| blob | 06ca8aa58030b82f0437593773974ff5b399de61 |
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 ;;; Commentary:
27 ;;
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
30 ;;
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
45 ;;
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
49 ;;
50 ;; http://orgmode.org/org.html#Installation
51 ;;
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
59 ;;
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
62 ;;
63 ;;; Code:
70 ;;;; Require other packages
85 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
86 ;; some places -- e.g. see the macro `org-with-limited-levels'.
87 ;;
88 ;; In Org buffers, the value of `outline-regexp' is that of
89 ;; `org-outline-regexp'. The only function still directly relying on
90 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
91 ;; job when `orgstruct-mode' is active.
96 "Regexp to match Org headlines.
97 This is similar to `org-outline-regexp' but additionally makes
101 "Matches a headline, putting stars and text into groups.
104 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
117 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
162 ;; load languages based on value of `org-babel-load-languages'
165 ;;;###autoload
167 "Load the languages defined in `org-babel-load-languages'."
179 org-babel-load-languages))
181 ;;;###autoload
183 "Load Emacs Lisp source code blocks in the Org-mode FILE.
184 This function exports the source code using `org-babel-tangle'
185 and then loads the resulting file using `load-file'. With prefix
186 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
187 file to byte-code before it is loaded."
197 ;; tangle if the org-mode file is newer than the elisp file
206 exported-file)))
209 "Languages which can be evaluated in Org-mode buffers.
210 This list can be used to load support for any of the languages
211 below, note that each language will depend on a different set of
212 system executables and/or Emacs modes. When a language is
214 with `org-babel-execute-src-block' bound by default to C-c
215 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
216 be set to remove code block evaluation from the C-c C-c
217 keybinding. By default only Emacs Lisp (which has no
218 requirements) is loaded."
223 :key-type
267 ;;;; Customization variables
269 "Remove ID property of clones of a subtree.
270 When non-nil, clones of a subtree don't inherit the ID property.
271 Otherwise they inherit the ID property with a new unique
272 identifier."
277 ;;; Version
280 ;;;###autoload
282 "Show the org-mode version in the echo area.
283 With prefix argument HERE, insert it at point.
284 When FULL is non-nil, use a verbose version string.
285 When MESSAGE is non-nil, display a message with the version."
298 org-version
299 git-version
302 org-install-dir
311 _version)))
315 ;;; Compatibility constants
317 ;;; The custom variables
320 "Outline-based notes management and organizer."
326 "Mode hook for Org-mode, run after the mode was turned on."
331 "Hook that is run after org.el has been loaded."
336 "Hook that is run after an Org log buffer is created."
346 "Load all extensions listed in `org-modules'."
351 org-modules)
355 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
360 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
361 "Modules that should always be loaded together with org.el.
363 If a description starts with <C>, the file is not part of Emacs
364 and loading it will require that you have downloaded and properly
365 installed the Org mode distribution.
367 You can also use this system to load external packages (i.e. neither Org
368 core modules, nor modules from the CONTRIB directory). Just add symbols
369 to the end of the list. If the package is called org-xyz.el, then you need
370 to add the symbol `xyz', and the package must have a call to:
372 \(provide 'org-xyz)
374 For export specific modules, see also `org-export-backends'."
379 :type
404 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
413 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
418 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
441 "List of export back-ends that should be always available.
443 If a description starts with <C>, the file is not part of Emacs
444 and loading it will require that you have downloaded and properly
445 installed the Org mode distribution.
447 Unlike to `org-modules', libraries in this list will not be
448 loaded along with Org, but only once the export framework is
449 needed.
451 This variable needs to be set before org.el is loaded. If you
452 need to make a change while Emacs is running, use the customize
453 interface or run the following code, where VALUE stands for the
454 new value of the variable, after updating it:
456 \(progn
457 \(setq org-export-registered-backends
458 \(org-remove-if-not
459 \(lambda (backend)
460 \(or (memq backend val)
461 \(catch 'parentp
462 \(mapc
463 \(lambda (b)
464 \(and (org-export-derived-backend-p b (car backend))
465 \(throw 'parentp t)))
466 val)
467 nil)))
468 org-export-registered-backends))
469 \(let ((new-list (mapcar 'car org-export-registered-backends)))
470 \(dolist (backend val)
471 \(cond
474 backend))
475 \((not (memq backend new-list)) (push backend new-list))))
476 \(set-default var new-list)))
478 Adding a back-end to this list will also pull the back-end it
479 depends on, if any."
487 ;; Any back-end not required anymore (not present in VAL and not
488 ;; a parent of any back-end in the new value) is removed from the
489 ;; list of registered back-ends.
499 val)
500 nil)))
501 org-export-registered-backends))
502 ;; Now build NEW-LIST of both new back-ends and required
503 ;; parents.
509 backend))
511 ;; Set VAR to that list with fixed dependencies.
538 backend))))
539 org-export-backends))
542 "Non-nil means make shift-cursor commands select text when possible.
544 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
545 start selecting a region, or enlarge regions started in this way.
546 In Org-mode, in special contexts, these same keys are used for
547 other purposes, important enough to compete with shift selection.
548 Org tries to balance these needs by supporting `shift-select-mode'
549 outside these special contexts, under control of this variable.
551 The default of this variable is nil, to avoid confusing behavior. Shifted
552 cursor keys will then execute Org commands in the following contexts:
553 - on a headline, changing TODO state (left/right) and priority (up/down)
554 - on a time stamp, changing the time
555 - in a plain list item, changing the bullet type
556 - in a property definition line, switching between allowed values
557 - in the BEGIN line of a clock table (changing the time block).
558 Outside these contexts, the commands will throw an error.
560 When this variable is t and the cursor is not in a special
561 context, Org-mode will support shift-selection for making and
562 enlarging regions. To make this more effective, the bullet
563 cycling will no longer happen anywhere in an item line, but only
564 if the cursor is exactly on the bullet.
566 If you set this variable to the symbol `always', then the keys
567 will not be special in headlines, property lines, and item lines,
568 to make shift selection work there as well. If this is what you
569 want, you can use the following alternative commands: `C-c C-t'
570 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
571 can be used to switch TODO sets, `C-c -' to cycle item bullet
572 types, and properties can be edited by hand or in column view.
574 However, when the cursor is on a timestamp, shift-cursor commands
575 will still edit the time stamp - this is just too good to give up.
577 XEmacs user should have this variable set to nil, because
578 `shift-select-mode' is in Emacs 23 or later only."
586 "Shall some commands act upon headlines in the active region?
588 When set to `t', some commands will be performed in all headlines
589 within the active region.
591 When set to `start-level', some commands will be performed in all
592 headlines within the active region, provided that these headlines
593 are of the same level than the first one.
595 When set to a string, those commands will be performed on the
596 matching headlines within the active region. Such string must be
597 a tags/property/todo match as it is used in the agenda tags view.
599 The list of commands is: `org-schedule', `org-deadline',
600 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
601 `org-archive-to-archive-sibling'. The archiving commands skip
602 already archived entries."
612 "Options concerning startup of Org-mode."
617 "Non-nil means entering Org-mode will switch to OVERVIEW.
618 This can also be configured on a per-file basis by adding one of
619 the following lines anywhere in the buffer:
621 #+STARTUP: fold (or `overview', this is equivalent)
622 #+STARTUP: nofold (or `showall', this is equivalent)
623 #+STARTUP: content
624 #+STARTUP: showeverything
626 By default, this option is ignored when Org opens agenda files
627 for the first time. If you want the agenda to honor the startup
628 option, set `org-agenda-inhibit-startup' to nil."
637 "Non-nil means entering Org-mode will set `truncate-lines'.
638 This is useful since some lines containing links can be very long and
639 uninteresting. Also tables look terrible when wrapped."
644 "Non-nil means turn on `org-indent-mode' on startup.
645 This can also be configured on a per-file basis by adding one of
646 the following lines anywhere in the buffer:
648 #+STARTUP: indent
649 #+STARTUP: noindent"
657 When this option is turned on, you can use TeX-like syntax for sub- and
659 considered as a single item - so grouping with {} is normally not
660 needed. For example, the following things will be parsed as single
661 sub- or superscripts.
663 10^24 or 10^tau several digits will be considered 1 item.
664 10^-12 or 10^-tau a leading sign with digits or a word
665 x^2-y^3 will be read as x^2 - y^3, because items are
666 terminated by almost any nonword/nondigit char.
667 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
669 Still, ambiguity is possible - so when in doubt use {} to enclose
670 the sub/superscript. If you set this variable to the symbol
671 `{}', the braces are *required* in order to trigger
672 interpretations as sub/superscript. This can be helpful in
682 "Non-nil means turn on `org-beamer-mode' on startup.
683 This can also be configured on a per-file basis by adding one of
684 the following lines anywhere in the buffer:
686 #+STARTUP: beamer"
692 "Non-nil means align all tables when visiting a file.
693 This is useful when the column width in tables is forced with <N> cookies
694 in table fields. Such tables will look correct only after the first re-align.
695 This can also be configured on a per-file basis by adding one of
696 the following lines anywhere in the buffer:
697 #+STARTUP: align
698 #+STARTUP: noalign"
703 "Non-nil means show inline images when loading a new Org file.
704 This can also be configured on a per-file basis by adding one of
705 the following lines anywhere in the buffer:
706 #+STARTUP: inlineimages
707 #+STARTUP: noinlineimages"
713 "Non-nil means preview LaTeX fragments when loading a new Org file.
715 This can also be configured on a per-file basis by adding one of
716 the followinglines anywhere in the buffer:
717 #+STARTUP: latexpreview
718 #+STARTUP: nolatexpreview"
725 "Non-nil means insert the first line setting Org-mode in empty files.
726 When the function `org-mode' is called interactively in an empty file, this
727 normally means that the file name does not automatically trigger Org-mode.
728 To ensure that the file will always be in Org-mode in the future, a
729 line enforcing Org-mode will be inserted into the buffer, if this option
730 has been set."
735 "Non-nil means use alternative key bindings for some keys.
736 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
737 These keys are also used by other packages like shift-selection-mode'
738 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
739 If you want to use Org-mode together with one of these other modes,
740 or more generally if you would like to move some Org-mode commands to
741 other keys, set this variable and configure the keys with the variable
742 `org-disputed-keys'.
744 This option is only relevant at load-time of Org-mode, and must be set
745 *before* org.el is loaded. Changing it requires a restart of Emacs to
746 become effective."
751 "Non-nil means use extra key sequence definitions for certain commands.
752 This happens automatically if you run XEmacs or if `window-system'
753 is nil. This variable lets you do the same manually. You must
754 set it before loading org.
756 Example: on Carbon Emacs 22 running graphically, with an external
757 keyboard on a Powerbook, the default way of setting M-left might
758 not work for either Alt or ESC. Setting this variable will make
759 it work for ESC."
772 "Keys for which Org-mode and other modes compete.
773 This is an alist, cars are the default keys, second element specifies
774 the alternative to use when `org-replace-disputed-keys' is t.
776 Keys can be specified in any syntax supported by `define-key'.
777 The value of this option takes effect only at Org-mode's startup,
778 therefore you'll have to restart Emacs to apply it after changing."
783 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
784 Or return the original if not disputed.
785 Also apply the translations defined in `org-xemacs-key-equivalents'."
790 org-disputed-keys)))
794 key)
804 "Define a key, possibly translated, as returned by `org-key'."
808 "The ellipsis to use in the Org-mode outline.
809 When nil, just use the standard three dots. When a string, use that instead,
810 When a face, use the standard 3 dots, but with the specified face.
811 The change affects only Org-mode (which will then use its own display table).
812 Changing this requires executing `M-x org-mode' in a buffer to become
813 effective."
823 "Keywords in Org-mode."
828 "String to mark deadline entries.
829 A deadline is this string, followed by a time stamp. Should be a word,
830 terminated by a colon. You can insert a schedule keyword and
832 Changes become only effective after restarting Emacs."
837 "String to mark scheduled TODO entries.
838 A schedule is this string, followed by a time stamp. Should be a word,
839 terminated by a colon. You can insert a schedule keyword and
841 Changes become only effective after restarting Emacs."
846 "String used as the prefix for timestamps logging closing a TODO entry."
851 "String used as prefix for timestamps clocking work hours on an item."
856 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
871 "Entries starting with this keyword will never be exported.
872 An entry can be toggled between COMMENT and normal with
874 Changes become only effective after restarting Emacs."
879 "Entries starting with this keyword will be exported in fixed-width font.
880 Quoting applies only to the text in the entry following the headline, and does
881 not extend beyond the next headline, even if that is lower level.
882 An entry can be toggled between QUOTE and normal with
889 "Regular expression for specifying repeated events.
893 "Options concerning the general structure of Org-mode files."
898 "Options about how to make context of a location visible."
922 "Non-nil means show full hierarchy when revealing a location.
923 Org-mode often shows locations in an org-mode file which might have
924 been invisible before. When this is set, the hierarchy of headings
925 above the exposed location is shown.
926 Turning this off for example for sparse trees makes them very compact.
927 Instead of t, this can also be an alist specifying this option for different
928 contexts. Valid contexts are
929 agenda when exposing an entry from the agenda
930 org-goto when using the command `org-goto' on key C-c C-j
931 occur-tree when using the command `org-occur' on key C-c /
932 tags-tree when constructing a sparse tree based on tags matches
933 link-search when exposing search matches associated with a link
934 mark-goto when exposing the jump goal of a mark
935 bookmark-jump when exposing a bookmark location
936 isearch when exiting from an incremental search
937 default default for all contexts not set explicitly"
942 "Non-nil means show following heading when revealing a location.
943 Org-mode often shows locations in an org-mode file which might have
944 been invisible before. When this is set, the heading following the
945 match is shown.
946 Turning this off for example for sparse trees makes them very compact,
947 but makes it harder to edit the location of the match. In such a case,
949 Instead of t, this can also be an alist specifying this option for different
950 contexts. See `org-show-hierarchy-above' for valid contexts."
955 "Non-nil means show all sibling heading when revealing a location.
956 Org-mode often shows locations in an org-mode file which might have
957 been invisible before. When this is set, the sibling of the current entry
958 heading are all made visible. If `org-show-hierarchy-above' is t,
959 the same happens on each level of the hierarchy above the current entry.
961 By default this is on for the isearch context, off for all other contexts.
962 Turning this off for example for sparse trees makes them very compact,
963 but makes it harder to edit the location of the match. In such a case,
965 Instead of t, this can also be an alist specifying this option for different
966 contexts. See `org-show-hierarchy-above' for valid contexts."
968 :type org-context-choice
973 "Non-nil means show the entry below a headline when revealing a location.
974 Org-mode often shows locations in an org-mode file which might have
975 been invisible before. When this is set, the text below the headline that is
976 exposed is also shown.
978 By default this is off for all contexts.
979 Instead of t, this can also be an alist specifying this option for different
980 contexts. See `org-show-hierarchy-above' for valid contexts."
985 "How should indirect tree buffers be displayed?
986 This applies to indirect buffers created with the commands
988 Valid values are:
989 current-window Display in the current window
990 other-window Just display in another window.
991 dedicated-frame Create one new frame, and re-use it each time.
992 new-frame Make a new frame each time. Note that in this case
993 previously-made indirect buffers are kept, and you need to
994 kill these buffers yourself."
1004 "Non-nil means activate single letter commands at beginning of a headline.
1005 This may also be a function to test for appropriate locations where speed
1006 commands should be active."
1014 "Alist of additional speed commands.
1015 This list will be checked before `org-speed-commands-default'
1016 when the variable `org-use-speed-commands' is non-nil
1017 and when the cursor is at the beginning of a headline.
1018 The car if each entry is a string with a single letter, which must
1019 be assigned to `self-insert-command' in the global map.
1020 The cdr is either a command to be called interactively, a function
1021 to be called, or a form to be evaluated.
1022 An entry that is just a list with a single string will be interpreted
1023 as a descriptive headline that will be added when listing the speed
1024 commands in the Help buffer using the `?' speed command."
1036 "Options concerning visibility cycling in Org-mode."
1041 "Non-nil means skip CHILDREN state in entries that don't have any."
1046 "Maximum level which should still be subject to visibility cycling.
1047 Levels higher than this will, for cycling, be treated as text, not a headline.
1048 When `org-odd-levels-only' is set, a value of N in this variable actually
1049 means 2N-1 stars as the limiting headline.
1050 When nil, cycle all levels.
1051 Note that the limiting level of cycling is also influenced by
1052 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1053 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1054 than its value."
1061 "Names of drawers. Drawers are not opened by cycling on the headline above.
1062 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1063 this:
1064 :DRAWERNAME:
1065 .....
1066 :END:
1068 the property API.
1070 Drawers can be defined on the per-file basis with a line like:
1072 #+DRAWERS: HIDDEN STATE PROPERTIES"
1078 "Non-nil means entering Org-mode will fold all blocks.
1079 This can also be set in on a per-file basis with
1081 #+STARTUP: hideblocks
1082 #+STARTUP: showblocks"
1088 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1089 This makes it possible to do global cycling without having to use S-TAB or
1091 of the buffer must not be a headline -- it may be empty or some other text.
1092 When used in this way, `org-cycle-hook' is disabled temporarily to make
1093 sure the cursor stays at the beginning of the buffer. When this option is
1094 nil, don't do anything special at the beginning of the buffer."
1099 "Non-nil means cycle entry level or item indentation in new empty entries.
1101 When the cursor is at the end of an empty headline, i.e., with only stars
1102 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1103 and then all possible ancestor states, before returning to the original state.
1104 This makes data entry extremely fast: M-RET to create a new headline,
1105 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1107 When the cursor is at the end of an empty plain list item, one TAB will
1108 make it a subitem, two or more tabs will back up to make this an item
1109 higher up in the item hierarchy."
1114 "Where should `org-cycle' emulate TAB.
1115 nil Never
1116 white Only in completely white lines
1117 whitestart Only at the beginning of lines, before the first non-white char
1118 t Everywhere except in headlines
1119 exc-hl-bol Everywhere except at the start of a headline
1120 If TAB is used in a place where it does not emulate TAB, the current subtree
1121 visibility is cycled."
1130 "Number of empty lines needed to keep an empty line between collapsed trees.
1131 If you leave an empty line between the end of a subtree and the following
1132 headline, this empty line is hidden when the subtree is folded.
1133 Org-mode will leave (exactly) one empty line visible if the number of
1134 empty lines is equal or larger to the number given in this variable.
1135 So the default 2 means at least 2 empty lines after the end of a subtree
1136 are needed to produce free space between a collapsed subtree and the
1137 following headline.
1139 If the number is negative, and the number of empty lines is at least -N,
1140 all empty lines are shown.
1142 Special case: when 0, never leave empty lines in collapsed view."
1148 "Hook that is run before visibility cycling is happening.
1149 The function(s) in this hook must accept a single argument which indicates
1150 the new state that will be set right after running this hook. The
1151 argument is a symbol. Before a global state change, it can have the values
1152 `overview', `content', or `all'. Before a local state change, it can have
1153 the values `folded', `children', or `subtree'."
1158 org-cycle-hide-drawers
1159 org-cycle-hide-inline-tasks
1160 org-cycle-show-empty-lines
1161 org-optimize-window-after-visibility-change)
1162 "Hook that is run after `org-cycle' has changed the buffer visibility.
1163 The function(s) in this hook must accept a single argument which indicates
1164 the new state that was set by the most recent `org-cycle' command. The
1165 argument is a symbol. After a global state change, it can have the values
1166 `overview', `contents', or `all'. After a local state change, it can have
1167 the values `folded', `children', or `subtree'."
1172 "Options concerning structure editing in Org-mode."
1177 "Non-nil means skip even levels and only use odd levels for the outline.
1178 This has the effect that two stars are being added/taken away in
1179 promotion/demotion commands. It also influences how levels are
1180 handled by the exporters.
1181 Changing it requires restart of `font-lock-mode' to become effective
1182 for fontification also in regions already fontified.
1183 You may also set this on a per-file basis by adding one of the following
1184 lines to the buffer:
1186 #+STARTUP: odd
1187 #+STARTUP: oddeven"
1193 "Non-nil means adapt indentation to outline node level.
1195 When this variable is set, Org assumes that you write outlines by
1196 indenting text in each node to align with the headline (after the stars).
1197 The following issues are influenced by this variable:
1199 - When this is set and the *entire* text in an entry is indented, the
1200 indentation is increased by one space in a demotion command, and
1201 decreased by one in a promotion command. If any line in the entry
1202 body starts with text at column 0, indentation is not changed at all.
1204 - Property drawers and planning information is inserted indented when
1205 this variable s set. When nil, they will not be indented.
1207 - TAB indents a line relative to context. The lines below a headline
1208 will be indented when this variable is set.
1210 Note that this is all about true indentation, by adding and removing
1211 space characters. See also `org-indent.el' which does level-dependent
1212 indentation in a virtual way, i.e. at display time in Emacs."
1217 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1219 When t, `C-a' will bring back the cursor to the beginning of the
1220 headline text, i.e. after the stars and after a possible TODO
1221 keyword. In an item, this will be the position after bullet and
1222 check-box, if any. When the cursor is already at that position,
1223 another `C-a' will bring it to the beginning of the line.
1225 `C-e' will jump to the end of the headline, ignoring the presence
1226 of tags in the headline. A second `C-e' will then jump to the
1227 true end of the line, after any tags. This also means that, when
1228 this variable is non-nil, `C-e' also will never jump beyond the
1229 end of the heading of a folded section, i.e. not after the
1230 ellipses.
1232 When set to the symbol `reversed', the first `C-a' or `C-e' works
1233 normally, going to the true line boundary first. Only a directly
1234 following, identical keypress will bring the cursor to the
1235 special positions.
1237 This may also be a cons cell where the behavior for `C-a' and
1238 `C-e' is set separately."
1256 "Non-nil means `C-k' will behave specially in headlines.
1257 When nil, `C-k' will call the default `kill-line' command.
1258 When t, the following will happen while the cursor is in the headline:
1260 - When the cursor is at the beginning of a headline, kill the entire
1261 line and possible the folded subtree below the line.
1262 - When in the middle of the headline text, kill the headline up to the tags.
1263 - When after the headline text, kill the tags."
1268 "Non-nil means, do not delete a hidden subtree with C-k.
1269 When set to the symbol `error', simply throw an error when C-k is
1270 used to kill (part-of) a headline that has hidden text behind it.
1271 Any other non-nil value will result in a query to the user, if it is
1272 OK to kill that hidden subtree. When nil, kill without remorse."
1281 "Check if in invisible region before inserting or deleting a character.
1282 Valid values are:
1284 nil Do not check, so just do invisible edits.
1285 error Throw an error and do nothing.
1286 show Make point visible, and do the requested edit.
1287 show-and-error Make point visible, then throw an error and abort the edit.
1288 smart Make point visible, and do insertion/deletion if it is
1289 adjacent to visible text and the change feels predictable.
1290 Never delete a previously invisible character or add in the
1291 middle or right after an invisible region. Basically, this
1292 allows insertion and backward-delete right before ellipses.
1293 FIXME: maybe in this case we should not even show?"
1304 "Non-nil means when yanking subtrees, fold them.
1305 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1306 it starts with a heading and all other headings in it are either children
1307 or siblings, then fold all the subtrees. However, do this only if no
1308 text after the yank would be swallowed into a folded tree by this action."
1313 "Non-nil means when yanking subtrees, adjust the level.
1314 With this setting, `org-paste-subtree' is used to insert the subtree, see
1315 this function for details."
1320 "Non-nil means M-RET will split the line at the cursor position.
1321 When nil, it will go to the end of the line before making a
1322 new line.
1323 You may also set this option in a different way for different
1324 contexts. Valid contexts are:
1326 headline when creating a new headline
1327 item when creating a new item
1328 table in a table field
1329 default the value to be used for all contexts not explicitly
1330 customized"
1347 "Non-nil means insert new headings after the current subtree.
1348 When nil, the new heading is created directly after the current line.
1349 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1350 this variable on for the duration of the command."
1356 "Should `org-insert-heading' leave a blank line before new heading/item?
1357 The value is an alist, with `heading' and `plain-list-item' as CAR,
1358 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1359 which case Org will look at the surrounding headings/items and try to
1360 make an intelligent decision whether to insert a blank line or not.
1362 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1363 the setting here is ignored and no empty line is inserted to avoid breaking
1364 the list structure."
1377 "Hook being run after inserting a new heading."
1383 This currently only means they are never auto-wrapped.
1384 When nil, such lines will be treated like ordinary lines.
1385 See also the QUOTE keyword."
1390 "Non-nil means typing characters in `org-goto' starts incremental search.
1391 When nil, you can use these keybindings to navigate the buffer:
1393 q Quit the org-goto interface
1394 n Go to the next visible heading
1395 p Go to the previous visible heading
1396 f Go one heading forward on same level
1397 b Go one heading backward on same level
1398 u Go one heading up"
1403 "Options concerning sparse trees in Org-mode."
1408 "Non-nil means highlight all matches that define a sparse tree.
1409 The highlights will automatically disappear the next time the buffer is
1410 changed by an edit command."
1415 "Non-nil means any change to the buffer will remove temporary highlights.
1416 Such highlights are created by `org-occur' and `org-clock-display'.
1417 When nil, `C-c C-c needs to be used to get rid of the highlights.
1418 The highlights created by `org-preview-latex-fragment' always need
1419 `C-c C-c' to be removed."
1426 "Hook that is run after `org-occur' has constructed a sparse tree.
1427 This can be used to recenter the window to show as much of the structure
1428 as possible."
1433 "Options concerning imenu and speedbar in Org-mode."
1438 "The maximum level for Imenu access to Org-mode headlines.
1439 This also applied for speedbar access."
1444 "Options concerning tables in Org-mode."
1450 When nil, such lines will be treated like ordinary lines.
1452 When equal to the symbol `optimized', the table editor will be optimized to
1453 do the following:
1454 - Automatic overwrite mode in front of whitespace in table fields.
1455 This makes the structure of the table stay in tact as long as the edited
1456 field does not exceed the column width.
1457 - Minimize the number of realigns. Normally, the table is aligned each time
1458 TAB or RET are pressed to move to another field. With optimization this
1459 happens only if changes to a field might have changed the column width.
1460 Optimization requires replacing the functions `self-insert-command',
1461 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1462 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1463 very good at guessing when a re-align will be necessary, but you can always
1466 If you would like to use the optimized version in Org-mode, but the
1467 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1469 This variable can be used to turn on and off the table editor during a session,
1470 but in order to toggle optimization, a restart is required.
1472 See also the variable `org-table-auto-blank-field'."
1481 "Non-nil means cluster self-insert commands for undo when possible.
1482 If this is set, then, like in the Emacs command loop, 20 consecutive
1483 characters will be undone together.
1484 This is configurable, because there is some impact on typing performance."
1489 "Non-nil means TAB will automatically notice a table.el table.
1490 When it sees such a table, it moves point into it and - if necessary -
1491 calls `table-recognize-table'."
1496 "Options concerning links in Org-mode."
1501 "Buffer-local version of `org-link-abbrev-alist', which see.
1506 "Alist of link abbreviations.
1507 The car of each element is a string, to be replaced at the start of a link.
1509 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1511 [[linkkey:tag][description]]
1513 The 'linkkey' must be a word word, starting with a letter, followed
1514 by letters, numbers, '-' or '_'.
1516 If REPLACE is a string, the tag will simply be appended to create the link.
1519 at that point (see the function `url-hexify-string'). If the string contains
1521 be invoked: this function takes the tag as its only argument and must return
1522 a string.
1524 REPLACE may also be a function that will be called with the tag as the
1525 only argument to create the link, which should be returned as a string.
1527 See the manual for examples."
1537 "Non-nil means Org will display descriptive links.
1538 E.g. [[http://orgmode.org][Org website]] will be displayed as
1540 description. When set to `nil', Org will display the full links
1541 literally.
1543 You can interactively set the value of this variable by calling
1544 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1549 "How the path name in file links should be stored.
1550 Valid values are:
1552 relative Relative to the current directory, i.e. the directory of the file
1553 into which the link is being inserted.
1554 absolute Absolute path, if possible with ~ for home directory.
1555 noabbrev Absolute path, no abbreviation of home directory.
1556 adaptive Use relative path for files in the current directory and sub-
1557 directories of it. For other files, use an absolute path."
1566 "Types of links that should be activated in Org-mode files.
1567 This is a list of symbols, each leading to the activation of a certain link
1568 type. In principle, it does not hurt to turn on most link types - there may
1569 be a small gain when turning off unused link types. The types are:
1571 bracket The recommended [[link][description]] or [[link]] links with hiding.
1572 angle Links in angular brackets that may contain whitespace like
1573 <bbdb:Carsten Dominik>.
1574 plain Plain links in normal text, no whitespace, like http://google.com.
1575 radio Text that is matched by a radio target, see manual for details.
1576 tag Tag settings in a headline (link to tag search).
1577 date Time stamps (link to calendar).
1578 footnote Footnote labels.
1580 Changing this variable requires a restart of Emacs to become effective."
1592 "Function to use for generating link descriptions from links.
1593 When nil, the link location will be used. This function must take
1594 two parameters: the first one is the link, the second one is the
1595 description generated by `org-insert-link'. The function should
1596 return the description to use."
1601 "Options concerning storing links in Org-mode."
1606 "When non-nil, hexify URL when creating a link."
1612 "Format of the description part of a link to an email or usenet message.
1613 The following %-escapes will be replaced by corresponding information:
1621 %s subject
1622 %d date
1623 %m message-id.
1625 You may use normal field width specification between the % and the letter.
1626 This is for example useful to limit the length of the subject.
1640 It should match if the message is from the user him/herself."
1645 "Non-nil means file links from `org-store-link' contain context.
1646 A search string will be added to the file name with :: as separator and
1647 used to find the context when the link is activated by the command
1648 `org-open-at-point'. When this option is t, the entire active region
1649 will be placed in the search string of the file link. If set to a
1650 positive integer, only the first n lines of context will be stored.
1653 negates this setting for the duration of the command."
1658 "Non-nil means keep link in list for entire session.
1660 The command `org-store-link' adds a link pointing to the current
1661 location to an internal list. These links accumulate during a session.
1662 The command `org-insert-link' can be used to insert links into any
1663 Org-mode file (offering completion for all stored links). When this
1665 will be removed from the list, to make completing the unused links
1666 more efficient."
1671 "Options concerning following links in Org-mode."
1676 "Function to translate links with different syntax to Org syntax.
1677 This can be used to translate links created for example by the Planner
1678 or emacs-wiki packages to Org syntax.
1679 The function must accept two parameters, a TYPE containing the link
1681 which is everything after the link protocol. It should return a cons
1682 with possibly modified values of type and path.
1683 Org contains a function for this, so if you set this variable to
1684 `org-translate-link-from-planner', you should be able follow many
1685 links created by planner."
1690 "Hook that is run after a link has been followed."
1695 "Non-nil means on links TAB will follow the link.
1696 Needs to be set before org.el is loaded.
1697 This really should not be used, it does not make sense, and the
1698 implementation is bad."
1703 "Non-nil means on links RET will follow the link.
1704 In tables, the special behavior of RET has precedence."
1710 "Non-nil means mouse-1 on a link will follow the link.
1711 A longer mouse click will still set point. Does not work on XEmacs.
1712 Needs to be set before org.el is loaded."
1717 "Number of different positions to be recorded in the ring.
1718 Changing this requires a restart of Emacs to work correctly."
1723 "Non-nil means internal links in Org files must exactly match a headline.
1724 When nil, the link search tries to match a phrase with all words
1725 in the search text."
1732 query-to-create)))
1740 "Setup the frame configuration for following links.
1741 When following a link with Emacs, it may often be useful to display
1742 this link in another window or frame. This variable can be used to
1743 set this up for the different types of links.
1744 For VM, use any of
1745 `vm-visit-folder'
1746 `vm-visit-folder-other-window'
1747 `vm-visit-folder-other-frame'
1748 For Gnus, use any of
1749 `gnus'
1750 `gnus-other-frame'
1751 `org-gnus-no-new-news'
1752 For FILE, use any of
1753 `find-file'
1754 `find-file-other-window'
1755 `find-file-other-frame'
1756 For Wanderlust use any of
1757 `wl'
1758 `wl-other-frame'
1759 For the calendar, use the variable `calendar-setup'.
1760 For BBDB, it is currently only possible to display the matches in
1761 another window."
1785 "Non-nil means use indirect buffer to display infile links.
1786 Activating internal links (from one location in a file to another location
1787 in the same file) normally just jumps to the location. When the link is
1789 is displayed in
1790 another window. When this option is set, the other window actually displays
1791 an indirect buffer clone of the current buffer, to avoid any visibility
1792 changes to the current buffer."
1797 "Non-nil means `org-open-file' will open non-existing files.
1798 When nil, an error will be generated.
1799 This variable applies only to external applications because they
1800 might choke on non-existing files. If the link is to a file that
1801 will be opened in Emacs, the variable is ignored."
1806 "Non-nil means a link to a directory really means to index.org.
1807 When nil, following a directory link will run dired or open a finder/explorer
1808 window on that directory."
1813 "Function and arguments to call for following mailto links.
1814 This is a list with the first element being a Lisp function, and the
1815 remaining elements being arguments to the function. In string arguments,
1816 %a will be replaced by the address, and %s will be replaced by the subject
1817 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1826 "Non-nil means ask for confirmation before executing shell links.
1827 Shell links can be dangerous: just think about a link
1829 [[shell:rm -rf ~/*][Google Search]]
1832 but really it would remove your entire home directory.
1833 Therefore we advise against setting this variable to nil.
1834 Just change it to `y-or-n-p' if you want to confirm with a
1842 'safe-local-variable
1846 "A regexp to skip confirmation for shell links."
1852 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1853 Elisp links can be dangerous: just think about a link
1858 but really it would remove your entire home directory.
1859 Therefore we advise against setting this variable to nil.
1860 Just change it to `y-or-n-p' if you want to confirm with a
1868 'safe-local-variable
1872 "A regexp to skip confirmation for Elisp links."
1881 "Default file applications on a UNIX or GNU/Linux system.
1892 "Default file applications on a MacOS X system.
1894 for some files for which the OS does not have a good default.
1902 'mswindows-shell-execute
1907 'mswindows-shell-execute
1910 "Default file applications on a Windows NT system.
1919 "External applications for opening `file:path' items in a document.
1920 Org-mode uses system defaults for different file types, but
1921 you can use this variable to set the application for a given file
1922 extension. The entries in this list are cons cells where the car identifies
1923 files and the cdr the corresponding command. Possible values for the
1924 file identifier are
1926 ways, depending on its contents:
1928 - Alphanumeric characters only:
1929 Match links with this file extension.
1931 to open PDFs with evince.
1933 - Regular expression: Match links where the
1934 filename matches the regexp. If you want to
1935 use groups here, use shy groups.
1939 to open *.html and *.xhtml with firefox.
1941 - Regular expression which contains (non-shy) groups:
1943 anything after that, matches the regexp.
1944 In a custom command string, %1, %2, etc. are replaced with
1945 the parts of the link that were matched by the groups.
1946 For backwards compatibility, if a command string is given
1947 that does not use any of the group matches, this case is
1948 handled identically to the second one (i.e. match against
1949 file name only).
1950 In a custom lisp form, you can access the group matches with
1951 (match-string n link).
1954 to open [[file:document.pdf::5]] with evince at page 5.
1956 `directory' Matches a directory
1957 `remote' Matches a remote file, accessible through tramp or efs.
1958 Remote files most likely should be visited through Emacs
1959 because external applications cannot handle such paths.
1960 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1961 so all files Emacs knows how to handle. Using this with
1962 command `emacs' will open most files in Emacs. Beware that this
1963 will also open html files inside Emacs, unless you add
1965 t Default for files not matched by any of the other options.
1966 `system' The system command to open files, like `open' on Windows
1967 and Mac OS X, and mailcap under GNU/Linux. This is the command
1968 that will be selected if you call `C-c C-o' with a double
1971 Possible values for the command are:
1972 `emacs' The file will be visited by the current Emacs process.
1973 `default' Use the default application for this file type, which is the
1974 association for t in the list, most likely in the system-specific
1975 part.
1976 This can be used to overrule an unwanted setting in the
1977 system-specific variable.
1979 This command is specified by the entry whose car is `system'.
1980 Most likely, the system-specific version of this variable
1981 does define this command, but you can overrule/replace it
1982 here.
1983 string A command to be executed by a shell; %s will be replaced
1984 by the path to the file.
1985 sexp A Lisp form which will be evaluated. The file path will
1986 be available in the Lisp variable `file'.
1987 For more examples, see the system specific constants
1988 `org-file-apps-defaults-macosx'
1989 `org-file-apps-defaults-windowsnt'
1990 `org-file-apps-defaults-gnu'."
2000 auto-mode))
2009 "The URL of the DOI server."
2015 "Options concerning refiling entries in Org-mode."
2020 "Directory with org files.
2021 This is just a default location to look for Org files. There is no need
2022 at all to put your files into this directory. It is only used in the
2023 following situations:
2025 1. When a capture template specifies a target file that is not an
2026 absolute path. The path will then be interpreted relative to
2027 `org-directory'
2028 2. When a capture note is filed away in an interactive way (when exiting the
2029 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2030 with `org-directory' as the default path."
2037 "Default target for storing notes.
2038 Used as a fall back file for org-remember.el and org-capture.el, for
2039 templates that do not specify a target file."
2045 file))
2048 "The default interface to be used for `org-goto'.
2049 Allowed values are:
2050 outline The interface shows an outline of the relevant file
2051 and the correct heading is found by moving through
2052 the outline or by searching with incremental search.
2053 outline-path-completion Headlines in the current buffer are offered via
2054 completion. This is the interface also used by
2055 the refile command."
2062 "Maximum target level when running `org-goto' with refile interface."
2067 "Non-nil means store new notes at the beginning of a file or entry.
2068 When nil, new notes will be filed to the end of a file or entry.
2069 This can also be a list with cons cells of regular expressions that
2070 are matched against file names, and values."
2081 "Information to record when a task is refiled.
2083 Possible values are:
2085 nil Don't add anything
2086 time Add a time stamp to the task
2087 note Prompt for a note and add it with template `org-log-note-headings'
2089 This option can also be set with on a per-file-basis with
2091 #+STARTUP: nologrefile
2092 #+STARTUP: logrefile
2093 #+STARTUP: lognoterefile
2095 You can have local logging settings for a subtree by setting the LOGGING
2096 property to one or more of these keywords.
2098 When bulk-refiling from the agenda, the value `note' is forbidden and
2099 will temporarily be changed to `time'."
2110 This is a list of cons cells. Each cell contains:
2111 - a specification of the files to be considered, either a list of files,
2112 or a symbol whose function or variable value will be used to retrieve
2113 a file name or a list of file names. If you use `org-agenda-files' for
2114 that, all agenda files will be scanned for targets. Nil means consider
2115 headings in the current buffer.
2116 - A specification of how to find candidate refile targets. This may be
2117 any of:
2119 This tag has to be present in all target headlines, inheritance will
2120 not be considered.
2122 todo keyword.
2124 headlines that are refiling targets.
2125 - a cons cell (:level . N). Any headline of level N is considered a target.
2126 Note that, when `org-odd-levels-only' is set, level corresponds to
2127 order in hierarchy, not to the number of stars.
2128 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2129 Note that, when `org-odd-levels-only' is set, level corresponds to
2130 order in hierarchy, not to the number of stars.
2132 Each element of this list generates a set of possible targets.
2133 The union of these sets is presented (with completion) to
2134 the user by `org-refile'.
2136 You can set the variable `org-refile-target-verify-function' to a function
2137 to verify each headline found by the simple criteria above.
2139 When this variable is nil, all top-level headlines in the current buffer
2140 are used, equivalent to the value `((nil . (:level . 1))'."
2156 "Function to verify if the headline at point should be a refile target.
2157 The function will be called without arguments, with point at the
2158 beginning of the headline. It should return t and leave point
2159 where it is if the headline is a valid target for refiling.
2161 If the target should not be selected, the function must return nil.
2162 In addition to this, it may move point to a place from where the search
2163 should be continued. For example, the function may decide that the entire
2164 subtree of the current entry should be excluded and move point to the end
2165 of the subtree."
2170 "Non-nil means cache refile targets to speed up the process.
2171 The cache for a particular file will be updated automatically when
2172 the buffer has been killed, or when any of the marker used for flagging
2173 refile targets no longer points at a live buffer.
2174 If you have added new entries to a buffer that might themselves be targets,
2175 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2176 find that easier, `C-u C-u C-u C-c C-w'."
2182 "Non-nil means provide refile targets as paths.
2183 So a level 3 headline will be available as level1/level2/level3.
2185 When the value is `file', also include the file name (without directory)
2186 into the path. In this case, you can also stop the completion after
2187 the file name, to get entries inserted as top level in the file.
2189 When `full-file-path', include the full file path."
2198 "Non-nil means complete the outline path in hierarchical steps.
2199 When Org-mode uses the refile interface to select an outline path
2200 \(see variable `org-refile-use-outline-path'), the completion of
2201 the path can be done is a single go, or if can be done in steps down
2202 the headline hierarchy. Going in steps is probably the best if you
2203 do not use a special completion package like `ido' or `icicles'.
2204 However, when using these packages, going in one step can be very
2205 fast, while still showing the whole path to the entry."
2210 "Non-nil means allow to create new nodes as refile targets.
2212 of an existing node. When the value of this variable is `confirm',
2213 new node creation must be confirmed by the user (recommended)
2214 When nil, the completion must match an existing entry.
2216 Note that, if the new heading is not seen by the criteria
2217 listed in `org-refile-targets', multiple instances of the same
2218 heading would be created by trying again to file under the new
2219 heading."
2227 "Non-nil means also refile active region within a subtree.
2229 By default `org-refile' doesn't allow refiling regions if they
2230 don't contain a set of subtrees, but it might be convenient to
2231 do so sometimes: in that case, the first line of the region is
2232 converted to a headline before refiling."
2238 "Options concerning TODO items in Org-mode."
2243 "Options concerning Progress logging in Org-mode."
2250 "The available interpretation symbols for customizing `org-todo-keywords'.
2254 "List of TODO entry keyword sequences and their interpretation.
2257 Each sequence starts with a symbol, either `sequence' or `type',
2258 indicating if the keywords should be interpreted as a sequence of
2259 action steps, or as different types of TODO items. The first
2260 keywords are states requiring action - these states will select a headline
2261 for inclusion into the global TODO list Org-mode produces. If one of
2264 the last keyword is treated as the only DONE state of the sequence.
2267 additional state where no keyword is present. For details about this
2268 cycling, see the manual.
2270 TODO keywords and interpretation can also be set on a per-file basis with
2271 the special #+SEQ_TODO and #+TYP_TODO lines.
2273 Each keyword can optionally specify a character for fast state selection
2274 \(in combination with the variable `org-use-fast-todo-selection')
2275 and specifiers for state change logging, using the same syntax that
2278 indicates to record a time stamp each time this state is selected.
2280 Each keyword may also specify if a timestamp or a note should be
2281 recorded when entering or leaving the state, by adding additional
2282 characters in the parenthesis after the keyword. This looks like this:
2284 record only the time of the state change. With X and Y being either
2286 Y when leaving the state if and only if the *target* state does not
2287 define X. You may omit any of the fast-selection key or X or /Y,
2288 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2290 For backward compatibility, this variable may also be just a list
2291 of keywords. In this case the interpretation (sequence or type) will be
2292 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2302 ;;Quick and dirty way to see
2303 ;;`org-todo-interpretations'. This takes the
2304 ;;place of item arguments
2305 :convert-widget
2312 org-todo-interpretation-widgets))
2313 widget))
2349 "Controls how TODO keywords are interpreted.
2350 This variable is in principle obsolete and is only used for
2351 backward compatibility, if the interpretation of todo keywords is
2352 not given already in `org-todo-keywords'. See that variable for
2353 more information."
2360 "Non-nil means use the fast todo selection scheme with C-c C-t.
2361 This variable describes if and under what circumstances the cycling
2362 mechanism for TODO keywords will be replaced by a single-key, direct
2363 selection scheme.
2365 When nil, fast selection is never used.
2367 When the symbol `prefix', it will be used when `org-todo' is called
2368 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2369 `C-u t' in an agenda buffer.
2371 When t, fast selection is used by default. In this case, the prefix
2372 argument forces cycling instead.
2374 In all cases, the special interface is only used if access keys have
2375 actually been assigned by the user, i.e. if keywords in the configuration
2376 are followed by a letter in parenthesis, like TODO(t)."
2384 "Non-nil means update todo statistics after insert and toggle.
2385 ALL-HEADLINES means update todo statistics by including headlines
2386 with no TODO keyword as well, counting them as not done.
2387 A list of TODO keywords means the same, but skip keywords that are
2388 not in this list.
2390 When this is set, todo statistics is updated in the parent of the
2391 current entry each time a todo state is changed."
2401 "Non-nil means TODO statistics covers just direct children.
2402 When nil, all entries in the subtree are considered.
2403 This has only an effect if `org-provide-todo-statistics' is set.
2404 To set this to nil for only a single subtree, use a COOKIE_DATA
2410 "Hook which is run after the state of a TODO item was changed.
2411 The new state (a string with a TODO keyword, or nil) is available in the
2412 Lisp variable `org-state'."
2417 "Hook for functions that are allowed to block a state change.
2419 Functions in this hook should not modify the buffer.
2420 Each function gets as its single argument a property list,
2421 see `org-trigger-hook' for more information about this list.
2423 If any of the functions in this hook returns nil, the state change
2427 "Hook for functions that are triggered by a state change.
2429 Each function gets as its single argument a property list with at
2430 least the following elements:
2432 (:type type-of-change :position pos-at-entry-start
2433 :from old-state :to new-state)
2435 Depending on the type, more properties may be present.
2437 This mechanism is currently implemented for:
2439 TODO state changes
2440 ------------------
2441 :type todo-state-change
2442 :from previous state (keyword as a string), or nil, or a symbol
2443 'todo' or 'done', to indicate the general type of state.
2447 "Non-nil means undone TODO entries will block switching the parent to DONE.
2448 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2449 be blocked if any prior sibling is not yet done.
2450 Finally, if the parent is blocked because of ordered siblings of its own,
2451 the child will also be blocked."
2463 "Non-nil means unchecked boxes will block switching the parent to DONE.
2464 When this is nil, checkboxes have no influence on switching TODO states.
2465 When non-nil, you first need to check off all check boxes before the TODO
2466 entry can be switched to DONE.
2467 This variable needs to be set before org.el is loaded, and you need to
2468 restart Emacs after a change to make the change effective. The only way
2469 to change is while Emacs is running is through the customize interface."
2481 "Non-nil means inserting a TODO heading is treated as state change.
2483 logging will apply if appropriate. When nil, the new TODO item will
2484 be inserted directly, and no logging will take place."
2489 "Non-nil means switching TODO states with S-cursor counts as state change.
2490 This is the default behavior. However, setting this to nil allows a
2491 convenient way to select a TODO state and bypass any logging associated
2492 with that."
2497 "Tag changes that should be triggered by TODO state changes.
2498 This is a list. Each entry is
2500 (state-change (tag . flag) .......)
2502 State-change can be a string with a state, and empty string to indicate the
2503 state that has no TODO keyword, or it can be one of the symbols `todo'
2504 or `done', meaning any not-done or done state, respectively."
2518 "Information to record when a task moves to the DONE state.
2520 Possible values are:
2522 nil Don't add anything, just change the keyword
2523 time Add a time stamp to the task
2524 note Prompt for a note and add it with template `org-log-note-headings'
2526 This option can also be set with on a per-file-basis with
2528 #+STARTUP: nologdone
2529 #+STARTUP: logdone
2530 #+STARTUP: lognotedone
2532 You can have local logging settings for a subtree by setting the LOGGING
2533 property to one or more of these keywords."
2541 ;; Normalize old uses of org-log-done.
2548 "Information to record when the scheduling date of a tasks is modified.
2550 Possible values are:
2552 nil Don't add anything, just change the date
2553 time Add a time stamp to the task
2554 note Prompt for a note and add it with template `org-log-note-headings'
2556 This option can also be set with on a per-file-basis with
2558 #+STARTUP: nologreschedule
2559 #+STARTUP: logreschedule
2560 #+STARTUP: lognotereschedule"
2569 "Information to record when the deadline date of a tasks is modified.
2571 Possible values are:
2573 nil Don't add anything, just change the date
2574 time Add a time stamp to the task
2575 note Prompt for a note and add it with template `org-log-note-headings'
2577 This option can also be set with on a per-file-basis with
2579 #+STARTUP: nologredeadline
2580 #+STARTUP: logredeadline
2581 #+STARTUP: lognoteredeadline
2583 You can have local logging settings for a subtree by setting the LOGGING
2584 property to one or more of these keywords."
2593 "Non-nil means record a note when clocking out of an item.
2594 This can also be configured on a per-file basis by adding one of
2595 the following lines anywhere in the buffer:
2597 #+STARTUP: lognoteclock-out
2598 #+STARTUP: nolognoteclock-out"
2604 "Non-nil means the CLOSED time stamp will contain date and time.
2605 When nil, only the date will be recorded."
2619 "Headings for notes added to entries.
2620 The value is an alist, with the car being a symbol indicating the note
2621 context, and the cdr is the heading to be used. The heading may also be the
2622 empty string.
2623 %t in the heading will be replaced by a time stamp.
2624 %T will be an active time stamp instead the default inactive one
2625 %d will be replaced by a short-format time stamp.
2626 %D will be replaced by an active short-format time stamp.
2627 %s will be replaced by the new TODO state, in double quotes.
2628 %S will be replaced by the old TODO state, in double quotes.
2629 %u will be replaced by the user name.
2630 %U will be replaced by the full user name.
2632 In fact, it is not a good idea to change the `state' entry, because
2633 agenda log mode depends on the format of these entries."
2639 "Heading when changing todo state (todo sequence only)"
2653 "Non-nil means insert state change notes and time stamps into a drawer.
2654 When nil, state changes notes will be inserted after the headline and
2655 any scheduling and clock lines, but not inside a drawer.
2657 The value of this variable should be the name of the drawer to use.
2658 LOGBOOK is proposed as the default drawer for this purpose, you can
2659 also set this to a string to define the drawer of your choice.
2663 A value of t or nil can also be set with on a per-file-basis with
2665 #+STARTUP: logdrawer
2666 #+STARTUP: nologdrawer
2668 If this variable is set, `org-log-state-notes-insert-after-drawers'
2669 will be ignored.
2671 You can set the property LOG_INTO_DRAWER to overrule this setting for
2672 a subtree."
2683 "Return the value of `org-log-into-drawer', but let properties overrule.
2684 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2685 used instead of the default value."
2694 "Non-nil means insert state change notes after any drawers in entry.
2695 Only the drawers that *immediately* follow the headline and the
2696 deadline/scheduled line are skipped.
2697 When nil, insert notes right after the heading and perhaps the line
2698 with deadline/scheduling if present.
2700 This variable will have no effect if `org-log-into-drawer' is
2701 set."
2707 "Non-nil means the latest state note will be directly after heading.
2708 When nil, the state change notes will be ordered according to time.
2710 This option can also be set with on a per-file-basis with
2712 #+STARTUP: logstatesreversed
2713 #+STARTUP: nologstatesreversed"
2719 "The TODO state to which a repeater should return the repeating task.
2720 By default this is the first task in a TODO sequence, or the previous state
2721 in a TODO_TYP set. But you can specify another task here.
2722 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2729 "Non-nil means record moving through the DONE state when triggering repeat.
2730 An auto-repeating task is immediately switched back to TODO when
2733 record a closing note, there will be no record of the task moving
2734 through DONE. This variable forces taking a note anyway.
2736 nil Don't force a record
2737 time Record a time stamp
2738 note Prompt for a note and add it with template `org-log-note-headings'
2740 This option can also be set with on a per-file-basis with
2742 #+STARTUP: nologrepeat
2743 #+STARTUP: logrepeat
2744 #+STARTUP: lognoterepeat
2746 You can have local logging settings for a subtree by setting the LOGGING
2747 property to one or more of these keywords."
2757 "Priorities in Org-mode."
2762 "Non-nil means priority commands are active.
2763 When nil, these commands will be disabled, so that you never accidentally
2764 set a priority."
2769 "The highest priority of TODO items. A character like ?A, ?B etc.
2770 Must have a smaller ASCII number than `org-lowest-priority'."
2775 "The lowest priority of TODO items. A character like ?A, ?B etc.
2776 Must have a larger ASCII number than `org-highest-priority'."
2781 "The default priority of TODO items.
2782 This is the priority an item gets if no explicit priority is given.
2783 When starting to cycle on an empty priority the first step in the cycle
2784 depends on `org-priority-start-cycle-with-default'. The resulting first
2785 step priority must not exceed the range from `org-highest-priority' to
2786 `org-lowest-priority' which means that `org-default-priority' has to be
2787 in this range exclusive or inclusive the range boundaries. Else the
2788 first step refuses to set the default and the second will fall back
2789 to (depending on the command used) the highest or lowest priority."
2794 "Non-nil means start with default priority when starting to cycle.
2795 When this is nil, the first step in the cycle will be (depending on the
2796 command used) one higher or lower than the default priority.
2797 See also `org-default-priority'."
2802 "Function to extract the priority from a string.
2803 The string is normally the headline. If this is nil Org computes the
2804 priority from the priority cookie like [#A] in the headline. It returns
2805 an integer, increasing by 1000 for each priority level.
2806 The user can set a different function here, which should take a string
2807 as an argument and return the numeric priority."
2813 "Options concerning time stamps and deadlines in Org-mode."
2818 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2819 When nil, these labeled time stamps are forces into the second line of an
2820 entry, just after the headline. When scheduling from the global TODO list,
2821 the time stamp will always be forced into the second line."
2826 "Formats for `format-time-string' which are used for time stamps.
2830 "Number of minutes to round time stamps to.
2831 These are two values, the first applies when first creating a time stamp.
2832 The second applies when changing it with the commands `S-up' and `S-down'.
2833 When changing the time stamp, this means that it will change in steps
2834 of N minutes, as given by the second value.
2836 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2837 numbers should be factors of 60, so for example 5, 10, 15.
2839 When this is larger than 1, you can still force an exact time stamp by using
2840 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2841 and by using a prefix arg to `S-up/down' to specify the exact number
2842 of minutes to shift."
2852 ;; Normalize old customizations of this variable.
2856 org-time-stamp-rounding-minutes)))
2859 "Non-nil means overlay custom formats over all time stamps.
2860 The formats are defined through the variable `org-time-stamp-custom-formats'.
2861 To turn this on on a per-file basis, insert anywhere in the file:
2862 #+STARTUP: customtime"
2870 "Custom formats for time stamps. See `format-time-string' for the syntax.
2871 These are overlaid over the default ISO format if the variable
2872 `org-display-custom-times' is set. Time like %H:%M should be at the
2873 end of the second format. The custom formats are also honored by export
2874 commands, if custom time display is turned on at the time of export."
2879 "Get the right format for a time string."
2884 f)))
2888 "The format string used when creating CLOCKSUM lines.
2889 This is also used when Org mode generates a time duration.
2891 The value can be a single format string containing two
2892 %-sequences, which will be filled with the number of hours and
2893 minutes in that order.
2895 Alternatively, the value can be a plist associating any of the
2896 keys :years, :months, :weeks, :days, :hours or :minutes with
2897 format strings. The time duration is formatted using only the
2898 time components that are needed and concatenating the results.
2899 If a time unit in absent, it falls back to the next smallest
2900 unit.
2902 The keys :require-years, :require-months, :require-days,
2903 :require-weeks, :require-hours, :require-minutes are also
2904 meaningful. A non-nil value for these keys indicates that the
2905 corresponding time component should always be included, even if
2906 its value is 0.
2909 For example,
2912 :require-minutes t)
2914 means durations longer than a day will be expressed in days,
2915 hours and minutes, and durations less than a day will always be
2916 expressed in hours and minutes (even for durations less than an
2917 hour).
2919 The value
2923 means durations longer than a day will be expressed in days and
2924 minutes, and durations less than a day will be expressed entirely
2925 in minutes (even for durations longer than an hour)."
2965 See `org-time-clocksum-format' for more on time clock formats."
2973 E.g. by default, one day is considered to be a 8 hours effort,
2974 so a task that has been clocked for 16 hours will be displayed
2975 as during 2 days in the clock display or in the clocktable.
2977 See `org-effort-durations' on how to set effort durations
2978 and `org-time-clocksum-format' for more on time clock formats."
2986 "The format string used when creating CLOCKSUM lines,
2987 or when Org mode generates a time duration, if
2988 `org-time-clocksum-use-fractional' is enabled.
2990 The value can be a single format string containing one
2991 %-sequence, which will be filled with the number of hours as
2992 a float.
2994 Alternatively, the value can be a plist associating any of the
2995 keys :years, :months, :weeks, :days, :hours or :minutes with
2996 a format string. The time duration is formatted using the
2997 largest time unit which gives a non-zero integer part. If all
2998 specified formats have zero integer part, the smallest time unit
2999 is used."
3016 "Number of days before expiration during which a deadline becomes active.
3017 This variable governs the display in sparse trees and in the agenda.
3018 When 0 or negative, it means use this number (the absolute value of it)
3019 even if a deadline has a different individual lead time specified.
3021 Custom commands can set this variable in the options section."
3027 "Number of days before a scheduled item becomes active.
3028 This variable governs the display in sparse trees and in the agenda.
3029 The default value (i.e. 0) means: don't delay scheduled item.
3030 When negative, it means use this number (the absolute value of it)
3031 even if a scheduled item has a different individual delay time
3032 specified.
3034 Custom commands can set this variable in the options section."
3042 "Non-nil means assume future for incomplete date input from user.
3043 This affects the following situations:
3044 1. The user gives a month but not a year.
3047 2. The user gives a day, but no month.
3050 it will be considered as *this* month.
3052 If you set this variable to the symbol `time', then also the following
3053 will work:
3055 3. If the user gives a time.
3056 If the time is before now, it will be interpreted as tomorrow.
3058 Currently none of this works for ISO week specifications.
3060 When this option is nil, the current day, month and year will always be
3061 used as defaults.
3063 See also `org-agenda-jump-prefer-future'."
3071 "Should the agenda jump command prefer the future for incomplete dates?
3072 The default is to do the same as configured in `org-read-date-prefer-future'.
3073 But you can also set a deviating value here.
3074 This may t or nil, or the symbol `org-read-date-prefer-future'."
3080 org-read-date-prefer-future)
3085 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3087 Depending on the system Emacs is running on, certain dates cannot
3088 be represented with the type used internally to represent time.
3089 Dates between 1970-1-1 and 2038-1-1 can always be represented
3090 correctly. Some systems allow for earlier dates, some for later,
3091 some for both. One way to find out it to insert any date into an
3092 Org buffer, putting the cursor on the year and hitting S-up and
3093 S-down to test the range.
3095 When this variable is set to t, the date/time prompt will not let
3096 you specify dates outside the 1970-2037 range, so it is certain that
3097 these dates will work in whatever version of Emacs you are
3098 running, and also that you can move a file from one Emacs implementation
3099 to another. WHenever Org is forcing the year for you, it will display
3100 a message and beep.
3102 When this variable is nil, Org will check if the date is
3103 representable in the specific Emacs implementation you are using.
3104 If not, it will force a year, usually the current year, and beep
3105 to remind you. Currently this setting is not recommended because
3106 the likelihood that you will open your Org files in an Emacs that
3107 has limited date range is not negligible.
3109 A workaround for this problem is to use diary sexp dates for time
3110 stamps outside of this range."
3116 "Non-nil means display current interpretation of date prompt live.
3117 This display will be in an overlay, in the minibuffer."
3122 "Non-nil means pop up a calendar when prompting for a date.
3123 In the calendar, the date can be selected with mouse-1. However, the
3124 minibuffer will also be active, and you can simply enter the date as well.
3125 When nil, only the minibuffer will be available."
3132 'org-read-date-minibuffer-setup-hook
3135 "Hook to be used to set up keys for the date/time interface.
3136 Add key definitions to `minibuffer-local-map', which will be a
3137 temporary copy.
3139 WARNING: This option is obsolete, you should use
3140 `org-read-date-minibuffer-local-map' to set up keys."
3145 "The hour when your day really ends. Must be an integer.
3146 This has influence for the following applications:
3148 the time given here, the day recognized as TODAY is actually yesterday.
3149 - When a date is read from the user and it is still before the time given
3150 here, the current date and time will be assumed to be yesterday, 23:59.
3151 Also, timestamps inserted in capture templates follow this rule.
3153 IMPORTANT: This is a feature whose implementation is and likely will
3154 remain incomplete. Really, it is only here because past midnight seems to
3155 be the favorite working time of John Wiegley :-)"
3160 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3161 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3163 23:59 of the previous day."
3169 "When non-nil, use the last clock out time for `org-todo'.
3170 Note that this option has precedence over the combined use of
3171 `org-use-effective-time' and `org-extend-today-until'."
3178 "Non-nil means S-down will increase the time in a time stamp.
3179 When nil, S-up will increase."
3184 "Non-nil means make the calendar window follow timestamp changes.
3185 When a timestamp is modified and the calendar window is visible, it will be
3186 moved to the new date."
3191 "Options concerning tags in Org-mode."
3196 "List of tags allowed in Org-mode files.
3197 When this list is nil, Org-mode will base TAG input on what is already in the
3198 buffer.
3199 The value of this variable is an alist, the car of each entry must be a
3200 keyword as a string, the cdr may be a character that is used to select
3201 that tag through the fast-tag-selection interface.
3202 See the manual for details."
3219 "List of tags that will always appear in all Org-mode files.
3220 This is in addition to any in buffer settings or customizations
3221 of `org-tag-alist'.
3222 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3223 The value of this variable is an alist, the car of each entry must be a
3224 keyword as a string, the cdr may be a character that is used to select
3225 that tag through the fast-tag-selection interface.
3226 See the manual for details.
3227 To disable these tags on a per-file basis, insert anywhere in the file:
3228 #+STARTUP: noptag"
3240 "If non-nil, always offer completion for all tags of all agenda files.
3241 Instead of customizing this variable directly, you might want to
3242 set it locally for capture buffers, because there no list of
3243 tags in that file can be created dynamically (there are none).
3245 (add-hook 'org-capture-mode-hook
3246 (lambda ()
3247 (set (make-local-variable
3248 'org-complete-tags-always-offer-all-agenda-tags)
3249 t)))"
3255 "List of tags that can be inherited by all entries in the file.
3256 The tags will be inherited if the variable `org-use-tag-inheritance'
3257 says they should be.
3261 "Non-nil means use fast tag selection scheme.
3262 This is a special interface to select and deselect tags with single keys.
3263 When nil, fast selection is never used.
3264 When the symbol `auto', fast selection is used if and only if selection
3265 characters for tags have been configured, either through the variable
3266 `org-tag-alist' or through a #+TAGS line in the buffer.
3267 When t, fast selection is always used and selection keys are assigned
3268 automatically if necessary."
3276 "Non-nil means fast tag selection exits after first change.
3277 When nil, you have to press RET to exit it.
3278 During fast tag selection, you can toggle this flag with `C-c'.
3279 This variable can also have the value `expert'. In this case, the window
3280 displaying the tags menu is not even shown, until you press C-c again."
3288 "Non-nil means fast tags selection interface will also offer TODO states.
3292 "The column to which tags should be indented in a headline.
3293 If this number is positive, it specifies the column. If it is negative,
3294 it means that the tags should be flushright to that column. For example,
3295 -80 works well for a normal 80 character screen.
3296 When 0, place tags directly after headline text, with only one space in
3297 between."
3302 "Non-nil keeps tags aligned when modifying headlines.
3303 Some operations (i.e. demoting) change the length of a headline and
3304 therefore shift the tags around. With this option turned on, after
3305 each such operation the tags are again aligned to `org-tags-column'."
3310 "Non-nil means tags in levels apply also for sublevels.
3311 When nil, only the tags directly given in a specific line apply there.
3312 This may also be a list of tags that should be inherited, or a regexp that
3313 matches tags that should be inherited. Additional control is possible
3314 with the variable `org-tags-exclude-from-inheritance' which gives an
3315 explicit list of tags to be excluded from inheritance, even if the value of
3316 `org-use-tag-inheritance' would select it for inheritance.
3318 If this option is t, a match early-on in a tree can lead to a large
3319 number of matches in the subtree when constructing the agenda or creating
3320 a sparse tree. If you only want to see the first match in a tree during
3321 a search, check out the variable `org-tags-match-list-sublevels'."
3330 "List of tags that should never be inherited.
3331 This is a way to exclude a few tags from inheritance. For way to do
3332 the opposite, to actively allow inheritance for selected tags,
3333 see the variable `org-use-tag-inheritance'."
3338 "Check if TAG is one that should be inherited."
3350 "Non-nil means list also sublevels of headlines matching a search.
3351 This variable applies to tags/property searches, and also to stuck
3352 projects because this search is based on a tags match as well.
3354 When set to the symbol `indented', sublevels are indented with
3355 leading dots.
3357 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3358 the sublevels of a headline matching a tag search often also match
3359 the same search. Listing all of them can create very long lists.
3360 Setting this variable to nil causes subtrees of a match to be skipped.
3362 This variable is semi-obsolete and probably should always be true. It
3363 is better to limit inheritance to certain tags using the variables
3364 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3372 "When set, tags are sorted using this function as a comparator."
3388 "Options concerning properties in Org-mode."
3393 "How property key/value pairs should be formatted by `indent-line'.
3394 When `indent-line' hits a property definition, it will format the line
3395 according to this format, mainly to make sure that the values are
3396 lined-up with respect to each other."
3401 "Alist of properties and functions to adjust inserted values.
3402 Elements of this alist must be of the form
3404 ([string] [function])
3406 where [string] must be a property name and [function] must be a
3407 lambda expression: this lambda expression must take one argument,
3408 the value to adjust, and return the new value as a string.
3412 and the clock summary:
3415 (let ((clocksum (org-clock-sum-current-item))
3416 (effort (org-duration-string-to-minutes
3418 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3425 "Non-nil means properties apply also for sublevels.
3427 This setting is chiefly used during property searches. Turning it on can
3428 cause significant overhead when doing a search, which is why it is not
3429 on by default.
3431 When nil, only the properties directly given in the current entry count.
3432 When t, every property is inherited. The value may also be a list of
3433 properties that should have inheritance, or a regular expression matching
3434 properties that should be inherited.
3436 However, note that some special properties use inheritance under special
3437 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3439 for valid values of a property.
3441 Note for programmers:
3442 When querying an entry with `org-entry-get', you can control if inheritance
3443 should be used. By default, `org-entry-get' looks only at the local
3444 properties. You can request inheritance by setting the inherit argument
3445 to t (to force inheritance) or to `selective' (to respect the setting
3446 in this variable)."
3455 "Check if PROPERTY is one that should be inherited."
3466 "The default column format, if no other format has been defined.
3467 This variable can be set on the per-file basis by inserting a line
3469 #+COLUMNS: %25ITEM ....."
3474 "The ellipses to be used when a field in column view is truncated.
3475 When this is the empty string, as many characters as possible are shown,
3476 but then there will be no visual indication that the field has been truncated.
3477 When this is a string of length N, the last N characters of a truncated
3478 field are replaced by this string. If the column is narrower than the
3479 ellipses string, only part of the ellipses string will be shown."
3484 "Function that modifies values for display in column view.
3485 For example, it can be used to cut out a certain part from a time stamp.
3486 The function must take 2 arguments:
3488 column-title The title of the column (*not* the property name)
3489 value The value that should be modified.
3491 The function should return the value that should be displayed,
3492 or nil if the normal value should be used."
3497 "The property that is being used to keep track of effort estimates.
3498 Effort estimates given in this property need to have the format H:MM."
3506 "List of property/value pairs that can be inherited by any entry.
3508 These are fixed values, for the preset properties. The user variable
3509 that can be used to add to this list is `org-global-properties'.
3511 The entries in this list are cons cells where the car is a property
3512 name and cdr is a string with the value. If the value represents
3517 "List of property/value pairs that can be inherited by any entry.
3519 This list will be combined with the constant `org-global-properties-fixed'.
3521 The entries in this list are cons cells where the car is a property
3522 name and cdr is a string with the value.
3524 You can set buffer-local values for the same purpose in the variable
3525 `org-file-properties' this by adding lines like
3527 #+PROPERTY: NAME VALUE"
3534 "List of property/value pairs that can be inherited by any entry.
3535 Valid for the current buffer.
3540 "Options concerning agenda views in Org-mode."
3545 "Variable used by org files to set a category for agenda display.
3546 Such files should use a file variable to set it, for example
3550 or contain a special line
3552 #+CATEGORY: ELisp
3554 If the file does not specify a category, then file's base name
3560 "The files to be used for agenda display.
3564 If an entry is a directory, all files in that directory that are matched by
3565 `org-agenda-file-regexp' will be part of the file list.
3567 If the value of the variable is not a list but a single file name, then
3568 the list of agenda files is actually stored and maintained in that file, one
3569 agenda file per line. In this file paths can be given relative to
3570 `org-directory'. Tilde expansion and environment variable substitution
3571 are also made."
3578 "Regular expression to match files for `org-agenda-files'.
3579 If any element in the list in that variable contains a directory instead
3580 of a normal file, all files in that directory that are matched by this
3581 regular expression will be included."
3586 "List of extra files to be searched by text search commands.
3587 These files will be search in addition to the agenda files by the
3588 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3589 Note that these files will only be searched for text search commands,
3590 not for the other agenda views like todo lists, tag searches or the weekly
3591 agenda. This variable is intended to list notes and possibly archive files
3592 that should also be searched by these two commands.
3593 In fact, if the first element in the list is the symbol `agenda-archives',
3594 than all archive files of all agenda files will be added to the search
3595 scope."
3605 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3606 A nil value means to remove them, after a query, from the list."
3611 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3612 The command `org-calendar-goto-agenda' will be bound to this key. The
3613 default is the character `c' because then `c' can be used to switch back and
3614 forth between agenda and calendar."
3619 "The key to be installed in `calendar-mode-map' for adding diary entries.
3620 This option is irrelevant until `org-agenda-diary-file' has been configured
3621 to point to an Org-mode file. When that is the case, the command
3622 `org-agenda-diary-entry' will be bound to the key given here, by default
3623 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3624 if you want to continue doing this, you need to change this to a different
3625 key."
3630 "File to which to add new entries with the `i' key in agenda and calendar.
3631 When this is the symbol `diary-file', the functionality in the Emacs
3632 calendar will be used to add entries to the `diary-file'. But when this
3633 points to a file, `org-agenda-diary-entry' will be used instead."
3647 org-calendar-insert-diary-entry-key
3651 "Options for embedding LaTeX code into Org-mode."
3659 "Options for creating images from LaTeX fragments.
3660 This is a property list with the following properties:
3662 `default' means use the foreground of the default face.
3663 `auto' means use the foreground from the text face.
3665 `default' means use the background of the default face.
3666 `auto' means use the background from the text face.
3667 :scale a scaling factor for the size of the images, to get more pixels
3668 :html-foreground, :html-background, :html-scale
3669 the same numbers for HTML export.
3670 :matchers a list indicating which matchers should be used to
3671 find LaTeX fragments. Valid members of this list are:
3682 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3683 When nil, just push out a message."
3690 Use this to specify additional executable file say a jar file.
3692 When using MathToWeb as the converter, specify the full-path to
3693 your mathtoweb.jar file."
3701 "Command to convert LaTeX fragments to MathML.
3702 Replace format-specifiers in the command as noted below and use
3703 `shell-command' to convert LaTeX to MathML.
3704 %j: Executable file in fully expanded form as specified by
3705 `org-latex-to-mathml-jar-file'.
3706 %I: Input LaTeX file in fully expanded form
3707 %o: Output MathML file
3708 This command is used by `org-create-math-formula'.
3710 When using MathToWeb as the converter, set this to
3719 "Program to convert LaTeX fragments with.
3721 dvipng Process the LaTeX fragments to dvi file, then convert
3722 dvi files to png files using dvipng.
3723 This will also include processing of non-math environments.
3724 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3725 to convert pdf files to png files"
3733 "Path to store latex preview images.
3734 A relative path here creates many directories relative to the
3735 processed org files paths. An absolute path puts all preview
3736 images at the same place."
3742 "Return t if `org-latex-to-mathml-convert-command' is usable."
3745 org-latex-to-mathml-convert-command)
3747 org-latex-to-mathml-convert-command))))
3752 t))))))
3759 \[PACKAGES]
3760 \[DEFAULT-PACKAGES]
3761 % The settings below are copied from fullpage.sty
3774 "The document header used for processing LaTeX fragments.
3775 It is imperative that this header make sure that no page number
3776 appears on the page. The package defined in the variables
3777 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3779 header, or they will be appended."
3784 "Set the packages alist and make sure it has 3 elements per entry."
3788 x))
3789 val)))
3792 "Get the packages alist and make sure it has 3 elements per entry."
3796 x))
3815 "Alist of default packages to be inserted in the header.
3817 Change this only if one of the packages here causes an
3818 incompatibility with another package you are using.
3820 The packages in this list are needed by one part or another of
3821 Org mode to function properly:
3823 - inputenc, fontenc: for basic font and character selection
3824 - textcomp, marvosymb, wasysym, latexsym, amssym: for various
3825 symbols used for interpreting the entities in `org-entities'.
3826 You can skip some of these packages if you don't use any of the
3827 symbols in it.
3828 - graphicx: for including images
3829 - float, wrapfig: for figure placement
3830 - longtable: for long tables
3831 - hyperref: for cross references
3833 Therefore you should not modify this variable unless you know
3834 what you are doing. The one reason to change it anyway is that
3835 you might be loading some other package that conflicts with one
3836 of the default packages. Each cell is of the format
3838 the package also needs to be included when compiling LaTeX
3839 snippets into images for inclusion into non-LaTeX output."
3854 "Alist of packages to be inserted in every LaTeX header.
3856 These will be inserted after `org-latex-default-packages-alist'.
3857 Each cell is of the format:
3861 SNIPPET-FLAG, when t, indicates that this package is also needed
3862 when turning LaTeX snippets into images for inclusion into
3863 non-LaTeX output.
3865 Make sure that you only list packages here which:
3867 - you want in every file
3868 - do not conflict with the setup in `org-format-latex-header'.
3869 - do not conflict with the default packages in
3870 `org-latex-default-packages-alist'."
3884 "Settings for Org-mode appearance."
3889 "Non-nil means fontify only the stars in each headline.
3890 When nil, the entire headline is fontified.
3891 Changing it requires restart of `font-lock-mode' to become effective
3892 also in regions already fontified."
3897 "Non-nil means hide the first N-1 stars in a headline.
3898 This works by using the face `org-hide' for these stars. This
3899 face is white for a light background, and black for a dark
3900 background. You may have to customize the face `org-hide' to
3901 make this work.
3902 Changing it requires restart of `font-lock-mode' to become effective
3903 also in regions already fontified.
3904 You may also set this on a per-file basis by adding one of the following
3905 lines to the buffer:
3907 #+STARTUP: hidestars
3908 #+STARTUP: showstars"
3913 "List of symbols corresponding to keywords to be hidden the org buffer.
3914 For example, a value '(title) for this list will make the document's title
3915 appear in the buffer without the initial #+TITLE: keyword."
3924 "List of properties (as strings) with a special meaning.
3925 The default use of these custom properties is to let the user
3926 hide them with `org-toggle-custom-properties-visibility'."
3933 "Non-nil means change the face of a headline if it is marked DONE.
3934 Normally, only the TODO/DONE keyword indicates the state of a headline.
3935 When this is non-nil, the headline after the keyword is set to the
3936 `org-headline-done' as an additional indication."
3941 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3942 Changing this variable requires a restart of Emacs to take effect."
3947 "Non-nil means fontify the whole line for headings.
3948 This is useful when setting a background color for the
3949 org-level-* faces."
3954 "Non-nil means highlight LaTeX related syntax in the buffer.
3955 When non nil, the value should be a list containing any of the
3956 following symbols:
3957 `latex' Highlight LaTeX snippets and environments.
3958 `script' Highlight subscript and superscript.
3959 `entities' Highlight entities."
3971 "Non-nil mean font-lock should hide the emphasis marker characters."
3976 "Non-nil means show entities as UTF8 characters.
3983 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3989 "Regular expression for matching emphasis.
3990 After a match, the match groups contain these elements:
3991 0 The match of the full regular expression, including the characters
3992 before and after the proper match
3993 1 The character before the proper match, or empty at beginning of line
3994 2 The proper match, including the leading and trailing markers
3995 3 The leading marker like * or /, indicating the type of highlighting
3996 4 The text between the emphasis markers, not including the markers
4003 "Set variable and compute the emphasis regular expression."
4007 org-emphasis-alist org-emphasis-regexp-components)
4019 ;; make sure special characters appear at the right position in the class
4031 ;; Make the regexp
4039 body1
4051 body1
4057 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4058 ;; set this option proved cumbersome. See this message/thread:
4059 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4062 "Components used to build the regular expression for emphasis.
4063 This is a list with five entries. Terminology: In an emphasis string
4067 specify what is allowed/forbidden in each part:
4069 pre Chars allowed as prematch. Beginning of line will be allowed too.
4070 post Chars allowed as postmatch. End of line will be allowed too.
4071 border The chars *forbidden* as border characters.
4073 non-shy groups here, and don't allow newline here.
4074 newline The maximum number of newlines allowed in an emphasis exp.
4085 "Alist of characters and faces to emphasize text.
4086 Text starting and ending with a special character will be emphasized,
4087 for example *bold*, _underlined_ and /italic/. This variable sets the
4088 marker characters and the face to be used by font-lock for highlighting
4089 in Org-mode Emacs buffers.
4091 You need to reload Org or to restart Emacs after customizing this."
4106 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4109 ;;; Miscellaneous options
4112 "Completion in Org-mode."
4117 "Non-nil means use ido completion wherever possible.
4118 Note that `ido-mode' must be active for this variable to be relevant.
4119 If you decide to turn this variable on, you might well want to turn off
4120 `org-outline-path-complete-in-steps'.
4121 See also `org-completion-use-iswitchb'."
4126 "Non-nil means use iswitchb completion wherever possible.
4127 Note that `iswitchb-mode' must be active for this variable to be relevant.
4128 If you decide to turn this variable on, you might well want to turn off
4129 `org-outline-path-complete-in-steps'.
4130 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4136 Normal means, no org-mode-specific context."
4140 ;;; Functions and variables from their packages
4141 ;; Declared here to avoid compiler warnings
4143 ;; XEmacs only
4149 ;; Emacs only
4152 ;; Various packages
4171 org-agenda-format-item "org-agenda"
4198 ;;; Autoload and prepare some org modules
4200 ;; Some table stuff that needs to be defined here, because it is used
4201 ;; by the functions setting up org-mode or checking for table context.
4214 "Detect the first line outside a table when searching from within it.
4217 ;; Autoload the functions in org-table.el that are needed by functions here.
4226 ;;;###autoload
4228 "Unconditionally turn on `orgtbl-mode'."
4233 "Return t if the cursor is inside an org-type table.
4234 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4239 org-table-line-regexp)))
4240 nil))
4244 "Return t if and only if we are at a table.el table."
4251 "If there is a table.el table nearby, recognize it and move into it."
4257 nil
4267 t
4272 t)
4273 nil)
4274 nil))
4277 "Return t if the cursor is inside a hline in a table."
4282 nil))
4286 "Apply FUNCTION to the start of all tables in the buffer."
4296 ;; Exclude tables in src/example/verbatim/clocktable blocks
4304 ;; Declare and autoload functions from ox.el and al.
4310 ;; Declare and autoload functions from org-agenda.el
4322 "Return t when point (or POS) is in #+TBLFM line."
4337 "Return non-nil if clock is currently running.
4338 The return value is actually the clock marker."
4343 org-clock-update-time-maybe
4344 org-clocktable-shift)))
4347 "Check if the current buffer contains the running clock.
4348 If yes, offer to stop it and to save the buffer with the changes."
4357 "Check if this line starts a clock table, if yes, shift the time block."
4361 ;;;###autoload
4363 "Set up hooks for clock persistence."
4368 ;; Define the variable already here, to make sure we have it.
4370 "Non-nil if Org-Indent mode is enabled.
4373 ;; Autoload archiving code
4374 ;; The stuff that is needed for cycling and tags has to be defined here.
4377 "Options concerning archiving in Org-mode."
4382 "The location where subtrees should be archived.
4384 The value of this variable is a string, consisting of two parts,
4385 separated by a double-colon. The first part is a filename and
4386 the second part is a headline.
4388 When the filename is omitted, archiving happens in the same file.
4389 %s in the filename will be replaced by the current file
4390 name (without the directory part). Archiving to a different file
4391 is useful to keep archived entries from contributing to the
4392 Org-mode Agenda.
4394 The archived entries will be filed as subtrees of the specified
4395 headline. When the headline is omitted, the subtrees are simply
4396 filed away at the end of the file, as top-level entries. Also in
4397 the heading you can use %s to represent the file name, this can be
4398 useful when using the same archive for a number of different files.
4400 Here are a few examples:
4402 If the current file is Projects.org, archive in file
4403 Projects.org_archive, as top-level trees. This is the default.
4406 Archive in the current file, under the top-level headline
4410 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4413 Archive in file ~/org/archive.org (absolute path), under headlines
4418 items to the datetree. Items are placed in either the CLOSED
4419 date of the item, or the current date if there is no CLOSED date.
4420 The heading will be a subentry to the current date. There doesn't
4421 need to be a heading, but there always needs to be a slash after
4422 datetree. For example, to store archived items directly in the
4426 Archive in file ./basement (relative path), as level 3 trees
4429 You may set this option on a per-file basis by adding to the buffer a
4430 line like
4432 #+ARCHIVE: basement::** Finished Tasks
4434 You may also define it locally for a subtree by setting an ARCHIVE property
4435 in the entry. If such a property is found in an entry, or anywhere up
4436 the hierarchy, it will be used."
4441 "The tag that marks a subtree as archived.
4442 An archived subtree does not open during visibility cycling, and does
4443 not contribute to the agenda listings.
4444 After changing this, font-lock must be restarted in the relevant buffers to
4445 get the proper fontification."
4451 "Non-nil means the agenda will skip any items located in archived trees.
4452 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4453 variable is no longer recommended, you should leave it at the value t.
4454 Instead, use the key `v' to cycle the archives-mode in the agenda."
4460 "Non-nil means ignore archived trees when creating column view."
4466 "Non-nil means `org-cycle' will open archived trees.
4467 An archived tree is a tree marked with the tag ARCHIVE.
4468 When nil, archived trees will stay folded. You can still open them with
4469 normal outline commands like `show-all', but not with the cycling commands."
4475 "Non-nil means sparse tree construction shows matches in archived trees.
4476 When nil, matches in these trees are highlighted, but the trees are kept in
4477 collapsed state."
4483 "The default date type when building a sparse tree.
4484 When this is nil, a date is a scheduled or a deadline timestamp.
4485 Otherwise, these types are allowed:
4487 all: all timestamps
4488 active: only active timestamps (<...>)
4489 inactive: only inactive timestamps (<...)
4490 scheduled: only scheduled timestamps
4491 deadline: only deadline timestamps"
4503 "Re-hide all archived subtrees after a visibility state change."
4514 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4517 "Cycle subtree even if it is archived."
4524 "Re-hide all archived subtrees after a visibility state change."
4541 flag)))
4549 ;; Autoload Column View Code
4557 org-columns-get-format-and-top-level
4558 org-columns-compute
4559 org-columns-remove-overlays))
4561 ;; Autoload ID code
4569 org-id-copy
4570 org-id-get-with-outline-path-completion
4571 org-id-get-with-outline-drilling))
4573 ;;; Variables for pre-computed regular expressions, all buffer local
4591 "Matches a headline and puts everything into groups:
4592 group 1: the stars
4593 group 2: The todo keyword, maybe
4594 group 3: Priority cookie
4595 group 4: True headline
4599 "Printf format to make regexp to match an exact headline.
4600 This regexp will match the headline of any node which has the
4601 exact headline text that is put into the format, but may have any
4605 "Matches a headline and puts TODO state into group 2 if present.
4657 "Regular expression to match a plain time or time range.
4658 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4659 groups carry important information:
4660 0 the full match
4661 1 the first time, range or not
4669 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4670 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4671 groups carry important information:
4672 0 the full match
4673 7 hours of duration
4682 "Regular expression to match a timestamp time or time range.
4683 After a match, the following groups carry important information:
4684 0 the full match
4685 1 date plus weekday, for back referencing to make sure both times are on the same day
4686 2 the first time, range or not
4747 "Variable associated with STARTUP options for org-mode.
4748 Each element is a list of three items: the startup options (as written
4749 in the #+STARTUP line), the corresponding variable, and the value to set
4750 this variable to if the option is found. An optional forth element PUSH
4754 "Update PROPS with KEY and VAL."
4768 "Printf format for a regexp matching a headline with some keyword.
4769 This regexp will match the headline of any node which has the
4770 exact keyword that is put into the format. The keyword isn't in
4774 "Printf format for a regexp matching a headline, possibly with some keyword.
4775 This regexp can match any headline with the specified keyword, or
4776 without a keyword. The keyword isn't in any group by default,
4780 "When non-nil (the default), use group tags.
4781 This can be turned on/off through `org-toggle-tags-groups'."
4787 "Toggle support for group tags.
4788 Support for group tags is controlled by the option
4789 `org-group-tags', which is non-nil by default."
4793 org-group-tags)
4801 "Precompute regular expressions used for tags in the current buffer."
4807 tags ftags key value)
4824 ftags
4828 ;; Process the file tags.
4832 ;; Process the tags.
4833 ;; FIXME
4843 org-tag-groups-alist)
4868 "Precompute regular expressions used in the current buffer."
4886 kwds kws0 kwsa key log value cat arch const links hw dws
4887 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4900 org-tag-groups-alist))))
4920 ;; general TODO-like setup
4929 links)))
4936 props))))
4943 l var val)
4961 ;; Prevent checking in Gnus messages
4973 ;; search for property blocks
4982 props)))))))
4997 ;; Process the TODO keywords
4999 ;; Use the global values as if they had been given locally.
5011 kws)))
5014 kwsa nil
5017 ;; 1 2
5025 kw)
5027 kws0)
5044 ;; Compute the regular expressions and other local variables.
5045 ;; Using `org-outline-regexp-bol' would complicate them much,
5046 ;; because of the fixed white space at the end of that string.
5054 org-drawer-regexp
5058 org-not-done-keywords
5060 org-todo-regexp
5064 org-not-done-regexp
5068 org-not-done-heading-regexp
5070 org-todo-line-regexp
5072 org-complex-heading-regexp
5079 org-complex-heading-regexp-format
5084 ;; Stats cookies can be stuck to body.
5091 org-todo-line-tags-regexp
5098 org-deadline-time-regexp
5100 org-deadline-time-hour-regexp
5103 org-deadline-line-regexp
5105 org-scheduled-regexp
5107 org-scheduled-time-regexp
5109 org-scheduled-time-hour-regexp
5112 org-closed-time-regexp
5114 org-keyword-time-regexp
5120 org-keyword-time-not-clock-regexp
5126 org-maybe-keyword-time-regexp
5132 org-all-time-keywords
5135 org-clock-string org-closed-string)))
5140 "Return the contents of FILE, as a string."
5151 "Extract the log state setting from a TODO keyword string.
5165 "Remove a pair of parenthesis at the end of each string in LIST."
5169 x))
5170 list))
5173 "Assign fast keys to a keyword-key alist.
5174 Respect keys that are already there."
5192 ;;; Some variables used in various places
5199 "Function to be called when `C-c C-c' is used.
5203 ;; FIXME: Occasionally check by commenting these, to make sure
5204 ;; no other functions uses these, forgetting to let-bind them.
5209 ;; Defined somewhere in this file, but used before definition.
5215 ;;;; Define the Org-mode
5217 ;; We use a before-change function to check if a table might need
5218 ;; an update.
5220 "Indicates that a table might need an update.
5221 This variable is set by `org-before-change-function'.
5224 "Every change indicates that a table might need an update."
5239 (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"))
5242 ;; Other stuff we need.
5248 ;; (require 'org-macs) moved higher up in the file before it is first used
5250 ;; (require 'org-compat) moved higher up in the file before it is first used
5258 ;; babel
5261 ;;;###autoload
5263 "Outline-based notes management and organizer, alias
5266 Org-mode develops organizational tasks around a NOTES file which
5267 contains information about projects as plain text. Org-mode is
5268 implemented on top of outline-mode, which is ideal to keep the content
5269 of large files well structured. It supports ToDo items, deadlines and
5270 time stamps, which magically appear in the diary listing of the Emacs
5271 calendar. Tables are easily created with a built-in table editor.
5272 Plain text URL-like links connect to websites, emails (VM), Usenet
5273 messages (Gnus), BBDB entries, and any files related to the project.
5274 For printing and sharing of notes, an Org-mode file (or a part of it)
5275 can be exported as a structured ASCII or HTML file.
5277 The following commands are available:
5281 ;; Get rid of Outline menus, they are not needed
5282 ;; Need to do this here because define-derived-mode sets up
5283 ;; the keymap so late. Still, it is a waste to call this each time
5284 ;; we switch another buffer into org-mode.
5287 ;; Assume this is Greg's port, it uses easymenu
5307 ;; FIXME Circumvent a bug in outline.el (Emacs <24.4)
5315 org-display-table 4
5318 org-ellipsis)))
5324 ;; tag faces set outside customize.... force initialization.
5326 ;; Calc embedded
5328 ;; Modify a few syntax entries
5335 ;; Activate before-change-function
5339 ;; Check for running clock before killing a buffer
5341 ;; Initialize macros templates.
5343 ;; Initialize radio targets.
5345 ;; Indentation.
5348 ;; Filling and auto-filling.
5350 ;; Comments.
5352 ;; Beginning/end of defun
5355 ;; Next error for sparse trees
5357 ;; Make sure dependence stuff works reliably, even for users who set it
5358 ;; too late :-(
5370 ;; Align options lines
5372 'align-mode-rules-list
5377 ;; Imenu
5381 ;; Make isearch reveal context
5384 ;; Emacs 21 and XEmacs make use of the hook
5386 ;; Emacs 22 deals with this through a special variable
5391 ;; Setup the pcomplete hooks
5404 ;; If empty file that did not turn on org-mode automatically, make it to.
5420 ;; Try to set org-hide correctly
5423 ;; Update `customize-package-emacs-version-alist'
5433 org-emphasis-alist)
5434 st))
5447 "unspecified-bg"
5460 "Current time, possibly rounded to ROUNDING-MINUTES.
5461 When ROUNDING-MINUTES is not an integer, fall back on the car of
5462 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5463 the rounding returns a past time."
5475 res))))
5478 "Return today date, considering `org-extend-today-until'."
5483 ;;;; Font-Lock stuff, including the activators
5514 "Regular expression used to analyze links.
5515 Here is what the match groups contain after a match:
5516 1: http:
5517 2: http
5518 3: path
5519 4: [desc]
5530 "Create a regular expression which will match a balanced sexp.
5531 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5532 as single character strings.
5533 The regexp returned will match the entire expression including the
5534 delimiters. It will also define a single group which contains the
5535 match except for the outermost delimiters. The maximum depth of
5536 stacked delimiters is N. Escaping delimiters is not possible."
5565 "Update the link regular expressions.
5566 This should be called after the variable `org-link-types' has changed."
5570 org-link-re-with-space
5576 org-link-re-with-space2
5582 org-link-re-with-space3
5587 org-angle-link-re
5593 org-plain-link-re
5597 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5598 org-bracket-link-regexp
5600 org-bracket-link-analytic-regexp
5608 org-bracket-link-analytic-regexp++
5616 org-any-link-re
5625 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5628 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5629 "Regular expression matching time strings for analysis.
5630 This one does not require the space after the date, so it can be used
5632 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5649 "Regular expression matching a time stamp or time stamp range.
5655 "Run through the buffer and add overlays to emphasized strings."
5664 'face
5677 rtn))
5680 "Insert or change an emphasis, i.e. a font like bold or italic.
5681 If there is an active region, change that region to a new emphasis.
5682 If there is no region, just insert the marker characters and position
5683 the cursor between them.
5684 CHAR should be the marker character. If it is a space, it means to
5685 remove the emphasis of the selected region.
5686 If CHAR is not given (for example in an interactive call) it will be
5687 prompted for."
5730 "Run through the buffer and add overlays to links."
5739 nil
5746 t)))
5754 t)))
5757 "When non-nil, fontify code in code blocks."
5764 "When non-nil, allow promoting a top level subtree.
5765 The leading star of the top level headline will be replaced
5766 by a #."
5777 "Fontify #+ lines and blocks."
5780 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5781 limit t)
5789 end end1 quoting block-type ovl)
5792 ;; a single line of backend-specific content
5800 ; for backend-specific code
5801 t)
5803 ;; Truly a block
5816 beg end
5824 ;; remove old background overlays
5829 ;; add a background overlay
5844 t))
5864 t)
5870 ;; just any other in-buffer setting, but not indented
5874 t)
5878 "Run through the buffer and add overlays to links."
5887 t)))
5890 "Run through the buffer and add overlays to footnotes."
5897 'keymap org-mouse-map
5898 'help-echo
5900 "Footnote definition"
5902 'font-lock-fontified t
5903 'font-lock-multiline t
5907 "Run through the buffer and add overlays to bracketed links."
5920 ;; We need to remove the invisible property here. Table narrowing
5921 ;; may have made some of this invisible.
5939 t)))
5942 "Run through the buffer and add overlays to dates."
5955 t)))
5964 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5968 "Run through the buffer and add overlays to target matches."
5976 'keymap org-mouse-map
5980 t)))))
5983 "Find all radio targets in this file and update the regular expression."
5998 t)))
6006 "Compute regular expression for LaTeX, entities and sub/superscript.
6007 Result depends on variable `org-highlight-latex-and-related'."
6009 'org-latex-and-related-regexp
6021 org-latex-regexps)))))
6028 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6029 LIMIT bounds the search for syntax to highlight. Stop at first
6030 highlighted object, if any. Return t if some highlighting was
6031 done, nil otherwise."
6040 1
6048 nil)))
6051 "Restart `font-lock-mode', to force refontification."
6057 "Return a list of all targets in this file.
6058 When optional argument RADIO is non-nil, only find radio
6059 targets."
6064 ;; Make sure point is really within the object.
6069 rtn)))
6072 "Make regular expression matching all strings in TARGETS.
6073 The regular expression finds the targets also if there is a line break
6074 between words."
6083 x)
6084 targets
6096 t)))
6099 "Compute the outline level of the heading at point.
6100 If this is called at a normal headline, the level is the number of stars.
6101 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6106 0
6112 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
6119 "Functions that can manipulate `org-font-lock-extra-keywords'.
6120 This is called after `org-font-lock-extra-keywords' is defined, but before
6121 it is installed to be used by font lock. This can be useful if something
6125 "Run `org-font-lock-hook' within LIMIT."
6129 "Set font lock defaults for the current buffer."
6134 ;; Call the hook
6136 ;; Headlines
6143 ;; Table lines
6146 ;; Table internals
6151 ;; Drawers
6154 ;; Properties
6158 ;; Links
6166 ;; Targets.
6168 ;; Diary sexps.
6170 ;; Macro
6173 ;; TODO keyword
6175 org-todo-regexp)
6177 ;; DONE
6185 nil)
6186 ;; Priorities
6188 ;; Tags
6190 ;; Tags groups
6196 ;; Special keywords
6201 ;; Emphasis
6206 ;; Checkboxes
6207 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6212 ;; Description list items
6215 ;; ARCHIVEd headings
6217 org-outline-regexp-bol
6220 ;; Specials
6224 ;; Code
6226 ;; COMMENT
6232 ;; Blocks and meta lines
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 (cons type path))
10200 (defun org-find-file-at-mouse (ev)
10201 "Open file link or URL at mouse."
10202 (interactive "e")
10203 (mouse-set-point ev)
10204 (org-open-at-point 'in-emacs))
10206 (defun org-open-at-mouse (ev)
10207 "Open file link or URL at mouse.
10208 See the docstring of `org-open-file' for details."
10209 (interactive "e")
10210 (mouse-set-point ev)
10211 (if (eq major-mode 'org-agenda-mode)
10212 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10213 (org-open-at-point))
10215 (defvar org-window-config-before-follow-link nil
10216 "The window configuration before following a link.
10217 This is saved in case the need arises to restore it.")
10219 (defvar org-open-link-marker (make-marker)
10220 "Marker pointing to the location where `org-open-at-point; was called.")
10222 ;;;###autoload
10223 (defun org-open-at-point-global ()
10224 "Follow a link like Org-mode does.
10225 This command can be called in any mode to follow a link that has
10226 Org-mode syntax."
10227 (interactive)
10228 (org-run-like-in-org-mode 'org-open-at-point))
10230 ;;;###autoload
10231 (defun org-open-link-from-string (s &optional arg reference-buffer)
10232 "Open a link in the string S, as if it was in Org-mode."
10234 (let ((reference-buffer (or reference-buffer (current-buffer))))
10235 (with-temp-buffer
10236 (let ((org-inhibit-startup (not reference-buffer)))
10237 (org-mode)
10238 (insert s)
10239 (goto-char (point-min))
10240 (when reference-buffer
10241 (setq org-link-abbrev-alist-local
10242 (with-current-buffer reference-buffer
10243 org-link-abbrev-alist-local)))
10244 (org-open-at-point arg reference-buffer)))))
10246 (defvar org-open-at-point-functions nil
10247 "Hook that is run when following a link at point.
10249 Functions in this hook must return t if they identify and follow
10250 a link at point. If they don't find anything interesting at point,
10251 they must return nil.")
10253 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10254 (defun org-open-at-point (&optional arg reference-buffer)
10255 "Open link at or after point.
10256 If there is no link at point, this function will search forward up to
10257 the end of the current line.
10258 Normally, files will be opened by an appropriate application. If the
10259 optional prefix argument ARG is non-nil, Emacs will visit the file.
10260 With a double prefix argument, try to open outside of Emacs, in the
10261 application the system uses for this file type."
10262 (interactive "P")
10263 ;; if in a code block, then open the block's results
10264 (unless (call-interactively #'org-babel-open-src-block-result)
10265 (org-load-modules-maybe)
10266 (move-marker org-open-link-marker (point))
10267 (setq org-window-config-before-follow-link (current-window-configuration))
10268 (org-remove-occur-highlights nil nil t)
10269 (cond
10270 ((and (org-at-heading-p)
10271 (not (org-at-timestamp-p t))
10272 (not (org-in-regexp
10277 (not (get-text-property (point) 'org-linked-text)))
10278 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10279 (lk0 (car lkall))
10280 (lk (if (stringp lk0) (list lk0) lk0))
10281 (lkend (cdr lkall)))
10282 (mapcar (lambda(l)
10283 (search-forward l nil lkend)
10284 (goto-char (match-beginning 0))
10285 (org-open-at-point))
10286 lk))
10287 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10288 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10289 ((and (org-at-timestamp-p t)
10290 (not (org-in-regexp org-bracket-link-regexp)))
10291 (org-follow-timestamp-link))
10292 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10293 (not (org-in-regexp org-any-link-re)))
10294 (org-footnote-action))
10295 (t
10296 (let (type path link line search (pos (point)))
10297 (catch 'match
10298 (save-excursion
10300 (when (org-in-regexp org-bracket-link-regexp 1)
10301 (setq link (org-extract-attributes
10302 (org-link-unescape (org-match-string-no-properties 1))))
10304 (setq link (replace-match " " t t link)))
10305 (setq link (org-link-expand-abbrev link))
10306 (cond
10307 ((or (file-name-absolute-p link)
10309 (setq type "file" path link))
10310 ((string-match org-link-re-with-space3 link)
10311 (setq type (match-string 1 link) path (match-string 2 link)))
10313 (setq type "help" path (match-string 1 link)))
10314 (t (setq type "thisfile" path link)))
10315 (throw 'match t)))
10317 (when (get-text-property (point) 'org-linked-text)
10318 (setq type "thisfile"
10319 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10320 (1+ (point)) (point))
10321 path (buffer-substring
10322 (or (previous-single-property-change pos 'org-linked-text)
10323 (point-min))
10324 (or (next-single-property-change pos 'org-linked-text)
10325 (point-max))))
10326 (throw 'match t))
10328 (save-excursion
10329 (when (or (org-in-regexp org-angle-link-re)
10330 (let ((match (org-in-regexp org-plain-link-re)))
10331 ;; Check a plain link is not within a bracket link
10332 (and match
10333 (save-excursion
10334 (progn
10335 (goto-char (car match))
10336 (not (org-in-regexp org-bracket-link-regexp))))))
10337 (let ((line_ending (save-excursion (end-of-line) (point))))
10338 ;; We are in a line before a plain or bracket link
10339 (or (re-search-forward org-plain-link-re line_ending t)
10340 (re-search-forward org-bracket-link-regexp line_ending t))))
10341 (setq type (match-string 1)
10342 path (org-link-unescape (match-string 2)))
10343 (throw 'match t)))
10344 (save-excursion
10346 (setq type "tags"
10347 path (match-string 1))
10348 (while (string-match ":" path)
10349 (setq path (replace-match "+" t t path)))
10350 (throw 'match t)))
10352 (setq type "tree-match"
10353 path (match-string 1))
10354 (throw 'match t)))
10355 (unless path
10356 (user-error "No link found"))
10358 ;; switch back to reference buffer
10359 ;; needed when if called in a temporary buffer through
10360 ;; org-open-link-from-string
10361 (with-current-buffer (or reference-buffer (current-buffer))
10363 ;; Remove any trailing spaces in path
10365 (setq path (replace-match "" t t path)))
10366 (if (and org-link-translation-function
10367 (fboundp org-link-translation-function))
10368 ;; Check if we need to translate the link
10369 (let ((tmp (funcall org-link-translation-function type path)))
10370 (setq type (car tmp) path (cdr tmp))))
10372 (cond
10374 ((assoc type org-link-protocols)
10375 (funcall (nth 1 (assoc type org-link-protocols)) path))
10377 ((equal type "help")
10378 (let ((f-or-v (intern path)))
10379 (cond ((fboundp f-or-v)
10380 (describe-function f-or-v))
10381 ((boundp f-or-v)
10382 (describe-variable f-or-v))
10383 (t (error "Not a known function or variable")))))
10385 ((equal type "mailto")
10386 (let ((cmd (car org-link-mailto-program))
10387 (args (cdr org-link-mailto-program)) args1
10388 (address path) (subject "") a)
10390 (setq address (match-string 1 path)
10391 subject (org-link-escape (match-string 2 path))))
10392 (while args
10393 (cond
10394 ((not (stringp (car args))) (push (pop args) args1))
10395 (t (setq a (pop args))
10396 (if (string-match "%a" a)
10397 (setq a (replace-match address t t a)))
10398 (if (string-match "%s" a)
10399 (setq a (replace-match subject t t a)))
10400 (push a args1))))
10401 (apply cmd (nreverse args1))))
10403 ((member type '("http" "https" "ftp" "news"))
10404 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
10405 (org-link-escape
10406 path org-link-escape-chars-browser)
10407 path))))
10409 ((string= type "doi")
10410 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
10411 (org-link-escape
10412 path org-link-escape-chars-browser)
10413 path))))
10415 ((member type '("message"))
10416 (browse-url (concat type ":" path)))
10418 ((string= type "tags")
10419 (org-tags-view arg path))
10421 ((string= type "tree-match")
10424 ((string= type "file")
10426 (setq line (string-to-number (match-string 1 path))
10427 path (substring path 0 (match-beginning 0)))
10429 (setq search (match-string 1 path)
10430 path (substring path 0 (match-beginning 0)))))
10431 (if (string-match "[*?{]" (file-name-nondirectory path))
10432 (dired path)
10433 (org-open-file path arg line search)))
10435 ((string= type "shell")
10436 (let ((buf (generate-new-buffer "*Org Shell Output"))
10437 (cmd path))
10438 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10439 (string-match org-confirm-shell-link-not-regexp cmd))
10440 (not org-confirm-shell-link-function)
10441 (funcall org-confirm-shell-link-function
10443 (org-add-props cmd nil
10444 'face 'org-warning))))
10445 (progn
10446 (message "Executing %s" cmd)
10447 (shell-command cmd buf)
10448 (if (featurep 'midnight)
10449 (setq clean-buffer-list-kill-buffer-names
10450 (cons buf clean-buffer-list-kill-buffer-names))))
10451 (error "Abort"))))
10453 ((string= type "elisp")
10454 (let ((cmd path))
10455 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10456 (string-match org-confirm-elisp-link-not-regexp cmd))
10457 (not org-confirm-elisp-link-function)
10458 (funcall org-confirm-elisp-link-function
10460 (org-add-props cmd nil
10461 'face 'org-warning))))
10462 (message "%s => %s" cmd
10463 (if (equal (string-to-char cmd) ?\()
10464 (eval (read cmd))
10465 (call-interactively (read cmd))))
10466 (error "Abort"))))
10468 ((and (string= type "thisfile")
10469 (run-hook-with-args-until-success
10470 'org-open-link-functions path)))
10472 ((string= type "thisfile")
10473 (if arg
10474 (switch-to-buffer-other-window
10475 (org-get-buffer-for-internal-link (current-buffer)))
10476 (org-mark-ring-push))
10477 (let ((cmd `(org-link-search
10478 ,path
10479 ,(cond ((equal arg '(4)) ''occur)
10480 ((equal arg '(16)) ''org-occur))
10481 ,pos)))
10482 (condition-case nil (let ((org-link-search-inhibit-query t))
10483 (eval cmd))
10484 (error (progn (widen) (eval cmd))))))
10486 (t (browse-url-at-point)))))))
10487 (move-marker org-open-link-marker nil)
10488 (run-hook-with-args 'org-follow-link-hook)))
10490 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10491 "Offer links in the current entry and return the selected link.
10492 If there is only one link, return it.
10493 If NTH is an integer, return the NTH link found.
10494 If ZERO is a string, check also this string for a link, and if
10495 there is one, return it."
10496 (with-current-buffer buffer
10497 (save-excursion
10498 (save-restriction
10499 (widen)
10500 (goto-char marker)
10504 (cnt ?0)
10505 (in-emacs (if (integerp nth) nil nth))
10506 have-zero end links link c)
10507 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10508 (push (match-string 0 zero) links)
10509 (setq cnt (1- cnt) have-zero t))
10510 (save-excursion
10511 (org-back-to-heading t)
10512 (setq end (save-excursion (outline-next-heading) (point)))
10513 (while (re-search-forward re end t)
10514 (push (match-string 0) links))
10515 (setq links (org-uniquify (reverse links))))
10516 (cond
10517 ((null links)
10518 (message "No links"))
10519 ((equal (length links) 1)
10520 (setq link (car links)))
10521 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10522 (setq link (nth (if have-zero nth (1- nth)) links)))
10523 (t ; we have to select a link
10524 (save-excursion
10525 (save-window-excursion
10526 (delete-other-windows)
10527 (with-output-to-temp-buffer "*Select Link*"
10528 (mapc (lambda (l)
10529 (if (not (string-match org-bracket-link-regexp l))
10531 (org-remove-angle-brackets l)))
10532 (if (match-end 3)
10534 (match-string 3 l) (match-string 1 l)))
10536 (match-string 1 l))))))
10537 links))
10538 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10539 (message "Select link to open, RET to open all:")
10540 (setq c (read-char-exclusive))
10541 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10542 (when (equal c ?q) (error "Abort"))
10543 (if (equal c ?\C-m)
10544 (setq link links)
10545 (setq nth (- c ?0))
10546 (if have-zero (setq nth (1+ nth)))
10547 (unless (and (integerp nth) (>= (length links) nth))
10548 (error "Invalid link selection"))
10549 (setq link (nth (1- nth) links)))))
10550 (cons link end))))))
10552 ;; Add special file links that specify the way of opening
10554 (org-add-link-type "file+sys" 'org-open-file-with-system)
10555 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10556 (defun org-open-file-with-system (path)
10557 "Open file at PATH using the system way of opening it."
10558 (org-open-file path 'system))
10559 (defun org-open-file-with-emacs (path)
10560 "Open file at PATH in Emacs."
10561 (org-open-file path 'emacs))
10564 ;;; File search
10566 (defvar org-create-file-search-functions nil
10567 "List of functions to construct the right search string for a file link.
10568 These functions are called in turn with point at the location to
10569 which the link should point.
10571 A function in the hook should first test if it would like to
10572 handle this file type, for example by checking the `major-mode'
10573 or the file extension. If it decides not to handle this file, it
10574 should just return nil to give other functions a chance. If it
10575 does handle the file, it must return the search string to be used
10576 when following the link. The search string will be part of the
10577 file link, given after a double colon, and `org-open-at-point'
10578 will automatically search for it. If special measures must be
10579 taken to make the search successful, another function should be
10580 added to the companion hook `org-execute-file-search-functions',
10581 which see.
10583 A function in this hook may also use `setq' to set the variable
10584 `description' to provide a suggestion for the descriptive text to
10585 be used for this link when it gets inserted into an Org-mode
10588 (defvar org-execute-file-search-functions nil
10589 "List of functions to execute a file search triggered by a link.
10591 Functions added to this hook must accept a single argument, the
10592 search string that was part of the file link, the part after the
10593 double colon. The function must first check if it would like to
10594 handle this search, for example by checking the `major-mode' or
10595 the file extension. If it decides not to handle this search, it
10596 should just return nil to give other functions a chance. If it
10597 does handle the search, it must return a non-nil value to keep
10598 other functions from trying.
10600 Each function can access the current prefix argument through the
10601 variable `current-prefix-arg'. Note that a single prefix is used
10602 to force opening a link in Emacs, so it may be good to only use a
10603 numeric or double prefix to guide the search function.
10605 In case this is needed, a function in this hook can also restore
10606 the window configuration before `org-open-at-point' was called using:
10608 (set-window-configuration org-window-config-before-follow-link)")
10610 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10611 (defun org-link-search (s &optional type avoid-pos stealth)
10612 "Search for a link search option.
10613 If S is surrounded by forward slashes, it is interpreted as a
10614 regular expression. In org-mode files, this will create an `org-occur'
10615 sparse tree. In ordinary files, `occur' will be used to list matches.
10616 If the current buffer is in `dired-mode', grep will be used to search
10617 in all files. If AVOID-POS is given, ignore matches near that position.
10619 When optional argument STEALTH is non-nil, do not modify
10620 visibility around point, thus ignoring
10621 `org-show-hierarchy-above', `org-show-following-heading' and
10622 `org-show-siblings' variables."
10623 (let ((case-fold-search t)
10627 org-emphasis-alist)
10629 (pos (point))
10630 (pre nil) (post nil)
10631 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10632 (cond
10633 ;; First check if there are any special search functions
10634 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10635 ;; Now try the builtin stuff
10636 ((and (equal (string-to-char s0) ?#)
10637 (> (length s0) 1)
10638 (save-excursion
10639 (goto-char (point-min))
10640 (and
10641 (re-search-forward
10644 (setq type 'dedicated
10645 pos (match-beginning 0))))
10646 ;; There is an exact target for this
10647 (goto-char pos)
10648 (org-back-to-heading t)))
10649 ((save-excursion
10650 (goto-char (point-min))
10651 (and
10652 (re-search-forward
10653 (concat "<<" (regexp-quote s0) ">>") nil t)
10654 (setq type 'dedicated
10655 pos (match-beginning 0))))
10656 ;; There is an exact target for this
10657 (goto-char pos))
10658 ((save-excursion
10659 (goto-char (point-min))
10660 (and
10661 (re-search-forward
10663 (setq type 'dedicated pos (match-beginning 0))))
10664 ;; Found an element with a matching #+name affiliated keyword.
10665 (goto-char pos))
10667 (save-excursion
10668 (goto-char (point-min))
10669 (and
10670 (re-search-forward
10671 (concat "[^[]" (regexp-quote
10672 (format org-coderef-label-format
10673 (match-string 1 s0))))
10674 nil t)
10675 (setq type 'dedicated
10676 pos (1+ (match-beginning 0))))))
10677 ;; There is a coderef target for this
10678 (goto-char pos))
10680 ;; A regular expression
10681 (cond
10682 ((derived-mode-p 'org-mode)
10683 (org-occur (match-string 1 s)))
10684 (t (org-do-occur (match-string 1 s)))))
10685 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10686 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10687 (goto-char (point-min))
10688 (cond
10689 ((let (case-fold-search)
10690 (re-search-forward (format org-complex-heading-regexp-format
10691 (regexp-quote s))
10692 nil t))
10693 ;; OK, found a match
10694 (setq type 'dedicated)
10695 (goto-char (match-beginning 0)))
10696 ((and (not org-link-search-inhibit-query)
10697 (eq org-link-search-must-match-exact-headline 'query-to-create)
10698 (y-or-n-p "No match - create this as a new heading? "))
10699 (goto-char (point-max))
10700 (or (bolp) (newline))
10702 (beginning-of-line 0))
10703 (t
10704 (goto-char pos)
10705 (error "No match"))))
10706 (t
10707 ;; A normal search string
10708 (when (equal (string-to-char s) ?*)
10709 ;; Anchor on headlines, post may include tags.
10712 s (substring s 1)))
10713 (remove-text-properties
10714 0 (length s)
10715 '(face nil mouse-face nil keymap nil fontified nil) s)
10716 ;; Make a series of regular expressions to find a match
10727 re4 (concat "[^a-zA-Z_]" re4_)
10729 re1 (concat pre re2 post)
10730 re3 (concat pre (if pre re4_ re4) post)
10731 re5 (concat pre ".*" re4)
10732 re2 (concat pre re2)
10733 re2a (concat pre (if pre re2a_ re2a))
10734 re4 (concat pre (if pre re4_ re4))
10738 (cond
10739 ((eq type 'org-occur) (org-occur reall))
10740 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10741 (t (goto-char (point-min))
10742 (setq type 'fuzzy)
10743 (if (or (and (org-search-not-self 1 re0 nil t)
10744 (setq type 'dedicated))
10745 (org-search-not-self 1 re1 nil t)
10746 (org-search-not-self 1 re2 nil t)
10747 (org-search-not-self 1 re2a nil t)
10748 (org-search-not-self 1 re3 nil t)
10749 (org-search-not-self 1 re4 nil t)
10750 (org-search-not-self 1 re5 nil t))
10751 (goto-char (match-beginning 1))
10752 (goto-char pos)
10753 (error "No match"))))))
10754 (and (derived-mode-p 'org-mode)
10755 (not stealth)
10756 (org-show-context 'link-search))
10757 type))
10759 (defun org-search-not-self (group &rest args)
10760 "Execute `re-search-forward', but only accept matches that do not
10761 enclose the position of `org-open-link-marker'."
10762 (let ((m org-open-link-marker))
10763 (catch 'exit
10764 (while (apply 're-search-forward args)
10765 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10766 (goto-char (match-end group))
10767 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10768 (> (match-beginning 0) (marker-position m))
10769 (< (match-end 0) (marker-position m)))
10770 (save-match-data
10771 (or (not (org-in-regexp
10772 org-bracket-link-analytic-regexp 1))
10773 (not (match-end 4)) ; no description
10774 (and (<= (match-beginning 4) (point))
10775 (>= (match-end 4) (point))))))
10776 (throw 'exit (point))))))))
10778 (defun org-get-buffer-for-internal-link (buffer)
10779 "Return a buffer to be used for displaying the link target of internal links."
10780 (cond
10781 ((not org-display-internal-link-with-indirect-buffer)
10782 buffer)
10783 ((string-match "(Clone)$" (buffer-name buffer))
10784 (message "Buffer is already a clone, not making another one")
10785 ;; we also do not modify visibility in this case
10786 buffer)
10787 (t ; make a new indirect buffer for displaying the link
10788 (let* ((bn (buffer-name buffer))
10789 (ibn (concat bn "(Clone)"))
10790 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10791 (with-current-buffer ib (org-overview))
10792 ib))))
10794 (defun org-do-occur (regexp &optional cleanup)
10795 "Call the Emacs command `occur'.
10796 If CLEANUP is non-nil, remove the printout of the regular expression
10797 in the *Occur* buffer. This is useful if the regex is long and not useful
10798 to read."
10799 (occur regexp)
10800 (when cleanup
10801 (let ((cwin (selected-window)) win beg end)
10802 (when (setq win (get-buffer-window "*Occur*"))
10803 (select-window win))
10804 (goto-char (point-min))
10805 (when (re-search-forward "match[a-z]+" nil t)
10806 (setq beg (match-end 0))
10808 (setq end (1- (match-beginning 0)))))
10809 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10810 (goto-char (point-min))
10811 (select-window cwin))))
10813 ;;; The mark ring for links jumps
10815 (defvar org-mark-ring nil
10816 "Mark ring for positions before jumps in Org-mode.")
10817 (defvar org-mark-ring-last-goto nil
10818 "Last position in the mark ring used to go back.")
10819 ;; Fill and close the ring
10820 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10821 (loop for i from 1 to org-mark-ring-length do
10822 (push (make-marker) org-mark-ring))
10823 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10824 org-mark-ring)
10826 (defun org-mark-ring-push (&optional pos buffer)
10827 "Put the current position or POS into the mark ring and rotate it."
10828 (interactive)
10829 (setq pos (or pos (point)))
10830 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10831 (move-marker (car org-mark-ring)
10832 (or pos (point))
10833 (or buffer (current-buffer)))
10834 (message "%s"
10835 (substitute-command-keys
10838 (defun org-mark-ring-goto (&optional n)
10839 "Jump to the previous position in the mark ring.
10840 With prefix arg N, jump back that many stored positions. When
10841 called several times in succession, walk through the entire ring.
10842 Org-mode commands jumping to a different position in the current file,
10843 or to another Org-mode file, automatically push the old position
10844 onto the ring."
10845 (interactive "p")
10846 (let (p m)
10847 (if (eq last-command this-command)
10848 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10849 (setq p org-mark-ring))
10850 (setq org-mark-ring-last-goto p)
10851 (setq m (car p))
10852 (org-pop-to-buffer-same-window (marker-buffer m))
10853 (goto-char m)
10854 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10856 (defun org-remove-angle-brackets (s)
10857 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10858 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10859 s)
10860 (defun org-add-angle-brackets (s)
10861 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10862 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10863 s)
10864 (defun org-remove-double-quotes (s)
10867 s)
10869 ;;; Following specific links
10871 (defun org-follow-timestamp-link ()
10872 "Open an agenda view for the time-stamp date/range at point."
10873 (cond
10874 ((org-at-date-range-p t)
10875 (let ((org-agenda-start-on-weekday)
10876 (t1 (match-string 1))
10877 (t2 (match-string 2)) tt1 tt2)
10878 (setq tt1 (time-to-days (org-time-string-to-time t1))
10879 tt2 (time-to-days (org-time-string-to-time t2)))
10880 (let ((org-agenda-buffer-tmp-name
10881 (format "*Org Agenda(a:%s)"
10882 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10883 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10884 ((org-at-timestamp-p t)
10885 (let ((org-agenda-buffer-tmp-name
10886 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10887 (org-agenda-list nil (time-to-days (org-time-string-to-time
10888 (substring (match-string 1) 0 10)))
10889 1)))
10890 (t (error "This should not happen"))))
10893 ;;; Following file links
10894 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10895 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10896 (declare-function mailcap-mime-info
10897 "mailcap" (string &optional request no-decode))
10898 (defvar org-wait nil)
10899 (defun org-open-file (path &optional in-emacs line search)
10900 "Open the file at PATH.
10901 First, this expands any special file name abbreviations. Then the
10902 configuration variable `org-file-apps' is checked if it contains an
10903 entry for this file type, and if yes, the corresponding command is launched.
10905 If no application is found, Emacs simply visits the file.
10907 With optional prefix argument IN-EMACS, Emacs will visit the file.
10909 prefix arg, Org tries to avoid opening in Emacs
10910 and to use an external application to visit the file.
10912 Optional LINE specifies a line to go to, optional SEARCH a string
10913 to search for. If LINE or SEARCH is given, the file will be
10914 opened in Emacs, unless an entry from org-file-apps that makes
10915 use of groups in a regexp matches.
10917 If you want to change the way frames are used when following a
10918 link, please customize `org-link-frame-setup'.
10920 If the file does not exist, an error is thrown."
10921 (let* ((file (if (equal path "")
10922 buffer-file-name
10923 (substitute-in-file-name (expand-file-name path))))
10924 (file-apps (append org-file-apps (org-default-apps)))
10925 (apps (org-remove-if
10926 'org-file-apps-entry-match-against-dlink-p file-apps))
10927 (apps-dlink (org-remove-if-not
10928 'org-file-apps-entry-match-against-dlink-p file-apps))
10929 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10930 (dirp (if remp nil (file-directory-p file)))
10931 (file (if (and dirp org-open-directory-means-index-dot-org)
10932 (concat (file-name-as-directory file) "index.org")
10933 file))
10934 (a-m-a-p (assq 'auto-mode apps))
10935 (dfile (downcase file))
10936 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10937 (link (cond ((and (eq line nil)
10938 (eq search nil))
10939 file)
10940 (line
10941 (concat file "::" (number-to-string line)))
10942 (search
10943 (concat file "::" search))))
10944 (dlink (downcase link))
10945 (old-buffer (current-buffer))
10946 (old-pos (point))
10947 (old-mode major-mode)
10948 ext cmd link-match-data)
10950 (setq ext (match-string 1 dfile))
10952 (setq ext (match-string 1 dfile))))
10953 (cond
10954 ((member in-emacs '((16) system))
10955 (setq cmd (cdr (assoc 'system apps))))
10956 (in-emacs (setq cmd 'emacs))
10957 (t
10958 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10959 (and dirp (cdr (assoc 'directory apps)))
10960 ; first, try matching against apps-dlink
10961 ; if we get a match here, store the match data for later
10962 (let ((match (assoc-default dlink apps-dlink
10963 'string-match)))
10964 (if match
10965 (progn (setq link-match-data (match-data))
10966 match)
10967 (progn (setq in-emacs (or in-emacs line search))
10968 nil))) ; if we have no match in apps-dlink,
10969 ; always open the file in emacs if line or search
10970 ; is given (for backwards compatibility)
10971 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10972 'string-match)
10973 (cdr (assoc ext apps))
10974 (cdr (assoc t apps))))))
10975 (when (eq cmd 'system)
10976 (setq cmd (cdr (assoc 'system apps))))
10977 (when (eq cmd 'default)
10978 (setq cmd (cdr (assoc t apps))))
10979 (when (eq cmd 'mailcap)
10980 (require 'mailcap)
10981 (mailcap-parse-mailcaps)
10982 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10983 (command (mailcap-mime-info mime-type)))
10984 (if (stringp command)
10985 (setq cmd command)
10986 (setq cmd 'emacs))))
10987 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10988 (not (file-exists-p file))
10989 (not org-open-non-existing-files))
10990 (error "No such file: %s" file))
10991 (cond
10993 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10995 (setq cmd (replace-match "%s" t t cmd)))
10996 (while (string-match "%s" cmd)
10997 (setq cmd (replace-match
10998 (save-match-data
10999 (shell-quote-argument
11000 (convert-standard-filename file)))
11001 t t cmd)))
11003 ;; Replace "%1", "%2" etc. in command with group matches from regex
11004 (save-match-data
11005 (let ((match-index 1)
11006 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11007 (set-match-data link-match-data)
11008 (while (<= match-index number-of-groups)
11009 (let ((regex (concat "%" (number-to-string match-index)))
11010 (replace-with (match-string match-index dlink)))
11011 (while (string-match regex cmd)
11012 (setq cmd (replace-match replace-with t t cmd))))
11013 (setq match-index (+ match-index 1)))))
11015 (save-window-excursion
11016 (message "Running %s...done" cmd)
11017 (start-process-shell-command cmd nil cmd)
11018 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11019 ((or (stringp cmd)
11020 (eq cmd 'emacs))
11021 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11022 (widen)
11023 (if line (org-goto-line line)
11024 (if search (org-link-search search))))
11025 ((consp cmd)
11026 (let ((file (convert-standard-filename file)))
11027 (save-match-data
11028 (set-match-data link-match-data)
11029 (eval cmd))))
11030 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11031 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11032 (or (not (equal old-buffer (current-buffer)))
11033 (not (equal old-pos (point))))
11034 (org-mark-ring-push old-pos old-buffer))))
11036 (defun org-file-apps-entry-match-against-dlink-p (entry)
11037 "This function returns non-nil if `entry' uses a regular
11038 expression which should be matched against the whole link by
11039 org-open-file.
11041 It assumes that is the case when the entry uses a regular
11042 expression which has at least one grouping construct and the
11043 action is either a lisp form or a command string containing
11044 '%1', i.e. using at least one subexpression match as a
11045 parameter."
11046 (let ((selector (car entry))
11047 (action (cdr entry)))
11048 (if (stringp selector)
11049 (and (> (regexp-opt-depth selector) 0)
11050 (or (and (stringp action)
11051 (string-match "%[0-9]" action))
11052 (consp action)))
11053 nil)))
11055 (defun org-default-apps ()
11056 "Return the default applications for this operating system."
11057 (cond
11058 ((eq system-type 'darwin)
11059 org-file-apps-defaults-macosx)
11060 ((eq system-type 'windows-nt)
11061 org-file-apps-defaults-windowsnt)
11062 (t org-file-apps-defaults-gnu)))
11064 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11065 "Convert extensions to regular expressions in the cars of LIST.
11066 Also, weed out any non-string entries, because the return value is used
11067 only for regexp matching.
11068 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11069 point to the symbol `emacs', indicating that the file should
11070 be opened in Emacs."
11071 (append
11072 (delq nil
11073 (mapcar (lambda (x)
11074 (if (not (stringp (car x)))
11075 nil
11077 x
11079 list))
11080 (if add-auto-mode
11081 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11083 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11084 (defun org-file-remote-p (file)
11085 "Test whether FILE specifies a location on a remote system.
11086 Return non-nil if the location is indeed remote.
11090 (cond ((fboundp 'file-remote-p)
11091 (file-remote-p file))
11092 ((fboundp 'tramp-handle-file-remote-p)
11093 (tramp-handle-file-remote-p file))
11094 ((and (boundp 'ange-ftp-name-format)
11095 (string-match (car ange-ftp-name-format) file))
11096 t)))
11099 ;;;; Refiling
11101 (defun org-get-org-file ()
11102 "Read a filename, with default directory `org-directory'."
11103 (let ((default (or org-default-notes-file remember-data-file)))
11104 (read-file-name (format "File name [%s]: " default)
11105 (file-name-as-directory org-directory)
11106 default)))
11108 (defun org-notes-order-reversed-p ()
11109 "Check if the current file should receive notes in reversed order."
11110 (cond
11111 ((not org-reverse-note-order) nil)
11112 ((eq t org-reverse-note-order) t)
11113 ((not (listp org-reverse-note-order)) nil)
11114 (t (catch 'exit
11115 (let ((all org-reverse-note-order)
11116 entry)
11117 (while (setq entry (pop all))
11118 (if (string-match (car entry) buffer-file-name)
11119 (throw 'exit (cdr entry))))
11120 nil)))))
11122 (defvar org-refile-target-table nil
11123 "The list of refile targets, created by `org-refile'.")
11125 (defvar org-agenda-new-buffers nil
11126 "Buffers created to visit agenda files.")
11128 (defvar org-refile-cache nil
11129 "Cache for refile targets.")
11131 (defvar org-refile-markers nil
11132 "All the markers used for caching refile locations.")
11134 (defun org-refile-marker (pos)
11135 "Get a new refile marker, but only if caching is in use."
11136 (if (not org-refile-use-cache)
11137 pos
11138 (let ((m (make-marker)))
11139 (move-marker m pos)
11140 (push m org-refile-markers)
11141 m)))
11143 (defun org-refile-cache-clear ()
11144 "Clear the refile cache and disable all the markers."
11145 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11146 (setq org-refile-markers nil)
11147 (setq org-refile-cache nil)
11148 (message "Refile cache has been cleared"))
11150 (defun org-refile-cache-check-set (set)
11151 "Check if all the markers in the cache still have live buffers."
11152 (let (marker)
11153 (catch 'exit
11154 (while (and set (setq marker (nth 3 (pop set))))
11155 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11156 (when (and marker (null (marker-buffer marker)))
11157 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11158 (sit-for 3)
11159 (throw 'exit nil)))
11160 t)))
11162 (defun org-refile-cache-put (set &rest identifiers)
11163 "Push the refile targets SET into the cache, under IDENTIFIERS."
11164 (let* ((key (sha1 (prin1-to-string identifiers)))
11165 (entry (assoc key org-refile-cache)))
11166 (if entry
11167 (setcdr entry set)
11168 (push (cons key set) org-refile-cache))))
11170 (defun org-refile-cache-get (&rest identifiers)
11171 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11172 (cond
11173 ((not org-refile-cache) nil)
11174 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11175 (t
11176 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11177 org-refile-cache))))
11178 (and set (org-refile-cache-check-set set) set)))))
11180 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11181 "Produce a table with refile targets."
11182 (let ((case-fold-search nil)
11183 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11184 (entries (or org-refile-targets '((nil . (:level . 1)))))
11185 targets tgs txt re files f desc descre fast-path-p level pos0)
11186 (message "Getting targets...")
11187 (with-current-buffer (or default-buffer (current-buffer))
11188 (while (setq entry (pop entries))
11189 (setq files (car entry) desc (cdr entry))
11190 (setq fast-path-p nil)
11191 (cond
11192 ((null files) (setq files (list (current-buffer))))
11193 ((eq files 'org-agenda-files)
11194 (setq files (org-agenda-files 'unrestricted)))
11195 ((and (symbolp files) (fboundp files))
11196 (setq files (funcall files)))
11197 ((and (symbolp files) (boundp files))
11198 (setq files (symbol-value files))))
11199 (if (stringp files) (setq files (list files)))
11200 (cond
11201 ((eq (car desc) :tag)
11203 ((eq (car desc) :todo)
11205 ((eq (car desc) :regexp)
11206 (setq descre (cdr desc)))
11207 ((eq (car desc) :level)
11209 (if org-odd-levels-only
11210 (1- (* 2 (cdr desc)))
11211 (cdr desc)))
11213 ((eq (car desc) :maxlevel)
11214 (setq fast-path-p t)
11216 (if org-odd-levels-only
11217 (1- (* 2 (cdr desc)))
11218 (cdr desc)))
11220 (t (error "Bad refiling target description %s" desc)))
11221 (while (setq f (pop files))
11222 (with-current-buffer
11223 (if (bufferp f) f (org-get-agenda-file-buffer f))
11224 (or
11225 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11226 (progn
11227 (if (bufferp f) (setq f (buffer-file-name
11228 (buffer-base-buffer f))))
11229 (setq f (and f (expand-file-name f)))
11230 (if (eq org-refile-use-outline-path 'file)
11231 (push (list (file-name-nondirectory f) f nil nil) tgs))
11232 (save-excursion
11233 (save-restriction
11234 (widen)
11235 (goto-char (point-min))
11236 (while (re-search-forward descre nil t)
11237 (goto-char (setq pos0 (point-at-bol)))
11238 (catch 'next
11239 (when org-refile-target-verify-function
11240 (save-match-data
11241 (or (funcall org-refile-target-verify-function)
11242 (throw 'next t))))
11243 (when (and (looking-at org-complex-heading-regexp)
11244 (not (member (match-string 4) excluded-entries))
11245 (match-string 4))
11246 (setq level (org-reduced-level
11247 (- (match-end 1) (match-beginning 1)))
11248 txt (org-link-display-format (match-string 4))
11250 re (format org-complex-heading-regexp-format
11251 (regexp-quote (match-string 4))))
11252 (when org-refile-use-outline-path
11253 (setq txt (mapconcat
11254 'org-protect-slash
11255 (append
11256 (if (eq org-refile-use-outline-path
11257 'file)
11258 (list (file-name-nondirectory
11259 (buffer-file-name
11260 (buffer-base-buffer))))
11261 (if (eq org-refile-use-outline-path
11262 'full-file-path)
11263 (list (buffer-file-name
11264 (buffer-base-buffer)))))
11265 (org-get-outline-path fast-path-p
11266 level txt)
11267 (list txt))
11268 "/")))
11269 (push (list txt f re (org-refile-marker (point)))
11270 tgs)))
11271 (when (= (point) pos0)
11272 ;; verification function has not moved point
11273 (goto-char (point-at-eol))))))))
11274 (when org-refile-use-cache
11275 (org-refile-cache-put tgs (buffer-file-name) descre))
11276 (setq targets (append tgs targets))))))
11277 (message "Getting targets...done")
11278 (nreverse targets)))
11280 (defun org-protect-slash (s)
11281 (while (string-match "/" s)
11283 s)
11285 (defvar org-olpa (make-vector 20 nil))
11287 (defun org-get-outline-path (&optional fastp level heading)
11288 "Return the outline path to the current entry, as a list.
11290 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11291 routine which makes outline path derivations for an entire file,
11292 avoiding backtracing. Refile target collection makes use of that."
11293 (if fastp
11294 (progn
11295 (if (> level 19)
11296 (error "Outline path failure, more than 19 levels"))
11297 (loop for i from level upto 19 do
11298 (aset org-olpa i nil))
11299 (prog1
11300 (delq nil (append org-olpa nil))
11301 (aset org-olpa level heading)))
11302 (let (rtn case-fold-search)
11303 (save-excursion
11304 (save-restriction
11305 (widen)
11306 (while (org-up-heading-safe)
11307 (when (looking-at org-complex-heading-regexp)
11308 (push (org-match-string-no-properties 4) rtn)))
11309 rtn)))))
11311 (defun org-format-outline-path (path &optional width prefix separator)
11312 "Format the outline path PATH for display.
11313 WIDTH is the maximum number of characters that is available.
11314 PREFIX is a prefix to be included in the returned string,
11315 such as the file name.
11316 SEPARATOR is inserted between the different parts of the path,
11318 (setq width (or width 79))
11319 (if prefix (setq width (- width (length prefix))))
11320 (if (not path)
11321 (or prefix "")
11322 (let* ((nsteps (length path))
11323 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11324 (maxwidth (if (<= total-width width)
11325 10000 ;; everything fits
11326 ;; we need to shorten the level headings
11327 (/ (- width nsteps) nsteps)))
11328 (org-odd-levels-only nil)
11329 (n 0)
11330 (total (1+ (length prefix))))
11331 (setq maxwidth (max maxwidth 10))
11332 (concat prefix
11333 (if prefix (or separator "/"))
11334 (mapconcat
11335 (lambda (h)
11336 (setq n (1+ n))
11337 (if (and (= n nsteps) (< maxwidth 10000))
11338 (setq maxwidth (- total-width total)))
11339 (if (< (length h) maxwidth)
11340 (progn (setq total (+ total (length h) 1)) h)
11341 (setq h (substring h 0 (- maxwidth 2))
11342 total (+ total maxwidth 1))
11344 (setq h (substring h 0 (match-beginning 0))))
11345 (setq h (concat h "..")))
11346 (org-add-props h nil 'face
11347 (nth (% (1- n) org-n-level-faces)
11348 org-level-faces))
11349 h)
11350 path (or separator "/"))))))
11352 (defun org-display-outline-path (&optional file current separator just-return-string)
11353 "Display the current outline path in the echo area.
11355 If FILE is non-nil, prepend the output with the file name.
11356 If CURRENT is non-nil, append the current heading to the output.
11357 SEPARATOR is passed through to `org-format-outline-path'. It separates
11359 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11360 (interactive "P")
11361 (let* (case-fold-search
11362 message-log-max ; Don't populate the *Messages* buffer
11363 (bfn (buffer-file-name (buffer-base-buffer)))
11364 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11365 res)
11366 (if current (setq path (append path
11367 (save-excursion
11368 (org-back-to-heading t)
11369 (if (looking-at org-complex-heading-regexp)
11370 (list (match-string 4)))))))
11371 (setq res
11372 (org-format-outline-path
11373 path
11374 (1- (frame-width))
11375 (and file bfn (concat (file-name-nondirectory bfn) separator))
11376 separator))
11377 (if just-return-string
11378 (org-no-properties res)
11379 (message "%s" res))))
11381 (defvar org-refile-history nil
11382 "History for refiling operations.")
11384 (defvar org-after-refile-insert-hook nil
11385 "Hook run after `org-refile' has inserted its stuff at the new location.
11386 Note that this is still *before* the stuff will be removed from
11387 the *old* location.")
11389 (defvar org-capture-last-stored-marker)
11390 (defvar org-refile-keep nil
11391 "Non-nil means `org-refile' will copy instead of refile.")
11393 (defun org-copy ()
11394 "Like `org-refile', but copy."
11395 (interactive)
11396 (let ((org-refile-keep t))
11397 (funcall 'org-refile nil nil nil "Copy")))
11399 (defun org-refile (&optional goto default-buffer rfloc msg)
11400 "Move the entry or entries at point to another heading.
11401 The list of target headings is compiled using the information in
11402 `org-refile-targets', which see.
11404 At the target location, the entry is filed as a subitem of the target
11405 heading. Depending on `org-reverse-note-order', the new subitem will
11406 either be the first or the last subitem.
11408 If there is an active region, all entries in that region will be moved.
11409 However, the region must fulfill the requirement that the first heading
11410 is the first one sets the top-level of the moved text - at most siblings
11411 below it are allowed.
11413 With prefix arg GOTO, the command will only visit the target location
11414 and not actually move anything.
11417 go to the location where the last refiling operation has put the subtree.
11418 With a prefix argument of `2', refile to the running clock.
11420 RFLOC can be a refile location obtained in a different way.
11425 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11427 If you are using target caching (see `org-refile-use-cache'),
11428 you have to clear the target cache in order to find new targets.
11429 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11430 prefix argument (`C-u C-u C-u C-c C-w')."
11432 (interactive "P")
11433 (if (member goto '(0 (64)))
11434 (org-refile-cache-clear)
11435 (let* ((actionmsg (or msg "Refile"))
11436 (cbuf (current-buffer))
11437 (regionp (org-region-active-p))
11438 (region-start (and regionp (region-beginning)))
11439 (region-end (and regionp (region-end)))
11440 (region-length (and regionp (- region-end region-start)))
11441 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11442 pos it nbuf file re level reversed)
11443 (setq last-command nil)
11444 (when regionp
11445 (goto-char region-start)
11446 (or (bolp) (goto-char (point-at-bol)))
11447 (setq region-start (point))
11448 (unless (or (org-kill-is-subtree-p
11449 (buffer-substring region-start region-end))
11450 (prog1 org-refile-active-region-within-subtree
11451 (org-toggle-heading)))
11452 (error "The region is not a (sequence of) subtree(s)")))
11453 (if (equal goto '(16))
11454 (org-refile-goto-last-stored)
11455 (when (or
11456 (and (equal goto 2)
11457 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11458 (prog1
11459 (setq it (list (or org-clock-heading "running clock")
11460 (buffer-file-name
11461 (marker-buffer org-clock-hd-marker))
11462 ""
11463 (marker-position org-clock-hd-marker)))
11464 (setq goto nil)))
11465 (setq it (or rfloc
11466 (let (heading-text)
11467 (save-excursion
11468 (unless goto
11469 (org-back-to-heading t)
11470 (setq heading-text
11471 (nth 4 (org-heading-components))))
11473 (org-refile-get-location
11474 (cond (goto "Goto")
11475 (regionp (concat actionmsg " region to"))
11478 default-buffer
11479 (and (not (equal '(4) goto))
11480 org-refile-allow-creating-parent-nodes)
11481 goto))))))
11482 (setq file (nth 1 it)
11483 re (nth 2 it)
11484 pos (nth 3 it))
11485 (if (and (not goto)
11486 pos
11487 (equal (buffer-file-name) file)
11488 (if regionp
11489 (and (>= pos region-start)
11490 (<= pos region-end))
11491 (and (>= pos (point))
11492 (< pos (save-excursion
11493 (org-end-of-subtree t t))))))
11494 (error "Cannot refile to position inside the tree or region"))
11496 (setq nbuf (or (find-buffer-visiting file)
11497 (find-file-noselect file)))
11498 (if goto
11499 (progn
11500 (org-pop-to-buffer-same-window nbuf)
11501 (goto-char pos)
11502 (org-show-context 'org-goto))
11503 (if regionp
11504 (progn
11505 (org-kill-new (buffer-substring region-start region-end))
11506 (org-save-markers-in-region region-start region-end))
11507 (org-copy-subtree 1 nil t))
11508 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11509 (find-file-noselect file)))
11510 (setq reversed (org-notes-order-reversed-p))
11511 (save-excursion
11512 (save-restriction
11513 (widen)
11514 (if pos
11515 (progn
11516 (goto-char pos)
11517 (looking-at org-outline-regexp)
11518 (setq level (org-get-valid-level (funcall outline-level) 1))
11519 (goto-char
11520 (if reversed
11521 (or (outline-next-heading) (point-max))
11522 (or (save-excursion (org-get-next-sibling))
11523 (org-end-of-subtree t t)
11524 (point-max)))))
11525 (setq level 1)
11526 (if (not reversed)
11527 (goto-char (point-max))
11528 (goto-char (point-min))
11529 (or (outline-next-heading) (goto-char (point-max)))))
11530 (if (not (bolp)) (newline))
11531 (org-paste-subtree level)
11532 (when org-log-refile
11533 (org-add-log-setup 'refile nil nil 'findpos
11534 org-log-refile)
11535 (unless (eq org-log-refile 'note)
11536 (save-excursion (org-add-log-note))))
11537 (and org-auto-align-tags
11538 (let ((org-loop-over-headlines-in-active-region nil))
11539 (org-set-tags nil t)))
11540 (with-demoted-errors
11541 (bookmark-set "org-refile-last-stored"))
11542 ;; If we are refiling for capture, make sure that the
11543 ;; last-capture pointers point here
11544 (when (org-bound-and-true-p org-refile-for-capture)
11545 (with-demoted-errors
11546 (bookmark-set "org-capture-last-stored-marker"))
11547 (move-marker org-capture-last-stored-marker (point)))
11548 (if (fboundp 'deactivate-mark) (deactivate-mark))
11549 (run-hooks 'org-after-refile-insert-hook))))
11550 (unless org-refile-keep
11551 (if regionp
11552 (delete-region (point) (+ (point) region-length))
11553 (org-cut-subtree)))
11554 (when (featurep 'org-inlinetask)
11555 (org-inlinetask-remove-END-maybe))
11556 (setq org-markers-to-move nil)
11559 (defun org-refile-goto-last-stored ()
11560 "Go to the location where the last refile was stored."
11561 (interactive)
11562 (bookmark-jump "org-refile-last-stored")
11563 (message "This is the location of the last refile"))
11565 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11566 no-exclude)
11567 "Prompt the user for a refile location, using PROMPT.
11568 PROMPT should not be suffixed with a colon and a space, because
11569 this function appends the default value from
11570 `org-refile-history' automatically, if that is not empty.
11571 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11572 this is used for the GOTO interface."
11573 (let ((org-refile-targets org-refile-targets)
11574 (org-refile-use-outline-path org-refile-use-outline-path)
11575 excluded-entries)
11576 (when (and (derived-mode-p 'org-mode)
11577 (not org-refile-use-cache)
11578 (not no-exclude))
11579 (org-map-tree
11580 (lambda()
11581 (setq excluded-entries
11582 (append excluded-entries (list (org-get-heading t t)))))))
11583 (setq org-refile-target-table
11584 (org-refile-get-targets default-buffer excluded-entries)))
11585 (unless org-refile-target-table
11586 (error "No refile targets"))
11587 (let* ((cbuf (current-buffer))
11588 (partial-completion-mode nil)
11589 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11590 (cfunc (if (and org-refile-use-outline-path
11591 org-outline-path-complete-in-steps)
11592 'org-olpath-completing-read
11593 'org-icompleting-read))
11594 (extra (if org-refile-use-outline-path "/" ""))
11595 (cbnex (concat (buffer-name) extra))
11596 (filename (and cfn (expand-file-name cfn)))
11597 (tbl (mapcar
11598 (lambda (x)
11599 (if (and (not (member org-refile-use-outline-path
11600 '(file full-file-path)))
11601 (not (equal filename (nth 1 x))))
11602 (cons (concat (car x) extra " ("
11603 (file-name-nondirectory (nth 1 x)) ")")
11604 (cdr x))
11605 (cons (concat (car x) extra) (cdr x))))
11606 org-refile-target-table))
11607 (completion-ignore-case t)
11608 cdef
11609 (prompt (concat prompt
11610 (or (and (car org-refile-history)
11611 (concat " (default " (car org-refile-history) ")"))
11612 (and (assoc cbnex tbl) (setq cdef cbnex)
11613 (concat " (default " cbnex ")"))) ": "))
11614 pa answ parent-target child parent old-hist)
11615 (setq old-hist org-refile-history)
11616 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11617 nil 'org-refile-history (or cdef (car org-refile-history))))
11618 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11619 (org-refile-check-position pa)
11620 (if pa
11621 (progn
11622 (when (or (not org-refile-history)
11623 (not (eq old-hist org-refile-history))
11624 (not (equal (car pa) (car org-refile-history))))
11625 (setq org-refile-history
11626 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11627 org-refile-history
11628 (cdr org-refile-history))))
11629 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11630 (pop org-refile-history)))
11631 pa)
11633 (progn
11634 (setq parent (match-string 1 answ)
11635 child (match-string 2 answ))
11636 (setq parent-target (or (assoc parent tbl)
11637 (assoc (concat parent "/") tbl)))
11638 (when (and parent-target
11639 (or (eq new-nodes t)
11640 (and (eq new-nodes 'confirm)
11642 child)))))
11643 (org-refile-new-child parent-target child)))
11644 (error "Invalid target location")))))
11646 (declare-function org-string-nw-p "org-macs" (s))
11647 (defun org-refile-check-position (refile-pointer)
11648 "Check if the refile pointer matches the headline to which it points."
11649 (let* ((file (nth 1 refile-pointer))
11650 (re (nth 2 refile-pointer))
11651 (pos (nth 3 refile-pointer))
11652 buffer)
11653 (if (and (not (markerp pos)) (not file))
11654 (error "Please save the buffer to a file before refiling")
11655 (when (org-string-nw-p re)
11656 (setq buffer (if (markerp pos)
11657 (marker-buffer pos)
11658 (or (find-buffer-visiting file)
11659 (find-file-noselect file))))
11660 (with-current-buffer buffer
11661 (save-excursion
11662 (save-restriction
11663 (widen)
11664 (goto-char pos)
11665 (beginning-of-line 1)
11666 (unless (org-looking-at-p re)
11667 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11669 (defun org-refile-new-child (parent-target child)
11670 "Use refile target PARENT-TARGET to add new CHILD below it."
11671 (unless parent-target
11672 (error "Cannot find parent for new node"))
11673 (let ((file (nth 1 parent-target))
11674 (pos (nth 3 parent-target))
11675 level)
11676 (with-current-buffer (or (find-buffer-visiting file)
11677 (find-file-noselect file))
11678 (save-excursion
11679 (save-restriction
11680 (widen)
11681 (if pos
11682 (goto-char pos)
11683 (goto-char (point-max))
11684 (if (not (bolp)) (newline)))
11685 (when (looking-at org-outline-regexp)
11686 (setq level (funcall outline-level))
11687 (org-end-of-subtree t t))
11688 (org-back-over-empty-lines)
11690 (if pos (org-get-valid-level level 1) 1) ?*)
11692 (beginning-of-line 0)
11693 (list (concat (car parent-target) "/" child) file "" (point)))))))
11695 (defun org-olpath-completing-read (prompt collection &rest args)
11696 "Read an outline path like a file name."
11697 (let ((thetable collection)
11698 (org-completion-use-ido nil) ; does not work with ido.
11699 (org-completion-use-iswitchb nil)) ; or iswitchb
11700 (apply
11701 'org-icompleting-read prompt
11702 (lambda (string predicate &optional flag)
11703 (let (rtn r f (l (length string)))
11704 (cond
11705 ((eq flag nil)
11706 ;; try completion
11707 (try-completion string thetable))
11708 ((eq flag t)
11709 ;; all-completions
11710 (setq rtn (all-completions string thetable predicate))
11711 (mapcar
11712 (lambda (x)
11713 (setq r (substring x l))
11714 (if (string-match " ([^)]*)$" x)
11715 (setq f (match-string 0 x))
11716 (setq f ""))
11717 (if (string-match "/" r)
11718 (concat string (substring r 0 (match-end 0)) f)
11719 x))
11720 rtn))
11721 ((eq flag 'lambda)
11722 ;; exact match?
11723 (assoc string thetable)))))
11724 args)))
11726 ;;;; Dynamic blocks
11728 (defun org-find-dblock (name)
11729 "Find the first dynamic block with name NAME in the buffer.
11730 If not found, stay at current position and return nil."
11731 (let ((case-fold-search t) pos)
11732 (save-excursion
11733 (goto-char (point-min))
11734 (setq pos (and (re-search-forward
11736 (match-beginning 0))))
11737 (if pos (goto-char pos))
11738 pos))
11740 (defconst org-dblock-start-re
11742 "Matches the start line of a dynamic block, with parameters.")
11745 "Matches the end of a dynamic block.")
11747 (defun org-create-dblock (plist)
11748 "Create a dynamic block section, with parameters taken from PLIST.
11749 PLIST must contain a :name entry which is used as name of the block."
11751 (end-of-line 1)
11752 (newline))
11753 (let ((col (current-column))
11754 (name (plist-get plist :name)))
11755 (insert "#+BEGIN: " name)
11756 (while plist
11757 (if (eq (car plist) :name)
11758 (setq plist (cddr plist))
11759 (insert " " (prin1-to-string (pop plist)))))
11761 (beginning-of-line -2)))
11763 (defun org-prepare-dblock ()
11764 "Prepare dynamic block for refresh.
11765 This empties the block, puts the cursor at the insert position and returns
11766 the property list including an extra property :name with the block name."
11767 (unless (looking-at org-dblock-start-re)
11768 (error "Not at a dynamic block"))
11769 (let* ((begdel (1+ (match-end 0)))
11770 (name (org-no-properties (match-string 1)))
11771 (params (append (list :name name)
11772 (read (concat "(" (match-string 3) ")")))))
11773 (save-excursion
11774 (beginning-of-line 1)
11776 (setq params (plist-put params :indentation-column (current-column))))
11777 (unless (re-search-forward org-dblock-end-re nil t)
11778 (error "Dynamic block not terminated"))
11779 (setq params
11780 (append params
11781 (list :content (buffer-substring
11782 begdel (match-beginning 0)))))
11783 (delete-region begdel (match-beginning 0))
11784 (goto-char begdel)
11785 (open-line 1)
11786 params))
11788 (defun org-map-dblocks (&optional command)
11789 "Apply COMMAND to all dynamic blocks in the current buffer.
11790 If COMMAND is not given, use `org-update-dblock'."
11791 (let ((cmd (or command 'org-update-dblock)))
11792 (save-excursion
11793 (goto-char (point-min))
11794 (while (re-search-forward org-dblock-start-re nil t)
11795 (goto-char (match-beginning 0))
11796 (save-excursion
11797 (condition-case nil
11798 (funcall cmd)
11799 (error (message "Error during update of dynamic block"))))
11800 (unless (re-search-forward org-dblock-end-re nil t)
11801 (error "Dynamic block not terminated"))))))
11803 (defun org-dblock-update (&optional arg)
11804 "User command for updating dynamic blocks.
11805 Update the dynamic block at point. With prefix ARG, update all dynamic
11806 blocks in the buffer."
11807 (interactive "P")
11808 (if arg
11809 (org-update-all-dblocks)
11810 (or (looking-at org-dblock-start-re)
11811 (org-beginning-of-dblock))
11812 (org-update-dblock)))
11814 (defun org-update-dblock ()
11815 "Update the dynamic block at point.
11816 This means to empty the block, parse for parameters and then call
11817 the correct writing function."
11818 (interactive)
11819 (save-window-excursion
11820 (let* ((pos (point))
11821 (line (org-current-line))
11822 (params (org-prepare-dblock))
11823 (name (plist-get params :name))
11824 (indent (plist-get params :indentation-column))
11825 (cmd (intern (concat "org-dblock-write:" name))))
11826 (message "Updating dynamic block `%s' at line %d..." name line)
11827 (funcall cmd params)
11828 (message "Updating dynamic block `%s' at line %d...done" name line)
11829 (goto-char pos)
11830 (when (and indent (> indent 0))
11831 (setq indent (make-string indent ?\ ))
11832 (save-excursion
11833 (org-beginning-of-dblock)
11834 (forward-line 1)
11835 (while (not (looking-at org-dblock-end-re))
11836 (insert indent)
11837 (beginning-of-line 2))
11838 (when (looking-at org-dblock-end-re)
11840 (replace-match ""))
11841 (insert indent)))))))
11843 (defun org-beginning-of-dblock ()
11844 "Find the beginning of the dynamic block at point.
11845 Error if there is no such block at point."
11846 (let ((pos (point))
11847 beg)
11848 (end-of-line 1)
11849 (if (and (re-search-backward org-dblock-start-re nil t)
11850 (setq beg (match-beginning 0))
11851 (re-search-forward org-dblock-end-re nil t)
11852 (> (match-end 0) pos))
11853 (goto-char beg)
11854 (goto-char pos)
11855 (error "Not in a dynamic block"))))
11857 (defun org-update-all-dblocks ()
11858 "Update all dynamic blocks in the buffer.
11859 This function can be used in a hook."
11860 (interactive)
11861 (when (derived-mode-p 'org-mode)
11862 (org-map-dblocks 'org-update-dblock)))
11865 ;;;; Completion
11867 (defun org-get-export-keywords ()
11868 "Return a list of all currently understood export keywords.
11869 Export keywords include options, block names, attributes and
11870 keywords relative to each registered export back-end."
11871 (delq nil
11872 (let (keywords)
11873 (mapc
11874 (lambda (back-end)
11875 (let ((props (cdr back-end)))
11876 ;; Back-end name (for keywords, like #+LATEX:)
11877 (push (upcase (symbol-name (car back-end))) keywords)
11878 ;; Back-end options.
11879 (mapc (lambda (option) (push (cadr option) keywords))
11880 (plist-get (cdr back-end) :options-alist))))
11881 (org-bound-and-true-p org-export-registered-backends))
11882 keywords)))
11884 (defconst org-options-keywords
11885 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11886 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11887 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11888 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11889 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11891 (defcustom org-structure-template-alist
11906 ("L" "#+LaTeX: "
11910 ("H" "#+HTML: "
11913 ("A" "#+ASCII: ")
11914 ("i" "#+INDEX: ?"
11915 "#+INDEX: ?")
11916 ("I" "#+INCLUDE: %file ?"
11918 "Structure completion elements.
11919 This is a list of abbreviation keys and values. The value gets inserted
11920 if you type `<' followed by the key and then press the completion key,
11921 usually `M-TAB'. %file will be replaced by a file name after prompting
11922 for the file using completion. The cursor will be placed at the position
11923 of the `?` in the template.
11924 There are two templates for each key, the first uses the original Org syntax,
11925 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11926 the default when the /org-mtags.el/ module has been loaded. See also the
11927 variable `org-mtags-prefer-muse-templates'."
11928 :group 'org-completion
11929 :type '(repeat
11930 (string :tag "Key")
11931 (string :tag "Template")
11932 (string :tag "Muse Template")))
11934 (defun org-try-structure-completion ()
11935 "Try to complete a structure template before point.
11937 expands them."
11938 (let ((l (buffer-substring (point-at-bol) (point)))
11939 a)
11942 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11943 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11944 (match-beginning 1)) a)
11945 t)))
11947 (defun org-complete-expand-structure-template (start cell)
11948 "Expand a structure template."
11949 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11950 (rpl (nth (if musep 2 1) cell))
11951 (ind ""))
11952 (delete-region start (point))
11954 (cond
11955 ((bolp))
11957 (setq ind (buffer-substring (point-at-bol) (point))))
11958 (t (newline))))
11959 (setq start (point))
11960 (if (string-match "%file" rpl)
11961 (setq rpl (replace-match
11962 (concat
11964 (save-match-data
11965 (abbreviate-file-name (read-file-name "Include file: ")))
11967 t t rpl)))
11970 (insert rpl)
11973 ;;;; TODO, DEADLINE, Comments
11975 (defun org-toggle-comment ()
11976 "Change the COMMENT state of an entry."
11977 (interactive)
11978 (save-excursion
11979 (org-back-to-heading)
11980 (let (case-fold-search)
11981 (cond
11982 ((looking-at (format org-heading-keyword-regexp-format
11983 org-comment-string))
11984 (goto-char (match-end 1))
11985 (looking-at (concat " +" org-comment-string))
11986 (replace-match "" t t)
11987 (when (eolp) (insert " ")))
11988 ((looking-at org-outline-regexp)
11989 (goto-char (match-end 0))
11990 (insert org-comment-string " "))))))
11992 (defvar org-last-todo-state-is-todo nil
11993 "This is non-nil when the last TODO state change led to a TODO state.
11994 If the last change removed the TODO tag or switched to DONE, then
11995 this is nil.")
11997 (defvar org-setting-tags nil) ; dynamically skipped
11999 (defvar org-todo-setup-filter-hook nil
12000 "Hook for functions that pre-filter todo specs.
12001 Each function takes a todo spec and returns either nil or the spec
12002 transformed into canonical form." )
12004 (defvar org-todo-get-default-hook nil
12005 "Hook for functions that get a default item for todo.
12006 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12007 nil or a string to be used for the todo mark." )
12009 (defvar org-agenda-headline-snapshot-before-repeat)
12011 (defun org-current-effective-time ()
12012 "Return current time adjusted for `org-extend-today-until' variable."
12013 (let* ((ct (org-current-time))
12014 (dct (decode-time ct))
12015 (ct1
12016 (cond
12017 (org-use-last-clock-out-time-as-effective-time
12018 (or (org-clock-get-last-clock-out-time) ct))
12019 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12020 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12021 (t ct))))
12022 ct1))
12024 (defun org-todo-yesterday (&optional arg)
12025 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12026 (interactive "P")
12027 (if (eq major-mode 'org-agenda-mode)
12028 (apply 'org-agenda-todo-yesterday arg)
12029 (let* ((hour (third (decode-time
12030 (org-current-time))))
12031 (org-extend-today-until (1+ hour)))
12032 (org-todo arg))))
12034 (defvar org-block-entry-blocking ""
12035 "First entry preventing the TODO state change.")
12037 (defun org-todo (&optional arg)
12038 "Change the TODO state of an item.
12039 The state of an item is given by a keyword at the start of the heading,
12040 like
12041 *** TODO Write paper
12042 *** DONE Call mom
12044 The different keywords are specified in the variable `org-todo-keywords'.
12046 So for this example: when the item starts with TODO, it is changed to DONE.
12047 When it starts with DONE, the DONE is removed. And when neither TODO nor
12048 DONE are present, add TODO at the beginning of the heading.
12051 state.
12052 With numeric prefix arg, switch to that state.
12054 keywords (nextset).
12056 With a numeric prefix arg of 0, inhibit note taking for the change.
12058 For calling through lisp, arg is also interpreted in the following way:
12059 'none -> empty state
12061 'done -> switch to DONE
12062 'nextset -> switch to the next set of keywords
12063 'previousset -> switch to the previous set of keywords
12065 really is a member of `org-todo-keywords'."
12066 (interactive "P")
12067 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12068 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12069 'region-start-level 'region))
12070 org-loop-over-headlines-in-active-region)
12071 (org-map-entries
12072 `(org-todo ,arg)
12073 org-loop-over-headlines-in-active-region
12074 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12075 (if (equal arg '(16)) (setq arg 'nextset))
12076 (let ((org-blocker-hook org-blocker-hook)
12077 commentp
12078 case-fold-search)
12079 (when (equal arg '(64))
12080 (setq arg nil org-blocker-hook nil))
12081 (when (and org-blocker-hook
12082 (or org-inhibit-blocking
12083 (org-entry-get nil "NOBLOCKING")))
12084 (setq org-blocker-hook nil))
12085 (save-excursion
12086 (catch 'exit
12087 (org-back-to-heading t)
12089 (org-toggle-comment)
12090 (setq commentp t))
12091 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12094 (let* ((match-data (match-data))
12095 (startpos (point-at-bol))
12096 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12097 (org-log-done org-log-done)
12098 (org-log-repeat org-log-repeat)
12099 (org-todo-log-states org-todo-log-states)
12100 (org-inhibit-logging
12101 (if (equal arg 0)
12102 (progn (setq arg nil) 'note) org-inhibit-logging))
12103 (this (match-string 1))
12104 (hl-pos (match-beginning 0))
12105 (head (org-get-todo-sequence-head this))
12106 (ass (assoc head org-todo-kwd-alist))
12107 (interpret (nth 1 ass))
12108 (done-word (nth 3 ass))
12109 (final-done-word (nth 4 ass))
12110 (org-last-state (or this ""))
12111 (completion-ignore-case t)
12112 (member (member this org-todo-keywords-1))
12113 (tail (cdr member))
12114 (org-state (cond
12115 ((and org-todo-key-trigger
12116 (or (and (equal arg '(4))
12117 (eq org-use-fast-todo-selection 'prefix))
12118 (and (not arg) org-use-fast-todo-selection
12119 (not (eq org-use-fast-todo-selection
12120 'prefix)))))
12121 ;; Use fast selection
12122 (org-fast-todo-selection))
12123 ((and (equal arg '(4))
12124 (or (not org-use-fast-todo-selection)
12125 (not org-todo-key-trigger)))
12126 ;; Read a state with completion
12127 (org-icompleting-read
12128 "State: " (mapcar 'list org-todo-keywords-1)
12129 nil t))
12130 ((eq arg 'right)
12131 (if this
12132 (if tail (car tail) nil)
12133 (car org-todo-keywords-1)))
12134 ((eq arg 'left)
12135 (if (equal member org-todo-keywords-1)
12136 nil
12137 (if this
12138 (nth (- (length org-todo-keywords-1)
12139 (length tail) 2)
12140 org-todo-keywords-1)
12141 (org-last org-todo-keywords-1))))
12142 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12143 (setq arg nil))) ; hack to fall back to cycling
12144 (arg
12145 ;; user or caller requests a specific state
12146 (cond
12147 ((equal arg "") nil)
12148 ((eq arg 'none) nil)
12149 ((eq arg 'done) (or done-word (car org-done-keywords)))
12150 ((eq arg 'nextset)
12151 (or (car (cdr (member head org-todo-heads)))
12152 (car org-todo-heads)))
12153 ((eq arg 'previousset)
12154 (let ((org-todo-heads (reverse org-todo-heads)))
12155 (or (car (cdr (member head org-todo-heads)))
12156 (car org-todo-heads))))
12157 ((car (member arg org-todo-keywords-1)))
12158 ((stringp arg)
12159 (error "State `%s' not valid in this file" arg))
12160 ((nth (1- (prefix-numeric-value arg))
12161 org-todo-keywords-1))))
12162 ((null member) (or head (car org-todo-keywords-1)))
12163 ((equal this final-done-word) nil) ;; -> make empty
12164 ((null tail) nil) ;; -> first entry
12165 ((memq interpret '(type priority))
12166 (if (eq this-command last-command)
12167 (car tail)
12168 (if (> (length tail) 0)
12169 (or done-word (car org-done-keywords))
12170 nil)))
12171 (t
12172 (car tail))))
12173 (org-state (or
12174 (run-hook-with-args-until-success
12175 'org-todo-get-default-hook org-state org-last-state)
12176 org-state))
12177 (next (if org-state (concat " " org-state " ") " "))
12178 (change-plist (list :type 'todo-state-change :from this :to org-state
12179 :position startpos))
12180 dolog now-done-p)
12181 (when org-blocker-hook
12182 (setq org-last-todo-state-is-todo
12183 (not (member this org-done-keywords)))
12184 (unless (save-excursion
12185 (save-match-data
12186 (org-with-wide-buffer
12187 (run-hook-with-args-until-failure
12188 'org-blocker-hook change-plist))))
12189 (if (org-called-interactively-p 'interactive)
12191 this org-state org-block-entry-blocking)
12192 ;; fail silently
12194 this org-state org-block-entry-blocking)
12195 (throw 'exit nil))))
12196 (store-match-data match-data)
12197 (replace-match next t t)
12198 (unless (pos-visible-in-window-p hl-pos)
12199 (message "TODO state changed to %s" (org-trim next)))
12200 (unless head
12201 (setq head (org-get-todo-sequence-head org-state)
12202 ass (assoc head org-todo-kwd-alist)
12203 interpret (nth 1 ass)
12204 done-word (nth 3 ass)
12205 final-done-word (nth 4 ass)))
12206 (when (memq arg '(nextset previousset))
12207 (message "Keyword-Set %d/%d: %s"
12208 (- (length org-todo-sets) -1
12209 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12210 (length org-todo-sets)
12211 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12212 (setq org-last-todo-state-is-todo
12213 (not (member org-state org-done-keywords)))
12214 (setq now-done-p (and (member org-state org-done-keywords)
12215 (not (member this org-done-keywords))))
12216 (and logging (org-local-logging logging))
12217 (when (and (or org-todo-log-states org-log-done)
12218 (not (eq org-inhibit-logging t))
12219 (not (memq arg '(nextset previousset))))
12220 ;; we need to look at recording a time and note
12221 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12222 (nth 2 (assoc this org-todo-log-states))))
12223 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12224 (setq dolog 'time))
12225 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12226 (and org-state
12227 (member org-state org-not-done-keywords)
12228 (not (member this org-not-done-keywords))))
12229 ;; This is now a todo state and was not one before
12230 ;; If there was a CLOSED time stamp, get rid of it.
12231 (org-add-planning-info nil nil 'closed))
12232 (when (and now-done-p org-log-done)
12233 ;; It is now done, and it was not done before
12234 (org-add-planning-info 'closed (org-current-effective-time))
12235 (if (and (not dolog) (eq 'note org-log-done))
12236 (org-add-log-setup 'done org-state this 'findpos 'note)))
12237 (when (and org-state dolog)
12238 ;; This is a non-nil state, and we need to log it
12239 (org-add-log-setup 'state org-state this 'findpos dolog)))
12240 ;; Fixup tag positioning
12241 (org-todo-trigger-tag-changes org-state)
12242 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12243 (when org-provide-todo-statistics
12244 (org-update-parent-todo-statistics))
12245 (run-hooks 'org-after-todo-state-change-hook)
12246 (if (and arg (not (member org-state org-done-keywords)))
12247 (setq head (org-get-todo-sequence-head org-state)))
12248 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12249 ;; Do we need to trigger a repeat?
12250 (when now-done-p
12251 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12252 ;; This is for the agenda, take a snapshot of the headline.
12253 (save-match-data
12254 (setq org-agenda-headline-snapshot-before-repeat
12255 (org-get-heading))))
12256 (org-auto-repeat-maybe org-state))
12257 ;; Fixup cursor location if close to the keyword
12258 (if (and (outline-on-heading-p)
12259 (not (bolp))
12260 (save-excursion (beginning-of-line 1)
12261 (looking-at org-todo-line-regexp))
12262 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12263 (progn
12264 (goto-char (or (match-end 2) (match-end 1)))
12265 (and (looking-at " ") (just-one-space))))
12266 (when org-trigger-hook
12267 (save-excursion
12268 (run-hook-with-args 'org-trigger-hook change-plist)))
12269 (when commentp (org-toggle-comment))))))))
12271 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12272 "Block turning an entry into a TODO, using the hierarchy.
12273 This checks whether the current task should be blocked from state
12274 changes. Such blocking occurs when:
12276 1. The task has children which are not all in a completed state.
12278 2. A task has a parent with the property :ORDERED:, and there
12279 are siblings prior to the current task with incomplete
12280 status.
12282 3. The parent of the task is blocked because it has siblings that should
12283 be done first, or is child of a block grandparent TODO entry."
12285 (if (not org-enforce-todo-dependencies)
12286 t ; if locally turned off don't block
12287 (catch 'dont-block
12288 ;; If this is not a todo state change, or if this entry is already DONE,
12289 ;; do not block
12290 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12291 (member (plist-get change-plist :from)
12292 (cons 'done org-done-keywords))
12293 (member (plist-get change-plist :to)
12294 (cons 'todo org-not-done-keywords))
12295 (not (plist-get change-plist :to)))
12296 (throw 'dont-block t))
12297 ;; If this task has children, and any are undone, it's blocked
12298 (save-excursion
12299 (org-back-to-heading t)
12300 (let ((this-level (funcall outline-level)))
12301 (outline-next-heading)
12302 (let ((child-level (funcall outline-level)))
12303 (while (and (not (eobp))
12304 (> child-level this-level))
12305 ;; this todo has children, check whether they are all
12306 ;; completed
12307 (if (and (not (org-entry-is-done-p))
12308 (org-entry-is-todo-p))
12309 (progn (setq org-block-entry-blocking (org-get-heading))
12310 (throw 'dont-block nil)))
12311 (outline-next-heading)
12312 (setq child-level (funcall outline-level))))))
12313 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12314 ;; any previous siblings are undone, it's blocked
12315 (save-excursion
12316 (org-back-to-heading t)
12317 (let* ((pos (point))
12318 (parent-pos (and (org-up-heading-safe) (point))))
12319 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12320 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12321 (forward-line 1)
12322 (re-search-forward org-not-done-heading-regexp pos t))
12323 (setq org-block-entry-blocking (match-string 0))
12324 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12325 ;; Search further up the hierarchy, to see if an ancestor is blocked
12326 (while t
12327 (goto-char parent-pos)
12328 (if (not (looking-at org-not-done-heading-regexp))
12329 (throw 'dont-block t)) ; do not block, parent is not a TODO
12330 (setq pos (point))
12331 (setq parent-pos (and (org-up-heading-safe) (point)))
12332 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12333 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12334 (forward-line 1)
12335 (re-search-forward org-not-done-heading-regexp pos t)
12336 (setq org-block-entry-blocking (org-get-heading)))
12337 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12339 (defcustom org-track-ordered-property-with-tag nil
12340 "Should the ORDERED property also be shown as a tag?
12341 The ORDERED property decides if an entry should require subtasks to be
12342 completed in sequence. Since a property is not very visible, setting
12343 this option means that toggling the ORDERED property with the command
12344 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12345 not relevant for the behavior, but it makes things more visible.
12347 Note that toggling the tag with tags commands will not change the property
12348 and therefore not influence behavior!
12350 This can be t, meaning the tag ORDERED should be used, It can also be a
12351 string to select a different tag for this task."
12352 :group 'org-todo
12353 :type '(choice
12354 (const :tag "No tracking" nil)
12355 (const :tag "Track with ORDERED tag" t)
12356 (string :tag "Use other tag")))
12358 (defun org-toggle-ordered-property ()
12359 "Toggle the ORDERED property of the current entry.
12360 For better visibility, you can track the value of this property with a tag.
12361 See variable `org-track-ordered-property-with-tag'."
12362 (interactive)
12363 (let* ((t1 org-track-ordered-property-with-tag)
12364 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12365 (save-excursion
12366 (org-back-to-heading)
12367 (if (org-entry-get nil "ORDERED")
12368 (progn
12369 (org-delete-property "ORDERED" "PROPERTIES")
12370 (and tag (org-toggle-tag tag 'off))
12371 (message "Subtasks can be completed in arbitrary order"))
12372 (org-entry-put nil "ORDERED" "t")
12373 (and tag (org-toggle-tag tag 'on))
12374 (message "Subtasks must be completed in sequence")))))
12376 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12377 (defun org-block-todo-from-checkboxes (change-plist)
12378 "Block turning an entry into a TODO, using checkboxes.
12379 This checks whether the current task should be blocked from state
12380 changes because there are unchecked boxes in this entry."
12381 (if (not org-enforce-todo-checkbox-dependencies)
12382 t ; if locally turned off don't block
12383 (catch 'dont-block
12384 ;; If this is not a todo state change, or if this entry is already DONE,
12385 ;; do not block
12386 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12387 (member (plist-get change-plist :from)
12388 (cons 'done org-done-keywords))
12389 (member (plist-get change-plist :to)
12390 (cons 'todo org-not-done-keywords))
12391 (not (plist-get change-plist :to)))
12392 (throw 'dont-block t))
12393 ;; If this task has checkboxes that are not checked, it's blocked
12394 (save-excursion
12395 (org-back-to-heading t)
12396 (let ((beg (point)) end)
12397 (outline-next-heading)
12398 (setq end (point))
12399 (goto-char beg)
12400 (if (org-list-search-forward
12401 (concat (org-item-beginning-re)
12404 end t)
12405 (progn
12406 (if (boundp 'org-blocked-by-checkboxes)
12407 (setq org-blocked-by-checkboxes t))
12408 (throw 'dont-block nil)))))
12409 t))) ; do not block
12411 (defun org-entry-blocked-p ()
12412 "Is the current entry blocked?"
12413 (org-with-silent-modifications
12414 (if (org-entry-get nil "NOBLOCKING")
12415 nil ;; Never block this entry
12416 (not (run-hook-with-args-until-failure
12417 'org-blocker-hook
12418 (list :type 'todo-state-change
12419 :position (point)
12420 :from 'todo
12421 :to 'done))))))
12423 (defun org-update-statistics-cookies (all)
12424 "Update the statistics cookie, either from TODO or from checkboxes.
12425 This should be called with the cursor in a line with a statistics cookie."
12426 (interactive "P")
12427 (if all
12428 (progn
12429 (org-update-checkbox-count 'all)
12430 (org-map-entries 'org-update-parent-todo-statistics))
12431 (if (not (org-at-heading-p))
12432 (org-update-checkbox-count)
12433 (let ((pos (point-marker))
12434 end l1 l2)
12435 (ignore-errors (org-back-to-heading t))
12436 (if (not (org-at-heading-p))
12437 (org-update-checkbox-count)
12438 (setq l1 (org-outline-level))
12439 (setq end (save-excursion
12440 (outline-next-heading)
12441 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12442 (point)))
12443 (if (and (save-excursion
12444 (re-search-forward
12446 (not (save-excursion (re-search-forward
12448 (org-update-checkbox-count)
12449 (if (and l2 (> l2 l1))
12450 (progn
12451 (goto-char end)
12452 (org-update-parent-todo-statistics))
12453 (goto-char pos)
12454 (beginning-of-line 1)
12455 (while (re-search-forward
12457 (point-at-eol) t)
12458 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12459 (goto-char pos)
12460 (move-marker pos nil)))))
12462 (defvar org-entry-property-inherited-from) ;; defined below
12463 (defun org-update-parent-todo-statistics ()
12464 "Update any statistics cookie in the parent of the current headline.
12465 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12466 the entire subtree and this will travel up the hierarchy and update
12467 statistics everywhere."
12468 (let* ((prop (save-excursion (org-up-heading-safe)
12469 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12470 (recursive (or (not org-hierarchical-todo-statistics)
12472 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12473 0))
12474 (first t)
12476 level ltoggle l1 new ndel
12477 (cnt-all 0) (cnt-done 0) is-percent kwd
12478 checkbox-beg ov ovs ove cookie-present)
12479 (catch 'exit
12480 (save-excursion
12481 (beginning-of-line 1)
12482 (setq ltoggle (funcall outline-level))
12483 ;; Three situations are to consider:
12485 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12486 ;; to the top-level ancestor on the headline;
12488 ;; 2. If parent has "recursive" property, repeat up to the
12489 ;; headline setting that property, taking inheritance into
12490 ;; account;
12492 ;; 3. Else, move up to direct parent and proceed only once.
12493 (while (and (setq level (org-up-heading-safe))
12494 (or recursive first)
12495 (>= (point) lim))
12496 (setq first nil cookie-present nil)
12497 (unless (and level
12498 (not (string-match
12500 (downcase (or (org-entry-get nil "COOKIE_DATA")
12501 "")))))
12502 (throw 'exit nil))
12503 (while (re-search-forward box-re (point-at-eol) t)
12504 (setq cnt-all 0 cnt-done 0 cookie-present t)
12505 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12506 (save-match-data
12507 (unless (outline-next-heading) (throw 'exit nil))
12508 (while (and (looking-at org-complex-heading-regexp)
12509 (> (setq l1 (length (match-string 1))) level))
12510 (setq kwd (and (or recursive (= l1 ltoggle))
12511 (match-string 2)))
12512 (if (or (eq org-provide-todo-statistics 'all-headlines)
12513 (and (listp org-provide-todo-statistics)
12514 (or (member kwd org-provide-todo-statistics)
12515 (member kwd org-done-keywords))))
12516 (setq cnt-all (1+ cnt-all))
12517 (if (eq org-provide-todo-statistics t)
12518 (and kwd (setq cnt-all (1+ cnt-all)))))
12519 (and (member kwd org-done-keywords)
12520 (setq cnt-done (1+ cnt-done)))
12521 (outline-next-heading)))
12522 (setq new
12523 (if is-percent
12524 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12525 (format "[%d/%d]" cnt-done cnt-all))
12526 ndel (- (match-end 0) checkbox-beg))
12527 ;; handle overlays when updating cookie from column view
12528 (when (setq ov (car (overlays-at checkbox-beg)))
12529 (setq ovs (overlay-start ov) ove (overlay-end ov))
12530 (delete-overlay ov))
12531 (goto-char checkbox-beg)
12532 (insert new)
12533 (delete-region (point) (+ (point) ndel))
12534 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12535 (when ov (move-overlay ov ovs ove)))
12536 (when cookie-present
12537 (run-hook-with-args 'org-after-todo-statistics-hook
12538 cnt-done (- cnt-all cnt-done))))))
12539 (run-hooks 'org-todo-statistics-hook)))
12541 (defvar org-after-todo-statistics-hook nil
12542 "Hook that is called after a TODO statistics cookie has been updated.
12543 Each function is called with two arguments: the number of not-done entries
12544 and the number of done entries.
12546 For example, the following function, when added to this hook, will switch
12547 an entry to DONE when all children are done, and back to TODO when new
12548 entries are set to a TODO status. Note that this hook is only called
12549 when there is a statistics cookie in the headline!
12551 (defun org-summary-todo (n-done n-not-done)
12553 (let (org-log-done org-log-states) ; turn off logging
12555 ")
12557 (defvar org-todo-statistics-hook nil
12558 "Hook that is run whenever Org thinks TODO statistics should be updated.
12559 This hook runs even if there is no statistics cookie present, in which case
12560 `org-after-todo-statistics-hook' would not run.")
12562 (defun org-todo-trigger-tag-changes (state)
12563 "Apply the changes defined in `org-todo-state-tags-triggers'."
12564 (let ((l org-todo-state-tags-triggers)
12565 changes)
12566 (when (or (not state) (equal state ""))
12567 (setq changes (append changes (cdr (assoc "" l)))))
12568 (when (and (stringp state) (> (length state) 0))
12569 (setq changes (append changes (cdr (assoc state l)))))
12570 (when (member state org-not-done-keywords)
12571 (setq changes (append changes (cdr (assoc 'todo l)))))
12572 (when (member state org-done-keywords)
12573 (setq changes (append changes (cdr (assoc 'done l)))))
12574 (dolist (c changes)
12575 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12577 (defun org-local-logging (value)
12578 "Get logging settings from a property VALUE."
12579 (let* (words w a)
12580 ;; directly set the variables, they are already local.
12581 (setq org-log-done nil
12582 org-log-repeat nil
12583 org-todo-log-states nil)
12584 (setq words (org-split-string value))
12585 (while (setq w (pop words))
12586 (cond
12587 ((setq a (assoc w org-startup-options))
12588 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12589 (set (nth 1 a) (nth 2 a))))
12590 ((setq a (org-extract-log-state-settings w))
12591 (and (member (car a) org-todo-keywords-1)
12592 (push a org-todo-log-states)))))))
12594 (defun org-get-todo-sequence-head (kwd)
12595 "Return the head of the TODO sequence to which KWD belongs.
12596 If KWD is not set, check if there is a text property remembering the
12597 right sequence."
12598 (let (p)
12599 (cond
12600 ((not kwd)
12601 (or (get-text-property (point-at-bol) 'org-todo-head)
12602 (progn
12603 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12604 nil (point-at-eol)))
12605 (get-text-property p 'org-todo-head))))
12606 ((not (member kwd org-todo-keywords-1))
12607 (car org-todo-keywords-1))
12608 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12610 (defun org-fast-todo-selection ()
12611 "Fast TODO keyword selection with single keys.
12612 Returns the new TODO keyword, or nil if no state change should occur."
12613 (let* ((fulltable org-todo-key-alist)
12614 (done-keywords org-done-keywords) ;; needed for the faces.
12615 (maxlen (apply 'max (mapcar
12616 (lambda (x)
12617 (if (stringp (car x)) (string-width (car x)) 0))
12618 fulltable)))
12619 (expert nil)
12620 (fwidth (+ maxlen 3 1 3))
12621 (ncol (/ (- (window-width) 4) fwidth))
12622 tg cnt e c tbl
12623 groups ingroup)
12624 (save-excursion
12625 (save-window-excursion
12626 (if expert
12627 (set-buffer (get-buffer-create " *Org todo*"))
12628 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12629 (erase-buffer)
12630 (org-set-local 'org-done-keywords done-keywords)
12631 (setq tbl fulltable cnt 0)
12632 (while (setq e (pop tbl))
12633 (cond
12634 ((equal e '(:startgroup))
12635 (push '() groups) (setq ingroup t)
12636 (when (not (= cnt 0))
12637 (setq cnt 0)
12639 (insert "{ "))
12640 ((equal e '(:endgroup))
12641 (setq ingroup nil cnt 0)
12643 ((equal e '(:newline))
12644 (when (not (= cnt 0))
12645 (setq cnt 0)
12647 (setq e (car tbl))
12648 (while (equal (car tbl) '(:newline))
12650 (setq tbl (cdr tbl)))))
12651 (t
12652 (setq tg (car e) c (cdr e))
12653 (if ingroup (push tg (car groups)))
12654 (setq tg (org-add-props tg nil 'face
12655 (org-get-todo-face tg)))
12656 (if (and (= cnt 0) (not ingroup)) (insert " "))
12657 (insert "[" c "] " tg (make-string
12658 (- fwidth 4 (length tg)) ?\ ))
12659 (when (= (setq cnt (1+ cnt)) ncol)
12661 (if ingroup (insert " "))
12662 (setq cnt 0)))))
12664 (goto-char (point-min))
12665 (if (not expert) (org-fit-window-to-buffer))
12666 (message "[a-z..]:Set [SPC]:clear")
12667 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12668 (cond
12669 ((or (= c ?\C-g)
12670 (and (= c ?q) (not (rassoc c fulltable))))
12671 (setq quit-flag t))
12672 ((= c ?\ ) nil)
12673 ((setq e (rassoc c fulltable) tg (car e))
12674 tg)
12675 (t (setq quit-flag t)))))))
12677 (defun org-entry-is-todo-p ()
12678 (member (org-get-todo-state) org-not-done-keywords))
12680 (defun org-entry-is-done-p ()
12681 (member (org-get-todo-state) org-done-keywords))
12683 (defun org-get-todo-state ()
12684 "Return the TODO keyword of the current subtree."
12685 (save-excursion
12686 (org-back-to-heading t)
12687 (and (looking-at org-todo-line-regexp)
12688 (match-end 2)
12689 (match-string 2))))
12691 (defun org-at-date-range-p (&optional inactive-ok)
12692 "Is the cursor inside a date range?"
12693 (interactive)
12694 (save-excursion
12695 (catch 'exit
12696 (let ((pos (point)))
12698 (skip-chars-backward "<[")
12699 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12700 (>= (match-end 0) pos)
12701 (throw 'exit t))
12703 (skip-chars-backward "<[")
12704 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12705 (>= (match-end 0) pos)
12706 (throw 'exit t)))
12707 nil)))
12709 (defun org-get-repeat (&optional tagline)
12710 "Check if there is a deadline/schedule with repeater in this entry."
12711 (save-match-data
12712 (save-excursion
12713 (org-back-to-heading t)
12714 (and (re-search-forward (if tagline
12716 org-repeat-re)
12717 (org-entry-end-position) t)
12718 (match-string-no-properties 1)))))
12720 (defvar org-last-changed-timestamp)
12721 (defvar org-last-inserted-timestamp)
12722 (defvar org-log-post-message)
12723 (defvar org-log-note-purpose)
12724 (defvar org-log-note-how)
12725 (defvar org-log-note-extra)
12726 (defun org-auto-repeat-maybe (done-word)
12727 "Check if the current headline contains a repeated deadline/schedule.
12728 If yes, set TODO state back to what it was and change the base date
12729 of repeating deadline/scheduled time stamps to new date.
12730 This function is run automatically after each state change to a DONE state."
12731 ;; last-state is dynamically scoped into this function
12732 (let* ((repeat (org-get-repeat))
12733 (aa (assoc org-last-state org-todo-kwd-alist))
12734 (interpret (nth 1 aa))
12735 (head (nth 2 aa))
12736 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12737 (msg "Entry repeats: ")
12738 (org-log-done nil)
12739 (org-todo-log-states nil)
12740 re type n what ts time to-state)
12741 (when repeat
12742 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12743 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12744 org-todo-repeat-to-state))
12745 (unless (and to-state (member to-state org-todo-keywords-1))
12746 (setq to-state (if (eq interpret 'type) org-last-state head)))
12747 (org-todo to-state)
12748 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12749 (org-entry-put nil "LAST_REPEAT" (format-time-string
12750 (org-time-stamp-format t t))))
12751 (when org-log-repeat
12752 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12753 (memq 'org-add-log-note post-command-hook))
12754 ;; OK, we are already setup for some record
12755 (if (eq org-log-repeat 'note)
12756 ;; make sure we take a note, not only a time stamp
12757 (setq org-log-note-how 'note))
12758 ;; Set up for taking a record
12759 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12760 org-last-state
12761 'findpos org-log-repeat)))
12762 (org-back-to-heading t)
12763 (org-add-planning-info nil nil 'closed)
12767 (while (re-search-forward
12768 re (save-excursion (outline-next-heading) (point)) t)
12769 (setq type (if (match-end 1) org-scheduled-string
12770 (if (match-end 3) org-deadline-string "Plain:"))
12771 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12773 (setq n (string-to-number (match-string 2 ts))
12774 what (match-string 3 ts))
12775 (if (equal what "w") (setq n (* n 7) what "d"))
12777 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12778 ;; Preparation, see if we need to modify the start date for the change
12779 (when (match-end 1)
12780 (setq time (save-match-data (org-time-string-to-time ts)))
12781 (cond
12782 ((equal (match-string 1 ts) ".")
12783 ;; Shift starting date to today
12784 (org-timestamp-change
12785 (- (org-today) (time-to-days time))
12786 'day))
12787 ((equal (match-string 1 ts) "+")
12788 (let ((nshiftmax 10) (nshift 0))
12789 (while (or (= nshift 0)
12790 (<= (time-to-days time)
12791 (time-to-days (current-time))))
12792 (when (= (incf nshift) nshiftmax)
12793 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12794 (error "Abort")))
12795 (org-timestamp-change n (cdr (assoc what whata)))
12796 (org-at-timestamp-p t)
12797 (setq ts (match-string 1))
12798 (setq time (save-match-data (org-time-string-to-time ts)))))
12799 (org-timestamp-change (- n) (cdr (assoc what whata)))
12800 ;; rematch, so that we have everything in place for the real shift
12801 (org-at-timestamp-p t)
12802 (setq ts (match-string 1))
12804 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12805 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12806 (setq org-log-post-message msg)
12807 (message "%s" msg))))
12809 (defun org-show-todo-tree (arg)
12810 "Make a compact tree which shows all headlines marked with TODO.
12811 The tree will show the lines where the regexp matches, and all higher
12812 headlines above the match.
12814 With a numeric prefix N, construct a sparse tree for the Nth element
12815 of `org-todo-keywords-1'."
12816 (interactive "P")
12817 (let ((case-fold-search nil)
12818 (kwd-re
12819 (cond ((null arg) org-not-done-regexp)
12820 ((equal arg '(4))
12821 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12822 (mapcar 'list org-todo-keywords-1))))
12826 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12827 (regexp-quote (nth (1- (prefix-numeric-value arg))
12828 org-todo-keywords-1)))
12829 (t (error "Invalid prefix argument: %s" arg)))))
12830 (message "%d TODO entries found"
12831 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12833 (defun org-deadline (arg &optional time)
12835 With one universal prefix argument, remove any deadline from the item.
12836 With two universal prefix arguments, prompt for a warning delay.
12837 With argument TIME, set the deadline at the corresponding date. TIME
12839 (interactive "P")
12840 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12841 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12842 'region-start-level 'region))
12843 org-loop-over-headlines-in-active-region)
12844 (org-map-entries
12845 `(org-deadline ',arg ,time)
12846 org-loop-over-headlines-in-active-region
12847 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12848 (let* ((old-date (org-entry-get nil "DEADLINE"))
12849 (old-date-time (if old-date (org-time-string-to-time old-date)))
12850 (repeater (and old-date
12851 (string-match
12853 old-date)
12854 (match-string 1 old-date))))
12855 (cond
12856 ((equal arg '(4))
12857 (when (and old-date org-log-redeadline)
12858 (org-add-log-setup 'deldeadline nil old-date 'findpos
12859 org-log-redeadline))
12860 (org-remove-timestamp-with-keyword org-deadline-string)
12861 (message "Item no longer has a deadline."))
12862 ((equal arg '(16))
12863 (save-excursion
12864 (if (re-search-forward
12865 org-deadline-time-regexp
12866 (save-excursion (outline-next-heading) (point)) t)
12867 (let* ((rpl0 (match-string 1))
12868 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12869 (replace-match
12870 (concat org-deadline-string
12871 " <" rpl
12872 (format " -%dd"
12873 (abs
12874 (- (time-to-days
12875 (save-match-data
12876 (org-read-date nil t nil "Warn starting from" old-date-time)))
12877 (time-to-days old-date-time))))
12878 ">") t t))
12879 (user-error "No deadline information to update"))))
12880 (t
12881 (org-add-planning-info 'deadline time 'closed)
12882 (when (and old-date org-log-redeadline
12883 (not (equal old-date
12884 (substring org-last-inserted-timestamp 1 -1))))
12885 (org-add-log-setup 'redeadline nil old-date 'findpos
12886 org-log-redeadline))
12887 (when repeater
12888 (save-excursion
12889 (org-back-to-heading t)
12890 (when (re-search-forward (concat org-deadline-string " "
12891 org-last-inserted-timestamp)
12892 (save-excursion
12893 (outline-next-heading) (point)) t)
12894 (goto-char (1- (match-end 0)))
12895 (insert " " repeater)
12896 (setq org-last-inserted-timestamp
12897 (concat (substring org-last-inserted-timestamp 0 -1)
12898 " " repeater
12899 (substring org-last-inserted-timestamp -1))))))
12900 (message "Deadline on %s" org-last-inserted-timestamp))))))
12902 (defun org-schedule (arg &optional time)
12903 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12904 With one universal prefix argument, remove any scheduling date from the item.
12905 With two universal prefix arguments, prompt for a delay cookie.
12906 With argument TIME, scheduled at the corresponding date. TIME can
12908 (interactive "P")
12909 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12910 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12911 'region-start-level 'region))
12912 org-loop-over-headlines-in-active-region)
12913 (org-map-entries
12914 `(org-schedule ',arg ,time)
12915 org-loop-over-headlines-in-active-region
12916 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12917 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12918 (old-date-time (if old-date (org-time-string-to-time old-date)))
12919 (repeater (and old-date
12920 (string-match
12922 old-date)
12923 (match-string 1 old-date))))
12924 (cond
12925 ((equal arg '(4))
12926 (progn
12927 (when (and old-date org-log-reschedule)
12928 (org-add-log-setup 'delschedule nil old-date 'findpos
12929 org-log-reschedule))
12930 (org-remove-timestamp-with-keyword org-scheduled-string)
12931 (message "Item is no longer scheduled.")))
12932 ((equal arg '(16))
12933 (save-excursion
12934 (if (re-search-forward
12935 org-scheduled-time-regexp
12936 (save-excursion (outline-next-heading) (point)) t)
12937 (let* ((rpl0 (match-string 1))
12938 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12939 (replace-match
12940 (concat org-scheduled-string
12941 " <" rpl
12942 (format " -%dd"
12943 (abs
12944 (- (time-to-days
12945 (save-match-data
12946 (org-read-date nil t nil "Delay until" old-date-time)))
12947 (time-to-days old-date-time))))
12948 ">") t t))
12949 (user-error "No scheduled information to update"))))
12950 (t
12951 (org-add-planning-info 'scheduled time 'closed)
12952 (when (and old-date org-log-reschedule
12953 (not (equal old-date
12954 (substring org-last-inserted-timestamp 1 -1))))
12955 (org-add-log-setup 'reschedule nil old-date 'findpos
12956 org-log-reschedule))
12957 (when repeater
12958 (save-excursion
12959 (org-back-to-heading t)
12960 (when (re-search-forward (concat org-scheduled-string " "
12961 org-last-inserted-timestamp)
12962 (save-excursion
12963 (outline-next-heading) (point)) t)
12964 (goto-char (1- (match-end 0)))
12965 (insert " " repeater)
12966 (setq org-last-inserted-timestamp
12967 (concat (substring org-last-inserted-timestamp 0 -1)
12968 " " repeater
12969 (substring org-last-inserted-timestamp -1))))))
12970 (message "Scheduled to %s" org-last-inserted-timestamp))))))
12972 (defun org-get-scheduled-time (pom &optional inherit)
12973 "Get the scheduled time as a time tuple, of a format suitable
12974 for calling org-schedule with, or if there is no scheduling,
12975 returns nil."
12976 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12977 (when time
12978 (apply 'encode-time (org-parse-time-string time)))))
12980 (defun org-get-deadline-time (pom &optional inherit)
12981 "Get the deadline as a time tuple, of a format suitable for
12982 calling org-deadline with, or if there is no scheduling, returns
12983 nil."
12984 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12985 (when time
12986 (apply 'encode-time (org-parse-time-string time)))))
12988 (defun org-remove-timestamp-with-keyword (keyword)
12989 "Remove all time stamps with KEYWORD in the current entry."
12991 beg)
12992 (save-excursion
12993 (org-back-to-heading t)
12994 (setq beg (point))
12995 (outline-next-heading)
12996 (while (re-search-backward re beg t)
12997 (replace-match "")
12999 (equal (char-before) ?\ ))
13000 (backward-delete-char 1)
13002 (point-at-bol) (point-at-eol)))
13003 (delete-region (point-at-bol)
13004 (min (point-max) (1+ (point-at-eol))))))))))
13006 (defun org-add-planning-info (what &optional time &rest remove)
13007 "Insert new timestamp with keyword in the line directly after the headline.
13008 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13009 If non is given, the user is prompted for a date.
13010 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13011 be removed."
13012 (interactive)
13013 (let (org-time-was-given org-end-time-was-given ts
13014 end default-time default-input)
13016 (catch 'exit
13017 (when (and (memq what '(scheduled deadline))
13018 (or (not time)
13019 (and (stringp time)
13020 (string-match "^[-+]+[0-9]" time))))
13021 ;; Try to get a default date/time from existing timestamp
13022 (save-excursion
13023 (org-back-to-heading t)
13024 (setq end (save-excursion (outline-next-heading) (point)))
13025 (when (re-search-forward (if (eq what 'scheduled)
13026 org-scheduled-time-regexp
13027 org-deadline-time-regexp)
13028 end t)
13029 (setq ts (match-string 1)
13030 default-time
13031 (apply 'encode-time (org-parse-time-string ts))
13032 default-input (and ts (org-get-compact-tod ts))))))
13033 (when what
13034 (setq time
13035 (if (stringp time)
13036 ;; This is a string (relative or absolute), set proper date
13037 (apply 'encode-time
13038 (org-read-date-analyze
13039 time default-time (decode-time default-time)))
13040 ;; If necessary, get the time from the user
13041 (or time (org-read-date nil 'to-time nil nil
13042 default-time default-input)))))
13044 (when (and org-insert-labeled-timestamps-at-point
13045 (member what '(scheduled deadline)))
13046 (insert
13047 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13048 (org-insert-time-stamp time org-time-was-given
13049 nil nil nil (list org-end-time-was-given))
13050 (setq what nil))
13051 (save-excursion
13052 (save-restriction
13053 (let (col list elt ts buffer-invisibility-spec)
13054 (org-back-to-heading t)
13056 (goto-char (match-end 1))
13057 (setq col (current-column))
13058 (goto-char (match-end 0))
13060 (when (and (not what)
13061 (not (looking-at
13063 org-keyword-time-not-clock-regexp))))
13064 ;; Nothing to add, nothing to remove...... :-)
13065 (throw 'exit nil))
13066 (if (and (not (looking-at org-outline-regexp))
13069 (not (equal (match-string 1) org-clock-string)))
13070 (narrow-to-region (match-beginning 0) (match-end 0))
13072 (backward-char 1)
13073 (narrow-to-region (point) (point))
13074 (and org-adapt-indentation (org-indent-to-column col)))
13075 ;; Check if we have to remove something.
13076 (setq list (cons what remove))
13077 (while list
13078 (setq elt (pop list))
13079 (when (or (and (eq elt 'scheduled)
13080 (re-search-forward org-scheduled-time-regexp nil t))
13081 (and (eq elt 'deadline)
13082 (re-search-forward org-deadline-time-regexp nil t))
13083 (and (eq elt 'closed)
13084 (re-search-forward org-closed-time-regexp nil t)))
13085 (replace-match "")
13086 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13088 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13089 (when what
13090 (insert
13091 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13092 (cond ((eq what 'scheduled) org-scheduled-string)
13093 ((eq what 'deadline) org-deadline-string)
13094 ((eq what 'closed) org-closed-string))
13095 " ")
13096 (setq ts (org-insert-time-stamp
13097 time
13098 (or org-time-was-given
13099 (and (eq what 'closed) org-log-done-with-time))
13100 (eq what 'closed)
13101 nil nil (list org-end-time-was-given)))
13102 (insert
13103 (if (not (or (bolp) (eq (char-before) ?\ )
13104 (memq (char-after) '(32 10))
13105 (eobp))) " " ""))
13106 (end-of-line 1))
13107 (goto-char (point-min))
13108 (widen)
13111 (delete-region (1- (point)) (point-at-eol)))
13112 ts))))))
13114 (defvar org-log-note-marker (make-marker))
13115 (defvar org-log-note-purpose nil)
13116 (defvar org-log-note-state nil)
13117 (defvar org-log-note-previous-state nil)
13118 (defvar org-log-note-how nil)
13119 (defvar org-log-note-extra nil)
13120 (defvar org-log-note-window-configuration nil)
13121 (defvar org-log-note-return-to (make-marker))
13122 (defvar org-log-note-effective-time nil
13123 "Remembered current time so that dynamically scoped
13124 `org-extend-today-until' affects tha timestamps in state change
13125 log")
13127 (defvar org-log-post-message nil
13128 "Message to be displayed after a log note has been stored.
13129 The auto-repeater uses this.")
13131 (defun org-add-note ()
13132 "Add a note to the current entry.
13133 This is done in the same way as adding a state change note."
13134 (interactive)
13135 (org-add-log-setup 'note nil nil 'findpos nil))
13137 (defvar org-property-end-re)
13138 (defun org-add-log-setup (&optional purpose state prev-state
13139 findpos how extra)
13140 "Set up the post command hook to take a note.
13141 If this is about to TODO state change, the new state is expected in STATE.
13142 When FINDPOS is non-nil, find the correct position for the note in
13143 the current entry. If not, assume that it can be inserted at point.
13144 HOW is an indicator what kind of note should be created.
13145 EXTRA is additional text that will be inserted into the notes buffer."
13146 (let* ((org-log-into-drawer (org-log-into-drawer))
13147 (drawer (cond ((stringp org-log-into-drawer)
13148 org-log-into-drawer)
13149 (org-log-into-drawer "LOGBOOK"))))
13150 (save-restriction
13151 (save-excursion
13152 (when findpos
13153 (org-back-to-heading t)
13154 (narrow-to-region (point) (save-excursion
13155 (outline-next-heading) (point)))
13159 (goto-char (match-end 0))
13160 (cond
13161 (drawer
13163 nil t)
13164 (progn
13165 (goto-char (match-end 0))
13166 (or org-log-states-order-reversed
13167 (and (re-search-forward org-property-end-re nil t)
13168 (goto-char (1- (match-beginning 0))))))
13170 (beginning-of-line 0)
13171 (org-indent-line)
13172 (beginning-of-line 2)
13173 (org-indent-line)
13174 (end-of-line 0)))
13175 ((and org-log-state-notes-insert-after-drawers
13176 (save-excursion
13177 (forward-line) (looking-at org-drawer-regexp)))
13178 (forward-line)
13179 (while (looking-at org-drawer-regexp)
13180 (goto-char (match-end 0))
13181 (re-search-forward org-property-end-re (point-max) t)
13182 (forward-line))
13183 (forward-line -1)))
13184 (unless org-log-states-order-reversed
13186 (org-skip-over-state-notes)
13188 (move-marker org-log-note-marker (point))
13189 (setq org-log-note-purpose purpose
13190 org-log-note-state state
13191 org-log-note-previous-state prev-state
13192 org-log-note-how how
13193 org-log-note-extra extra
13194 org-log-note-effective-time (org-current-effective-time))
13195 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13197 (defun org-skip-over-state-notes ()
13198 "Skip past the list of State notes in an entry."
13200 (when (ignore-errors (goto-char (org-in-item-p)))
13201 (let* ((struct (org-list-struct))
13202 (prevs (org-list-prevs-alist struct)))
13204 (goto-char (or (org-list-get-next-item (point) struct prevs)
13205 (org-list-get-item-end (point) struct)))))))
13207 (defun org-add-log-note (&optional purpose)
13208 "Pop up a window for taking a note, and add this note later at point."
13209 (remove-hook 'post-command-hook 'org-add-log-note)
13210 (setq org-log-note-window-configuration (current-window-configuration))
13211 (delete-other-windows)
13212 (move-marker org-log-note-return-to (point))
13213 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13214 (goto-char org-log-note-marker)
13215 (org-switch-to-buffer-other-window "*Org Note*")
13216 (erase-buffer)
13217 (if (memq org-log-note-how '(time state))
13218 (let (current-prefix-arg) (org-store-log-note))
13219 (let ((org-inhibit-startup t)) (org-mode))
13220 (insert (format "# Insert note for %s.
13222 (cond
13223 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13224 ((eq org-log-note-purpose 'done) "closed todo item")
13225 ((eq org-log-note-purpose 'state)
13227 (or org-log-note-previous-state "")
13228 (or org-log-note-state "")))
13229 ((eq org-log-note-purpose 'reschedule)
13230 "rescheduling")
13231 ((eq org-log-note-purpose 'delschedule)
13232 "no longer scheduled")
13233 ((eq org-log-note-purpose 'redeadline)
13234 "changing deadline")
13235 ((eq org-log-note-purpose 'deldeadline)
13236 "removing deadline")
13237 ((eq org-log-note-purpose 'refile)
13238 "refiling")
13239 ((eq org-log-note-purpose 'note)
13240 "this entry")
13241 (t (error "This should not happen")))))
13242 (if org-log-note-extra (insert org-log-note-extra))
13243 (org-set-local 'org-finish-function 'org-store-log-note)
13244 (run-hooks 'org-log-buffer-setup-hook)))
13246 (defvar org-note-abort nil) ; dynamically scoped
13247 (defun org-store-log-note ()
13248 "Finish taking a log note, and insert it to where it belongs."
13249 (let ((txt (buffer-string)))
13250 (kill-buffer (current-buffer))
13251 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13252 lines ind bul)
13254 (setq txt (replace-match "" t t txt)))
13256 (setq txt (replace-match "" t t txt)))
13259 (setq note
13260 (org-replace-escapes
13261 note
13262 (list (cons "%u" (user-login-name))
13263 (cons "%U" user-full-name)
13264 (cons "%t" (format-time-string
13265 (org-time-stamp-format 'long 'inactive)
13266 org-log-note-effective-time))
13267 (cons "%T" (format-time-string
13268 (org-time-stamp-format 'long nil)
13269 org-log-note-effective-time))
13270 (cons "%d" (format-time-string
13271 (org-time-stamp-format nil 'inactive)
13272 org-log-note-effective-time))
13273 (cons "%D" (format-time-string
13274 (org-time-stamp-format nil nil)
13275 org-log-note-effective-time))
13276 (cons "%s" (if org-log-note-state
13278 ""))
13279 (cons "%S" (if org-log-note-previous-state
13283 (push note lines))
13284 (when (or current-prefix-arg org-note-abort)
13285 (when org-log-into-drawer
13286 (org-remove-empty-drawer-at
13287 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13288 org-log-note-marker))
13289 (setq lines nil))
13290 (when lines
13291 (with-current-buffer (marker-buffer org-log-note-marker)
13292 (save-excursion
13293 (goto-char org-log-note-marker)
13294 (move-marker org-log-note-marker nil)
13295 (end-of-line 1)
13297 (setq ind (save-excursion
13298 (if (ignore-errors (goto-char (org-in-item-p)))
13299 (let ((struct (org-list-struct)))
13300 (org-list-get-ind
13301 (org-list-get-top-point struct) struct))
13303 (cond
13304 ((and (org-at-heading-p)
13305 org-adapt-indentation)
13306 (1+ (org-current-level)))
13307 ((org-at-heading-p) 0)
13308 (t (org-get-indentation))))))
13309 (setq bul (org-list-bullet-string "-"))
13310 (org-indent-line-to ind)
13311 (insert bul (pop lines))
13312 (let ((ind-body (+ (length bul) ind)))
13313 (while lines
13315 (org-indent-line-to ind-body)
13316 (insert (pop lines))))
13317 (message "Note stored")
13318 (org-back-to-heading t)
13319 (org-cycle-hide-drawers 'children))
13320 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13321 ;; from within `org-add-log-note' because `buffer-undo-list'
13322 ;; is then modified outside of `org-with-remote-undo'.
13323 (when (eq this-command 'org-agenda-todo)
13324 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13325 ;; Don't add undo information when called from `org-agenda-todo'
13326 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13327 (set-window-configuration org-log-note-window-configuration)
13328 (with-current-buffer (marker-buffer org-log-note-return-to)
13329 (goto-char org-log-note-return-to))
13330 (move-marker org-log-note-return-to nil)
13331 (and org-log-post-message (message "%s" org-log-post-message))))
13333 (defun org-remove-empty-drawer-at (drawer pos)
13334 "Remove an empty drawer DRAWER at position POS.
13335 POS may also be a marker."
13336 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13337 (save-excursion
13338 (save-restriction
13339 (widen)
13340 (goto-char pos)
13341 (if (org-in-regexp
13343 (replace-match ""))))))
13345 (defvar org-ts-type nil)
13346 (defun org-sparse-tree (&optional arg type)
13347 "Create a sparse tree, prompt for the details.
13348 This command can create sparse trees. You first need to select the type
13349 of match used to create the tree:
13351 t Show all TODO entries.
13352 T Show entries with a specific TODO keyword.
13353 m Show entries selected by a tags/property match.
13354 p Enter a property name and its value (both with completion on existing
13355 names/values) and show entries with that property.
13356 r Show entries matching a regular expression (`/' can be used as well).
13357 b Show deadlines and scheduled items before a date.
13358 a Show deadlines and scheduled items after a date.
13359 d Show deadlines due within `org-deadline-warning-days'.
13360 D Show deadlines and scheduled items between a date range."
13361 (interactive "P")
13362 (let (ans kwd value ts-type)
13363 (setq type (or type org-sparse-tree-default-date-type))
13364 (setq org-ts-type type)
13365 (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"
13366 (cond ((eq type 'all) "all timestamps")
13367 ((eq type 'scheduled) "only scheduled")
13368 ((eq type 'deadline) "only deadline")
13369 ((eq type 'active) "only active timestamps")
13370 ((eq type 'inactive) "only inactive timestamps")
13371 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13372 ((eq type 'closed) "with a closed time-stamp")
13373 (t "scheduled/deadline")))
13374 (setq ans (read-char-exclusive))
13375 (cond
13376 ((equal ans ?c)
13377 (org-sparse-tree
13378 arg (cadr (member type '(scheduled-or-deadline
13379 all scheduled deadline active inactive closed)))))
13380 ((equal ans ?d)
13381 (call-interactively 'org-check-deadlines))
13382 ((equal ans ?b)
13383 (call-interactively 'org-check-before-date))
13384 ((equal ans ?a)
13385 (call-interactively 'org-check-after-date))
13386 ((equal ans ?D)
13387 (call-interactively 'org-check-dates-range))
13388 ((equal ans ?t)
13389 (call-interactively 'org-show-todo-tree))
13390 ((equal ans ?T)
13391 (org-show-todo-tree '(4)))
13392 ((member ans '(?T ?m))
13393 (call-interactively 'org-match-sparse-tree))
13394 ((member ans '(?p ?P))
13395 (setq kwd (org-icompleting-read "Property: "
13396 (mapcar 'list (org-buffer-property-keys))))
13397 (setq value (org-icompleting-read "Value: "
13398 (mapcar 'list (org-property-values kwd))))
13401 (org-match-sparse-tree arg (concat kwd "=" value)))
13402 ((member ans '(?r ?R ?/))
13403 (call-interactively 'org-occur))
13406 (defvar org-occur-highlights nil
13407 "List of overlays used for occur matches.")
13408 (make-variable-buffer-local 'org-occur-highlights)
13409 (defvar org-occur-parameters nil
13410 "Parameters of the active org-occur calls.
13411 This is a list, each call to org-occur pushes as cons cell,
13412 containing the regular expression and the callback, onto the list.
13413 The list can contain several entries if `org-occur' has been called
13414 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13415 will only contain one set of parameters. When the highlights are
13416 removed (for example with `C-c C-c', or with the next edit (depending
13417 on `org-remove-highlights-with-change'), this variable is emptied
13418 as well.")
13419 (make-variable-buffer-local 'org-occur-parameters)
13421 (defun org-occur (regexp &optional keep-previous callback)
13422 "Make a compact tree which shows all matches of REGEXP.
13423 The tree will show the lines where the regexp matches, and all higher
13424 headlines above the match. It will also show the heading after the match,
13425 to make sure editing the matching entry is easy.
13426 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13427 call to `org-occur' will be kept, to allow stacking of calls to this
13428 command.
13429 If CALLBACK is non-nil, it is a function which is called to confirm
13430 that the match should indeed be shown."
13432 (when (equal regexp "")
13433 (error "Regexp cannot be empty"))
13434 (unless keep-previous
13435 (org-remove-occur-highlights nil nil t))
13436 (push (cons regexp callback) org-occur-parameters)
13437 (let ((cnt 0))
13438 (save-excursion
13439 (goto-char (point-min))
13440 (if (or (not keep-previous) ; do not want to keep
13441 (not org-occur-highlights)) ; no previous matches
13442 ;; hide everything
13443 (org-overview))
13444 (while (re-search-forward regexp nil t)
13445 (when (or (not callback)
13446 (save-match-data (funcall callback)))
13447 (setq cnt (1+ cnt))
13448 (when org-highlight-sparse-tree-matches
13449 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13450 (org-show-context 'occur-tree))))
13451 (when org-remove-highlights-with-change
13452 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13453 nil 'local))
13454 (unless org-sparse-tree-open-archived-trees
13455 (org-hide-archived-subtrees (point-min) (point-max)))
13456 (run-hooks 'org-occur-hook)
13457 (if (org-called-interactively-p 'interactive)
13458 (message "%d match(es) for regexp %s" cnt regexp))
13459 cnt))
13461 (defun org-occur-next-match (&optional n reset)
13462 "Function for `next-error-function' to find sparse tree matches.
13463 N is the number of matches to move, when negative move backwards.
13464 RESET is entirely ignored - this function always goes back to the
13465 starting point when no match is found."
13466 (let* ((limit (if (< n 0) (point-min) (point-max)))
13467 (search-func (if (< n 0)
13468 'previous-single-char-property-change
13469 'next-single-char-property-change))
13470 (n (abs n))
13471 (pos (point))
13472 p1)
13473 (catch 'exit
13474 (while (setq p1 (funcall search-func (point) 'org-type))
13475 (when (equal p1 limit)
13476 (goto-char pos)
13477 (error "No more matches"))
13478 (when (equal (get-char-property p1 'org-type) 'org-occur)
13479 (setq n (1- n))
13480 (when (= n 0)
13481 (goto-char p1)
13482 (throw 'exit (point))))
13483 (goto-char p1))
13484 (goto-char p1)
13485 (error "No more matches"))))
13487 (defun org-show-context (&optional key)
13488 "Make sure point and context are visible.
13489 How much context is shown depends upon the variables
13490 `org-show-hierarchy-above', `org-show-following-heading',
13491 `org-show-entry-below' and `org-show-siblings'."
13492 (let ((heading-p (org-at-heading-p t))
13493 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13494 (following-p (org-get-alist-option org-show-following-heading key))
13495 (entry-p (org-get-alist-option org-show-entry-below key))
13496 (siblings-p (org-get-alist-option org-show-siblings key)))
13497 ;; Show heading or entry text
13498 (if (and heading-p (not entry-p))
13499 (org-flag-heading nil) ; only show the heading
13500 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13501 (org-show-hidden-entry))) ; show entire entry
13502 (when following-p
13503 ;; Show next sibling, or heading below text
13504 (save-excursion
13505 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13506 (org-flag-heading nil))))
13507 (when siblings-p (org-show-siblings))
13508 (when hierarchy-p
13509 ;; show all higher headings, possibly with siblings
13510 (save-excursion
13511 (while (and (condition-case nil
13512 (progn (org-up-heading-all 1) t)
13513 (error nil))
13514 (not (bobp)))
13515 (org-flag-heading nil)
13516 (when siblings-p (org-show-siblings)))))
13517 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13519 (defvar org-reveal-start-hook nil
13520 "Hook run before revealing a location.")
13522 (defun org-reveal (&optional siblings)
13523 "Show current entry, hierarchy above it, and the following headline.
13524 This can be used to show a consistent set of context around locations
13525 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13526 not t for the search context.
13528 With optional argument SIBLINGS, on each level of the hierarchy all
13529 siblings are shown. This repairs the tree structure to what it would
13530 look like when opened with hierarchical calls to `org-cycle'.
13532 go to the parent and show the
13533 entire tree."
13534 (interactive "P")
13535 (run-hooks 'org-reveal-start-hook)
13536 (let ((org-show-hierarchy-above t)
13537 (org-show-following-heading t)
13538 (org-show-siblings (if siblings t org-show-siblings)))
13539 (org-show-context nil))
13540 (when (equal siblings '(16))
13541 (save-excursion
13542 (when (org-up-heading-safe)
13543 (org-show-subtree)
13544 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13546 (defun org-highlight-new-match (beg end)
13547 "Highlight from BEG to END and mark the highlight is an occur headline."
13548 (let ((ov (make-overlay beg end)))
13549 (overlay-put ov 'face 'secondary-selection)
13550 (overlay-put ov 'org-type 'org-occur)
13551 (push ov org-occur-highlights)))
13553 (defun org-remove-occur-highlights (&optional beg end noremove)
13554 "Remove the occur highlights from the buffer.
13555 BEG and END are ignored. If NOREMOVE is nil, remove this function
13556 from the `before-change-functions' in the current buffer."
13557 (interactive)
13558 (unless org-inhibit-highlight-removal
13559 (mapc 'delete-overlay org-occur-highlights)
13560 (setq org-occur-highlights nil)
13561 (setq org-occur-parameters nil)
13562 (unless noremove
13563 (remove-hook 'before-change-functions
13564 'org-remove-occur-highlights 'local))))
13566 ;;;; Priorities
13569 "Regular expression matching the priority indicator.")
13571 (defvar org-remove-priority-next-time nil)
13573 (defun org-priority-up ()
13574 "Increase the priority of the current item."
13575 (interactive)
13576 (org-priority 'up))
13578 (defun org-priority-down ()
13579 "Decrease the priority of the current item."
13580 (interactive)
13581 (org-priority 'down))
13583 (defun org-priority (&optional action show)
13584 "Change the priority of an item.
13585 ACTION can be `set', `up', `down', or a character."
13586 (interactive "P")
13587 (if (equal action '(4))
13588 (org-show-priority)
13589 (unless org-enable-priority-commands
13590 (error "Priority commands are disabled"))
13591 (setq action (or action 'set))
13592 (let (current new news have remove)
13593 (save-excursion
13594 (org-back-to-heading t)
13595 (if (looking-at org-priority-regexp)
13596 (setq current (string-to-char (match-string 2))
13597 have t))
13598 (cond
13599 ((eq action 'remove)
13600 (setq remove t new ?\ ))
13601 ((or (eq action 'set)
13602 (if (featurep 'xemacs) (characterp action) (integerp action)))
13603 (if (not (eq action 'set))
13604 (setq new action)
13605 (message "Priority %c-%c, SPC to remove: "
13606 org-highest-priority org-lowest-priority)
13607 (save-match-data
13608 (setq new (read-char-exclusive))))
13609 (if (and (= (upcase org-highest-priority) org-highest-priority)
13610 (= (upcase org-lowest-priority) org-lowest-priority))
13611 (setq new (upcase new)))
13612 (cond ((equal new ?\ ) (setq remove t))
13613 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13614 (error "Priority must be between `%c' and `%c'"
13615 org-highest-priority org-lowest-priority))))
13616 ((eq action 'up)
13617 (setq new (if have
13618 (1- current) ; normal cycling
13619 ;; last priority was empty
13620 (if (eq last-command this-command)
13621 org-lowest-priority ; wrap around empty to lowest
13622 ;; default
13623 (if org-priority-start-cycle-with-default
13624 org-default-priority
13625 (1- org-default-priority))))))
13626 ((eq action 'down)
13627 (setq new (if have
13628 (1+ current) ; normal cycling
13629 ;; last priority was empty
13630 (if (eq last-command this-command)
13631 org-highest-priority ; wrap around empty to highest
13632 ;; default
13633 (if org-priority-start-cycle-with-default
13634 org-default-priority
13635 (1+ org-default-priority))))))
13636 (t (error "Invalid action")))
13637 (if (or (< (upcase new) org-highest-priority)
13638 (> (upcase new) org-lowest-priority))
13639 (if (and (memq action '(up down))
13640 (not have) (not (eq last-command this-command)))
13641 ;; `new' is from default priority
13642 (error
13643 "The default can not be set, see `org-default-priority' why")
13644 ;; normal cycling: `new' is beyond highest/lowest priority
13645 ;; and is wrapped around to the empty priority
13646 (setq remove t)))
13647 (setq news (format "%c" new))
13648 (if have
13649 (if remove
13650 (replace-match "" t t nil 1)
13651 (replace-match news t t nil 2))
13652 (if remove
13653 (error "No priority cookie found in line")
13654 (let ((case-fold-search nil))
13655 (looking-at org-todo-line-regexp))
13656 (if (match-end 2)
13657 (progn
13658 (goto-char (match-end 2))
13659 (insert " [#" news "]"))
13660 (goto-char (match-beginning 3))
13661 (insert "[#" news "] "))))
13662 (org-preserve-lc (org-set-tags nil 'align)))
13663 (if remove
13664 (message "Priority removed")
13665 (message "Priority of current item set to %s" news)))))
13667 (defun org-show-priority ()
13668 "Show the priority of the current item.
13669 This priority is composed of the main priority given with the [#A] cookies,
13670 and by additional input from the age of a schedules or deadline entry."
13671 (interactive)
13672 (let ((pri (if (eq major-mode 'org-agenda-mode)
13673 (org-get-at-bol 'priority)
13674 (save-excursion
13675 (save-match-data
13676 (beginning-of-line)
13677 (and (looking-at org-heading-regexp)
13678 (org-get-priority (match-string 0))))))))
13679 (message "Priority is %d" (if pri pri -1000))))
13681 (defun org-get-priority (s)
13682 "Find priority cookie and return priority."
13683 (save-match-data
13684 (if (functionp org-get-priority-function)
13685 (funcall org-get-priority-function)
13686 (if (not (string-match org-priority-regexp s))
13687 (* 1000 (- org-lowest-priority org-default-priority))
13688 (* 1000 (- org-lowest-priority
13689 (string-to-char (match-string 2 s))))))))
13691 ;;;; Tags
13693 (defvar org-agenda-archives-mode)
13694 (defvar org-map-continue-from nil
13695 "Position from where mapping should continue.
13696 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13698 (defvar org-scanner-tags nil
13699 "The current tag list while the tags scanner is running.")
13700 (defvar org-trust-scanner-tags nil
13701 "Should `org-get-tags-at' use the tags for the scanner.
13702 This is for internal dynamical scoping only.
13703 When this is non-nil, the function `org-get-tags-at' will return the value
13704 of `org-scanner-tags' instead of building the list by itself. This
13705 can lead to large speed-ups when the tags scanner is used in a file with
13706 many entries, and when the list of tags is retrieved, for example to
13707 obtain a list of properties. Building the tags list for each entry in such
13708 a file becomes an N^2 operation - but with this variable set, it scales
13709 as N.")
13711 (defun org-scan-tags (action matcher todo-only &optional start-level)
13712 "Sca headline tags with inheritance and produce output ACTION.
13714 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13715 or `agenda' to produce an entry list for an agenda view. It can also be
13716 a Lisp form or a function that should be called at each matched headline, in
13717 this case the return value is a list of all return values from these calls.
13719 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13720 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13721 only lines with a not-done TODO keyword are included in the output.
13722 This should be the same variable that was scoped into
13723 and set by `org-make-tags-matcher' when it constructed MATCHER.
13725 START-LEVEL can be a string with asterisks, reducing the scope to
13726 headlines matching this string."
13727 (require 'org-agenda)
13728 (let* ((re (concat "^"
13729 (if start-level
13730 ;; Get the correct level to match
13732 org-outline-regexp)
13736 (props (list 'face 'default
13737 'done-face 'org-agenda-done
13738 'undone-face 'default
13739 'mouse-face 'highlight
13740 'org-not-done-regexp org-not-done-regexp
13741 'org-todo-regexp org-todo-regexp
13742 'org-complex-heading-regexp org-complex-heading-regexp
13743 'help-echo
13744 (format "mouse-2 or RET jump to org file %s"
13745 (abbreviate-file-name
13746 (or (buffer-file-name (buffer-base-buffer))
13747 (buffer-name (buffer-base-buffer)))))))
13748 (case-fold-search nil)
13749 (org-map-continue-from nil)
13750 lspos tags tags-list
13751 (tags-alist (list (cons 0 org-file-tags)))
13752 (llast 0) rtn rtn1 level category i txt
13753 todo marker entry priority)
13754 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13755 (setq action (list 'lambda nil action)))
13756 (save-excursion
13757 (goto-char (point-min))
13758 (when (eq action 'sparse-tree)
13759 (org-overview)
13760 (org-remove-occur-highlights))
13761 (while (re-search-forward re nil t)
13762 (setq org-map-continue-from nil)
13763 (catch :skip
13764 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13765 tags (if (match-end 4) (org-match-string-no-properties 4)))
13766 (goto-char (setq lspos (match-beginning 0)))
13767 (setq level (org-reduced-level (org-outline-level))
13768 category (org-get-category))
13769 (setq i llast llast level)
13770 ;; remove tag lists from same and sublevels
13771 (while (>= i level)
13772 (when (setq entry (assoc i tags-alist))
13773 (setq tags-alist (delete entry tags-alist)))
13774 (setq i (1- i)))
13775 ;; add the next tags
13776 (when tags
13777 (setq tags (org-split-string tags ":")
13778 tags-alist
13779 (cons (cons level tags) tags-alist)))
13780 ;; compile tags for current headline
13781 (setq tags-list
13782 (if org-use-tag-inheritance
13783 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13784 tags)
13785 org-scanner-tags tags-list)
13786 (when org-use-tag-inheritance
13787 (setcdr (car tags-alist)
13788 (mapcar (lambda (x)
13789 (setq x (copy-sequence x))
13790 (org-add-prop-inherited x))
13791 (cdar tags-alist))))
13792 (when (and tags org-use-tag-inheritance
13793 (or (not (eq t org-use-tag-inheritance))
13794 org-tags-exclude-from-inheritance))
13795 ;; selective inheritance, remove uninherited ones
13796 (setcdr (car tags-alist)
13797 (org-remove-uninherited-tags (cdar tags-alist))))
13798 (when (and
13800 ;; eval matcher only when the todo condition is OK
13801 (and (or (not todo-only) (member todo org-not-done-keywords))
13802 (let ((case-fold-search t) (org-trust-scanner-tags t))
13803 (eval matcher)))
13805 ;; Call the skipper, but return t if it does not skip,
13806 ;; so that the `and' form continues evaluating
13807 (progn
13808 (unless (eq action 'sparse-tree) (org-agenda-skip))
13809 t)
13811 ;; Check if timestamps are deselecting this entry
13812 (or (not todo-only)
13813 (and (member todo org-not-done-keywords)
13814 (or (not org-agenda-tags-todo-honor-ignore-options)
13815 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13817 ;; select this headline
13818 (cond
13819 ((eq action 'sparse-tree)
13820 (and org-highlight-sparse-tree-matches
13821 (org-get-heading) (match-end 0)
13822 (org-highlight-new-match
13823 (match-beginning 1) (match-end 1)))
13824 (org-show-context 'tags-tree))
13825 ((eq action 'agenda)
13826 (setq txt (org-agenda-format-item
13827 ""
13828 (concat
13829 (if (eq org-tags-match-list-sublevels 'indented)
13830 (make-string (1- level) ?.) "")
13831 (org-get-heading))
13832 level category
13833 tags-list)
13834 priority (org-get-priority txt))
13835 (goto-char lspos)
13836 (setq marker (org-agenda-new-marker))
13837 (org-add-props txt props
13838 'org-marker marker 'org-hd-marker marker 'org-category category
13839 'todo-state todo
13840 'priority priority 'type "tagsmatch")
13841 (push txt rtn))
13842 ((functionp action)
13843 (setq org-map-continue-from nil)
13844 (save-excursion
13845 (setq rtn1 (funcall action))
13846 (push rtn1 rtn)))
13847 (t (error "Invalid action")))
13849 ;; if we are to skip sublevels, jump to end of subtree
13850 (unless org-tags-match-list-sublevels
13851 (org-end-of-subtree t)
13852 (backward-char 1))))
13853 ;; Get the correct position from where to continue
13854 (if org-map-continue-from
13855 (goto-char org-map-continue-from)
13856 (and (= (point) lspos) (end-of-line 1)))))
13857 (when (and (eq action 'sparse-tree)
13858 (not org-sparse-tree-open-archived-trees))
13859 (org-hide-archived-subtrees (point-min) (point-max)))
13860 (nreverse rtn)))
13862 (defun org-remove-uninherited-tags (tags)
13863 "Remove all tags that are not inherited from the list TAGS."
13864 (cond
13865 ((eq org-use-tag-inheritance t)
13866 (if org-tags-exclude-from-inheritance
13867 (org-delete-all org-tags-exclude-from-inheritance tags)
13868 tags))
13869 ((not org-use-tag-inheritance) nil)
13870 ((stringp org-use-tag-inheritance)
13871 (delq nil (mapcar
13872 (lambda (x)
13873 (if (and (string-match org-use-tag-inheritance x)
13874 (not (member x org-tags-exclude-from-inheritance)))
13875 x nil))
13876 tags)))
13877 ((listp org-use-tag-inheritance)
13878 (delq nil (mapcar
13879 (lambda (x)
13880 (if (member x org-use-tag-inheritance) x nil))
13881 tags)))))
13883 (defun org-match-sparse-tree (&optional todo-only match)
13884 "Create a sparse tree according to tags string MATCH.
13885 MATCH can contain positive and negative selection of tags, like
13887 If optional argument TODO-ONLY is non-nil, only select lines that are
13888 also TODO lines."
13889 (interactive "P")
13890 (org-agenda-prepare-buffers (list (current-buffer)))
13891 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13893 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13895 (defvar org-cached-props nil)
13896 (defun org-cached-entry-get (pom property)
13897 (if (or (eq t org-use-property-inheritance)
13898 (and (stringp org-use-property-inheritance)
13899 (string-match org-use-property-inheritance property))
13900 (and (listp org-use-property-inheritance)
13901 (member property org-use-property-inheritance)))
13902 ;; Caching is not possible, check it directly
13903 (org-entry-get pom property 'inherit)
13904 ;; Get all properties, so that we can do complicated checks easily
13905 (cdr (assoc property (or org-cached-props
13906 (setq org-cached-props
13907 (org-entry-properties pom)))))))
13909 (defun org-global-tags-completion-table (&optional files)
13910 "Return the list of all tags in all agenda buffer/files.
13911 Optional FILES argument is a list of files which can be used
13912 instead of the agenda files."
13913 (save-excursion
13914 (org-uniquify
13915 (delq nil
13916 (apply 'append
13917 (mapcar
13918 (lambda (file)
13919 (set-buffer (find-file-noselect file))
13920 (append (org-get-buffer-tags)
13921 (mapcar (lambda (x) (if (stringp (car-safe x))
13922 (list (car-safe x)) nil))
13923 org-tag-alist)))
13924 (if (and files (car files))
13925 files
13926 (org-agenda-files))))))))
13928 (defun org-make-tags-matcher (match)
13929 "Create the TAGS/TODO matcher form for the selection string MATCH.
13931 The variable `todo-only' is scoped dynamically into this function.
13932 It will be set to t if the matcher restricts matching to TODO entries,
13933 otherwise will not be touched.
13935 Returns a cons of the selection string MATCH and the constructed
13936 lisp form implementing the matcher. The matcher is to be evaluated
13937 at an Org entry, with point on the headline, and returns t if the
13938 entry matches the selection string MATCH. The returned lisp form
13939 references two variables with information about the entry, which
13940 must be bound around the form's evaluation: todo, the TODO keyword
13941 at the entry (or nil of none); and tags-list, the list of all tags
13942 at the entry including inherited ones. Additionally, the category
13943 of the entry (if any) must be specified as the text property
13944 'org-category on the headline.
13946 See also `org-scan-tags'.
13947 "
13948 (declare (special todo-only))
13949 (unless (boundp 'todo-only)
13950 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
13951 (unless match
13952 ;; Get a new match request, with completion against the global
13953 ;; tags table and the local tags in current buffer
13954 (let ((org-last-tags-completion-table
13955 (org-uniquify
13956 (delq nil (append (org-get-buffer-tags)
13957 (org-global-tags-completion-table))))))
13958 (setq match (org-completing-read-no-i
13959 "Match: " 'org-tags-completion-function nil nil nil
13960 'org-tags-history))))
13962 ;; Parse the string and create a lisp form
13963 (let ((match0 match)
13964 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13965 minus tag mm
13966 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13967 orterms term orlist re-p str-p level-p level-op time-p
13968 prop-p pn pv po gv rest)
13969 ;; Expand group tags
13970 (setq match (org-tags-expand match))
13971 (if (string-match "/+" match)
13972 ;; match contains also a todo-matching request
13973 (progn
13974 (setq tagsmatch (substring match 0 (match-beginning 0))
13975 todomatch (substring match (match-end 0)))
13976 (if (string-match "^!" todomatch)
13977 (setq todo-only t todomatch (substring todomatch 1)))
13979 (setq todomatch nil)))
13980 ;; only matching tags
13981 (setq tagsmatch match todomatch nil))
13983 ;; Make the tags matcher
13985 (setq tagsmatcher t)
13986 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13987 (while (setq term (pop orterms))
13989 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13990 (while (string-match re term)
13991 (setq rest (substring term (match-end 0))
13992 minus (and (match-end 1)
13993 (equal (match-string 1 term) "-"))
13994 tag (save-match-data (replace-regexp-in-string
13996 (match-string 2 term)))
13997 re-p (equal (string-to-char tag) ?{)
13998 level-p (match-end 4)
13999 prop-p (match-end 5)
14000 mm (cond
14001 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14002 (level-p
14003 (setq level-op (org-op-to-function (match-string 3 term)))
14004 `(,level-op level ,(string-to-number
14005 (match-string 4 term))))
14006 (prop-p
14007 (setq pn (match-string 5 term)
14008 po (match-string 6 term)
14009 pv (match-string 7 term)
14010 re-p (equal (string-to-char pv) ?{)
14012 time-p (save-match-data
14014 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14015 (if time-p (setq pv (org-matcher-time pv)))
14016 (setq po (org-op-to-function po (if time-p 'time str-p)))
14017 (cond
14018 ((equal pn "CATEGORY")
14019 (setq gv '(get-text-property (point) 'org-category)))
14020 ((equal pn "TODO")
14021 (setq gv 'todo))
14022 (t
14023 (setq gv `(org-cached-entry-get nil ,pn))))
14024 (if re-p
14025 (if (eq po 'org<>)
14026 `(not (string-match ,pv (or ,gv "")))
14027 `(string-match ,pv (or ,gv "")))
14028 (if str-p
14029 `(,po (or ,gv "") ,pv)
14030 `(,po (string-to-number (or ,gv ""))
14031 ,(string-to-number pv) ))))
14032 (t `(member ,tag tags-list)))
14033 mm (if minus (list 'not mm) mm)
14034 term rest)
14035 (push mm tagsmatcher))
14036 (push (if (> (length tagsmatcher) 1)
14037 (cons 'and tagsmatcher)
14038 (car tagsmatcher))
14039 orlist)
14040 (setq tagsmatcher nil))
14041 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14042 (setq tagsmatcher
14043 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14044 ;; Make the todo matcher
14046 (setq todomatcher t)
14047 (setq orterms (org-split-string todomatch "|") orlist nil)
14048 (while (setq term (pop orterms))
14049 (while (string-match re term)
14050 (setq minus (and (match-end 1)
14051 (equal (match-string 1 term) "-"))
14052 kwd (match-string 2 term)
14053 re-p (equal (string-to-char kwd) ?{)
14054 term (substring term (match-end 0))
14055 mm (if re-p
14056 `(string-match ,(substring kwd 1 -1) todo)
14057 (list 'equal 'todo kwd))
14058 mm (if minus (list 'not mm) mm))
14059 (push mm todomatcher))
14060 (push (if (> (length todomatcher) 1)
14061 (cons 'and todomatcher)
14062 (car todomatcher))
14063 orlist)
14064 (setq todomatcher nil))
14065 (setq todomatcher (if (> (length orlist) 1)
14066 (cons 'or orlist) (car orlist))))
14068 ;; Return the string and lisp forms of the matcher
14069 (setq matcher (if todomatcher
14070 (list 'and tagsmatcher todomatcher)
14071 tagsmatcher))
14072 (when todo-only
14073 (setq matcher (list 'and '(member todo org-not-done-keywords)
14074 matcher)))
14075 (cons match0 matcher)))
14077 (defun org-tags-expand (match &optional single-as-list downcased)
14078 "Expand group tags in MATCH.
14080 This replaces every group tag in MATCH with a regexp tag search.
14082 will be replaced like this:
14088 Replacing by a regexp preserves the structure of the match.
14089 E.g., this expansion
14096 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14097 assumed to be a single group tag, and the function will return
14098 the list of tags in this group.
14100 When DOWNCASE is non-nil, expand downcased TAGS."
14101 (if org-group-tags
14102 (let* ((case-fold-search t)
14103 (stable org-mode-syntax-table)
14104 (tal (or org-tag-groups-alist-for-agenda
14105 org-tag-groups-alist))
14106 (tal (if downcased
14107 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14108 (tml (mapcar 'car tal))
14109 (rtnmatch match) rpl)
14110 ;; @ and _ are allowed as word-components in tags
14111 (modify-syntax-entry ?@ "w" stable)
14112 (modify-syntax-entry ?_ "w" stable)
14113 (while (and tml
14114 (string-match
14117 (let* ((dir (match-string 1 rtnmatch))
14118 (tag (match-string 2 rtnmatch))
14119 (tag (if downcased (downcase tag) tag)))
14120 (setq tml (delete tag tml))
14121 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14122 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14124 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14125 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14126 (if single-as-list
14127 (or (reverse rpl) (list rtnmatch))
14128 rtnmatch))
14129 (if single-as-list (list (if downcased (downcase match) match))
14130 match)))
14132 (defun org-op-to-function (op &optional stringp)
14133 "Turn an operator into the appropriate function."
14134 (setq op
14135 (cond
14136 ((equal op "<" ) '(< string< org-time<))
14137 ((equal op ">" ) '(> org-string> org-time>))
14138 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14139 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14140 ((member op '("=" "==")) '(= string= org-time=))
14141 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14142 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14144 (defun org<> (a b) (not (= a b)))
14145 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14146 (defun org-string>= (a b) (not (string< a b)))
14147 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14148 (defun org-string<> (a b) (not (string= a b)))
14149 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14150 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14151 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= 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) (org<> a b)))
14155 (defun org-2ft (s)
14156 "Convert S to a floating point time.
14157 If S is already a number, just return it. If it is a string, parse
14158 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14159 (cond
14160 ((numberp s) s)
14161 ((stringp s)
14162 (condition-case nil
14163 (float-time (apply 'encode-time (org-parse-time-string s)))
14164 (error 0.)))
14165 (t 0.)))
14167 (defun org-time-today ()
14168 "Time in seconds today at 0:00.
14169 Returns the float number of seconds since the beginning of the
14170 epoch to the beginning of today (00:00)."
14171 (float-time (apply 'encode-time
14172 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14174 (defun org-matcher-time (s)
14175 "Interpret a time comparison value."
14176 (save-match-data
14177 (cond
14178 ((string= s "<now>") (float-time))
14179 ((string= s "<today>") (org-time-today))
14180 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14181 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14183 (+ (org-time-today)
14184 (* (string-to-number (match-string 1 s))
14185 (cdr (assoc (match-string 2 s)
14186 '(("d" . 86400.0) ("w" . 604800.0)
14187 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14188 (t (org-2ft s)))))
14190 (defun org-match-any-p (re list)
14191 "Does re match any element of list?"
14192 (setq list (mapcar (lambda (x) (string-match re x)) list))
14193 (delq nil list))
14195 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14196 (defvar org-tags-overlay (make-overlay 1 1))
14197 (org-detach-overlay org-tags-overlay)
14199 (defun org-get-local-tags-at (&optional pos)
14200 "Get a list of tags defined in the current headline."
14201 (org-get-tags-at pos 'local))
14203 (defun org-get-local-tags ()
14204 "Get a list of tags defined in the current headline."
14205 (org-get-tags-at nil 'local))
14207 (defun org-get-tags-at (&optional pos local)
14208 "Get a list of all headline tags applicable at POS.
14209 POS defaults to point. If tags are inherited, the list contains
14210 the targets in the same sequence as the headlines appear, i.e.
14211 the tags of the current headline come last.
14212 When LOCAL is non-nil, only return tags from the current headline,
14213 ignore inherited ones."
14214 (interactive)
14215 (if (and org-trust-scanner-tags
14216 (or (not pos) (equal pos (point)))
14217 (not local))
14218 org-scanner-tags
14219 (let (tags ltags lastpos parent)
14220 (save-excursion
14221 (save-restriction
14222 (widen)
14223 (goto-char (or pos (point)))
14224 (save-match-data
14225 (catch 'done
14226 (condition-case nil
14227 (progn
14228 (org-back-to-heading t)
14229 (while (not (equal lastpos (point)))
14230 (setq lastpos (point))
14231 (when (looking-at
14233 (setq ltags (org-split-string
14234 (org-match-string-no-properties 1) ":"))
14235 (when parent
14236 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14237 (setq tags (append
14238 (if parent
14239 (org-remove-uninherited-tags ltags)
14240 ltags)
14241 tags)))
14242 (or org-use-tag-inheritance (throw 'done t))
14243 (if local (throw 'done t))
14244 (or (org-up-heading-safe) (error nil))
14245 (setq parent t)))
14246 (error nil)))))
14247 (if local
14248 tags
14249 (reverse (delete-dups
14250 (reverse (append
14251 (org-remove-uninherited-tags
14252 org-file-tags) tags)))))))))
14254 (defun org-add-prop-inherited (s)
14255 (add-text-properties 0 (length s) '(inherited t) s)
14256 s)
14258 (defun org-toggle-tag (tag &optional onoff)
14259 "Toggle the tag TAG for the current line.
14260 If ONOFF is `on' or `off', don't toggle but set to this state."
14261 (let (res current)
14262 (save-excursion
14263 (org-back-to-heading t)
14265 (point-at-eol) t)
14266 (progn
14267 (setq current (match-string 1))
14268 (replace-match ""))
14269 (setq current ""))
14270 (setq current (nreverse (org-split-string current ":")))
14271 (cond
14272 ((eq onoff 'on)
14273 (setq res t)
14274 (or (member tag current) (push tag current)))
14275 ((eq onoff 'off)
14276 (or (not (member tag current)) (setq current (delete tag current))))
14277 (t (if (member tag current)
14278 (setq current (delete tag current))
14279 (setq res t)
14280 (push tag current))))
14281 (end-of-line 1)
14282 (if current
14283 (progn
14284 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14285 (org-set-tags nil t))
14286 (delete-horizontal-space))
14287 (run-hooks 'org-after-tags-change-hook))
14288 res))
14290 (defun org-align-tags-here (to-col)
14291 ;; Assumes that this is a headline
14292 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14293 (beginning-of-line 1)
14295 (< pos (match-beginning 2)))
14296 (progn
14297 (setq tags-l (- (match-end 2) (match-beginning 2)))
14298 (goto-char (match-beginning 1))
14299 (insert " ")
14300 (delete-region (point) (1+ (match-beginning 2)))
14301 (setq ncol (max (current-column)
14302 (1+ col)
14303 (if (> to-col 0)
14304 to-col
14305 (- (abs to-col) tags-l))))
14306 (setq p (point))
14307 (insert (make-string (- ncol (current-column)) ?\ ))
14308 (setq ncol (current-column))
14309 (when indent-tabs-mode (tabify p (point-at-eol)))
14310 (org-move-to-column (min ncol col) t))
14311 (goto-char pos))))
14313 (defun org-set-tags-command (&optional arg just-align)
14314 "Call the set-tags command for the current entry."
14315 (interactive "P")
14316 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14317 (org-set-tags arg just-align)
14318 (save-excursion
14319 (unless (and (org-region-active-p)
14320 org-loop-over-headlines-in-active-region)
14321 (org-back-to-heading t))
14322 (org-set-tags arg just-align))))
14324 (defun org-set-tags-to (data)
14325 "Set the tags of the current entry to DATA, replacing the current tags.
14326 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14327 If DATA is nil or the empty string, any tags will be removed."
14328 (interactive "sTags: ")
14329 (setq data
14330 (cond
14331 ((eq data nil) "")
14332 ((equal data "") "")
14333 ((stringp data)
14334 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14335 ":"))
14336 ((listp data)
14337 (concat ":" (mapconcat 'identity data ":") ":"))))
14338 (when data
14339 (save-excursion
14340 (org-back-to-heading t)
14341 (when (looking-at org-complex-heading-regexp)
14342 (if (match-end 5)
14343 (progn
14344 (goto-char (match-beginning 5))
14345 (insert data)
14346 (delete-region (point) (point-at-eol))
14347 (org-set-tags nil 'align))
14348 (goto-char (point-at-eol))
14349 (insert " " data)
14350 (org-set-tags nil 'align)))
14351 (beginning-of-line 1)
14353 (delete-region (match-beginning 1) (match-end 1))))))
14355 (defun org-align-all-tags ()
14356 "Align the tags i all headings."
14357 (interactive)
14358 (save-excursion
14359 (or (ignore-errors (org-back-to-heading t))
14360 (outline-next-heading))
14361 (if (org-at-heading-p)
14362 (org-set-tags t)
14363 (message "No headings"))))
14365 (defvar org-indent-indentation-per-level)
14366 (defun org-set-tags (&optional arg just-align)
14367 "Set the tags for the current headline.
14368 With prefix ARG, realign all tags in headings in the current buffer."
14369 (interactive "P")
14370 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14371 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14372 'region-start-level 'region))
14373 org-loop-over-headlines-in-active-region)
14374 (org-map-entries
14375 ;; We don't use ARG and JUST-ALIGN here these args are not
14376 ;; useful when looping over headlines
14377 `(org-set-tags)
14378 org-loop-over-headlines-in-active-region
14379 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14380 (let* ((re org-outline-regexp-bol)
14381 (current (unless arg (org-get-tags-string)))
14382 (col (current-column))
14383 (org-setting-tags t)
14384 table current-tags inherited-tags ; computed below when needed
14385 tags p0 c0 c1 rpl di tc level)
14386 (if arg
14387 (save-excursion
14388 (goto-char (point-min))
14389 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14390 (while (re-search-forward re nil t)
14391 (org-set-tags nil t)
14392 (end-of-line 1)))
14393 (message "All tags realigned to column %d" org-tags-column))
14394 (if just-align
14395 (setq tags current)
14396 ;; Get a new set of tags from the user
14397 (save-excursion
14398 (setq table (append org-tag-persistent-alist
14399 (or org-tag-alist (org-get-buffer-tags))
14400 (and
14401 org-complete-tags-always-offer-all-agenda-tags
14402 (org-global-tags-completion-table
14403 (org-agenda-files))))
14404 org-last-tags-completion-table table
14405 current-tags (org-split-string current ":")
14406 inherited-tags (nreverse
14407 (nthcdr (length current-tags)
14408 (nreverse (org-get-tags-at))))
14409 tags
14410 (if (or (eq t org-use-fast-tag-selection)
14411 (and org-use-fast-tag-selection
14412 (delq nil (mapcar 'cdr table))))
14413 (org-fast-tag-selection
14414 current-tags inherited-tags table
14415 (if org-fast-tag-selection-include-todo
14416 org-todo-key-alist))
14417 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14418 (org-trim
14419 (org-icompleting-read "Tags: "
14420 'org-tags-completion-function
14421 nil nil current 'org-tags-history))))))
14422 (while (string-match "[-+&]+" tags)
14423 ;; No boolean logic, just a list
14424 (setq tags (replace-match ":" t t tags))))
14426 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14428 (if org-tags-sort-function
14429 (setq tags (mapconcat 'identity
14430 (sort (org-split-string
14431 tags (org-re "[^[:alnum:]_@#%]+"))
14432 org-tags-sort-function) ":")))
14435 (setq tags "")
14436 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14437 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14439 ;; Insert new tags at the correct column
14440 (beginning-of-line 1)
14441 (setq level (or (and (looking-at org-outline-regexp)
14442 (- (match-end 0) (point) 1))
14443 1))
14444 (cond
14445 ((and (equal current "") (equal tags "")))
14446 ((re-search-forward
14448 (point-at-eol) t)
14449 (if (equal tags "")
14450 (setq rpl "")
14451 (goto-char (match-beginning 0))
14452 (setq c0 (current-column)
14453 ;; compute offset for the case of org-indent-mode active
14454 di (if org-indent-mode
14455 (* (1- org-indent-indentation-per-level) (1- level))
14456 0)
14457 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14458 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14459 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14460 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14461 (replace-match rpl t t)
14462 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14463 tags)
14464 (t (error "Tags alignment failed")))
14465 (org-move-to-column col)
14466 (unless just-align
14467 (run-hooks 'org-after-tags-change-hook))))))
14469 (defun org-change-tag-in-region (beg end tag off)
14470 "Add or remove TAG for each entry in the region.
14471 This works in the agenda, and also in an org-mode buffer."
14472 (interactive
14473 (list (region-beginning) (region-end)
14474 (let ((org-last-tags-completion-table
14475 (if (derived-mode-p 'org-mode)
14476 (org-uniquify
14477 (delq nil (append (org-get-buffer-tags)
14478 (org-global-tags-completion-table))))
14479 (org-global-tags-completion-table))))
14480 (org-icompleting-read
14481 "Tag: " 'org-tags-completion-function nil nil nil
14482 'org-tags-history))
14483 (progn
14485 (equal (read-char-exclusive) ?r))))
14486 (if (fboundp 'deactivate-mark) (deactivate-mark))
14487 (let ((agendap (equal major-mode 'org-agenda-mode))
14488 l1 l2 m buf pos newhead (cnt 0))
14489 (goto-char end)
14490 (setq l2 (1- (org-current-line)))
14491 (goto-char beg)
14492 (setq l1 (org-current-line))
14493 (loop for l from l1 to l2 do
14494 (org-goto-line l)
14495 (setq m (get-text-property (point) 'org-hd-marker))
14496 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14497 (and agendap m))
14498 (setq buf (if agendap (marker-buffer m) (current-buffer))
14499 pos (if agendap m (point)))
14500 (with-current-buffer buf
14501 (save-excursion
14502 (save-restriction
14503 (goto-char pos)
14504 (setq cnt (1+ cnt))
14505 (org-toggle-tag tag (if off 'off 'on))
14506 (setq newhead (org-get-heading)))))
14507 (and agendap (org-agenda-change-all-lines newhead m))))
14508 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14510 (defun org-tags-completion-function (string predicate &optional flag)
14511 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14512 (confirm (lambda (x) (stringp (car x)))))
14514 (setq s1 (match-string 1 string)
14515 s2 (match-string 2 string))
14516 (setq s1 "" s2 string))
14517 (cond
14518 ((eq flag nil)
14519 ;; try completion
14520 (setq rtn (try-completion s2 ctable confirm))
14521 (if (stringp rtn)
14522 (setq rtn
14523 (concat s1 s2 (substring rtn (length s2))
14524 (if (and org-add-colon-after-tag-completion
14525 (assoc rtn ctable))
14526 ":" ""))))
14527 rtn)
14528 ((eq flag t)
14529 ;; all-completions
14530 (all-completions s2 ctable confirm))
14531 ((eq flag 'lambda)
14532 ;; exact match?
14533 (assoc s2 ctable)))))
14535 (defun org-fast-tag-insert (kwd tags face &optional end)
14536 "Insert KDW, and the TAGS, the latter with face FACE.
14537 Also insert END."
14538 (insert (format "%-12s" (concat kwd ":"))
14539 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14540 (or end "")))
14542 (defun org-fast-tag-show-exit (flag)
14543 (save-excursion
14544 (org-goto-line 3)
14546 (replace-match ""))
14547 (when flag
14548 (end-of-line 1)
14549 (org-move-to-column (- (window-width) 19) t)
14550 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14552 (defun org-set-current-tags-overlay (current prefix)
14553 "Add an overlay to CURRENT tag with PREFIX."
14554 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14555 (if (featurep 'xemacs)
14556 (org-overlay-display org-tags-overlay (concat prefix s)
14557 'secondary-selection)
14558 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14559 (org-overlay-display org-tags-overlay (concat prefix s)))))
14561 (defvar org-last-tag-selection-key nil)
14562 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14563 "Fast tag selection with single keys.
14564 CURRENT is the current list of tags in the headline, INHERITED is the
14565 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14566 possibly with grouping information. TODO-TABLE is a similar table with
14567 TODO keywords, should these have keys assigned to them.
14568 If the keys are nil, a-z are automatically assigned.
14569 Returns the new tags string, or nil to not change the current settings."
14570 (let* ((fulltable (append table todo-table))
14571 (maxlen (apply 'max (mapcar
14572 (lambda (x)
14573 (if (stringp (car x)) (string-width (car x)) 0))
14574 fulltable)))
14575 (buf (current-buffer))
14576 (expert (eq org-fast-tag-selection-single-key 'expert))
14577 (buffer-tags nil)
14578 (fwidth (+ maxlen 3 1 3))
14579 (ncol (/ (- (window-width) 4) fwidth))
14580 (i-face 'org-done)
14581 (c-face 'org-todo)
14582 tg cnt e c char c1 c2 ntable tbl rtn
14583 ov-start ov-end ov-prefix
14584 (exit-after-next org-fast-tag-selection-single-key)
14585 (done-keywords org-done-keywords)
14586 groups ingroup)
14587 (save-excursion
14588 (beginning-of-line 1)
14589 (if (looking-at
14591 (setq ov-start (match-beginning 1)
14592 ov-end (match-end 1)
14593 ov-prefix "")
14594 (setq ov-start (1- (point-at-eol))
14595 ov-end (1+ ov-start))
14597 (setq ov-prefix
14598 (concat
14599 (buffer-substring (1- (point)) (point))
14600 (if (> (current-column) org-tags-column)
14601 " "
14602 (make-string (- org-tags-column (current-column)) ?\ ))))))
14603 (move-overlay org-tags-overlay ov-start ov-end)
14604 (save-window-excursion
14605 (if expert
14606 (set-buffer (get-buffer-create " *Org tags*"))
14607 (delete-other-windows)
14608 (split-window-vertically)
14609 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14610 (erase-buffer)
14611 (org-set-local 'org-done-keywords done-keywords)
14614 (org-fast-tag-show-exit exit-after-next)
14615 (org-set-current-tags-overlay current ov-prefix)
14616 (setq tbl fulltable char ?a cnt 0)
14617 (while (setq e (pop tbl))
14618 (cond
14619 ((equal (car e) :startgroup)
14620 (push '() groups) (setq ingroup t)
14621 (when (not (= cnt 0))
14622 (setq cnt 0)
14624 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14625 ((equal (car e) :endgroup)
14626 (setq ingroup nil cnt 0)
14628 ((equal e '(:newline))
14629 (when (not (= cnt 0))
14630 (setq cnt 0)
14632 (setq e (car tbl))
14633 (while (equal (car tbl) '(:newline))
14635 (setq tbl (cdr tbl)))))
14636 ((equal e '(:grouptags)) nil)
14637 (t
14638 (setq tg (copy-sequence (car e)) c2 nil)
14639 (if (cdr e)
14640 (setq c (cdr e))
14641 ;; automatically assign a character.
14642 (setq c1 (string-to-char
14643 (downcase (substring
14644 tg (if (= (string-to-char tg) ?@) 1 0)))))
14645 (if (or (rassoc c1 ntable) (rassoc c1 table))
14646 (while (or (rassoc char ntable) (rassoc char table))
14647 (setq char (1+ char)))
14648 (setq c2 c1))
14649 (setq c (or c2 char)))
14650 (if ingroup (push tg (car groups)))
14651 (setq tg (org-add-props tg nil 'face
14652 (cond
14653 ((not (assoc tg table))
14654 (org-get-todo-face tg))
14655 ((member tg current) c-face)
14656 ((member tg inherited) i-face))))
14657 (if (equal (caar tbl) :grouptags)
14658 (org-add-props tg nil 'face 'org-tag-group))
14659 (if (and (= cnt 0) (not ingroup)) (insert " "))
14660 (insert "[" c "] " tg (make-string
14661 (- fwidth 4 (length tg)) ?\ ))
14662 (push (cons tg c) ntable)
14663 (when (= (setq cnt (1+ cnt)) ncol)
14665 (if ingroup (insert " "))
14666 (setq cnt 0)))))
14667 (setq ntable (nreverse ntable))
14669 (goto-char (point-min))
14670 (if (not expert) (org-fit-window-to-buffer))
14671 (setq rtn
14672 (catch 'exit
14673 (while t
14674 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14675 (if (not groups) "no " "")
14676 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14677 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14678 (setq org-last-tag-selection-key c)
14679 (cond
14681 ((= c ?!)
14682 (setq groups (not groups))
14683 (goto-char (point-min))
14684 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14685 ((= c ?\C-c)
14686 (if (not expert)
14687 (org-fast-tag-show-exit
14688 (setq exit-after-next (not exit-after-next)))
14689 (setq expert nil)
14690 (delete-other-windows)
14691 (set-window-buffer (split-window-vertically) " *Org tags*")
14692 (org-switch-to-buffer-other-window " *Org tags*")
14693 (org-fit-window-to-buffer)))
14694 ((or (= c ?\C-g)
14695 (and (= c ?q) (not (rassoc c ntable))))
14696 (org-detach-overlay org-tags-overlay)
14697 (setq quit-flag t))
14698 ((= c ?\ )
14699 (setq current nil)
14700 (if exit-after-next (setq exit-after-next 'now)))
14702 (condition-case nil
14703 (setq tg (org-icompleting-read
14704 "Tag: "
14705 (or buffer-tags
14706 (with-current-buffer buf
14707 (org-get-buffer-tags)))))
14708 (quit (setq tg "")))
14710 (add-to-list 'buffer-tags (list tg))
14711 (if (member tg current)
14712 (setq current (delete tg current))
14713 (push tg current)))
14714 (if exit-after-next (setq exit-after-next 'now)))
14715 ((setq e (rassoc c todo-table) tg (car e))
14716 (with-current-buffer buf
14717 (save-excursion (org-todo tg)))
14718 (if exit-after-next (setq exit-after-next 'now)))
14719 ((setq e (rassoc c ntable) tg (car e))
14720 (if (member tg current)
14721 (setq current (delete tg current))
14722 (loop for g in groups do
14723 (if (member tg g)
14724 (mapc (lambda (x)
14725 (setq current (delete x current)))
14726 g)))
14727 (push tg current))
14728 (if exit-after-next (setq exit-after-next 'now))))
14730 ;; Create a sorted list
14731 (setq current
14732 (sort current
14733 (lambda (a b)
14734 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14735 (if (eq exit-after-next 'now) (throw 'exit t))
14736 (goto-char (point-min))
14737 (beginning-of-line 2)
14738 (delete-region (point) (point-at-eol))
14739 (org-fast-tag-insert "Current" current c-face)
14740 (org-set-current-tags-overlay current ov-prefix)
14741 (while (re-search-forward
14743 (setq tg (match-string 1))
14744 (add-text-properties
14745 (match-beginning 1) (match-end 1)
14746 (list 'face
14747 (cond
14748 ((member tg current) c-face)
14749 ((member tg inherited) i-face)
14750 (t (get-text-property (match-beginning 1) 'face))))))
14751 (goto-char (point-min)))))
14752 (org-detach-overlay org-tags-overlay)
14753 (if rtn
14754 (mapconcat 'identity current ":")
14755 nil))))
14757 (defun org-get-tags-string ()
14758 "Get the TAGS string in the current headline."
14759 (unless (org-at-heading-p t)
14760 (error "Not on a heading"))
14761 (save-excursion
14762 (beginning-of-line 1)
14764 (org-match-string-no-properties 1)
14765 "")))
14767 (defun org-get-tags ()
14768 "Get the list of tags specified in the current headline."
14769 (org-split-string (org-get-tags-string) ":"))
14771 (defun org-get-buffer-tags ()
14772 "Get a table of all tags used in the buffer, for completion."
14773 (let (tags)
14774 (save-excursion
14775 (goto-char (point-min))
14776 (while (re-search-forward
14778 (when (equal (char-after (point-at-bol 0)) ?*)
14779 (mapc (lambda (x) (add-to-list 'tags x))
14780 (org-split-string (org-match-string-no-properties 1) ":")))))
14781 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14782 (mapcar 'list tags)))
14784 ;;;; The mapping API
14786 (defun org-map-entries (func &optional match scope &rest skip)
14787 "Call FUNC at each headline selected by MATCH in SCOPE.
14789 FUNC is a function or a lisp form. The function will be called without
14790 arguments, with the cursor positioned at the beginning of the headline.
14791 The return values of all calls to the function will be collected and
14792 returned as a list.
14794 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14795 does not need to preserve point. After evaluation, the cursor will be
14796 moved to the end of the line (presumably of the headline of the
14797 processed entry) and search continues from there. Under some
14798 circumstances, this may not produce the wanted results. For example,
14799 if you have removed (e.g. archived) the current (sub)tree it could
14800 mean that the next entry will be skipped entirely. In such cases, you
14801 can specify the position from where search should continue by making
14802 FUNC set the variable `org-map-continue-from' to the desired buffer
14803 position.
14805 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14806 Only headlines that are matched by this query will be considered during
14807 the iteration. When MATCH is nil or t, all headlines will be
14808 visited by the iteration.
14810 SCOPE determines the scope of this command. It can be any of:
14812 nil The current buffer, respecting the restriction if any
14813 tree The subtree started with the entry at point
14814 region The entries within the active region, if any
14815 region-start-level
14816 The entries within the active region, but only those at
14817 the same level than the first one.
14818 file The current buffer, without restriction
14819 file-with-archives
14820 The current buffer, and any archives associated with it
14821 agenda All agenda files
14822 agenda-with-archives
14823 All agenda files with any archive files associated with them
14824 \(file1 file2 ...)
14825 If this is a list, all files in the list will be scanned
14827 The remaining args are treated as settings for the skipping facilities of
14828 the scanner. The following items can be given here:
14830 archive skip trees with the archive tag
14831 comment skip trees with the COMMENT keyword
14832 function or Emacs Lisp form:
14833 will be used as value for `org-agenda-skip-function', so
14834 whenever the function returns a position, FUNC will not be
14835 called for that entry and search will continue from the
14836 position returned
14838 If your function needs to retrieve the tags including inherited tags
14839 at the *current* entry, you can use the value of the variable
14840 `org-scanner-tags' which will be much faster than getting the value
14841 with `org-get-tags-at'. If your function gets properties with
14842 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14843 to t around the call to `org-entry-properties' to get the same speedup.
14844 Note that if your function moves around to retrieve tags and properties at
14845 a *different* entry, you cannot use these techniques."
14846 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14847 (not (org-region-active-p)))
14848 (let* ((org-agenda-archives-mode nil) ; just to make sure
14849 (org-agenda-skip-archived-trees (memq 'archive skip))
14850 (org-agenda-skip-comment-trees (memq 'comment skip))
14851 (org-agenda-skip-function
14852 (car (org-delete-all '(comment archive) skip)))
14853 (org-tags-match-list-sublevels t)
14854 (start-level (eq scope 'region-start-level))
14855 matcher file res
14856 org-todo-keywords-for-agenda
14857 org-done-keywords-for-agenda
14858 org-todo-keyword-alist-for-agenda
14859 org-drawers-for-agenda
14860 org-tag-alist-for-agenda
14861 todo-only)
14863 (cond
14864 ((eq match t) (setq matcher t))
14865 ((eq match nil) (setq matcher t))
14866 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14868 (save-window-excursion
14869 (save-restriction
14870 (cond ((eq scope 'tree)
14871 (org-back-to-heading t)
14872 (org-narrow-to-subtree)
14873 (setq scope nil))
14874 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14875 (org-region-active-p))
14876 ;; If needed, set start-level to a string like "2"
14877 (when start-level
14878 (save-excursion
14879 (goto-char (region-beginning))
14880 (unless (org-at-heading-p) (outline-next-heading))
14881 (setq start-level (org-current-level))))
14882 (narrow-to-region (region-beginning)
14883 (save-excursion
14884 (goto-char (region-end))
14885 (unless (and (bolp) (org-at-heading-p))
14886 (outline-next-heading))
14887 (point)))
14888 (setq scope nil)))
14890 (if (not scope)
14891 (progn
14892 (org-agenda-prepare-buffers
14893 (list (buffer-file-name (current-buffer))))
14894 (setq res (org-scan-tags func matcher todo-only start-level)))
14895 ;; Get the right scope
14896 (cond
14897 ((and scope (listp scope) (symbolp (car scope)))
14898 (setq scope (eval scope)))
14899 ((eq scope 'agenda)
14900 (setq scope (org-agenda-files t)))
14901 ((eq scope 'agenda-with-archives)
14902 (setq scope (org-agenda-files t))
14903 (setq scope (org-add-archive-files scope)))
14904 ((eq scope 'file)
14905 (setq scope (list (buffer-file-name))))
14906 ((eq scope 'file-with-archives)
14907 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14908 (org-agenda-prepare-buffers scope)
14909 (while (setq file (pop scope))
14910 (with-current-buffer (org-find-base-buffer-visiting file)
14911 (save-excursion
14912 (save-restriction
14913 (widen)
14914 (goto-char (point-min))
14915 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14916 res)))
14918 ;;;; Properties
14920 ;;; Setting and retrieving properties
14922 (defconst org-special-properties
14923 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14924 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14925 "The special properties valid in Org-mode.
14927 These are properties that are not defined in the property drawer,
14928 but in some other way.")
14930 (defconst org-default-properties
14931 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14932 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14933 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14934 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14935 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14936 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14937 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14938 "Some properties that are used by Org-mode for various purposes.
14939 Being in this list makes sure that they are offered for completion.")
14942 "Regular expression matching the first line of a property drawer.")
14945 "Regular expression matching the last line of a property drawer.")
14948 "Regular expression matching the first line of a property drawer.")
14951 "Regular expression matching the first line of a property drawer.")
14953 (defconst org-property-drawer-re
14956 "Matches an entire property drawer.")
14958 (defconst org-clock-drawer-re
14961 "Matches an entire clock drawer.")
14963 (defsubst org-re-property (property)
14964 "Return a regexp matching a PROPERTY line.
14965 Match group 1 will be set to the value."
14968 (defsubst org-re-property-keyword (property)
14969 "Return a regexp matching a PROPERTY line, possibly with no
14970 value for the property."
14973 (defun org-property-action ()
14974 "Do an action on properties."
14975 (interactive)
14976 (let (c)
14977 (org-at-property-p)
14978 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14979 (setq c (read-char-exclusive))
14980 (cond
14981 ((equal c ?s)
14982 (call-interactively 'org-set-property))
14983 ((equal c ?d)
14984 (call-interactively 'org-delete-property))
14985 ((equal c ?D)
14986 (call-interactively 'org-delete-property-globally))
14987 ((equal c ?c)
14988 (call-interactively 'org-compute-property-at-point))
14989 (t (error "No such property action %c" c)))))
14991 (defun org-inc-effort ()
14992 "Increment the value of the effort property in the current entry."
14993 (interactive)
14994 (org-set-effort nil t))
14996 (defvar org-clock-effort) ;; Defined in org-clock.el
14997 (defvar org-clock-current-task) ;; Defined in org-clock.el
14998 (defun org-set-effort (&optional value increment)
14999 "Set the effort property of the current entry.
15000 With numerical prefix arg, use the nth allowed value, 0 stands for the
15001 10th allowed value.
15003 When INCREMENT is non-nil, set the property to the next allowed value."
15004 (interactive "P")
15005 (if (equal value 0) (setq value 10))
15006 (let* ((completion-ignore-case t)
15007 (prop org-effort-property)
15008 (cur (org-entry-get nil prop))
15009 (allowed (org-property-get-allowed-values nil prop 'table))
15010 (existing (mapcar 'list (org-property-values prop)))
15011 (heading (nth 4 (org-heading-components)))
15012 rpl
15013 (val (cond
15014 ((stringp value) value)
15015 ((and allowed (integerp value))
15016 (or (car (nth (1- value) allowed))
15017 (car (org-last allowed))))
15018 ((and allowed increment)
15019 (or (caadr (member (list cur) allowed))
15020 (error "Allowed effort values are not set")))
15021 (allowed
15022 (message "Select 1-9,0, [RET%s]: %s"
15023 (if cur (concat "=" cur) "")
15024 (mapconcat 'car allowed " "))
15025 (setq rpl (read-char-exclusive))
15027 cur
15028 (setq rpl (- rpl ?0))
15029 (if (equal rpl 0) (setq rpl 10))
15030 (if (and (> rpl 0) (<= rpl (length allowed)))
15031 (car (nth (1- rpl) allowed))
15032 (org-completing-read "Effort: " allowed nil))))
15033 (t
15034 (let (org-completion-use-ido org-completion-use-iswitchb)
15035 (org-completing-read
15037 (concat "[" cur "]") "")
15038 ": ")
15039 existing nil nil "" nil cur))))))
15040 (unless (equal (org-entry-get nil prop) val)
15041 (org-entry-put nil prop val))
15042 (save-excursion
15043 (org-back-to-heading t)
15044 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15045 (when (string= heading org-clock-current-task)
15046 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15047 (org-clock-update-mode-line))
15048 (message "%s is now %s" prop val)))
15050 (defun org-at-property-p ()
15051 "Is cursor inside a property drawer?"
15052 (save-excursion
15053 (beginning-of-line 1)
15055 (save-match-data ;; Used by calling procedures
15056 (let ((p (point))
15057 (range (unless (org-before-first-heading-p)
15058 (org-get-property-block))))
15059 (and range (<= (car range) p) (< p (cdr range))))))))
15061 (defun org-get-property-block (&optional beg end force)
15062 "Return the (beg . end) range of the body of the property drawer.
15063 BEG and END are the beginning and end of the current subtree, or of
15064 the part before the first headline. If they are not given, they will
15065 be found. If the drawer does not exist and FORCE is non-nil, create
15066 the drawer."
15067 (catch 'exit
15068 (save-excursion
15069 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15070 (progn (org-back-to-heading t) (point))))
15071 (end (or end (and (not (outline-next-heading)) (point-max))
15072 (point))))
15073 (goto-char beg)
15074 (if (re-search-forward org-property-start-re end t)
15075 (setq beg (1+ (match-end 0)))
15076 (if force
15077 (save-excursion
15078 (org-insert-property-drawer)
15079 (setq end (progn (outline-next-heading) (point))))
15080 (throw 'exit nil))
15081 (goto-char beg)
15082 (if (re-search-forward org-property-start-re end t)
15083 (setq beg (1+ (match-end 0)))))
15084 (if (re-search-forward org-property-end-re end t)
15085 (setq end (match-beginning 0))
15086 (or force (throw 'exit nil))
15087 (goto-char beg)
15088 (setq end beg)
15089 (org-indent-line)
15091 (cons beg end)))))
15093 (defun org-entry-properties (&optional pom which specific)
15094 "Get all properties of the entry at point-or-marker POM.
15095 This includes the TODO keyword, the tags, time strings for deadline,
15096 scheduled, and clocking, and any additional properties defined in the
15097 entry. The return value is an alist, keys may occur multiple times
15098 if the property key was used several times.
15099 POM may also be nil, in which case the current entry is used.
15100 If WHICH is nil or `all', get all properties. If WHICH is
15101 `special' or `standard', only get that subclass. If WHICH
15102 is a string only get exactly this property. SPECIFIC can be a string, the
15103 specific property we are interested in. Specifying it can speed
15104 things up because then unnecessary parsing is avoided."
15105 (setq which (or which 'all))
15106 (org-with-point-at pom
15107 (let ((clockstr (substring org-clock-string 0 -1))
15108 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15109 (case-fold-search nil)
15110 beg end range props sum-props key key1 value string clocksum clocksumt)
15111 (save-excursion
15112 (when (condition-case nil
15113 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15114 (error nil))
15115 (setq beg (point))
15116 (setq sum-props (get-text-property (point) 'org-summaries))
15117 (setq clocksum (get-text-property (point) :org-clock-minutes)
15118 clocksumt (get-text-property (point) :org-clock-minutes-today))
15119 (outline-next-heading)
15120 (setq end (point))
15121 (when (memq which '(all special))
15122 ;; Get the special properties, like TODO and tags
15123 (goto-char beg)
15124 (when (and (or (not specific) (string= specific "TODO"))
15125 (looking-at org-todo-line-regexp) (match-end 2))
15126 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15127 (when (and (or (not specific) (string= specific "PRIORITY"))
15128 (looking-at org-priority-regexp))
15129 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15130 (when (or (not specific) (string= specific "FILE"))
15131 (push (cons "FILE" buffer-file-name) props))
15132 (when (and (or (not specific) (string= specific "TAGS"))
15133 (setq value (org-get-tags-string))
15135 (push (cons "TAGS" value) props))
15136 (when (and (or (not specific) (string= specific "ALLTAGS"))
15137 (setq value (org-get-tags-at)))
15138 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15139 ":"))
15140 props))
15141 (when (or (not specific) (string= specific "BLOCKED"))
15142 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15143 (when (or (not specific)
15144 (member specific
15145 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15146 "TIMESTAMP" "TIMESTAMP_IA")))
15147 (catch 'match
15148 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15149 (setq key (if (match-end 1)
15150 (substring (org-match-string-no-properties 1)
15151 0 -1))
15152 string (if (equal key clockstr)
15153 (org-trim
15154 (buffer-substring-no-properties
15155 (match-beginning 3) (goto-char
15156 (point-at-eol))))
15157 (substring (org-match-string-no-properties 3)
15158 1 -1)))
15159 ;; Get the correct property name from the key. This is
15160 ;; necessary if the user has configured time keywords.
15161 (setq key1 (concat key ":"))
15162 (cond
15163 ((not key)
15164 (setq key
15165 (if (= (char-after (match-beginning 3)) ?\[)
15166 "TIMESTAMP_IA" "TIMESTAMP")))
15167 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15168 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15169 ((equal key1 org-closed-string) (setq key "CLOSED"))
15170 ((equal key1 org-clock-string) (setq key "CLOCK")))
15171 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15172 (progn
15173 (push (cons key string) props)
15174 ;; no need to search further if match is found
15175 (throw 'match t))
15176 (when (or (equal key "CLOCK") (not (assoc key props)))
15177 (push (cons key string) props)))))))
15179 (when (memq which '(all standard))
15180 ;; Get the standard properties, like :PROP: ...
15181 (setq range (org-get-property-block beg end))
15182 (when range
15183 (goto-char (car range))
15184 (while (re-search-forward
15186 (cdr range) t)
15187 (setq key (org-match-string-no-properties 1)
15188 value (org-trim (or (org-match-string-no-properties 2) "")))
15189 (unless (member key excluded)
15190 (push (cons key (or value "")) props)))))
15191 (if clocksum
15192 (push (cons "CLOCKSUM"
15193 (org-columns-number-to-string (/ (float clocksum) 60.)
15194 'add_times))
15195 props))
15196 (if clocksumt
15197 (push (cons "CLOCKSUM_T"
15198 (org-columns-number-to-string (/ (float clocksumt) 60.)
15199 'add_times))
15200 props))
15201 (unless (assoc "CATEGORY" props)
15202 (push (cons "CATEGORY" (org-get-category)) props))
15203 (append sum-props (nreverse props)))))))
15205 (defun org-entry-get (pom property &optional inherit literal-nil)
15206 "Get value of PROPERTY for entry or content at point-or-marker POM.
15207 If INHERIT is non-nil and the entry does not have the property,
15208 then also check higher levels of the hierarchy.
15209 If INHERIT is the symbol `selective', use inheritance only if the setting
15210 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15211 If the property is present but empty, the return value is the empty string.
15212 If the property is not present at all, nil is returned.
15215 do not interpret it as the list atom nil. This is used for inheritance
15217 (org-with-point-at pom
15218 (if (and inherit (if (eq inherit 'selective)
15219 (org-property-inherit-p property)
15220 t))
15221 (org-entry-get-with-inheritance property literal-nil)
15222 (if (member property org-special-properties)
15223 ;; We need a special property. Use `org-entry-properties' to
15224 ;; retrieve it, but specify the wanted property
15225 (cdr (assoc property (org-entry-properties nil 'special property)))
15226 (let ((range (org-get-property-block)))
15227 (when (and range (not (eq (car range) (cdr range))))
15228 (let* ((props (list (or (assoc property org-file-properties)
15229 (assoc property org-global-properties)
15230 (assoc property org-global-properties-fixed))))
15231 (ap (lambda (key)
15232 (when (re-search-forward
15233 (org-re-property key) (cdr range) t)
15234 (setq props
15235 (org-update-property-plist
15236 key
15237 (if (match-end 1)
15238 (org-match-string-no-properties 1) "")
15239 props)))))
15240 val)
15241 (goto-char (car range))
15242 (funcall ap property)
15243 (goto-char (car range))
15244 (while (funcall ap (concat property "+")))
15245 (setq val (cdr (assoc property props)))
15246 (when val (if literal-nil val (org-not-nil val))))))))))
15248 (defun org-property-or-variable-value (var &optional inherit)
15249 "Check if there is a property fixing the value of VAR.
15250 If yes, return this value. If not, return the current value of the variable."
15251 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15253 (read prop)
15254 (symbol-value var))))
15256 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15257 "Delete the property PROPERTY from entry at point-or-marker POM.
15258 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15259 an empty drawer to delete."
15260 (org-with-point-at pom
15261 (if (member property org-special-properties)
15262 nil ; cannot delete these properties.
15263 (let ((range (org-get-property-block)))
15264 (if (and range
15265 (goto-char (car range))
15266 (re-search-forward
15267 (org-re-property property)
15268 (cdr range) t))
15269 (progn
15270 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15271 (and delete-empty-drawer
15272 (org-remove-empty-drawer-at
15273 delete-empty-drawer (car range)))
15274 t)
15275 nil)))))
15277 ;; Multi-values properties are properties that contain multiple values
15278 ;; These values are assumed to be single words, separated by whitespace.
15279 (defun org-entry-add-to-multivalued-property (pom property value)
15280 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15281 (let* ((old (org-entry-get pom property))
15283 (setq value (org-entry-protect-space value))
15284 (unless (member value values)
15285 (setq values (append values (list value)))
15286 (org-entry-put pom property
15287 (mapconcat 'identity values " ")))))
15289 (defun org-entry-remove-from-multivalued-property (pom property value)
15290 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15291 (let* ((old (org-entry-get pom property))
15293 (setq value (org-entry-protect-space value))
15294 (when (member value values)
15295 (setq values (delete value values))
15296 (org-entry-put pom property
15297 (mapconcat 'identity values " ")))))
15299 (defun org-entry-member-in-multivalued-property (pom property value)
15300 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15301 (let* ((old (org-entry-get pom property))
15303 (setq value (org-entry-protect-space value))
15304 (member value values)))
15306 (defun org-entry-get-multivalued-property (pom property)
15307 "Return a list of values in a multivalued property."
15308 (let* ((value (org-entry-get pom property))
15310 (mapcar 'org-entry-restore-space values)))
15312 (defun org-entry-put-multivalued-property (pom property &rest values)
15313 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15314 VALUES should be a list of strings. Spaces will be protected."
15315 (org-entry-put pom property
15316 (mapconcat 'org-entry-protect-space values " "))
15317 (let* ((value (org-entry-get pom property))
15319 (mapcar 'org-entry-restore-space values)))
15321 (defun org-entry-protect-space (s)
15322 "Protect spaces and newline in string S."
15323 (while (string-match " " s)
15324 (setq s (replace-match "%20" t t s)))
15326 (setq s (replace-match "%0A" t t s)))
15327 s)
15329 (defun org-entry-restore-space (s)
15330 "Restore spaces and newline in string S."
15331 (while (string-match "%20" s)
15332 (setq s (replace-match " " t t s)))
15333 (while (string-match "%0A" s)
15335 s)
15337 (defvar org-entry-property-inherited-from (make-marker)
15338 "Marker pointing to the entry from where a property was inherited.
15339 Each call to `org-entry-get-with-inheritance' will set this marker to the
15340 location of the entry where the inheritance search matched. If there was
15341 no match, the marker will point nowhere.
15342 Note that also `org-entry-get' calls this function, if the INHERIT flag
15343 is set.")
15345 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15346 "Get PROPERTY of entry or content at point, search higher levels if needed.
15347 The search will stop at the first ancestor which has the property defined.
15349 should be considered as undefined (this is the meaning of nil here).
15351 (move-marker org-entry-property-inherited-from nil)
15352 (let (tmp)
15353 (save-excursion
15354 (save-restriction
15355 (widen)
15356 (catch 'ex
15357 (while t
15358 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15359 (or (ignore-errors (org-back-to-heading t))
15360 (goto-char (point-min)))
15361 (move-marker org-entry-property-inherited-from (point))
15362 (throw 'ex tmp))
15363 (or (ignore-errors (org-up-heading-safe))
15364 (throw 'ex nil))))))
15365 (setq tmp (or tmp
15366 (cdr (assoc property org-file-properties))
15367 (cdr (assoc property org-global-properties))
15368 (cdr (assoc property org-global-properties-fixed))))
15369 (if literal-nil tmp (org-not-nil tmp))))
15371 (defvar org-property-changed-functions nil
15372 "Hook called when the value of a property has changed.
15373 Each hook function should accept two arguments, the name of the property
15374 and the new value.")
15376 (defun org-entry-put (pom property value)
15377 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15378 (org-with-point-at pom
15379 (org-back-to-heading t)
15380 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15381 range)
15382 (cond
15383 ((equal property "TODO")
15385 (not (member value org-todo-keywords-1)))
15387 (if (or (not value)
15389 (setq value 'none))
15390 (org-todo value)
15391 (org-set-tags nil 'align))
15392 ((equal property "PRIORITY")
15394 (string-to-char value) ?\ ))
15395 (org-set-tags nil 'align))
15396 ((equal property "CLOCKSUM")
15397 (if (not (re-search-forward
15399 (error "Cannot find a clock log")
15400 (goto-char (- (match-end 1) 2))
15401 (cond
15402 ((eq value 'earlier) (org-timestamp-down))
15403 ((eq value 'later) (org-timestamp-up)))
15404 (org-clock-sum-current-item)))
15405 ((equal property "SCHEDULED")
15406 (if (re-search-forward org-scheduled-time-regexp end t)
15407 (cond
15408 ((eq value 'earlier) (org-timestamp-change -1 'day))
15409 ((eq value 'later) (org-timestamp-change 1 'day))
15410 (t (call-interactively 'org-schedule)))
15411 (call-interactively 'org-schedule)))
15412 ((equal property "DEADLINE")
15413 (if (re-search-forward org-deadline-time-regexp end t)
15414 (cond
15415 ((eq value 'earlier) (org-timestamp-change -1 'day))
15416 ((eq value 'later) (org-timestamp-change 1 'day))
15417 (t (call-interactively 'org-deadline)))
15418 (call-interactively 'org-deadline)))
15419 ((member property org-special-properties)
15420 (error "The %s property can not yet be set with `org-entry-put'"
15421 property))
15422 (t ; a non-special property
15423 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15424 (setq range (org-get-property-block beg end 'force))
15425 (goto-char (car range))
15426 (if (re-search-forward
15427 (org-re-property-keyword property) (cdr range) t)
15428 (progn
15429 (delete-region (match-beginning 0) (match-end 0))
15430 (goto-char (match-beginning 0)))
15431 (goto-char (cdr range))
15433 (backward-char 1)
15434 (org-indent-line))
15435 (insert ":" property ":")
15436 (and value (insert " " value))
15437 (org-indent-line)))))
15438 (run-hook-with-args 'org-property-changed-functions property value)))
15440 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15441 "Get all property keys in the current buffer.
15442 With INCLUDE-SPECIALS, also list the special properties that reflect things
15443 like tags and TODO state.
15444 With INCLUDE-DEFAULTS, also include properties that has special meaning
15445 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15446 and others.
15447 With INCLUDE-COLUMNS, also include property names given in COLUMN
15448 formats in the current buffer."
15449 (let (rtn range cfmt s p)
15450 (save-excursion
15451 (save-restriction
15452 (widen)
15453 (goto-char (point-min))
15454 (while (re-search-forward org-property-start-re nil t)
15455 (setq range (org-get-property-block))
15456 (goto-char (car range))
15457 (while (re-search-forward
15459 (cdr range) t)
15460 (add-to-list 'rtn (org-match-string-no-properties 1)))
15461 (outline-next-heading))))
15463 (when include-specials
15464 (setq rtn (append org-special-properties rtn)))
15466 (when include-defaults
15467 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15468 (add-to-list 'rtn org-effort-property))
15470 (when include-columns
15471 (save-excursion
15472 (save-restriction
15473 (widen)
15474 (goto-char (point-min))
15475 (while (re-search-forward
15477 nil t)
15478 (setq cfmt (match-string 2) s 0)
15480 cfmt s)
15481 (setq s (match-end 0)
15482 p (match-string 1 cfmt))
15483 (unless (or (equal p "ITEM")
15484 (member p org-special-properties))
15485 (add-to-list 'rtn (match-string 1 cfmt))))))))
15487 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15489 (defun org-property-values (key)
15490 "Return a list of all values of property KEY in the current buffer."
15491 (save-excursion
15492 (save-restriction
15493 (widen)
15494 (goto-char (point-min))
15495 (let ((re (org-re-property key))
15496 values)
15497 (while (re-search-forward re nil t)
15498 (add-to-list 'values (org-trim (match-string 1))))
15499 (delete "" values)))))
15501 (defun org-insert-property-drawer ()
15502 "Insert a property drawer into the current entry."
15503 (org-back-to-heading t)
15504 (looking-at org-outline-regexp)
15505 (let ((indent (if org-adapt-indentation
15506 (- (match-end 0) (match-beginning 0))
15507 0))
15508 (beg (point))
15510 end hiddenp)
15511 (outline-next-heading)
15512 (setq end (point))
15513 (goto-char beg)
15514 (while (re-search-forward re end t))
15515 (setq hiddenp (outline-invisible-p))
15516 (end-of-line 1)
15519 (if (member (match-string 1) '("CLOCK:" ":END:"))
15520 ;; just skip this line
15521 (beginning-of-line 2)
15522 ;; Drawer start, find the end
15524 (beginning-of-line 1)))
15525 (org-skip-over-state-notes)
15527 (if (eq (char-before) ?*) (forward-char 1))
15529 (beginning-of-line 0)
15530 (org-indent-to-column indent)
15531 (beginning-of-line 2)
15532 (org-indent-to-column indent)
15533 (beginning-of-line 0)
15534 (if hiddenp
15535 (save-excursion
15536 (org-back-to-heading t)
15537 (hide-entry))
15538 (org-flag-drawer t))))
15540 (defun org-insert-drawer (&optional arg drawer)
15541 "Insert a drawer at point.
15543 Optional argument DRAWER, when non-nil, is a string representing
15544 drawer's name. Otherwise, the user is prompted for a name.
15546 If a region is active, insert the drawer around that region
15547 instead.
15549 Point is left between drawer's boundaries."
15550 (interactive "P")
15551 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15552 "LOGBOOK"))
15553 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15554 ;; internally by Org. They are meant to be inserted
15555 ;; automatically.
15556 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15557 ;; Remove system drawers from list. Note: For some reason,
15558 ;; `org-completing-read' ignores the predicate while
15559 ;; `completing-read' handles it fine.
15560 (drawer (if arg "PROPERTIES"
15561 (or drawer
15562 (completing-read
15563 "Drawer: " org-drawers
15564 (lambda (d) (not (member d system-drawers))))))))
15565 (cond
15566 ;; With C-u, fall back on `org-insert-property-drawer'
15567 (arg (org-insert-property-drawer))
15568 ;; With an active region, insert a drawer at point.
15569 ((not (org-region-active-p))
15570 (progn
15573 (forward-line -2)))
15574 ;; Otherwise, insert the drawer at point
15575 (t
15576 (let ((rbeg (region-beginning))
15577 (rend (copy-marker (region-end))))
15578 (unwind-protect
15579 (progn
15580 (goto-char rbeg)
15581 (beginning-of-line)
15582 (when (save-excursion
15583 (re-search-forward org-outline-regexp-bol rend t))
15584 (error "Drawers cannot contain headlines"))
15585 ;; Position point at the beginning of the first
15586 ;; non-blank line in region. Insert drawer's opening
15587 ;; there, then indent it.
15588 (org-skip-whitespace)
15589 (beginning-of-line)
15591 (forward-line -1)
15592 (indent-for-tab-command)
15593 ;; Move point to the beginning of the first blank line
15594 ;; after the last non-blank line in region. Insert
15595 ;; drawer's closing, then indent it.
15596 (goto-char rend)
15599 (deactivate-mark t)
15600 (indent-for-tab-command)
15602 ;; Clear marker, whatever the outcome of insertion is.
15603 (set-marker rend nil)))))))
15605 (defvar org-property-set-functions-alist nil
15606 "Property set function alist.
15607 Each entry should have the following format:
15609 (PROPERTY . READ-FUNCTION)
15611 The read function will be called with the same argument as
15612 `org-completing-read'.")
15614 (defun org-set-property-function (property)
15615 "Get the function that should be used to set PROPERTY.
15616 This is computed according to `org-property-set-functions-alist'."
15617 (or (cdr (assoc property org-property-set-functions-alist))
15618 'org-completing-read))
15620 (defun org-read-property-value (property)
15621 "Read PROPERTY value from user."
15622 (let* ((completion-ignore-case t)
15623 (allowed (org-property-get-allowed-values nil property 'table))
15624 (cur (org-entry-get nil property))
15625 (prompt (concat property " value"
15627 (concat " [" cur "]") "") ": "))
15628 (set-function (org-set-property-function property))
15629 (val (if allowed
15630 (funcall set-function prompt allowed nil
15631 (not (get-text-property 0 'org-unrestricted
15632 (caar allowed))))
15633 (let (org-completion-use-ido org-completion-use-iswitchb)
15634 (funcall set-function prompt
15635 (mapcar 'list (org-property-values property))
15636 nil nil "" nil cur)))))
15637 (if (equal val "")
15638 cur
15639 val)))
15641 (defvar org-last-set-property nil)
15642 (defvar org-last-set-property-value nil)
15643 (defun org-read-property-name ()
15644 "Read a property name."
15645 (let* ((completion-ignore-case t)
15646 (keys (org-buffer-property-keys nil t t))
15647 (default-prop (or (save-excursion
15648 (save-match-data
15649 (beginning-of-line)
15651 (null (string= (match-string 1) "END"))
15652 (match-string 1))))
15653 org-last-set-property))
15654 (property (org-icompleting-read
15655 (concat "Property"
15656 (if default-prop (concat " [" default-prop "]") "")
15657 ": ")
15658 (mapcar 'list keys)
15659 nil nil nil nil
15660 default-prop)))
15661 (if (member property keys)
15662 property
15663 (or (cdr (assoc (downcase property)
15664 (mapcar (lambda (x) (cons (downcase x) x))
15665 keys)))
15666 property))))
15668 (defun org-set-property-and-value (use-last)
15669 "Allow to set [PROPERTY]: [value] direction from prompt.
15670 When use-default, don't even ask, just use the last
15672 (interactive "P")
15673 (let* ((completion-ignore-case t)
15674 (pv (or (and use-last org-last-set-property-value)
15675 (org-completing-read
15677 nil nil nil nil nil
15678 org-last-set-property-value)))
15679 prop val)
15681 (setq prop (match-string 1 pv)
15682 val (match-string 2 pv))
15683 (org-set-property prop val))))
15685 (defun org-set-property (property value)
15686 "In the current entry, set PROPERTY to VALUE.
15687 When called interactively, this will prompt for a property name, offering
15688 completion on existing and default properties. And then it will prompt
15689 for a value, offering completion either on allowed values (via an inherited
15690 xxx_ALL property) or on existing values in other instances of this property
15691 in the current file."
15692 (interactive (list nil nil))
15693 (let* ((property (or property (org-read-property-name)))
15694 (value (or value (org-read-property-value property)))
15695 (fn (cdr (assoc property org-properties-postprocess-alist))))
15696 (setq org-last-set-property property)
15697 (setq org-last-set-property-value (concat property ": " value))
15698 ;; Possibly postprocess the inserted value:
15699 (when fn (setq value (funcall fn value)))
15700 (unless (equal (org-entry-get nil property) value)
15701 (org-entry-put nil property value))))
15703 (defun org-delete-property (property &optional delete-empty-drawer)
15704 "In the current entry, delete PROPERTY.
15705 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15706 an empty drawer to delete."
15707 (interactive
15708 (let* ((completion-ignore-case t)
15709 (prop (org-icompleting-read "Property: "
15710 (org-entry-properties nil 'standard))))
15711 (list prop)))
15712 (message "Property %s %s" property
15713 (if (org-entry-delete nil property delete-empty-drawer)
15714 "deleted"
15715 "was not present in the entry")))
15717 (defun org-delete-property-globally (property)
15718 "Remove PROPERTY globally, from all entries."
15719 (interactive
15720 (let* ((completion-ignore-case t)
15721 (prop (org-icompleting-read
15722 "Globally remove property: "
15723 (mapcar 'list (org-buffer-property-keys)))))
15724 (list prop)))
15725 (save-excursion
15726 (save-restriction
15727 (widen)
15728 (goto-char (point-min))
15729 (let ((cnt 0))
15730 (while (re-search-forward
15731 (org-re-property property)
15732 nil t)
15733 (setq cnt (1+ cnt))
15734 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15737 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15739 (defun org-compute-property-at-point ()
15740 "Compute the property at point.
15741 This looks for an enclosing column format, extracts the operator and
15742 then applies it to the property in the column format's scope."
15743 (interactive)
15744 (unless (org-at-property-p)
15745 (error "Not at a property"))
15746 (let ((prop (org-match-string-no-properties 2)))
15747 (org-columns-get-format-and-top-level)
15748 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15749 (error "No operator defined for property %s" prop))
15750 (org-columns-compute prop)))
15752 (defvar org-property-allowed-value-functions nil
15753 "Hook for functions supplying allowed values for a specific property.
15754 The functions must take a single argument, the name of the property, and
15756 the values, this means that these values are intended as defaults for
15757 completion, but that other values should be allowed too.
15758 The functions must return nil if they are not responsible for this
15759 property.")
15761 (defun org-property-get-allowed-values (pom property &optional table)
15762 "Get allowed values for the property PROPERTY.
15763 When TABLE is non-nil, return an alist that can directly be used for
15764 completion."
15765 (let (vals)
15766 (cond
15767 ((equal property "TODO")
15768 (setq vals (org-with-point-at pom
15769 (append org-todo-keywords-1 '("")))))
15770 ((equal property "PRIORITY")
15771 (let ((n org-lowest-priority))
15772 (while (>= n org-highest-priority)
15773 (push (char-to-string n) vals)
15774 (setq n (1- n)))))
15775 ((member property org-special-properties))
15776 ((setq vals (run-hook-with-args-until-success
15777 'org-property-allowed-value-functions property)))
15778 (t
15779 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15781 (setq vals (car (read-from-string (concat "(" vals ")"))))
15782 (setq vals (mapcar (lambda (x)
15783 (cond ((stringp x) x)
15784 ((numberp x) (number-to-string x))
15785 ((symbolp x) (symbol-name x))
15786 (t "???")))
15787 vals)))))
15788 (when (member ":ETC" vals)
15789 (setq vals (remove ":ETC" vals))
15790 (org-add-props (car vals) '(org-unrestricted t)))
15791 (if table (mapcar 'list vals) vals)))
15793 (defun org-property-previous-allowed-value (&optional previous)
15794 "Switch to the next allowed value for this property."
15795 (interactive)
15796 (org-property-next-allowed-value t))
15798 (defun org-property-next-allowed-value (&optional previous)
15799 "Switch to the next allowed value for this property."
15800 (interactive)
15801 (unless (org-at-property-p)
15802 (error "Not at a property"))
15803 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15804 (key (match-string 2))
15805 (value (match-string 3))
15806 (allowed (or (org-property-get-allowed-values (point) key)
15807 (and (member value '("[ ]" "[-]" "[X]"))
15808 '("[ ]" "[X]"))))
15809 (heading (save-match-data (nth 4 (org-heading-components))))
15810 nval)
15811 (unless allowed
15812 (error "Allowed values for this property have not been defined"))
15813 (if previous (setq allowed (reverse allowed)))
15814 (if (member value allowed)
15815 (setq nval (car (cdr (member value allowed)))))
15816 (setq nval (or nval (car allowed)))
15817 (if (equal nval value)
15818 (error "Only one allowed value for this property"))
15819 (org-at-property-p)
15820 (replace-match (concat " :" key ": " nval) t t)
15821 (org-indent-line)
15822 (beginning-of-line 1)
15824 (when (equal prop org-effort-property)
15825 (save-excursion
15826 (org-back-to-heading t)
15827 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15828 (when (string= org-clock-current-task heading)
15829 (setq org-clock-effort nval)
15830 (org-clock-update-mode-line)))
15831 (run-hook-with-args 'org-property-changed-functions key nval)))
15833 (defun org-find-olp (path &optional this-buffer)
15834 "Return a marker pointing to the entry at outline path OLP.
15835 If anything goes wrong, throw an error.
15836 You can wrap this call to catch the error like this:
15838 (condition-case msg
15839 (org-mobile-locate-entry (match-string 4))
15840 (error (nth 1 msg)))
15842 The return value will then be either a string with the error message,
15843 or a marker if everything is OK.
15845 If THIS-BUFFER is set, the outline path does not contain a file,
15846 only headings."
15847 (let* ((file (if this-buffer buffer-file-name (pop path)))
15848 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15849 (level 1)
15850 (lmin 1)
15851 (lmax 1)
15852 limit re end found pos heading cnt flevel)
15853 (unless buffer (error "File not found :%s" file))
15854 (with-current-buffer buffer
15855 (save-excursion
15856 (save-restriction
15857 (widen)
15858 (setq limit (point-max))
15859 (goto-char (point-min))
15860 (while (setq heading (pop path))
15861 (setq re (format org-complex-heading-regexp-format
15862 (regexp-quote heading)))
15863 (setq cnt 0 pos (point))
15864 (while (re-search-forward re end t)
15865 (setq level (- (match-end 1) (match-beginning 1)))
15866 (if (and (>= level lmin) (<= level lmax))
15867 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15868 (when (= cnt 0) (error "Heading not found on level %d: %s"
15869 lmax heading))
15870 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15871 lmax heading))
15872 (goto-char found)
15873 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15874 (setq end (save-excursion (org-end-of-subtree t t))))
15875 (when (org-at-heading-p)
15876 (point-marker)))))))
15878 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15879 "Find node HEADING in BUFFER.
15880 Return a marker to the heading if it was found, or nil if not.
15881 If POS-ONLY is set, return just the position instead of a marker.
15883 The heading text must match exact, but it may have a TODO keyword,
15884 a priority cookie and tags in the standard locations."
15885 (with-current-buffer (or buffer (current-buffer))
15886 (save-excursion
15887 (save-restriction
15888 (widen)
15889 (goto-char (point-min))
15890 (let (case-fold-search)
15891 (if (re-search-forward
15892 (format org-complex-heading-regexp-format
15893 (regexp-quote heading)) nil t)
15894 (if pos-only
15895 (match-beginning 0)
15896 (move-marker (make-marker) (match-beginning 0)))))))))
15898 (defun org-find-exact-heading-in-directory (heading &optional dir)
15899 "Find Org node headline HEADING in all .org files in directory DIR.
15900 When the target headline is found, return a marker to this location."
15901 (let ((files (directory-files (or dir default-directory)
15903 file visiting m buffer)
15904 (catch 'found
15905 (while (setq file (pop files))
15906 (message "trying %s" file)
15907 (setq visiting (org-find-base-buffer-visiting file))
15908 (setq buffer (or visiting (find-file-noselect file)))
15909 (setq m (org-find-exact-headline-in-buffer
15910 heading buffer))
15911 (when (and (not m) (not visiting)) (kill-buffer buffer))
15912 (and m (throw 'found m))))))
15914 (defun org-find-entry-with-id (ident)
15915 "Locate the entry that contains the ID property with exact value IDENT.
15916 IDENT can be a string, a symbol or a number, this function will search for
15917 the string representation of it.
15918 Return the position where this entry starts, or nil if there is no such entry."
15919 (interactive "sID: ")
15920 (let ((id (cond
15921 ((stringp ident) ident)
15922 ((symbol-name ident) (symbol-name ident))
15923 ((numberp ident) (number-to-string ident))
15924 (t (error "IDENT %s must be a string, symbol or number" ident))))
15925 (case-fold-search nil))
15926 (save-excursion
15927 (save-restriction
15928 (widen)
15929 (goto-char (point-min))
15930 (when (re-search-forward
15932 nil t)
15933 (org-back-to-heading t)
15934 (point))))))
15936 ;;;; Timestamps
15938 (defvar org-last-changed-timestamp nil)
15939 (defvar org-last-inserted-timestamp nil
15940 "The last time stamp inserted with `org-insert-time-stamp'.")
15941 (defvar org-time-was-given) ; dynamically scoped parameter
15942 (defvar org-end-time-was-given) ; dynamically scoped parameter
15943 (defvar org-ts-what) ; dynamically scoped parameter
15945 (defun org-time-stamp (arg &optional inactive)
15946 "Prompt for a date/time and insert a time stamp.
15947 If the user specifies a time like HH:MM or if this command is
15948 called with at least one prefix argument, the time stamp contains
15949 the date and the time. Otherwise, only the date is be included.
15951 All parts of a date not specified by the user is filled in from
15952 the current date/time. So if you just press return without
15953 typing anything, the time stamp will represent the current
15954 date/time.
15956 If there is already a timestamp at the cursor, it will be
15957 modified.
15959 With two universal prefix arguments, insert an active timestamp
15960 with the current time without prompting the user."
15961 (interactive "P")
15962 (let* ((ts nil)
15963 (default-time
15964 ;; Default time is either today, or, when entering a range,
15965 ;; the range start.
15966 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15967 (save-excursion
15968 (re-search-backward
15970 (- (point) 20) t)))
15971 (apply 'encode-time (org-parse-time-string (match-string 1)))
15972 (current-time)))
15973 (default-input (and ts (org-get-compact-tod ts)))
15974 (repeater (save-excursion
15975 (save-match-data
15976 (beginning-of-line)
15977 (when (re-search-forward
15979 (save-excursion (progn (end-of-line) (point))) t)
15980 (match-string 0)))))
15981 org-time-was-given org-end-time-was-given time)
15982 (cond
15983 ((and (org-at-timestamp-p t)
15984 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15985 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15986 (insert "--")
15987 (setq time (let ((this-command this-command))
15988 (org-read-date arg 'totime nil nil
15989 default-time default-input inactive)))
15990 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15991 ((org-at-timestamp-p t)
15992 (setq time (let ((this-command this-command))
15993 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15994 (when (org-at-timestamp-p t) ; just to get the match data
15995 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15996 (replace-match "")
15997 (setq org-last-changed-timestamp
15998 (org-insert-time-stamp
15999 time (or org-time-was-given arg)
16000 inactive nil nil (list org-end-time-was-given)))
16001 (when repeater (goto-char (1- (point))) (insert " " repeater)
16002 (setq org-last-changed-timestamp
16003 (concat (substring org-last-inserted-timestamp 0 -1)
16004 " " repeater ">"))))
16005 (message "Timestamp updated"))
16006 ((equal arg '(16))
16007 (org-insert-time-stamp (current-time) t))
16008 (t
16009 (setq time (let ((this-command this-command))
16010 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16011 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16012 nil nil (list org-end-time-was-given))))))
16014 ;; FIXME: can we use this for something else, like computing time differences?
16015 (defun org-get-compact-tod (s)
16016 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16017 (let* ((t1 (match-string 1 s))
16018 (h1 (string-to-number (match-string 2 s)))
16019 (m1 (string-to-number (match-string 3 s)))
16020 (t2 (and (match-end 4) (match-string 5 s)))
16021 (h2 (and t2 (string-to-number (match-string 6 s))))
16022 (m2 (and t2 (string-to-number (match-string 7 s))))
16023 dh dm)
16024 (if (not t2)
16025 t1
16026 (setq dh (- h2 h1) dm (- m2 m1))
16027 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16028 (concat t1 "+" (number-to-string dh)
16029 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
16031 (defun org-time-stamp-inactive (&optional arg)
16032 "Insert an inactive time stamp.
16033 An inactive time stamp is enclosed in square brackets instead of angle
16034 brackets. It is inactive in the sense that it does not trigger agenda entries,
16035 does not link to the calendar and cannot be changed with the S-cursor keys.
16036 So these are more for recording a certain time/date."
16037 (interactive "P")
16038 (org-time-stamp arg 'inactive))
16040 (defvar org-date-ovl (make-overlay 1 1))
16041 (overlay-put org-date-ovl 'face 'org-date-selected)
16042 (org-detach-overlay org-date-ovl)
16044 (defvar org-ans1) ; dynamically scoped parameter
16045 (defvar org-ans2) ; dynamically scoped parameter
16047 (defvar org-plain-time-of-day-regexp) ; defined below
16049 (defvar org-overriding-default-time nil) ; dynamically scoped
16050 (defvar org-read-date-overlay nil)
16051 (defvar org-dcst nil) ; dynamically scoped
16052 (defvar org-read-date-history nil)
16053 (defvar org-read-date-final-answer nil)
16054 (defvar org-read-date-analyze-futurep nil)
16055 (defvar org-read-date-analyze-forced-year nil)
16056 (defvar org-read-date-inactive)
16058 (defvar org-read-date-minibuffer-local-map
16059 (let ((map (make-sparse-keymap)))
16060 (set-keymap-parent map minibuffer-local-map)
16061 (org-defkey map (kbd ".")
16062 (lambda () (interactive)
16063 (org-eval-in-calendar '(calendar-goto-today))))
16064 (org-defkey map [(meta shift left)]
16065 (lambda () (interactive)
16066 (org-eval-in-calendar '(calendar-backward-month 1))))
16067 (org-defkey map [(meta shift right)]
16068 (lambda () (interactive)
16069 (org-eval-in-calendar '(calendar-forward-month 1))))
16070 (org-defkey map [(meta shift up)]
16071 (lambda () (interactive)
16072 (org-eval-in-calendar '(calendar-backward-year 1))))
16073 (org-defkey map [(meta shift down)]
16074 (lambda () (interactive)
16075 (org-eval-in-calendar '(calendar-forward-year 1))))
16076 (org-defkey map [?\e (shift left)]
16077 (lambda () (interactive)
16078 (org-eval-in-calendar '(calendar-backward-month 1))))
16079 (org-defkey map [?\e (shift right)]
16080 (lambda () (interactive)
16081 (org-eval-in-calendar '(calendar-forward-month 1))))
16082 (org-defkey map [?\e (shift up)]
16083 (lambda () (interactive)
16084 (org-eval-in-calendar '(calendar-backward-year 1))))
16085 (org-defkey map [?\e (shift down)]
16086 (lambda () (interactive)
16087 (org-eval-in-calendar '(calendar-forward-year 1))))
16088 (org-defkey map [(shift up)]
16089 (lambda () (interactive)
16090 (org-eval-in-calendar '(calendar-backward-week 1))))
16091 (org-defkey map [(shift down)]
16092 (lambda () (interactive)
16093 (org-eval-in-calendar '(calendar-forward-week 1))))
16094 (org-defkey map [(shift left)]
16095 (lambda () (interactive)
16096 (org-eval-in-calendar '(calendar-backward-day 1))))
16097 (org-defkey map [(shift right)]
16098 (lambda () (interactive)
16099 (org-eval-in-calendar '(calendar-forward-day 1))))
16100 (org-defkey map "!"
16101 (lambda () (interactive)
16102 (org-eval-in-calendar '(diary-view-entries))
16103 (message "")))
16104 (org-defkey map ">"
16105 (lambda () (interactive)
16106 (org-eval-in-calendar '(scroll-calendar-left 1))))
16107 (org-defkey map "<"
16108 (lambda () (interactive)
16109 (org-eval-in-calendar '(scroll-calendar-right 1))))
16110 (org-defkey map "\C-v"
16111 (lambda () (interactive)
16112 (org-eval-in-calendar
16113 '(calendar-scroll-left-three-months 1))))
16114 (org-defkey map "\M-v"
16115 (lambda () (interactive)
16116 (org-eval-in-calendar
16117 '(calendar-scroll-right-three-months 1))))
16118 map)
16119 "Keymap for minibuffer commands when using `org-read-date'.")
16121 (defun org-read-date (&optional org-with-time to-time from-string prompt
16122 default-time default-input inactive)
16123 "Read a date, possibly a time, and make things smooth for the user.
16124 The prompt will suggest to enter an ISO date, but you can also enter anything
16125 which will at least partially be understood by `parse-time-string'.
16126 Unrecognized parts of the date will default to the current day, month, year,
16127 hour and minute. If this command is called to replace a timestamp at point,
16128 or to enter the second timestamp of a range, the default time is taken
16129 from the existing stamp. Furthermore, the command prefers the future,
16130 so if you are giving a date where the year is not given, and the day-month
16131 combination is already past in the current year, it will assume you
16132 mean next year. For details, see the manual. A few examples:
16134 3-2-5 --> 2003-02-05
16135 feb 15 --> currentyear-02-15
16136 2/15 --> currentyear-02-15
16137 sep 12 9 --> 2009-09-12
16138 12:45 --> today 12:45
16139 22 sept 0:34 --> currentyear-09-22 0:34
16140 12 --> currentyear-currentmonth-12
16141 Fri --> nearest Friday after today
16142 -Tue --> last Tuesday
16143 etc.
16145 Furthermore you can specify a relative date by giving, as the *first* thing
16146 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16147 change in days weeks, months, years.
16148 With a single plus or minus, the date is relative to today. With a double
16149 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16150 +4d --> four days from today
16151 +4 --> same as above
16152 +2w --> two weeks from today
16153 ++5 --> five days from default date
16155 The function understands only English month and weekday abbreviations.
16157 While prompting, a calendar is popped up - you can also select the
16158 date with the mouse (button 1). The calendar shows a period of three
16159 months. To scroll it to other months, use the keys `>' and `<'.
16160 If you don't like the calendar, turn it off with
16161 \(setq org-read-date-popup-calendar nil)
16163 With optional argument TO-TIME, the date will immediately be converted
16164 to an internal time.
16165 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16166 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16167 still enter a time, and this function will inform the calling routine
16168 about this change. The calling routine may then choose to change the
16169 format used to insert the time stamp into the buffer to include the time.
16170 With optional argument FROM-STRING, read from this string instead from
16171 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16172 the time/date that is used for everything that is not specified by the
16173 user."
16174 (require 'parse-time)
16175 (let* ((org-time-stamp-rounding-minutes
16176 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16177 (org-dcst org-display-custom-times)
16178 (ct (org-current-time))
16179 (org-def (or org-overriding-default-time default-time ct))
16180 (org-defdecode (decode-time org-def))
16181 (dummy (progn
16182 (when (< (nth 2 org-defdecode) org-extend-today-until)
16183 (setcar (nthcdr 2 org-defdecode) -1)
16184 (setcar (nthcdr 1 org-defdecode) 59)
16185 (setq org-def (apply 'encode-time org-defdecode)
16186 org-defdecode (decode-time org-def)))))
16187 (mouse-autoselect-window nil) ; Don't let the mouse jump
16188 (calendar-frame-setup nil)
16189 (calendar-setup nil)
16190 (calendar-move-hook nil)
16191 (calendar-view-diary-initially-flag nil)
16192 (calendar-view-holidays-initially-flag nil)
16193 (timestr (format-time-string
16194 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16195 (prompt (concat (if prompt (concat prompt " ") "")
16196 (format "Date+time [%s]: " timestr)))
16197 ans (org-ans0 "") org-ans1 org-ans2 final)
16199 (cond
16200 (from-string (setq ans from-string))
16201 (org-read-date-popup-calendar
16202 (save-excursion
16203 (save-window-excursion
16204 (calendar)
16205 (org-eval-in-calendar '(setq cursor-type nil) t)
16206 (unwind-protect
16207 (progn
16208 (calendar-forward-day (- (time-to-days org-def)
16209 (calendar-absolute-from-gregorian
16210 (calendar-current-date))))
16211 (org-eval-in-calendar nil t)
16212 (let* ((old-map (current-local-map))
16213 (map (copy-keymap calendar-mode-map))
16214 (minibuffer-local-map
16215 (copy-keymap org-read-date-minibuffer-local-map)))
16216 (org-defkey map (kbd "RET") 'org-calendar-select)
16217 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16218 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16219 (unwind-protect
16220 (progn
16221 (use-local-map map)
16222 (setq org-read-date-inactive inactive)
16223 (add-hook 'post-command-hook 'org-read-date-display)
16224 (setq org-ans0 (read-string prompt default-input
16225 'org-read-date-history nil))
16226 ;; org-ans0: from prompt
16227 ;; org-ans1: from mouse click
16228 ;; org-ans2: from calendar motion
16229 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16230 (remove-hook 'post-command-hook 'org-read-date-display)
16231 (use-local-map old-map)
16232 (when org-read-date-overlay
16233 (delete-overlay org-read-date-overlay)
16234 (setq org-read-date-overlay nil)))))
16235 (bury-buffer "*Calendar*")))))
16237 (t ; Naked prompt only
16238 (unwind-protect
16239 (setq ans (read-string prompt default-input
16240 'org-read-date-history timestr))
16241 (when org-read-date-overlay
16242 (delete-overlay org-read-date-overlay)
16243 (setq org-read-date-overlay nil)))))
16245 (setq final (org-read-date-analyze ans org-def org-defdecode))
16247 (when org-read-date-analyze-forced-year
16248 (message "Year was forced into %s"
16249 (if org-read-date-force-compatible-dates
16250 "compatible range (1970-2037)"
16251 "range representable on this machine"))
16252 (ding))
16254 ;; One round trip to get rid of 34th of August and stuff like that....
16255 (setq final (decode-time (apply 'encode-time final)))
16257 (setq org-read-date-final-answer ans)
16259 (if to-time
16260 (apply 'encode-time final)
16261 (if (and (boundp 'org-time-was-given) org-time-was-given)
16262 (format "%04d-%02d-%02d %02d:%02d"
16263 (nth 5 final) (nth 4 final) (nth 3 final)
16264 (nth 2 final) (nth 1 final))
16265 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16267 (defvar org-def)
16268 (defvar org-defdecode)
16269 (defvar org-with-time)
16270 (defun org-read-date-display ()
16271 "Display the current date prompt interpretation in the minibuffer."
16272 (when org-read-date-display-live
16273 (when org-read-date-overlay
16274 (delete-overlay org-read-date-overlay))
16275 (when (minibufferp (current-buffer))
16276 (save-excursion
16277 (end-of-line 1)
16278 (while (not (equal (buffer-substring
16279 (max (point-min) (- (point) 4)) (point))
16280 " "))
16281 (insert " ")))
16282 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16283 " " (or org-ans1 org-ans2)))
16284 (org-end-time-was-given nil)
16285 (f (org-read-date-analyze ans org-def org-defdecode))
16286 (fmts (if org-dcst
16287 org-time-stamp-custom-formats
16288 org-time-stamp-formats))
16289 (fmt (if (or org-with-time
16290 (and (boundp 'org-time-was-given) org-time-was-given))
16291 (cdr fmts)
16292 (car fmts)))
16293 (txt (format-time-string fmt (apply 'encode-time f)))
16294 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16295 (txt (concat "=> " txt)))
16296 (when (and org-end-time-was-given
16297 (string-match org-plain-time-of-day-regexp txt))
16298 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16299 org-end-time-was-given
16300 (substring txt (match-end 0)))))
16301 (when org-read-date-analyze-futurep
16302 (setq txt (concat txt " (=>F)")))
16303 (setq org-read-date-overlay
16304 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16305 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16307 (defun org-read-date-analyze (ans org-def org-defdecode)
16308 "Analyze the combined answer of the date prompt."
16309 ;; FIXME: cleanup and comment
16310 (let ((nowdecode (decode-time (current-time)))
16311 delta deltan deltaw deltadef year month day
16312 hour minute second wday pm h2 m2 tl wday1
16313 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16314 (setq org-read-date-analyze-futurep nil
16315 org-read-date-analyze-forced-year nil)
16317 (setq ans "+0"))
16319 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16320 (setq ans (replace-match "" t t ans)
16321 deltan (car delta)
16322 deltaw (nth 1 delta)
16323 deltadef (nth 2 delta)))
16325 ;; Check if there is an iso week date in there. If yes, store the
16326 ;; info and postpone interpreting it until the rest of the parsing
16327 ;; is done.
16328 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16329 (setq iso-year (if (match-end 1)
16330 (org-small-year-to-year
16331 (string-to-number (match-string 1 ans))))
16332 iso-weekday (if (match-end 3)
16333 (string-to-number (match-string 3 ans)))
16334 iso-week (string-to-number (match-string 2 ans)))
16335 (setq ans (replace-match "" t t ans)))
16337 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16338 (when (string-match
16340 (setq year (if (match-end 2)
16341 (string-to-number (match-string 2 ans))
16342 (progn (setq kill-year t)
16343 (string-to-number (format-time-string "%Y"))))
16344 month (string-to-number (match-string 3 ans))
16345 day (string-to-number (match-string 4 ans)))
16346 (if (< year 100) (setq year (+ 2000 year)))
16348 t nil ans)))
16350 ;; Help matching dotted european dates
16351 (when (string-match
16352 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16353 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16354 (setq kill-year t)
16355 (string-to-number (format-time-string "%Y")))
16356 day (string-to-number (match-string 1 ans))
16357 month (string-to-number (match-string 2 ans))
16358 ans (replace-match (format "%04d-%02d-%02d" year month day)
16359 t nil ans)))
16361 ;; Help matching american dates, like 5/30 or 5/30/7
16362 (when (string-match
16363 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16364 (setq year (if (match-end 4)
16365 (string-to-number (match-string 4 ans))
16366 (progn (setq kill-year t)
16367 (string-to-number (format-time-string "%Y"))))
16368 month (string-to-number (match-string 1 ans))
16369 day (string-to-number (match-string 2 ans)))
16370 (if (< year 100) (setq year (+ 2000 year)))
16372 t nil ans)))
16373 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16374 ;; If there is a time with am/pm, and *no* time without it, we convert
16375 ;; so that matching will be successful.
16376 (loop for i from 1 to 2 do ; twice, for end time as well
16379 (setq hour (string-to-number (match-string 1 ans))
16380 minute (if (match-end 3)
16381 (string-to-number (match-string 3 ans))
16382 0)
16383 pm (equal ?p
16384 (string-to-char (downcase (match-string 4 ans)))))
16385 (if (and (= hour 12) (not pm))
16386 (setq hour 0)
16387 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16388 (setq ans (replace-match (format "%02d:%02d" hour minute)
16389 t t ans))))
16391 ;; Check if a time range is given as a duration
16392 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16393 (setq hour (string-to-number (match-string 1 ans))
16394 h2 (+ hour (string-to-number (match-string 3 ans)))
16395 minute (string-to-number (match-string 2 ans))
16396 m2 (+ minute (if (match-end 5) (string-to-number
16397 (match-string 5 ans))0)))
16398 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16399 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16400 t t ans)))
16402 ;; Check if there is a time range
16403 (when (boundp 'org-end-time-was-given)
16404 (setq org-time-was-given nil)
16405 (when (and (string-match org-plain-time-of-day-regexp ans)
16406 (match-end 8))
16407 (setq org-end-time-was-given (match-string 8 ans))
16408 (setq ans (concat (substring ans 0 (match-beginning 7))
16409 (substring ans (match-end 7))))))
16411 (setq tl (parse-time-string ans)
16412 day (or (nth 3 tl) (nth 3 org-defdecode))
16413 month (or (nth 4 tl)
16414 (if (and org-read-date-prefer-future
16415 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16416 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16417 (nth 4 org-defdecode)))
16418 year (or (and (not kill-year) (nth 5 tl))
16419 (if (and org-read-date-prefer-future
16420 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16421 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16422 (nth 5 org-defdecode)))
16423 hour (or (nth 2 tl) (nth 2 org-defdecode))
16424 minute (or (nth 1 tl) (nth 1 org-defdecode))
16425 second (or (nth 0 tl) 0)
16426 wday (nth 6 tl))
16428 (when (and (eq org-read-date-prefer-future 'time)
16429 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16430 (equal day (nth 3 nowdecode))
16431 (equal month (nth 4 nowdecode))
16432 (equal year (nth 5 nowdecode))
16433 (nth 2 tl)
16434 (or (< (nth 2 tl) (nth 2 nowdecode))
16435 (and (= (nth 2 tl) (nth 2 nowdecode))
16436 (nth 1 tl)
16437 (< (nth 1 tl) (nth 1 nowdecode)))))
16438 (setq day (1+ day)
16439 futurep t))
16441 ;; Special date definitions below
16442 (cond
16443 (iso-week
16444 ;; There was an iso week
16445 (require 'cal-iso)
16446 (setq futurep nil)
16447 (setq year (or iso-year year)
16448 day (or iso-weekday wday 1)
16449 wday nil ; to make sure that the trigger below does not match
16450 iso-date (calendar-gregorian-from-absolute
16451 (calendar-absolute-from-iso
16452 (list iso-week day year))))
16453 ; FIXME: Should we also push ISO weeks into the future?
16454 ; (when (and org-read-date-prefer-future
16455 ; (not iso-year)
16456 ; (< (calendar-absolute-from-gregorian iso-date)
16457 ; (time-to-days (current-time))))
16458 ; (setq year (1+ year)
16459 ; iso-date (calendar-gregorian-from-absolute
16460 ; (calendar-absolute-from-iso
16461 ; (list iso-week day year)))))
16462 (setq month (car iso-date)
16463 year (nth 2 iso-date)
16464 day (nth 1 iso-date)))
16465 (deltan
16466 (setq futurep nil)
16467 (unless deltadef
16468 (let ((now (decode-time (current-time))))
16469 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16470 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16471 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16472 ((equal deltaw "m") (setq month (+ month deltan)))
16473 ((equal deltaw "y") (setq year (+ year deltan)))))
16474 ((and wday (not (nth 3 tl)))
16475 ;; Weekday was given, but no day, so pick that day in the week
16476 ;; on or after the derived date.
16477 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16478 (unless (equal wday wday1)
16479 (setq day (+ day (% (- wday wday1 -7) 7))))))
16480 (if (and (boundp 'org-time-was-given)
16481 (nth 2 tl))
16482 (setq org-time-was-given t))
16483 (if (< year 100) (setq year (+ 2000 year)))
16484 ;; Check of the date is representable
16485 (if org-read-date-force-compatible-dates
16486 (progn
16487 (if (< year 1970)
16488 (setq year 1970 org-read-date-analyze-forced-year t))
16489 (if (> year 2037)
16490 (setq year 2037 org-read-date-analyze-forced-year t)))
16491 (condition-case nil
16492 (ignore (encode-time second minute hour day month year))
16493 (error
16494 (setq year (nth 5 org-defdecode))
16495 (setq org-read-date-analyze-forced-year t))))
16496 (setq org-read-date-analyze-futurep futurep)
16497 (list second minute hour day month year)))
16499 (defvar parse-time-weekdays)
16500 (defun org-read-date-get-relative (s today default)
16501 "Check string S for special relative date string.
16502 TODAY and DEFAULT are internal times, for today and for a default.
16503 Return shift list (N what def-flag)
16505 N is the number of WHATs to shift.
16506 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16507 the DEFAULT date rather than TODAY."
16508 (require 'parse-time)
16509 (when (and
16510 (string-match
16511 (concat
16516 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16517 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16518 (string-to-char (substring (match-string 1 s) -1))
16519 ?+))
16520 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16521 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16522 (what (if (match-end 3) (match-string 3 s) "d"))
16523 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16524 (date (if rel default today))
16525 (wday (nth 6 (decode-time date)))
16526 delta)
16527 (if wday1
16528 (progn
16529 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16530 (if (= delta 0) (setq delta 7))
16531 (if (= dir ?-)
16532 (progn
16533 (setq delta (- delta 7))
16534 (if (= delta 0) (setq delta -7))))
16535 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16536 (list delta "d" rel))
16537 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16539 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16540 "Turn a user-specified date into the internal representation.
16541 The internal representation needed by the calendar is (month day year).
16542 This is a wrapper to handle the brain-dead convention in calendar that
16543 user function argument order change dependent on argument order."
16544 (if (boundp 'calendar-date-style)
16545 (cond
16546 ((eq calendar-date-style 'american)
16547 (list arg1 arg2 arg3))
16548 ((eq calendar-date-style 'european)
16549 (list arg2 arg1 arg3))
16550 ((eq calendar-date-style 'iso)
16551 (list arg2 arg3 arg1)))
16552 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16553 (if (org-bound-and-true-p european-calendar-style)
16554 (list arg2 arg1 arg3)
16555 (list arg1 arg2 arg3)))))
16557 (defun org-eval-in-calendar (form &optional keepdate)
16558 "Eval FORM in the calendar window and return to current window.
16559 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16560 otherwise stick to the current value of `org-ans2'."
16561 (let ((sf (selected-frame))
16562 (sw (selected-window)))
16563 (select-window (get-buffer-window "*Calendar*" t))
16564 (eval form)
16565 (when (and (not keepdate) (calendar-cursor-to-date))
16566 (let* ((date (calendar-cursor-to-date))
16567 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16568 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16569 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16570 (select-window sw)
16571 (org-select-frame-set-input-focus sf)))
16573 (defun org-calendar-select ()
16574 "Return to `org-read-date' with the date currently selected.
16575 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16576 (interactive)
16577 (when (calendar-cursor-to-date)
16578 (let* ((date (calendar-cursor-to-date))
16579 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16580 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16581 (if (active-minibuffer-window) (exit-minibuffer))))
16583 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16584 "Insert a date stamp for the date given by the internal TIME.
16585 WITH-HM means use the stamp format that includes the time of the day.
16586 INACTIVE means use square brackets instead of angular ones, so that the
16587 stamp will not contribute to the agenda.
16588 PRE and POST are optional strings to be inserted before and after the
16589 stamp.
16590 The command returns the inserted time stamp."
16591 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16592 stamp)
16593 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16594 (insert-before-markers (or pre ""))
16595 (when (listp extra)
16596 (setq extra (car extra))
16597 (if (and (stringp extra)
16599 (setq extra (format "-%02d:%02d"
16600 (string-to-number (match-string 1 extra))
16601 (string-to-number (match-string 2 extra))))
16602 (setq extra nil)))
16603 (when extra
16604 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16605 (insert-before-markers (setq stamp (format-time-string fmt time)))
16606 (insert-before-markers (or post ""))
16607 (setq org-last-inserted-timestamp stamp)))
16609 (defun org-toggle-time-stamp-overlays ()
16610 "Toggle the use of custom time stamp formats."
16611 (interactive)
16612 (setq org-display-custom-times (not org-display-custom-times))
16613 (unless org-display-custom-times
16614 (let ((p (point-min)) (bmp (buffer-modified-p)))
16615 (while (setq p (next-single-property-change p 'display))
16616 (if (and (get-text-property p 'display)
16617 (eq (get-text-property p 'face) 'org-date))
16618 (remove-text-properties
16619 p (setq p (next-single-property-change p 'display))
16620 '(display t))))
16621 (set-buffer-modified-p bmp)))
16622 (if (featurep 'xemacs)
16623 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16624 (org-restart-font-lock)
16625 (setq org-table-may-need-update t)
16626 (if org-display-custom-times
16627 (message "Time stamps are overlaid with custom format")
16628 (message "Time stamp overlays removed")))
16630 (defun org-display-custom-time (beg end)
16631 "Overlay modified time stamp format over timestamp between BEG and END."
16632 (let* ((ts (buffer-substring beg end))
16633 t1 w1 with-hm tf time str w2 (off 0))
16634 (save-match-data
16635 (setq t1 (org-parse-time-string ts t))
16636 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16637 (setq off (- (match-end 0) (match-beginning 0)))))
16638 (setq end (- end off))
16639 (setq w1 (- end beg)
16640 with-hm (and (nth 1 t1) (nth 2 t1))
16641 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16642 time (org-fix-decoded-time t1)
16643 str (org-add-props
16644 (format-time-string
16645 (substring tf 1 -1) (apply 'encode-time time))
16646 nil 'mouse-face 'highlight)
16647 w2 (length str))
16648 (if (not (= w2 w1))
16649 (add-text-properties (1+ beg) (+ 2 beg)
16650 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16651 (if (featurep 'xemacs)
16652 (progn
16653 (put-text-property beg end 'invisible t)
16654 (put-text-property beg end 'end-glyph (make-glyph str)))
16655 (put-text-property beg end 'display str))))
16657 (defun org-translate-time (string)
16658 "Translate all timestamps in STRING to custom format.
16659 But do this only if the variable `org-display-custom-times' is set."
16660 (when org-display-custom-times
16661 (save-match-data
16662 (let* ((start 0)
16663 (re org-ts-regexp-both)
16664 t1 with-hm inactive tf time str beg end)
16665 (while (setq start (string-match re string start))
16666 (setq beg (match-beginning 0)
16667 end (match-end 0)
16668 t1 (save-match-data
16669 (org-parse-time-string (substring string beg end) t))
16670 with-hm (and (nth 1 t1) (nth 2 t1))
16671 inactive (equal (substring string beg (1+ beg)) "[")
16672 tf (funcall (if with-hm 'cdr 'car)
16673 org-time-stamp-custom-formats)
16674 time (org-fix-decoded-time t1)
16675 str (format-time-string
16676 (concat
16677 (if inactive "[" "<") (substring tf 1 -1)
16678 (if inactive "]" ">"))
16679 (apply 'encode-time time))
16680 string (replace-match str t t string)
16681 start (+ start (length str)))))))
16682 string)
16684 (defun org-fix-decoded-time (time)
16685 "Set 0 instead of nil for the first 6 elements of time.
16686 Don't touch the rest."
16687 (let ((n 0))
16688 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16690 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16692 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16693 "Difference between TIMESTAMP-STRING and now in days.
16694 If SECONDS is non-nil, return the difference in seconds."
16695 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16696 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16697 (funcall fdiff (current-time)))))
16699 (defun org-deadline-close (timestamp-string &optional ndays)
16700 "Is the time in TIMESTAMP-STRING close to the current date?"
16701 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16702 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16703 (not (org-entry-is-done-p))))
16705 (defun org-get-wdays (ts &optional delay zero-delay)
16706 "Get the deadline lead time appropriate for timestring TS.
16707 When DELAY is non-nil, get the delay time for scheduled items
16708 instead of the deadline lead time. When ZERO-DELAY is non-nil
16709 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16710 don't try to find the delay cookie in the scheduled timestamp."
16711 (let ((tv (if delay org-scheduled-delay-days
16712 org-deadline-warning-days)))
16713 (cond
16714 ((or (and delay (< tv 0))
16715 (and delay zero-delay (<= tv 0))
16716 (and (not delay) (<= tv 0)))
16717 ;; Enforce this value no matter what
16718 (- tv))
16720 ;; lead time is specified.
16721 (floor (* (string-to-number (match-string 1 ts))
16722 (cdr (assoc (match-string 2 ts)
16723 '(("d" . 1) ("w" . 7)
16724 ("m" . 30.4) ("y" . 365.25)
16725 ("h" . 0.041667)))))))
16726 ;; go for the default.
16727 (t tv))))
16729 (defun org-calendar-select-mouse (ev)
16730 "Return to `org-read-date' with the date currently selected.
16731 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16732 (interactive "e")
16733 (mouse-set-point ev)
16734 (when (calendar-cursor-to-date)
16735 (let* ((date (calendar-cursor-to-date))
16736 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16737 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16738 (if (active-minibuffer-window) (exit-minibuffer))))
16740 (defun org-check-deadlines (ndays)
16741 "Check if there are any deadlines due or past due.
16742 A deadline is considered due if it happens within `org-deadline-warning-days'
16743 days from today's date. If the deadline appears in an entry marked DONE,
16744 it is not shown. The prefix arg NDAYS can be used to test that many
16746 (interactive "P")
16747 (let* ((org-warn-days
16748 (cond
16749 ((equal ndays '(4)) 100000)
16750 (ndays (prefix-numeric-value ndays))
16751 (t (abs org-deadline-warning-days))))
16752 (case-fold-search nil)
16754 (callback
16755 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16757 (message "%d deadlines past-due or due within %d days"
16758 (org-occur regexp nil callback)
16759 org-warn-days)))
16761 (defsubst org-re-timestamp (type)
16762 "Return a regexp for timestamp TYPE.
16763 Allowed values for TYPE are:
16765 all: all timestamps
16766 active: only active timestamps (<...>)
16767 inactive: only inactive timestamps ([...])
16768 scheduled: only scheduled timestamps
16769 deadline: only deadline timestamps
16770 closed: only closed time-stamps
16772 When TYPE is nil, fall back on returning a regexp that matches
16773 both scheduled and deadline timestamps."
16774 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16775 ((eq type 'active) org-ts-regexp)
16779 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16780 ((eq type 'scheduled-or-deadline)
16783 (defun org-check-before-date (date)
16784 "Check if there are deadlines or scheduled entries before DATE."
16785 (interactive (list (org-read-date)))
16786 (let ((case-fold-search nil)
16787 (regexp (org-re-timestamp org-ts-type))
16788 (callback
16789 (lambda () (time-less-p
16790 (org-time-string-to-time (match-string 1))
16791 (org-time-string-to-time date)))))
16792 (message "%d entries before %s"
16793 (org-occur regexp nil callback) date)))
16795 (defun org-check-after-date (date)
16796 "Check if there are deadlines or scheduled entries after DATE."
16797 (interactive (list (org-read-date)))
16798 (let ((case-fold-search nil)
16799 (regexp (org-re-timestamp org-ts-type))
16800 (callback
16801 (lambda () (not
16802 (time-less-p
16803 (org-time-string-to-time (match-string 1))
16804 (org-time-string-to-time date))))))
16805 (message "%d entries after %s"
16806 (org-occur regexp nil callback) date)))
16808 (defun org-check-dates-range (start-date end-date)
16809 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16810 (interactive (list (org-read-date nil nil nil "Range starts")
16811 (org-read-date nil nil nil "Range end")))
16812 (let ((case-fold-search nil)
16813 (regexp (org-re-timestamp org-ts-type))
16814 (callback
16815 (lambda ()
16816 (let ((match (match-string 1)))
16817 (and
16818 (not (time-less-p
16819 (org-time-string-to-time match)
16820 (org-time-string-to-time start-date)))
16821 (time-less-p
16822 (org-time-string-to-time match)
16823 (org-time-string-to-time end-date)))))))
16824 (message "%d entries between %s and %s"
16825 (org-occur regexp nil callback) start-date end-date)))
16827 (defun org-evaluate-time-range (&optional to-buffer)
16828 "Evaluate a time range by computing the difference between start and end.
16829 Normally the result is just printed in the echo area, but with prefix arg
16830 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16831 If the time range is actually in a table, the result is inserted into the
16832 next column.
16833 For time difference computation, a year is assumed to be exactly 365
16834 days in order to avoid rounding problems."
16835 (interactive "P")
16836 (or
16837 (org-clock-update-time-maybe)
16838 (save-excursion
16839 (unless (org-at-date-range-p t)
16840 (goto-char (point-at-bol))
16841 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16842 (if (not (org-at-date-range-p t))
16843 (error "Not at a time-stamp range, and none found in current line")))
16844 (let* ((ts1 (match-string 1))
16845 (ts2 (match-string 2))
16846 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16847 (match-end (match-end 0))
16848 (time1 (org-time-string-to-time ts1))
16849 (time2 (org-time-string-to-time ts2))
16850 (t1 (org-float-time time1))
16851 (t2 (org-float-time time2))
16852 (diff (abs (- t2 t1)))
16853 (negative (< (- t2 t1) 0))
16854 ;; (ys (floor (* 365 24 60 60)))
16855 (ds (* 24 60 60))
16856 (hs (* 60 60))
16857 (fy "%dy %dd %02d:%02d")
16858 (fy1 "%dy %dd")
16859 (fd "%dd %02d:%02d")
16860 (fd1 "%dd")
16861 (fh "%02d:%02d")
16862 y d h m align)
16863 (if havetime
16864 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16865 y 0
16866 d (floor (/ diff ds)) diff (mod diff ds)
16867 h (floor (/ diff hs)) diff (mod diff hs)
16868 m (floor (/ diff 60)))
16869 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16870 y 0
16871 d (floor (+ (/ diff ds) 0.5))
16872 h 0 m 0))
16873 (if (not to-buffer)
16874 (message "%s" (org-make-tdiff-string y d h m))
16875 (if (org-at-table-p)
16876 (progn
16877 (goto-char match-end)
16878 (setq align t)
16879 (and (looking-at " *|") (goto-char (match-end 0))))
16880 (goto-char match-end))
16881 (if (looking-at
16883 (replace-match ""))
16884 (if negative (insert " -"))
16885 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16886 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16887 (insert " " (format fh h m))))
16888 (if align (org-table-align))
16889 (message "Time difference inserted")))))
16891 (defun org-make-tdiff-string (y d h m)
16892 (let ((fmt "")
16893 (l nil))
16894 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16895 l (push y l)))
16896 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16897 l (push d l)))
16898 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16899 l (push h l)))
16900 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16901 l (push m l)))
16902 (apply 'format fmt (nreverse l))))
16904 (defun org-time-string-to-time (s &optional buffer pos)
16905 "Convert a timestamp string into internal time."
16906 (condition-case errdata
16907 (apply 'encode-time (org-parse-time-string s))
16909 s (if (not (and buffer pos))
16910 ""
16911 (format " at %d in buffer `%s'" pos buffer))
16912 (cdr errdata)))))
16914 (defun org-time-string-to-seconds (s)
16915 "Convert a timestamp string to a number of seconds."
16916 (org-float-time (org-time-string-to-time s)))
16918 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16919 "Convert a time stamp to an absolute day number.
16920 If there is a specifier for a cyclic time stamp, get the closest
16921 date to DAYNR.
16922 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16923 The variable `date' is bound by the calendar when this is called."
16924 (cond
16926 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16927 daynr
16928 (+ daynr 1000)))
16930 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16931 (time-to-days (current-time))) (match-string 0 s)
16932 prefer show-all))
16933 (t (time-to-days
16934 (condition-case errdata
16935 (apply 'encode-time (org-parse-time-string s))
16937 s (if (not (and buffer pos))
16938 ""
16939 (format " at %d in buffer `%s'" pos buffer))
16940 (cdr errdata))))))))
16942 (defun org-days-to-iso-week (days)
16943 "Return the iso week number."
16944 (require 'cal-iso)
16945 (car (calendar-iso-from-absolute days)))
16947 (defun org-small-year-to-year (year)
16948 "Convert 2-digit years into 4-digit years.
16949 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16950 The year 2000 cannot be abbreviated. Any year larger than 99
16951 is returned unchanged."
16952 (if (< year 38)
16953 (setq year (+ 2000 year))
16954 (if (< year 100)
16955 (setq year (+ 1900 year))))
16956 year)
16958 (defun org-time-from-absolute (d)
16959 "Return the time corresponding to date D.
16960 D may be an absolute day number, or a calendar-type list (month day year)."
16961 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16962 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16964 (defun org-calendar-holiday ()
16965 "List of holidays, for Diary display in Org-mode."
16966 (require 'holidays)
16967 (let ((hl (funcall
16968 (if (fboundp 'calendar-check-holidays)
16969 'calendar-check-holidays 'check-calendar-holidays) date)))
16970 (if hl (mapconcat 'identity hl "; "))))
16972 (defun org-diary-sexp-entry (sexp entry date)
16973 "Process a SEXP diary ENTRY for DATE."
16974 (require 'diary-lib)
16975 (let ((result (if calendar-debug-sexp
16976 (let ((stack-trace-on-error t))
16977 (eval (car (read-from-string sexp))))
16978 (condition-case nil
16979 (eval (car (read-from-string sexp)))
16980 (error
16981 (beep)
16982 (message "Bad sexp at line %d in %s: %s"
16983 (org-current-line)
16984 (buffer-file-name) sexp)
16985 (sleep-for 2))))))
16986 (cond ((stringp result) (split-string result "; "))
16987 ((and (consp result)
16988 (not (consp (cdr result)))
16989 (stringp (cdr result))) (cdr result))
16990 ((and (consp result)
16991 (stringp (car result))) result)
16992 (result entry))))
16994 (defun org-diary-to-ical-string (frombuf)
16995 "Get iCalendar entries from diary entries in buffer FROMBUF.
16996 This uses the icalendar.el library."
16997 (let* ((tmpdir (if (featurep 'xemacs)
16998 (temp-directory)
16999 temporary-file-directory))
17000 (tmpfile (make-temp-name
17001 (expand-file-name "orgics" tmpdir)))
17002 buf rtn b e)
17003 (with-current-buffer frombuf
17004 (icalendar-export-region (point-min) (point-max) tmpfile)
17005 (setq buf (find-buffer-visiting tmpfile))
17006 (set-buffer buf)
17007 (goto-char (point-min))
17008 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17009 (setq b (match-beginning 0)))
17010 (goto-char (point-max))
17011 (if (re-search-backward "^END:VEVENT" nil t)
17012 (setq e (match-end 0)))
17014 (kill-buffer buf)
17015 (delete-file tmpfile)
17016 rtn))
17018 (defun org-closest-date (start current change prefer show-all)
17019 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17020 When PREFER is `past', return a date that is either CURRENT or past.
17021 When PREFER is `future', return a date that is either CURRENT or future.
17022 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17023 ;; Make the proper lists from the dates
17024 (catch 'exit
17025 (let ((a1 '(("h" . hour)
17026 ("d" . day)
17027 ("w" . week)
17028 ("m" . month)
17029 ("y" . year)))
17030 (shour (nth 2 (org-parse-time-string start)))
17031 dn dw sday cday n1 n2 n0
17032 d m y y1 y2 date1 date2 nmonths nm ny m2)
17034 (setq start (org-date-to-gregorian start)
17035 current (org-date-to-gregorian
17036 (if show-all
17037 current
17038 (time-to-days (current-time))))
17039 sday (calendar-absolute-from-gregorian start)
17040 cday (calendar-absolute-from-gregorian current))
17042 (if (<= cday sday) (throw 'exit sday))
17045 (setq dn (string-to-number (match-string 1 change))
17046 dw (cdr (assoc (match-string 2 change) a1)))
17047 (error "Invalid change specifier: %s" change))
17048 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17049 (cond
17050 ((eq dw 'hour)
17051 (let ((missing-hours
17052 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17053 dn)))
17054 (setq n1 (if (zerop missing-hours) cday
17055 (- cday (1+ (floor (/ missing-hours 24)))))
17056 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17057 ((eq dw 'day)
17058 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17059 n2 (+ n1 dn)))
17060 ((eq dw 'year)
17061 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17062 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17063 (setq date1 (list m d y1)
17064 n1 (calendar-absolute-from-gregorian date1)
17065 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17066 n2 (calendar-absolute-from-gregorian date2)))
17067 ((eq dw 'month)
17068 ;; approx number of month between the two dates
17069 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17070 ;; How often does dn fit in there?
17071 (setq d (nth 1 start) m (car start) y (nth 2 start)
17072 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17073 m (+ m nm)
17074 ny (floor (/ m 12))
17075 y (+ y ny)
17076 m (- m (* ny 12)))
17077 (while (> m 12) (setq m (- m 12) y (1+ y)))
17078 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17079 (setq m2 (+ m dn) y2 y)
17080 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17081 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17082 (while (<= n2 cday)
17083 (setq n1 n2 m m2 y y2)
17084 (setq m2 (+ m dn) y2 y)
17085 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17086 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17087 ;; Make sure n1 is the earlier date
17088 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17089 (if show-all
17090 (cond
17091 ((eq prefer 'past) (if (= cday n2) n2 n1))
17092 ((eq prefer 'future) (if (= cday n1) n1 n2))
17093 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17094 (cond
17095 ((eq prefer 'past) (if (= cday n2) n2 n1))
17096 ((eq prefer 'future) (if (= cday n1) n1 n2))
17097 (t (if (= cday n1) n1 n2)))))))
17099 (defun org-date-to-gregorian (date)
17100 "Turn any specification of DATE into a Gregorian date for the calendar."
17101 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17102 ((and (listp date) (= (length date) 3)) date)
17103 ((stringp date)
17104 (setq date (org-parse-time-string date))
17105 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17106 ((listp date)
17107 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17109 (defun org-parse-time-string (s &optional nodefault)
17110 "Parse the standard Org-mode time string.
17111 This should be a lot faster than the normal `parse-time-string'.
17112 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17113 hour and minute fields will be nil if not given."
17114 (cond ((string-match org-ts-regexp0 s)
17115 (list 0
17116 (if (or (match-beginning 8) (not nodefault))
17117 (string-to-number (or (match-string 8 s) "0")))
17118 (if (or (match-beginning 7) (not nodefault))
17119 (string-to-number (or (match-string 7 s) "0")))
17120 (string-to-number (match-string 4 s))
17121 (string-to-number (match-string 3 s))
17122 (string-to-number (match-string 2 s))
17123 nil nil nil))
17124 ((string-match "^<[^>]+>$" s)
17125 (decode-time (seconds-to-time (org-matcher-time s))))
17126 (t (error "Not a standard Org-mode time string: %s" s))))
17128 (defun org-timestamp-up (&optional arg)
17129 "Increase the date item at the cursor by one.
17130 If the cursor is on the year, change the year. If it is on the month,
17131 the day or the time, change that.
17132 With prefix ARG, change by that many units."
17133 (interactive "p")
17134 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17136 (defun org-timestamp-down (&optional arg)
17137 "Decrease the date item at the cursor by one.
17138 If the cursor is on the year, change the year. If it is on the month,
17139 the day or the time, change that.
17140 With prefix ARG, change by that many units."
17141 (interactive "p")
17142 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17144 (defun org-timestamp-up-day (&optional arg)
17145 "Increase the date in the time stamp by one day.
17146 With prefix ARG, change that many days."
17147 (interactive "p")
17148 (if (and (not (org-at-timestamp-p t))
17149 (org-at-heading-p))
17150 (org-todo 'up)
17151 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17153 (defun org-timestamp-down-day (&optional arg)
17154 "Decrease the date in the time stamp by one day.
17155 With prefix ARG, change that many days."
17156 (interactive "p")
17157 (if (and (not (org-at-timestamp-p t))
17158 (org-at-heading-p))
17159 (org-todo 'down)
17160 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17162 (defun org-at-timestamp-p (&optional inactive-ok)
17163 "Determine if the cursor is in or at a timestamp."
17164 (interactive)
17165 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17166 (pos (point))
17167 (ans (or (looking-at tsr)
17168 (save-excursion
17170 (if (> (point) (point-min)) (backward-char 1))
17171 (and (looking-at tsr)
17172 (> (- (match-end 0) pos) -1))))))
17173 (and ans
17174 (boundp 'org-ts-what)
17175 (setq org-ts-what
17176 (cond
17177 ((= pos (match-beginning 0)) 'bracket)
17178 ;; Point is considered to be "on the bracket" whether
17179 ;; it's really on it or right after it.
17180 ((= pos (1- (match-end 0))) 'bracket)
17181 ((= pos (match-end 0)) 'after)
17182 ((org-pos-in-match-range pos 2) 'year)
17183 ((org-pos-in-match-range pos 3) 'month)
17184 ((org-pos-in-match-range pos 7) 'hour)
17185 ((org-pos-in-match-range pos 8) 'minute)
17186 ((or (org-pos-in-match-range pos 4)
17187 (org-pos-in-match-range pos 5)) 'day)
17188 ((and (> pos (or (match-end 8) (match-end 5)))
17189 (< pos (match-end 0)))
17190 (- pos (or (match-end 8) (match-end 5))))
17191 (t 'day))))
17192 ans))
17194 (defun org-toggle-timestamp-type ()
17195 "Toggle the type (<active> or [inactive]) of a time stamp."
17196 (interactive)
17197 (when (org-at-timestamp-p t)
17198 (let ((beg (match-beginning 0)) (end (match-end 0))
17199 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17200 (save-excursion
17201 (goto-char beg)
17202 (while (re-search-forward "[][<>]" end t)
17203 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17204 t t)))
17205 (message "Timestamp is now %sactive"
17206 (if (equal (char-after beg) ?<) "" "in")))))
17208 (defun org-at-clock-log-p nil
17209 "Is the cursor on the clock log line?"
17210 (save-excursion
17211 (move-beginning-of-line 1)
17214 (defvar org-clock-history) ; defined in org-clock.el
17215 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17216 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17217 "Change the date in the time stamp at point.
17218 The date will be changed by N times WHAT. WHAT can be `day', `month',
17219 `year', `minute', `second'. If WHAT is not given, the cursor position
17220 in the timestamp determines what will be changed.
17222 (let ((origin (point)) origin-cat
17223 with-hm inactive
17224 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17225 org-ts-what
17226 extra rem
17227 ts time time0 fixnext clrgx)
17228 (if (not (org-at-timestamp-p t))
17229 (error "Not at a timestamp"))
17230 (if (and (not what) (eq org-ts-what 'bracket))
17231 (org-toggle-timestamp-type)
17232 ;; Point isn't on brackets. Remember the part of the time-stamp
17233 ;; the point was in. Indeed, size of time-stamps may change,
17234 ;; but point must be kept in the same category nonetheless.
17235 (setq origin-cat org-ts-what)
17236 (if (and (not what) (not (eq org-ts-what 'day))
17237 org-display-custom-times
17238 (get-text-property (point) 'display)
17239 (not (get-text-property (1- (point)) 'display)))
17240 (setq org-ts-what 'day))
17241 (setq org-ts-what (or what org-ts-what)
17242 inactive (= (char-after (match-beginning 0)) ?\[)
17243 ts (match-string 0))
17244 (replace-match "")
17245 (when (string-match
17246 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17247 ts)
17248 (setq extra (match-string 1 ts))
17249 (if suppress-tmp-delay
17250 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17252 (setq with-hm t))
17253 (setq time0 (org-parse-time-string ts))
17254 (when (and updown
17255 (eq org-ts-what 'minute)
17256 (not current-prefix-arg))
17257 ;; This looks like s-up and s-down. Change by one rounding step.
17258 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17259 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17260 (setcar (cdr time0) (+ (nth 1 time0)
17261 (if (> n 0) (- rem) (- dm rem))))))
17262 (setq time
17263 (encode-time (or (car time0) 0)
17264 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17265 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17266 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17267 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17268 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17269 (nthcdr 6 time0)))
17270 (when (and (member org-ts-what '(hour minute))
17271 extra
17273 (setq extra (org-modify-ts-extra
17274 extra
17275 (if (eq org-ts-what 'hour) 2 5)
17276 n dm)))
17277 (when (integerp org-ts-what)
17278 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17279 (if (eq what 'calendar)
17280 (let ((cal-date (org-get-date-from-calendar)))
17281 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17282 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17283 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17284 (setcar time0 (or (car time0) 0))
17285 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17286 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17287 (setq time (apply 'encode-time time0))))
17288 ;; Insert the new time-stamp, and ensure point stays in the same
17289 ;; category as before (i.e. not after the last position in that
17290 ;; category).
17291 (let ((pos (point)))
17292 ;; Stay before inserted string. `save-excursion' is of no use.
17293 (setq org-last-changed-timestamp
17294 (org-insert-time-stamp time with-hm inactive nil nil extra))
17295 (goto-char pos))
17296 (save-match-data
17297 (looking-at org-ts-regexp3)
17298 (goto-char (cond
17299 ;; `day' category ends before `hour' if any, or at
17300 ;; the end of the day name.
17301 ((eq origin-cat 'day)
17302 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17303 ((eq origin-cat 'hour) (min (match-end 7) origin))
17304 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17305 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17306 ;; `year' and `month' have both fixed size: point
17307 ;; couldn't have moved into another part.
17308 (t origin))))
17309 ;; Update clock if on a CLOCK line.
17310 (org-clock-update-time-maybe)
17311 ;; Maybe adjust the closest clock in `org-clock-history'
17312 (when org-clock-adjust-closest
17313 (if (not (and (org-at-clock-log-p)
17314 (< 1 (length (delq nil (mapcar 'marker-position
17315 org-clock-history))))))
17316 (message "No clock to adjust")
17317 (cond ((save-excursion ; fix previous clock?
17318 (re-search-backward org-ts-regexp0 nil t)
17321 ((save-excursion ; fix next clock?
17322 (re-search-backward org-ts-regexp0 nil t)
17325 (save-window-excursion
17326 ;; Find closest clock to point, adjust the previous/next one in history
17327 (let* ((p (save-excursion (org-back-to-heading t)))
17328 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17329 (clfixnth
17330 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17331 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17332 (if (not clfixpos)
17333 (message "No clock to adjust")
17334 (save-excursion
17335 (org-goto-marker-or-bmk clfixpos)
17336 (org-show-subtree)
17337 (when (re-search-forward clrgx nil t)
17338 (goto-char (match-beginning 1))
17339 (let (org-clock-adjust-closest)
17340 (org-timestamp-change n org-ts-what updown))
17341 (message "Clock adjusted in %s for heading: %s"
17342 (file-name-nondirectory (buffer-file-name))
17343 (org-get-heading t t)))))))))
17344 ;; Try to recenter the calendar window, if any.
17345 (if (and org-calendar-follow-timestamp-change
17346 (get-buffer-window "*Calendar*" t)
17347 (memq org-ts-what '(day month year)))
17348 (org-recenter-calendar (time-to-days time))))))
17350 (defun org-modify-ts-extra (s pos n dm)
17351 "Change the different parts of the lead-time and repeat fields in timestamp."
17352 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17353 ng h m new rem)
17354 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17355 (cond
17356 ((or (org-pos-in-match-range pos 2)
17357 (org-pos-in-match-range pos 3))
17358 (setq m (string-to-number (match-string 3 s))
17359 h (string-to-number (match-string 2 s)))
17360 (if (org-pos-in-match-range pos 2)
17361 (setq h (+ h n))
17362 (setq n (* dm (org-no-warnings (signum n))))
17363 (when (not (= 0 (setq rem (% m dm))))
17364 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17365 (setq m (+ m n)))
17366 (if (< m 0) (setq m (+ m 60) h (1- h)))
17367 (if (> m 59) (setq m (- m 60) h (1+ h)))
17368 (setq h (min 24 (max 0 h)))
17369 (setq ng 1 new (format "-%02d:%02d" h m)))
17370 ((org-pos-in-match-range pos 6)
17371 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17372 ((org-pos-in-match-range pos 5)
17373 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17375 ((org-pos-in-match-range pos 9)
17376 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17377 ((org-pos-in-match-range pos 8)
17378 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17380 (when ng
17381 (setq s (concat
17382 (substring s 0 (match-beginning ng))
17383 new
17384 (substring s (match-end ng))))))
17385 s))
17387 (defun org-recenter-calendar (date)
17388 "If the calendar is visible, recenter it to DATE."
17389 (let ((cwin (get-buffer-window "*Calendar*" t)))
17390 (when cwin
17391 (let ((calendar-move-hook nil))
17392 (with-selected-window cwin
17393 (calendar-goto-date (if (listp date) date
17394 (calendar-gregorian-from-absolute date))))))))
17396 (defun org-goto-calendar (&optional arg)
17397 "Go to the Emacs calendar at the current date.
17398 If there is a time stamp in the current line, go to that date.
17399 A prefix ARG can be used to force the current date."
17400 (interactive "P")
17401 (let ((tsr org-ts-regexp) diff
17402 (calendar-move-hook nil)
17403 (calendar-view-holidays-initially-flag nil)
17404 (calendar-view-diary-initially-flag nil))
17405 (if (or (org-at-timestamp-p)
17406 (save-excursion
17407 (beginning-of-line 1)
17408 (looking-at (concat ".*" tsr))))
17409 (let ((d1 (time-to-days (current-time)))
17410 (d2 (time-to-days
17411 (org-time-string-to-time (match-string 1)))))
17412 (setq diff (- d2 d1))))
17413 (calendar)
17414 (calendar-goto-today)
17415 (if (and diff (not arg)) (calendar-forward-day diff))))
17417 (defun org-get-date-from-calendar ()
17418 "Return a list (month day year) of date at point in calendar."
17419 (with-current-buffer "*Calendar*"
17420 (save-match-data
17421 (calendar-cursor-to-date))))
17423 (defun org-date-from-calendar ()
17424 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17425 If there is already a time stamp at the cursor position, update it."
17426 (interactive)
17427 (if (org-at-timestamp-p t)
17428 (org-timestamp-change 0 'calendar)
17429 (let ((cal-date (org-get-date-from-calendar)))
17430 (org-insert-time-stamp
17431 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17433 (defcustom org-effort-durations
17434 `(("h" . 60)
17435 ("d" . ,(* 60 8))
17436 ("w" . ,(* 60 8 5))
17437 ("m" . ,(* 60 8 5 4))
17438 ("y" . ,(* 60 8 5 40)))
17439 "Conversion factor to minutes for an effort modifier.
17441 Each entry has the form (MODIFIER . MINUTES).
17443 In an effort string, a number followed by MODIFIER is multiplied
17444 by the specified number of MINUTES to obtain an effort in
17445 minutes.
17449 :group 'org-agenda
17450 :version "24.1"
17451 :type '(alist :key-type (string :tag "Modifier")
17452 :value-type (number :tag "Minutes")))
17454 (defun org-minutes-to-clocksum-string (m)
17455 "Format number of minutes as a clocksum string.
17456 The format is determined by `org-time-clocksum-format',
17457 `org-time-clocksum-use-fractional' and
17458 `org-time-clocksum-fractional-format' and
17459 `org-time-clocksum-use-effort-durations'."
17460 (let ((clocksum "")
17461 (m (round m)) ; Don't allow fractions of minutes
17462 h d w mo y fmt n)
17463 (setq h (if org-time-clocksum-use-effort-durations
17464 (cdr (assoc "h" org-effort-durations)) 60)
17465 d (if org-time-clocksum-use-effort-durations
17466 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17467 w (if org-time-clocksum-use-effort-durations
17468 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17469 mo (if org-time-clocksum-use-effort-durations
17470 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17471 y (if org-time-clocksum-use-effort-durations
17472 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17473 ;; fractional format
17474 (if org-time-clocksum-use-fractional
17475 (cond
17476 ;; single format string
17477 ((stringp org-time-clocksum-fractional-format)
17478 (format org-time-clocksum-fractional-format (/ m (float h))))
17479 ;; choice of fractional formats for different time units
17480 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17481 (> (/ (truncate m) (* y d h)) 0))
17482 (format fmt (/ m (* y d (float h)))))
17483 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17484 (> (/ (truncate m) (* mo d h)) 0))
17485 (format fmt (/ m (* mo d (float h)))))
17486 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17487 (> (/ (truncate m) (* w d h)) 0))
17488 (format fmt (/ m (* w d (float h)))))
17489 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17490 (> (/ (truncate m) (* d h)) 0))
17491 (format fmt (/ m (* d (float h)))))
17492 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17493 (> (/ (truncate m) h) 0))
17494 (format fmt (/ m (float h))))
17495 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17496 (format fmt m))
17497 ;; fall back to smallest time unit with a format
17498 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17499 (format fmt (/ m (float h))))
17500 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17501 (format fmt (/ m (* d (float h)))))
17502 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17503 (format fmt (/ m (* w d (float h)))))
17504 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17505 (format fmt (/ m (* mo d (float h)))))
17506 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17507 (format fmt (/ m (* y d (float h))))))
17508 ;; standard (non-fractional) format, with single format string
17509 (if (stringp org-time-clocksum-format)
17510 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17511 ;; separate formats components
17512 (and (setq fmt (plist-get org-time-clocksum-format :years))
17513 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17514 (plist-get org-time-clocksum-format :require-years))
17515 (setq clocksum (concat clocksum (format fmt n))
17516 m (- m (* n y d h))))
17517 (and (setq fmt (plist-get org-time-clocksum-format :months))
17518 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17519 (plist-get org-time-clocksum-format :require-months))
17520 (setq clocksum (concat clocksum (format fmt n))
17521 m (- m (* n mo d h))))
17522 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17523 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17524 (plist-get org-time-clocksum-format :require-weeks))
17525 (setq clocksum (concat clocksum (format fmt n))
17526 m (- m (* n w d h))))
17527 (and (setq fmt (plist-get org-time-clocksum-format :days))
17528 (or (> (setq n (/ (truncate m) (* d h))) 0)
17529 (plist-get org-time-clocksum-format :require-days))
17530 (setq clocksum (concat clocksum (format fmt n))
17531 m (- m (* n d h))))
17532 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17533 (or (> (setq n (/ (truncate m) h)) 0)
17534 (plist-get org-time-clocksum-format :require-hours))
17535 (setq clocksum (concat clocksum (format fmt n))
17536 m (- m (* n h))))
17537 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17538 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17539 (setq clocksum (concat clocksum (format fmt m))))
17540 ;; return formatted time duration
17541 clocksum))))
17543 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17544 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17545 "Org mode version 8.0")
17547 (defun org-hours-to-clocksum-string (n)
17548 (org-minutes-to-clocksum-string (* n 60)))
17550 (defun org-hh:mm-string-to-minutes (s)
17551 "Convert a string H:MM to a number of minutes.
17552 If the string is just a number, interpret it as minutes.
17553 In fact, the first hh:mm or number in the string will be taken,
17554 there can be extra stuff in the string.
17555 If no number is found, the return value is 0."
17556 (cond
17557 ((integerp s) s)
17559 (+ (* (string-to-number (match-string 1 s)) 60)
17560 (string-to-number (match-string 2 s))))
17562 (string-to-number (match-string 1 s)))
17563 (t 0)))
17565 (defcustom org-image-actual-width t
17566 "Should we use the actual width of images when inlining them?
17568 When set to `t', always use the image width.
17570 When set to a number, use imagemagick (when available) to set
17571 the image's width to this value.
17573 When set to a number in a list, try to get the width from any
17574 #+ATTR.* keyword if it matches a width specification like
17576 #+ATTR_HTML: :width 300px
17578 and fall back on that number if none is found.
17580 When set to nil, try to get the width from an #+ATTR.* keyword
17581 and fall back on the original width if none is found.
17583 This requires Emacs >= 24.1, build with imagemagick support."
17584 :group 'org-appearance
17585 :version "24.4"
17586 :package-version '(Org . "8.0")
17587 :type '(choice
17588 (const :tag "Use the image width" t)
17589 (integer :tag "Use a number of pixels")
17590 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17591 (const :tag "Use #+ATTR* or don't resize" nil)))
17593 (defcustom org-agenda-inhibit-startup nil
17594 "Inhibit startup when preparing agenda buffers.
17595 When this variable is `t' (the default), the initialization of
17596 the Org agenda buffers is inhibited: e.g. the visibility state
17597 is not set, the tables are not re-aligned, etc."
17598 :type 'boolean
17599 :version "24.3"
17600 :group 'org-agenda)
17602 (defun org-duration-string-to-minutes (s &optional output-to-string)
17603 "Convert a duration string S to minutes.
17605 A bare number is interpreted as minutes, modifiers can be set by
17606 customizing `org-effort-durations' (which see).
17608 Entries containing a colon are interpreted as H:MM by
17609 `org-hh:mm-string-to-minutes'."
17610 (let ((result 0)
17612 (regexp-opt (mapcar 'car org-effort-durations))
17614 (while (string-match re s)
17615 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17616 (string-to-number (match-string 1 s))))
17617 (setq s (replace-match "" nil t s)))
17618 (setq result (floor result))
17619 (incf result (org-hh:mm-string-to-minutes s))
17620 (if output-to-string (number-to-string result) result)))
17622 ;;;; Files
17624 (defun org-save-all-org-buffers ()
17625 "Save all Org-mode buffers without user confirmation."
17626 (interactive)
17627 (message "Saving all Org-mode buffers...")
17628 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17629 (when (featurep 'org-id) (org-id-locations-save))
17630 (message "Saving all Org-mode buffers... done"))
17632 (defun org-revert-all-org-buffers ()
17633 "Revert all Org-mode buffers.
17634 Prompt for confirmation when there are unsaved changes.
17635 Be sure you know what you are doing before letting this function
17636 overwrite your changes.
17638 This function is useful in a setup where one tracks org files
17639 with a version control system, to revert on one machine after pulling
17640 changes from another. I believe the procedure must be like this:
17642 1. M-x org-save-all-org-buffers
17643 2. Pull changes from the other machine, resolve conflicts
17644 3. M-x org-revert-all-org-buffers"
17645 (interactive)
17646 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17647 (error "Abort"))
17648 (save-excursion
17649 (save-window-excursion
17650 (mapc
17651 (lambda (b)
17652 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17653 (with-current-buffer b buffer-file-name))
17654 (org-pop-to-buffer-same-window b)
17655 (revert-buffer t 'no-confirm)))
17656 (buffer-list))
17657 (when (and (featurep 'org-id) org-id-track-globally)
17658 (org-id-locations-load)))))
17660 ;;;; Agenda files
17662 ;;;###autoload
17663 (defun org-switchb (&optional arg)
17664 "Switch between Org buffers.
17665 With one prefix argument, restrict available buffers to files.
17666 With two prefix arguments, restrict available buffers to agenda files.
17668 Defaults to `iswitchb' for buffer name completion.
17669 Set `org-completion-use-ido' to make it use ido instead."
17670 (interactive "P")
17671 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17672 ((equal arg '(16)) (org-buffer-list 'agenda))
17673 (t (org-buffer-list))))
17674 (org-completion-use-iswitchb org-completion-use-iswitchb)
17675 (org-completion-use-ido org-completion-use-ido))
17676 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17677 (setq org-completion-use-iswitchb t))
17678 (org-pop-to-buffer-same-window
17679 (org-icompleting-read "Org buffer: "
17680 (mapcar 'list (mapcar 'buffer-name blist))
17681 nil t))))
17683 ;;; Define some older names previously used for this functionality
17684 ;;;###autoload
17685 (defalias 'org-ido-switchb 'org-switchb)
17686 ;;;###autoload
17687 (defalias 'org-iswitchb 'org-switchb)
17689 (defun org-buffer-list (&optional predicate exclude-tmp)
17690 "Return a list of Org buffers.
17691 PREDICATE can be `export', `files' or `agenda'.
17693 export restrict the list to Export buffers.
17694 files restrict the list to buffers visiting Org files.
17695 agenda restrict the list to buffers visiting agenda files.
17697 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17698 (let* ((bfn nil)
17699 (agenda-files (and (eq predicate 'agenda)
17700 (mapcar 'file-truename (org-agenda-files t))))
17701 (filter
17702 (cond
17703 ((eq predicate 'files)
17704 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17705 ((eq predicate 'export)
17706 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17707 ((eq predicate 'agenda)
17708 (lambda (b)
17709 (with-current-buffer b
17710 (and (derived-mode-p 'org-mode)
17711 (setq bfn (buffer-file-name b))
17712 (member (file-truename bfn) agenda-files)))))
17713 (t (lambda (b) (with-current-buffer b
17714 (or (derived-mode-p 'org-mode)
17715 (string-match "\*Org .*Export"
17716 (buffer-name b)))))))))
17717 (delq nil
17718 (mapcar
17719 (lambda(b)
17720 (if (and (funcall filter b)
17721 (or (not exclude-tmp)
17722 (not (string-match "tmp" (buffer-name b)))))
17723 b
17724 nil))
17725 (buffer-list)))))
17727 (defun org-agenda-files (&optional unrestricted archives)
17728 "Get the list of agenda files.
17729 Optional UNRESTRICTED means return the full list even if a restriction
17730 is currently in place.
17731 When ARCHIVES is t, include all archive files that are really being
17732 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17733 `org-agenda-archives-mode' is t."
17734 (let ((files
17735 (cond
17736 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17737 ((stringp org-agenda-files) (org-read-agenda-file-list))
17738 ((listp org-agenda-files) org-agenda-files)
17739 (t (error "Invalid value of `org-agenda-files'")))))
17740 (setq files (apply 'append
17741 (mapcar (lambda (f)
17742 (if (file-directory-p f)
17743 (directory-files
17744 f t org-agenda-file-regexp)
17745 (list f)))
17746 files)))
17747 (when org-agenda-skip-unavailable-files
17748 (setq files (delq nil
17749 (mapcar (function
17750 (lambda (file)
17751 (and (file-readable-p file) file)))
17752 files))))
17753 (when (or (eq archives t)
17754 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17755 (setq files (org-add-archive-files files)))
17756 files))
17758 (defun org-agenda-file-p (&optional file)
17759 "Return non-nil, if FILE is an agenda file.
17760 If FILE is omitted, use the file associated with the current
17761 buffer."
17762 (member (or file (buffer-file-name))
17763 (org-agenda-files t)))
17765 (defun org-edit-agenda-file-list ()
17766 "Edit the list of agenda files.
17767 Depending on setup, this either uses customize to edit the variable
17768 `org-agenda-files', or it visits the file that is holding the list. In the
17769 latter case, the buffer is set up in a way that saving it automatically kills
17770 the buffer and restores the previous window configuration."
17771 (interactive)
17772 (if (stringp org-agenda-files)
17773 (let ((cw (current-window-configuration)))
17774 (find-file org-agenda-files)
17775 (org-set-local 'org-window-configuration cw)
17776 (org-add-hook 'after-save-hook
17777 (lambda ()
17778 (set-window-configuration
17779 (prog1 org-window-configuration
17780 (kill-buffer (current-buffer))))
17781 (org-install-agenda-files-menu)
17782 (message "New agenda file list installed"))
17783 nil 'local)
17784 (message "%s" (substitute-command-keys
17786 (customize-variable 'org-agenda-files)))
17788 (defun org-store-new-agenda-file-list (list)
17789 "Set new value for the agenda file list and save it correctly."
17790 (if (stringp org-agenda-files)
17791 (let ((fe (org-read-agenda-file-list t)) b u)
17792 (while (setq b (find-buffer-visiting org-agenda-files))
17793 (kill-buffer b))
17794 (with-temp-file org-agenda-files
17795 (insert
17796 (mapconcat
17797 (lambda (f) ;; Keep un-expanded entries.
17798 (if (setq u (assoc f fe))
17799 (cdr u)
17800 f))
17803 (let ((org-mode-hook nil) (org-inhibit-startup t)
17804 (org-insert-mode-line-in-empty-file nil))
17805 (setq org-agenda-files list)
17806 (customize-save-variable 'org-agenda-files org-agenda-files))))
17808 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17809 "Read the list of agenda files from a file.
17810 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17811 filenames, used by `org-store-new-agenda-file-list' to write back
17812 un-expanded file names."
17813 (when (file-directory-p org-agenda-files)
17814 (error "`org-agenda-files' cannot be a single directory"))
17815 (when (stringp org-agenda-files)
17816 (with-temp-buffer
17817 (insert-file-contents org-agenda-files)
17818 (mapcar
17819 (lambda (f)
17820 (let ((e (expand-file-name (substitute-in-file-name f)
17821 org-directory)))
17822 (if pair-with-expansion
17823 (cons e f)
17824 e)))
17827 ;;;###autoload
17828 (defun org-cycle-agenda-files ()
17829 "Cycle through the files in `org-agenda-files'.
17830 If the current buffer visits an agenda file, find the next one in the list.
17831 If the current buffer does not, find the first agenda file."
17832 (interactive)
17833 (let* ((fs (org-agenda-files t))
17834 (files (append fs (list (car fs))))
17835 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17836 file)
17837 (unless files (error "No agenda files"))
17838 (catch 'exit
17839 (while (setq file (pop files))
17840 (if (equal (file-truename file) tcf)
17841 (when (car files)
17842 (find-file (car files))
17843 (throw 'exit t))))
17844 (find-file (car fs)))
17845 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17847 (defun org-agenda-file-to-front (&optional to-end)
17848 "Move/add the current file to the top of the agenda file list.
17849 If the file is not present in the list, it is added to the front. If it is
17850 present, it is moved there. With optional argument TO-END, add/move to the
17851 end of the list."
17852 (interactive "P")
17853 (let ((org-agenda-skip-unavailable-files nil)
17854 (file-alist (mapcar (lambda (x)
17855 (cons (file-truename x) x))
17856 (org-agenda-files t)))
17857 (ctf (file-truename
17858 (or buffer-file-name
17859 (error "Please save the current buffer to a file"))))
17860 x had)
17861 (setq x (assoc ctf file-alist) had x)
17863 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17864 (if to-end
17865 (setq file-alist (append (delq x file-alist) (list x)))
17866 (setq file-alist (cons x (delq x file-alist))))
17867 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17868 (org-install-agenda-files-menu)
17869 (message "File %s to %s of agenda file list"
17870 (if had "moved" "added") (if to-end "end" "front"))))
17872 (defun org-remove-file (&optional file)
17873 "Remove current file from the list of files in variable `org-agenda-files'.
17874 These are the files which are being checked for agenda entries.
17875 Optional argument FILE means use this file instead of the current."
17876 (interactive)
17877 (let* ((org-agenda-skip-unavailable-files nil)
17878 (file (or file buffer-file-name
17879 (error "Current buffer does not visit a file")))
17880 (true-file (file-truename file))
17881 (afile (abbreviate-file-name file))
17882 (files (delq nil (mapcar
17883 (lambda (x)
17884 (if (equal true-file
17885 (file-truename x))
17886 nil x))
17887 (org-agenda-files t)))))
17888 (if (not (= (length files) (length (org-agenda-files t))))
17889 (progn
17890 (org-store-new-agenda-file-list files)
17891 (org-install-agenda-files-menu)
17892 (message "Removed file: %s" afile))
17893 (message "File was not in list: %s (not removed)" afile))))
17895 (defun org-file-menu-entry (file)
17896 (vector file (list 'find-file file) t))
17898 (defun org-check-agenda-file (file)
17899 "Make sure FILE exists. If not, ask user what to do."
17900 (when (not (file-exists-p file))
17901 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17902 (abbreviate-file-name file))
17903 (let ((r (downcase (read-char-exclusive))))
17904 (cond
17905 ((equal r ?r)
17906 (org-remove-file file)
17907 (throw 'nextfile t))
17908 (t (error "Abort"))))))
17910 (defun org-get-agenda-file-buffer (file)
17911 "Get a buffer visiting FILE. If the buffer needs to be created, add
17912 it to the list of buffers which might be released later."
17913 (let ((buf (org-find-base-buffer-visiting file)))
17914 (if buf
17915 buf ; just return it
17916 ;; Make a new buffer and remember it
17917 (setq buf (find-file-noselect file))
17918 (if buf (push buf org-agenda-new-buffers))
17919 buf)))
17921 (defun org-release-buffers (blist)
17922 "Release all buffers in list, asking the user for confirmation when needed.
17923 When a buffer is unmodified, it is just killed. When modified, it is saved
17924 \(if the user agrees) and then killed."
17925 (let (buf file)
17926 (while (setq buf (pop blist))
17927 (setq file (buffer-file-name buf))
17928 (when (and (buffer-modified-p buf)
17929 file
17930 (y-or-n-p (format "Save file %s? " file)))
17931 (with-current-buffer buf (save-buffer)))
17932 (kill-buffer buf))))
17934 (defun org-agenda-prepare-buffers (files)
17935 "Create buffers for all agenda files, protect archived trees and comments."
17936 (interactive)
17937 (let ((pa '(:org-archived t))
17938 (pc '(:org-comment t))
17939 (pall '(:org-archived t :org-comment t))
17940 (inhibit-read-only t)
17941 (org-inhibit-startup org-agenda-inhibit-startup)
17942 (rea (concat ":" org-archive-tag ":"))
17943 file re)
17944 (setq org-tag-alist-for-agenda nil
17945 org-tag-groups-alist-for-agenda nil)
17946 (save-excursion
17947 (save-restriction
17948 (while (setq file (pop files))
17949 (catch 'nextfile
17950 (if (bufferp file)
17951 (set-buffer file)
17952 (org-check-agenda-file file)
17953 (set-buffer (org-get-agenda-file-buffer file)))
17954 (widen)
17955 (org-set-regexps-and-options-for-tags)
17956 (org-refresh-category-properties)
17957 (org-refresh-properties org-effort-property 'org-effort)
17958 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
17959 (setq org-todo-keywords-for-agenda
17960 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17961 (setq org-done-keywords-for-agenda
17962 (append org-done-keywords-for-agenda org-done-keywords))
17963 (setq org-todo-keyword-alist-for-agenda
17964 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17965 (setq org-drawers-for-agenda
17966 (append org-drawers-for-agenda org-drawers))
17967 (unless (equal org-tag-alist-for-agenda org-tag-alist)
17968 (setq org-tag-alist-for-agenda
17969 (append org-tag-alist-for-agenda org-tag-alist)))
17970 (if org-group-tags
17971 (setq org-tag-groups-alist-for-agenda
17972 (org-uniquify-alist
17973 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
17974 (org-with-silent-modifications
17975 (save-excursion
17976 (remove-text-properties (point-min) (point-max) pall)
17977 (when org-agenda-skip-archived-trees
17978 (goto-char (point-min))
17979 (while (re-search-forward rea nil t)
17980 (if (org-at-heading-p t)
17981 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17982 (goto-char (point-min))
17983 (setq re (format org-heading-keyword-regexp-format
17984 org-comment-string))
17985 (while (re-search-forward re nil t)
17986 (add-text-properties
17987 (match-beginning 0) (org-end-of-subtree t) pc))))))))
17988 (setq org-todo-keywords-for-agenda
17989 (org-uniquify org-todo-keywords-for-agenda))
17990 (setq org-todo-keyword-alist-for-agenda
17991 (org-uniquify org-todo-keyword-alist-for-agenda))))
17993 \f
17994 ;;;; CDLaTeX minor mode
17996 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17997 "Keymap for the minor `org-cdlatex-mode'.")
17999 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18000 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18001 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18002 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18003 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18005 (defvar org-cdlatex-texmathp-advice-is-done nil
18006 "Flag remembering if we have applied the advice to texmathp already.")
18008 (define-minor-mode org-cdlatex-mode
18009 "Toggle the minor `org-cdlatex-mode'.
18010 This mode supports entering LaTeX environment and math in LaTeX fragments
18011 in Org-mode.
18013 nil " OCDL" nil
18014 (when org-cdlatex-mode
18015 (require 'cdlatex)
18016 (run-hooks 'cdlatex-mode-hook)
18017 (cdlatex-compute-tables))
18018 (unless org-cdlatex-texmathp-advice-is-done
18019 (setq org-cdlatex-texmathp-advice-is-done t)
18020 (defadvice texmathp (around org-math-always-on activate)
18021 "Always return t in org-mode buffers.
18022 This is because we want to insert math symbols without dollars even outside
18023 the LaTeX math segments. If Orgmode thinks that point is actually inside
18024 an embedded LaTeX fragment, let texmathp do its job.
18026 (interactive)
18027 (let (p)
18028 (cond
18029 ((not (derived-mode-p 'org-mode)) ad-do-it)
18030 ((eq this-command 'cdlatex-math-symbol)
18031 (setq ad-return-value t
18032 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18033 (t
18034 (let ((p (org-inside-LaTeX-fragment-p)))
18035 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18036 (setq ad-return-value t
18037 texmathp-why '("Org-mode embedded math" . 0))
18038 (if p ad-do-it)))))))))
18040 (defun turn-on-org-cdlatex ()
18041 "Unconditionally turn on `org-cdlatex-mode'."
18042 (org-cdlatex-mode 1))
18044 (defun org-try-cdlatex-tab ()
18045 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18046 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18047 - inside a LaTeX fragment, or
18048 - after the first word in a line, where an abbreviation expansion could
18049 insert a LaTeX environment."
18050 (when org-cdlatex-mode
18051 (cond
18052 ;; Before any word on the line: No expansion possible.
18054 ;; Just after first word on the line: Expand it. Make sure it
18055 ;; cannot happen on headlines, though.
18056 ((save-excursion
18057 (skip-chars-backward "a-zA-Z0-9*")
18059 (and (bolp) (not (org-at-heading-p))))
18060 (cdlatex-tab) t)
18061 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18063 (defun org-cdlatex-underscore-caret (&optional arg)
18064 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18065 Revert to the normal definition outside of these fragments."
18066 (interactive "P")
18067 (if (org-inside-LaTeX-fragment-p)
18068 (call-interactively 'cdlatex-sub-superscript)
18069 (let (org-cdlatex-mode)
18070 (call-interactively (key-binding (vector last-input-event))))))
18072 (defun org-cdlatex-math-modify (&optional arg)
18073 "Execute `cdlatex-math-modify' in LaTeX fragments.
18074 Revert to the normal definition outside of these fragments."
18075 (interactive "P")
18076 (if (org-inside-LaTeX-fragment-p)
18077 (call-interactively 'cdlatex-math-modify)
18078 (let (org-cdlatex-mode)
18079 (call-interactively (key-binding (vector last-input-event))))))
18082 \f
18083 ;;;; LaTeX fragments
18085 (defvar org-latex-regexps
18087 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18090 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18094 "Regular expressions for matching embedded LaTeX.")
18096 (defun org-inside-LaTeX-fragment-p ()
18097 "Test if point is inside a LaTeX fragment.
18099 sequence appearing also before point.
18100 Even though the matchers for math are configurable, this function assumes
18102 delimiters are skipped when they have been removed by customization.
18103 The return value is nil, or a cons cell with the delimiter and the
18104 position of this delimiter.
18106 This function does a reasonably good job, but can locally be fooled by
18107 for example currency specifications. For example it will assume being in
18109 fragments that are properly closed, but during editing, we have to live
18110 with the uncertainty caused by missing closing delimiters. This function
18111 looks only before point, not after."
18112 (catch 'exit
18113 (let ((pos (point))
18114 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18115 (lim (progn
18117 (point)))
18118 dd-on str (start 0) m re)
18119 (goto-char pos)
18120 (when dodollar
18122 re (nth 1 (assoc "$" org-latex-regexps)))
18123 (while (string-match re str start)
18124 (cond
18125 ((= (match-end 0) (length str))
18126 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18127 ((= (match-end 0) (- (length str) 5))
18128 (throw 'exit nil))
18129 (t (setq start (match-end 0))))))
18130 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18131 (goto-char pos)
18132 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18133 (and (match-beginning 2) (throw 'exit nil))
18134 ;; count $$
18136 (setq dd-on (not dd-on)))
18137 (goto-char pos)
18138 (if dd-on (cons "$$" m))))))
18140 (defun org-inside-latex-macro-p ()
18141 "Is point inside a LaTeX macro or its arguments?"
18142 (save-match-data
18143 (org-in-regexp
18146 (defvar org-latex-fragment-image-overlays nil
18147 "List of overlays carrying the images of latex fragments.")
18148 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18150 (defun org-remove-latex-fragment-image-overlays ()
18151 "Remove all overlays with LaTeX fragment images in current buffer."
18152 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18153 (setq org-latex-fragment-image-overlays nil))
18155 (defun org-preview-latex-fragment (&optional subtree)
18156 "Preview the LaTeX fragment at point, or all locally or globally.
18157 If the cursor is in a LaTeX fragment, create the image and overlay
18158 it over the source code. If there is no fragment at point, display
18159 all fragments in the current text, from one headline to the next. With
18160 prefix SUBTREE, display all fragments in the current subtree. With a
18162 the cursor is before the first headline,
18163 display all fragments in the buffer.
18165 (interactive "P")
18166 (unless buffer-file-name
18167 (error "Can't preview LaTeX fragment in a non-file buffer"))
18168 (org-remove-latex-fragment-image-overlays)
18169 (save-excursion
18170 (save-restriction
18171 (let (beg end at msg)
18172 (cond
18173 ((or (equal subtree '(16))
18174 (not (save-excursion
18175 (re-search-backward org-outline-regexp-bol nil t))))
18176 (setq beg (point-min) end (point-max)
18177 msg "Creating images for buffer...%s"))
18178 ((equal subtree '(4))
18179 (org-back-to-heading)
18180 (setq beg (point) end (org-end-of-subtree t)
18181 msg "Creating images for subtree...%s"))
18182 (t
18183 (if (setq at (org-inside-LaTeX-fragment-p))
18184 (goto-char (max (point-min) (- (cdr at) 2)))
18185 (org-back-to-heading))
18186 (setq beg (point) end (progn (outline-next-heading) (point))
18187 msg (if at "Creating image...%s"
18188 "Creating images for entry...%s"))))
18189 (message msg "")
18190 (narrow-to-region beg end)
18191 (goto-char beg)
18192 (org-format-latex
18193 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18194 (file-name-nondirectory
18195 buffer-file-name)))
18196 default-directory 'overlays msg at 'forbuffer
18197 org-latex-create-formula-image-program)
18198 (message msg "done. Use `C-c C-c' to remove images.")))))
18200 (defun org-format-latex (prefix &optional dir overlays msg at
18201 forbuffer processing-type)
18202 "Replace LaTeX fragments with links to an image, and produce images.
18203 Some of the options can be changed using the variable
18204 `org-format-latex-options'."
18205 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18206 (let* ((prefixnodir (file-name-nondirectory prefix))
18207 (absprefix (expand-file-name prefix dir))
18208 (todir (file-name-directory absprefix))
18209 (opt org-format-latex-options)
18210 (optnew org-format-latex-options)
18211 (matchers (plist-get opt :matchers))
18212 (re-list org-latex-regexps)
18213 (cnt 0) txt hash link beg end re e checkdir
18214 string
18215 m n block-type block linkfile movefile ov)
18216 ;; Check the different regular expressions
18217 (while (setq e (pop re-list))
18218 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18220 (when (member m matchers)
18221 (goto-char (point-min))
18222 (while (re-search-forward re nil t)
18223 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18224 (or (not overlays)
18225 (not (eq (get-char-property (match-beginning n)
18226 'org-overlay-type)
18227 'org-latex-overlay))))
18228 (cond
18229 ((eq processing-type 'verbatim))
18230 ((eq processing-type 'mathjax)
18231 ;; Prepare for MathJax processing.
18232 (setq string (match-string n))
18233 (when (member m '("$" "$1"))
18234 (save-excursion
18235 (delete-region (match-beginning n) (match-end n))
18236 (goto-char (match-beginning n))
18238 ((or (eq processing-type 'dvipng)
18239 (eq processing-type 'imagemagick))
18240 ;; Process to an image.
18241 (setq txt (match-string n)
18242 beg (match-beginning n) end (match-end n)
18243 cnt (1+ cnt))
18244 (let ((face (face-at-point))
18245 (fg (plist-get opt :foreground))
18246 (bg (plist-get opt :background))
18247 ;; Ensure full list is printed.
18248 print-length print-level)
18249 (when forbuffer
18250 ;; Get the colors from the face at point.
18251 (goto-char beg)
18252 (when (eq fg 'auto)
18253 (setq fg (face-attribute face :foreground nil 'default)))
18254 (when (eq bg 'auto)
18255 (setq bg (face-attribute face :background nil 'default)))
18256 (setq optnew (copy-sequence opt))
18257 (plist-put optnew :foreground fg)
18258 (plist-put optnew :background bg))
18259 (setq hash (sha1 (prin1-to-string
18260 (list org-format-latex-header
18261 org-latex-default-packages-alist
18262 org-latex-packages-alist
18263 org-format-latex-options
18264 forbuffer txt fg bg)))
18265 linkfile (format "%s_%s.png" prefix hash)
18266 movefile (format "%s_%s.png" absprefix hash)))
18267 (setq link (concat block "[[file:" linkfile "]]" block))
18268 (if msg (message msg cnt))
18269 (goto-char beg)
18270 (unless checkdir ; Ensure the directory exists.
18271 (setq checkdir t)
18272 (or (file-directory-p todir) (make-directory todir t)))
18273 (unless (file-exists-p movefile)
18274 (org-create-formula-image
18275 txt movefile optnew forbuffer processing-type))
18276 (if overlays
18277 (progn
18278 (mapc (lambda (o)
18279 (if (eq (overlay-get o 'org-overlay-type)
18280 'org-latex-overlay)
18281 (delete-overlay o)))
18282 (overlays-in beg end))
18283 (setq ov (make-overlay beg end))
18284 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18285 (if (featurep 'xemacs)
18286 (progn
18287 (overlay-put ov 'invisible t)
18288 (overlay-put
18289 ov 'end-glyph
18290 (make-glyph (vector 'png :file movefile))))
18291 (overlay-put
18292 ov 'display
18293 (list 'image :type 'png :file movefile :ascent 'center)))
18294 (push ov org-latex-fragment-image-overlays)
18295 (goto-char end))
18296 (delete-region beg end)
18297 (insert (org-add-props link
18298 (list 'org-latex-src
18299 (replace-regexp-in-string
18301 'org-latex-src-embed-type
18302 (if block-type 'paragraph 'character))))))
18303 ((eq processing-type 'mathml)
18304 ;; Process to MathML
18305 (unless (save-match-data (org-format-latex-mathml-available-p))
18306 (error "LaTeX to MathML converter not configured"))
18307 (setq txt (match-string n)
18308 beg (match-beginning n) end (match-end n)
18309 cnt (1+ cnt))
18310 (if msg (message msg cnt))
18311 (goto-char beg)
18312 (delete-region beg end)
18313 (insert (org-format-latex-as-mathml
18314 txt block-type prefix dir)))
18315 (t
18316 (error "Unknown conversion type %s for latex fragments"
18317 processing-type)))))))))
18319 (defun org-create-math-formula (latex-frag &optional mathml-file)
18320 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18321 Use `org-latex-to-mathml-convert-command'. If the conversion is
18323 elements otherwise return nil. When MATHML-FILE is specified,
18324 write the results in to that file. When invoked as an
18325 interactive command, prompt for LATEX-FRAG, with initial value
18326 set to the current active region and echo the results for user
18327 inspection."
18328 (interactive (list (let ((frag (when (org-region-active-p)
18329 (buffer-substring-no-properties
18330 (region-beginning) (region-end)))))
18331 (read-string "LaTeX Fragment: " frag nil frag))))
18332 (unless latex-frag (error "Invalid latex-frag"))
18333 (let* ((tmp-in-file (file-relative-name
18334 (make-temp-name (expand-file-name "ltxmathml-in"))))
18335 (ignore (write-region latex-frag nil tmp-in-file))
18336 (tmp-out-file (file-relative-name
18337 (make-temp-name (expand-file-name "ltxmathml-out"))))
18338 (cmd (format-spec
18339 org-latex-to-mathml-convert-command
18340 `((?j . ,(shell-quote-argument
18341 (expand-file-name org-latex-to-mathml-jar-file)))
18342 (?I . ,(shell-quote-argument tmp-in-file))
18343 (?o . ,(shell-quote-argument tmp-out-file)))))
18344 mathml shell-command-output)
18345 (when (org-called-interactively-p 'any)
18346 (unless (org-format-latex-mathml-available-p)
18347 (error "LaTeX to MathML converter not configured")))
18348 (message "Running %s" cmd)
18349 (setq shell-command-output (shell-command-to-string cmd))
18350 (setq mathml
18351 (when (file-readable-p tmp-out-file)
18352 (with-current-buffer (find-file-noselect tmp-out-file t)
18353 (goto-char (point-min))
18354 (when (re-search-forward
18355 (concat
18356 (regexp-quote
18359 (regexp-quote "</math>")) nil t)
18360 (prog1 (match-string 0) (kill-buffer))))))
18361 (cond
18362 (mathml
18363 (setq mathml
18365 (when mathml-file
18366 (write-region mathml nil mathml-file))
18367 (when (org-called-interactively-p 'any)
18368 (message mathml)))
18369 ((message "LaTeX to MathML conversion failed")
18370 (message shell-command-output)))
18371 (delete-file tmp-in-file)
18372 (when (file-exists-p tmp-out-file)
18373 (delete-file tmp-out-file))
18374 mathml))
18376 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18377 prefix &optional dir)
18378 "Use `org-create-math-formula' but check local cache first."
18379 (let* ((absprefix (expand-file-name prefix dir))
18380 (print-length nil) (print-level nil)
18381 (formula-id (concat
18382 "formula-"
18383 (sha1
18384 (prin1-to-string
18385 (list latex-frag
18386 org-latex-to-mathml-convert-command)))))
18387 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18388 (formula-cache-dir (file-name-directory formula-cache)))
18390 (unless (file-directory-p formula-cache-dir)
18391 (make-directory formula-cache-dir t))
18393 (unless (file-exists-p formula-cache)
18394 (org-create-math-formula latex-frag formula-cache))
18396 (if (file-exists-p formula-cache)
18397 ;; Successful conversion. Return the link to MathML file.
18398 (org-add-props
18399 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18401 'org-latex-src-embed-type (if latex-frag-type
18402 'paragraph 'character)))
18403 ;; Failed conversion. Return the LaTeX fragment verbatim
18404 latex-frag)))
18406 (defun org-create-formula-image (string tofile options buffer &optional type)
18407 "Create an image from LaTeX source using dvipng or convert.
18408 This function calls either `org-create-formula-image-with-dvipng'
18409 or `org-create-formula-image-with-imagemagick' depending on the
18410 value of `org-latex-create-formula-image-program' or on the value
18411 of the optional TYPE variable.
18413 Note: ultimately these two function should be combined as they
18414 share a good deal of logic."
18415 (org-check-external-command
18416 "latex" "needed to convert LaTeX fragments to images")
18417 (funcall
18418 (case (or type org-latex-create-formula-image-program)
18419 ('dvipng
18420 (org-check-external-command
18421 "dvipng" "needed to convert LaTeX fragments to images")
18422 #'org-create-formula-image-with-dvipng)
18423 ('imagemagick
18424 (org-check-external-command
18425 "convert" "you need to install imagemagick")
18426 #'org-create-formula-image-with-imagemagick)
18427 (t (error
18428 "invalid value of `org-latex-create-formula-image-program'")))
18429 string tofile options buffer))
18431 (declare-function org-export--get-global-options "ox" (&optional backend))
18432 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18433 (defun org-create-formula--latex-header ()
18434 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18435 (org-latex-guess-inputenc
18436 (org-splice-latex-header
18437 org-format-latex-header
18438 org-latex-default-packages-alist
18439 org-latex-packages-alist t
18440 (plist-get
18441 (org-combine-plists
18442 (org-export--get-global-options 'latex)
18443 (org-export--get-inbuffer-options 'latex))
18444 :latex-header))))
18446 ;; This function borrows from Ganesh Swami's latex2png.el
18447 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18448 "This calls dvipng."
18449 (require 'ox-latex)
18450 (let* ((tmpdir (if (featurep 'xemacs)
18451 (temp-directory)
18452 temporary-file-directory))
18453 (texfilebase (make-temp-name
18454 (expand-file-name "orgtex" tmpdir)))
18455 (texfile (concat texfilebase ".tex"))
18456 (dvifile (concat texfilebase ".dvi"))
18457 (pngfile (concat texfilebase ".png"))
18458 (fnh (if (featurep 'xemacs)
18459 (font-height (face-font 'default))
18460 (face-attribute 'default :height nil)))
18461 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18462 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18463 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18464 "Black"))
18465 (bg (or (plist-get options (if buffer :background :html-background))
18466 "Transparent")))
18467 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18468 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18469 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18470 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18471 (let ((latex-header (org-create-formula--latex-header)))
18472 (with-temp-file texfile
18473 (insert latex-header)
18475 (let ((dir default-directory))
18476 (condition-case nil
18477 (progn
18478 (cd tmpdir)
18479 (call-process "latex" nil nil nil texfile))
18480 (error nil))
18481 (cd dir))
18482 (if (not (file-exists-p dvifile))
18483 (progn (message "Failed to create dvi file from %s" texfile) nil)
18484 (condition-case nil
18485 (if (featurep 'xemacs)
18486 (call-process "dvipng" nil nil nil
18487 "-fg" fg "-bg" bg
18488 "-T" "tight"
18489 "-o" pngfile
18490 dvifile)
18491 (call-process "dvipng" nil nil nil
18492 "-fg" fg "-bg" bg
18493 "-D" dpi
18494 ;;"-x" scale "-y" scale
18495 "-T" "tight"
18496 "-o" pngfile
18497 dvifile))
18498 (error nil))
18499 (if (not (file-exists-p pngfile))
18500 (if org-format-latex-signal-error
18501 (error "Failed to create png file from %s" texfile)
18502 (message "Failed to create png file from %s" texfile)
18503 nil)
18504 ;; Use the requested file name and clean up
18505 (copy-file pngfile tofile 'replace)
18506 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18507 (if (file-exists-p (concat texfilebase e))
18508 (delete-file (concat texfilebase e))))
18509 pngfile))))
18511 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18512 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18513 "This calls convert, which is included into imagemagick."
18514 (require 'ox-latex)
18515 (let* ((tmpdir (if (featurep 'xemacs)
18516 (temp-directory)
18517 temporary-file-directory))
18518 (texfilebase (make-temp-name
18519 (expand-file-name "orgtex" tmpdir)))
18520 (texfile (concat texfilebase ".tex"))
18521 (pdffile (concat texfilebase ".pdf"))
18522 (pngfile (concat texfilebase ".png"))
18523 (fnh (if (featurep 'xemacs)
18524 (font-height (face-font 'default))
18525 (face-attribute 'default :height nil)))
18526 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18527 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18528 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18529 "black"))
18530 (bg (or (plist-get options (if buffer :background :html-background))
18531 "white")))
18532 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18533 (setq fg (org-latex-color-format fg)))
18534 (if (eq bg 'default) (setq bg (org-latex-color :background))
18535 (setq bg (org-latex-color-format
18536 (if (string= bg "Transparent") "white" bg))))
18537 (let ((latex-header (org-create-formula--latex-header)))
18538 (with-temp-file texfile
18539 (insert latex-header)
18545 string
18548 (org-latex-compile texfile t)
18549 (if (not (file-exists-p pdffile))
18550 (progn (message "Failed to create pdf file from %s" texfile) nil)
18551 (condition-case nil
18552 (if (featurep 'xemacs)
18553 (call-process "convert" nil nil nil
18554 "-density" "96"
18555 "-trim"
18556 "-antialias"
18557 pdffile
18558 "-quality" "100"
18559 ;; "-sharpen" "0x1.0"
18560 pngfile)
18561 (call-process "convert" nil nil nil
18562 "-density" dpi
18563 "-trim"
18564 "-antialias"
18565 pdffile
18566 "-quality" "100"
18567 ;; "-sharpen" "0x1.0"
18568 pngfile))
18569 (error nil))
18570 (if (not (file-exists-p pngfile))
18571 (if org-format-latex-signal-error
18572 (error "Failed to create png file from %s" texfile)
18573 (message "Failed to create png file from %s" texfile)
18574 nil)
18575 ;; Use the requested file name and clean up
18576 (copy-file pngfile tofile 'replace)
18577 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18578 (if (file-exists-p (concat texfilebase e))
18579 (delete-file (concat texfilebase e))))
18580 pngfile))))
18582 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18583 "Fill a LaTeX header template TPL.
18584 In the template, the following place holders will be recognized:
18587 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18589 [NO-PACKAGES] do not include PKG
18590 [EXTRA] the string EXTRA
18591 [NO-EXTRA] do not include EXTRA
18593 For backward compatibility, if both the positive and the negative place
18595 assumed to be present at the end of the template.
18596 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18597 EXTRA is a string.
18598 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18599 (let (rpl (end ""))
18601 (setq rpl (if (or (match-end 1) (not def-pkg))
18602 "" (org-latex-packages-to-string def-pkg snippets-p t))
18603 tpl (replace-match rpl t t tpl))
18604 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18607 (setq rpl (if (or (match-end 1) (not pkg))
18608 "" (org-latex-packages-to-string pkg snippets-p t))
18609 tpl (replace-match rpl t t tpl))
18610 (if pkg (setq end
18612 (org-latex-packages-to-string pkg snippets-p)))))
18615 (setq rpl (if (or (match-end 1) (not extra))
18617 tpl (replace-match rpl t t tpl))
18623 tpl)))
18625 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18627 (setq pkg (mapconcat (lambda(p)
18628 (cond
18629 ((stringp p) p)
18630 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18631 (format "%% Package %s omitted" (cadr p)))
18632 ((equal "" (car p))
18634 (t
18636 (car p) (cadr p)))))
18637 pkg
18641 (defun org-dvipng-color (attr)
18642 "Return a RGB color specification for dvipng."
18643 (apply 'format "rgb %s %s %s"
18644 (mapcar 'org-normalize-color
18645 (if (featurep 'xemacs)
18646 (color-rgb-components
18647 (face-property 'default
18648 (cond ((eq attr :foreground) 'foreground)
18649 ((eq attr :background) 'background))))
18650 (color-values (face-attribute 'default attr nil))))))
18652 (defun org-dvipng-color-format (color-name)
18653 "Convert COLOR-NAME to a RGB color value for dvipng."
18654 (apply 'format "rgb %s %s %s"
18655 (mapcar 'org-normalize-color
18656 (color-values color-name))))
18658 (defun org-latex-color (attr)
18659 "Return a RGB color for the LaTeX color package."
18660 (apply 'format "%s,%s,%s"
18661 (mapcar 'org-normalize-color
18662 (if (featurep 'xemacs)
18663 (color-rgb-components
18664 (face-property 'default
18665 (cond ((eq attr :foreground) 'foreground)
18666 ((eq attr :background) 'background))))
18667 (color-values (face-attribute 'default attr nil))))))
18669 (defun org-latex-color-format (color-name)
18670 "Convert COLOR-NAME to a RGB color value."
18671 (apply 'format "%s,%s,%s"
18672 (mapcar 'org-normalize-color
18673 (color-values color-name))))
18675 (defun org-normalize-color (value)
18676 "Return string to be used as color value for an RGB component."
18677 (format "%g" (/ value 65535.0)))
18680 \f
18681 ;; Image display
18683 (defvar org-inline-image-overlays nil)
18684 (make-variable-buffer-local 'org-inline-image-overlays)
18686 (defun org-toggle-inline-images (&optional include-linked)
18687 "Toggle the display of inline images.
18688 INCLUDE-LINKED is passed to `org-display-inline-images'."
18689 (interactive "P")
18690 (if org-inline-image-overlays
18691 (progn
18692 (org-remove-inline-images)
18693 (message "Inline image display turned off"))
18694 (org-display-inline-images include-linked)
18695 (if (and (org-called-interactively-p)
18696 org-inline-image-overlays)
18697 (message "%d images displayed inline"
18698 (length org-inline-image-overlays))
18699 (message "No images to display inline"))))
18701 (defun org-redisplay-inline-images ()
18702 "Refresh the display of inline images."
18703 (interactive)
18704 (if (not org-inline-image-overlays)
18705 (org-toggle-inline-images)
18706 (org-toggle-inline-images)
18707 (org-toggle-inline-images)))
18709 (defun org-display-inline-images (&optional include-linked refresh beg end)
18710 "Display inline images.
18711 Normally only links without a description part are inlined, because this
18712 is how it will work for export. When INCLUDE-LINKED is set, also links
18713 with a description part will be inlined. This can be nice for a quick
18714 look at those images, but it does not reflect what exported files will look
18715 like.
18716 When REFRESH is set, refresh existing images between BEG and END.
18717 This will create new image displays only if necessary.
18718 BEG and END default to the buffer boundaries."
18719 (interactive "P")
18720 (unless refresh
18721 (org-remove-inline-images)
18722 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18723 (save-excursion
18724 (save-restriction
18725 (widen)
18726 (setq beg (or beg (point-min)) end (or end (point-max)))
18727 (goto-char beg)
18729 (substring (org-image-file-name-regexp) 0 -2)
18731 (case-fold-search t)
18732 old file ov img type attrwidth width)
18733 (while (re-search-forward re end t)
18734 (setq old (get-char-property-and-overlay (match-beginning 1)
18735 'org-image-overlay)
18736 file (expand-file-name
18737 (concat (or (match-string 3) "") (match-string 4))))
18738 (when (image-type-available-p 'imagemagick)
18739 (setq attrwidth (if (or (listp org-image-actual-width)
18740 (null org-image-actual-width))
18741 (save-excursion
18742 (save-match-data
18743 (when (re-search-backward
18745 (save-excursion
18747 (string-to-number (match-string 1))))))
18748 width (cond ((eq org-image-actual-width t) nil)
18749 ((null org-image-actual-width) attrwidth)
18750 ((numberp org-image-actual-width)
18751 org-image-actual-width)
18752 ((listp org-image-actual-width)
18753 (or attrwidth (car org-image-actual-width))))
18754 type (if width 'imagemagick)))
18755 (when (file-exists-p file)
18756 (if (and (car-safe old) refresh)
18757 (image-refresh (overlay-get (cdr old) 'display))
18758 (setq img (save-match-data (create-image file type nil :width width)))
18759 (when img
18760 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18761 (overlay-put ov 'display img)
18762 (overlay-put ov 'face 'default)
18763 (overlay-put ov 'org-image-overlay t)
18764 (overlay-put ov 'modification-hooks
18765 (list 'org-display-inline-remove-overlay))
18766 (push ov org-inline-image-overlays)))))))))
18768 (define-obsolete-function-alias
18769 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18771 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18772 "Remove inline-display overlay if a corresponding region is modified."
18773 (let ((inhibit-modification-hooks t))
18774 (when (and ov after)
18775 (delete ov org-inline-image-overlays)
18776 (delete-overlay ov))))
18778 (defun org-remove-inline-images ()
18779 "Remove inline display of images."
18780 (interactive)
18781 (mapc 'delete-overlay org-inline-image-overlays)
18782 (setq org-inline-image-overlays nil))
18784 ;;;; Key bindings
18786 ;; Outline functions from `outline-mode-prefix-map'
18787 ;; that can be remapped in Org:
18788 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18789 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18790 (define-key org-mode-map [remap outline-forward-same-level]
18791 'org-forward-heading-same-level)
18792 (define-key org-mode-map [remap outline-backward-same-level]
18793 'org-backward-heading-same-level)
18794 (define-key org-mode-map [remap show-branches]
18795 'org-kill-note-or-show-branches)
18796 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18797 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18798 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18800 ;; Outline functions from `outline-mode-prefix-map' that can not
18801 ;; be remapped in Org:
18802 ;;
18803 ;; - the column "key binding" shows whether the Outline function is still
18804 ;; available in Org mode on the same key that it has been bound to in
18805 ;; Outline mode:
18806 ;; - "overridden": key used for a different functionality in Org mode
18807 ;; - else: key still bound to the same Outline function in Org mode
18808 ;;
18809 ;; | Outline function | key binding | Org replacement |
18810 ;; |------------------------------------+-------------+-----------------------|
18811 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18812 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18813 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18814 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18815 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18816 ;; | `show-entry' | overridden | no replacement |
18817 ;; | `show-children' | `C-c C-i' | visibility cycling |
18818 ;; | `show-branches' | `C-c C-k' | still same function |
18819 ;; | `show-subtree' | overridden | visibility cycling |
18820 ;; | `show-all' | overridden | no replacement |
18821 ;; | `hide-subtree' | overridden | visibility cycling |
18822 ;; | `hide-body' | overridden | no replacement |
18823 ;; | `hide-entry' | overridden | visibility cycling |
18824 ;; | `hide-leaves' | overridden | no replacement |
18825 ;; | `hide-sublevels' | overridden | no replacement |
18826 ;; | `hide-other' | overridden | no replacement |
18828 ;; Make `C-c C-x' a prefix key
18829 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18831 ;; TAB key with modifiers
18832 (org-defkey org-mode-map "\C-i" 'org-cycle)
18833 (org-defkey org-mode-map [(tab)] 'org-cycle)
18834 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18836 ;; The following line is necessary under Suse GNU/Linux
18837 (unless (featurep 'xemacs)
18838 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18839 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18840 (define-key org-mode-map [backtab] 'org-shifttab)
18842 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18843 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18844 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18846 ;; Cursor keys with modifiers
18847 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18848 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18849 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18850 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18852 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18853 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18854 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18855 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18857 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18858 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18859 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18860 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18862 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18863 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18864 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18865 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18867 ;; Babel keys
18868 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18869 (mapc (lambda (pair)
18870 (define-key org-babel-map (car pair) (cdr pair)))
18871 org-babel-key-bindings)
18873 ;;; Extra keys for tty access.
18874 ;; We only set them when really needed because otherwise the
18875 ;; menus don't show the simple keys
18877 (when (or org-use-extra-keys
18878 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18879 (not window-system))
18880 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18881 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18882 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18883 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18884 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18885 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18886 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18887 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18888 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18889 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18890 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18891 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18892 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18893 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18894 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18895 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18896 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18897 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18898 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18899 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18900 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18901 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18902 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18903 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18904 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18905 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18906 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18907 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18909 ;; All the other keys
18911 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18912 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18913 (if (boundp 'narrow-map)
18914 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18915 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18916 (if (boundp 'narrow-map)
18917 (org-defkey narrow-map "b" 'org-narrow-to-block)
18918 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18919 (if (boundp 'narrow-map)
18920 (org-defkey narrow-map "e" 'org-narrow-to-element)
18921 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18922 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18923 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18924 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18925 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18926 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18927 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18928 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18929 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
18930 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
18931 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18932 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18933 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18934 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18935 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18936 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18937 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18938 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
18939 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18940 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18941 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18942 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18943 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18944 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18945 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18946 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18947 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18949 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18950 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18951 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18952 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18953 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18954 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18955 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18956 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18957 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18958 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18959 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18960 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18961 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18962 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18963 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18964 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18965 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18966 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18967 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18968 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18969 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18971 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18972 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18973 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18974 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18975 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18976 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18977 (org-defkey org-mode-map "\C-c^" 'org-sort)
18978 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18979 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18980 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18981 (org-defkey org-mode-map [remap open-line] 'org-open-line)
18982 (org-defkey org-mode-map "\C-m" 'org-return)
18983 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18984 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18985 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18986 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18987 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18988 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18989 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18990 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18991 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18992 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18993 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18994 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18995 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
18996 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
18997 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
18998 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
18999 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19000 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19001 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19002 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19003 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19004 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19005 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19007 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19008 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19009 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19011 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19012 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19013 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19014 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19015 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19016 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19017 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19018 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19019 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19020 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19021 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19022 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19023 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19025 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19026 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19027 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19028 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19029 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19030 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19031 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19032 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19033 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19035 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19036 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19037 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19038 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19039 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19041 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19043 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19045 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19046 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19048 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19051 (when (featurep 'xemacs)
19052 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19055 (defconst org-speed-commands-default
19056 '(
19057 ("Outline Navigation")
19058 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19059 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19060 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19061 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19062 ("F" . org-next-block)
19063 ("B" . org-previous-block)
19064 ("u" . (org-speed-move-safe 'outline-up-heading))
19065 ("j" . org-goto)
19066 ("g" . (org-refile t))
19067 ("Outline Visibility")
19068 ("c" . org-cycle)
19069 ("C" . org-shifttab)
19070 (" " . org-display-outline-path)
19071 ("s" . org-narrow-to-subtree)
19072 ("=" . org-columns)
19073 ("Outline Structure Editing")
19074 ("U" . org-shiftmetaup)
19075 ("D" . org-shiftmetadown)
19076 ("r" . org-metaright)
19077 ("l" . org-metaleft)
19078 ("R" . org-shiftmetaright)
19079 ("L" . org-shiftmetaleft)
19080 ("i" . (progn (forward-char 1) (call-interactively
19081 'org-insert-heading-respect-content)))
19082 ("^" . org-sort)
19083 ("w" . org-refile)
19084 ("a" . org-archive-subtree-default-with-confirmation)
19085 ("@" . org-mark-subtree)
19086 ("#" . org-toggle-comment)
19087 ("Clock Commands")
19088 ("I" . org-clock-in)
19089 ("O" . org-clock-out)
19090 ("Meta Data Editing")
19091 ("t" . org-todo)
19092 ("," . (org-priority))
19093 ("0" . (org-priority ?\ ))
19094 ("1" . (org-priority ?A))
19095 ("2" . (org-priority ?B))
19096 ("3" . (org-priority ?C))
19097 (":" . org-set-tags-command)
19098 ("e" . org-set-effort)
19099 ("E" . org-inc-effort)
19100 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19101 (org-entry-put (point) "APPT_WARNTIME" m)))
19102 ("Agenda Views etc")
19103 ("v" . org-agenda)
19104 ("/" . org-sparse-tree)
19105 ("Misc")
19106 ("o" . org-open-at-point)
19107 ("?" . org-speed-command-help)
19108 ("<" . (org-agenda-set-restriction-lock 'subtree))
19109 (">" . (org-agenda-remove-restriction-lock))
19110 )
19111 "The default speed commands.")
19113 (defun org-print-speed-command (e)
19114 (if (> (length (car e)) 1)
19115 (progn
19117 (princ (car e))
19119 (princ (make-string (length (car e)) ?-))
19121 (princ (car e))
19122 (princ " ")
19123 (if (symbolp (cdr e))
19124 (princ (symbol-name (cdr e)))
19125 (prin1 (cdr e)))
19128 (defun org-speed-command-help ()
19129 "Show the available speed commands."
19130 (interactive)
19131 (if (not org-use-speed-commands)
19132 (error "Speed commands are not activated, customize `org-use-speed-commands'")
19133 (with-output-to-temp-buffer "*Help*"
19135 (mapc 'org-print-speed-command org-speed-commands-user)
19138 (mapc 'org-print-speed-command org-speed-commands-default))
19139 (with-current-buffer "*Help*"
19140 (setq truncate-lines t))))
19142 (defun org-speed-move-safe (cmd)
19143 "Execute CMD, but make sure that the cursor always ends up in a headline.
19144 If not, return to the original position and throw an error."
19145 (interactive)
19146 (let ((pos (point)))
19147 (call-interactively cmd)
19148 (unless (and (bolp) (org-at-heading-p))
19149 (goto-char pos)
19150 (error "Boundary reached while executing %s" cmd))))
19152 (defvar org-self-insert-command-undo-counter 0)
19154 (defvar org-table-auto-blank-field) ; defined in org-table.el
19155 (defvar org-speed-command nil)
19157 (define-obsolete-function-alias
19158 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19160 (defun org-speed-command-activate (keys)
19161 "Hook for activating single-letter speed commands.
19162 `org-speed-commands-default' specifies a minimal command set.
19163 Use `org-speed-commands-user' for further customization."
19164 (when (or (and (bolp) (looking-at org-outline-regexp))
19165 (and (functionp org-use-speed-commands)
19166 (funcall org-use-speed-commands)))
19167 (cdr (assoc keys (append org-speed-commands-user
19168 org-speed-commands-default)))))
19170 (define-obsolete-function-alias
19171 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19173 (defun org-babel-speed-command-activate (keys)
19174 "Hook for activating single-letter code block commands."
19175 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19176 (cdr (assoc keys org-babel-key-bindings))))
19178 (defcustom org-speed-command-hook
19179 '(org-speed-command-default-hook org-babel-speed-command-hook)
19180 "Hook for activating speed commands at strategic locations.
19181 Hook functions are called in sequence until a valid handler is
19182 found.
19184 Each hook takes a single argument, a user-pressed command key
19185 which is also a `self-insert-command' from the global map.
19187 Within the hook, examine the cursor position and the command key
19188 and return nil or a valid handler as appropriate. Handler could
19189 be one of an interactive command, a function, or a form.
19191 Set `org-use-speed-commands' to non-nil value to enable this
19192 hook. The default setting is `org-speed-command-activate'."
19193 :group 'org-structure
19194 :version "24.1"
19195 :type 'hook)
19197 (defun org-self-insert-command (N)
19198 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19199 If the cursor is in a table looking at whitespace, the whitespace is
19200 overwritten, and the table is not marked as requiring realignment."
19201 (interactive "p")
19202 (org-check-before-invisible-edit 'insert)
19203 (cond
19204 ((and org-use-speed-commands
19205 (setq org-speed-command
19206 (run-hook-with-args-until-success
19207 'org-speed-command-hook (this-command-keys))))
19208 (cond
19209 ((commandp org-speed-command)
19210 (setq this-command org-speed-command)
19211 (call-interactively org-speed-command))
19212 ((functionp org-speed-command)
19213 (funcall org-speed-command))
19214 ((and org-speed-command (listp org-speed-command))
19215 (eval org-speed-command))
19216 (t (let (org-use-speed-commands)
19217 (call-interactively 'org-self-insert-command)))))
19218 ((and
19219 (org-table-p)
19220 (progn
19221 ;; check if we blank the field, and if that triggers align
19222 (and (featurep 'org-table) org-table-auto-blank-field
19223 (member last-command
19224 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19226 ;; got extra space, this field does not determine column width
19227 (let (org-table-may-need-update) (org-table-blank-field))
19228 ;; no extra space, this field may determine column width
19229 (org-table-blank-field)))
19230 t)
19231 (eq N 1)
19233 (let (org-table-may-need-update)
19234 (goto-char (1- (match-end 0)))
19235 (backward-delete-char 1)
19236 (goto-char (match-beginning 0))
19237 (self-insert-command N)))
19238 (t
19239 (setq org-table-may-need-update t)
19240 (self-insert-command N)
19241 (org-fix-tags-on-the-fly)
19242 (if org-self-insert-cluster-for-undo
19243 (if (not (eq last-command 'org-self-insert-command))
19244 (setq org-self-insert-command-undo-counter 1)
19245 (if (>= org-self-insert-command-undo-counter 20)
19246 (setq org-self-insert-command-undo-counter 1)
19247 (and (> org-self-insert-command-undo-counter 0)
19248 buffer-undo-list (listp buffer-undo-list)
19249 (not (cadr buffer-undo-list)) ; remove nil entry
19250 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19251 (setq org-self-insert-command-undo-counter
19252 (1+ org-self-insert-command-undo-counter))))))))
19254 (defun org-check-before-invisible-edit (kind)
19255 "Check is editing if kind KIND would be dangerous with invisible text around.
19256 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19257 ;; First, try to get out of here as quickly as possible, to reduce overhead
19258 (if (and org-catch-invisible-edits
19259 (or (not (boundp 'visible-mode)) (not visible-mode))
19260 (or (get-char-property (point) 'invisible)
19261 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19262 ;; OK, we need to take a closer look
19263 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19264 (invisible-before-point (if (bobp) nil (get-char-property
19265 (1- (point)) 'invisible)))
19266 (border-and-ok-direction
19267 (or
19268 ;; Check if we are acting predictably before invisible text
19269 (and invisible-at-point (not invisible-before-point)
19270 (memq kind '(insert delete-backward)))
19271 ;; Check if we are acting predictably after invisible text
19272 ;; This works not well, and I have turned it off. It seems
19273 ;; better to always show and stop after invisible text.
19274 ;; (and (not invisible-at-point) invisible-before-point
19275 ;; (memq kind '(insert delete)))
19276 )))
19277 (when (or (memq invisible-at-point '(outline org-hide-block t))
19278 (memq invisible-before-point '(outline org-hide-block t)))
19279 (if (eq org-catch-invisible-edits 'error)
19280 (error "Editing in invisible areas is prohibited - make visible first"))
19281 (if (and org-custom-properties-overlays
19282 (y-or-n-p "Display invisible properties in this buffer? "))
19283 (org-toggle-custom-properties-visibility)
19284 ;; Make the area visible
19285 (save-excursion
19286 (if invisible-before-point
19287 (goto-char (previous-single-char-property-change
19288 (point) 'invisible)))
19289 (org-cycle))
19290 (cond
19291 ((eq org-catch-invisible-edits 'show)
19292 ;; That's it, we do the edit after showing
19293 (message
19294 "Unfolding invisible region around point before editing")
19295 (sit-for 1))
19296 ((and (eq org-catch-invisible-edits 'smart)
19297 border-and-ok-direction)
19298 (message "Unfolding invisible region around point before editing"))
19299 (t
19300 ;; Don't do the edit, make the user repeat it in full visibility
19301 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19303 (defun org-fix-tags-on-the-fly ()
19304 (when (and (equal (char-after (point-at-bol)) ?*)
19305 (org-at-heading-p))
19306 (org-align-tags-here org-tags-column)))
19308 (defun org-delete-backward-char (N)
19309 "Like `delete-backward-char', insert whitespace at field end in tables.
19310 When deleting backwards, in tables this function will insert whitespace in
19312 still be marked for re-alignment if the field did fill the entire column,
19313 because, in this case the deletion might narrow the column."
19314 (interactive "p")
19315 (save-match-data
19316 (org-check-before-invisible-edit 'delete-backward)
19317 (if (and (org-table-p)
19318 (eq N 1)
19319 (string-match "|" (buffer-substring (point-at-bol) (point)))
19320 (looking-at ".*?|"))
19321 (let ((pos (point))
19323 (c org-table-may-need-update))
19324 (backward-delete-char N)
19325 (if (not overwrite-mode)
19326 (progn
19327 (skip-chars-forward "^|")
19328 (insert " ")
19329 (goto-char (1- pos))))
19330 ;; noalign: if there were two spaces at the end, this field
19331 ;; does not determine the width of the column.
19332 (if noalign (setq org-table-may-need-update c)))
19333 (backward-delete-char N)
19334 (org-fix-tags-on-the-fly))))
19336 (defun org-delete-char (N)
19337 "Like `delete-char', but insert whitespace at field end in tables.
19338 When deleting characters, in tables this function will insert whitespace in
19340 still be marked for re-alignment if the field did fill the entire column,
19341 because, in this case the deletion might narrow the column."
19342 (interactive "p")
19343 (save-match-data
19344 (org-check-before-invisible-edit 'delete)
19345 (if (and (org-table-p)
19346 (not (bolp))
19347 (not (= (char-after) ?|))
19348 (eq N 1))
19349 (if (looking-at ".*?|")
19350 (let ((pos (point))
19352 (c org-table-may-need-update))
19353 (replace-match
19354 (concat (substring (match-string 0) 1 -1) " |") nil t)
19355 (goto-char pos)
19356 ;; noalign: if there were two spaces at the end, this field
19357 ;; does not determine the width of the column.
19358 (if noalign (setq org-table-may-need-update c)))
19359 (delete-char N))
19360 (delete-char N)
19361 (org-fix-tags-on-the-fly))))
19363 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19364 (put 'org-self-insert-command 'delete-selection t)
19365 (put 'orgtbl-self-insert-command 'delete-selection t)
19366 (put 'org-delete-char 'delete-selection 'supersede)
19367 (put 'org-delete-backward-char 'delete-selection 'supersede)
19368 (put 'org-yank 'delete-selection 'yank)
19370 ;; Make `flyspell-mode' delay after some commands
19371 (put 'org-self-insert-command 'flyspell-delayed t)
19372 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19373 (put 'org-delete-char 'flyspell-delayed t)
19374 (put 'org-delete-backward-char 'flyspell-delayed t)
19376 ;; Make pabbrev-mode expand after org-mode commands
19377 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19378 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19380 ;; How to do this: Measure non-white length of current string
19381 ;; If equal to column width, we should realign.
19383 (defun org-remap (map &rest commands)
19384 "In MAP, remap the functions given in COMMANDS.
19385 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19386 (let (new old)
19387 (while commands
19388 (setq old (pop commands) new (pop commands))
19389 (if (fboundp 'command-remapping)
19390 (org-defkey map (vector 'remap old) new)
19391 (substitute-key-definition old new map global-map)))))
19393 (defun org-transpose-words ()
19394 "Transpose words for Org.
19395 This uses the `org-mode-transpose-word-syntax-table' syntax
19396 table, which interprets characters in `org-emphasis-alist' as
19397 word constituants."
19398 (interactive)
19399 (with-syntax-table org-mode-transpose-word-syntax-table
19400 (call-interactively 'transpose-words)))
19401 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19403 (when (eq org-enable-table-editor 'optimized)
19404 ;; If the user wants maximum table support, we need to hijack
19405 ;; some standard editing functions
19406 (org-remap org-mode-map
19407 'self-insert-command 'org-self-insert-command
19408 'delete-char 'org-delete-char
19409 'delete-backward-char 'org-delete-backward-char)
19410 (org-defkey org-mode-map "|" 'org-force-self-insert))
19412 (defvar org-ctrl-c-ctrl-c-hook nil
19413 "Hook for functions attaching themselves to `C-c C-c'.
19415 This can be used to add additional functionality to the C-c C-c
19416 key which executes context-dependent commands. This hook is run
19417 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19418 run after the last test.
19420 Each function will be called with no arguments. The function
19421 must check if the context is appropriate for it to act. If yes,
19422 it should do its thing and then return a non-nil value. If the
19423 context is wrong, just do nothing and return nil.")
19425 (defvar org-ctrl-c-ctrl-c-final-hook nil
19426 "Hook for functions attaching themselves to `C-c C-c'.
19428 This can be used to add additional functionality to the C-c C-c
19429 key which executes context-dependent commands. This hook is run
19430 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19431 before the first test.
19433 Each function will be called with no arguments. The function
19434 must check if the context is appropriate for it to act. If yes,
19435 it should do its thing and then return a non-nil value. If the
19436 context is wrong, just do nothing and return nil.")
19438 (defvar org-tab-first-hook nil
19439 "Hook for functions to attach themselves to TAB.
19440 See `org-ctrl-c-ctrl-c-hook' for more information.
19441 This hook runs as the first action when TAB is pressed, even before
19442 `org-cycle' messes around with the `outline-regexp' to cater for
19443 inline tasks and plain list item folding.
19444 If any function in this hook returns t, any other actions that
19445 would have been caused by TAB (such as table field motion or visibility
19446 cycling) will not occur.")
19448 (defvar org-tab-after-check-for-table-hook nil
19449 "Hook for functions to attach themselves to TAB.
19450 See `org-ctrl-c-ctrl-c-hook' for more information.
19451 This hook runs after it has been established that the cursor is not in a
19452 table, but before checking if the cursor is in a headline or if global cycling
19453 should be done.
19454 If any function in this hook returns t, not other actions like visibility
19455 cycling will be done.")
19457 (defvar org-tab-after-check-for-cycling-hook nil
19458 "Hook for functions to attach themselves to TAB.
19459 See `org-ctrl-c-ctrl-c-hook' for more information.
19460 This hook runs after it has been established that not table field motion and
19461 not visibility should be done because of current context. This is probably
19462 the place where a package like yasnippets can hook in.")
19464 (defvar org-tab-before-tab-emulation-hook nil
19465 "Hook for functions to attach themselves to TAB.
19466 See `org-ctrl-c-ctrl-c-hook' for more information.
19467 This hook runs after every other options for TAB have been exhausted, but
19470 (defvar org-metaleft-hook nil
19471 "Hook for functions attaching themselves to `M-left'.
19472 See `org-ctrl-c-ctrl-c-hook' for more information.")
19473 (defvar org-metaright-hook nil
19474 "Hook for functions attaching themselves to `M-right'.
19475 See `org-ctrl-c-ctrl-c-hook' for more information.")
19476 (defvar org-metaup-hook nil
19477 "Hook for functions attaching themselves to `M-up'.
19478 See `org-ctrl-c-ctrl-c-hook' for more information.")
19479 (defvar org-metadown-hook nil
19480 "Hook for functions attaching themselves to `M-down'.
19481 See `org-ctrl-c-ctrl-c-hook' for more information.")
19482 (defvar org-shiftmetaleft-hook nil
19483 "Hook for functions attaching themselves to `M-S-left'.
19484 See `org-ctrl-c-ctrl-c-hook' for more information.")
19485 (defvar org-shiftmetaright-hook nil
19486 "Hook for functions attaching themselves to `M-S-right'.
19487 See `org-ctrl-c-ctrl-c-hook' for more information.")
19488 (defvar org-shiftmetaup-hook nil
19489 "Hook for functions attaching themselves to `M-S-up'.
19490 See `org-ctrl-c-ctrl-c-hook' for more information.")
19491 (defvar org-shiftmetadown-hook nil
19492 "Hook for functions attaching themselves to `M-S-down'.
19493 See `org-ctrl-c-ctrl-c-hook' for more information.")
19494 (defvar org-metareturn-hook nil
19495 "Hook for functions attaching themselves to `M-RET'.
19496 See `org-ctrl-c-ctrl-c-hook' for more information.")
19497 (defvar org-shiftup-hook nil
19498 "Hook for functions attaching themselves to `S-up'.
19499 See `org-ctrl-c-ctrl-c-hook' for more information.")
19500 (defvar org-shiftup-final-hook nil
19501 "Hook for functions attaching themselves to `S-up'.
19502 This one runs after all other options except shift-select have been excluded.
19503 See `org-ctrl-c-ctrl-c-hook' for more information.")
19504 (defvar org-shiftdown-hook nil
19505 "Hook for functions attaching themselves to `S-down'.
19506 See `org-ctrl-c-ctrl-c-hook' for more information.")
19507 (defvar org-shiftdown-final-hook nil
19508 "Hook for functions attaching themselves to `S-down'.
19509 This one runs after all other options except shift-select have been excluded.
19510 See `org-ctrl-c-ctrl-c-hook' for more information.")
19511 (defvar org-shiftleft-hook nil
19512 "Hook for functions attaching themselves to `S-left'.
19513 See `org-ctrl-c-ctrl-c-hook' for more information.")
19514 (defvar org-shiftleft-final-hook nil
19515 "Hook for functions attaching themselves to `S-left'.
19516 This one runs after all other options except shift-select have been excluded.
19517 See `org-ctrl-c-ctrl-c-hook' for more information.")
19518 (defvar org-shiftright-hook nil
19519 "Hook for functions attaching themselves to `S-right'.
19520 See `org-ctrl-c-ctrl-c-hook' for more information.")
19521 (defvar org-shiftright-final-hook nil
19522 "Hook for functions attaching themselves to `S-right'.
19523 This one runs after all other options except shift-select have been excluded.
19524 See `org-ctrl-c-ctrl-c-hook' for more information.")
19526 (defun org-modifier-cursor-error ()
19527 "Throw an error, a modified cursor command was applied in wrong context."
19528 (error "This command is active in special context like tables, headlines or items"))
19530 (defun org-shiftselect-error ()
19531 "Throw an error because Shift-Cursor command was applied in wrong context."
19532 (if (and (boundp 'shift-select-mode) shift-select-mode)
19533 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19534 (error "This command works only in special context like headlines or timestamps")))
19536 (defun org-call-for-shift-select (cmd)
19537 (let ((this-command-keys-shift-translated t))
19538 (call-interactively cmd)))
19540 (defun org-shifttab (&optional arg)
19541 "Global visibility cycling or move to previous table field.
19542 Call `org-table-previous-field' within a table.
19543 When ARG is nil, cycle globally through visibility states.
19544 When ARG is a numeric prefix, show contents of this level."
19545 (interactive "P")
19546 (cond
19547 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19548 ((integerp arg)
19549 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19550 (message "Content view to level: %d" arg)
19551 (org-content (prefix-numeric-value arg2))
19552 (org-cycle-show-empty-lines t)
19553 (setq org-cycle-global-status 'overview)))
19554 (t (call-interactively 'org-global-cycle))))
19556 (defun org-shiftmetaleft ()
19557 "Promote subtree or delete table column.
19558 Calls `org-promote-subtree', `org-outdent-item-tree', or
19559 `org-table-delete-column', depending on context. See the
19560 individual commands for more information."
19561 (interactive)
19562 (cond
19563 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19564 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19565 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19566 ((if (not (org-region-active-p)) (org-at-item-p)
19567 (save-excursion (goto-char (region-beginning))
19568 (org-at-item-p)))
19569 (call-interactively 'org-outdent-item-tree))
19570 (t (org-modifier-cursor-error))))
19572 (defun org-shiftmetaright ()
19573 "Demote subtree or insert table column.
19574 Calls `org-demote-subtree', `org-indent-item-tree', or
19575 `org-table-insert-column', depending on context. See the
19576 individual commands for more information."
19577 (interactive)
19578 (cond
19579 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19580 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19581 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19582 ((if (not (org-region-active-p)) (org-at-item-p)
19583 (save-excursion (goto-char (region-beginning))
19584 (org-at-item-p)))
19585 (call-interactively 'org-indent-item-tree))
19586 (t (org-modifier-cursor-error))))
19588 (defun org-shiftmetaup (&optional arg)
19589 "Move subtree up or kill table row.
19590 Calls `org-move-subtree-up' or `org-table-kill-row' or
19591 `org-move-item-up' or `org-timestamp-up', depending on context.
19592 See the individual commands for more information."
19593 (interactive "P")
19594 (cond
19595 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19596 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19597 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19598 ((org-at-item-p) (call-interactively 'org-move-item-up))
19599 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19600 (call-interactively 'org-timestamp-up)))
19601 (t (call-interactively 'org-drag-line-backward))))
19603 (defun org-shiftmetadown (&optional arg)
19604 "Move subtree down or insert table row.
19605 Calls `org-move-subtree-down' or `org-table-insert-row' or
19606 `org-move-item-down' or `org-timestamp-up', depending on context.
19607 See the individual commands for more information."
19608 (interactive "P")
19609 (cond
19610 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19611 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19612 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19613 ((org-at-item-p) (call-interactively 'org-move-item-down))
19614 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19615 (call-interactively 'org-timestamp-down)))
19616 (t (call-interactively 'org-drag-line-forward))))
19618 (defsubst org-hidden-tree-error ()
19619 (error
19620 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19622 (defun org-metaleft (&optional arg)
19623 "Promote heading or move table column to left.
19624 Calls `org-do-promote' or `org-table-move-column', depending on context.
19625 With no specific context, calls the Emacs default `backward-word'.
19626 See the individual commands for more information."
19627 (interactive "P")
19628 (cond
19629 ((run-hook-with-args-until-success 'org-metaleft-hook))
19630 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19631 ((org-with-limited-levels
19632 (or (org-at-heading-p)
19633 (and (org-region-active-p)
19634 (save-excursion
19635 (goto-char (region-beginning))
19636 (org-at-heading-p)))))
19637 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19638 (call-interactively 'org-do-promote))
19639 ;; At an inline task.
19640 ((org-at-heading-p)
19641 (call-interactively 'org-inlinetask-promote))
19642 ((or (org-at-item-p)
19643 (and (org-region-active-p)
19644 (save-excursion
19645 (goto-char (region-beginning))
19646 (org-at-item-p))))
19647 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19648 (call-interactively 'org-outdent-item))
19649 (t (call-interactively 'backward-word))))
19651 (defun org-metaright (&optional arg)
19652 "Demote a subtree, a list item or move table column to right.
19653 In front of a drawer or a block keyword, indent it correctly.
19654 With no specific context, calls the Emacs default `forward-word'.
19655 See the individual commands for more information."
19656 (interactive "P")
19657 (cond
19658 ((run-hook-with-args-until-success 'org-metaright-hook))
19659 ((org-at-table-p) (call-interactively 'org-table-move-column))
19660 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19661 ((org-at-block-p) (call-interactively 'org-indent-block))
19662 ((org-with-limited-levels
19663 (or (org-at-heading-p)
19664 (and (org-region-active-p)
19665 (save-excursion
19666 (goto-char (region-beginning))
19667 (org-at-heading-p)))))
19668 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19669 (call-interactively 'org-do-demote))
19670 ;; At an inline task.
19671 ((org-at-heading-p)
19672 (call-interactively 'org-inlinetask-demote))
19673 ((or (org-at-item-p)
19674 (and (org-region-active-p)
19675 (save-excursion
19676 (goto-char (region-beginning))
19677 (org-at-item-p))))
19678 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19679 (call-interactively 'org-indent-item))
19680 (t (call-interactively 'forward-word))))
19682 (defun org-check-for-hidden (what)
19683 "Check if there are hidden headlines/items in the current visual line.
19684 WHAT can be either `headlines' or `items'. If the current line is
19685 an outline or item heading and it has a folded subtree below it,
19686 this function returns t, nil otherwise."
19687 (let ((re (cond
19688 ((eq what 'headlines) org-outline-regexp-bol)
19689 ((eq what 'items) (org-item-beginning-re))
19690 (t (error "This should not happen"))))
19691 beg end)
19692 (save-excursion
19693 (catch 'exit
19694 (unless (org-region-active-p)
19695 (setq beg (point-at-bol))
19696 (beginning-of-line 2)
19697 (while (and (not (eobp)) ;; this is like `next-line'
19698 (get-char-property (1- (point)) 'invisible))
19699 (beginning-of-line 2))
19700 (setq end (point))
19701 (goto-char beg)
19702 (goto-char (point-at-eol))
19703 (setq end (max end (point)))
19704 (while (re-search-forward re end t)
19705 (if (get-char-property (match-beginning 0) 'invisible)
19706 (throw 'exit t))))
19707 nil))))
19709 (defun org-metaup (&optional arg)
19710 "Move subtree up or move table row up.
19711 Calls `org-move-subtree-up' or `org-table-move-row' or
19712 `org-move-item-up', depending on context. See the individual commands
19713 for more information."
19714 (interactive "P")
19715 (cond
19716 ((run-hook-with-args-until-success 'org-metaup-hook))
19717 ((org-region-active-p)
19718 (let* ((a (min (region-beginning) (region-end)))
19719 (b (1- (max (region-beginning) (region-end))))
19720 (c (save-excursion (goto-char a)
19721 (move-beginning-of-line 0)))
19722 (d (save-excursion (goto-char a)
19723 (move-end-of-line 0) (point))))
19724 (transpose-regions a b c d)
19725 (goto-char c)))
19726 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19727 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19728 ((org-at-item-p) (call-interactively 'org-move-item-up))
19729 (t (org-drag-element-backward))))
19731 (defun org-metadown (&optional arg)
19732 "Move subtree down or move table row down.
19733 Calls `org-move-subtree-down' or `org-table-move-row' or
19734 `org-move-item-down', depending on context. See the individual
19735 commands for more information."
19736 (interactive "P")
19737 (cond
19738 ((run-hook-with-args-until-success 'org-metadown-hook))
19739 ((org-region-active-p)
19740 (let* ((a (min (region-beginning) (region-end)))
19741 (b (max (region-beginning) (region-end)))
19742 (c (save-excursion (goto-char b)
19743 (move-beginning-of-line 1)))
19744 (d (save-excursion (goto-char b)
19745 (move-end-of-line 1) (1+ (point)))))
19746 (transpose-regions a b c d)
19747 (goto-char d)))
19748 ((org-at-table-p) (call-interactively 'org-table-move-row))
19749 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19750 ((org-at-item-p) (call-interactively 'org-move-item-down))
19751 (t (org-drag-element-forward))))
19753 (defun org-shiftup (&optional arg)
19754 "Increase item in timestamp or increase priority of current headline.
19755 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19756 depending on context. See the individual commands for more information."
19757 (interactive "P")
19758 (cond
19759 ((run-hook-with-args-until-success 'org-shiftup-hook))
19760 ((and org-support-shift-select (org-region-active-p))
19761 (org-call-for-shift-select 'previous-line))
19762 ((org-at-timestamp-p t)
19763 (call-interactively (if org-edit-timestamp-down-means-later
19764 'org-timestamp-down 'org-timestamp-up)))
19765 ((and (not (eq org-support-shift-select 'always))
19766 org-enable-priority-commands
19767 (org-at-heading-p))
19768 (call-interactively 'org-priority-up))
19769 ((and (not org-support-shift-select) (org-at-item-p))
19770 (call-interactively 'org-previous-item))
19771 ((org-clocktable-try-shift 'up arg))
19772 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19773 (org-support-shift-select
19774 (org-call-for-shift-select 'previous-line))
19775 (t (org-shiftselect-error))))
19777 (defun org-shiftdown (&optional arg)
19778 "Decrease item in timestamp or decrease priority of current headline.
19779 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19780 depending on context. See the individual commands for more information."
19781 (interactive "P")
19782 (cond
19783 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19784 ((and org-support-shift-select (org-region-active-p))
19785 (org-call-for-shift-select 'next-line))
19786 ((org-at-timestamp-p t)
19787 (call-interactively (if org-edit-timestamp-down-means-later
19788 'org-timestamp-up 'org-timestamp-down)))
19789 ((and (not (eq org-support-shift-select 'always))
19790 org-enable-priority-commands
19791 (org-at-heading-p))
19792 (call-interactively 'org-priority-down))
19793 ((and (not org-support-shift-select) (org-at-item-p))
19794 (call-interactively 'org-next-item))
19795 ((org-clocktable-try-shift 'down arg))
19796 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19797 (org-support-shift-select
19798 (org-call-for-shift-select 'next-line))
19799 (t (org-shiftselect-error))))
19801 (defun org-shiftright (&optional arg)
19802 "Cycle the thing at point or in the current line, depending on context.
19803 Depending on context, this does one of the following:
19805 - switch a timestamp at point one day into the future
19806 - on a headline, switch to the next TODO keyword.
19807 - on an item, switch entire list to the next bullet type
19808 - on a property line, switch to the next allowed value
19809 - on a clocktable definition line, move time block into the future"
19810 (interactive "P")
19811 (cond
19812 ((run-hook-with-args-until-success 'org-shiftright-hook))
19813 ((and org-support-shift-select (org-region-active-p))
19814 (org-call-for-shift-select 'forward-char))
19815 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19816 ((and (not (eq org-support-shift-select 'always))
19817 (org-at-heading-p))
19818 (let ((org-inhibit-logging
19819 (not org-treat-S-cursor-todo-selection-as-state-change))
19820 (org-inhibit-blocking
19821 (not org-treat-S-cursor-todo-selection-as-state-change)))
19822 (org-call-with-arg 'org-todo 'right)))
19823 ((or (and org-support-shift-select
19824 (not (eq org-support-shift-select 'always))
19825 (org-at-item-bullet-p))
19826 (and (not org-support-shift-select) (org-at-item-p)))
19827 (org-call-with-arg 'org-cycle-list-bullet nil))
19828 ((and (not (eq org-support-shift-select 'always))
19829 (org-at-property-p))
19830 (call-interactively 'org-property-next-allowed-value))
19831 ((org-clocktable-try-shift 'right arg))
19832 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19833 (org-support-shift-select
19834 (org-call-for-shift-select 'forward-char))
19835 (t (org-shiftselect-error))))
19837 (defun org-shiftleft (&optional arg)
19838 "Cycle the thing at point or in the current line, depending on context.
19839 Depending on context, this does one of the following:
19841 - switch a timestamp at point one day into the past
19842 - on a headline, switch to the previous TODO keyword.
19843 - on an item, switch entire list to the previous bullet type
19844 - on a property line, switch to the previous allowed value
19845 - on a clocktable definition line, move time block into the past"
19846 (interactive "P")
19847 (cond
19848 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19849 ((and org-support-shift-select (org-region-active-p))
19850 (org-call-for-shift-select 'backward-char))
19851 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19852 ((and (not (eq org-support-shift-select 'always))
19853 (org-at-heading-p))
19854 (let ((org-inhibit-logging
19855 (not org-treat-S-cursor-todo-selection-as-state-change))
19856 (org-inhibit-blocking
19857 (not org-treat-S-cursor-todo-selection-as-state-change)))
19858 (org-call-with-arg 'org-todo 'left)))
19859 ((or (and org-support-shift-select
19860 (not (eq org-support-shift-select 'always))
19861 (org-at-item-bullet-p))
19862 (and (not org-support-shift-select) (org-at-item-p)))
19863 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19864 ((and (not (eq org-support-shift-select 'always))
19865 (org-at-property-p))
19866 (call-interactively 'org-property-previous-allowed-value))
19867 ((org-clocktable-try-shift 'left arg))
19868 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19869 (org-support-shift-select
19870 (org-call-for-shift-select 'backward-char))
19871 (t (org-shiftselect-error))))
19873 (defun org-shiftcontrolright ()
19874 "Switch to next TODO set."
19875 (interactive)
19876 (cond
19877 ((and org-support-shift-select (org-region-active-p))
19878 (org-call-for-shift-select 'forward-word))
19879 ((and (not (eq org-support-shift-select 'always))
19880 (org-at-heading-p))
19881 (org-call-with-arg 'org-todo 'nextset))
19882 (org-support-shift-select
19883 (org-call-for-shift-select 'forward-word))
19884 (t (org-shiftselect-error))))
19886 (defun org-shiftcontrolleft ()
19887 "Switch to previous TODO set."
19888 (interactive)
19889 (cond
19890 ((and org-support-shift-select (org-region-active-p))
19891 (org-call-for-shift-select 'backward-word))
19892 ((and (not (eq org-support-shift-select 'always))
19893 (org-at-heading-p))
19894 (org-call-with-arg 'org-todo 'previousset))
19895 (org-support-shift-select
19896 (org-call-for-shift-select 'backward-word))
19897 (t (org-shiftselect-error))))
19899 (defun org-shiftcontrolup (&optional n)
19900 "Change timestamps synchronously up in CLOCK log lines.
19901 Optional argument N tells to change by that many units."
19902 (interactive "P")
19903 (cond ((and (not org-support-shift-select)
19904 (org-at-clock-log-p)
19905 (org-at-timestamp-p t))
19906 (org-clock-timestamps-up n))
19907 (t (org-shiftselect-error))))
19909 (defun org-shiftcontroldown (&optional n)
19910 "Change timestamps synchronously down in CLOCK log lines.
19911 Optional argument N tells to change by that many units."
19912 (interactive "P")
19913 (cond ((and (not org-support-shift-select)
19914 (org-at-clock-log-p)
19915 (org-at-timestamp-p t))
19916 (org-clock-timestamps-down n))
19917 (t (org-shiftselect-error))))
19919 (defun org-ctrl-c-ret ()
19920 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19921 (interactive)
19922 (cond
19923 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19924 (t (call-interactively 'org-insert-heading))))
19926 (defun org-find-visible ()
19927 (let ((s (point)))
19928 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19929 (get-char-property s 'invisible)))
19930 s))
19931 (defun org-find-invisible ()
19932 (let ((s (point)))
19933 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19934 (not (get-char-property s 'invisible))))
19935 s))
19937 (defun org-copy-visible (beg end)
19938 "Copy the visible parts of the region."
19939 (interactive "r")
19940 (let (snippets s)
19941 (save-excursion
19942 (save-restriction
19943 (narrow-to-region beg end)
19944 (setq s (goto-char (point-min)))
19945 (while (not (= (point) (point-max)))
19946 (goto-char (org-find-invisible))
19947 (push (buffer-substring s (point)) snippets)
19948 (setq s (goto-char (org-find-visible))))))
19949 (kill-new (apply 'concat (nreverse snippets)))))
19951 (defun org-copy-special ()
19952 "Copy region in table or copy current subtree.
19953 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19954 See the individual commands for more information."
19955 (interactive)
19956 (call-interactively
19957 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19959 (defun org-cut-special ()
19960 "Cut region in table or cut current subtree.
19961 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19962 See the individual commands for more information."
19963 (interactive)
19964 (call-interactively
19965 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19967 (defun org-paste-special (arg)
19968 "Paste rectangular region into table, or past subtree relative to level.
19969 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19970 See the individual commands for more information."
19971 (interactive "P")
19972 (if (org-at-table-p)
19973 (org-table-paste-rectangle)
19974 (org-paste-subtree arg)))
19976 (defsubst org-in-fixed-width-region-p ()
19977 "Is point in a fixed-width region?"
19978 (save-match-data
19979 (eq 'fixed-width (org-element-type (org-element-at-point)))))
19981 (defun org-edit-special (&optional arg)
19982 "Call a special editor for the element at point.
19983 When at a table, call the formula editor with `org-table-edit-formulas'.
19984 When in a source code block, call `org-edit-src-code'.
19985 When in a fixed-width region, call `org-edit-fixed-width-region'.
19986 When at an #+INCLUDE keyword, visit the included file.
19987 On a link, call `ffap' to visit the link at point.
19988 Otherwise, return a user error."
19989 (interactive "P")
19990 (let ((element (org-element-at-point)))
19991 (assert (not buffer-read-only) nil
19992 "Buffer is read-only: %s" (buffer-name))
19993 (case (org-element-type element)
19994 (src-block
19995 (if (not arg) (org-edit-src-code)
19996 (let* ((info (org-babel-get-src-block-info))
19997 (lang (nth 0 info))
19998 (params (nth 2 info))
19999 (session (cdr (assq :session params))))
20000 (if (not session) (org-edit-src-code)
20001 ;; At a src-block with a session and function called with
20002 ;; an ARG: switch to the buffer related to the inferior
20003 ;; process.
20004 (switch-to-buffer
20005 (funcall (intern (concat "org-babel-prep-session:" lang))
20006 session params))))))
20007 (keyword
20008 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20009 (find-file
20010 (org-remove-double-quotes
20011 (car (org-split-string (org-element-property :value element)))))
20012 (user-error "No special environment to edit here")))
20013 (table
20014 (if (eq (org-element-property :type element) 'table.el)
20015 (org-edit-src-code)
20016 (call-interactively 'org-table-edit-formulas)))
20017 ;; Only Org tables contain `table-row' type elements.
20018 (table-row (call-interactively 'org-table-edit-formulas))
20019 ((example-block export-block) (org-edit-src-code))
20020 (fixed-width (org-edit-fixed-width-region))
20021 (otherwise
20022 ;; No notable element at point. Though, we may be at a link,
20023 ;; which is an object. Thus, scan deeper.
20024 (if (eq (org-element-type (org-element-context element)) 'link)
20025 (call-interactively 'ffap)
20026 (user-error "No special environment to edit here"))))))
20028 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20029 (defun org-ctrl-c-ctrl-c (&optional arg)
20030 "Set tags in headline, or update according to changed information at point.
20032 This command does many different things, depending on context:
20034 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20035 this is what we do.
20037 - If the cursor is on a statistics cookie, update it.
20039 - If the cursor is in a headline, prompt for tags and insert them
20040 into the current line, aligned to `org-tags-column'. When called
20041 with prefix arg, realign all tags in the current buffer.
20043 - If the cursor is in one of the special #+KEYWORD lines, this
20044 triggers scanning the buffer for these lines and updating the
20045 information.
20047 - If the cursor is inside a table, realign the table. This command
20048 works even if the automatic table editor has been turned off.
20050 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20051 the entire table.
20053 - If the cursor is at a footnote reference or definition, jump to
20054 the corresponding definition or references, respectively.
20056 - If the cursor is a the beginning of a dynamic block, update it.
20058 - If the current buffer is a capture buffer, close note and file it.
20060 - If the cursor is on a <<<target>>>, update radio targets and
20061 corresponding links in this buffer.
20063 - If the cursor is on a numbered item in a plain list, renumber the
20064 ordered list.
20066 - If the cursor is on a checkbox, toggle it.
20068 - If the cursor is on a code block, evaluate it. The variable
20069 `org-confirm-babel-evaluate' can be used to control prompting
20070 before code block evaluation, by default every code block
20071 evaluation requires confirmation. Code block evaluation can be
20072 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20073 (interactive "P")
20074 (cond
20075 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20076 org-occur-highlights
20077 org-latex-fragment-image-overlays)
20078 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20079 (org-remove-occur-highlights)
20080 (org-remove-latex-fragment-image-overlays)
20081 (message "Temporary highlights/overlays removed from current buffer"))
20082 ((and (local-variable-p 'org-finish-function (current-buffer))
20083 (fboundp org-finish-function))
20084 (funcall org-finish-function))
20085 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20086 (t
20087 (let* ((context (org-element-context)) (type (org-element-type context)))
20088 ;; Test if point is within a blank line.
20090 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20091 (user-error "C-c C-c can do nothing useful at this location"))
20092 ;; For convenience: at the first line of a paragraph on the
20093 ;; same line as an item, apply function on that item instead.
20094 (when (eq type 'paragraph)
20095 (let ((parent (org-element-property :parent context)))
20096 (when (and (eq (org-element-type parent) 'item)
20097 (= (point-at-bol) (org-element-property :begin parent)))
20098 (setq context parent type 'item))))
20099 ;; Act according to type of element or object at point.
20100 (case type
20101 (clock (org-clock-update-time-maybe))
20102 (dynamic-block
20103 (save-excursion
20104 (goto-char (org-element-property :post-affiliated context))
20105 (org-update-dblock)))
20106 (footnote-definition
20107 (goto-char (org-element-property :post-affiliated context))
20108 (call-interactively 'org-footnote-action))
20109 (footnote-reference (call-interactively 'org-footnote-action))
20110 ((headline inlinetask)
20111 (save-excursion (goto-char (org-element-property :begin context))
20112 (call-interactively 'org-set-tags)))
20113 (item
20114 ;; At an item: a double C-u set checkbox to "[-]"
20115 ;; unconditionally, whereas a single one will toggle its
20116 ;; presence. Without an universal argument, if the item
20117 ;; has a checkbox, toggle it. Otherwise repair the list.
20118 (let* ((box (org-element-property :checkbox context))
20119 (struct (org-element-property :structure context))
20120 (old-struct (copy-tree struct))
20121 (parents (org-list-parents-alist struct))
20122 (prevs (org-list-prevs-alist struct))
20123 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20124 (org-list-set-checkbox
20125 (org-element-property :begin context) struct
20126 (cond ((equal arg '(16)) "[-]")
20127 ((and (not box) (equal arg '(4))) "[ ]")
20128 ((or (not box) (equal arg '(4))) nil)
20129 ((eq box 'on) "[ ]")
20130 (t "[X]")))
20131 ;; Mimic `org-list-write-struct' but with grabbing
20132 ;; a return value from `org-list-struct-fix-box'.
20133 (org-list-struct-fix-ind struct parents 2)
20134 (org-list-struct-fix-item-end struct)
20135 (org-list-struct-fix-bul struct prevs)
20136 (org-list-struct-fix-ind struct parents)
20137 (let ((block-item
20138 (org-list-struct-fix-box struct parents prevs orderedp)))
20139 (if (and box (equal struct old-struct))
20140 (if (equal arg '(16))
20141 (message "Checkboxes already reset")
20142 (user-error "Cannot toggle this checkbox: %s"
20143 (if (eq box 'on)
20144 "all subitems checked"
20145 "unchecked subitems")))
20146 (org-list-struct-apply-struct struct old-struct)
20147 (org-update-checkbox-count-maybe))
20148 (when block-item
20149 (message "Checkboxes were removed due to empty box at line %d"
20150 (org-current-line block-item))))))
20151 (keyword
20152 (let ((org-inhibit-startup-visibility-stuff t)
20153 (org-startup-align-all-tables nil))
20154 (when (boundp 'org-table-coordinate-overlays)
20155 (mapc 'delete-overlay org-table-coordinate-overlays)
20156 (setq org-table-coordinate-overlays nil))
20157 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20158 (message "Local setup has been refreshed"))
20159 (plain-list
20160 ;; At a plain list, with a double C-u argument, set
20161 ;; checkboxes of each item to "[-]", whereas a single one
20162 ;; will toggle their presence according to the state of the
20163 ;; first item in the list. Without an argument, repair the
20164 ;; list.
20165 (let* ((begin (org-element-property :contents-begin context))
20166 (beginm (move-marker (make-marker) begin))
20167 (struct (org-element-property :structure context))
20168 (old-struct (copy-tree struct))
20169 (first-box (save-excursion
20170 (goto-char begin)
20171 (looking-at org-list-full-item-re)
20172 (match-string-no-properties 3)))
20173 (new-box (cond ((equal arg '(16)) "[-]")
20174 ((equal arg '(4)) (unless first-box "[ ]"))
20175 ((equal first-box "[X]") "[ ]")
20176 (t "[X]"))))
20177 (cond
20178 (arg
20179 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20180 (org-list-get-all-items
20181 begin struct (org-list-prevs-alist struct))))
20182 ((and first-box (eq (point) begin))
20183 ;; For convenience, when point is at bol on the first
20184 ;; item of the list and no argument is provided, simply
20185 ;; toggle checkbox of that item, if any.
20186 (org-list-set-checkbox begin struct new-box)))
20187 (org-list-write-struct
20188 struct (org-list-parents-alist struct) old-struct)
20189 (org-update-checkbox-count-maybe)
20190 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20191 ((property-drawer node-property)
20192 (call-interactively 'org-property-action))
20193 ((radio-target target)
20194 (call-interactively 'org-update-radio-target-regexp))
20195 (statistics-cookie
20196 (call-interactively 'org-update-statistics-cookies))
20197 ((table table-cell table-row)
20198 ;; At a table, recalculate every field and align it. Also
20199 ;; send the table if necessary. If the table has
20200 ;; a `table.el' type, just give up. At a table row or
20201 ;; cell, maybe recalculate line but always align table.
20202 (if (eq (org-element-property :type context) 'table.el)
20203 (message "Use C-c ' to edit table.el tables")
20204 (let ((org-enable-table-editor t))
20205 (if (or (eq type 'table)
20206 ;; Check if point is at a TBLFM line.
20207 (and (eq type 'table-row)
20208 (= (point) (org-element-property :end context))))
20209 (save-excursion
20210 (if (org-at-TBLFM-p) (org-calc-current-TBLFM)
20211 (goto-char (org-element-property :contents-begin context))
20212 (org-call-with-arg 'org-table-recalculate (or arg t))
20213 (orgtbl-send-table 'maybe)))
20214 (org-table-maybe-eval-formula)
20215 (cond (arg (call-interactively 'org-table-recalculate))
20216 ((org-table-maybe-recalculate-line))
20217 (t (org-table-align)))))))
20218 (timestamp (org-timestamp-change 0 'day))
20219 (otherwise
20220 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20221 (user-error
20222 "C-c C-c can do nothing useful at this location")))))))))
20224 (defun org-mode-restart ()
20225 "Restart Org-mode, to scan again for special lines.
20226 Also updates the keyword regular expressions."
20227 (interactive)
20228 (org-mode)
20229 (message "Org-mode restarted"))
20231 (defun org-kill-note-or-show-branches ()
20232 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20233 (interactive)
20234 (if (not org-finish-function)
20235 (progn
20236 (hide-subtree)
20237 (call-interactively 'show-branches))
20238 (let ((org-note-abort t))
20239 (funcall org-finish-function))))
20241 (defun org-open-line (n)
20242 "Insert a new row in tables, call `open-line' elsewhere."
20243 (interactive "*p")
20244 (if (org-at-table-p)
20245 (org-table-insert-row)
20246 (open-line n)))
20248 (defun org-return (&optional indent)
20249 "Goto next table row or insert a newline.
20250 Calls `org-table-next-row' or `newline', depending on context.
20251 See the individual commands for more information."
20252 (interactive)
20253 (let (org-ts-what)
20254 (cond
20255 ((or (bobp) (org-in-src-block-p))
20256 (if indent (newline-and-indent) (newline)))
20257 ((org-at-table-p)
20258 (org-table-justify-field-maybe)
20259 (call-interactively 'org-table-next-row))
20260 ;; when `newline-and-indent' is called within a list, make sure
20261 ;; text moved stays inside the item.
20262 ((and (org-in-item-p) indent)
20263 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20264 (progn
20265 (save-match-data (newline))
20266 (org-indent-line-to (length (match-string 0))))
20267 (let ((ind (org-get-indentation)))
20268 (newline)
20269 (if (org-looking-back org-list-end-re)
20270 (org-indent-line)
20271 (org-indent-line-to ind)))))
20272 ((and org-return-follows-link
20273 (org-at-timestamp-p t)
20274 (not (eq org-ts-what 'after)))
20275 (org-follow-timestamp-link))
20276 ((and org-return-follows-link
20277 (let ((tprop (get-text-property (point) 'face)))
20278 (or (eq tprop 'org-link)
20279 (and (listp tprop) (memq 'org-link tprop)))))
20280 (call-interactively 'org-open-at-point))
20281 ((and (org-at-heading-p)
20282 (looking-at
20284 (org-show-entry)
20285 (end-of-line 1)
20286 (newline))
20287 (t (if indent (newline-and-indent) (newline))))))
20289 (defun org-return-indent ()
20290 "Goto next table row or insert a newline and indent.
20291 Calls `org-table-next-row' or `newline-and-indent', depending on
20292 context. See the individual commands for more information."
20293 (interactive)
20294 (org-return t))
20296 (defun org-ctrl-c-star ()
20297 "Compute table, or change heading status of lines.
20298 Calls `org-table-recalculate' or `org-toggle-heading',
20299 depending on context."
20300 (interactive)
20301 (cond
20302 ((org-at-table-p)
20303 (call-interactively 'org-table-recalculate))
20304 (t
20305 ;; Convert all lines in region to list items
20306 (call-interactively 'org-toggle-heading))))
20308 (defun org-ctrl-c-minus ()
20309 "Insert separator line in table or modify bullet status of line.
20310 Also turns a plain line or a region of lines into list items.
20311 Calls `org-table-insert-hline', `org-toggle-item', or
20312 `org-cycle-list-bullet', depending on context."
20313 (interactive)
20314 (cond
20315 ((org-at-table-p)
20316 (call-interactively 'org-table-insert-hline))
20317 ((org-region-active-p)
20318 (call-interactively 'org-toggle-item))
20319 ((org-in-item-p)
20320 (call-interactively 'org-cycle-list-bullet))
20321 (t
20322 (call-interactively 'org-toggle-item))))
20324 (defun org-toggle-item (arg)
20325 "Convert headings or normal lines to items, items to normal lines.
20326 If there is no active region, only the current line is considered.
20328 If the first non blank line in the region is a headline, convert
20329 all headlines to items, shifting text accordingly.
20331 If it is an item, convert all items to normal lines.
20333 If it is normal text, change region into a list of items.
20334 With a prefix argument ARG, change the region in a single item."
20335 (interactive "P")
20336 (let ((shift-text
20337 (function
20338 ;; Shift text in current section to IND, from point to END.
20339 ;; The function leaves point to END line.
20340 (lambda (ind end)
20341 (let ((min-i 1000) (end (copy-marker end)))
20342 ;; First determine the minimum indentation (MIN-I) of
20343 ;; the text.
20344 (save-excursion
20345 (catch 'exit
20346 (while (< (point) end)
20347 (let ((i (org-get-indentation)))
20348 (cond
20349 ;; Skip blank lines and inline tasks.
20351 ((looking-at org-outline-regexp-bol))
20352 ;; We can't find less than 0 indentation.
20353 ((zerop i) (throw 'exit (setq min-i 0)))
20354 ((< i min-i) (setq min-i i))))
20355 (forward-line))))
20356 ;; Then indent each line so that a line indented to
20357 ;; MIN-I becomes indented to IND. Ignore blank lines
20358 ;; and inline tasks in the process.
20359 (let ((delta (- ind min-i)))
20360 (while (< (point) end)
20362 (looking-at org-outline-regexp-bol))
20363 (org-indent-line-to (+ (org-get-indentation) delta)))
20364 (forward-line)))))))
20365 (skip-blanks
20366 (function
20367 ;; Return beginning of first non-blank line, starting from
20368 ;; line at POS.
20369 (lambda (pos)
20370 (save-excursion
20371 (goto-char pos)
20373 (point-at-bol)))))
20374 beg end)
20375 ;; Determine boundaries of changes.
20376 (if (org-region-active-p)
20377 (setq beg (funcall skip-blanks (region-beginning))
20378 end (copy-marker (region-end)))
20379 (setq beg (funcall skip-blanks (point-at-bol))
20380 end (copy-marker (point-at-eol))))
20381 ;; Depending on the starting line, choose an action on the text
20382 ;; between BEG and END.
20383 (org-with-limited-levels
20384 (save-excursion
20385 (goto-char beg)
20386 (cond
20387 ;; Case 1. Start at an item: de-itemize. Note that it only
20388 ;; happens when a region is active: `org-ctrl-c-minus'
20389 ;; would call `org-cycle-list-bullet' otherwise.
20390 ((org-at-item-p)
20391 (while (< (point) end)
20392 (when (org-at-item-p)
20394 (delete-region (point) (match-end 0)))
20395 (forward-line)))
20396 ;; Case 2. Start at an heading: convert to items.
20397 ((org-at-heading-p)
20398 (let* ((bul (org-list-bullet-string "-"))
20399 (bul-len (length bul))
20400 ;; Indentation of the first heading. It should be
20401 ;; relative to the indentation of its parent, if any.
20402 (start-ind (save-excursion
20403 (cond
20404 ((not org-adapt-indentation) 0)
20405 ((not (outline-previous-heading)) 0)
20406 (t (length (match-string 0))))))
20407 ;; Level of first heading. Further headings will be
20408 ;; compared to it to determine hierarchy in the list.
20409 (ref-level (org-reduced-level (org-outline-level))))
20410 (while (< (point) end)
20411 (let* ((level (org-reduced-level (org-outline-level)))
20412 (delta (max 0 (- level ref-level))))
20413 ;; If current headline is less indented than the first
20414 ;; one, set it as reference, in order to preserve
20415 ;; subtrees.
20416 (when (< level ref-level) (setq ref-level level))
20417 (replace-match bul t t)
20418 (org-indent-line-to (+ start-ind (* delta bul-len)))
20419 ;; Ensure all text down to END (or SECTION-END) belongs
20420 ;; to the newly created item.
20421 (let ((section-end (save-excursion
20422 (or (outline-next-heading) (point)))))
20423 (forward-line)
20424 (funcall shift-text
20425 (+ start-ind (* (1+ delta) bul-len))
20426 (min end section-end)))))))
20427 ;; Case 3. Normal line with ARG: make the first line of region
20428 ;; an item, and shift indentation of others lines to
20429 ;; set them as item's body.
20430 (arg (let* ((bul (org-list-bullet-string "-"))
20431 (bul-len (length bul))
20432 (ref-ind (org-get-indentation)))
20434 (insert bul)
20435 (forward-line)
20436 (while (< (point) end)
20437 ;; Ensure that lines less indented than first one
20438 ;; still get included in item body.
20439 (funcall shift-text
20440 (+ ref-ind bul-len)
20441 (min end (save-excursion (or (outline-next-heading)
20442 (point)))))
20443 (forward-line))))
20444 ;; Case 4. Normal line without ARG: turn each non-item line
20445 ;; into an item.
20446 (t
20447 (while (< (point) end)
20448 (unless (or (org-at-heading-p) (org-at-item-p))
20450 (replace-match
20452 (forward-line))))))))
20454 (defun org-toggle-heading (&optional nstars)
20455 "Convert headings to normal text, or items or text to headings.
20456 If there is no active region, only convert the current line.
20459 point into heading.
20461 In a region:
20463 - If the first non blank line is a headline, remove the stars
20464 from all headlines in the region.
20466 - If it is a normal line, turn each and every normal line (i.e.,
20467 not an heading or an item) in the region into headings. If you
20468 want to convert only the first line of this region, use one
20469 universal prefix argument.
20471 - If it is a plain list item, turn all plain list items into headings.
20473 When converting a line into a heading, the number of stars is chosen
20474 such that the lines become children of the current entry. However,
20475 when a numeric prefix argument is given, its value determines the
20476 number of stars to add."
20477 (interactive "P")
20478 (let ((skip-blanks
20479 (function
20480 ;; Return beginning of first non-blank line, starting from
20481 ;; line at POS.
20482 (lambda (pos)
20483 (save-excursion
20484 (goto-char pos)
20485 (while (org-at-comment-p) (forward-line))
20487 (point-at-bol)))))
20488 beg end toggled)
20489 ;; Determine boundaries of changes. If a universal prefix has
20490 ;; been given, put the list in a region. If region ends at a bol,
20491 ;; do not consider the last line to be in the region.
20493 (when (and current-prefix-arg (org-at-item-p))
20494 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20495 (org-mark-element))
20497 (if (org-region-active-p)
20498 (setq beg (funcall skip-blanks (region-beginning))
20499 end (copy-marker (save-excursion
20500 (goto-char (region-end))
20501 (if (bolp) (point) (point-at-eol)))))
20502 (setq beg (funcall skip-blanks (point-at-bol))
20503 end (copy-marker (point-at-eol))))
20504 ;; Ensure inline tasks don't count as headings.
20505 (org-with-limited-levels
20506 (save-excursion
20507 (goto-char beg)
20508 (cond
20509 ;; Case 1. Started at an heading: de-star headings.
20510 ((org-at-heading-p)
20511 (while (< (point) end)
20512 (when (org-at-heading-p t)
20513 (looking-at org-outline-regexp) (replace-match "")
20514 (setq toggled t))
20515 (forward-line)))
20516 ;; Case 2. Started at an item: change items into headlines.
20517 ;; One star will be added by `org-list-to-subtree'.
20518 ((org-at-item-p)
20519 (let* ((stars (make-string
20520 ;; subtract the star that will be added again by
20521 ;; `org-list-to-subtree'
20522 (if (numberp nstars) (1- nstars)
20523 (or (org-current-level) 0))
20524 ?*))
20525 (add-stars
20526 (cond (nstars "") ; stars from prefix only
20527 ((equal stars "") "") ; before first heading
20528 (org-odd-levels-only "*") ; inside heading, odd
20529 (t "")))) ; inside heading, oddeven
20530 (while (< (point) end)
20531 (when (org-at-item-p)
20532 ;; Pay attention to cases when region ends before list.
20533 (let* ((struct (org-list-struct))
20534 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20535 (save-restriction
20536 (narrow-to-region (point) list-end)
20537 (insert
20538 (org-list-to-subtree
20539 (org-list-parse-list t)
20540 '(:istart (concat stars add-stars (funcall get-stars depth))
20541 :icount (concat stars add-stars (funcall get-stars depth)))))))
20542 (setq toggled t))
20543 (forward-line))))
20544 ;; Case 3. Started at normal text: make every line an heading,
20545 ;; skipping headlines and items.
20546 (t (let* ((stars
20547 (make-string
20548 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20549 (add-stars
20550 (cond (nstars "") ; stars from prefix only
20551 ((equal stars "") "*") ; before first heading
20552 (org-odd-levels-only "**") ; inside heading, odd
20553 (t "*"))) ; inside heading, oddeven
20554 (rpl (concat stars add-stars " "))
20555 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20556 (while (< (point) (if (equal nstars '(4)) lend end))
20557 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20559 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20560 (forward-line)))))))
20561 (unless toggled (message "Cannot toggle heading from here"))))
20563 (defun org-meta-return (&optional arg)
20564 "Insert a new heading or wrap a region in a table.
20565 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20566 See the individual commands for more information."
20567 (interactive "P")
20568 (cond
20569 ((run-hook-with-args-until-success 'org-metareturn-hook))
20570 ((or (org-at-drawer-p) (org-at-property-p))
20571 (newline-and-indent))
20572 ((org-at-table-p)
20573 (call-interactively 'org-table-wrap-region))
20574 (t (call-interactively 'org-insert-heading))))
20576 ;;; Menu entries
20578 (defsubst org-in-subtree-not-table-p ()
20579 "Are we in a subtree and not in a table?"
20580 (and (not (org-before-first-heading-p))
20581 (not (org-at-table-p))))
20583 ;; Define the Org-mode menus
20584 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20585 '("Tbl"
20586 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20587 ["Next Field" org-cycle (org-at-table-p)]
20588 ["Previous Field" org-shifttab (org-at-table-p)]
20589 ["Next Row" org-return (org-at-table-p)]
20590 "--"
20591 ["Blank Field" org-table-blank-field (org-at-table-p)]
20592 ["Edit Field" org-table-edit-field (org-at-table-p)]
20593 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20594 "--"
20595 ("Column"
20596 ["Move Column Left" org-metaleft (org-at-table-p)]
20597 ["Move Column Right" org-metaright (org-at-table-p)]
20598 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20599 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20600 ("Row"
20601 ["Move Row Up" org-metaup (org-at-table-p)]
20602 ["Move Row Down" org-metadown (org-at-table-p)]
20603 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20604 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20605 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20606 "--"
20607 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20608 ("Rectangle"
20609 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20610 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20611 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20612 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20613 "--"
20614 ("Calculate"
20615 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20616 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20617 ["Edit Formulas" org-edit-special (org-at-table-p)]
20618 "--"
20619 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20620 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20621 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20622 "--"
20623 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20624 "--"
20625 ["Sum Column/Rectangle" org-table-sum
20626 (or (org-at-table-p) (org-region-active-p))]
20627 ["Which Column?" org-table-current-column (org-at-table-p)])
20628 ["Debug Formulas"
20629 org-table-toggle-formula-debugger
20630 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20631 ["Show Col/Row Numbers"
20632 org-table-toggle-coordinate-overlays
20633 :style toggle
20634 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20635 "--"
20636 ["Create" org-table-create (and (not (org-at-table-p))
20637 org-enable-table-editor)]
20638 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20639 ["Import from File" org-table-import (not (org-at-table-p))]
20640 ["Export to File" org-table-export (org-at-table-p)]
20641 "--"
20642 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20644 (easy-menu-define org-org-menu org-mode-map "Org menu"
20645 '("Org"
20646 ("Show/Hide"
20647 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20648 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20649 ["Sparse Tree..." org-sparse-tree t]
20650 ["Reveal Context" org-reveal t]
20651 ["Show All" show-all t]
20652 "--"
20653 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20654 "--"
20655 ["New Heading" org-insert-heading t]
20656 ("Navigate Headings"
20657 ["Up" outline-up-heading t]
20658 ["Next" outline-next-visible-heading t]
20659 ["Previous" outline-previous-visible-heading t]
20660 ["Next Same Level" outline-forward-same-level t]
20661 ["Previous Same Level" outline-backward-same-level t]
20662 "--"
20663 ["Jump" org-goto t])
20664 ("Edit Structure"
20665 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20666 "--"
20667 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20668 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20669 "--"
20670 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20671 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20672 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20673 "--"
20674 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20675 "--"
20676 ["Copy visible text" org-copy-visible t]
20677 "--"
20678 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20679 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20680 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20681 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20682 "--"
20683 ["Sort Region/Children" org-sort t]
20684 "--"
20685 ["Convert to odd levels" org-convert-to-odd-levels t]
20686 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20687 ("Editing"
20688 ["Emphasis..." org-emphasize t]
20689 ["Edit Source Example" org-edit-special t]
20690 "--"
20691 ["Footnote new/jump" org-footnote-action t]
20692 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20693 ("Archive"
20694 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20695 "--"
20696 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20697 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20698 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20699 )
20700 "--"
20701 ("Hyperlinks"
20702 ["Store Link (Global)" org-store-link t]
20703 ["Find existing link to here" org-occur-link-in-agenda-files t]
20704 ["Insert Link" org-insert-link t]
20705 ["Follow Link" org-open-at-point t]
20706 "--"
20707 ["Next link" org-next-link t]
20708 ["Previous link" org-previous-link t]
20709 "--"
20710 ["Descriptive Links"
20711 org-toggle-link-display
20712 :style radio
20713 :selected org-descriptive-links
20714 ]
20715 ["Literal Links"
20716 org-toggle-link-display
20717 :style radio
20718 :selected (not org-descriptive-links)])
20719 "--"
20720 ("TODO Lists"
20721 ["TODO/DONE/-" org-todo t]
20722 ("Select keyword"
20723 ["Next keyword" org-shiftright (org-at-heading-p)]
20724 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20725 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20726 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20727 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20728 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20729 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20730 "--"
20731 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20732 :selected org-enforce-todo-dependencies :style toggle :active t]
20733 "Settings for tree at point"
20734 ["Do Children sequentially" org-toggle-ordered-property :style radio
20735 :selected (org-entry-get nil "ORDERED")
20736 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20737 ["Do Children parallel" org-toggle-ordered-property :style radio
20738 :selected (not (org-entry-get nil "ORDERED"))
20739 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20740 "--"
20741 ["Set Priority" org-priority t]
20742 ["Priority Up" org-shiftup t]
20743 ["Priority Down" org-shiftdown t]
20744 "--"
20745 ["Get news from all feeds" org-feed-update-all t]
20746 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20747 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20748 ("TAGS and Properties"
20749 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20750 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20751 "--"
20752 ["Set property" org-set-property (not (org-before-first-heading-p))]
20753 ["Column view of properties" org-columns t]
20754 ["Insert Column View DBlock" org-insert-columns-dblock t])
20755 ("Dates and Scheduling"
20756 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20757 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20758 ("Change Date"
20759 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20760 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20761 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20762 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20763 ["Compute Time Range" org-evaluate-time-range t]
20764 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20765 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20766 "--"
20767 ["Custom time format" org-toggle-time-stamp-overlays
20768 :style radio :selected org-display-custom-times]
20769 "--"
20770 ["Goto Calendar" org-goto-calendar t]
20771 ["Date from Calendar" org-date-from-calendar t]
20772 "--"
20773 ["Start/Restart Timer" org-timer-start t]
20774 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20775 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20776 ["Insert Timer String" org-timer t]
20777 ["Insert Timer Item" org-timer-item t])
20778 ("Logging work"
20779 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20780 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20781 ["Clock out" org-clock-out t]
20782 ["Clock cancel" org-clock-cancel t]
20783 "--"
20784 ["Mark as default task" org-clock-mark-default-task t]
20785 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20786 ["Goto running clock" org-clock-goto t]
20787 "--"
20788 ["Display times" org-clock-display t]
20789 ["Create clock table" org-clock-report t]
20790 "--"
20791 ["Record DONE time"
20792 (progn (setq org-log-done (not org-log-done))
20793 (message "Switching to %s will %s record a timestamp"
20794 (car org-done-keywords)
20795 (if org-log-done "automatically" "not")))
20796 :style toggle :selected org-log-done])
20797 "--"
20798 ["Agenda Command..." org-agenda t]
20799 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20800 ("File List for Agenda")
20801 ("Special views current file"
20802 ["TODO Tree" org-show-todo-tree t]
20803 ["Check Deadlines" org-check-deadlines t]
20804 ["Timeline" org-timeline t]
20805 ["Tags/Property tree" org-match-sparse-tree t])
20806 "--"
20807 ["Export/Publish..." org-export-dispatch t]
20808 ("LaTeX"
20809 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20810 :selected org-cdlatex-mode]
20811 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20812 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20813 ["Modify math symbol" org-cdlatex-math-modify
20814 (org-inside-LaTeX-fragment-p)]
20815 ["Insert citation" org-reftex-citation t]
20816 "--"
20817 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20818 "--"
20819 ("MobileOrg"
20820 ["Push Files and Views" org-mobile-push t]
20821 ["Get Captured and Flagged" org-mobile-pull t]
20822 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20823 "--"
20824 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20825 "--"
20826 ("Documentation"
20827 ["Show Version" org-version t]
20828 ["Info Documentation" org-info t])
20829 ("Customize"
20830 ["Browse Org Group" org-customize t]
20831 "--"
20832 ["Expand This Menu" org-create-customize-menu
20833 (fboundp 'customize-menu-create)])
20834 ["Send bug report" org-submit-bug-report t]
20835 "--"
20836 ("Refresh/Reload"
20837 ["Refresh setup current buffer" org-mode-restart t]
20838 ["Reload Org (after update)" org-reload t]
20839 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20840 ))
20842 (defun org-info (&optional node)
20843 "Read documentation for Org-mode in the info system.
20844 With optional NODE, go directly to that node."
20845 (interactive)
20846 (info (format "(org)%s" (or node ""))))
20848 ;;;###autoload
20849 (defun org-submit-bug-report ()
20850 "Submit a bug report on Org-mode via mail.
20852 Don't hesitate to report any problems or inaccurate documentation.
20854 If you don't have setup sending mail from (X)Emacs, please copy the
20855 output buffer into your mail program, as it gives us important
20856 information about your Org-mode version and configuration."
20857 (interactive)
20858 (require 'reporter)
20859 (org-load-modules-maybe)
20860 (org-require-autoloaded-modules)
20861 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20862 (reporter-submit-bug-report
20863 "emacs-orgmode@gnu.org"
20864 (org-version nil 'full)
20865 (let (list)
20866 (save-window-excursion
20867 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20868 (delete-other-windows)
20869 (erase-buffer)
20870 (insert "You are about to submit a bug report to the Org-mode mailing list.
20872 We would like to add your full Org-mode and Outline configuration to the
20873 bug report. This greatly simplifies the work of the maintainer and
20874 other experts on the mailing list.
20876 HOWEVER, some variables you have customized may contain private
20877 information. The names of customers, colleagues, or friends, might
20878 appear in the form of file names, tags, todo states, or search strings.
20879 If you answer yes to the prompt, you might want to check and remove
20880 such private information before sending the email.")
20881 (add-text-properties (point-min) (point-max) '(face org-warning))
20882 (when (yes-or-no-p "Include your Org-mode configuration ")
20883 (mapatoms
20884 (lambda (v)
20885 (and (boundp v)
20887 (or (and (symbol-value v)
20889 (and
20890 (get v 'custom-type) (get v 'standard-value)
20891 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20892 (push v list)))))
20893 (kill-buffer (get-buffer "*Warn about privacy*"))
20894 list))
20895 nil nil
20896 "Remember to cover the basics, that is, what you expected to happen and
20897 what in fact did happen. You don't know how to make a good report? See
20899 http://orgmode.org/manual/Feedback.html#Feedback
20901 Your bug report will be posted to the Org-mode mailing list.
20902 ------------------------------------------------------------------------")
20903 (save-excursion
20908 (defun org-install-agenda-files-menu ()
20909 (let ((bl (buffer-list)))
20910 (save-excursion
20911 (while bl
20912 (set-buffer (pop bl))
20913 (if (derived-mode-p 'org-mode) (setq bl nil)))
20914 (when (derived-mode-p 'org-mode)
20915 (easy-menu-change
20916 '("Org") "File List for Agenda"
20917 (append
20918 (list
20919 ["Edit File List" (org-edit-agenda-file-list) t]
20920 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20921 ["Remove Current File from List" org-remove-file t]
20922 ["Cycle through agenda files" org-cycle-agenda-files t]
20923 ["Occur in all agenda files" org-occur-in-agenda-files t]
20924 "--")
20925 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20927 ;;;; Documentation
20929 (defun org-require-autoloaded-modules ()
20930 (interactive)
20931 (mapc 'require
20932 '(org-agenda org-archive org-attach org-clock org-colview org-id
20933 org-remember org-table org-timer)))
20935 ;;;###autoload
20936 (defun org-reload (&optional uncompiled)
20937 "Reload all org lisp files.
20938 With prefix arg UNCOMPILED, load the uncompiled versions."
20939 (interactive "P")
20940 (require 'loadhist)
20941 (let* ((org-dir (org-find-library-dir "org"))
20942 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20944 (remove-re (mapconcat 'identity
20945 (mapcar (lambda (f) (concat "^" f "$"))
20946 (list (if (featurep 'xemacs)
20947 "org-colview"
20948 "org-colview-xemacs")
20949 "org" "org-loaddefs" "org-version"))
20951 (feats (delete-dups
20952 (mapcar 'file-name-sans-extension
20953 (mapcar 'file-name-nondirectory
20954 (delq nil
20955 (mapcar 'feature-file
20956 features))))))
20957 (lfeat (append
20958 (sort
20959 (setq feats
20960 (delq nil (mapcar
20961 (lambda (f)
20962 (if (and (string-match feature-re f)
20963 (not (string-match remove-re f)))
20964 f nil))
20965 feats)))
20966 'string-lessp)
20967 (list "org-version" "org")))
20968 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
20969 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20970 load-uncore load-misses)
20971 (setq load-misses
20972 (delq 't
20973 (mapcar (lambda (f)
20974 (or (org-load-noerror-mustsuffix (concat org-dir f))
20975 (and (string= org-dir contrib-dir)
20976 (org-load-noerror-mustsuffix (concat contrib-dir f)))
20977 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
20978 (add-to-list 'load-uncore f 'append)
20979 't)
20980 f))
20981 lfeat)))
20982 (if load-uncore
20984 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20985 (if load-misses
20987 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20990 ;;;###autoload
20991 (defun org-customize ()
20992 "Call the customize function with org as argument."
20993 (interactive)
20994 (org-load-modules-maybe)
20995 (org-require-autoloaded-modules)
20996 (customize-browse 'org))
20998 (defun org-create-customize-menu ()
20999 "Create a full customization menu for Org-mode, insert it into the menu."
21000 (interactive)
21001 (org-load-modules-maybe)
21002 (org-require-autoloaded-modules)
21003 (if (fboundp 'customize-menu-create)
21004 (progn
21005 (easy-menu-change
21006 '("Org") "Customize"
21007 `(["Browse Org group" org-customize t]
21008 "--"
21009 ,(customize-menu-create 'org)
21010 ["Set" Custom-set t]
21011 ["Save" Custom-save t]
21012 ["Reset to Current" Custom-reset-current t]
21013 ["Reset to Saved" Custom-reset-saved t]
21014 ["Reset to Standard Settings" Custom-reset-standard t]))
21016 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21018 ;;;; Miscellaneous stuff
21020 ;;; Generally useful functions
21022 (defun org-get-at-bol (property)
21023 "Get text property PROPERTY at beginning of line."
21024 (get-text-property (point-at-bol) property))
21026 (defun org-find-text-property-in-string (prop s)
21027 "Return the first non-nil value of property PROP in string S."
21028 (or (get-text-property 0 prop s)
21029 (get-text-property (or (next-single-property-change 0 prop s) 0)
21030 prop s)))
21032 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21033 "Display the given MESSAGE as a warning."
21034 (if (fboundp 'display-warning)
21035 (display-warning 'org message
21036 (if (featurep 'xemacs) 'warning :warning))
21037 (let ((buf (get-buffer-create "*Org warnings*")))
21038 (with-current-buffer buf
21039 (goto-char (point-max))
21040 (insert "Warning (Org): " message)
21041 (unless (bolp)
21042 (newline)))
21043 (display-buffer buf)
21044 (sit-for 0))))
21046 (defun org-eval (form)
21047 "Eval FORM and return result."
21048 (condition-case error
21049 (eval form)
21050 (error (format "%%![Error: %s]" error))))
21052 (defun org-in-clocktable-p ()
21053 "Check if the cursor is in a clocktable."
21054 (let ((pos (point)) start)
21055 (save-excursion
21056 (end-of-line 1)
21058 (setq start (match-beginning 0))
21060 (>= (match-end 0) pos)
21061 start))))
21063 (defun org-in-commented-line ()
21064 "Is point in a line starting with `#'?"
21065 (equal (char-after (point-at-bol)) ?#))
21067 (defun org-in-indented-comment-line ()
21068 "Is point in a line starting with `#' after some white space?"
21069 (save-excursion
21070 (save-match-data
21071 (goto-char (point-at-bol))
21074 (defun org-in-verbatim-emphasis ()
21075 (save-match-data
21076 (and (org-in-regexp org-emph-re 2)
21077 (>= (point) (match-beginning 3))
21078 (<= (point) (match-end 4))
21079 (member (match-string 3) '("=" "~")))))
21081 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21082 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21083 (if (and marker (marker-buffer marker)
21084 (buffer-live-p (marker-buffer marker)))
21085 (progn
21086 (org-pop-to-buffer-same-window (marker-buffer marker))
21087 (if (or (> marker (point-max)) (< marker (point-min)))
21088 (widen))
21089 (goto-char marker)
21090 (org-show-context 'org-goto))
21091 (if bookmark
21092 (bookmark-jump bookmark)
21093 (error "Cannot find location"))))
21095 (defun org-quote-csv-field (s)
21096 "Quote field for inclusion in CSV material."
21099 s))
21101 (defun org-force-self-insert (N)
21102 "Needed to enforce self-insert under remapping."
21103 (interactive "p")
21104 (self-insert-command N))
21106 (defun org-string-width (s)
21107 "Compute width of string, ignoring invisible characters.
21108 This ignores character with invisibility property `org-link', and also
21109 characters with property `org-cwidth', because these will become invisible
21110 upon the next fontification round."
21111 (let (b l)
21112 (when (or (eq t buffer-invisibility-spec)
21113 (assq 'org-link buffer-invisibility-spec))
21114 (while (setq b (text-property-any 0 (length s)
21115 'invisible 'org-link s))
21116 (setq s (concat (substring s 0 b)
21117 (substring s (or (next-single-property-change
21118 b 'invisible s) (length s)))))))
21119 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21120 (setq s (concat (substring s 0 b)
21121 (substring s (or (next-single-property-change
21122 b 'org-cwidth s) (length s))))))
21123 (setq l (string-width s) b -1)
21124 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21125 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21126 l))
21128 (defun org-shorten-string (s maxlength)
21129 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21130 If the string is shorter or has length MAXLENGTH, just return the
21131 original string. If it is longer, the functions finds a space in the
21132 string, breaks this string off at that locations and adds three dots
21133 as ellipsis. Including the ellipsis, the string will not be longer
21134 than MAXLENGTH. If finding a good breaking point in the string does
21135 not work, the string is just chopped off in the middle of a word
21136 if necessary."
21137 (if (<= (length s) maxlength)
21138 s
21139 (let* ((n (max (- maxlength 4) 1))
21141 (if (string-match re s)
21142 (concat (match-string 1 s) "...")
21143 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21145 (defun org-get-indentation (&optional line)
21146 "Get the indentation of the current line, interpreting tabs.
21147 When LINE is given, assume it represents a line and compute its indentation."
21148 (if line
21149 (if (string-match "^ *" (org-remove-tabs line))
21150 (match-end 0))
21151 (save-excursion
21152 (beginning-of-line 1)
21154 (current-column))))
21156 (defun org-get-string-indentation (s)
21157 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21158 (let ((n -1) (i 0) (w tab-width) c)
21159 (catch 'exit
21160 (while (< (setq n (1+ n)) (length s))
21161 (setq c (aref s n))
21162 (cond ((= c ?\ ) (setq i (1+ i)))
21164 (t (throw 'exit t)))))
21165 i))
21167 (defun org-remove-tabs (s &optional width)
21168 "Replace tabulators in S with spaces.
21169 Assumes that s is a single line, starting in column 0."
21170 (setq width (or width tab-width))
21172 (setq s (replace-match
21173 (make-string
21174 (- (* width (/ (+ (match-beginning 0) width) width))
21175 (match-beginning 0)) ?\ )
21176 t t s)))
21177 s)
21179 (defun org-fix-indentation (line ind)
21180 "Fix indentation in LINE.
21181 IND is a cons cell with target and minimum indentation.
21182 If the current indentation in LINE is smaller than the minimum,
21183 leave it alone. If it is larger than ind, set it to the target."
21184 (let* ((l (org-remove-tabs line))
21185 (i (org-get-indentation l))
21186 (i1 (car ind)) (i2 (cdr ind)))
21187 (if (>= i i2) (setq l (substring line i2)))
21188 (if (> i1 0)
21189 (concat (make-string i1 ?\ ) l)
21190 l)))
21192 (defun org-remove-indentation (code &optional n)
21193 "Remove the maximum common indentation from the lines in CODE.
21194 N may optionally be the number of spaces to remove."
21195 (with-temp-buffer
21196 (insert code)
21197 (org-do-remove-indentation n)
21198 (buffer-string)))
21200 (defun org-do-remove-indentation (&optional n)
21201 "Remove the maximum common indentation from the buffer."
21202 (untabify (point-min) (point-max))
21203 (let ((min 10000) re)
21204 (if n
21205 (setq min n)
21206 (goto-char (point-min))
21208 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21209 (unless (or (= min 0) (= min 10000))
21211 (goto-char (point-min))
21212 (while (re-search-forward re nil t)
21213 (replace-match "")
21214 (end-of-line 1))
21215 min)))
21217 (defun org-fill-template (template alist)
21218 "Find each %key of ALIST in TEMPLATE and replace it."
21219 (let ((case-fold-search nil)
21220 entry key value)
21221 (setq alist (sort (copy-sequence alist)
21222 (lambda (a b) (< (length (car a)) (length (car b))))))
21223 (while (setq entry (pop alist))
21224 (setq template
21225 (replace-regexp-in-string
21226 (concat "%" (regexp-quote (car entry)))
21227 (or (cdr entry) "") template t t)))
21228 template))
21230 (defun org-base-buffer (buffer)
21231 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21232 (if (not buffer)
21233 buffer
21234 (or (buffer-base-buffer buffer)
21235 buffer)))
21237 (defun org-trim (s)
21238 "Remove whitespace at beginning and end of string."
21241 s)
21243 (defun org-wrap (string &optional width lines)
21244 "Wrap string to either a number of lines, or a width in characters.
21245 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21246 that costs. If there is a word longer than WIDTH, the text is actually
21247 wrapped to the length of that word.
21248 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21249 many lines, whatever width that takes.
21250 The return value is a list of lines, without newlines at the end."
21252 (maxword (apply 'max (mapcar 'org-string-width words)))
21253 w ll)
21254 (cond (width
21255 (org-do-wrap words (max maxword width)))
21256 (lines
21257 (setq w maxword)
21258 (setq ll (org-do-wrap words maxword))
21259 (if (<= (length ll) lines)
21260 ll
21261 (setq ll words)
21262 (while (> (length ll) lines)
21263 (setq w (1+ w))
21264 (setq ll (org-do-wrap words w)))
21265 ll))
21266 (t (error "Cannot wrap this")))))
21268 (defun org-do-wrap (words width)
21269 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21270 (let (lines line)
21271 (while words
21272 (setq line (pop words))
21273 (while (and words (< (+ (length line) (length (car words))) width))
21274 (setq line (concat line " " (pop words))))
21275 (setq lines (push line lines)))
21276 (nreverse lines)))
21278 (defun org-split-string (string &optional separators)
21279 "Splits STRING into substrings at SEPARATORS.
21280 No empty strings are returned if there are matches at the beginning
21281 and end of string."
21283 (start 0)
21284 notfirst
21285 (list nil))
21286 (while (and (string-match rexp string
21287 (if (and notfirst
21288 (= start (match-beginning 0))
21289 (< start (length string)))
21290 (1+ start) start))
21291 (< (match-beginning 0) (length string)))
21292 (setq notfirst t)
21293 (or (eq (match-beginning 0) 0)
21294 (and (eq (match-beginning 0) (match-end 0))
21295 (eq (match-beginning 0) start))
21296 (setq list
21297 (cons (substring string start (match-beginning 0))
21298 list)))
21299 (setq start (match-end 0)))
21300 (or (eq start (length string))
21301 (setq list
21302 (cons (substring string start)
21303 list)))
21304 (nreverse list)))
21306 (defun org-quote-vert (s)
21308 (while (string-match "|" s)
21310 s)
21312 (defun org-uuidgen-p (s)
21313 "Is S an ID created by UUIDGEN?"
21314 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21316 (defun org-in-src-block-p (&optional inside)
21317 "Whether point is in a code source block.
21318 When INSIDE is non-nil, don't consider we are within a src block
21319 when point is at #+BEGIN_SRC or #+END_SRC."
21320 (let ((case-fold-search t) ov)
21321 (or (and (setq ov (overlays-at (point)))
21322 (memq 'org-block-background
21323 (overlay-properties (car ov))))
21324 (and (not inside)
21325 (save-match-data
21326 (save-excursion
21327 (beginning-of-line)
21330 (defun org-context ()
21331 "Return a list of contexts of the current cursor position.
21332 If several contexts apply, all are returned.
21333 Each context entry is a list with a symbol naming the context, and
21334 two positions indicating start and end of the context. Possible
21335 contexts are:
21337 :headline anywhere in a headline
21338 :headline-stars on the leading stars in a headline
21339 :todo-keyword on a TODO keyword (including DONE) in a headline
21340 :tags on the TAGS in a headline
21341 :priority on the priority cookie in a headline
21342 :item on the first line of a plain list item
21343 :item-bullet on the bullet/number of a plain list item
21344 :checkbox on the checkbox in a plain list item
21345 :table in an org-mode table
21346 :table-special on a special filed in a table
21347 :table-table in a table.el table
21348 :clocktable in a clocktable
21349 :src-block in a source block
21350 :link on a hyperlink
21351 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21352 :target on a <<target>>
21353 :radio-target on a <<<radio-target>>>
21354 :latex-fragment on a LaTeX fragment
21355 :latex-preview on a LaTeX fragment with overlaid preview image
21357 This function expects the position to be visible because it uses font-lock
21358 faces as a help to recognize the following contexts: :table-special, :link,
21359 and :keyword."
21360 (let* ((f (get-text-property (point) 'face))
21361 (faces (if (listp f) f (list f)))
21362 (case-fold-search t)
21363 (p (point)) clist o)
21364 ;; First the large context
21365 (cond
21366 ((org-at-heading-p t)
21367 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21368 (when (progn
21369 (beginning-of-line 1)
21370 (looking-at org-todo-line-tags-regexp))
21371 (push (org-point-in-group p 1 :headline-stars) clist)
21372 (push (org-point-in-group p 2 :todo-keyword) clist)
21373 (push (org-point-in-group p 4 :tags) clist))
21374 (goto-char p)
21377 (push (org-point-in-group p 0 :priority) clist)))
21379 ((org-at-item-p)
21380 (push (org-point-in-group p 2 :item-bullet) clist)
21381 (push (list :item (point-at-bol)
21382 (save-excursion (org-end-of-item) (point)))
21383 clist)
21384 (and (org-at-item-checkbox-p)
21385 (push (org-point-in-group p 0 :checkbox) clist)))
21387 ((org-at-table-p)
21388 (push (list :table (org-table-begin) (org-table-end)) clist)
21389 (if (memq 'org-formula faces)
21390 (push (list :table-special
21391 (previous-single-property-change p 'face)
21392 (next-single-property-change p 'face)) clist)))
21393 ((org-at-table-p 'any)
21394 (push (list :table-table) clist)))
21395 (goto-char p)
21397 (let ((case-fold-search t))
21398 ;; New the "medium" contexts: clocktables, source blocks
21399 (cond ((org-in-clocktable-p)
21400 (push (list :clocktable
21402 (search-backward "#+BEGIN: clocktable" nil t))
21403 (match-beginning 0))
21405 (match-end 0))) clist))
21406 ((org-in-src-block-p)
21407 (push (list :src-block
21409 (search-backward "#+BEGIN_SRC" nil t))
21410 (match-beginning 0))
21411 (and (search-forward "#+END_SRC" nil t)
21412 (match-beginning 0))) clist))))
21413 (goto-char p)
21415 ;; Now the small context
21416 (cond
21417 ((org-at-timestamp-p)
21418 (push (org-point-in-group p 0 :timestamp) clist))
21419 ((memq 'org-link faces)
21420 (push (list :link
21421 (previous-single-property-change p 'face)
21422 (next-single-property-change p 'face)) clist))
21423 ((memq 'org-special-keyword faces)
21424 (push (list :keyword
21425 (previous-single-property-change p 'face)
21426 (next-single-property-change p 'face)) clist))
21427 ((org-at-target-p)
21428 (push (org-point-in-group p 0 :target) clist)
21429 (goto-char (1- (match-beginning 0)))
21430 (if (looking-at org-radio-target-regexp)
21431 (push (org-point-in-group p 0 :radio-target) clist))
21432 (goto-char p))
21433 ((setq o (car (delq nil
21434 (mapcar
21435 (lambda (x)
21436 (if (memq x org-latex-fragment-image-overlays) x))
21437 (overlays-at (point))))))
21438 (push (list :latex-fragment
21439 (overlay-start o) (overlay-end o)) clist)
21440 (push (list :latex-preview
21441 (overlay-start o) (overlay-end o)) clist))
21442 ((org-inside-LaTeX-fragment-p)
21443 ;; FIXME: positions wrong.
21444 (push (list :latex-fragment (point) (point)) clist)))
21446 (setq clist (nreverse (delq nil clist)))
21447 clist))
21449 ;; FIXME: Compare with at-regexp-p Do we need both?
21450 (defun org-in-regexp (re &optional nlines visually)
21451 "Check if point is inside a match of regexp.
21452 Normally only the current line is checked, but you can include NLINES extra
21453 lines both before and after point into the search.
21454 If VISUALLY is set, require that the cursor is not after the match but
21455 really on, so that the block visually is on the match."
21456 (catch 'exit
21457 (let ((pos (point))
21458 (eol (point-at-eol (+ 1 (or nlines 0))))
21459 (inc (if visually 1 0)))
21460 (save-excursion
21461 (beginning-of-line (- 1 (or nlines 0)))
21462 (while (re-search-forward re eol t)
21463 (if (and (<= (match-beginning 0) pos)
21464 (>= (+ inc (match-end 0)) pos))
21465 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21467 (defun org-at-regexp-p (regexp)
21468 "Is point inside a match of REGEXP in the current line?"
21469 (catch 'exit
21470 (save-excursion
21471 (let ((pos (point)) (end (point-at-eol)))
21472 (beginning-of-line 1)
21473 (while (re-search-forward regexp end t)
21474 (if (and (<= (match-beginning 0) pos)
21475 (>= (match-end 0) pos))
21476 (throw 'exit t)))
21477 nil))))
21479 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21480 "Non-nil when point is between matches of START-RE and END-RE.
21482 Also return a non-nil value when point is on one of the matches.
21484 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21485 buffer positions. Default values are the positions of headlines
21486 surrounding the point.
21488 The functions returns a cons cell whose car (resp. cdr) is the
21489 position before START-RE (resp. after END-RE)."
21490 (save-match-data
21491 (let ((pos (point))
21492 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21493 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21494 beg end)
21495 (save-excursion
21496 ;; Point is on a block when on START-RE or if START-RE can be
21497 ;; found before it...
21498 (and (or (org-at-regexp-p start-re)
21499 (re-search-backward start-re limit-up t))
21500 (setq beg (match-beginning 0))
21501 ;; ... and END-RE after it...
21502 (goto-char (match-end 0))
21503 (re-search-forward end-re limit-down t)
21504 (> (setq end (match-end 0)) pos)
21505 ;; ... without another START-RE in-between.
21506 (goto-char (match-beginning 0))
21507 (not (re-search-backward start-re (1+ beg) t))
21508 ;; Return value.
21509 (cons beg end))))))
21511 (defun org-in-block-p (names)
21512 "Non-nil when point belongs to a block whose name belongs to NAMES.
21514 NAMES is a list of strings containing names of blocks.
21516 Return first block name matched, or nil. Beware that in case of
21517 nested blocks, the returned name may not belong to the closest
21518 block from point."
21519 (save-match-data
21520 (catch 'exit
21521 (let ((case-fold-search t)
21522 (lim-up (save-excursion (outline-previous-heading)))
21523 (lim-down (save-excursion (outline-next-heading))))
21524 (mapc (lambda (name)
21525 (let ((n (regexp-quote name)))
21526 (when (org-between-regexps-p
21529 lim-up lim-down)
21530 (throw 'exit n))))
21531 names))
21532 nil)))
21534 (defun org-occur-in-agenda-files (regexp &optional nlines)
21535 "Call `multi-occur' with buffers for all agenda files."
21537 (let* ((files (org-agenda-files))
21538 (tnames (mapcar 'file-truename files))
21539 (extra org-agenda-text-search-extra-files)
21540 f)
21541 (when (eq (car extra) 'agenda-archives)
21542 (setq extra (cdr extra))
21543 (setq files (org-add-archive-files files)))
21544 (while (setq f (pop extra))
21545 (unless (member (file-truename f) tnames)
21546 (add-to-list 'files f 'append)
21547 (add-to-list 'tnames (file-truename f) 'append)))
21548 (multi-occur
21549 (mapcar (lambda (x)
21550 (with-current-buffer
21551 (or (get-file-buffer x) (find-file-noselect x))
21552 (widen)
21553 (current-buffer)))
21554 files)
21555 regexp)))
21557 (if (boundp 'occur-mode-find-occurrence-hook)
21558 ;; Emacs 23
21559 (add-hook 'occur-mode-find-occurrence-hook
21560 (lambda ()
21561 (when (derived-mode-p 'org-mode)
21562 (org-reveal))))
21563 ;; Emacs 22
21564 (defadvice occur-mode-goto-occurrence
21565 (after org-occur-reveal activate)
21566 (and (derived-mode-p 'org-mode) (org-reveal)))
21567 (defadvice occur-mode-goto-occurrence-other-window
21568 (after org-occur-reveal activate)
21569 (and (derived-mode-p 'org-mode) (org-reveal)))
21570 (defadvice occur-mode-display-occurrence
21571 (after org-occur-reveal activate)
21572 (when (derived-mode-p 'org-mode)
21573 (let ((pos (occur-mode-find-occurrence)))
21574 (with-current-buffer (marker-buffer pos)
21575 (save-excursion
21576 (goto-char pos)
21577 (org-reveal)))))))
21579 (defun org-occur-link-in-agenda-files ()
21580 "Create a link and search for it in the agendas.
21581 The link is not stored in `org-stored-links', it is just created
21582 for the search purpose."
21583 (interactive)
21584 (let ((link (condition-case nil
21585 (org-store-link nil)
21586 (error "Unable to create a link to here"))))
21587 (org-occur-in-agenda-files (regexp-quote link))))
21589 (defun org-reverse-string (string)
21590 "Return the reverse of STRING."
21591 (apply 'string (reverse (string-to-list string))))
21593 (defsubst org-uniquify (list)
21594 "Non-destructively remove duplicate elements from LIST."
21595 (let ((res (copy-sequence list))) (delete-dups res)))
21597 (defun org-uniquify-alist (alist)
21598 "Merge elements of ALIST with the same key.
21600 For example, in this alist:
21602 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21603 => '((a 1 3) (b 2))
21605 merge (a 1) and (a 3) into (a 1 3).
21607 The function returns the new ALIST."
21608 (let (rtn)
21609 (mapc
21610 (lambda (e)
21611 (let (n)
21612 (if (not (assoc (car e) rtn))
21613 (push e rtn)
21614 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21615 (setq rtn (assq-delete-all (car e) rtn))
21616 (push n rtn))))
21617 alist)
21618 rtn))
21620 (defun org-delete-all (elts list)
21621 "Remove all elements in ELTS from LIST."
21622 (while elts
21623 (setq list (delete (pop elts) list)))
21624 list)
21626 (defun org-count (cl-item cl-seq)
21627 "Count the number of occurrences of ITEM in SEQ.
21628 Taken from `count' in cl-seq.el with all keyword arguments removed."
21629 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21630 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21631 (while (< cl-start cl-end)
21632 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21633 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21634 (setq cl-start (1+ cl-start)))
21635 cl-count))
21637 (defun org-remove-if (predicate seq)
21638 "Remove everything from SEQ that fulfills PREDICATE."
21639 (let (res e)
21640 (while seq
21641 (setq e (pop seq))
21642 (if (not (funcall predicate e)) (push e res)))
21643 (nreverse res)))
21645 (defun org-remove-if-not (predicate seq)
21646 "Remove everything from SEQ that does not fulfill PREDICATE."
21647 (let (res e)
21648 (while seq
21649 (setq e (pop seq))
21650 (if (funcall predicate e) (push e res)))
21651 (nreverse res)))
21653 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21654 "Reduce two-argument FUNCTION across SEQ.
21655 Taken from `reduce' in cl-seq.el with all keyword arguments but
21657 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21658 (cadr (memq :initial-value cl-keys)))
21659 (cl-seq (pop cl-seq))
21660 (t (funcall cl-func)))))
21661 (while cl-seq
21662 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21663 cl-accum))
21665 (defun org-back-over-empty-lines ()
21666 "Move backwards over whitespace, to the beginning of the first empty line.
21667 Returns the number of empty lines passed."
21668 (let ((pos (point)))
21669 (if (cdr (assoc 'heading org-blank-before-new-entry))
21671 (unless (eobp)
21672 (forward-line -1)))
21673 (beginning-of-line 2)
21674 (goto-char (min (point) pos))
21675 (count-lines (point) pos)))
21677 (defun org-skip-whitespace ()
21680 (defun org-point-in-group (point group &optional context)
21681 "Check if POINT is in match-group GROUP.
21682 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21683 match. If the match group does not exist or point is not inside it,
21684 return nil."
21685 (and (match-beginning group)
21686 (>= point (match-beginning group))
21687 (<= point (match-end group))
21688 (if context
21689 (list context (match-beginning group) (match-end group))
21690 t)))
21692 (defun org-switch-to-buffer-other-window (&rest args)
21693 "Switch to buffer in a second window on the current frame.
21694 In particular, do not allow pop-up frames.
21695 Returns the newly created buffer."
21696 (org-no-popups
21697 (apply 'switch-to-buffer-other-window args)))
21699 (defun org-combine-plists (&rest plists)
21700 "Create a single property list from all plists in PLISTS.
21701 The process starts by copying the first list, and then setting properties
21702 from the other lists. Settings in the last list are the most significant
21703 ones and overrule settings in the other lists."
21704 (let ((rtn (copy-sequence (pop plists)))
21705 p v ls)
21706 (while plists
21707 (setq ls (pop plists))
21708 (while ls
21709 (setq p (pop ls) v (pop ls))
21710 (setq rtn (plist-put rtn p v))))
21711 rtn))
21713 (defun org-replace-escapes (string table)
21714 "Replace %-escapes in STRING with values in TABLE.
21716 The sequences in STRING may contain normal field width and padding information,
21718 so values can contain further %-escapes if they are define later in TABLE."
21719 (let ((tbl (copy-alist table))
21720 (case-fold-search nil)
21721 (pchg 0)
21722 e re rpl)
21723 (while (setq e (pop tbl))
21724 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21725 (when (and (cdr e) (string-match re (cdr e)))
21726 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21727 (safe "SREF"))
21728 (add-text-properties 0 3 (list 'sref sref) safe)
21729 (setcdr e (replace-match safe t t (cdr e)))))
21730 (while (string-match re string)
21731 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21732 (cdr e)))
21733 (setq string (replace-match rpl t t string))))
21734 (while (setq pchg (next-property-change pchg string))
21735 (let ((sref (get-text-property pchg 'sref string)))
21736 (when (and sref (string-match "SREF" string pchg))
21737 (setq string (replace-match sref t t string)))))
21738 string))
21740 (defun org-sublist (list start end)
21741 "Return a section of LIST, from START to END.
21742 Counting starts at 1."
21743 (let (rtn (c start))
21744 (setq list (nthcdr (1- start) list))
21745 (while (and list (<= c end))
21746 (push (pop list) rtn)
21747 (setq c (1+ c)))
21748 (nreverse rtn)))
21750 (defun org-find-base-buffer-visiting (file)
21751 "Like `find-buffer-visiting' but always return the base buffer and
21752 not an indirect buffer."
21753 (let ((buf (or (get-file-buffer file)
21754 (find-buffer-visiting file))))
21755 (if buf
21756 (or (buffer-base-buffer buf) buf)
21757 nil)))
21759 (defun org-image-file-name-regexp (&optional extensions)
21760 "Return regexp matching the file names of images.
21761 If EXTENSIONS is given, only match these."
21762 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21763 (image-file-name-regexp)
21764 (let ((image-file-name-extensions
21765 (or extensions
21766 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21767 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21769 (regexp-opt (nconc (mapcar 'upcase
21770 image-file-name-extensions)
21771 image-file-name-extensions)
21772 t)
21775 (defun org-file-image-p (file &optional extensions)
21776 "Return non-nil if FILE is an image."
21777 (save-match-data
21778 (string-match (org-image-file-name-regexp extensions) file)))
21780 (defun org-get-cursor-date (&optional with-time)
21781 "Return the date at cursor in as a time.
21782 This works in the calendar and in the agenda, anywhere else it just
21783 returns the current time.
21784 If WITH-TIME is non-nil, returns the time of the event at point (in
21785 the agenda) or the current time of the day."
21786 (let (date day defd tp tm hod mod)
21787 (when with-time
21788 (setq tp (get-text-property (point) 'time))
21790 (setq hod (string-to-number (match-string 1 tp))
21791 mod (string-to-number (match-string 2 tp))))
21792 (or tp (setq hod (nth 2 (decode-time (current-time)))
21793 mod (nth 1 (decode-time (current-time))))))
21794 (cond
21795 ((eq major-mode 'calendar-mode)
21796 (setq date (calendar-cursor-to-date)
21797 defd (encode-time 0 (or mod 0) (or hod 0)
21798 (nth 1 date) (nth 0 date) (nth 2 date))))
21799 ((eq major-mode 'org-agenda-mode)
21800 (setq day (get-text-property (point) 'day))
21801 (if day
21802 (setq date (calendar-gregorian-from-absolute day)
21803 defd (encode-time 0 (or mod 0) (or hod 0)
21804 (nth 1 date) (nth 0 date) (nth 2 date))))))
21805 (or defd (current-time))))
21807 (defun org-mark-subtree (&optional up)
21808 "Mark the current subtree.
21809 This puts point at the start of the current subtree, and mark at
21810 the end. If a numeric prefix UP is given, move up into the
21811 hierarchy of headlines by UP levels before marking the subtree."
21812 (interactive "P")
21813 (org-with-limited-levels
21814 (cond ((org-at-heading-p) (beginning-of-line))
21815 ((org-before-first-heading-p) (error "Not in a subtree"))
21816 (t (outline-previous-visible-heading 1))))
21817 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21818 (if (org-called-interactively-p 'any)
21819 (call-interactively 'org-mark-element)
21820 (org-mark-element)))
21823 ;;; Indentation
21825 (defun org-indent-line ()
21826 "Indent line depending on context."
21827 (interactive)
21828 (let* ((pos (point))
21829 (itemp (org-at-item-p))
21830 (case-fold-search t)
21832 (inline-task-p (and (featurep 'org-inlinetask)
21833 (org-inlinetask-in-task-p)))
21834 (inline-re (and inline-task-p
21835 (org-inlinetask-outline-regexp)))
21836 column)
21837 (if (and orgstruct-is-++ (eq pos (point)))
21838 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21839 (indent-according-to-mode))
21840 (beginning-of-line 1)
21841 (cond
21842 ;; Headings
21843 ((looking-at org-outline-regexp) (setq column 0))
21844 ;; Footnote definition
21845 ((looking-at org-footnote-definition-re) (setq column 0))
21846 ;; Literal examples
21848 (setq column (org-get-indentation))) ; do nothing
21849 ;; Lists
21850 ((ignore-errors (goto-char (org-in-item-p)))
21851 (setq column (if itemp
21852 (org-get-indentation)
21853 (org-list-item-body-column (point))))
21854 (goto-char pos))
21855 ;; Drawers
21857 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21858 (save-excursion
21859 (goto-char (1- (match-beginning 1)))
21860 (setq column (current-column))))
21861 ;; Special blocks
21863 (save-excursion
21864 (re-search-backward
21866 (setq column (org-get-indentation (match-string 0))))
21869 (save-excursion
21871 (setq column
21872 (cond ((equal (downcase (match-string 1)) "src")
21873 ;; src blocks: let `org-edit-src-exit' handle them
21874 (org-get-indentation))
21875 ((equal (downcase (match-string 1)) "example")
21876 (max (org-get-indentation)
21877 (org-get-indentation (match-string 0))))
21878 (t
21879 (org-get-indentation (match-string 0))))))
21880 ;; This line has nothing special, look at the previous relevant
21881 ;; line to compute indentation
21882 (t
21883 (beginning-of-line 0)
21884 (while (and (not (bobp))
21885 (not (looking-at org-table-line-regexp))
21886 (not (looking-at org-drawer-regexp))
21887 ;; When point started in an inline task, do not move
21888 ;; above task starting line.
21889 (not (and inline-task-p (looking-at inline-re)))
21890 ;; Skip drawers, blocks, empty lines, verbatim,
21891 ;; comments, tables, footnotes definitions, lists,
21892 ;; inline tasks.
21894 (re-search-backward org-drawer-regexp nil t))
21898 (looking-at org-footnote-definition-re)
21899 (and (not inline-task-p)
21900 (featurep 'org-inlinetask)
21901 (org-inlinetask-in-task-p)
21902 (or (org-inlinetask-goto-beginning) t))))
21903 (beginning-of-line 0))
21904 (cond
21905 ;; There was a list item above.
21906 ((save-excursion
21907 (and (ignore-errors (goto-char (org-in-item-p)))
21908 (goto-char
21909 (org-list-get-top-point (org-list-struct)))))
21910 (looking-at org-list-full-item-re)
21911 (setq column (length (match-string 0))))
21912 ;; There was an heading above.
21914 (if (not org-adapt-indentation)
21915 (setq column 0)
21916 (goto-char (match-end 0))
21917 (setq column (current-column))))
21918 ;; A drawer had started and is unfinished
21919 ((looking-at org-drawer-regexp)
21920 (goto-char (1- (match-beginning 1)))
21921 (setq column (current-column)))
21922 ;; Else, nothing noticeable found: get indentation and go on.
21923 (t (setq column (org-get-indentation))))))
21924 ;; Now apply indentation and move cursor accordingly
21925 (goto-char pos)
21926 (if (<= (current-column) (current-indentation))
21927 (org-indent-line-to column)
21928 (save-excursion (org-indent-line-to column)))
21929 ;; Special polishing for properties, see `org-property-format'
21930 (setq column (current-column))
21931 (beginning-of-line 1)
21932 (if (looking-at
21934 (replace-match (concat (match-string 1)
21935 (format org-property-format
21936 (match-string 2) (match-string 3)))
21937 t t))
21938 (org-move-to-column column))))
21940 (defun org-indent-drawer ()
21941 "Indent the drawer at point."
21942 (interactive)
21943 (let ((p (point))
21944 (e (and (save-excursion (re-search-forward ":END:" nil t))
21945 (match-end 0)))
21946 (folded
21947 (save-excursion
21948 (end-of-line)
21949 (when (overlays-at (point))
21950 (member 'invisible (overlay-properties
21951 (car (overlays-at (point)))))))))
21952 (when folded (org-cycle))
21953 (indent-for-tab-command)
21954 (while (and (move-beginning-of-line 2) (< (point) e))
21955 (indent-for-tab-command))
21956 (goto-char p)
21957 (when folded (org-cycle)))
21958 (message "Drawer at point indented"))
21960 (defun org-indent-block ()
21961 "Indent the block at point."
21962 (interactive)
21963 (let ((p (point))
21964 (case-fold-search t)
21966 (match-end 0)))
21967 (folded
21968 (save-excursion
21969 (end-of-line)
21970 (when (overlays-at (point))
21971 (member 'invisible (overlay-properties
21972 (car (overlays-at (point)))))))))
21973 (when folded (org-cycle))
21974 (indent-for-tab-command)
21975 (while (and (move-beginning-of-line 2) (< (point) e))
21976 (indent-for-tab-command))
21977 (goto-char p)
21978 (when folded (org-cycle)))
21979 (message "Block at point indented"))
21981 (defun org-indent-region (start end)
21982 "Indent region."
21983 (interactive "r")
21984 (save-excursion
21985 (let ((line-end (org-current-line end)))
21986 (goto-char start)
21987 (while (< (org-current-line) line-end)
21988 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21989 (t (call-interactively 'org-indent-line)))
21990 (move-beginning-of-line 2)))))
21993 ;;; Filling
21995 ;; We use our own fill-paragraph and auto-fill functions.
21997 ;; `org-fill-paragraph' relies on adaptive filling and context
21998 ;; checking. Appropriate `fill-prefix' is computed with
21999 ;; `org-adaptive-fill-function'.
22001 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22002 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22003 ;; `org-adaptive-fill-function' value. Internally,
22004 ;; `org-comment-line-break-function' breaks the line.
22006 ;; `org-setup-filling' installs filling and auto-filling related
22007 ;; variables during `org-mode' initialization.
22009 (defun org-setup-filling ()
22010 (interactive)
22011 ;; Prevent auto-fill from inserting unwanted new items.
22012 (when (boundp 'fill-nobreak-predicate)
22013 (org-set-local
22014 'fill-nobreak-predicate
22015 (org-uniquify
22016 (append fill-nobreak-predicate
22017 '(org-fill-paragraph-separate-nobreak-p
22018 org-fill-line-break-nobreak-p
22019 org-fill-paragraph-with-timestamp-nobreak-p)))))
22020 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22021 (org-set-local 'auto-fill-inhibit-regexp nil)
22022 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22023 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22024 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22026 (defvar org-element-paragraph-separate) ; org-element.el
22027 (defun org-fill-paragraph-separate-nobreak-p ()
22028 "Non-nil when a line break at point would insert a new item."
22029 (looking-at (substring org-element-paragraph-separate 1)))
22031 (defun org-fill-line-break-nobreak-p ()
22032 "Non-nil when a line break at point would create an Org line break."
22033 (save-excursion
22038 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22039 "Non-nil when a line break at point would insert a new item."
22040 (and (org-at-timestamp-p t)
22041 (not (looking-at org-ts-regexp-both))))
22043 (declare-function message-in-body-p "message" ())
22044 (defvar orgtbl-line-start-regexp) ; From org-table.el
22045 (defun org-adaptive-fill-function ()
22046 "Compute a fill prefix for the current line.
22047 Return fill prefix, as a string, or nil if current line isn't
22048 meant to be filled."
22049 (let (prefix)
22050 (catch 'exit
22051 (when (derived-mode-p 'message-mode)
22052 (save-excursion
22053 (beginning-of-line)
22054 (cond ((or (not (message-in-body-p))
22055 (looking-at orgtbl-line-start-regexp))
22056 (throw 'exit nil))
22057 ((looking-at message-cite-prefix-regexp)
22058 (throw 'exit (match-string-no-properties 0)))
22059 ((looking-at org-outline-regexp)
22060 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22061 (org-with-wide-buffer
22062 (let* ((p (line-beginning-position))
22063 (element (save-excursion
22064 (beginning-of-line)
22065 (or (ignore-errors (org-element-at-point))
22066 (user-error "An element cannot be parsed line %d"
22067 (line-number-at-pos (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
22138 (end-of-line)
22139 (or (ignore-errors (org-element-at-point))
22140 (user-error "An element cannot be parsed line %d"
22141 (line-number-at-pos (point)))))))
22142 ;; First check if point is in a blank line at the beginning of
22143 ;; the buffer. In that case, ignore filling.
22144 (case (org-element-type element)
22145 ;; Use major mode filling function is src blocks.
22146 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22147 ;; Align Org tables, leave table.el tables as-is.
22148 (table-row (org-table-align) t)
22149 (table
22150 (when (eq (org-element-property :type element) 'org)
22151 (org-table-align))
22152 t)
22153 (paragraph
22154 ;; Paragraphs may contain `line-break' type objects.
22155 (let ((beg (max (point-min)
22156 (org-element-property :contents-begin element)))
22157 (end (min (point-max)
22158 (org-element-property :contents-end element))))
22159 ;; Do nothing if point is at an affiliated keyword.
22160 (if (< (line-end-position) beg) t
22161 (when (derived-mode-p 'message-mode)
22162 ;; In `message-mode', do not fill following citation
22163 ;; in current paragraph nor text before message body.
22164 (let ((body-start (save-excursion (message-goto-body))))
22165 (when body-start (setq beg (max body-start beg))))
22166 (when (save-excursion
22167 (re-search-forward
22168 (concat "^" message-cite-prefix-regexp) end t))
22169 (setq end (match-beginning 0))))
22170 ;; Fill paragraph, taking line breaks into account.
22171 ;; For that, slice the paragraph using line breaks as
22172 ;; separators, and fill the parts in reverse order to
22173 ;; avoid messing with markers.
22174 (save-excursion
22175 (goto-char end)
22176 (mapc
22177 (lambda (pos)
22178 (fill-region-as-paragraph pos (point) justify)
22179 (goto-char pos))
22180 ;; Find the list of ending positions for line breaks
22181 ;; in the current paragraph. Add paragraph
22182 ;; beginning to include first slice.
22183 (nreverse
22184 (cons beg
22185 (org-element-map
22186 (org-element--parse-objects
22187 beg end nil (org-element-restriction 'paragraph))
22188 'line-break
22189 (lambda (lb) (org-element-property :end lb)))))))
22190 t)))
22191 ;; Contents of `comment-block' type elements should be
22192 ;; filled as plain text, but only if point is within block
22193 ;; markers.
22194 (comment-block
22195 (let* ((case-fold-search t)
22196 (beg (save-excursion
22197 (goto-char (org-element-property :begin element))
22199 (forward-line)
22200 (point)))
22201 (end (save-excursion
22202 (goto-char (org-element-property :end element))
22204 (line-beginning-position))))
22205 (when (and (>= (point) beg) (< (point) end))
22206 (fill-region-as-paragraph
22207 (save-excursion
22208 (end-of-line)
22210 (line-beginning-position))
22211 (save-excursion
22212 (beginning-of-line)
22214 (line-beginning-position))
22215 justify)))
22216 t)
22217 ;; Fill comments.
22218 (comment (fill-comment-paragraph justify))
22219 ;; Ignore every other element.
22220 (otherwise t))))))
22222 (defun org-auto-fill-function ()
22223 "Auto-fill function."
22224 ;; Check if auto-filling is meaningful.
22225 (let ((fc (current-fill-column)))
22226 (when (and fc (> (current-column) fc))
22227 (let* ((fill-prefix (org-adaptive-fill-function))
22228 ;; Enforce empty fill prefix, if required. Otherwise, it
22229 ;; will be computed again.
22230 (adaptive-fill-mode (not (equal fill-prefix ""))))
22231 (when fill-prefix (do-auto-fill))))))
22233 (defun org-comment-line-break-function (&optional soft)
22234 "Break line at point and indent, continuing comment if within one.
22235 The inserted newline is marked hard if variable
22236 `use-hard-newlines' is true, unless optional argument SOFT is
22237 non-nil."
22239 (save-excursion (forward-char -1) (delete-horizontal-space))
22240 (delete-horizontal-space)
22241 (indent-to-left-margin)
22242 (insert-before-markers-and-inherit fill-prefix))
22245 ;;; Comments
22247 ;; Org comments syntax is quite complex. It requires the entire line
22248 ;; to be just a comment. Also, even with the right syntax at the
22249 ;; beginning of line, some some elements (i.e. verse-block or
22250 ;; example-block) don't accept comments. Usual Emacs comment commands
22251 ;; cannot cope with those requirements. Therefore, Org replaces them.
22253 ;; Org still relies on `comment-dwim', but cannot trust
22254 ;; `comment-only-p'. So, `comment-region-function' and
22255 ;; `uncomment-region-function' both point
22256 ;; to`org-comment-or-uncomment-region'. Eventually,
22257 ;; `org-insert-comment' takes care of insertion of comments at the
22258 ;; beginning of line.
22260 ;; `org-setup-comments-handling' install comments related variables
22261 ;; during `org-mode' initialization.
22263 (defun org-setup-comments-handling ()
22264 (interactive)
22265 (org-set-local 'comment-use-syntax nil)
22266 (org-set-local 'comment-start "# ")
22268 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22269 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22270 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22272 (defun org-insert-comment ()
22273 "Insert an empty comment above current line.
22274 If the line is empty, insert comment at its beginning."
22275 (beginning-of-line)
22277 (org-indent-line)
22278 (insert "# "))
22280 (defvar comment-empty-lines) ; From newcomment.el.
22281 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22282 "Comment or uncomment each non-blank line in the region.
22283 Uncomment each non-blank line between BEG and END if it only
22284 contains commented lines. Otherwise, comment them."
22285 (save-restriction
22286 ;; Restrict region
22287 (narrow-to-region (save-excursion (goto-char beg)
22289 (line-beginning-position))
22290 (save-excursion (goto-char end)
22292 (line-end-position)))
22293 (let ((uncommentp
22294 ;; UNCOMMENTP is non-nil when every non blank line between
22295 ;; BEG and END is a comment.
22296 (save-excursion
22297 (goto-char (point-min))
22298 (while (and (not (eobp))
22299 (let ((element (org-element-at-point)))
22300 (and (eq (org-element-type element) 'comment)
22301 (goto-char (min (point-max)
22302 (org-element-property
22303 :end element)))))))
22304 (eobp))))
22305 (if uncommentp
22306 ;; Only blank lines and comments in region: uncomment it.
22307 (save-excursion
22308 (goto-char (point-min))
22309 (while (not (eobp))
22311 (replace-match "" nil nil nil 1))
22312 (forward-line)))
22313 ;; Comment each line in region.
22314 (let ((min-indent (point-max)))
22315 ;; First find the minimum indentation across all lines.
22316 (save-excursion
22317 (goto-char (point-min))
22318 (while (and (not (eobp)) (not (zerop min-indent)))
22320 (setq min-indent (min min-indent (current-indentation))))
22321 (forward-line)))
22322 ;; Then loop over all lines.
22323 (save-excursion
22324 (goto-char (point-min))
22325 (while (not (eobp))
22327 ;; Don't get fooled by invisible text (e.g. link path)
22328 ;; when moving to column MIN-INDENT.
22329 (let ((buffer-invisibility-spec nil))
22330 (org-move-to-column min-indent t))
22331 (insert comment-start))
22332 (forward-line))))))))
22335 ;;; Planning
22337 ;; This section contains tools to operate on timestamp objects, as
22338 ;; returned by, e.g. `org-element-context'.
22340 (defun org-timestamp-has-time-p (timestamp)
22341 "Non-nil when TIMESTAMP has a time specified."
22342 (org-element-property :hour-start timestamp))
22344 (defun org-timestamp-format (timestamp format &optional end utc)
22345 "Format a TIMESTAMP element into a string.
22347 FORMAT is a format specifier to be passed to
22348 `format-time-string'.
22350 When optional argument END is non-nil, use end of date-range or
22351 time-range, if possible.
22353 When optional argument UTC is non-nil, time will be expressed as
22354 Universal Time."
22355 (format-time-string
22356 format
22357 (apply 'encode-time
22358 (cons 0
22359 (mapcar
22360 (lambda (prop) (or (org-element-property prop timestamp) 0))
22361 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22362 '(:minute-start :hour-start :day-start :month-start
22363 :year-start)))))
22364 utc))
22366 (defun org-timestamp-split-range (timestamp &optional end)
22367 "Extract a timestamp object from a date or time range.
22369 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22370 the end of the range. Otherwise, extract its start.
22372 Return a new timestamp object sharing the same parent as
22373 TIMESTAMP."
22374 (let ((type (org-element-property :type timestamp)))
22375 (if (memq type '(active inactive diary)) timestamp
22376 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22377 ;; Set new type.
22378 (org-element-put-property
22379 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22380 ;; Copy start properties over end properties if END is
22381 ;; non-nil. Otherwise, copy end properties over `start' ones.
22382 (let ((p-alist '((:minute-start . :minute-end)
22383 (:hour-start . :hour-end)
22384 (:day-start . :day-end)
22385 (:month-start . :month-end)
22386 (:year-start . :year-end))))
22387 (dolist (p-cell p-alist)
22388 (org-element-put-property
22389 split-ts
22390 (funcall (if end 'car 'cdr) p-cell)
22391 (org-element-property
22392 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22393 ;; Eventually refresh `:raw-value'.
22394 (org-element-put-property split-ts :raw-value nil)
22395 (org-element-put-property
22396 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22398 (defun org-timestamp-translate (timestamp &optional boundary)
22399 "Apply `org-translate-time' on a TIMESTAMP object.
22400 When optional argument BOUNDARY is non-nil, it is either the
22401 symbol `start' or `end'. In this case, only translate the
22402 starting or ending part of TIMESTAMP if it is a date or time
22403 range. Otherwise, translate both parts."
22404 (if (and (not boundary)
22405 (memq (org-element-property :type timestamp)
22406 '(active-range inactive-range)))
22407 (concat
22408 (org-translate-time
22409 (org-element-property :raw-value
22410 (org-timestamp-split-range timestamp)))
22411 "--"
22412 (org-translate-time
22413 (org-element-property :raw-value
22414 (org-timestamp-split-range timestamp t))))
22415 (org-translate-time
22416 (org-element-property
22417 :raw-value
22418 (if (not boundary) timestamp
22419 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22423 ;;; Other stuff.
22425 (defun org-toggle-fixed-width-section (arg)
22426 "Toggle the fixed-width export.
22427 If there is no active region, the QUOTE keyword at the current headline is
22428 inserted or removed. When present, it causes the text between this headline
22429 and the next to be exported as fixed-width text, and unmodified.
22430 If there is an active region, this command adds or removes a colon as the
22431 first character of this line. If the first character of a line is a colon,
22432 this line is also exported in fixed-width font."
22433 (interactive "P")
22434 (let* ((cc 0)
22435 (regionp (org-region-active-p))
22436 (beg (if regionp (region-beginning) (point)))
22437 (end (if regionp (region-end)))
22438 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22439 (case-fold-search nil)
22441 off)
22442 (if regionp
22443 (save-excursion
22444 (goto-char beg)
22445 (setq cc (current-column))
22446 (beginning-of-line 1)
22447 (setq off (looking-at re))
22448 (while (> nlines 0)
22449 (setq nlines (1- nlines))
22450 (beginning-of-line 1)
22451 (cond
22452 (arg
22453 (org-move-to-column cc t)
22455 (forward-line -1))
22456 ((and off (looking-at re))
22457 (replace-match "" t t nil 1))
22458 ((not off) (org-move-to-column cc t) (insert ": ")))
22459 (forward-line 1)))
22460 (save-excursion
22461 (org-back-to-heading)
22462 (cond
22463 ((looking-at (format org-heading-keyword-regexp-format
22464 org-quote-string))
22465 (goto-char (match-end 1))
22466 (looking-at (concat " +" org-quote-string))
22467 (replace-match "" t t)
22468 (when (eolp) (insert " ")))
22469 ((looking-at org-outline-regexp)
22470 (goto-char (match-end 0))
22471 (insert org-quote-string " ")))))))
22473 (defun org-reftex-citation ()
22474 "Use reftex-citation to insert a citation into the buffer.
22475 This looks for a line like
22477 #+BIBLIOGRAPHY: foo plain option:-d
22479 and derives from it that foo.bib is the bibliography file relevant
22480 for this document. It then installs the necessary environment for RefTeX
22481 to work in this buffer and calls `reftex-citation' to insert a citation
22482 into the buffer.
22484 Export of such citations to both LaTeX and HTML is handled by the contributed
22485 package org-exp-bibtex by Taru Karttunen."
22486 (interactive)
22487 (let ((reftex-docstruct-symbol 'rds)
22489 rds bib)
22490 (save-excursion
22491 (save-restriction
22492 (widen)
22493 (let ((case-fold-search t)
22495 (if (not (save-excursion
22496 (or (re-search-forward re nil t)
22497 (re-search-backward re nil t))))
22498 (error "No bibliography defined in file")
22499 (setq bib (concat (match-string 1) ".bib")
22500 rds (list (list 'bib bib)))))))
22501 (call-interactively 'reftex-citation)))
22503 ;;;; Functions extending outline functionality
22505 (defun org-beginning-of-line (&optional arg)
22506 "Go to the beginning of the current line. If that is invisible, continue
22507 to a visible line beginning. This makes the function of C-a more intuitive.
22508 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22509 first attempt, and only move to after the tags when the cursor is already
22510 beyond the end of the headline."
22511 (interactive "P")
22512 (let ((pos (point))
22513 (special (if (consp org-special-ctrl-a/e)
22514 (car org-special-ctrl-a/e)
22515 org-special-ctrl-a/e))
22516 refpos)
22517 (if (org-bound-and-true-p visual-line-mode)
22518 (beginning-of-visual-line 1)
22519 (beginning-of-line 1))
22520 (if (and arg (fboundp 'move-beginning-of-line))
22521 (call-interactively 'move-beginning-of-line)
22522 (if (bobp)
22523 nil
22524 (backward-char 1)
22525 (if (org-truely-invisible-p)
22526 (while (and (not (bobp)) (org-truely-invisible-p))
22527 (backward-char 1)
22528 (beginning-of-line 1))
22529 (forward-char 1))))
22530 (when special
22531 (cond
22532 ((and (looking-at org-complex-heading-regexp)
22533 (= (char-after (match-end 1)) ?\ ))
22534 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22535 (point-at-eol)))
22536 (goto-char
22537 (if (eq special t)
22538 (cond ((> pos refpos) refpos)
22539 ((= pos (point)) refpos)
22540 (t (point)))
22541 (cond ((> pos (point)) (point))
22542 ((not (eq last-command this-command)) (point))
22543 (t refpos)))))
22544 ((org-at-item-p)
22545 ;; Being at an item and not looking at an the item means point
22546 ;; was previously moved to beginning of a visual line, which
22547 ;; doesn't contain the item. Therefore, do nothing special,
22548 ;; just stay here.
22549 (when (looking-at org-list-full-item-re)
22550 ;; Set special position at first white space character after
22551 ;; bullet, and check-box, if any.
22552 (let ((after-bullet
22553 (let ((box (match-end 3)))
22554 (if (not box) (match-end 1)
22555 (let ((after (char-after box)))
22556 (if (and after (= after ? )) (1+ box) box))))))
22557 ;; Special case: Move point to special position when
22558 ;; currently after it or at beginning of line.
22559 (if (eq special t)
22560 (when (or (> pos after-bullet) (= (point) pos))
22561 (goto-char after-bullet))
22562 ;; Reversed case: Move point to special position when
22563 ;; point was already at beginning of line and command is
22564 ;; repeated.
22565 (when (and (= (point) pos) (eq last-command this-command))
22566 (goto-char after-bullet))))))))
22567 (org-no-warnings
22568 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22570 (defun org-end-of-line (&optional arg)
22571 "Go to the end of the line.
22572 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22573 tags on the first attempt, and only move to after the tags when
22574 the cursor is already beyond the end of the headline."
22575 (interactive "P")
22576 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22577 org-special-ctrl-a/e))
22578 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22579 'end-of-visual-line)
22580 ((fboundp 'move-end-of-line) 'move-end-of-line)
22581 (t 'end-of-line))))
22582 (if (or (not special) arg) (call-interactively move-fun)
22583 (let* ((element (save-excursion (beginning-of-line)
22584 (org-element-at-point)))
22585 (type (org-element-type element)))
22586 (cond
22587 ((memq type '(headline inlinetask))
22588 (let ((pos (point)))
22589 (beginning-of-line 1)
22591 (if (eq special t)
22592 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22593 (goto-char (match-beginning 1))
22594 (goto-char (match-end 0)))
22595 (if (or (< pos (match-end 0))
22596 (not (eq this-command last-command)))
22597 (goto-char (match-end 0))
22598 (goto-char (match-beginning 1))))
22599 (call-interactively move-fun))))
22600 ((org-element-property :hiddenp element)
22601 ;; If element is hidden, `move-end-of-line' would put point
22602 ;; after it. Use `end-of-line' to stay on current line.
22603 (call-interactively 'end-of-line))
22604 (t (call-interactively move-fun)))))
22605 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22607 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22608 (define-key org-mode-map "\C-e" 'org-end-of-line)
22610 (defun org-backward-sentence (&optional arg)
22611 "Go to beginning of sentence, or beginning of table field.
22612 This will call `backward-sentence' or `org-table-beginning-of-field',
22613 depending on context."
22614 (interactive "P")
22615 (cond
22616 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22617 (t (call-interactively 'backward-sentence))))
22619 (defun org-forward-sentence (&optional arg)
22620 "Go to end of sentence, or end of table field.
22621 This will call `forward-sentence' or `org-table-end-of-field',
22622 depending on context."
22623 (interactive "P")
22624 (cond
22625 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22626 (t (call-interactively 'forward-sentence))))
22628 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22629 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22631 (defun org-kill-line (&optional arg)
22632 "Kill line, to tags or end of line."
22633 (interactive "P")
22634 (cond
22635 ((or (not org-special-ctrl-k)
22636 (bolp)
22637 (not (org-at-heading-p)))
22638 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22639 org-ctrl-k-protect-subtree)
22640 (if (or (eq org-ctrl-k-protect-subtree 'error)
22641 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22642 (error "C-k aborted - would kill hidden subtree")))
22643 (call-interactively
22644 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22646 (kill-region (point) (match-beginning 1))
22647 (org-set-tags nil t))
22648 (t (kill-region (point) (point-at-eol)))))
22650 (define-key org-mode-map "\C-k" 'org-kill-line)
22652 (defun org-yank (&optional arg)
22653 "Yank. If the kill is a subtree, treat it specially.
22654 This command will look at the current kill and check if is a single
22655 subtree, or a series of subtrees[1]. If it passes the test, and if the
22656 cursor is at the beginning of a line or after the stars of a currently
22657 empty headline, then the yank is handled specially. How exactly depends
22658 on the value of the following variables, both set by default.
22660 org-yank-folded-subtrees
22661 When set, the subtree(s) will be folded after insertion, but only
22662 if doing so would now swallow text after the yanked text.
22664 org-yank-adjusted-subtrees
22665 When set, the subtree will be promoted or demoted in order to
22666 fit into the local outline tree structure, which means that the level
22667 will be adjusted so that it becomes the smaller one of the two
22668 *visible* surrounding headings.
22670 Any prefix to this command will cause `yank' to be called directly with
22672 will just
22673 plainly yank the text as it is.
22675 \[1] The test checks if the first non-white line is a heading
22676 and if there are no other headings with fewer stars."
22677 (interactive "P")
22678 (org-yank-generic 'yank arg))
22680 (defun org-yank-generic (command arg)
22681 "Perform some yank-like command.
22683 This function implements the behavior described in the `org-yank'
22684 documentation. However, it has been generalized to work for any
22685 interactive command with similar behavior."
22687 ;; pretend to be command COMMAND
22688 (setq this-command command)
22690 (if arg
22691 (call-interactively command)
22693 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22694 (and (org-kill-is-subtree-p)
22695 (or (bolp)
22697 (string-match
22699 (buffer-substring (point-at-bol) (point)))))))
22700 swallowp)
22701 (cond
22702 ((and subtreep org-yank-folded-subtrees)
22703 (let ((beg (point))
22704 end)
22705 (if (and subtreep org-yank-adjusted-subtrees)
22706 (org-paste-subtree nil nil 'for-yank)
22707 (call-interactively command))
22709 (setq end (point))
22710 (goto-char beg)
22711 (when (and (bolp) subtreep
22712 (not (setq swallowp
22713 (org-yank-folding-would-swallow-text beg end))))
22714 (org-with-limited-levels
22715 (or (looking-at org-outline-regexp)
22716 (re-search-forward org-outline-regexp-bol end t))
22717 (while (and (< (point) end) (looking-at org-outline-regexp))
22718 (hide-subtree)
22719 (org-cycle-show-empty-lines 'folded)
22720 (condition-case nil
22721 (outline-forward-same-level 1)
22722 (error (goto-char end))))))
22723 (when swallowp
22724 (message
22725 "Inserted text not folded because that would swallow text"))
22727 (goto-char end)
22729 (beginning-of-line 1)
22730 (push-mark beg 'nomsg)))
22731 ((and subtreep org-yank-adjusted-subtrees)
22732 (let ((beg (point-at-bol)))
22733 (org-paste-subtree nil nil 'for-yank)
22734 (push-mark beg 'nomsg)))
22735 (t
22736 (call-interactively command))))))
22738 (defun org-yank-folding-would-swallow-text (beg end)
22739 "Would hide-subtree at BEG swallow any text after END?"
22740 (let (level)
22741 (org-with-limited-levels
22742 (save-excursion
22743 (goto-char beg)
22744 (when (or (looking-at org-outline-regexp)
22745 (re-search-forward org-outline-regexp-bol end t))
22746 (setq level (org-outline-level)))
22747 (goto-char end)
22749 (if (or (eobp)
22750 (and (bolp) (looking-at org-outline-regexp)
22751 (<= (org-outline-level) level)))
22752 nil ; Nothing would be swallowed
22753 t))))) ; something would swallow
22755 (define-key org-mode-map "\C-y" 'org-yank)
22757 (defun org-truely-invisible-p ()
22758 "Check if point is at a character currently not visible.
22759 This version does not only check the character property, but also
22760 `visible-mode'."
22761 ;; Early versions of noutline don't have `outline-invisible-p'.
22762 (if (org-bound-and-true-p visible-mode)
22763 nil
22764 (outline-invisible-p)))
22766 (defun org-invisible-p2 ()
22767 "Check if point is at a character currently not visible."
22768 (save-excursion
22769 (if (and (eolp) (not (bobp))) (backward-char 1))
22770 ;; Early versions of noutline don't have `outline-invisible-p'.
22771 (outline-invisible-p)))
22773 (defun org-back-to-heading (&optional invisible-ok)
22774 "Call `outline-back-to-heading', but provide a better error message."
22775 (condition-case nil
22776 (outline-back-to-heading invisible-ok)
22777 (error (error "Before first headline at position %d in buffer %s"
22778 (point) (current-buffer)))))
22780 (defun org-before-first-heading-p ()
22781 "Before first heading?"
22782 (save-excursion
22783 (end-of-line)
22784 (null (re-search-backward org-outline-regexp-bol nil t))))
22786 (defun org-at-heading-p (&optional ignored)
22787 (outline-on-heading-p t))
22788 ;; Compatibility alias with Org versions < 7.8.03
22789 (defalias 'org-on-heading-p 'org-at-heading-p)
22791 (defun org-at-comment-p nil
22792 "Is cursor in a line starting with a # character?"
22793 (save-excursion
22794 (beginning-of-line)
22795 (looking-at "^#")))
22797 (defun org-at-drawer-p nil
22798 "Is cursor at a drawer keyword?"
22799 (save-excursion
22800 (move-beginning-of-line 1)
22801 (looking-at org-drawer-regexp)))
22803 (defun org-at-block-p nil
22804 "Is cursor at a block keyword?"
22805 (save-excursion
22806 (move-beginning-of-line 1)
22807 (looking-at org-block-regexp)))
22809 (defun org-point-at-end-of-empty-headline ()
22810 "If point is at the end of an empty headline, return t, else nil.
22811 If the heading only contains a TODO keyword, it is still still considered
22812 empty."
22814 (when org-todo-line-regexp
22815 (save-excursion
22816 (beginning-of-line 1)
22817 (let ((case-fold-search nil))
22818 (looking-at org-todo-line-regexp)
22819 (string= (match-string 3) ""))))))
22821 (defun org-at-heading-or-item-p ()
22822 (or (org-at-heading-p) (org-at-item-p)))
22824 (defun org-at-target-p ()
22825 (or (org-in-regexp org-radio-target-regexp)
22826 (org-in-regexp org-target-regexp)))
22827 ;; Compatibility alias with Org versions < 7.8.03
22828 (defalias 'org-on-target-p 'org-at-target-p)
22830 (defun org-up-heading-all (arg)
22831 "Move to the heading line of which the present line is a subheading.
22832 This function considers both visible and invisible heading lines.
22833 With argument, move up ARG levels."
22834 (if (fboundp 'outline-up-heading-all)
22835 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22836 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22838 (defun org-up-heading-safe ()
22839 "Move to the heading line of which the present line is a subheading.
22840 This version will not throw an error. It will return the level of the
22841 headline found, or nil if no higher level is found.
22843 Also, this function will be a lot faster than `outline-up-heading',
22844 because it relies on stars being the outline starters. This can really
22845 make a significant difference in outlines with very many siblings."
22846 (let (start-level re)
22847 (org-back-to-heading t)
22848 (setq start-level (funcall outline-level))
22849 (if (equal start-level 1)
22850 nil
22852 (if (re-search-backward re nil t)
22853 (funcall outline-level)))))
22855 (defun org-first-sibling-p ()
22856 "Is this heading the first child of its parents?"
22857 (interactive)
22858 (let ((re org-outline-regexp-bol)
22859 level l)
22860 (unless (org-at-heading-p t)
22861 (error "Not at a heading"))
22862 (setq level (funcall outline-level))
22863 (save-excursion
22864 (if (not (re-search-backward re nil t))
22865 t
22866 (setq l (funcall outline-level))
22867 (< l level)))))
22869 (defun org-goto-sibling (&optional previous)
22870 "Goto the next sibling, even if it is invisible.
22871 When PREVIOUS is set, go to the previous sibling instead. Returns t
22872 when a sibling was found. When none is found, return nil and don't
22873 move point."
22874 (let ((fun (if previous 're-search-backward 're-search-forward))
22875 (pos (point))
22876 (re org-outline-regexp-bol)
22877 level l)
22878 (when (condition-case nil (org-back-to-heading t) (error nil))
22879 (setq level (funcall outline-level))
22880 (catch 'exit
22881 (or previous (forward-char 1))
22882 (while (funcall fun re nil t)
22883 (setq l (funcall outline-level))
22884 (when (< l level) (goto-char pos) (throw 'exit nil))
22885 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22886 (goto-char pos)
22887 nil))))
22889 (defun org-show-siblings ()
22890 "Show all siblings of the current headline."
22891 (save-excursion
22892 (while (org-goto-sibling) (org-flag-heading nil)))
22893 (save-excursion
22894 (while (org-goto-sibling 'previous)
22895 (org-flag-heading nil))))
22897 (defun org-goto-first-child ()
22898 "Goto the first child, even if it is invisible.
22899 Return t when a child was found. Otherwise don't move point and
22900 return nil."
22901 (let (level (pos (point)) (re org-outline-regexp-bol))
22902 (when (condition-case nil (org-back-to-heading t) (error nil))
22903 (setq level (outline-level))
22904 (forward-char 1)
22905 (if (and (re-search-forward re nil t) (> (outline-level) level))
22906 (progn (goto-char (match-beginning 0)) t)
22907 (goto-char pos) nil))))
22909 (defun org-show-hidden-entry ()
22910 "Show an entry where even the heading is hidden."
22911 (save-excursion
22912 (org-show-entry)))
22914 (defun org-flag-heading (flag &optional entry)
22915 "Flag the current heading. FLAG non-nil means make invisible.
22916 When ENTRY is non-nil, show the entire entry."
22917 (save-excursion
22918 (org-back-to-heading t)
22919 ;; Check if we should show the entire entry
22920 (if entry
22921 (progn
22922 (org-show-entry)
22923 (save-excursion
22924 (and (outline-next-heading)
22925 (org-flag-heading nil))))
22926 (outline-flag-region (max (point-min) (1- (point)))
22927 (save-excursion (outline-end-of-heading) (point))
22928 flag))))
22930 (defun org-get-next-sibling ()
22931 "Move to next heading of the same level, and return point.
22932 If there is no such heading, return nil.
22933 This is like outline-next-sibling, but invisible headings are ok."
22934 (let ((level (funcall outline-level)))
22935 (outline-next-heading)
22936 (while (and (not (eobp)) (> (funcall outline-level) level))
22937 (outline-next-heading))
22938 (if (or (eobp) (< (funcall outline-level) level))
22939 nil
22940 (point))))
22942 (defun org-get-last-sibling ()
22943 "Move to previous heading of the same level, and return point.
22944 If there is no such heading, return nil."
22945 (let ((opoint (point))
22946 (level (funcall outline-level)))
22947 (outline-previous-heading)
22948 (when (and (/= (point) opoint) (outline-on-heading-p t))
22949 (while (and (> (funcall outline-level) level)
22950 (not (bobp)))
22951 (outline-previous-heading))
22952 (if (< (funcall outline-level) level)
22953 nil
22954 (point)))))
22956 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22957 "Goto to the end of a subtree."
22958 ;; This contains an exact copy of the original function, but it uses
22959 ;; `org-back-to-heading', to make it work also in invisible
22960 ;; trees. And is uses an invisible-ok argument.
22961 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22962 ;; Furthermore, when used inside Org, finding the end of a large subtree
22963 ;; with many children and grandchildren etc, this can be much faster
22964 ;; than the outline version.
22965 (org-back-to-heading invisible-ok)
22966 (let ((first t)
22967 (level (funcall outline-level)))
22968 (if (and (derived-mode-p 'org-mode) (< level 1000))
22969 ;; A true heading (not a plain list item), in Org-mode
22970 ;; This means we can easily find the end by looking
22971 ;; only for the right number of stars. Using a regexp to do
22972 ;; this is so much faster than using a Lisp loop.
22974 (forward-char 1)
22975 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22976 ;; something else, do it the slow way
22977 (while (and (not (eobp))
22978 (or first (> (funcall outline-level) level)))
22979 (setq first nil)
22980 (outline-next-heading)))
22981 (unless to-heading
22983 (progn
22984 ;; Go to end of line before heading
22985 (forward-char -1)
22987 ;; leave blank line before heading
22988 (forward-char -1))))))
22989 (point))
22991 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22992 "Use Org version in org-mode, for dramatic speed-up."
22993 (if (derived-mode-p 'org-mode)
22994 (progn
22995 (org-end-of-subtree nil t)
22996 (unless (eobp) (backward-char 1)))
22997 ad-do-it))
22999 (defun org-end-of-meta-data-and-drawers ()
23000 "Jump to the first text after meta data and drawers in the current entry.
23001 This will move over empty lines, lines with planning time stamps,
23002 clocking lines, and drawers."
23003 (org-back-to-heading t)
23004 (let ((end (save-excursion (outline-next-heading) (point)))
23007 (forward-line 1)
23008 (while (re-search-forward re end t)
23009 (if (not (match-end 1))
23010 ;; empty or planning line
23011 (forward-line 1)
23012 ;; a drawer, find the end
23014 (forward-line 1)))
23016 (point)))
23018 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23019 "Move forward to the ARG'th subheading at same level as this one.
23020 Stop at the first and last subheadings of a superior heading.
23021 Normally this only looks at visible headings, but when INVISIBLE-OK is
23022 non-nil it will also look at invisible ones."
23023 (interactive "p")
23024 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23025 (if (and arg (< arg 0))
23026 (goto-char (point-min))
23027 (outline-next-heading))
23028 (org-at-heading-p)
23029 (let ((level (- (match-end 0) (match-beginning 0) 1))
23030 (f (if (and arg (< arg 0))
23031 're-search-backward
23032 're-search-forward))
23033 (count (if arg (abs arg) 1))
23034 (result (point)))
23035 (while (and (prog1 (> count 0)
23036 (forward-char (if (and arg (< arg 0)) -1 1)))
23037 (funcall f org-outline-regexp-bol nil 'move))
23038 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23039 (cond ((< l level) (setq count 0))
23040 ((and (= l level)
23041 (or invisible-ok
23042 (progn
23043 (goto-char (line-beginning-position))
23044 (not (outline-invisible-p)))))
23045 (setq count (1- count))
23046 (when (eq l level)
23047 (setq result (point)))))))
23048 (goto-char result))
23049 (beginning-of-line 1)))
23051 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23052 "Move backward to the ARG'th subheading at same level as this one.
23053 Stop at the first and last subheadings of a superior heading."
23054 (interactive "p")
23055 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23057 (defun org-next-block (arg &optional backward block-regexp)
23058 "Jump to the next block.
23059 With a prefix argument ARG, jump forward ARG many source blocks.
23060 When BACKWARD is non-nil, jump to the previous block.
23061 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23062 (interactive "p")
23063 (let ((re (or block-regexp org-block-regexp))
23064 (re-search-fn (or (and backward 're-search-backward)
23065 're-search-forward)))
23066 (if (looking-at re) (forward-char 1))
23067 (condition-case nil
23068 (funcall re-search-fn re nil nil arg)
23069 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23070 (goto-char (match-beginning 0)) (org-show-context)))
23072 (defun org-previous-block (arg &optional block-regexp)
23073 "Jump to the previous block.
23074 With a prefix argument ARG, jump backward ARG many source blocks.
23075 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23076 (interactive "p")
23077 (org-next-block arg t block-regexp))
23079 (defun org-forward-element ()
23080 "Move forward by one element.
23081 Move to the next element at the same level, when possible."
23082 (interactive)
23083 (cond ((eobp) (user-error "Cannot move further down"))
23084 ((org-with-limited-levels (org-at-heading-p))
23085 (let ((origin (point)))
23086 (goto-char (org-end-of-subtree nil t))
23087 (unless (org-with-limited-levels (org-at-heading-p))
23088 (goto-char origin)
23089 (user-error "Cannot move further down"))))
23090 (t
23091 (let* ((elem (org-element-at-point))
23092 (end (org-element-property :end elem))
23093 (parent (org-element-property :parent elem)))
23094 (if (and parent (= (org-element-property :contents-end parent) end))
23095 (goto-char (org-element-property :end parent))
23096 (goto-char end))))))
23098 (defun org-backward-element ()
23099 "Move backward by one element.
23100 Move to the previous element at the same level, when possible."
23101 (interactive)
23102 (cond ((bobp) (user-error "Cannot move further up"))
23103 ((org-with-limited-levels (org-at-heading-p))
23104 ;; At a headline, move to the previous one, if any, or stay
23105 ;; here.
23106 (let ((origin (point)))
23107 (org-with-limited-levels (org-backward-heading-same-level 1))
23108 ;; When current headline has no sibling above, move to its
23109 ;; parent.
23110 (when (= (point) origin)
23111 (or (org-with-limited-levels (org-up-heading-safe))
23112 (progn (goto-char origin)
23113 (user-error "Cannot move further up"))))))
23114 (t
23115 (let* ((trail (org-element-at-point 'keep-trail))
23116 (elem (car trail))
23117 (prev-elem (nth 1 trail))
23118 (beg (org-element-property :begin elem)))
23119 (cond
23120 ;; Move to beginning of current element if point isn't
23121 ;; there already.
23122 ((/= (point) beg) (goto-char beg))
23123 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23124 ((org-before-first-heading-p) (goto-char (point-min)))
23125 (t (org-back-to-heading)))))))
23127 (defun org-up-element ()
23128 "Move to upper element."
23129 (interactive)
23130 (if (org-with-limited-levels (org-at-heading-p))
23131 (unless (org-up-heading-safe) (error "No surrounding element"))
23132 (let* ((elem (org-element-at-point))
23133 (parent (org-element-property :parent elem)))
23134 (if parent (goto-char (org-element-property :begin parent))
23135 (if (org-with-limited-levels (org-before-first-heading-p))
23136 (error "No surrounding element")
23137 (org-with-limited-levels (org-back-to-heading)))))))
23139 (defvar org-element-greater-elements)
23140 (defun org-down-element ()
23141 "Move to inner element."
23142 (interactive)
23143 (let ((element (org-element-at-point)))
23144 (cond
23145 ((memq (org-element-type element) '(plain-list table))
23146 (goto-char (org-element-property :contents-begin element))
23147 (forward-char))
23148 ((memq (org-element-type element) org-element-greater-elements)
23149 ;; If contents are hidden, first disclose them.
23150 (when (org-element-property :hiddenp element) (org-cycle))
23151 (goto-char (or (org-element-property :contents-begin element)
23152 (error "No content for this element"))))
23153 (t (error "No inner element")))))
23155 (defun org-drag-element-backward ()
23156 "Move backward element at point."
23157 (interactive)
23158 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23159 (let* ((trail (org-element-at-point 'keep-trail))
23160 (elem (car trail))
23161 (prev-elem (nth 1 trail)))
23162 ;; Error out if no previous element or previous element is
23163 ;; a parent of the current one.
23164 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23165 (error "Cannot drag element backward")
23166 (let ((pos (point)))
23167 (org-element-swap-A-B prev-elem elem)
23168 (goto-char (+ (org-element-property :begin prev-elem)
23169 (- pos (org-element-property :begin elem)))))))))
23171 (defun org-drag-element-forward ()
23172 "Move forward element at point."
23173 (interactive)
23174 (let* ((pos (point))
23175 (elem (org-element-at-point)))
23176 (when (= (point-max) (org-element-property :end elem))
23177 (error "Cannot drag element forward"))
23178 (goto-char (org-element-property :end elem))
23179 (let ((next-elem (org-element-at-point)))
23180 (when (or (org-element-nested-p elem next-elem)
23181 (and (eq (org-element-type next-elem) 'headline)
23182 (not (eq (org-element-type elem) 'headline))))
23183 (goto-char pos)
23184 (error "Cannot drag element forward"))
23185 ;; Compute new position of point: it's shifted by NEXT-ELEM
23186 ;; body's length (without final blanks) and by the length of
23187 ;; blanks between ELEM and NEXT-ELEM.
23188 (let ((size-next (- (save-excursion
23189 (goto-char (org-element-property :end next-elem))
23191 (forward-line)
23192 ;; Small correction if buffer doesn't end
23193 ;; with a newline character.
23194 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23195 (org-element-property :begin next-elem)))
23196 (size-blank (- (org-element-property :end elem)
23197 (save-excursion
23198 (goto-char (org-element-property :end elem))
23200 (forward-line)
23201 (point)))))
23202 (org-element-swap-A-B elem next-elem)
23203 (goto-char (+ pos size-next size-blank))))))
23205 (defun org-drag-line-forward (arg)
23206 "Drag the line at point ARG lines forward."
23207 (interactive "p")
23208 (dotimes (n (abs arg))
23209 (let ((c (current-column)))
23210 (if (< 0 arg)
23211 (progn
23212 (beginning-of-line 2)
23213 (transpose-lines 1)
23214 (beginning-of-line 0))
23215 (transpose-lines 1)
23216 (beginning-of-line -1))
23217 (org-move-to-column c))))
23219 (defun org-drag-line-backward (arg)
23220 "Drag the line at point ARG lines backward."
23221 (interactive "p")
23222 (org-drag-line-forward (- arg)))
23224 (defun org-mark-element ()
23225 "Put point at beginning of this element, mark at end.
23227 Interactively, if this command is repeated or (in Transient Mark
23228 mode) if the mark is active, it marks the next element after the
23229 ones already marked."
23230 (interactive)
23231 (let (deactivate-mark)
23232 (if (and (org-called-interactively-p 'any)
23233 (or (and (eq last-command this-command) (mark t))
23234 (and transient-mark-mode mark-active)))
23235 (set-mark
23236 (save-excursion
23237 (goto-char (mark))
23238 (goto-char (org-element-property :end (org-element-at-point)))))
23239 (let ((element (org-element-at-point)))
23240 (end-of-line)
23241 (push-mark (org-element-property :end element) t t)
23242 (goto-char (org-element-property :begin element))))))
23244 (defun org-narrow-to-element ()
23245 "Narrow buffer to current element."
23246 (interactive)
23247 (let ((elem (org-element-at-point)))
23248 (cond
23249 ((eq (car elem) 'headline)
23250 (narrow-to-region
23251 (org-element-property :begin elem)
23252 (org-element-property :end elem)))
23253 ((memq (car elem) org-element-greater-elements)
23254 (narrow-to-region
23255 (org-element-property :contents-begin elem)
23256 (org-element-property :contents-end elem)))
23257 (t
23258 (narrow-to-region
23259 (org-element-property :begin elem)
23260 (org-element-property :end elem))))))
23262 (defun org-transpose-element ()
23263 "Transpose current and previous elements, keeping blank lines between.
23264 Point is moved after both elements."
23265 (interactive)
23266 (org-skip-whitespace)
23267 (let ((end (org-element-property :end (org-element-at-point))))
23268 (org-drag-element-backward)
23269 (goto-char end)))
23271 (defun org-unindent-buffer ()
23272 "Un-indent the visible part of the buffer.
23273 Relative indentation (between items, inside blocks, etc.) isn't
23274 modified."
23275 (interactive)
23276 (unless (eq major-mode 'org-mode)
23277 (error "Cannot un-indent a buffer not in Org mode"))
23278 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23279 unindent-tree ; For byte-compiler.
23280 (unindent-tree
23281 (function
23282 (lambda (contents)
23283 (mapc
23284 (lambda (element)
23285 (if (memq (org-element-type element) '(headline section))
23286 (funcall unindent-tree (org-element-contents element))
23287 (save-excursion
23288 (save-restriction
23289 (narrow-to-region
23290 (org-element-property :begin element)
23291 (org-element-property :end element))
23292 (org-do-remove-indentation)))))
23293 (reverse contents))))))
23294 (funcall unindent-tree (org-element-contents parse-tree))))
23296 (defun org-show-subtree ()
23297 "Show everything after this heading at deeper levels."
23298 (interactive)
23299 (outline-flag-region
23300 (point)
23301 (save-excursion
23302 (org-end-of-subtree t t))
23303 nil))
23305 (defun org-show-entry ()
23306 "Show the body directly following this heading.
23307 Show the heading too, if it is currently invisible."
23308 (interactive)
23309 (save-excursion
23310 (condition-case nil
23311 (progn
23312 (org-back-to-heading t)
23313 (outline-flag-region
23314 (max (point-min) (1- (point)))
23315 (save-excursion
23316 (if (re-search-forward
23318 (match-beginning 1)
23319 (point-max)))
23320 nil)
23321 (org-cycle-hide-drawers 'children))
23322 (error nil))))
23324 (defun org-make-options-regexp (kwds &optional extra)
23325 "Make a regular expression for keyword lines."
23326 (concat
23332 ;; Make isearch reveal the necessary context
23333 (defun org-isearch-end ()
23334 "Reveal context after isearch exits."
23335 (when isearch-success ; only if search was successful
23336 (if (featurep 'xemacs)
23337 ;; Under XEmacs, the hook is run in the correct place,
23338 ;; we directly show the context.
23339 (org-show-context 'isearch)
23340 ;; In Emacs the hook runs *before* restoring the overlays.
23341 ;; So we have to use a one-time post-command-hook to do this.
23342 ;; (Emacs 22 has a special variable, see function `org-mode')
23343 (unless (and (boundp 'isearch-mode-end-hook-quit)
23344 isearch-mode-end-hook-quit)
23345 ;; Only when the isearch was not quitted.
23346 (org-add-hook 'post-command-hook 'org-isearch-post-command
23347 'append 'local)))
23348 (org-fix-ellipsis-at-bol)))
23350 (defun org-isearch-post-command ()
23351 "Remove self from hook, and show context."
23352 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23353 (org-show-context 'isearch))
23356 ;;;; Integration with and fixes for other packages
23358 ;;; Imenu support
23360 (defvar org-imenu-markers nil
23361 "All markers currently used by Imenu.")
23362 (make-variable-buffer-local 'org-imenu-markers)
23364 (defun org-imenu-new-marker (&optional pos)
23365 "Return a new marker for use by Imenu, and remember the marker."
23366 (let ((m (make-marker)))
23367 (move-marker m (or pos (point)))
23368 (push m org-imenu-markers)
23369 m))
23371 (defun org-imenu-get-tree ()
23372 "Produce the index for Imenu."
23373 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23374 (setq org-imenu-markers nil)
23375 (let* ((n org-imenu-depth)
23376 (re (concat "^" (org-get-limited-outline-regexp)))
23377 (subs (make-vector (1+ n) nil))
23378 (last-level 0)
23379 m level head0 head)
23380 (save-excursion
23381 (save-restriction
23382 (widen)
23383 (goto-char (point-max))
23384 (while (re-search-backward re nil t)
23385 (setq level (org-reduced-level (funcall outline-level)))
23386 (when (and (<= level n)
23387 (looking-at org-complex-heading-regexp)
23388 (setq head0 (org-match-string-no-properties 4)))
23389 (setq head (org-link-display-format head0)
23390 m (org-imenu-new-marker))
23391 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23392 (if (>= level last-level)
23393 (push (cons head m) (aref subs level))
23394 (push (cons head (aref subs (1+ level))) (aref subs level))
23395 (loop for i from (1+ level) to n do (aset subs i nil)))
23396 (setq last-level level)))))
23397 (aref subs 1)))
23399 (eval-after-load "imenu"
23400 '(progn
23401 (add-hook 'imenu-after-jump-hook
23402 (lambda ()
23403 (if (derived-mode-p 'org-mode)
23404 (org-show-context 'org-goto))))))
23406 (defun org-link-display-format (link)
23407 "Replace a link with its the description.
23408 If there is no description, use the link target."
23409 (save-match-data
23410 (if (string-match org-bracket-link-analytic-regexp link)
23411 (replace-match (if (match-end 5)
23412 (match-string 5 link)
23413 (concat (match-string 1 link)
23414 (match-string 3 link)))
23415 nil t link)
23416 link)))
23418 (defun org-toggle-link-display ()
23419 "Toggle the literal or descriptive display of links."
23420 (interactive)
23421 (if org-descriptive-links
23422 (progn (org-remove-from-invisibility-spec '(org-link))
23423 (org-restart-font-lock)
23424 (setq org-descriptive-links nil))
23425 (progn (add-to-invisibility-spec '(org-link))
23426 (org-restart-font-lock)
23427 (setq org-descriptive-links t))))
23429 ;; Speedbar support
23431 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23432 "Overlay marking the agenda restriction line in speedbar.")
23433 (overlay-put org-speedbar-restriction-lock-overlay
23434 'face 'org-agenda-restriction-lock)
23435 (overlay-put org-speedbar-restriction-lock-overlay
23436 'help-echo "Agendas are currently limited to this item.")
23437 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23439 (defun org-speedbar-set-agenda-restriction ()
23440 "Restrict future agenda commands to the location at point in speedbar.
23442 (interactive)
23443 (require 'org-agenda)
23444 (let (p m tp np dir txt)
23445 (cond
23446 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23447 'org-imenu t))
23448 (setq m (get-text-property p 'org-imenu-marker))
23449 (with-current-buffer (marker-buffer m)
23450 (goto-char m)
23451 (org-agenda-set-restriction-lock 'subtree)))
23452 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23453 'speedbar-function 'speedbar-find-file))
23454 (setq tp (previous-single-property-change
23455 (1+ p) 'speedbar-function)
23456 np (next-single-property-change
23457 tp 'speedbar-function)
23458 dir (speedbar-line-directory)
23459 txt (buffer-substring-no-properties (or tp (point-min))
23460 (or np (point-max))))
23461 (with-current-buffer (find-file-noselect
23462 (let ((default-directory dir))
23463 (expand-file-name txt)))
23464 (unless (derived-mode-p 'org-mode)
23465 (error "Cannot restrict to non-Org-mode file"))
23466 (org-agenda-set-restriction-lock 'file)))
23467 (t (error "Don't know how to restrict Org-mode's agenda")))
23468 (move-overlay org-speedbar-restriction-lock-overlay
23469 (point-at-bol) (point-at-eol))
23470 (setq current-prefix-arg nil)
23471 (org-agenda-maybe-redo)))
23473 (eval-after-load "speedbar"
23474 '(progn
23475 (speedbar-add-supported-extension ".org")
23476 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23477 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23478 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23479 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23480 (add-hook 'speedbar-visiting-tag-hook
23481 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23483 ;;; Fixes and Hacks for problems with other packages
23485 ;; Make flyspell not check words in links, to not mess up our keymap
23486 (defvar org-element-affiliated-keywords) ; From org-element.el
23487 (defvar org-element-block-name-alist) ; From org-element.el
23488 (defun org-mode-flyspell-verify ()
23489 "Don't let flyspell put overlays at active buttons, or on
23490 {todo,all-time,additional-option-like}-keywords."
23491 (require 'org-element) ; For `org-element-affiliated-keywords'
23492 (let ((pos (max (1- (point)) (point-min)))
23493 (word (thing-at-point 'word)))
23494 (and (not (get-text-property pos 'keymap))
23495 (not (get-text-property pos 'org-no-flyspell))
23496 (not (member word org-todo-keywords-1))
23497 (not (member word org-all-time-keywords))
23498 (not (member word org-options-keywords))
23499 (not (member word (mapcar 'car org-startup-options)))
23500 (not (member-ignore-case word org-element-affiliated-keywords))
23501 (not (member-ignore-case word (org-get-export-keywords)))
23502 (not (member-ignore-case
23503 word (mapcar 'car org-element-block-name-alist)))
23504 (not (member-ignore-case word '("BEGIN" "END" "ATTR"))))))
23506 (defun org-remove-flyspell-overlays-in (beg end)
23507 "Remove flyspell overlays in region."
23508 (and (org-bound-and-true-p flyspell-mode)
23509 (fboundp 'flyspell-delete-region-overlays)
23510 (flyspell-delete-region-overlays beg end))
23511 (add-text-properties beg end '(org-no-flyspell t)))
23513 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23514 (eval-after-load "bookmark"
23515 '(if (boundp 'bookmark-after-jump-hook)
23516 ;; We can use the hook
23517 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23518 ;; Hook not available, use advice
23519 (defadvice bookmark-jump (after org-make-visible activate)
23520 "Make the position visible."
23521 (org-bookmark-jump-unhide))))
23523 ;; Make sure saveplace shows the location if it was hidden
23524 (eval-after-load "saveplace"
23525 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23526 "Make the position visible."
23527 (org-bookmark-jump-unhide)))
23529 ;; Make sure ecb shows the location if it was hidden
23530 (eval-after-load "ecb"
23531 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23532 "Make hierarchy visible when jumping into location from ECB tree buffer."
23533 (if (derived-mode-p 'org-mode)
23534 (org-show-context))))
23536 (defun org-bookmark-jump-unhide ()
23537 "Unhide the current position, to show the bookmark location."
23538 (and (derived-mode-p 'org-mode)
23539 (or (outline-invisible-p)
23540 (save-excursion (goto-char (max (point-min) (1- (point))))
23541 (outline-invisible-p)))
23542 (org-show-context 'bookmark-jump)))
23544 ;; Make session.el ignore our circular variable
23545 (eval-after-load "session"
23546 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23548 ;;;; Finish up
23550 (provide 'org)
23552 (run-hooks 'org-load-hook)
23554 ;;; org.el ends here