| blob | 50f988de22c7170140861f26ade43c49a66eabe5 |
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
9256 (save-match-data
9257 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9258 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9259 ((string-match "%h" rpl)
9260 (replace-match (url-hexify-string (or tag "")) t t rpl))
9261 (t (concat rpl tag)))))
9262 link))
9264 ;;; Storing and inserting links
9266 (defvar org-insert-link-history nil
9267 "Minibuffer history for links inserted with `org-insert-link'.")
9269 (defvar org-stored-links nil
9270 "Contains the links stored with `org-store-link'.")
9272 (defvar org-store-link-plist nil
9273 "Plist with info about the most recently link created with `org-store-link'.")
9275 (defvar org-link-protocols nil
9276 "Link protocols added to Org-mode using `org-add-link-type'.")
9278 (defvar org-store-link-functions nil
9279 "List of functions that are called to create and store a link.
9280 Each function will be called in turn until one returns a non-nil
9281 value. Each function should check if it is responsible for creating
9282 this link (for example by looking at the major mode).
9283 If not, it must exit and return nil.
9284 If yes, it should return a non-nil value after a calling
9285 `org-store-link-props' with a list of properties and values.
9286 Special properties are:
9290 This is obligatory as well.
9291 :description Optional default description for the second pair
9292 of brackets in an Org-mode link. The user can still change
9293 this when inserting this link into an Org-mode buffer.
9295 In addition to these, any additional properties can be specified
9296 and then used in capture templates.")
9298 (defun org-add-link-type (type &optional follow export)
9299 "Add TYPE to the list of `org-link-types'.
9300 Re-compute all regular expressions depending on `org-link-types'
9302 FOLLOW and EXPORT are two functions.
9304 FOLLOW should take the link path as the single argument and do whatever
9305 is necessary to follow the link, for example find a file or display
9306 a mail message.
9308 EXPORT should format the link path for export to one of the export formats.
9309 It should be a function accepting three arguments:
9312 desc the description of the link, if any, or a description added by
9313 org-export-normalize-links if there is none
9314 format the export format, a symbol like `html' or `latex' or `ascii'..
9316 The function may use the FORMAT information to return different values
9317 depending on the format. The return value will be put literally into
9318 the exported file. If the return value is nil, this means Org should
9319 do what it normally does with links which do not have EXPORT defined.
9321 Org-mode has a built-in default for exporting links. If you are happy with
9322 this default, there is no need to define an export function for the link
9323 type. For a simple example of an export function, see `org-bbdb.el'."
9324 (add-to-list 'org-link-types type t)
9325 (org-make-link-regexps)
9326 (if (assoc type org-link-protocols)
9327 (setcdr (assoc type org-link-protocols) (list follow export))
9328 (push (list type follow export) org-link-protocols)))
9330 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9331 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9333 ;;;###autoload
9334 (defun org-store-link (arg)
9336 This link is added to `org-stored-links' and can later be inserted
9339 For some link types, a prefix arg is interpreted.
9340 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9341 For file links, arg negates `org-context-in-file-links'.
9343 A double prefix arg force skipping storing functions that are not
9344 part of Org's core.
9346 A triple prefix arg force storing a link for each line in the
9347 active region."
9348 (interactive "P")
9349 (org-load-modules-maybe)
9350 (if (and (equal arg '(64)) (org-region-active-p))
9351 (save-excursion
9352 (let ((end (region-end)))
9353 (goto-char (region-beginning))
9354 (set-mark (point))
9355 (while (< (point-at-eol) end)
9356 (move-end-of-line 1) (activate-mark)
9357 (let (current-prefix-arg)
9358 (call-interactively 'org-store-link))
9359 (move-beginning-of-line 2)
9360 (set-mark (point)))))
9361 (org-with-limited-levels
9362 (setq org-store-link-plist nil)
9363 (let (link cpltxt desc description search
9364 txt custom-id agenda-link sfuns sfunsn)
9365 (cond
9367 ;; Store a link using an external link type
9368 ((and (not (equal arg '(16)))
9369 (setq sfuns
9370 (delq
9371 nil (mapcar (lambda (f)
9372 (let (fs) (if (funcall f) (push f fs))))
9373 org-store-link-functions))
9374 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9375 (or (and (cdr sfuns)
9376 (funcall (intern
9377 (completing-read
9378 "Which function for creating the link? "
9379 sfunsn t (car sfunsn)))))
9380 (funcall (caar sfuns)))
9381 (setq link (plist-get org-store-link-plist :link)
9382 desc (or (plist-get org-store-link-plist
9383 :description) link))))
9385 ;; Store a link from a source code buffer
9386 ((org-src-edit-buffer-p)
9387 (let (label gc)
9388 (while (or (not label)
9389 (save-excursion
9390 (save-restriction
9391 (widen)
9392 (goto-char (point-min))
9393 (re-search-forward
9394 (regexp-quote (format org-coderef-label-format label))
9395 nil t))))
9396 (when label (message "Label exists already") (sit-for 2))
9397 (setq label (read-string "Code line label: " label)))
9398 (end-of-line 1)
9399 (setq link (format org-coderef-label-format label))
9400 (setq gc (- 79 (length link)))
9401 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9402 (insert link)
9403 (setq link (concat "(" label ")") desc nil)))
9405 ;; We are in the agenda, link to referenced location
9406 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9407 (let ((m (or (get-text-property (point) 'org-hd-marker)
9408 (get-text-property (point) 'org-marker))))
9409 (when m
9410 (org-with-point-at m
9411 (setq agenda-link
9412 (if (org-called-interactively-p 'any)
9413 (call-interactively 'org-store-link)
9414 (org-store-link nil)))))))
9416 ((eq major-mode 'calendar-mode)
9417 (let ((cd (calendar-cursor-to-date)))
9418 (setq link
9419 (format-time-string
9420 (car org-time-stamp-formats)
9421 (apply 'encode-time
9422 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9423 nil nil nil))))
9424 (org-store-link-props :type "calendar" :date cd)))
9426 ((eq major-mode 'help-mode)
9427 (setq link (concat "help:" (save-excursion
9428 (goto-char (point-min))
9429 (looking-at "^[^ ]+")
9430 (match-string 0))))
9431 (org-store-link-props :type "help"))
9433 ((eq major-mode 'w3-mode)
9434 (setq cpltxt (if (and (buffer-name)
9435 (not (string-match "Untitled" (buffer-name))))
9436 (buffer-name)
9437 (url-view-url t))
9438 link (url-view-url t))
9439 (org-store-link-props :type "w3" :url (url-view-url t)))
9441 ((eq major-mode 'image-mode)
9442 (setq cpltxt (concat "file:"
9443 (abbreviate-file-name buffer-file-name))
9444 link cpltxt)
9445 (org-store-link-props :type "image" :file buffer-file-name))
9447 ;; In dired, store a link to the file of the current line
9448 ((eq major-mode 'dired-mode)
9449 (let ((file (dired-get-filename nil t)))
9450 (setq file (if file
9451 (abbreviate-file-name
9452 (expand-file-name (dired-get-filename nil t)))
9453 ;; otherwise, no file so use current directory.
9454 default-directory))
9455 (setq cpltxt (concat "file:" file)
9456 link cpltxt)))
9458 ((setq search (run-hook-with-args-until-success
9459 'org-create-file-search-functions))
9460 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9461 "::" search))
9462 (setq cpltxt (or description link)))
9464 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9465 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9466 (cond
9467 ;; Store a link using the radio target at point
9469 (setq cpltxt
9470 (concat "file:"
9471 (abbreviate-file-name
9472 (buffer-file-name (buffer-base-buffer)))
9473 "::" (match-string 1))
9474 link cpltxt))
9475 ((and (featurep 'org-id)
9476 (or (eq org-id-link-to-org-use-id t)
9477 (and (org-called-interactively-p 'any)
9478 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9479 (and (eq org-id-link-to-org-use-id
9480 'create-if-interactive-and-no-custom-id)
9481 (not custom-id))))
9482 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9483 ;; Store a link using the ID at point
9484 (setq link (condition-case nil
9485 (prog1 (org-id-store-link)
9486 (setq desc (plist-get org-store-link-plist
9487 :description)))
9488 (error
9489 ;; Probably before first headline, link only to file
9490 (concat "file:"
9491 (abbreviate-file-name
9492 (buffer-file-name (buffer-base-buffer))))))))
9493 (t
9494 ;; Just link to current headline
9495 (setq cpltxt (concat "file:"
9496 (abbreviate-file-name
9497 (buffer-file-name (buffer-base-buffer)))))
9498 ;; Add a context search string
9499 (when (org-xor org-context-in-file-links arg)
9500 (let* ((ee (org-element-at-point))
9501 (et (org-element-type ee))
9502 (ev (plist-get (cadr ee) :value))
9503 (ek (plist-get (cadr ee) :key))
9504 (eok (and (stringp ek) (string-match "name" ek))))
9505 (setq txt (cond
9506 ((org-at-heading-p) nil)
9507 ((and (eq et 'keyword) eok) ev)
9508 ((org-region-active-p)
9509 (buffer-substring (region-beginning) (region-end)))))
9511 (setq cpltxt
9512 (concat cpltxt "::"
9513 (condition-case nil
9514 (org-make-org-heading-search-string txt)
9515 (error "")))
9516 desc (or (and (eq et 'keyword) eok ev)
9517 (nth 4 (ignore-errors (org-heading-components)))
9518 "NONE")))))
9520 (setq cpltxt (substring cpltxt 0 -2)))
9521 (setq link cpltxt))))
9523 ((buffer-file-name (buffer-base-buffer))
9524 ;; Just link to this file here.
9525 (setq cpltxt (concat "file:"
9526 (abbreviate-file-name
9527 (buffer-file-name (buffer-base-buffer)))))
9528 ;; Add a context string.
9529 (when (org-xor org-context-in-file-links arg)
9530 (setq txt (if (org-region-active-p)
9531 (buffer-substring (region-beginning) (region-end))
9532 (buffer-substring (point-at-bol) (point-at-eol))))
9533 ;; Only use search option if there is some text.
9535 (setq cpltxt
9536 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9537 desc "NONE")))
9538 (setq link cpltxt))
9540 ((org-called-interactively-p 'interactive)
9541 (user-error "No method for storing a link from this buffer"))
9543 (t (setq link nil)))
9545 ;; We're done setting link and desc, clean up
9546 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9547 (setq link (or link cpltxt)
9548 desc (or desc cpltxt))
9549 (cond ((equal desc "NONE") (setq desc nil))
9550 ((string-match org-bracket-link-regexp desc)
9551 (setq desc
9552 (replace-regexp-in-string
9553 org-bracket-link-regexp
9555 (length desc)) "*" "")) desc))))
9557 ;; Return the link
9558 (if (not (and (or (org-called-interactively-p 'any)
9559 executing-kbd-macro) link))
9560 (or agenda-link (and link (org-make-link-string link desc)))
9561 (push (list link desc) org-stored-links)
9562 (message "Stored: %s" (or desc link))
9563 (when custom-id
9564 (setq link (concat "file:" (abbreviate-file-name
9565 (buffer-file-name)) "::#" custom-id))
9566 (push (list link desc) org-stored-links)))))))
9568 (defun org-store-link-props (&rest plist)
9569 "Store link properties, extract names and addresses."
9570 (let (x adr)
9571 (when (setq x (plist-get plist :from))
9572 (setq adr (mail-extract-address-components x))
9573 (setq plist (plist-put plist :fromname (car adr)))
9574 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9575 (when (setq x (plist-get plist :to))
9576 (setq adr (mail-extract-address-components x))
9577 (setq plist (plist-put plist :toname (car adr)))
9578 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9579 (let ((from (plist-get plist :from))
9580 (to (plist-get plist :to)))
9581 (when (and from to org-from-is-user-regexp)
9582 (setq plist
9583 (plist-put plist :fromto
9584 (if (string-match org-from-is-user-regexp from)
9585 (concat "to %t")
9586 (concat "from %f"))))))
9587 (setq org-store-link-plist plist))
9589 (defun org-add-link-props (&rest plist)
9590 "Add these properties to the link property list."
9591 (let (key value)
9592 (while plist
9593 (setq key (pop plist) value (pop plist))
9594 (setq org-store-link-plist
9595 (plist-put org-store-link-plist key value)))))
9597 (defun org-email-link-description (&optional fmt)
9598 "Return the description part of an email link.
9599 This takes information from `org-store-link-plist' and formats it
9600 according to FMT (default from `org-email-link-description-format')."
9601 (setq fmt (or fmt org-email-link-description-format))
9602 (let* ((p org-store-link-plist)
9603 (to (plist-get p :toaddress))
9604 (from (plist-get p :fromaddress))
9605 (table
9606 (list
9607 (cons "%c" (plist-get p :fromto))
9608 (cons "%F" (plist-get p :from))
9609 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9610 (cons "%T" (plist-get p :to))
9611 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9612 (cons "%s" (plist-get p :subject))
9613 (cons "%d" (plist-get p :date))
9614 (cons "%m" (plist-get p :message-id)))))
9615 (when (string-match "%c" fmt)
9616 ;; Check if the user wrote this message
9617 (if (and org-from-is-user-regexp from to
9618 (save-match-data (string-match org-from-is-user-regexp from)))
9619 (setq fmt (replace-match "to %t" t t fmt))
9620 (setq fmt (replace-match "from %f" t t fmt))))
9621 (org-replace-escapes fmt table)))
9623 (defun org-make-org-heading-search-string (&optional string)
9624 "Make search string for the current headline or STRING."
9625 (let ((s (or string
9626 (and (derived-mode-p 'org-mode)
9627 (save-excursion
9628 (org-back-to-heading t)
9629 (org-element-property :raw-value (org-element-at-point))))))
9630 (lines org-context-in-file-links))
9631 (or string (setq s (concat "*" s))) ; Add * for headlines
9633 (when (and string (integerp lines) (> lines 0))
9635 (when (< lines (length slines))
9636 (setq s (mapconcat
9637 'identity
9638 (reverse (nthcdr (- (length slines) lines)
9642 (defun org-make-link-string (link &optional description)
9643 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9645 (error "Empty link"))
9646 (when (and description
9647 (stringp description)
9649 (setq description nil))
9650 (when (stringp description)
9651 ;; Remove brackets from the description, they are fatal.
9653 (setq description (replace-match "{" t t description)))
9655 (setq description (replace-match "}" t t description))))
9656 (when (equal link description)
9657 ;; No description needed, it is identical
9658 (setq description nil))
9659 (when (and (not description)
9660 (not (string-match (org-image-file-name-regexp) link))
9661 (not (equal link (org-link-escape link))))
9662 (setq description (org-extract-attributes link)))
9663 (setq link
9664 (cond ((string-match (org-image-file-name-regexp) link) link)
9665 ((string-match org-link-types-re link)
9666 (concat (match-string 1 link)
9667 (org-link-escape (substring link (match-end 1)))))
9668 (t (org-link-escape link))))
9669 (concat "[[" link "]"
9670 (if description (concat "[" description "]") "")
9671 "]"))
9673 (defconst org-link-escape-chars
9674 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9675 "List of characters that should be escaped in link.
9676 This is the list that is used for internal purposes.")
9678 (defconst org-link-escape-chars-browser
9679 '(?\ )
9680 "List of escapes for characters that are problematic in links.
9681 This is the list that is used before handing over to the browser.")
9683 (defun org-link-escape (text &optional table merge)
9684 "Return percent escaped representation of TEXT.
9685 TEXT is a string with the text to escape.
9686 Optional argument TABLE is a list with characters that should be
9687 escaped. When nil, `org-link-escape-chars' is used.
9688 If optional argument MERGE is set, merge TABLE into
9689 `org-link-escape-chars'."
9690 (cond
9691 ((and table merge)
9692 (mapc (lambda (defchr)
9693 (unless (member defchr table)
9694 (setq table (cons defchr table)))) org-link-escape-chars))
9695 ((null table)
9696 (setq table org-link-escape-chars)))
9697 (mapconcat
9698 (lambda (char)
9699 (if (or (member char table)
9700 (and (or (< char 32) (= char 37) (> char 126))
9701 org-url-hexify-p))
9702 (mapconcat (lambda (sequence-element)
9703 (format "%%%.2X" sequence-element))
9704 (or (encode-coding-char char 'utf-8)
9705 (error "Unable to percent escape character: %s"
9706 (char-to-string char))) "")
9707 (char-to-string char))) text ""))
9709 (defun org-link-unescape (str)
9710 "Unhex hexified Unicode strings as returned from the JavaScript function
9711 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9712 (unless (and (null str) (string= "" str))
9713 (let ((pos 0) (case-fold-search t) unhexed)
9715 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9716 (setq str (replace-match unhexed t t str))
9717 (setq pos (+ pos (length unhexed))))))
9718 str)
9720 (defun org-link-unescape-compound (hex)
9721 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9722 Note: this function also decodes single byte encodings like
9723 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9724 (save-match-data
9725 (let* ((bytes (cdr (split-string hex "%")))
9726 (ret "")
9727 (eat 0)
9728 (sum 0))
9729 (while bytes
9730 (let* ((val (string-to-number (pop bytes) 16))
9731 (shift-xor
9732 (if (= 0 eat)
9733 (cond
9734 ((>= val 252) (cons 6 252))
9735 ((>= val 248) (cons 5 248))
9736 ((>= val 240) (cons 4 240))
9737 ((>= val 224) (cons 3 224))
9738 ((>= val 192) (cons 2 192))
9739 (t (cons 0 0)))
9740 (cons 6 128))))
9741 (if (>= val 192) (setq eat (car shift-xor)))
9742 (setq val (logxor val (cdr shift-xor)))
9743 (setq sum (+ (lsh sum (car shift-xor)) val))
9744 (if (> eat 0) (setq eat (- eat 1)))
9745 (cond
9746 ((= 0 eat) ;multi byte
9747 (setq ret (concat ret (org-char-to-string sum)))
9748 (setq sum 0))
9749 ((not bytes) ; single byte(s)
9750 (setq ret (org-link-unescape-single-byte-sequence hex))))
9751 )) ;; end (while bytes
9752 ret )))
9754 (defun org-link-unescape-single-byte-sequence (hex)
9755 "Unhexify hex-encoded single byte character sequences."
9756 (mapconcat (lambda (byte)
9757 (char-to-string (string-to-number byte 16)))
9758 (cdr (split-string hex "%")) ""))
9760 (defun org-xor (a b)
9761 "Exclusive or."
9762 (if a (not b) b))
9764 (defun org-fixup-message-id-for-http (s)
9765 "Replace special characters in a message id, so it can be used in an http query."
9766 (when (string-match "%" s)
9767 (setq s (mapconcat (lambda (c)
9768 (if (eq c ?%)
9769 "%25"
9770 (char-to-string c)))
9771 s "")))
9772 (while (string-match "<" s)
9773 (setq s (replace-match "%3C" t t s)))
9774 (while (string-match ">" s)
9775 (setq s (replace-match "%3E" t t s)))
9776 (while (string-match "@" s)
9777 (setq s (replace-match "%40" t t s)))
9778 s)
9780 (defun org-link-prettify (link)
9781 "Return a human-readable representation of LINK.
9782 The car of LINK must be a raw link the cdr of LINK must be either
9783 a link description or nil."
9784 (let ((desc (or (cadr link) "<no description>")))
9785 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9786 "<" (car link) ">")))
9788 ;;;###autoload
9789 (defun org-insert-link-global ()
9790 "Insert a link like Org-mode does.
9791 This command can be called in any mode to insert a link in Org-mode syntax."
9792 (interactive)
9793 (org-load-modules-maybe)
9794 (org-run-like-in-org-mode 'org-insert-link))
9796 (defun org-insert-all-links (&optional keep)
9797 "Insert all links in `org-stored-links'."
9798 (interactive "P")
9799 (let ((links (copy-sequence org-stored-links)) l)
9800 (while (setq l (if keep (pop links) (pop org-stored-links)))
9801 (insert "- ")
9802 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9805 (defun org-link-fontify-links-to-this-file ()
9806 "Fontify links to the current file in `org-stored-links'."
9807 (let ((f (buffer-file-name)) a b)
9808 (setq a (mapcar (lambda(l)
9809 (let ((ll (car l)))
9811 (equal f (expand-file-name (match-string 1 ll))))
9812 ll)))
9813 org-stored-links))
9814 (when (featurep 'org-id)
9815 (setq b (mapcar (lambda(l)
9816 (let ((ll (car l)))
9818 (equal f (expand-file-name
9819 (or (org-id-find-id-file
9820 (match-string 1 ll)) ""))))
9821 ll)))
9822 org-stored-links)))
9823 (mapcar (lambda(l)
9824 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9825 (delq nil (append a b)))))
9827 (defvar org-link-links-in-this-file nil)
9828 (defun org-insert-link (&optional complete-file link-location default-description)
9829 "Insert a link. At the prompt, enter the link.
9831 Completion can be used to insert any of the link protocol prefixes like
9832 http or ftp in use.
9834 The history can be used to select a link previously stored with
9835 `org-store-link'. When the empty string is entered (i.e. if you just
9836 press RET at the prompt), the link defaults to the most recently
9837 stored link. As SPC triggers completion in the minibuffer, you need to
9838 use M-SPC or C-q SPC to force the insertion of a space character.
9840 You will also be prompted for a description, and if one is given, it will
9841 be displayed in the buffer instead of the link.
9843 If there is already a link at point, this command will allow you to edit link
9844 and description parts.
9847 be selected using completion. The path to the file will be relative to the
9848 current directory if the file is in the current directory or a subdirectory.
9849 Otherwise, the link will be the absolute path as completed in the minibuffer
9850 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9851 option `org-link-file-path-type'.
9854 the current directory or below.
9857 `org-keep-stored-link-after-insertion'.
9859 If `org-make-link-description-function' is non-nil, this function will be
9860 called with the link target, and the result will be the default
9861 link description.
9863 If the LINK-LOCATION parameter is non-nil, this value will be
9864 used as the link location instead of reading one interactively.
9866 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9867 be used as the default description."
9868 (interactive "P")
9869 (let* ((wcf (current-window-configuration))
9870 (origbuf (current-buffer))
9871 (region (if (org-region-active-p)
9872 (buffer-substring (region-beginning) (region-end))))
9873 (remove (and region (list (region-beginning) (region-end))))
9874 (desc region)
9875 tmphist ; byte-compile incorrectly complains about this
9876 (link link-location)
9877 (abbrevs org-link-abbrev-alist-local)
9878 entry file all-prefixes auto-desc)
9879 (cond
9880 (link-location) ; specified by arg, just use it.
9881 ((org-in-regexp org-bracket-link-regexp 1)
9882 ;; We do have a link at point, and we are going to edit it.
9883 (setq remove (list (match-beginning 0) (match-end 0)))
9884 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9885 (setq link (read-string "Link: "
9886 (org-link-unescape
9887 (org-match-string-no-properties 1)))))
9888 ((or (org-in-regexp org-angle-link-re)
9889 (org-in-regexp org-plain-link-re))
9890 ;; Convert to bracket link
9891 (setq remove (list (match-beginning 0) (match-end 0))
9892 link (read-string "Link: "
9893 (org-remove-angle-brackets (match-string 0)))))
9894 ((member complete-file '((4) (16)))
9895 ;; Completing read for file names.
9896 (setq link (org-file-complete-link complete-file)))
9897 (t
9898 ;; Read link, with completion for stored links.
9899 (org-link-fontify-links-to-this-file)
9900 (org-switch-to-buffer-other-window "*Org Links*")
9901 (with-current-buffer "*Org Links*"
9902 (erase-buffer)
9903 (insert "Insert a link.
9905 (when org-stored-links
9907 (insert (mapconcat 'org-link-prettify
9909 (goto-char (point-min)))
9910 (let ((cw (selected-window)))
9911 (select-window (get-buffer-window "*Org Links*" 'visible))
9912 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9913 (unless (pos-visible-in-window-p (point-max))
9914 (org-fit-window-to-buffer))
9915 (and (window-live-p cw) (select-window cw)))
9916 ;; Fake a link history, containing the stored links.
9917 (setq tmphist (append (mapcar 'car org-stored-links)
9918 org-insert-link-history))
9919 (setq all-prefixes (append (mapcar 'car abbrevs)
9920 (mapcar 'car org-link-abbrev-alist)
9921 org-link-types))
9922 (unwind-protect
9923 (progn
9924 (setq link
9925 (org-completing-read
9926 "Link: "
9927 (append
9928 (mapcar (lambda (x) (concat x ":"))
9929 all-prefixes)
9930 (mapcar 'car org-stored-links))
9931 nil nil nil
9932 'tmphist
9933 (caar org-stored-links)))
9935 (error "No link selected"))
9936 (mapc (lambda(l)
9937 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9938 org-stored-links)
9939 (if (or (member link all-prefixes)
9940 (and (equal ":" (substring link -1))
9941 (member (substring link 0 -1) all-prefixes)
9942 (setq link (substring link 0 -1))))
9943 (setq link (with-current-buffer origbuf
9944 (org-link-try-special-completion link)))))
9945 (set-window-configuration wcf)
9946 (kill-buffer "*Org Links*"))
9947 (setq entry (assoc link org-stored-links))
9948 (or entry (push link org-insert-link-history))
9949 (setq desc (or desc (nth 1 entry)))))
9951 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9952 (not org-keep-stored-link-after-insertion))
9953 (setq org-stored-links (delq (assoc link org-stored-links)
9954 org-stored-links)))
9956 (if (string-match org-plain-link-re link)
9957 ;; URL-like link, normalize the use of angular brackets.
9958 (setq link (org-remove-angle-brackets link)))
9960 ;; Check if we are linking to the current file with a search
9961 ;; option If yes, simplify the link by using only the search
9962 ;; option.
9963 (when (and buffer-file-name
9965 (let* ((path (match-string 1 link))
9966 (case-fold-search nil)
9967 (search (match-string 2 link)))
9968 (save-match-data
9969 (if (equal (file-truename buffer-file-name) (file-truename path))
9970 ;; We are linking to this same file, with a search option
9971 (setq link search)))))
9973 ;; Check if we can/should use a relative path. If yes, simplify the link
9975 (let* ((type (match-string 1 link))
9976 (path (match-string 2 link))
9977 (origpath path)
9978 (case-fold-search nil))
9979 (cond
9980 ((or (eq org-link-file-path-type 'absolute)
9981 (equal complete-file '(16)))
9982 (setq path (abbreviate-file-name (expand-file-name path))))
9983 ((eq org-link-file-path-type 'noabbrev)
9984 (setq path (expand-file-name path)))
9985 ((eq org-link-file-path-type 'relative)
9986 (setq path (file-relative-name path)))
9987 (t
9988 (save-match-data
9989 (if (string-match (concat "^" (regexp-quote
9990 (expand-file-name
9991 (file-name-as-directory
9992 default-directory))))
9993 (expand-file-name path))
9994 ;; We are linking a file with relative path name.
9995 (setq path (substring (expand-file-name path)
9996 (match-end 0)))
9997 (setq path (abbreviate-file-name (expand-file-name path)))))))
9998 (setq link (concat type path))
9999 (if (equal desc origpath)
10000 (setq desc path))))
10002 (if org-make-link-description-function
10003 (setq desc
10004 (or (condition-case nil
10005 (funcall org-make-link-description-function link desc)
10006 (error (progn (message "Can't get link description from `%s'"
10007 (symbol-name org-make-link-description-function))
10008 (sit-for 2) nil)))
10009 (read-string "Description: " default-description)))
10010 (if default-description (setq desc default-description)
10011 (setq desc (or (and auto-desc desc)
10012 (read-string "Description: " desc)))))
10015 (if remove (apply 'delete-region remove))
10016 (insert (org-make-link-string link desc))))
10018 (defun org-link-try-special-completion (type)
10019 "If there is completion support for link type TYPE, offer it."
10020 (let ((fun (intern (concat "org-" type "-complete-link"))))
10021 (if (functionp fun)
10022 (funcall fun)
10023 (read-string "Link (no completion support): " (concat type ":")))))
10025 (defun org-file-complete-link (&optional arg)
10026 "Create a file link using completion."
10027 (let (file link)
10028 (setq file (org-iread-file-name "File: "))
10029 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10030 (pwd1 (file-name-as-directory (abbreviate-file-name
10031 (expand-file-name ".")))))
10032 (cond
10033 ((equal arg '(16))
10034 (setq link (concat
10035 "file:"
10036 (abbreviate-file-name (expand-file-name file)))))
10038 (setq link (concat "file:" (match-string 1 file))))
10040 (expand-file-name file))
10041 (setq link (concat
10042 "file:" (match-string 1 (expand-file-name file)))))
10043 (t (setq link (concat "file:" file)))))
10044 link))
10046 (defun org-iread-file-name (&rest args)
10047 "Read-file-name using `ido-mode' speedup if available.
10048 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10049 See `read-file-name' for a description of parameters."
10050 (org-without-partial-completion
10051 (if (and org-completion-use-ido
10052 (fboundp 'ido-read-file-name)
10053 (boundp 'ido-mode) ido-mode
10054 (listp (second args)))
10055 (let ((ido-enter-matching-directory nil))
10056 (apply 'ido-read-file-name args))
10057 (apply 'read-file-name args))))
10059 (defun org-completing-read (&rest args)
10060 "Completing-read with SPACE being a normal character."
10061 (let ((enable-recursive-minibuffers t)
10062 (minibuffer-local-completion-map
10063 (copy-keymap minibuffer-local-completion-map)))
10064 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10065 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10066 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10067 (apply 'org-icompleting-read args)))
10069 (defun org-completing-read-no-i (&rest args)
10070 (let (org-completion-use-ido org-completion-use-iswitchb)
10071 (apply 'org-completing-read args)))
10073 (defun org-iswitchb-completing-read (prompt choices &rest args)
10074 "Use iswitch as a completing-read replacement to choose from choices.
10075 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10076 from."
10077 (let* ((iswitchb-use-virtual-buffers nil)
10078 (iswitchb-make-buflist-hook
10079 (lambda ()
10080 (setq iswitchb-temp-buflist choices))))
10081 (iswitchb-read-buffer prompt)))
10083 (defun org-icompleting-read (&rest args)
10084 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10085 (org-without-partial-completion
10086 (if (and org-completion-use-ido
10087 (fboundp 'ido-completing-read)
10088 (boundp 'ido-mode) ido-mode
10089 (listp (second args)))
10090 (let ((ido-enter-matching-directory nil))
10091 (apply 'ido-completing-read (concat (car args))
10092 (if (consp (car (nth 1 args)))
10093 (mapcar 'car (nth 1 args))
10094 (nth 1 args))
10095 (cddr args)))
10096 (if (and org-completion-use-iswitchb
10097 (boundp 'iswitchb-mode) iswitchb-mode
10098 (listp (second args)))
10099 (apply 'org-iswitchb-completing-read (concat (car args))
10100 (if (consp (car (nth 1 args)))
10101 (mapcar 'car (nth 1 args))
10102 (nth 1 args))
10103 (cddr args))
10104 (apply 'completing-read args)))))
10106 (defun org-extract-attributes (s)
10107 "Extract the attributes cookie from a string and set as text property."
10108 (let (a attr (start 0) key value)
10109 (save-match-data
10111 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10113 (setq key (match-string 1 a) value (match-string 2 a)
10114 start (match-end 0)
10115 attr (plist-put attr (intern key) value))))
10116 (org-add-props s nil 'org-attr attr))
10117 s))
10119 ;;; Opening/following a link
10121 (defvar org-link-search-failed nil)
10123 (defvar org-open-link-functions nil
10124 "Hook for functions finding a plain text link.
10125 These functions must take a single argument, the link content.
10126 They will be called for links that look like [[link text][description]]
10130 These functions will be called *before* Org attempts to resolve the
10131 link by doing text searches in the current buffer - so if you want a
10133 handle this as a special case.
10135 When the function does handle the link, it must return a non-nil value.
10136 If it decides that it is not responsible for this link, it must return
10137 nil to indicate that that Org-mode can continue with other options
10138 like exact and fuzzy text search.")
10140 (defun org-next-link (&optional search-backward)
10141 "Move forward to the next link.
10142 If the link is in hidden text, expose it."
10143 (interactive "P")
10144 (when (and org-link-search-failed (eq this-command last-command))
10145 (goto-char (point-min))
10146 (message "Link search wrapped back to beginning of buffer"))
10147 (setq org-link-search-failed nil)
10148 (let* ((pos (point))
10149 (ct (org-context))
10150 (a (assoc :link ct))
10151 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10152 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10153 ((looking-at org-any-link-re)
10154 ;; Don't stay stuck at link without an org-link face
10155 (forward-char (if search-backward -1 1))))
10156 (if (funcall srch-fun org-any-link-re nil t)
10157 (progn
10158 (goto-char (match-beginning 0))
10159 (if (outline-invisible-p) (org-show-context)))
10160 (goto-char pos)
10161 (setq org-link-search-failed t)
10162 (message "No further link found"))))
10164 (defun org-previous-link ()
10165 "Move backward to the previous link.
10166 If the link is in hidden text, expose it."
10167 (interactive)
10168 (funcall 'org-next-link t))
10170 (defun org-translate-link (s)
10171 "Translate a link string if a translation function has been defined."
10172 (if (and org-link-translation-function
10173 (fboundp org-link-translation-function)
10175 (progn
10176 (setq s (funcall org-link-translation-function
10177 (match-string 1 s) (match-string 2 s)))
10178 (concat (car s) ":" (cdr s)))
10179 s))
10181 (defun org-translate-link-from-planner (type path)
10182 "Translate a link from Emacs Planner syntax so that Org can follow it.
10183 This is still an experimental function, your mileage may vary."
10184 (cond
10185 ((member type '("http" "https" "news" "ftp"))
10186 ;; standard Internet links are the same.
10187 nil)
10188 ((and (equal type "irc") (string-match "^//" path))
10189 ;; Planner has two / at the beginning of an irc link, we have 1.
10190 ;; We should have zero, actually....
10191 (setq path (substring path 1)))
10192 ((and (equal type "lisp") (string-match "^/" path))
10193 ;; Planner has a slash, we do not.
10194 (setq type "elisp" path (substring path 1)))
10196 ;; A typical message link. Planner has the id after the final slash,
10197 ;; we separate it with a hash mark
10198 (setq path (concat (match-string 1 path) "#"
10199 (org-remove-angle-brackets (match-string 2 path))))))
10200 (cons type path))
10202 (defun org-find-file-at-mouse (ev)
10203 "Open file link or URL at mouse."
10204 (interactive "e")
10205 (mouse-set-point ev)
10206 (org-open-at-point 'in-emacs))
10208 (defun org-open-at-mouse (ev)
10209 "Open file link or URL at mouse.
10210 See the docstring of `org-open-file' for details."
10211 (interactive "e")
10212 (mouse-set-point ev)
10213 (if (eq major-mode 'org-agenda-mode)
10214 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10215 (org-open-at-point))
10217 (defvar org-window-config-before-follow-link nil
10218 "The window configuration before following a link.
10219 This is saved in case the need arises to restore it.")
10221 (defvar org-open-link-marker (make-marker)
10222 "Marker pointing to the location where `org-open-at-point; was called.")
10224 ;;;###autoload
10225 (defun org-open-at-point-global ()
10226 "Follow a link like Org-mode does.
10227 This command can be called in any mode to follow a link that has
10228 Org-mode syntax."
10229 (interactive)
10230 (org-run-like-in-org-mode 'org-open-at-point))
10232 ;;;###autoload
10233 (defun org-open-link-from-string (s &optional arg reference-buffer)
10234 "Open a link in the string S, as if it was in Org-mode."
10236 (let ((reference-buffer (or reference-buffer (current-buffer))))
10237 (with-temp-buffer
10238 (let ((org-inhibit-startup (not reference-buffer)))
10239 (org-mode)
10240 (insert s)
10241 (goto-char (point-min))
10242 (when reference-buffer
10243 (setq org-link-abbrev-alist-local
10244 (with-current-buffer reference-buffer
10245 org-link-abbrev-alist-local)))
10246 (org-open-at-point arg reference-buffer)))))
10248 (defvar org-open-at-point-functions nil
10249 "Hook that is run when following a link at point.
10251 Functions in this hook must return t if they identify and follow
10252 a link at point. If they don't find anything interesting at point,
10253 they must return nil.")
10255 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10256 (defun org-open-at-point (&optional arg reference-buffer)
10257 "Open link at or after point.
10258 If there is no link at point, this function will search forward up to
10259 the end of the current line.
10260 Normally, files will be opened by an appropriate application. If the
10261 optional prefix argument ARG is non-nil, Emacs will visit the file.
10262 With a double prefix argument, try to open outside of Emacs, in the
10263 application the system uses for this file type."
10264 (interactive "P")
10265 ;; if in a code block, then open the block's results
10266 (unless (call-interactively #'org-babel-open-src-block-result)
10267 (org-load-modules-maybe)
10268 (move-marker org-open-link-marker (point))
10269 (setq org-window-config-before-follow-link (current-window-configuration))
10270 (org-remove-occur-highlights nil nil t)
10271 (cond
10272 ((and (org-at-heading-p)
10273 (not (org-at-timestamp-p t))
10274 (not (org-in-regexp
10279 (not (get-text-property (point) 'org-linked-text)))
10280 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10281 (lk0 (car lkall))
10282 (lk (if (stringp lk0) (list lk0) lk0))
10283 (lkend (cdr lkall)))
10284 (mapcar (lambda(l)
10285 (search-forward l nil lkend)
10286 (goto-char (match-beginning 0))
10287 (org-open-at-point))
10288 lk))
10289 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10290 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10291 ((and (org-at-timestamp-p t)
10292 (not (org-in-regexp org-bracket-link-regexp)))
10293 (org-follow-timestamp-link))
10294 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10295 (not (org-in-regexp org-any-link-re)))
10296 (org-footnote-action))
10297 (t
10298 (let (type path link line search (pos (point)))
10299 (catch 'match
10300 (save-excursion
10302 (when (org-in-regexp org-bracket-link-regexp 1)
10303 (setq link (org-extract-attributes
10304 (org-link-unescape (org-match-string-no-properties 1))))
10306 (setq link (replace-match " " t t link)))
10307 (setq link (org-link-expand-abbrev link))
10308 (cond
10309 ((or (file-name-absolute-p link)
10311 (setq type "file" path link))
10312 ((string-match org-link-re-with-space3 link)
10313 (setq type (match-string 1 link) path (match-string 2 link)))
10315 (setq type "help" path (match-string 1 link)))
10316 (t (setq type "thisfile" path link)))
10317 (throw 'match t)))
10319 (when (get-text-property (point) 'org-linked-text)
10320 (setq type "thisfile"
10321 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10322 (1+ (point)) (point))
10323 path (buffer-substring
10324 (or (previous-single-property-change pos 'org-linked-text)
10325 (point-min))
10326 (or (next-single-property-change pos 'org-linked-text)
10327 (point-max))))
10328 (throw 'match t))
10330 (save-excursion
10331 (when (or (org-in-regexp org-angle-link-re)
10332 (let ((match (org-in-regexp org-plain-link-re)))
10333 ;; Check a plain link is not within a bracket link
10334 (and match
10335 (save-excursion
10336 (progn
10337 (goto-char (car match))
10338 (not (org-in-regexp org-bracket-link-regexp))))))
10339 (let ((line_ending (save-excursion (end-of-line) (point))))
10340 ;; We are in a line before a plain or bracket link
10341 (or (re-search-forward org-plain-link-re line_ending t)
10342 (re-search-forward org-bracket-link-regexp line_ending t))))
10343 (setq type (match-string 1)
10344 path (org-link-unescape (match-string 2)))
10345 (throw 'match t)))
10346 (save-excursion
10348 (setq type "tags"
10349 path (match-string 1))
10350 (while (string-match ":" path)
10351 (setq path (replace-match "+" t t path)))
10352 (throw 'match t)))
10354 (setq type "tree-match"
10355 path (match-string 1))
10356 (throw 'match t)))
10357 (unless path
10358 (user-error "No link found"))
10360 ;; switch back to reference buffer
10361 ;; needed when if called in a temporary buffer through
10362 ;; org-open-link-from-string
10363 (with-current-buffer (or reference-buffer (current-buffer))
10365 ;; Remove any trailing spaces in path
10367 (setq path (replace-match "" t t path)))
10368 (if (and org-link-translation-function
10369 (fboundp org-link-translation-function))
10370 ;; Check if we need to translate the link
10371 (let ((tmp (funcall org-link-translation-function type path)))
10372 (setq type (car tmp) path (cdr tmp))))
10374 (cond
10376 ((assoc type org-link-protocols)
10377 (funcall (nth 1 (assoc type org-link-protocols)) path))
10379 ((equal type "help")
10380 (let ((f-or-v (intern path)))
10381 (cond ((fboundp f-or-v)
10382 (describe-function f-or-v))
10383 ((boundp f-or-v)
10384 (describe-variable f-or-v))
10385 (t (error "Not a known function or variable")))))
10387 ((equal type "mailto")
10388 (let ((cmd (car org-link-mailto-program))
10389 (args (cdr org-link-mailto-program)) args1
10390 (address path) (subject "") a)
10392 (setq address (match-string 1 path)
10393 subject (org-link-escape (match-string 2 path))))
10394 (while args
10395 (cond
10396 ((not (stringp (car args))) (push (pop args) args1))
10397 (t (setq a (pop args))
10398 (if (string-match "%a" a)
10399 (setq a (replace-match address t t a)))
10400 (if (string-match "%s" a)
10401 (setq a (replace-match subject t t a)))
10402 (push a args1))))
10403 (apply cmd (nreverse args1))))
10405 ((member type '("http" "https" "ftp" "news"))
10406 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
10407 (org-link-escape
10408 path org-link-escape-chars-browser)
10409 path))))
10411 ((string= type "doi")
10412 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
10413 (org-link-escape
10414 path org-link-escape-chars-browser)
10415 path))))
10417 ((member type '("message"))
10418 (browse-url (concat type ":" path)))
10420 ((string= type "tags")
10421 (org-tags-view arg path))
10423 ((string= type "tree-match")
10426 ((string= type "file")
10428 (setq line (string-to-number (match-string 1 path))
10429 path (substring path 0 (match-beginning 0)))
10431 (setq search (match-string 1 path)
10432 path (substring path 0 (match-beginning 0)))))
10433 (if (string-match "[*?{]" (file-name-nondirectory path))
10434 (dired path)
10435 (org-open-file path arg line search)))
10437 ((string= type "shell")
10438 (let ((buf (generate-new-buffer "*Org Shell Output"))
10439 (cmd path))
10440 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10441 (string-match org-confirm-shell-link-not-regexp cmd))
10442 (not org-confirm-shell-link-function)
10443 (funcall org-confirm-shell-link-function
10445 (org-add-props cmd nil
10446 'face 'org-warning))))
10447 (progn
10448 (message "Executing %s" cmd)
10449 (shell-command cmd buf)
10450 (if (featurep 'midnight)
10451 (setq clean-buffer-list-kill-buffer-names
10452 (cons buf clean-buffer-list-kill-buffer-names))))
10453 (error "Abort"))))
10455 ((string= type "elisp")
10456 (let ((cmd path))
10457 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10458 (string-match org-confirm-elisp-link-not-regexp cmd))
10459 (not org-confirm-elisp-link-function)
10460 (funcall org-confirm-elisp-link-function
10462 (org-add-props cmd nil
10463 'face 'org-warning))))
10464 (message "%s => %s" cmd
10465 (if (equal (string-to-char cmd) ?\()
10466 (eval (read cmd))
10467 (call-interactively (read cmd))))
10468 (error "Abort"))))
10470 ((and (string= type "thisfile")
10471 (run-hook-with-args-until-success
10472 'org-open-link-functions path)))
10474 ((string= type "thisfile")
10475 (if arg
10476 (switch-to-buffer-other-window
10477 (org-get-buffer-for-internal-link (current-buffer)))
10478 (org-mark-ring-push))
10479 (let ((cmd `(org-link-search
10480 ,path
10481 ,(cond ((equal arg '(4)) ''occur)
10482 ((equal arg '(16)) ''org-occur))
10483 ,pos)))
10484 (condition-case nil (let ((org-link-search-inhibit-query t))
10485 (eval cmd))
10486 (error (progn (widen) (eval cmd))))))
10488 (t (browse-url-at-point)))))))
10489 (move-marker org-open-link-marker nil)
10490 (run-hook-with-args 'org-follow-link-hook)))
10492 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10493 "Offer links in the current entry and return the selected link.
10494 If there is only one link, return it.
10495 If NTH is an integer, return the NTH link found.
10496 If ZERO is a string, check also this string for a link, and if
10497 there is one, return it."
10498 (with-current-buffer buffer
10499 (save-excursion
10500 (save-restriction
10501 (widen)
10502 (goto-char marker)
10506 (cnt ?0)
10507 (in-emacs (if (integerp nth) nil nth))
10508 have-zero end links link c)
10509 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10510 (push (match-string 0 zero) links)
10511 (setq cnt (1- cnt) have-zero t))
10512 (save-excursion
10513 (org-back-to-heading t)
10514 (setq end (save-excursion (outline-next-heading) (point)))
10515 (while (re-search-forward re end t)
10516 (push (match-string 0) links))
10517 (setq links (org-uniquify (reverse links))))
10518 (cond
10519 ((null links)
10520 (message "No links"))
10521 ((equal (length links) 1)
10522 (setq link (car links)))
10523 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10524 (setq link (nth (if have-zero nth (1- nth)) links)))
10525 (t ; we have to select a link
10526 (save-excursion
10527 (save-window-excursion
10528 (delete-other-windows)
10529 (with-output-to-temp-buffer "*Select Link*"
10530 (mapc (lambda (l)
10531 (if (not (string-match org-bracket-link-regexp l))
10533 (org-remove-angle-brackets l)))
10534 (if (match-end 3)
10536 (match-string 3 l) (match-string 1 l)))
10538 (match-string 1 l))))))
10539 links))
10540 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10541 (message "Select link to open, RET to open all:")
10542 (setq c (read-char-exclusive))
10543 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10544 (when (equal c ?q) (error "Abort"))
10545 (if (equal c ?\C-m)
10546 (setq link links)
10547 (setq nth (- c ?0))
10548 (if have-zero (setq nth (1+ nth)))
10549 (unless (and (integerp nth) (>= (length links) nth))
10550 (error "Invalid link selection"))
10551 (setq link (nth (1- nth) links)))))
10552 (cons link end))))))
10554 ;; Add special file links that specify the way of opening
10556 (org-add-link-type "file+sys" 'org-open-file-with-system)
10557 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10558 (defun org-open-file-with-system (path)
10559 "Open file at PATH using the system way of opening it."
10560 (org-open-file path 'system))
10561 (defun org-open-file-with-emacs (path)
10562 "Open file at PATH in Emacs."
10563 (org-open-file path 'emacs))
10566 ;;; File search
10568 (defvar org-create-file-search-functions nil
10569 "List of functions to construct the right search string for a file link.
10570 These functions are called in turn with point at the location to
10571 which the link should point.
10573 A function in the hook should first test if it would like to
10574 handle this file type, for example by checking the `major-mode'
10575 or the file extension. If it decides not to handle this file, it
10576 should just return nil to give other functions a chance. If it
10577 does handle the file, it must return the search string to be used
10578 when following the link. The search string will be part of the
10579 file link, given after a double colon, and `org-open-at-point'
10580 will automatically search for it. If special measures must be
10581 taken to make the search successful, another function should be
10582 added to the companion hook `org-execute-file-search-functions',
10583 which see.
10585 A function in this hook may also use `setq' to set the variable
10586 `description' to provide a suggestion for the descriptive text to
10587 be used for this link when it gets inserted into an Org-mode
10590 (defvar org-execute-file-search-functions nil
10591 "List of functions to execute a file search triggered by a link.
10593 Functions added to this hook must accept a single argument, the
10594 search string that was part of the file link, the part after the
10595 double colon. The function must first check if it would like to
10596 handle this search, for example by checking the `major-mode' or
10597 the file extension. If it decides not to handle this search, it
10598 should just return nil to give other functions a chance. If it
10599 does handle the search, it must return a non-nil value to keep
10600 other functions from trying.
10602 Each function can access the current prefix argument through the
10603 variable `current-prefix-arg'. Note that a single prefix is used
10604 to force opening a link in Emacs, so it may be good to only use a
10605 numeric or double prefix to guide the search function.
10607 In case this is needed, a function in this hook can also restore
10608 the window configuration before `org-open-at-point' was called using:
10610 (set-window-configuration org-window-config-before-follow-link)")
10612 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10613 (defun org-link-search (s &optional type avoid-pos stealth)
10614 "Search for a link search option.
10615 If S is surrounded by forward slashes, it is interpreted as a
10616 regular expression. In org-mode files, this will create an `org-occur'
10617 sparse tree. In ordinary files, `occur' will be used to list matches.
10618 If the current buffer is in `dired-mode', grep will be used to search
10619 in all files. If AVOID-POS is given, ignore matches near that position.
10621 When optional argument STEALTH is non-nil, do not modify
10622 visibility around point, thus ignoring
10623 `org-show-hierarchy-above', `org-show-following-heading' and
10624 `org-show-siblings' variables."
10625 (let ((case-fold-search t)
10629 org-emphasis-alist)
10631 (pos (point))
10632 (pre nil) (post nil)
10633 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10634 (cond
10635 ;; First check if there are any special search functions
10636 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10637 ;; Now try the builtin stuff
10638 ((and (equal (string-to-char s0) ?#)
10639 (> (length s0) 1)
10640 (save-excursion
10641 (goto-char (point-min))
10642 (and
10643 (re-search-forward
10646 (setq type 'dedicated
10647 pos (match-beginning 0))))
10648 ;; There is an exact target for this
10649 (goto-char pos)
10650 (org-back-to-heading t)))
10651 ((save-excursion
10652 (goto-char (point-min))
10653 (and
10654 (re-search-forward
10655 (concat "<<" (regexp-quote s0) ">>") nil t)
10656 (setq type 'dedicated
10657 pos (match-beginning 0))))
10658 ;; There is an exact target for this
10659 (goto-char pos))
10660 ((save-excursion
10661 (goto-char (point-min))
10662 (and
10663 (re-search-forward
10665 (setq type 'dedicated pos (match-beginning 0))))
10666 ;; Found an element with a matching #+name affiliated keyword.
10667 (goto-char pos))
10669 (save-excursion
10670 (goto-char (point-min))
10671 (and
10672 (re-search-forward
10673 (concat "[^[]" (regexp-quote
10674 (format org-coderef-label-format
10675 (match-string 1 s0))))
10676 nil t)
10677 (setq type 'dedicated
10678 pos (1+ (match-beginning 0))))))
10679 ;; There is a coderef target for this
10680 (goto-char pos))
10682 ;; A regular expression
10683 (cond
10684 ((derived-mode-p 'org-mode)
10685 (org-occur (match-string 1 s)))
10686 (t (org-do-occur (match-string 1 s)))))
10687 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10688 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10689 (goto-char (point-min))
10690 (cond
10691 ((let (case-fold-search)
10692 (re-search-forward (format org-complex-heading-regexp-format
10693 (regexp-quote s))
10694 nil t))
10695 ;; OK, found a match
10696 (setq type 'dedicated)
10697 (goto-char (match-beginning 0)))
10698 ((and (not org-link-search-inhibit-query)
10699 (eq org-link-search-must-match-exact-headline 'query-to-create)
10700 (y-or-n-p "No match - create this as a new heading? "))
10701 (goto-char (point-max))
10702 (or (bolp) (newline))
10704 (beginning-of-line 0))
10705 (t
10706 (goto-char pos)
10707 (error "No match"))))
10708 (t
10709 ;; A normal search string
10710 (when (equal (string-to-char s) ?*)
10711 ;; Anchor on headlines, post may include tags.
10714 s (substring s 1)))
10715 (remove-text-properties
10716 0 (length s)
10717 '(face nil mouse-face nil keymap nil fontified nil) s)
10718 ;; Make a series of regular expressions to find a match
10729 re4 (concat "[^a-zA-Z_]" re4_)
10731 re1 (concat pre re2 post)
10732 re3 (concat pre (if pre re4_ re4) post)
10733 re5 (concat pre ".*" re4)
10734 re2 (concat pre re2)
10735 re2a (concat pre (if pre re2a_ re2a))
10736 re4 (concat pre (if pre re4_ re4))
10740 (cond
10741 ((eq type 'org-occur) (org-occur reall))
10742 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10743 (t (goto-char (point-min))
10744 (setq type 'fuzzy)
10745 (if (or (and (org-search-not-self 1 re0 nil t)
10746 (setq type 'dedicated))
10747 (org-search-not-self 1 re1 nil t)
10748 (org-search-not-self 1 re2 nil t)
10749 (org-search-not-self 1 re2a nil t)
10750 (org-search-not-self 1 re3 nil t)
10751 (org-search-not-self 1 re4 nil t)
10752 (org-search-not-self 1 re5 nil t))
10753 (goto-char (match-beginning 1))
10754 (goto-char pos)
10755 (error "No match"))))))
10756 (and (derived-mode-p 'org-mode)
10757 (not stealth)
10758 (org-show-context 'link-search))
10759 type))
10761 (defun org-search-not-self (group &rest args)
10762 "Execute `re-search-forward', but only accept matches that do not
10763 enclose the position of `org-open-link-marker'."
10764 (let ((m org-open-link-marker))
10765 (catch 'exit
10766 (while (apply 're-search-forward args)
10767 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10768 (goto-char (match-end group))
10769 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10770 (> (match-beginning 0) (marker-position m))
10771 (< (match-end 0) (marker-position m)))
10772 (save-match-data
10773 (or (not (org-in-regexp
10774 org-bracket-link-analytic-regexp 1))
10775 (not (match-end 4)) ; no description
10776 (and (<= (match-beginning 4) (point))
10777 (>= (match-end 4) (point))))))
10778 (throw 'exit (point))))))))
10780 (defun org-get-buffer-for-internal-link (buffer)
10781 "Return a buffer to be used for displaying the link target of internal links."
10782 (cond
10783 ((not org-display-internal-link-with-indirect-buffer)
10784 buffer)
10785 ((string-match "(Clone)$" (buffer-name buffer))
10786 (message "Buffer is already a clone, not making another one")
10787 ;; we also do not modify visibility in this case
10788 buffer)
10789 (t ; make a new indirect buffer for displaying the link
10790 (let* ((bn (buffer-name buffer))
10791 (ibn (concat bn "(Clone)"))
10792 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10793 (with-current-buffer ib (org-overview))
10794 ib))))
10796 (defun org-do-occur (regexp &optional cleanup)
10797 "Call the Emacs command `occur'.
10798 If CLEANUP is non-nil, remove the printout of the regular expression
10799 in the *Occur* buffer. This is useful if the regex is long and not useful
10800 to read."
10801 (occur regexp)
10802 (when cleanup
10803 (let ((cwin (selected-window)) win beg end)
10804 (when (setq win (get-buffer-window "*Occur*"))
10805 (select-window win))
10806 (goto-char (point-min))
10807 (when (re-search-forward "match[a-z]+" nil t)
10808 (setq beg (match-end 0))
10810 (setq end (1- (match-beginning 0)))))
10811 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10812 (goto-char (point-min))
10813 (select-window cwin))))
10815 ;;; The mark ring for links jumps
10817 (defvar org-mark-ring nil
10818 "Mark ring for positions before jumps in Org-mode.")
10819 (defvar org-mark-ring-last-goto nil
10820 "Last position in the mark ring used to go back.")
10821 ;; Fill and close the ring
10822 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10823 (loop for i from 1 to org-mark-ring-length do
10824 (push (make-marker) org-mark-ring))
10825 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10826 org-mark-ring)
10828 (defun org-mark-ring-push (&optional pos buffer)
10829 "Put the current position or POS into the mark ring and rotate it."
10830 (interactive)
10831 (setq pos (or pos (point)))
10832 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10833 (move-marker (car org-mark-ring)
10834 (or pos (point))
10835 (or buffer (current-buffer)))
10836 (message "%s"
10837 (substitute-command-keys
10840 (defun org-mark-ring-goto (&optional n)
10841 "Jump to the previous position in the mark ring.
10842 With prefix arg N, jump back that many stored positions. When
10843 called several times in succession, walk through the entire ring.
10844 Org-mode commands jumping to a different position in the current file,
10845 or to another Org-mode file, automatically push the old position
10846 onto the ring."
10847 (interactive "p")
10848 (let (p m)
10849 (if (eq last-command this-command)
10850 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10851 (setq p org-mark-ring))
10852 (setq org-mark-ring-last-goto p)
10853 (setq m (car p))
10854 (org-pop-to-buffer-same-window (marker-buffer m))
10855 (goto-char m)
10856 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10858 (defun org-remove-angle-brackets (s)
10859 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10860 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10861 s)
10862 (defun org-add-angle-brackets (s)
10863 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10864 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10865 s)
10866 (defun org-remove-double-quotes (s)
10869 s)
10871 ;;; Following specific links
10873 (defun org-follow-timestamp-link ()
10874 "Open an agenda view for the time-stamp date/range at point."
10875 (cond
10876 ((org-at-date-range-p t)
10877 (let ((org-agenda-start-on-weekday)
10878 (t1 (match-string 1))
10879 (t2 (match-string 2)) tt1 tt2)
10880 (setq tt1 (time-to-days (org-time-string-to-time t1))
10881 tt2 (time-to-days (org-time-string-to-time t2)))
10882 (let ((org-agenda-buffer-tmp-name
10883 (format "*Org Agenda(a:%s)"
10884 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10885 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10886 ((org-at-timestamp-p t)
10887 (let ((org-agenda-buffer-tmp-name
10888 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10889 (org-agenda-list nil (time-to-days (org-time-string-to-time
10890 (substring (match-string 1) 0 10)))
10891 1)))
10892 (t (error "This should not happen"))))
10895 ;;; Following file links
10896 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10897 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10898 (declare-function mailcap-mime-info
10899 "mailcap" (string &optional request no-decode))
10900 (defvar org-wait nil)
10901 (defun org-open-file (path &optional in-emacs line search)
10902 "Open the file at PATH.
10903 First, this expands any special file name abbreviations. Then the
10904 configuration variable `org-file-apps' is checked if it contains an
10905 entry for this file type, and if yes, the corresponding command is launched.
10907 If no application is found, Emacs simply visits the file.
10909 With optional prefix argument IN-EMACS, Emacs will visit the file.
10911 prefix arg, Org tries to avoid opening in Emacs
10912 and to use an external application to visit the file.
10914 Optional LINE specifies a line to go to, optional SEARCH a string
10915 to search for. If LINE or SEARCH is given, the file will be
10916 opened in Emacs, unless an entry from org-file-apps that makes
10917 use of groups in a regexp matches.
10919 If you want to change the way frames are used when following a
10920 link, please customize `org-link-frame-setup'.
10922 If the file does not exist, an error is thrown."
10923 (let* ((file (if (equal path "")
10924 buffer-file-name
10925 (substitute-in-file-name (expand-file-name path))))
10926 (file-apps (append org-file-apps (org-default-apps)))
10927 (apps (org-remove-if
10928 'org-file-apps-entry-match-against-dlink-p file-apps))
10929 (apps-dlink (org-remove-if-not
10930 'org-file-apps-entry-match-against-dlink-p file-apps))
10931 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10932 (dirp (if remp nil (file-directory-p file)))
10933 (file (if (and dirp org-open-directory-means-index-dot-org)
10934 (concat (file-name-as-directory file) "index.org")
10935 file))
10936 (a-m-a-p (assq 'auto-mode apps))
10937 (dfile (downcase file))
10938 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10939 (link (cond ((and (eq line nil)
10940 (eq search nil))
10941 file)
10942 (line
10943 (concat file "::" (number-to-string line)))
10944 (search
10945 (concat file "::" search))))
10946 (dlink (downcase link))
10947 (old-buffer (current-buffer))
10948 (old-pos (point))
10949 (old-mode major-mode)
10950 ext cmd link-match-data)
10952 (setq ext (match-string 1 dfile))
10954 (setq ext (match-string 1 dfile))))
10955 (cond
10956 ((member in-emacs '((16) system))
10957 (setq cmd (cdr (assoc 'system apps))))
10958 (in-emacs (setq cmd 'emacs))
10959 (t
10960 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10961 (and dirp (cdr (assoc 'directory apps)))
10962 ; first, try matching against apps-dlink
10963 ; if we get a match here, store the match data for later
10964 (let ((match (assoc-default dlink apps-dlink
10965 'string-match)))
10966 (if match
10967 (progn (setq link-match-data (match-data))
10968 match)
10969 (progn (setq in-emacs (or in-emacs line search))
10970 nil))) ; if we have no match in apps-dlink,
10971 ; always open the file in emacs if line or search
10972 ; is given (for backwards compatibility)
10973 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10974 'string-match)
10975 (cdr (assoc ext apps))
10976 (cdr (assoc t apps))))))
10977 (when (eq cmd 'system)
10978 (setq cmd (cdr (assoc 'system apps))))
10979 (when (eq cmd 'default)
10980 (setq cmd (cdr (assoc t apps))))
10981 (when (eq cmd 'mailcap)
10982 (require 'mailcap)
10983 (mailcap-parse-mailcaps)
10984 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10985 (command (mailcap-mime-info mime-type)))
10986 (if (stringp command)
10987 (setq cmd command)
10988 (setq cmd 'emacs))))
10989 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10990 (not (file-exists-p file))
10991 (not org-open-non-existing-files))
10992 (error "No such file: %s" file))
10993 (cond
10995 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10997 (setq cmd (replace-match "%s" t t cmd)))
10998 (while (string-match "%s" cmd)
10999 (setq cmd (replace-match
11000 (save-match-data
11001 (shell-quote-argument
11002 (convert-standard-filename file)))
11003 t t cmd)))
11005 ;; Replace "%1", "%2" etc. in command with group matches from regex
11006 (save-match-data
11007 (let ((match-index 1)
11008 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11009 (set-match-data link-match-data)
11010 (while (<= match-index number-of-groups)
11011 (let ((regex (concat "%" (number-to-string match-index)))
11012 (replace-with (match-string match-index dlink)))
11013 (while (string-match regex cmd)
11014 (setq cmd (replace-match replace-with t t cmd))))
11015 (setq match-index (+ match-index 1)))))
11017 (save-window-excursion
11018 (message "Running %s...done" cmd)
11019 (start-process-shell-command cmd nil cmd)
11020 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11021 ((or (stringp cmd)
11022 (eq cmd 'emacs))
11023 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11024 (widen)
11025 (if line (org-goto-line line)
11026 (if search (org-link-search search))))
11027 ((consp cmd)
11028 (let ((file (convert-standard-filename file)))
11029 (save-match-data
11030 (set-match-data link-match-data)
11031 (eval cmd))))
11032 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11033 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11034 (or (not (equal old-buffer (current-buffer)))
11035 (not (equal old-pos (point))))
11036 (org-mark-ring-push old-pos old-buffer))))
11038 (defun org-file-apps-entry-match-against-dlink-p (entry)
11039 "This function returns non-nil if `entry' uses a regular
11040 expression which should be matched against the whole link by
11041 org-open-file.
11043 It assumes that is the case when the entry uses a regular
11044 expression which has at least one grouping construct and the
11045 action is either a lisp form or a command string containing
11046 '%1', i.e. using at least one subexpression match as a
11047 parameter."
11048 (let ((selector (car entry))
11049 (action (cdr entry)))
11050 (if (stringp selector)
11051 (and (> (regexp-opt-depth selector) 0)
11052 (or (and (stringp action)
11053 (string-match "%[0-9]" action))
11054 (consp action)))
11055 nil)))
11057 (defun org-default-apps ()
11058 "Return the default applications for this operating system."
11059 (cond
11060 ((eq system-type 'darwin)
11061 org-file-apps-defaults-macosx)
11062 ((eq system-type 'windows-nt)
11063 org-file-apps-defaults-windowsnt)
11064 (t org-file-apps-defaults-gnu)))
11066 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11067 "Convert extensions to regular expressions in the cars of LIST.
11068 Also, weed out any non-string entries, because the return value is used
11069 only for regexp matching.
11070 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11071 point to the symbol `emacs', indicating that the file should
11072 be opened in Emacs."
11073 (append
11074 (delq nil
11075 (mapcar (lambda (x)
11076 (if (not (stringp (car x)))
11077 nil
11079 x
11081 list))
11082 (if add-auto-mode
11083 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11085 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11086 (defun org-file-remote-p (file)
11087 "Test whether FILE specifies a location on a remote system.
11088 Return non-nil if the location is indeed remote.
11092 (cond ((fboundp 'file-remote-p)
11093 (file-remote-p file))
11094 ((fboundp 'tramp-handle-file-remote-p)
11095 (tramp-handle-file-remote-p file))
11096 ((and (boundp 'ange-ftp-name-format)
11097 (string-match (car ange-ftp-name-format) file))
11098 t)))
11101 ;;;; Refiling
11103 (defun org-get-org-file ()
11104 "Read a filename, with default directory `org-directory'."
11105 (let ((default (or org-default-notes-file remember-data-file)))
11106 (read-file-name (format "File name [%s]: " default)
11107 (file-name-as-directory org-directory)
11108 default)))
11110 (defun org-notes-order-reversed-p ()
11111 "Check if the current file should receive notes in reversed order."
11112 (cond
11113 ((not org-reverse-note-order) nil)
11114 ((eq t org-reverse-note-order) t)
11115 ((not (listp org-reverse-note-order)) nil)
11116 (t (catch 'exit
11117 (let ((all org-reverse-note-order)
11118 entry)
11119 (while (setq entry (pop all))
11120 (if (string-match (car entry) buffer-file-name)
11121 (throw 'exit (cdr entry))))
11122 nil)))))
11124 (defvar org-refile-target-table nil
11125 "The list of refile targets, created by `org-refile'.")
11127 (defvar org-agenda-new-buffers nil
11128 "Buffers created to visit agenda files.")
11130 (defvar org-refile-cache nil
11131 "Cache for refile targets.")
11133 (defvar org-refile-markers nil
11134 "All the markers used for caching refile locations.")
11136 (defun org-refile-marker (pos)
11137 "Get a new refile marker, but only if caching is in use."
11138 (if (not org-refile-use-cache)
11139 pos
11140 (let ((m (make-marker)))
11141 (move-marker m pos)
11142 (push m org-refile-markers)
11143 m)))
11145 (defun org-refile-cache-clear ()
11146 "Clear the refile cache and disable all the markers."
11147 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11148 (setq org-refile-markers nil)
11149 (setq org-refile-cache nil)
11150 (message "Refile cache has been cleared"))
11152 (defun org-refile-cache-check-set (set)
11153 "Check if all the markers in the cache still have live buffers."
11154 (let (marker)
11155 (catch 'exit
11156 (while (and set (setq marker (nth 3 (pop set))))
11157 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11158 (when (and marker (null (marker-buffer marker)))
11159 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11160 (sit-for 3)
11161 (throw 'exit nil)))
11162 t)))
11164 (defun org-refile-cache-put (set &rest identifiers)
11165 "Push the refile targets SET into the cache, under IDENTIFIERS."
11166 (let* ((key (sha1 (prin1-to-string identifiers)))
11167 (entry (assoc key org-refile-cache)))
11168 (if entry
11169 (setcdr entry set)
11170 (push (cons key set) org-refile-cache))))
11172 (defun org-refile-cache-get (&rest identifiers)
11173 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11174 (cond
11175 ((not org-refile-cache) nil)
11176 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11177 (t
11178 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11179 org-refile-cache))))
11180 (and set (org-refile-cache-check-set set) set)))))
11182 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11183 "Produce a table with refile targets."
11184 (let ((case-fold-search nil)
11185 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11186 (entries (or org-refile-targets '((nil . (:level . 1)))))
11187 targets tgs txt re files f desc descre fast-path-p level pos0)
11188 (message "Getting targets...")
11189 (with-current-buffer (or default-buffer (current-buffer))
11190 (while (setq entry (pop entries))
11191 (setq files (car entry) desc (cdr entry))
11192 (setq fast-path-p nil)
11193 (cond
11194 ((null files) (setq files (list (current-buffer))))
11195 ((eq files 'org-agenda-files)
11196 (setq files (org-agenda-files 'unrestricted)))
11197 ((and (symbolp files) (fboundp files))
11198 (setq files (funcall files)))
11199 ((and (symbolp files) (boundp files))
11200 (setq files (symbol-value files))))
11201 (if (stringp files) (setq files (list files)))
11202 (cond
11203 ((eq (car desc) :tag)
11205 ((eq (car desc) :todo)
11207 ((eq (car desc) :regexp)
11208 (setq descre (cdr desc)))
11209 ((eq (car desc) :level)
11211 (if org-odd-levels-only
11212 (1- (* 2 (cdr desc)))
11213 (cdr desc)))
11215 ((eq (car desc) :maxlevel)
11216 (setq fast-path-p t)
11218 (if org-odd-levels-only
11219 (1- (* 2 (cdr desc)))
11220 (cdr desc)))
11222 (t (error "Bad refiling target description %s" desc)))
11223 (while (setq f (pop files))
11224 (with-current-buffer
11225 (if (bufferp f) f (org-get-agenda-file-buffer f))
11226 (or
11227 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11228 (progn
11229 (if (bufferp f) (setq f (buffer-file-name
11230 (buffer-base-buffer f))))
11231 (setq f (and f (expand-file-name f)))
11232 (if (eq org-refile-use-outline-path 'file)
11233 (push (list (file-name-nondirectory f) f nil nil) tgs))
11234 (save-excursion
11235 (save-restriction
11236 (widen)
11237 (goto-char (point-min))
11238 (while (re-search-forward descre nil t)
11239 (goto-char (setq pos0 (point-at-bol)))
11240 (catch 'next
11241 (when org-refile-target-verify-function
11242 (save-match-data
11243 (or (funcall org-refile-target-verify-function)
11244 (throw 'next t))))
11245 (when (and (looking-at org-complex-heading-regexp)
11246 (not (member (match-string 4) excluded-entries))
11247 (match-string 4))
11248 (setq level (org-reduced-level
11249 (- (match-end 1) (match-beginning 1)))
11250 txt (org-link-display-format (match-string 4))
11252 re (format org-complex-heading-regexp-format
11253 (regexp-quote (match-string 4))))
11254 (when org-refile-use-outline-path
11255 (setq txt (mapconcat
11256 'org-protect-slash
11257 (append
11258 (if (eq org-refile-use-outline-path
11259 'file)
11260 (list (file-name-nondirectory
11261 (buffer-file-name
11262 (buffer-base-buffer))))
11263 (if (eq org-refile-use-outline-path
11264 'full-file-path)
11265 (list (buffer-file-name
11266 (buffer-base-buffer)))))
11267 (org-get-outline-path fast-path-p
11268 level txt)
11269 (list txt))
11270 "/")))
11271 (push (list txt f re (org-refile-marker (point)))
11272 tgs)))
11273 (when (= (point) pos0)
11274 ;; verification function has not moved point
11275 (goto-char (point-at-eol))))))))
11276 (when org-refile-use-cache
11277 (org-refile-cache-put tgs (buffer-file-name) descre))
11278 (setq targets (append tgs targets))))))
11279 (message "Getting targets...done")
11280 (nreverse targets)))
11282 (defun org-protect-slash (s)
11283 (while (string-match "/" s)
11285 s)
11287 (defvar org-olpa (make-vector 20 nil))
11289 (defun org-get-outline-path (&optional fastp level heading)
11290 "Return the outline path to the current entry, as a list.
11292 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11293 routine which makes outline path derivations for an entire file,
11294 avoiding backtracing. Refile target collection makes use of that."
11295 (if fastp
11296 (progn
11297 (if (> level 19)
11298 (error "Outline path failure, more than 19 levels"))
11299 (loop for i from level upto 19 do
11300 (aset org-olpa i nil))
11301 (prog1
11302 (delq nil (append org-olpa nil))
11303 (aset org-olpa level heading)))
11304 (let (rtn case-fold-search)
11305 (save-excursion
11306 (save-restriction
11307 (widen)
11308 (while (org-up-heading-safe)
11309 (when (looking-at org-complex-heading-regexp)
11310 (push (org-match-string-no-properties 4) rtn)))
11311 rtn)))))
11313 (defun org-format-outline-path (path &optional width prefix separator)
11314 "Format the outline path PATH for display.
11315 WIDTH is the maximum number of characters that is available.
11316 PREFIX is a prefix to be included in the returned string,
11317 such as the file name.
11318 SEPARATOR is inserted between the different parts of the path,
11320 (setq width (or width 79))
11321 (if prefix (setq width (- width (length prefix))))
11322 (if (not path)
11323 (or prefix "")
11324 (let* ((nsteps (length path))
11325 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11326 (maxwidth (if (<= total-width width)
11327 10000 ;; everything fits
11328 ;; we need to shorten the level headings
11329 (/ (- width nsteps) nsteps)))
11330 (org-odd-levels-only nil)
11331 (n 0)
11332 (total (1+ (length prefix))))
11333 (setq maxwidth (max maxwidth 10))
11334 (concat prefix
11335 (if prefix (or separator "/"))
11336 (mapconcat
11337 (lambda (h)
11338 (setq n (1+ n))
11339 (if (and (= n nsteps) (< maxwidth 10000))
11340 (setq maxwidth (- total-width total)))
11341 (if (< (length h) maxwidth)
11342 (progn (setq total (+ total (length h) 1)) h)
11343 (setq h (substring h 0 (- maxwidth 2))
11344 total (+ total maxwidth 1))
11346 (setq h (substring h 0 (match-beginning 0))))
11347 (setq h (concat h "..")))
11348 (org-add-props h nil 'face
11349 (nth (% (1- n) org-n-level-faces)
11350 org-level-faces))
11351 h)
11352 path (or separator "/"))))))
11354 (defun org-display-outline-path (&optional file current separator just-return-string)
11355 "Display the current outline path in the echo area.
11357 If FILE is non-nil, prepend the output with the file name.
11358 If CURRENT is non-nil, append the current heading to the output.
11359 SEPARATOR is passed through to `org-format-outline-path'. It separates
11361 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11362 (interactive "P")
11363 (let* (case-fold-search
11364 message-log-max ; Don't populate the *Messages* buffer
11365 (bfn (buffer-file-name (buffer-base-buffer)))
11366 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11367 res)
11368 (if current (setq path (append path
11369 (save-excursion
11370 (org-back-to-heading t)
11371 (if (looking-at org-complex-heading-regexp)
11372 (list (match-string 4)))))))
11373 (setq res
11374 (org-format-outline-path
11375 path
11376 (1- (frame-width))
11377 (and file bfn (concat (file-name-nondirectory bfn) separator))
11378 separator))
11379 (if just-return-string
11380 (org-no-properties res)
11381 (message "%s" res))))
11383 (defvar org-refile-history nil
11384 "History for refiling operations.")
11386 (defvar org-after-refile-insert-hook nil
11387 "Hook run after `org-refile' has inserted its stuff at the new location.
11388 Note that this is still *before* the stuff will be removed from
11389 the *old* location.")
11391 (defvar org-capture-last-stored-marker)
11392 (defvar org-refile-keep nil
11393 "Non-nil means `org-refile' will copy instead of refile.")
11395 (defun org-copy ()
11396 "Like `org-refile', but copy."
11397 (interactive)
11398 (let ((org-refile-keep t))
11399 (funcall 'org-refile nil nil nil "Copy")))
11401 (defun org-refile (&optional goto default-buffer rfloc msg)
11402 "Move the entry or entries at point to another heading.
11403 The list of target headings is compiled using the information in
11404 `org-refile-targets', which see.
11406 At the target location, the entry is filed as a subitem of the target
11407 heading. Depending on `org-reverse-note-order', the new subitem will
11408 either be the first or the last subitem.
11410 If there is an active region, all entries in that region will be moved.
11411 However, the region must fulfill the requirement that the first heading
11412 is the first one sets the top-level of the moved text - at most siblings
11413 below it are allowed.
11415 With prefix arg GOTO, the command will only visit the target location
11416 and not actually move anything.
11419 go to the location where the last refiling operation has put the subtree.
11420 With a prefix argument of `2', refile to the running clock.
11422 RFLOC can be a refile location obtained in a different way.
11427 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11429 If you are using target caching (see `org-refile-use-cache'),
11430 you have to clear the target cache in order to find new targets.
11431 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11432 prefix argument (`C-u C-u C-u C-c C-w')."
11434 (interactive "P")
11435 (if (member goto '(0 (64)))
11436 (org-refile-cache-clear)
11437 (let* ((actionmsg (or msg "Refile"))
11438 (cbuf (current-buffer))
11439 (regionp (org-region-active-p))
11440 (region-start (and regionp (region-beginning)))
11441 (region-end (and regionp (region-end)))
11442 (region-length (and regionp (- region-end region-start)))
11443 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11444 pos it nbuf file re level reversed)
11445 (setq last-command nil)
11446 (when regionp
11447 (goto-char region-start)
11448 (or (bolp) (goto-char (point-at-bol)))
11449 (setq region-start (point))
11450 (unless (or (org-kill-is-subtree-p
11451 (buffer-substring region-start region-end))
11452 (prog1 org-refile-active-region-within-subtree
11453 (org-toggle-heading)))
11454 (error "The region is not a (sequence of) subtree(s)")))
11455 (if (equal goto '(16))
11456 (org-refile-goto-last-stored)
11457 (when (or
11458 (and (equal goto 2)
11459 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11460 (prog1
11461 (setq it (list (or org-clock-heading "running clock")
11462 (buffer-file-name
11463 (marker-buffer org-clock-hd-marker))
11464 ""
11465 (marker-position org-clock-hd-marker)))
11466 (setq goto nil)))
11467 (setq it (or rfloc
11468 (let (heading-text)
11469 (save-excursion
11470 (unless goto
11471 (org-back-to-heading t)
11472 (setq heading-text
11473 (nth 4 (org-heading-components))))
11475 (org-refile-get-location
11476 (cond (goto "Goto")
11477 (regionp (concat actionmsg " region to"))
11480 default-buffer
11481 (and (not (equal '(4) goto))
11482 org-refile-allow-creating-parent-nodes)
11483 goto))))))
11484 (setq file (nth 1 it)
11485 re (nth 2 it)
11486 pos (nth 3 it))
11487 (if (and (not goto)
11488 pos
11489 (equal (buffer-file-name) file)
11490 (if regionp
11491 (and (>= pos region-start)
11492 (<= pos region-end))
11493 (and (>= pos (point))
11494 (< pos (save-excursion
11495 (org-end-of-subtree t t))))))
11496 (error "Cannot refile to position inside the tree or region"))
11498 (setq nbuf (or (find-buffer-visiting file)
11499 (find-file-noselect file)))
11500 (if goto
11501 (progn
11502 (org-pop-to-buffer-same-window nbuf)
11503 (goto-char pos)
11504 (org-show-context 'org-goto))
11505 (if regionp
11506 (progn
11507 (org-kill-new (buffer-substring region-start region-end))
11508 (org-save-markers-in-region region-start region-end))
11509 (org-copy-subtree 1 nil t))
11510 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11511 (find-file-noselect file)))
11512 (setq reversed (org-notes-order-reversed-p))
11513 (save-excursion
11514 (save-restriction
11515 (widen)
11516 (if pos
11517 (progn
11518 (goto-char pos)
11519 (looking-at org-outline-regexp)
11520 (setq level (org-get-valid-level (funcall outline-level) 1))
11521 (goto-char
11522 (if reversed
11523 (or (outline-next-heading) (point-max))
11524 (or (save-excursion (org-get-next-sibling))
11525 (org-end-of-subtree t t)
11526 (point-max)))))
11527 (setq level 1)
11528 (if (not reversed)
11529 (goto-char (point-max))
11530 (goto-char (point-min))
11531 (or (outline-next-heading) (goto-char (point-max)))))
11532 (if (not (bolp)) (newline))
11533 (org-paste-subtree level)
11534 (when org-log-refile
11535 (org-add-log-setup 'refile nil nil 'findpos
11536 org-log-refile)
11537 (unless (eq org-log-refile 'note)
11538 (save-excursion (org-add-log-note))))
11539 (and org-auto-align-tags
11540 (let ((org-loop-over-headlines-in-active-region nil))
11541 (org-set-tags nil t)))
11542 (with-demoted-errors
11543 (bookmark-set "org-refile-last-stored"))
11544 ;; If we are refiling for capture, make sure that the
11545 ;; last-capture pointers point here
11546 (when (org-bound-and-true-p org-refile-for-capture)
11547 (with-demoted-errors
11548 (bookmark-set "org-capture-last-stored-marker"))
11549 (move-marker org-capture-last-stored-marker (point)))
11550 (if (fboundp 'deactivate-mark) (deactivate-mark))
11551 (run-hooks 'org-after-refile-insert-hook))))
11552 (unless org-refile-keep
11553 (if regionp
11554 (delete-region (point) (+ (point) region-length))
11555 (org-cut-subtree)))
11556 (when (featurep 'org-inlinetask)
11557 (org-inlinetask-remove-END-maybe))
11558 (setq org-markers-to-move nil)
11561 (defun org-refile-goto-last-stored ()
11562 "Go to the location where the last refile was stored."
11563 (interactive)
11564 (bookmark-jump "org-refile-last-stored")
11565 (message "This is the location of the last refile"))
11567 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11568 no-exclude)
11569 "Prompt the user for a refile location, using PROMPT.
11570 PROMPT should not be suffixed with a colon and a space, because
11571 this function appends the default value from
11572 `org-refile-history' automatically, if that is not empty.
11573 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11574 this is used for the GOTO interface."
11575 (let ((org-refile-targets org-refile-targets)
11576 (org-refile-use-outline-path org-refile-use-outline-path)
11577 excluded-entries)
11578 (when (and (derived-mode-p 'org-mode)
11579 (not org-refile-use-cache)
11580 (not no-exclude))
11581 (org-map-tree
11582 (lambda()
11583 (setq excluded-entries
11584 (append excluded-entries (list (org-get-heading t t)))))))
11585 (setq org-refile-target-table
11586 (org-refile-get-targets default-buffer excluded-entries)))
11587 (unless org-refile-target-table
11588 (error "No refile targets"))
11589 (let* ((cbuf (current-buffer))
11590 (partial-completion-mode nil)
11591 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11592 (cfunc (if (and org-refile-use-outline-path
11593 org-outline-path-complete-in-steps)
11594 'org-olpath-completing-read
11595 'org-icompleting-read))
11596 (extra (if org-refile-use-outline-path "/" ""))
11597 (cbnex (concat (buffer-name) extra))
11598 (filename (and cfn (expand-file-name cfn)))
11599 (tbl (mapcar
11600 (lambda (x)
11601 (if (and (not (member org-refile-use-outline-path
11602 '(file full-file-path)))
11603 (not (equal filename (nth 1 x))))
11604 (cons (concat (car x) extra " ("
11605 (file-name-nondirectory (nth 1 x)) ")")
11606 (cdr x))
11607 (cons (concat (car x) extra) (cdr x))))
11608 org-refile-target-table))
11609 (completion-ignore-case t)
11610 cdef
11611 (prompt (concat prompt
11612 (or (and (car org-refile-history)
11613 (concat " (default " (car org-refile-history) ")"))
11614 (and (assoc cbnex tbl) (setq cdef cbnex)
11615 (concat " (default " cbnex ")"))) ": "))
11616 pa answ parent-target child parent old-hist)
11617 (setq old-hist org-refile-history)
11618 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11619 nil 'org-refile-history (or cdef (car org-refile-history))))
11620 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11621 (org-refile-check-position pa)
11622 (if pa
11623 (progn
11624 (when (or (not org-refile-history)
11625 (not (eq old-hist org-refile-history))
11626 (not (equal (car pa) (car org-refile-history))))
11627 (setq org-refile-history
11628 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11629 org-refile-history
11630 (cdr org-refile-history))))
11631 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11632 (pop org-refile-history)))
11633 pa)
11635 (progn
11636 (setq parent (match-string 1 answ)
11637 child (match-string 2 answ))
11638 (setq parent-target (or (assoc parent tbl)
11639 (assoc (concat parent "/") tbl)))
11640 (when (and parent-target
11641 (or (eq new-nodes t)
11642 (and (eq new-nodes 'confirm)
11644 child)))))
11645 (org-refile-new-child parent-target child)))
11646 (error "Invalid target location")))))
11648 (declare-function org-string-nw-p "org-macs" (s))
11649 (defun org-refile-check-position (refile-pointer)
11650 "Check if the refile pointer matches the headline to which it points."
11651 (let* ((file (nth 1 refile-pointer))
11652 (re (nth 2 refile-pointer))
11653 (pos (nth 3 refile-pointer))
11654 buffer)
11655 (if (and (not (markerp pos)) (not file))
11656 (error "Please save the buffer to a file before refiling")
11657 (when (org-string-nw-p re)
11658 (setq buffer (if (markerp pos)
11659 (marker-buffer pos)
11660 (or (find-buffer-visiting file)
11661 (find-file-noselect file))))
11662 (with-current-buffer buffer
11663 (save-excursion
11664 (save-restriction
11665 (widen)
11666 (goto-char pos)
11667 (beginning-of-line 1)
11668 (unless (org-looking-at-p re)
11669 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11671 (defun org-refile-new-child (parent-target child)
11672 "Use refile target PARENT-TARGET to add new CHILD below it."
11673 (unless parent-target
11674 (error "Cannot find parent for new node"))
11675 (let ((file (nth 1 parent-target))
11676 (pos (nth 3 parent-target))
11677 level)
11678 (with-current-buffer (or (find-buffer-visiting file)
11679 (find-file-noselect file))
11680 (save-excursion
11681 (save-restriction
11682 (widen)
11683 (if pos
11684 (goto-char pos)
11685 (goto-char (point-max))
11686 (if (not (bolp)) (newline)))
11687 (when (looking-at org-outline-regexp)
11688 (setq level (funcall outline-level))
11689 (org-end-of-subtree t t))
11690 (org-back-over-empty-lines)
11692 (if pos (org-get-valid-level level 1) 1) ?*)
11694 (beginning-of-line 0)
11695 (list (concat (car parent-target) "/" child) file "" (point)))))))
11697 (defun org-olpath-completing-read (prompt collection &rest args)
11698 "Read an outline path like a file name."
11699 (let ((thetable collection)
11700 (org-completion-use-ido nil) ; does not work with ido.
11701 (org-completion-use-iswitchb nil)) ; or iswitchb
11702 (apply
11703 'org-icompleting-read prompt
11704 (lambda (string predicate &optional flag)
11705 (let (rtn r f (l (length string)))
11706 (cond
11707 ((eq flag nil)
11708 ;; try completion
11709 (try-completion string thetable))
11710 ((eq flag t)
11711 ;; all-completions
11712 (setq rtn (all-completions string thetable predicate))
11713 (mapcar
11714 (lambda (x)
11715 (setq r (substring x l))
11716 (if (string-match " ([^)]*)$" x)
11717 (setq f (match-string 0 x))
11718 (setq f ""))
11719 (if (string-match "/" r)
11720 (concat string (substring r 0 (match-end 0)) f)
11721 x))
11722 rtn))
11723 ((eq flag 'lambda)
11724 ;; exact match?
11725 (assoc string thetable)))))
11726 args)))
11728 ;;;; Dynamic blocks
11730 (defun org-find-dblock (name)
11731 "Find the first dynamic block with name NAME in the buffer.
11732 If not found, stay at current position and return nil."
11733 (let ((case-fold-search t) pos)
11734 (save-excursion
11735 (goto-char (point-min))
11736 (setq pos (and (re-search-forward
11738 (match-beginning 0))))
11739 (if pos (goto-char pos))
11740 pos))
11742 (defconst org-dblock-start-re
11744 "Matches the start line of a dynamic block, with parameters.")
11747 "Matches the end of a dynamic block.")
11749 (defun org-create-dblock (plist)
11750 "Create a dynamic block section, with parameters taken from PLIST.
11751 PLIST must contain a :name entry which is used as name of the block."
11753 (end-of-line 1)
11754 (newline))
11755 (let ((col (current-column))
11756 (name (plist-get plist :name)))
11757 (insert "#+BEGIN: " name)
11758 (while plist
11759 (if (eq (car plist) :name)
11760 (setq plist (cddr plist))
11761 (insert " " (prin1-to-string (pop plist)))))
11763 (beginning-of-line -2)))
11765 (defun org-prepare-dblock ()
11766 "Prepare dynamic block for refresh.
11767 This empties the block, puts the cursor at the insert position and returns
11768 the property list including an extra property :name with the block name."
11769 (unless (looking-at org-dblock-start-re)
11770 (error "Not at a dynamic block"))
11771 (let* ((begdel (1+ (match-end 0)))
11772 (name (org-no-properties (match-string 1)))
11773 (params (append (list :name name)
11774 (read (concat "(" (match-string 3) ")")))))
11775 (save-excursion
11776 (beginning-of-line 1)
11778 (setq params (plist-put params :indentation-column (current-column))))
11779 (unless (re-search-forward org-dblock-end-re nil t)
11780 (error "Dynamic block not terminated"))
11781 (setq params
11782 (append params
11783 (list :content (buffer-substring
11784 begdel (match-beginning 0)))))
11785 (delete-region begdel (match-beginning 0))
11786 (goto-char begdel)
11787 (open-line 1)
11788 params))
11790 (defun org-map-dblocks (&optional command)
11791 "Apply COMMAND to all dynamic blocks in the current buffer.
11792 If COMMAND is not given, use `org-update-dblock'."
11793 (let ((cmd (or command 'org-update-dblock)))
11794 (save-excursion
11795 (goto-char (point-min))
11796 (while (re-search-forward org-dblock-start-re nil t)
11797 (goto-char (match-beginning 0))
11798 (save-excursion
11799 (condition-case nil
11800 (funcall cmd)
11801 (error (message "Error during update of dynamic block"))))
11802 (unless (re-search-forward org-dblock-end-re nil t)
11803 (error "Dynamic block not terminated"))))))
11805 (defun org-dblock-update (&optional arg)
11806 "User command for updating dynamic blocks.
11807 Update the dynamic block at point. With prefix ARG, update all dynamic
11808 blocks in the buffer."
11809 (interactive "P")
11810 (if arg
11811 (org-update-all-dblocks)
11812 (or (looking-at org-dblock-start-re)
11813 (org-beginning-of-dblock))
11814 (org-update-dblock)))
11816 (defun org-update-dblock ()
11817 "Update the dynamic block at point.
11818 This means to empty the block, parse for parameters and then call
11819 the correct writing function."
11820 (interactive)
11821 (save-window-excursion
11822 (let* ((pos (point))
11823 (line (org-current-line))
11824 (params (org-prepare-dblock))
11825 (name (plist-get params :name))
11826 (indent (plist-get params :indentation-column))
11827 (cmd (intern (concat "org-dblock-write:" name))))
11828 (message "Updating dynamic block `%s' at line %d..." name line)
11829 (funcall cmd params)
11830 (message "Updating dynamic block `%s' at line %d...done" name line)
11831 (goto-char pos)
11832 (when (and indent (> indent 0))
11833 (setq indent (make-string indent ?\ ))
11834 (save-excursion
11835 (org-beginning-of-dblock)
11836 (forward-line 1)
11837 (while (not (looking-at org-dblock-end-re))
11838 (insert indent)
11839 (beginning-of-line 2))
11840 (when (looking-at org-dblock-end-re)
11842 (replace-match ""))
11843 (insert indent)))))))
11845 (defun org-beginning-of-dblock ()
11846 "Find the beginning of the dynamic block at point.
11847 Error if there is no such block at point."
11848 (let ((pos (point))
11849 beg)
11850 (end-of-line 1)
11851 (if (and (re-search-backward org-dblock-start-re nil t)
11852 (setq beg (match-beginning 0))
11853 (re-search-forward org-dblock-end-re nil t)
11854 (> (match-end 0) pos))
11855 (goto-char beg)
11856 (goto-char pos)
11857 (error "Not in a dynamic block"))))
11859 (defun org-update-all-dblocks ()
11860 "Update all dynamic blocks in the buffer.
11861 This function can be used in a hook."
11862 (interactive)
11863 (when (derived-mode-p 'org-mode)
11864 (org-map-dblocks 'org-update-dblock)))
11867 ;;;; Completion
11869 (defun org-get-export-keywords ()
11870 "Return a list of all currently understood export keywords.
11871 Export keywords include options, block names, attributes and
11872 keywords relative to each registered export back-end."
11873 (delq nil
11874 (let (keywords)
11875 (mapc
11876 (lambda (back-end)
11877 (let ((props (cdr back-end)))
11878 ;; Back-end name (for keywords, like #+LATEX:)
11879 (push (upcase (symbol-name (car back-end))) keywords)
11880 ;; Back-end options.
11881 (mapc (lambda (option) (push (cadr option) keywords))
11882 (plist-get (cdr back-end) :options-alist))))
11883 (org-bound-and-true-p org-export-registered-backends))
11884 keywords)))
11886 (defconst org-options-keywords
11887 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11888 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11889 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11890 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11891 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11893 (defcustom org-structure-template-alist
11908 ("L" "#+LaTeX: "
11912 ("H" "#+HTML: "
11915 ("A" "#+ASCII: ")
11916 ("i" "#+INDEX: ?"
11917 "#+INDEX: ?")
11918 ("I" "#+INCLUDE: %file ?"
11920 "Structure completion elements.
11921 This is a list of abbreviation keys and values. The value gets inserted
11922 if you type `<' followed by the key and then press the completion key,
11923 usually `M-TAB'. %file will be replaced by a file name after prompting
11924 for the file using completion. The cursor will be placed at the position
11925 of the `?` in the template.
11926 There are two templates for each key, the first uses the original Org syntax,
11927 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11928 the default when the /org-mtags.el/ module has been loaded. See also the
11929 variable `org-mtags-prefer-muse-templates'."
11930 :group 'org-completion
11931 :type '(repeat
11932 (string :tag "Key")
11933 (string :tag "Template")
11934 (string :tag "Muse Template")))
11936 (defun org-try-structure-completion ()
11937 "Try to complete a structure template before point.
11939 expands them."
11940 (let ((l (buffer-substring (point-at-bol) (point)))
11941 a)
11944 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11945 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11946 (match-beginning 1)) a)
11947 t)))
11949 (defun org-complete-expand-structure-template (start cell)
11950 "Expand a structure template."
11951 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11952 (rpl (nth (if musep 2 1) cell))
11953 (ind ""))
11954 (delete-region start (point))
11956 (cond
11957 ((bolp))
11959 (setq ind (buffer-substring (point-at-bol) (point))))
11960 (t (newline))))
11961 (setq start (point))
11962 (if (string-match "%file" rpl)
11963 (setq rpl (replace-match
11964 (concat
11966 (save-match-data
11967 (abbreviate-file-name (read-file-name "Include file: ")))
11969 t t rpl)))
11972 (insert rpl)
11975 ;;;; TODO, DEADLINE, Comments
11977 (defun org-toggle-comment ()
11978 "Change the COMMENT state of an entry."
11979 (interactive)
11980 (save-excursion
11981 (org-back-to-heading)
11982 (let (case-fold-search)
11983 (cond
11984 ((looking-at (format org-heading-keyword-regexp-format
11985 org-comment-string))
11986 (goto-char (match-end 1))
11987 (looking-at (concat " +" org-comment-string))
11988 (replace-match "" t t)
11989 (when (eolp) (insert " ")))
11990 ((looking-at org-outline-regexp)
11991 (goto-char (match-end 0))
11992 (insert org-comment-string " "))))))
11994 (defvar org-last-todo-state-is-todo nil
11995 "This is non-nil when the last TODO state change led to a TODO state.
11996 If the last change removed the TODO tag or switched to DONE, then
11997 this is nil.")
11999 (defvar org-setting-tags nil) ; dynamically skipped
12001 (defvar org-todo-setup-filter-hook nil
12002 "Hook for functions that pre-filter todo specs.
12003 Each function takes a todo spec and returns either nil or the spec
12004 transformed into canonical form." )
12006 (defvar org-todo-get-default-hook nil
12007 "Hook for functions that get a default item for todo.
12008 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12009 nil or a string to be used for the todo mark." )
12011 (defvar org-agenda-headline-snapshot-before-repeat)
12013 (defun org-current-effective-time ()
12014 "Return current time adjusted for `org-extend-today-until' variable."
12015 (let* ((ct (org-current-time))
12016 (dct (decode-time ct))
12017 (ct1
12018 (cond
12019 (org-use-last-clock-out-time-as-effective-time
12020 (or (org-clock-get-last-clock-out-time) ct))
12021 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12022 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12023 (t ct))))
12024 ct1))
12026 (defun org-todo-yesterday (&optional arg)
12027 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12028 (interactive "P")
12029 (if (eq major-mode 'org-agenda-mode)
12030 (apply 'org-agenda-todo-yesterday arg)
12031 (let* ((hour (third (decode-time
12032 (org-current-time))))
12033 (org-extend-today-until (1+ hour)))
12034 (org-todo arg))))
12036 (defvar org-block-entry-blocking ""
12037 "First entry preventing the TODO state change.")
12039 (defun org-todo (&optional arg)
12040 "Change the TODO state of an item.
12041 The state of an item is given by a keyword at the start of the heading,
12042 like
12043 *** TODO Write paper
12044 *** DONE Call mom
12046 The different keywords are specified in the variable `org-todo-keywords'.
12048 So for this example: when the item starts with TODO, it is changed to DONE.
12049 When it starts with DONE, the DONE is removed. And when neither TODO nor
12050 DONE are present, add TODO at the beginning of the heading.
12053 state.
12054 With numeric prefix arg, switch to that state.
12056 keywords (nextset).
12058 With a numeric prefix arg of 0, inhibit note taking for the change.
12060 For calling through lisp, arg is also interpreted in the following way:
12061 'none -> empty state
12063 'done -> switch to DONE
12064 'nextset -> switch to the next set of keywords
12065 'previousset -> switch to the previous set of keywords
12067 really is a member of `org-todo-keywords'."
12068 (interactive "P")
12069 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12070 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12071 'region-start-level 'region))
12072 org-loop-over-headlines-in-active-region)
12073 (org-map-entries
12074 `(org-todo ,arg)
12075 org-loop-over-headlines-in-active-region
12076 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12077 (if (equal arg '(16)) (setq arg 'nextset))
12078 (let ((org-blocker-hook org-blocker-hook)
12079 commentp
12080 case-fold-search)
12081 (when (equal arg '(64))
12082 (setq arg nil org-blocker-hook nil))
12083 (when (and org-blocker-hook
12084 (or org-inhibit-blocking
12085 (org-entry-get nil "NOBLOCKING")))
12086 (setq org-blocker-hook nil))
12087 (save-excursion
12088 (catch 'exit
12089 (org-back-to-heading t)
12091 (org-toggle-comment)
12092 (setq commentp t))
12093 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12096 (let* ((match-data (match-data))
12097 (startpos (point-at-bol))
12098 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12099 (org-log-done org-log-done)
12100 (org-log-repeat org-log-repeat)
12101 (org-todo-log-states org-todo-log-states)
12102 (org-inhibit-logging
12103 (if (equal arg 0)
12104 (progn (setq arg nil) 'note) org-inhibit-logging))
12105 (this (match-string 1))
12106 (hl-pos (match-beginning 0))
12107 (head (org-get-todo-sequence-head this))
12108 (ass (assoc head org-todo-kwd-alist))
12109 (interpret (nth 1 ass))
12110 (done-word (nth 3 ass))
12111 (final-done-word (nth 4 ass))
12112 (org-last-state (or this ""))
12113 (completion-ignore-case t)
12114 (member (member this org-todo-keywords-1))
12115 (tail (cdr member))
12116 (org-state (cond
12117 ((and org-todo-key-trigger
12118 (or (and (equal arg '(4))
12119 (eq org-use-fast-todo-selection 'prefix))
12120 (and (not arg) org-use-fast-todo-selection
12121 (not (eq org-use-fast-todo-selection
12122 'prefix)))))
12123 ;; Use fast selection
12124 (org-fast-todo-selection))
12125 ((and (equal arg '(4))
12126 (or (not org-use-fast-todo-selection)
12127 (not org-todo-key-trigger)))
12128 ;; Read a state with completion
12129 (org-icompleting-read
12130 "State: " (mapcar 'list org-todo-keywords-1)
12131 nil t))
12132 ((eq arg 'right)
12133 (if this
12134 (if tail (car tail) nil)
12135 (car org-todo-keywords-1)))
12136 ((eq arg 'left)
12137 (if (equal member org-todo-keywords-1)
12138 nil
12139 (if this
12140 (nth (- (length org-todo-keywords-1)
12141 (length tail) 2)
12142 org-todo-keywords-1)
12143 (org-last org-todo-keywords-1))))
12144 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12145 (setq arg nil))) ; hack to fall back to cycling
12146 (arg
12147 ;; user or caller requests a specific state
12148 (cond
12149 ((equal arg "") nil)
12150 ((eq arg 'none) nil)
12151 ((eq arg 'done) (or done-word (car org-done-keywords)))
12152 ((eq arg 'nextset)
12153 (or (car (cdr (member head org-todo-heads)))
12154 (car org-todo-heads)))
12155 ((eq arg 'previousset)
12156 (let ((org-todo-heads (reverse org-todo-heads)))
12157 (or (car (cdr (member head org-todo-heads)))
12158 (car org-todo-heads))))
12159 ((car (member arg org-todo-keywords-1)))
12160 ((stringp arg)
12161 (error "State `%s' not valid in this file" arg))
12162 ((nth (1- (prefix-numeric-value arg))
12163 org-todo-keywords-1))))
12164 ((null member) (or head (car org-todo-keywords-1)))
12165 ((equal this final-done-word) nil) ;; -> make empty
12166 ((null tail) nil) ;; -> first entry
12167 ((memq interpret '(type priority))
12168 (if (eq this-command last-command)
12169 (car tail)
12170 (if (> (length tail) 0)
12171 (or done-word (car org-done-keywords))
12172 nil)))
12173 (t
12174 (car tail))))
12175 (org-state (or
12176 (run-hook-with-args-until-success
12177 'org-todo-get-default-hook org-state org-last-state)
12178 org-state))
12179 (next (if org-state (concat " " org-state " ") " "))
12180 (change-plist (list :type 'todo-state-change :from this :to org-state
12181 :position startpos))
12182 dolog now-done-p)
12183 (when org-blocker-hook
12184 (setq org-last-todo-state-is-todo
12185 (not (member this org-done-keywords)))
12186 (unless (save-excursion
12187 (save-match-data
12188 (org-with-wide-buffer
12189 (run-hook-with-args-until-failure
12190 'org-blocker-hook change-plist))))
12191 (if (org-called-interactively-p 'interactive)
12193 this org-state org-block-entry-blocking)
12194 ;; fail silently
12196 this org-state org-block-entry-blocking)
12197 (throw 'exit nil))))
12198 (store-match-data match-data)
12199 (replace-match next t t)
12200 (unless (pos-visible-in-window-p hl-pos)
12201 (message "TODO state changed to %s" (org-trim next)))
12202 (unless head
12203 (setq head (org-get-todo-sequence-head org-state)
12204 ass (assoc head org-todo-kwd-alist)
12205 interpret (nth 1 ass)
12206 done-word (nth 3 ass)
12207 final-done-word (nth 4 ass)))
12208 (when (memq arg '(nextset previousset))
12209 (message "Keyword-Set %d/%d: %s"
12210 (- (length org-todo-sets) -1
12211 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12212 (length org-todo-sets)
12213 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12214 (setq org-last-todo-state-is-todo
12215 (not (member org-state org-done-keywords)))
12216 (setq now-done-p (and (member org-state org-done-keywords)
12217 (not (member this org-done-keywords))))
12218 (and logging (org-local-logging logging))
12219 (when (and (or org-todo-log-states org-log-done)
12220 (not (eq org-inhibit-logging t))
12221 (not (memq arg '(nextset previousset))))
12222 ;; we need to look at recording a time and note
12223 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12224 (nth 2 (assoc this org-todo-log-states))))
12225 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12226 (setq dolog 'time))
12227 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12228 (and org-state
12229 (member org-state org-not-done-keywords)
12230 (not (member this org-not-done-keywords))))
12231 ;; This is now a todo state and was not one before
12232 ;; If there was a CLOSED time stamp, get rid of it.
12233 (org-add-planning-info nil nil 'closed))
12234 (when (and now-done-p org-log-done)
12235 ;; It is now done, and it was not done before
12236 (org-add-planning-info 'closed (org-current-effective-time))
12237 (if (and (not dolog) (eq 'note org-log-done))
12238 (org-add-log-setup 'done org-state this 'findpos 'note)))
12239 (when (and org-state dolog)
12240 ;; This is a non-nil state, and we need to log it
12241 (org-add-log-setup 'state org-state this 'findpos dolog)))
12242 ;; Fixup tag positioning
12243 (org-todo-trigger-tag-changes org-state)
12244 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12245 (when org-provide-todo-statistics
12246 (org-update-parent-todo-statistics))
12247 (run-hooks 'org-after-todo-state-change-hook)
12248 (if (and arg (not (member org-state org-done-keywords)))
12249 (setq head (org-get-todo-sequence-head org-state)))
12250 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12251 ;; Do we need to trigger a repeat?
12252 (when now-done-p
12253 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12254 ;; This is for the agenda, take a snapshot of the headline.
12255 (save-match-data
12256 (setq org-agenda-headline-snapshot-before-repeat
12257 (org-get-heading))))
12258 (org-auto-repeat-maybe org-state))
12259 ;; Fixup cursor location if close to the keyword
12260 (if (and (outline-on-heading-p)
12261 (not (bolp))
12262 (save-excursion (beginning-of-line 1)
12263 (looking-at org-todo-line-regexp))
12264 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12265 (progn
12266 (goto-char (or (match-end 2) (match-end 1)))
12267 (and (looking-at " ") (just-one-space))))
12268 (when org-trigger-hook
12269 (save-excursion
12270 (run-hook-with-args 'org-trigger-hook change-plist)))
12271 (when commentp (org-toggle-comment))))))))
12273 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12274 "Block turning an entry into a TODO, using the hierarchy.
12275 This checks whether the current task should be blocked from state
12276 changes. Such blocking occurs when:
12278 1. The task has children which are not all in a completed state.
12280 2. A task has a parent with the property :ORDERED:, and there
12281 are siblings prior to the current task with incomplete
12282 status.
12284 3. The parent of the task is blocked because it has siblings that should
12285 be done first, or is child of a block grandparent TODO entry."
12287 (if (not org-enforce-todo-dependencies)
12288 t ; if locally turned off don't block
12289 (catch 'dont-block
12290 ;; If this is not a todo state change, or if this entry is already DONE,
12291 ;; do not block
12292 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12293 (member (plist-get change-plist :from)
12294 (cons 'done org-done-keywords))
12295 (member (plist-get change-plist :to)
12296 (cons 'todo org-not-done-keywords))
12297 (not (plist-get change-plist :to)))
12298 (throw 'dont-block t))
12299 ;; If this task has children, and any are undone, it's blocked
12300 (save-excursion
12301 (org-back-to-heading t)
12302 (let ((this-level (funcall outline-level)))
12303 (outline-next-heading)
12304 (let ((child-level (funcall outline-level)))
12305 (while (and (not (eobp))
12306 (> child-level this-level))
12307 ;; this todo has children, check whether they are all
12308 ;; completed
12309 (if (and (not (org-entry-is-done-p))
12310 (org-entry-is-todo-p))
12311 (progn (setq org-block-entry-blocking (org-get-heading))
12312 (throw 'dont-block nil)))
12313 (outline-next-heading)
12314 (setq child-level (funcall outline-level))))))
12315 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12316 ;; any previous siblings are undone, it's blocked
12317 (save-excursion
12318 (org-back-to-heading t)
12319 (let* ((pos (point))
12320 (parent-pos (and (org-up-heading-safe) (point))))
12321 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12322 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12323 (forward-line 1)
12324 (re-search-forward org-not-done-heading-regexp pos t))
12325 (setq org-block-entry-blocking (match-string 0))
12326 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12327 ;; Search further up the hierarchy, to see if an ancestor is blocked
12328 (while t
12329 (goto-char parent-pos)
12330 (if (not (looking-at org-not-done-heading-regexp))
12331 (throw 'dont-block t)) ; do not block, parent is not a TODO
12332 (setq pos (point))
12333 (setq parent-pos (and (org-up-heading-safe) (point)))
12334 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12335 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12336 (forward-line 1)
12337 (re-search-forward org-not-done-heading-regexp pos t)
12338 (setq org-block-entry-blocking (org-get-heading)))
12339 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12341 (defcustom org-track-ordered-property-with-tag nil
12342 "Should the ORDERED property also be shown as a tag?
12343 The ORDERED property decides if an entry should require subtasks to be
12344 completed in sequence. Since a property is not very visible, setting
12345 this option means that toggling the ORDERED property with the command
12346 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12347 not relevant for the behavior, but it makes things more visible.
12349 Note that toggling the tag with tags commands will not change the property
12350 and therefore not influence behavior!
12352 This can be t, meaning the tag ORDERED should be used, It can also be a
12353 string to select a different tag for this task."
12354 :group 'org-todo
12355 :type '(choice
12356 (const :tag "No tracking" nil)
12357 (const :tag "Track with ORDERED tag" t)
12358 (string :tag "Use other tag")))
12360 (defun org-toggle-ordered-property ()
12361 "Toggle the ORDERED property of the current entry.
12362 For better visibility, you can track the value of this property with a tag.
12363 See variable `org-track-ordered-property-with-tag'."
12364 (interactive)
12365 (let* ((t1 org-track-ordered-property-with-tag)
12366 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12367 (save-excursion
12368 (org-back-to-heading)
12369 (if (org-entry-get nil "ORDERED")
12370 (progn
12371 (org-delete-property "ORDERED" "PROPERTIES")
12372 (and tag (org-toggle-tag tag 'off))
12373 (message "Subtasks can be completed in arbitrary order"))
12374 (org-entry-put nil "ORDERED" "t")
12375 (and tag (org-toggle-tag tag 'on))
12376 (message "Subtasks must be completed in sequence")))))
12378 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12379 (defun org-block-todo-from-checkboxes (change-plist)
12380 "Block turning an entry into a TODO, using checkboxes.
12381 This checks whether the current task should be blocked from state
12382 changes because there are unchecked boxes in this entry."
12383 (if (not org-enforce-todo-checkbox-dependencies)
12384 t ; if locally turned off don't block
12385 (catch 'dont-block
12386 ;; If this is not a todo state change, or if this entry is already DONE,
12387 ;; do not block
12388 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12389 (member (plist-get change-plist :from)
12390 (cons 'done org-done-keywords))
12391 (member (plist-get change-plist :to)
12392 (cons 'todo org-not-done-keywords))
12393 (not (plist-get change-plist :to)))
12394 (throw 'dont-block t))
12395 ;; If this task has checkboxes that are not checked, it's blocked
12396 (save-excursion
12397 (org-back-to-heading t)
12398 (let ((beg (point)) end)
12399 (outline-next-heading)
12400 (setq end (point))
12401 (goto-char beg)
12402 (if (org-list-search-forward
12403 (concat (org-item-beginning-re)
12406 end t)
12407 (progn
12408 (if (boundp 'org-blocked-by-checkboxes)
12409 (setq org-blocked-by-checkboxes t))
12410 (throw 'dont-block nil)))))
12411 t))) ; do not block
12413 (defun org-entry-blocked-p ()
12414 "Is the current entry blocked?"
12415 (org-with-silent-modifications
12416 (if (org-entry-get nil "NOBLOCKING")
12417 nil ;; Never block this entry
12418 (not (run-hook-with-args-until-failure
12419 'org-blocker-hook
12420 (list :type 'todo-state-change
12421 :position (point)
12422 :from 'todo
12423 :to 'done))))))
12425 (defun org-update-statistics-cookies (all)
12426 "Update the statistics cookie, either from TODO or from checkboxes.
12427 This should be called with the cursor in a line with a statistics cookie."
12428 (interactive "P")
12429 (if all
12430 (progn
12431 (org-update-checkbox-count 'all)
12432 (org-map-entries 'org-update-parent-todo-statistics))
12433 (if (not (org-at-heading-p))
12434 (org-update-checkbox-count)
12435 (let ((pos (point-marker))
12436 end l1 l2)
12437 (ignore-errors (org-back-to-heading t))
12438 (if (not (org-at-heading-p))
12439 (org-update-checkbox-count)
12440 (setq l1 (org-outline-level))
12441 (setq end (save-excursion
12442 (outline-next-heading)
12443 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12444 (point)))
12445 (if (and (save-excursion
12446 (re-search-forward
12448 (not (save-excursion (re-search-forward
12450 (org-update-checkbox-count)
12451 (if (and l2 (> l2 l1))
12452 (progn
12453 (goto-char end)
12454 (org-update-parent-todo-statistics))
12455 (goto-char pos)
12456 (beginning-of-line 1)
12457 (while (re-search-forward
12459 (point-at-eol) t)
12460 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12461 (goto-char pos)
12462 (move-marker pos nil)))))
12464 (defvar org-entry-property-inherited-from) ;; defined below
12465 (defun org-update-parent-todo-statistics ()
12466 "Update any statistics cookie in the parent of the current headline.
12467 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12468 the entire subtree and this will travel up the hierarchy and update
12469 statistics everywhere."
12470 (let* ((prop (save-excursion (org-up-heading-safe)
12471 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12472 (recursive (or (not org-hierarchical-todo-statistics)
12474 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12475 0))
12476 (first t)
12478 level ltoggle l1 new ndel
12479 (cnt-all 0) (cnt-done 0) is-percent kwd
12480 checkbox-beg ov ovs ove cookie-present)
12481 (catch 'exit
12482 (save-excursion
12483 (beginning-of-line 1)
12484 (setq ltoggle (funcall outline-level))
12485 ;; Three situations are to consider:
12487 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12488 ;; to the top-level ancestor on the headline;
12490 ;; 2. If parent has "recursive" property, repeat up to the
12491 ;; headline setting that property, taking inheritance into
12492 ;; account;
12494 ;; 3. Else, move up to direct parent and proceed only once.
12495 (while (and (setq level (org-up-heading-safe))
12496 (or recursive first)
12497 (>= (point) lim))
12498 (setq first nil cookie-present nil)
12499 (unless (and level
12500 (not (string-match
12502 (downcase (or (org-entry-get nil "COOKIE_DATA")
12503 "")))))
12504 (throw 'exit nil))
12505 (while (re-search-forward box-re (point-at-eol) t)
12506 (setq cnt-all 0 cnt-done 0 cookie-present t)
12507 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12508 (save-match-data
12509 (unless (outline-next-heading) (throw 'exit nil))
12510 (while (and (looking-at org-complex-heading-regexp)
12511 (> (setq l1 (length (match-string 1))) level))
12512 (setq kwd (and (or recursive (= l1 ltoggle))
12513 (match-string 2)))
12514 (if (or (eq org-provide-todo-statistics 'all-headlines)
12515 (and (listp org-provide-todo-statistics)
12516 (or (member kwd org-provide-todo-statistics)
12517 (member kwd org-done-keywords))))
12518 (setq cnt-all (1+ cnt-all))
12519 (if (eq org-provide-todo-statistics t)
12520 (and kwd (setq cnt-all (1+ cnt-all)))))
12521 (and (member kwd org-done-keywords)
12522 (setq cnt-done (1+ cnt-done)))
12523 (outline-next-heading)))
12524 (setq new
12525 (if is-percent
12526 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12527 (format "[%d/%d]" cnt-done cnt-all))
12528 ndel (- (match-end 0) checkbox-beg))
12529 ;; handle overlays when updating cookie from column view
12530 (when (setq ov (car (overlays-at checkbox-beg)))
12531 (setq ovs (overlay-start ov) ove (overlay-end ov))
12532 (delete-overlay ov))
12533 (goto-char checkbox-beg)
12534 (insert new)
12535 (delete-region (point) (+ (point) ndel))
12536 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12537 (when ov (move-overlay ov ovs ove)))
12538 (when cookie-present
12539 (run-hook-with-args 'org-after-todo-statistics-hook
12540 cnt-done (- cnt-all cnt-done))))))
12541 (run-hooks 'org-todo-statistics-hook)))
12543 (defvar org-after-todo-statistics-hook nil
12544 "Hook that is called after a TODO statistics cookie has been updated.
12545 Each function is called with two arguments: the number of not-done entries
12546 and the number of done entries.
12548 For example, the following function, when added to this hook, will switch
12549 an entry to DONE when all children are done, and back to TODO when new
12550 entries are set to a TODO status. Note that this hook is only called
12551 when there is a statistics cookie in the headline!
12553 (defun org-summary-todo (n-done n-not-done)
12555 (let (org-log-done org-log-states) ; turn off logging
12557 ")
12559 (defvar org-todo-statistics-hook nil
12560 "Hook that is run whenever Org thinks TODO statistics should be updated.
12561 This hook runs even if there is no statistics cookie present, in which case
12562 `org-after-todo-statistics-hook' would not run.")
12564 (defun org-todo-trigger-tag-changes (state)
12565 "Apply the changes defined in `org-todo-state-tags-triggers'."
12566 (let ((l org-todo-state-tags-triggers)
12567 changes)
12568 (when (or (not state) (equal state ""))
12569 (setq changes (append changes (cdr (assoc "" l)))))
12570 (when (and (stringp state) (> (length state) 0))
12571 (setq changes (append changes (cdr (assoc state l)))))
12572 (when (member state org-not-done-keywords)
12573 (setq changes (append changes (cdr (assoc 'todo l)))))
12574 (when (member state org-done-keywords)
12575 (setq changes (append changes (cdr (assoc 'done l)))))
12576 (dolist (c changes)
12577 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12579 (defun org-local-logging (value)
12580 "Get logging settings from a property VALUE."
12581 (let* (words w a)
12582 ;; directly set the variables, they are already local.
12583 (setq org-log-done nil
12584 org-log-repeat nil
12585 org-todo-log-states nil)
12586 (setq words (org-split-string value))
12587 (while (setq w (pop words))
12588 (cond
12589 ((setq a (assoc w org-startup-options))
12590 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12591 (set (nth 1 a) (nth 2 a))))
12592 ((setq a (org-extract-log-state-settings w))
12593 (and (member (car a) org-todo-keywords-1)
12594 (push a org-todo-log-states)))))))
12596 (defun org-get-todo-sequence-head (kwd)
12597 "Return the head of the TODO sequence to which KWD belongs.
12598 If KWD is not set, check if there is a text property remembering the
12599 right sequence."
12600 (let (p)
12601 (cond
12602 ((not kwd)
12603 (or (get-text-property (point-at-bol) 'org-todo-head)
12604 (progn
12605 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12606 nil (point-at-eol)))
12607 (get-text-property p 'org-todo-head))))
12608 ((not (member kwd org-todo-keywords-1))
12609 (car org-todo-keywords-1))
12610 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12612 (defun org-fast-todo-selection ()
12613 "Fast TODO keyword selection with single keys.
12614 Returns the new TODO keyword, or nil if no state change should occur."
12615 (let* ((fulltable org-todo-key-alist)
12616 (done-keywords org-done-keywords) ;; needed for the faces.
12617 (maxlen (apply 'max (mapcar
12618 (lambda (x)
12619 (if (stringp (car x)) (string-width (car x)) 0))
12620 fulltable)))
12621 (expert nil)
12622 (fwidth (+ maxlen 3 1 3))
12623 (ncol (/ (- (window-width) 4) fwidth))
12624 tg cnt e c tbl
12625 groups ingroup)
12626 (save-excursion
12627 (save-window-excursion
12628 (if expert
12629 (set-buffer (get-buffer-create " *Org todo*"))
12630 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12631 (erase-buffer)
12632 (org-set-local 'org-done-keywords done-keywords)
12633 (setq tbl fulltable cnt 0)
12634 (while (setq e (pop tbl))
12635 (cond
12636 ((equal e '(:startgroup))
12637 (push '() groups) (setq ingroup t)
12638 (when (not (= cnt 0))
12639 (setq cnt 0)
12641 (insert "{ "))
12642 ((equal e '(:endgroup))
12643 (setq ingroup nil cnt 0)
12645 ((equal e '(:newline))
12646 (when (not (= cnt 0))
12647 (setq cnt 0)
12649 (setq e (car tbl))
12650 (while (equal (car tbl) '(:newline))
12652 (setq tbl (cdr tbl)))))
12653 (t
12654 (setq tg (car e) c (cdr e))
12655 (if ingroup (push tg (car groups)))
12656 (setq tg (org-add-props tg nil 'face
12657 (org-get-todo-face tg)))
12658 (if (and (= cnt 0) (not ingroup)) (insert " "))
12659 (insert "[" c "] " tg (make-string
12660 (- fwidth 4 (length tg)) ?\ ))
12661 (when (= (setq cnt (1+ cnt)) ncol)
12663 (if ingroup (insert " "))
12664 (setq cnt 0)))))
12666 (goto-char (point-min))
12667 (if (not expert) (org-fit-window-to-buffer))
12668 (message "[a-z..]:Set [SPC]:clear")
12669 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12670 (cond
12671 ((or (= c ?\C-g)
12672 (and (= c ?q) (not (rassoc c fulltable))))
12673 (setq quit-flag t))
12674 ((= c ?\ ) nil)
12675 ((setq e (rassoc c fulltable) tg (car e))
12676 tg)
12677 (t (setq quit-flag t)))))))
12679 (defun org-entry-is-todo-p ()
12680 (member (org-get-todo-state) org-not-done-keywords))
12682 (defun org-entry-is-done-p ()
12683 (member (org-get-todo-state) org-done-keywords))
12685 (defun org-get-todo-state ()
12686 "Return the TODO keyword of the current subtree."
12687 (save-excursion
12688 (org-back-to-heading t)
12689 (and (looking-at org-todo-line-regexp)
12690 (match-end 2)
12691 (match-string 2))))
12693 (defun org-at-date-range-p (&optional inactive-ok)
12694 "Is the cursor inside a date range?"
12695 (interactive)
12696 (save-excursion
12697 (catch 'exit
12698 (let ((pos (point)))
12700 (skip-chars-backward "<[")
12701 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12702 (>= (match-end 0) pos)
12703 (throw 'exit t))
12705 (skip-chars-backward "<[")
12706 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12707 (>= (match-end 0) pos)
12708 (throw 'exit t)))
12709 nil)))
12711 (defun org-get-repeat (&optional tagline)
12712 "Check if there is a deadline/schedule with repeater in this entry."
12713 (save-match-data
12714 (save-excursion
12715 (org-back-to-heading t)
12716 (and (re-search-forward (if tagline
12718 org-repeat-re)
12719 (org-entry-end-position) t)
12720 (match-string-no-properties 1)))))
12722 (defvar org-last-changed-timestamp)
12723 (defvar org-last-inserted-timestamp)
12724 (defvar org-log-post-message)
12725 (defvar org-log-note-purpose)
12726 (defvar org-log-note-how)
12727 (defvar org-log-note-extra)
12728 (defun org-auto-repeat-maybe (done-word)
12729 "Check if the current headline contains a repeated deadline/schedule.
12730 If yes, set TODO state back to what it was and change the base date
12731 of repeating deadline/scheduled time stamps to new date.
12732 This function is run automatically after each state change to a DONE state."
12733 ;; last-state is dynamically scoped into this function
12734 (let* ((repeat (org-get-repeat))
12735 (aa (assoc org-last-state org-todo-kwd-alist))
12736 (interpret (nth 1 aa))
12737 (head (nth 2 aa))
12738 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12739 (msg "Entry repeats: ")
12740 (org-log-done nil)
12741 (org-todo-log-states nil)
12742 re type n what ts time to-state)
12743 (when repeat
12744 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12745 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12746 org-todo-repeat-to-state))
12747 (unless (and to-state (member to-state org-todo-keywords-1))
12748 (setq to-state (if (eq interpret 'type) org-last-state head)))
12749 (org-todo to-state)
12750 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12751 (org-entry-put nil "LAST_REPEAT" (format-time-string
12752 (org-time-stamp-format t t))))
12753 (when org-log-repeat
12754 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12755 (memq 'org-add-log-note post-command-hook))
12756 ;; OK, we are already setup for some record
12757 (if (eq org-log-repeat 'note)
12758 ;; make sure we take a note, not only a time stamp
12759 (setq org-log-note-how 'note))
12760 ;; Set up for taking a record
12761 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12762 org-last-state
12763 'findpos org-log-repeat)))
12764 (org-back-to-heading t)
12765 (org-add-planning-info nil nil 'closed)
12769 (while (re-search-forward
12770 re (save-excursion (outline-next-heading) (point)) t)
12771 (setq type (if (match-end 1) org-scheduled-string
12772 (if (match-end 3) org-deadline-string "Plain:"))
12773 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12775 (setq n (string-to-number (match-string 2 ts))
12776 what (match-string 3 ts))
12777 (if (equal what "w") (setq n (* n 7) what "d"))
12779 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12780 ;; Preparation, see if we need to modify the start date for the change
12781 (when (match-end 1)
12782 (setq time (save-match-data (org-time-string-to-time ts)))
12783 (cond
12784 ((equal (match-string 1 ts) ".")
12785 ;; Shift starting date to today
12786 (org-timestamp-change
12787 (- (org-today) (time-to-days time))
12788 'day))
12789 ((equal (match-string 1 ts) "+")
12790 (let ((nshiftmax 10) (nshift 0))
12791 (while (or (= nshift 0)
12792 (<= (time-to-days time)
12793 (time-to-days (current-time))))
12794 (when (= (incf nshift) nshiftmax)
12795 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12796 (error "Abort")))
12797 (org-timestamp-change n (cdr (assoc what whata)))
12798 (org-at-timestamp-p t)
12799 (setq ts (match-string 1))
12800 (setq time (save-match-data (org-time-string-to-time ts)))))
12801 (org-timestamp-change (- n) (cdr (assoc what whata)))
12802 ;; rematch, so that we have everything in place for the real shift
12803 (org-at-timestamp-p t)
12804 (setq ts (match-string 1))
12806 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12807 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12808 (setq org-log-post-message msg)
12809 (message "%s" msg))))
12811 (defun org-show-todo-tree (arg)
12812 "Make a compact tree which shows all headlines marked with TODO.
12813 The tree will show the lines where the regexp matches, and all higher
12814 headlines above the match.
12816 With a numeric prefix N, construct a sparse tree for the Nth element
12817 of `org-todo-keywords-1'."
12818 (interactive "P")
12819 (let ((case-fold-search nil)
12820 (kwd-re
12821 (cond ((null arg) org-not-done-regexp)
12822 ((equal arg '(4))
12823 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12824 (mapcar 'list org-todo-keywords-1))))
12828 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12829 (regexp-quote (nth (1- (prefix-numeric-value arg))
12830 org-todo-keywords-1)))
12831 (t (error "Invalid prefix argument: %s" arg)))))
12832 (message "%d TODO entries found"
12833 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12835 (defun org-deadline (arg &optional time)
12837 With one universal prefix argument, remove any deadline from the item.
12838 With two universal prefix arguments, prompt for a warning delay.
12839 With argument TIME, set the deadline at the corresponding date. TIME
12841 (interactive "P")
12842 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12843 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12844 'region-start-level 'region))
12845 org-loop-over-headlines-in-active-region)
12846 (org-map-entries
12847 `(org-deadline ',arg ,time)
12848 org-loop-over-headlines-in-active-region
12849 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12850 (let* ((old-date (org-entry-get nil "DEADLINE"))
12851 (old-date-time (if old-date (org-time-string-to-time old-date)))
12852 (repeater (and old-date
12853 (string-match
12855 old-date)
12856 (match-string 1 old-date))))
12857 (cond
12858 ((equal arg '(4))
12859 (when (and old-date org-log-redeadline)
12860 (org-add-log-setup 'deldeadline nil old-date 'findpos
12861 org-log-redeadline))
12862 (org-remove-timestamp-with-keyword org-deadline-string)
12863 (message "Item no longer has a deadline."))
12864 ((equal arg '(16))
12865 (save-excursion
12866 (if (re-search-forward
12867 org-deadline-time-regexp
12868 (save-excursion (outline-next-heading) (point)) t)
12869 (let* ((rpl0 (match-string 1))
12870 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12871 (replace-match
12872 (concat org-deadline-string
12873 " <" rpl
12874 (format " -%dd"
12875 (abs
12876 (- (time-to-days
12877 (save-match-data
12878 (org-read-date nil t nil "Warn starting from" old-date-time)))
12879 (time-to-days old-date-time))))
12880 ">") t t))
12881 (user-error "No deadline information to update"))))
12882 (t
12883 (org-add-planning-info 'deadline time 'closed)
12884 (when (and old-date org-log-redeadline
12885 (not (equal old-date
12886 (substring org-last-inserted-timestamp 1 -1))))
12887 (org-add-log-setup 'redeadline nil old-date 'findpos
12888 org-log-redeadline))
12889 (when repeater
12890 (save-excursion
12891 (org-back-to-heading t)
12892 (when (re-search-forward (concat org-deadline-string " "
12893 org-last-inserted-timestamp)
12894 (save-excursion
12895 (outline-next-heading) (point)) t)
12896 (goto-char (1- (match-end 0)))
12897 (insert " " repeater)
12898 (setq org-last-inserted-timestamp
12899 (concat (substring org-last-inserted-timestamp 0 -1)
12900 " " repeater
12901 (substring org-last-inserted-timestamp -1))))))
12902 (message "Deadline on %s" org-last-inserted-timestamp))))))
12904 (defun org-schedule (arg &optional time)
12905 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12906 With one universal prefix argument, remove any scheduling date from the item.
12907 With two universal prefix arguments, prompt for a delay cookie.
12908 With argument TIME, scheduled at the corresponding date. TIME can
12910 (interactive "P")
12911 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12912 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12913 'region-start-level 'region))
12914 org-loop-over-headlines-in-active-region)
12915 (org-map-entries
12916 `(org-schedule ',arg ,time)
12917 org-loop-over-headlines-in-active-region
12918 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12919 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12920 (old-date-time (if old-date (org-time-string-to-time old-date)))
12921 (repeater (and old-date
12922 (string-match
12924 old-date)
12925 (match-string 1 old-date))))
12926 (cond
12927 ((equal arg '(4))
12928 (progn
12929 (when (and old-date org-log-reschedule)
12930 (org-add-log-setup 'delschedule nil old-date 'findpos
12931 org-log-reschedule))
12932 (org-remove-timestamp-with-keyword org-scheduled-string)
12933 (message "Item is no longer scheduled.")))
12934 ((equal arg '(16))
12935 (save-excursion
12936 (if (re-search-forward
12937 org-scheduled-time-regexp
12938 (save-excursion (outline-next-heading) (point)) t)
12939 (let* ((rpl0 (match-string 1))
12940 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12941 (replace-match
12942 (concat org-scheduled-string
12943 " <" rpl
12944 (format " -%dd"
12945 (abs
12946 (- (time-to-days
12947 (save-match-data
12948 (org-read-date nil t nil "Delay until" old-date-time)))
12949 (time-to-days old-date-time))))
12950 ">") t t))
12951 (user-error "No scheduled information to update"))))
12952 (t
12953 (org-add-planning-info 'scheduled time 'closed)
12954 (when (and old-date org-log-reschedule
12955 (not (equal old-date
12956 (substring org-last-inserted-timestamp 1 -1))))
12957 (org-add-log-setup 'reschedule nil old-date 'findpos
12958 org-log-reschedule))
12959 (when repeater
12960 (save-excursion
12961 (org-back-to-heading t)
12962 (when (re-search-forward (concat org-scheduled-string " "
12963 org-last-inserted-timestamp)
12964 (save-excursion
12965 (outline-next-heading) (point)) t)
12966 (goto-char (1- (match-end 0)))
12967 (insert " " repeater)
12968 (setq org-last-inserted-timestamp
12969 (concat (substring org-last-inserted-timestamp 0 -1)
12970 " " repeater
12971 (substring org-last-inserted-timestamp -1))))))
12972 (message "Scheduled to %s" org-last-inserted-timestamp))))))
12974 (defun org-get-scheduled-time (pom &optional inherit)
12975 "Get the scheduled time as a time tuple, of a format suitable
12976 for calling org-schedule with, or if there is no scheduling,
12977 returns nil."
12978 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12979 (when time
12980 (apply 'encode-time (org-parse-time-string time)))))
12982 (defun org-get-deadline-time (pom &optional inherit)
12983 "Get the deadline as a time tuple, of a format suitable for
12984 calling org-deadline with, or if there is no scheduling, returns
12985 nil."
12986 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12987 (when time
12988 (apply 'encode-time (org-parse-time-string time)))))
12990 (defun org-remove-timestamp-with-keyword (keyword)
12991 "Remove all time stamps with KEYWORD in the current entry."
12993 beg)
12994 (save-excursion
12995 (org-back-to-heading t)
12996 (setq beg (point))
12997 (outline-next-heading)
12998 (while (re-search-backward re beg t)
12999 (replace-match "")
13001 (equal (char-before) ?\ ))
13002 (backward-delete-char 1)
13004 (point-at-bol) (point-at-eol)))
13005 (delete-region (point-at-bol)
13006 (min (point-max) (1+ (point-at-eol))))))))))
13008 (defun org-add-planning-info (what &optional time &rest remove)
13009 "Insert new timestamp with keyword in the line directly after the headline.
13010 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13011 If non is given, the user is prompted for a date.
13012 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13013 be removed."
13014 (interactive)
13015 (let (org-time-was-given org-end-time-was-given ts
13016 end default-time default-input)
13018 (catch 'exit
13019 (when (and (memq what '(scheduled deadline))
13020 (or (not time)
13021 (and (stringp time)
13022 (string-match "^[-+]+[0-9]" time))))
13023 ;; Try to get a default date/time from existing timestamp
13024 (save-excursion
13025 (org-back-to-heading t)
13026 (setq end (save-excursion (outline-next-heading) (point)))
13027 (when (re-search-forward (if (eq what 'scheduled)
13028 org-scheduled-time-regexp
13029 org-deadline-time-regexp)
13030 end t)
13031 (setq ts (match-string 1)
13032 default-time
13033 (apply 'encode-time (org-parse-time-string ts))
13034 default-input (and ts (org-get-compact-tod ts))))))
13035 (when what
13036 (setq time
13037 (if (stringp time)
13038 ;; This is a string (relative or absolute), set proper date
13039 (apply 'encode-time
13040 (org-read-date-analyze
13041 time default-time (decode-time default-time)))
13042 ;; If necessary, get the time from the user
13043 (or time (org-read-date nil 'to-time nil nil
13044 default-time default-input)))))
13046 (when (and org-insert-labeled-timestamps-at-point
13047 (member what '(scheduled deadline)))
13048 (insert
13049 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13050 (org-insert-time-stamp time org-time-was-given
13051 nil nil nil (list org-end-time-was-given))
13052 (setq what nil))
13053 (save-excursion
13054 (save-restriction
13055 (let (col list elt ts buffer-invisibility-spec)
13056 (org-back-to-heading t)
13058 (goto-char (match-end 1))
13059 (setq col (current-column))
13060 (goto-char (match-end 0))
13062 (when (and (not what)
13063 (not (looking-at
13065 org-keyword-time-not-clock-regexp))))
13066 ;; Nothing to add, nothing to remove...... :-)
13067 (throw 'exit nil))
13068 (if (and (not (looking-at org-outline-regexp))
13071 (not (equal (match-string 1) org-clock-string)))
13072 (narrow-to-region (match-beginning 0) (match-end 0))
13074 (backward-char 1)
13075 (narrow-to-region (point) (point))
13076 (and org-adapt-indentation (org-indent-to-column col)))
13077 ;; Check if we have to remove something.
13078 (setq list (cons what remove))
13079 (while list
13080 (setq elt (pop list))
13081 (when (or (and (eq elt 'scheduled)
13082 (re-search-forward org-scheduled-time-regexp nil t))
13083 (and (eq elt 'deadline)
13084 (re-search-forward org-deadline-time-regexp nil t))
13085 (and (eq elt 'closed)
13086 (re-search-forward org-closed-time-regexp nil t)))
13087 (replace-match "")
13088 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13090 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13091 (when what
13092 (insert
13093 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13094 (cond ((eq what 'scheduled) org-scheduled-string)
13095 ((eq what 'deadline) org-deadline-string)
13096 ((eq what 'closed) org-closed-string))
13097 " ")
13098 (setq ts (org-insert-time-stamp
13099 time
13100 (or org-time-was-given
13101 (and (eq what 'closed) org-log-done-with-time))
13102 (eq what 'closed)
13103 nil nil (list org-end-time-was-given)))
13104 (insert
13105 (if (not (or (bolp) (eq (char-before) ?\ )
13106 (memq (char-after) '(32 10))
13107 (eobp))) " " ""))
13108 (end-of-line 1))
13109 (goto-char (point-min))
13110 (widen)
13113 (delete-region (1- (point)) (point-at-eol)))
13114 ts))))))
13116 (defvar org-log-note-marker (make-marker))
13117 (defvar org-log-note-purpose nil)
13118 (defvar org-log-note-state nil)
13119 (defvar org-log-note-previous-state nil)
13120 (defvar org-log-note-how nil)
13121 (defvar org-log-note-extra nil)
13122 (defvar org-log-note-window-configuration nil)
13123 (defvar org-log-note-return-to (make-marker))
13124 (defvar org-log-note-effective-time nil
13125 "Remembered current time so that dynamically scoped
13126 `org-extend-today-until' affects tha timestamps in state change
13127 log")
13129 (defvar org-log-post-message nil
13130 "Message to be displayed after a log note has been stored.
13131 The auto-repeater uses this.")
13133 (defun org-add-note ()
13134 "Add a note to the current entry.
13135 This is done in the same way as adding a state change note."
13136 (interactive)
13137 (org-add-log-setup 'note nil nil 'findpos nil))
13139 (defvar org-property-end-re)
13140 (defun org-add-log-setup (&optional purpose state prev-state
13141 findpos how extra)
13142 "Set up the post command hook to take a note.
13143 If this is about to TODO state change, the new state is expected in STATE.
13144 When FINDPOS is non-nil, find the correct position for the note in
13145 the current entry. If not, assume that it can be inserted at point.
13146 HOW is an indicator what kind of note should be created.
13147 EXTRA is additional text that will be inserted into the notes buffer."
13148 (let* ((org-log-into-drawer (org-log-into-drawer))
13149 (drawer (cond ((stringp org-log-into-drawer)
13150 org-log-into-drawer)
13151 (org-log-into-drawer "LOGBOOK"))))
13152 (save-restriction
13153 (save-excursion
13154 (when findpos
13155 (org-back-to-heading t)
13156 (narrow-to-region (point) (save-excursion
13157 (outline-next-heading) (point)))
13161 (goto-char (match-end 0))
13162 (cond
13163 (drawer
13165 nil t)
13166 (progn
13167 (goto-char (match-end 0))
13168 (or org-log-states-order-reversed
13169 (and (re-search-forward org-property-end-re nil t)
13170 (goto-char (1- (match-beginning 0))))))
13172 (beginning-of-line 0)
13173 (org-indent-line)
13174 (beginning-of-line 2)
13175 (org-indent-line)
13176 (end-of-line 0)))
13177 ((and org-log-state-notes-insert-after-drawers
13178 (save-excursion
13179 (forward-line) (looking-at org-drawer-regexp)))
13180 (forward-line)
13181 (while (looking-at org-drawer-regexp)
13182 (goto-char (match-end 0))
13183 (re-search-forward org-property-end-re (point-max) t)
13184 (forward-line))
13185 (forward-line -1)))
13186 (unless org-log-states-order-reversed
13188 (org-skip-over-state-notes)
13190 (move-marker org-log-note-marker (point))
13191 (setq org-log-note-purpose purpose
13192 org-log-note-state state
13193 org-log-note-previous-state prev-state
13194 org-log-note-how how
13195 org-log-note-extra extra
13196 org-log-note-effective-time (org-current-effective-time))
13197 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13199 (defun org-skip-over-state-notes ()
13200 "Skip past the list of State notes in an entry."
13202 (when (ignore-errors (goto-char (org-in-item-p)))
13203 (let* ((struct (org-list-struct))
13204 (prevs (org-list-prevs-alist struct)))
13206 (goto-char (or (org-list-get-next-item (point) struct prevs)
13207 (org-list-get-item-end (point) struct)))))))
13209 (defun org-add-log-note (&optional purpose)
13210 "Pop up a window for taking a note, and add this note later at point."
13211 (remove-hook 'post-command-hook 'org-add-log-note)
13212 (setq org-log-note-window-configuration (current-window-configuration))
13213 (delete-other-windows)
13214 (move-marker org-log-note-return-to (point))
13215 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13216 (goto-char org-log-note-marker)
13217 (org-switch-to-buffer-other-window "*Org Note*")
13218 (erase-buffer)
13219 (if (memq org-log-note-how '(time state))
13220 (let (current-prefix-arg) (org-store-log-note))
13221 (let ((org-inhibit-startup t)) (org-mode))
13222 (insert (format "# Insert note for %s.
13224 (cond
13225 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13226 ((eq org-log-note-purpose 'done) "closed todo item")
13227 ((eq org-log-note-purpose 'state)
13229 (or org-log-note-previous-state "")
13230 (or org-log-note-state "")))
13231 ((eq org-log-note-purpose 'reschedule)
13232 "rescheduling")
13233 ((eq org-log-note-purpose 'delschedule)
13234 "no longer scheduled")
13235 ((eq org-log-note-purpose 'redeadline)
13236 "changing deadline")
13237 ((eq org-log-note-purpose 'deldeadline)
13238 "removing deadline")
13239 ((eq org-log-note-purpose 'refile)
13240 "refiling")
13241 ((eq org-log-note-purpose 'note)
13242 "this entry")
13243 (t (error "This should not happen")))))
13244 (if org-log-note-extra (insert org-log-note-extra))
13245 (org-set-local 'org-finish-function 'org-store-log-note)
13246 (run-hooks 'org-log-buffer-setup-hook)))
13248 (defvar org-note-abort nil) ; dynamically scoped
13249 (defun org-store-log-note ()
13250 "Finish taking a log note, and insert it to where it belongs."
13251 (let ((txt (buffer-string)))
13252 (kill-buffer (current-buffer))
13253 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13254 lines ind bul)
13256 (setq txt (replace-match "" t t txt)))
13258 (setq txt (replace-match "" t t txt)))
13261 (setq note
13262 (org-replace-escapes
13263 note
13264 (list (cons "%u" (user-login-name))
13265 (cons "%U" user-full-name)
13266 (cons "%t" (format-time-string
13267 (org-time-stamp-format 'long 'inactive)
13268 org-log-note-effective-time))
13269 (cons "%T" (format-time-string
13270 (org-time-stamp-format 'long nil)
13271 org-log-note-effective-time))
13272 (cons "%d" (format-time-string
13273 (org-time-stamp-format nil 'inactive)
13274 org-log-note-effective-time))
13275 (cons "%D" (format-time-string
13276 (org-time-stamp-format nil nil)
13277 org-log-note-effective-time))
13278 (cons "%s" (if org-log-note-state
13280 ""))
13281 (cons "%S" (if org-log-note-previous-state
13285 (push note lines))
13286 (when (or current-prefix-arg org-note-abort)
13287 (when org-log-into-drawer
13288 (org-remove-empty-drawer-at
13289 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13290 org-log-note-marker))
13291 (setq lines nil))
13292 (when lines
13293 (with-current-buffer (marker-buffer org-log-note-marker)
13294 (save-excursion
13295 (goto-char org-log-note-marker)
13296 (move-marker org-log-note-marker nil)
13297 (end-of-line 1)
13299 (setq ind (save-excursion
13300 (if (ignore-errors (goto-char (org-in-item-p)))
13301 (let ((struct (org-list-struct)))
13302 (org-list-get-ind
13303 (org-list-get-top-point struct) struct))
13305 (cond
13306 ((and (org-at-heading-p)
13307 org-adapt-indentation)
13308 (1+ (org-current-level)))
13309 ((org-at-heading-p) 0)
13310 (t (org-get-indentation))))))
13311 (setq bul (org-list-bullet-string "-"))
13312 (org-indent-line-to ind)
13313 (insert bul (pop lines))
13314 (let ((ind-body (+ (length bul) ind)))
13315 (while lines
13317 (org-indent-line-to ind-body)
13318 (insert (pop lines))))
13319 (message "Note stored")
13320 (org-back-to-heading t)
13321 (org-cycle-hide-drawers 'children))
13322 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13323 ;; from within `org-add-log-note' because `buffer-undo-list'
13324 ;; is then modified outside of `org-with-remote-undo'.
13325 (when (eq this-command 'org-agenda-todo)
13326 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13327 ;; Don't add undo information when called from `org-agenda-todo'
13328 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13329 (set-window-configuration org-log-note-window-configuration)
13330 (with-current-buffer (marker-buffer org-log-note-return-to)
13331 (goto-char org-log-note-return-to))
13332 (move-marker org-log-note-return-to nil)
13333 (and org-log-post-message (message "%s" org-log-post-message))))
13335 (defun org-remove-empty-drawer-at (drawer pos)
13336 "Remove an empty drawer DRAWER at position POS.
13337 POS may also be a marker."
13338 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13339 (save-excursion
13340 (save-restriction
13341 (widen)
13342 (goto-char pos)
13343 (if (org-in-regexp
13345 (replace-match ""))))))
13347 (defvar org-ts-type nil)
13348 (defun org-sparse-tree (&optional arg type)
13349 "Create a sparse tree, prompt for the details.
13350 This command can create sparse trees. You first need to select the type
13351 of match used to create the tree:
13353 t Show all TODO entries.
13354 T Show entries with a specific TODO keyword.
13355 m Show entries selected by a tags/property match.
13356 p Enter a property name and its value (both with completion on existing
13357 names/values) and show entries with that property.
13358 r Show entries matching a regular expression (`/' can be used as well).
13359 b Show deadlines and scheduled items before a date.
13360 a Show deadlines and scheduled items after a date.
13361 d Show deadlines due within `org-deadline-warning-days'.
13362 D Show deadlines and scheduled items between a date range."
13363 (interactive "P")
13364 (let (ans kwd value ts-type)
13365 (setq type (or type org-sparse-tree-default-date-type))
13366 (setq org-ts-type type)
13367 (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"
13368 (cond ((eq type 'all) "all timestamps")
13369 ((eq type 'scheduled) "only scheduled")
13370 ((eq type 'deadline) "only deadline")
13371 ((eq type 'active) "only active timestamps")
13372 ((eq type 'inactive) "only inactive timestamps")
13373 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13374 ((eq type 'closed) "with a closed time-stamp")
13375 (t "scheduled/deadline")))
13376 (setq ans (read-char-exclusive))
13377 (cond
13378 ((equal ans ?c)
13379 (org-sparse-tree
13380 arg (cadr (member type '(scheduled-or-deadline
13381 all scheduled deadline active inactive closed)))))
13382 ((equal ans ?d)
13383 (call-interactively 'org-check-deadlines))
13384 ((equal ans ?b)
13385 (call-interactively 'org-check-before-date))
13386 ((equal ans ?a)
13387 (call-interactively 'org-check-after-date))
13388 ((equal ans ?D)
13389 (call-interactively 'org-check-dates-range))
13390 ((equal ans ?t)
13391 (call-interactively 'org-show-todo-tree))
13392 ((equal ans ?T)
13393 (org-show-todo-tree '(4)))
13394 ((member ans '(?T ?m))
13395 (call-interactively 'org-match-sparse-tree))
13396 ((member ans '(?p ?P))
13397 (setq kwd (org-icompleting-read "Property: "
13398 (mapcar 'list (org-buffer-property-keys))))
13399 (setq value (org-icompleting-read "Value: "
13400 (mapcar 'list (org-property-values kwd))))
13403 (org-match-sparse-tree arg (concat kwd "=" value)))
13404 ((member ans '(?r ?R ?/))
13405 (call-interactively 'org-occur))
13408 (defvar org-occur-highlights nil
13409 "List of overlays used for occur matches.")
13410 (make-variable-buffer-local 'org-occur-highlights)
13411 (defvar org-occur-parameters nil
13412 "Parameters of the active org-occur calls.
13413 This is a list, each call to org-occur pushes as cons cell,
13414 containing the regular expression and the callback, onto the list.
13415 The list can contain several entries if `org-occur' has been called
13416 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13417 will only contain one set of parameters. When the highlights are
13418 removed (for example with `C-c C-c', or with the next edit (depending
13419 on `org-remove-highlights-with-change'), this variable is emptied
13420 as well.")
13421 (make-variable-buffer-local 'org-occur-parameters)
13423 (defun org-occur (regexp &optional keep-previous callback)
13424 "Make a compact tree which shows all matches of REGEXP.
13425 The tree will show the lines where the regexp matches, and all higher
13426 headlines above the match. It will also show the heading after the match,
13427 to make sure editing the matching entry is easy.
13428 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13429 call to `org-occur' will be kept, to allow stacking of calls to this
13430 command.
13431 If CALLBACK is non-nil, it is a function which is called to confirm
13432 that the match should indeed be shown."
13434 (when (equal regexp "")
13435 (error "Regexp cannot be empty"))
13436 (unless keep-previous
13437 (org-remove-occur-highlights nil nil t))
13438 (push (cons regexp callback) org-occur-parameters)
13439 (let ((cnt 0))
13440 (save-excursion
13441 (goto-char (point-min))
13442 (if (or (not keep-previous) ; do not want to keep
13443 (not org-occur-highlights)) ; no previous matches
13444 ;; hide everything
13445 (org-overview))
13446 (while (re-search-forward regexp nil t)
13447 (when (or (not callback)
13448 (save-match-data (funcall callback)))
13449 (setq cnt (1+ cnt))
13450 (when org-highlight-sparse-tree-matches
13451 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13452 (org-show-context 'occur-tree))))
13453 (when org-remove-highlights-with-change
13454 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13455 nil 'local))
13456 (unless org-sparse-tree-open-archived-trees
13457 (org-hide-archived-subtrees (point-min) (point-max)))
13458 (run-hooks 'org-occur-hook)
13459 (if (org-called-interactively-p 'interactive)
13460 (message "%d match(es) for regexp %s" cnt regexp))
13461 cnt))
13463 (defun org-occur-next-match (&optional n reset)
13464 "Function for `next-error-function' to find sparse tree matches.
13465 N is the number of matches to move, when negative move backwards.
13466 RESET is entirely ignored - this function always goes back to the
13467 starting point when no match is found."
13468 (let* ((limit (if (< n 0) (point-min) (point-max)))
13469 (search-func (if (< n 0)
13470 'previous-single-char-property-change
13471 'next-single-char-property-change))
13472 (n (abs n))
13473 (pos (point))
13474 p1)
13475 (catch 'exit
13476 (while (setq p1 (funcall search-func (point) 'org-type))
13477 (when (equal p1 limit)
13478 (goto-char pos)
13479 (error "No more matches"))
13480 (when (equal (get-char-property p1 'org-type) 'org-occur)
13481 (setq n (1- n))
13482 (when (= n 0)
13483 (goto-char p1)
13484 (throw 'exit (point))))
13485 (goto-char p1))
13486 (goto-char p1)
13487 (error "No more matches"))))
13489 (defun org-show-context (&optional key)
13490 "Make sure point and context are visible.
13491 How much context is shown depends upon the variables
13492 `org-show-hierarchy-above', `org-show-following-heading',
13493 `org-show-entry-below' and `org-show-siblings'."
13494 (let ((heading-p (org-at-heading-p t))
13495 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13496 (following-p (org-get-alist-option org-show-following-heading key))
13497 (entry-p (org-get-alist-option org-show-entry-below key))
13498 (siblings-p (org-get-alist-option org-show-siblings key)))
13499 ;; Show heading or entry text
13500 (if (and heading-p (not entry-p))
13501 (org-flag-heading nil) ; only show the heading
13502 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13503 (org-show-hidden-entry))) ; show entire entry
13504 (when following-p
13505 ;; Show next sibling, or heading below text
13506 (save-excursion
13507 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13508 (org-flag-heading nil))))
13509 (when siblings-p (org-show-siblings))
13510 (when hierarchy-p
13511 ;; show all higher headings, possibly with siblings
13512 (save-excursion
13513 (while (and (condition-case nil
13514 (progn (org-up-heading-all 1) t)
13515 (error nil))
13516 (not (bobp)))
13517 (org-flag-heading nil)
13518 (when siblings-p (org-show-siblings)))))
13519 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13521 (defvar org-reveal-start-hook nil
13522 "Hook run before revealing a location.")
13524 (defun org-reveal (&optional siblings)
13525 "Show current entry, hierarchy above it, and the following headline.
13526 This can be used to show a consistent set of context around locations
13527 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13528 not t for the search context.
13530 With optional argument SIBLINGS, on each level of the hierarchy all
13531 siblings are shown. This repairs the tree structure to what it would
13532 look like when opened with hierarchical calls to `org-cycle'.
13534 go to the parent and show the
13535 entire tree."
13536 (interactive "P")
13537 (run-hooks 'org-reveal-start-hook)
13538 (let ((org-show-hierarchy-above t)
13539 (org-show-following-heading t)
13540 (org-show-siblings (if siblings t org-show-siblings)))
13541 (org-show-context nil))
13542 (when (equal siblings '(16))
13543 (save-excursion
13544 (when (org-up-heading-safe)
13545 (org-show-subtree)
13546 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13548 (defun org-highlight-new-match (beg end)
13549 "Highlight from BEG to END and mark the highlight is an occur headline."
13550 (let ((ov (make-overlay beg end)))
13551 (overlay-put ov 'face 'secondary-selection)
13552 (overlay-put ov 'org-type 'org-occur)
13553 (push ov org-occur-highlights)))
13555 (defun org-remove-occur-highlights (&optional beg end noremove)
13556 "Remove the occur highlights from the buffer.
13557 BEG and END are ignored. If NOREMOVE is nil, remove this function
13558 from the `before-change-functions' in the current buffer."
13559 (interactive)
13560 (unless org-inhibit-highlight-removal
13561 (mapc 'delete-overlay org-occur-highlights)
13562 (setq org-occur-highlights nil)
13563 (setq org-occur-parameters nil)
13564 (unless noremove
13565 (remove-hook 'before-change-functions
13566 'org-remove-occur-highlights 'local))))
13568 ;;;; Priorities
13571 "Regular expression matching the priority indicator.")
13573 (defvar org-remove-priority-next-time nil)
13575 (defun org-priority-up ()
13576 "Increase the priority of the current item."
13577 (interactive)
13578 (org-priority 'up))
13580 (defun org-priority-down ()
13581 "Decrease the priority of the current item."
13582 (interactive)
13583 (org-priority 'down))
13585 (defun org-priority (&optional action show)
13586 "Change the priority of an item.
13587 ACTION can be `set', `up', `down', or a character."
13588 (interactive "P")
13589 (if (equal action '(4))
13590 (org-show-priority)
13591 (unless org-enable-priority-commands
13592 (error "Priority commands are disabled"))
13593 (setq action (or action 'set))
13594 (let (current new news have remove)
13595 (save-excursion
13596 (org-back-to-heading t)
13597 (if (looking-at org-priority-regexp)
13598 (setq current (string-to-char (match-string 2))
13599 have t))
13600 (cond
13601 ((eq action 'remove)
13602 (setq remove t new ?\ ))
13603 ((or (eq action 'set)
13604 (if (featurep 'xemacs) (characterp action) (integerp action)))
13605 (if (not (eq action 'set))
13606 (setq new action)
13607 (message "Priority %c-%c, SPC to remove: "
13608 org-highest-priority org-lowest-priority)
13609 (save-match-data
13610 (setq new (read-char-exclusive))))
13611 (if (and (= (upcase org-highest-priority) org-highest-priority)
13612 (= (upcase org-lowest-priority) org-lowest-priority))
13613 (setq new (upcase new)))
13614 (cond ((equal new ?\ ) (setq remove t))
13615 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13616 (error "Priority must be between `%c' and `%c'"
13617 org-highest-priority org-lowest-priority))))
13618 ((eq action 'up)
13619 (setq new (if have
13620 (1- current) ; normal cycling
13621 ;; last priority was empty
13622 (if (eq last-command this-command)
13623 org-lowest-priority ; wrap around empty to lowest
13624 ;; default
13625 (if org-priority-start-cycle-with-default
13626 org-default-priority
13627 (1- org-default-priority))))))
13628 ((eq action 'down)
13629 (setq new (if have
13630 (1+ current) ; normal cycling
13631 ;; last priority was empty
13632 (if (eq last-command this-command)
13633 org-highest-priority ; wrap around empty to highest
13634 ;; default
13635 (if org-priority-start-cycle-with-default
13636 org-default-priority
13637 (1+ org-default-priority))))))
13638 (t (error "Invalid action")))
13639 (if (or (< (upcase new) org-highest-priority)
13640 (> (upcase new) org-lowest-priority))
13641 (if (and (memq action '(up down))
13642 (not have) (not (eq last-command this-command)))
13643 ;; `new' is from default priority
13644 (error
13645 "The default can not be set, see `org-default-priority' why")
13646 ;; normal cycling: `new' is beyond highest/lowest priority
13647 ;; and is wrapped around to the empty priority
13648 (setq remove t)))
13649 (setq news (format "%c" new))
13650 (if have
13651 (if remove
13652 (replace-match "" t t nil 1)
13653 (replace-match news t t nil 2))
13654 (if remove
13655 (error "No priority cookie found in line")
13656 (let ((case-fold-search nil))
13657 (looking-at org-todo-line-regexp))
13658 (if (match-end 2)
13659 (progn
13660 (goto-char (match-end 2))
13661 (insert " [#" news "]"))
13662 (goto-char (match-beginning 3))
13663 (insert "[#" news "] "))))
13664 (org-preserve-lc (org-set-tags nil 'align)))
13665 (if remove
13666 (message "Priority removed")
13667 (message "Priority of current item set to %s" news)))))
13669 (defun org-show-priority ()
13670 "Show the priority of the current item.
13671 This priority is composed of the main priority given with the [#A] cookies,
13672 and by additional input from the age of a schedules or deadline entry."
13673 (interactive)
13674 (let ((pri (if (eq major-mode 'org-agenda-mode)
13675 (org-get-at-bol 'priority)
13676 (save-excursion
13677 (save-match-data
13678 (beginning-of-line)
13679 (and (looking-at org-heading-regexp)
13680 (org-get-priority (match-string 0))))))))
13681 (message "Priority is %d" (if pri pri -1000))))
13683 (defun org-get-priority (s)
13684 "Find priority cookie and return priority."
13685 (save-match-data
13686 (if (functionp org-get-priority-function)
13687 (funcall org-get-priority-function)
13688 (if (not (string-match org-priority-regexp s))
13689 (* 1000 (- org-lowest-priority org-default-priority))
13690 (* 1000 (- org-lowest-priority
13691 (string-to-char (match-string 2 s))))))))
13693 ;;;; Tags
13695 (defvar org-agenda-archives-mode)
13696 (defvar org-map-continue-from nil
13697 "Position from where mapping should continue.
13698 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13700 (defvar org-scanner-tags nil
13701 "The current tag list while the tags scanner is running.")
13702 (defvar org-trust-scanner-tags nil
13703 "Should `org-get-tags-at' use the tags for the scanner.
13704 This is for internal dynamical scoping only.
13705 When this is non-nil, the function `org-get-tags-at' will return the value
13706 of `org-scanner-tags' instead of building the list by itself. This
13707 can lead to large speed-ups when the tags scanner is used in a file with
13708 many entries, and when the list of tags is retrieved, for example to
13709 obtain a list of properties. Building the tags list for each entry in such
13710 a file becomes an N^2 operation - but with this variable set, it scales
13711 as N.")
13713 (defun org-scan-tags (action matcher todo-only &optional start-level)
13714 "Sca headline tags with inheritance and produce output ACTION.
13716 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13717 or `agenda' to produce an entry list for an agenda view. It can also be
13718 a Lisp form or a function that should be called at each matched headline, in
13719 this case the return value is a list of all return values from these calls.
13721 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13722 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13723 only lines with a not-done TODO keyword are included in the output.
13724 This should be the same variable that was scoped into
13725 and set by `org-make-tags-matcher' when it constructed MATCHER.
13727 START-LEVEL can be a string with asterisks, reducing the scope to
13728 headlines matching this string."
13729 (require 'org-agenda)
13730 (let* ((re (concat "^"
13731 (if start-level
13732 ;; Get the correct level to match
13734 org-outline-regexp)
13738 (props (list 'face 'default
13739 'done-face 'org-agenda-done
13740 'undone-face 'default
13741 'mouse-face 'highlight
13742 'org-not-done-regexp org-not-done-regexp
13743 'org-todo-regexp org-todo-regexp
13744 'org-complex-heading-regexp org-complex-heading-regexp
13745 'help-echo
13746 (format "mouse-2 or RET jump to org file %s"
13747 (abbreviate-file-name
13748 (or (buffer-file-name (buffer-base-buffer))
13749 (buffer-name (buffer-base-buffer)))))))
13750 (case-fold-search nil)
13751 (org-map-continue-from nil)
13752 lspos tags tags-list
13753 (tags-alist (list (cons 0 org-file-tags)))
13754 (llast 0) rtn rtn1 level category i txt
13755 todo marker entry priority)
13756 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13757 (setq action (list 'lambda nil action)))
13758 (save-excursion
13759 (goto-char (point-min))
13760 (when (eq action 'sparse-tree)
13761 (org-overview)
13762 (org-remove-occur-highlights))
13763 (while (re-search-forward re nil t)
13764 (setq org-map-continue-from nil)
13765 (catch :skip
13766 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13767 tags (if (match-end 4) (org-match-string-no-properties 4)))
13768 (goto-char (setq lspos (match-beginning 0)))
13769 (setq level (org-reduced-level (org-outline-level))
13770 category (org-get-category))
13771 (setq i llast llast level)
13772 ;; remove tag lists from same and sublevels
13773 (while (>= i level)
13774 (when (setq entry (assoc i tags-alist))
13775 (setq tags-alist (delete entry tags-alist)))
13776 (setq i (1- i)))
13777 ;; add the next tags
13778 (when tags
13779 (setq tags (org-split-string tags ":")
13780 tags-alist
13781 (cons (cons level tags) tags-alist)))
13782 ;; compile tags for current headline
13783 (setq tags-list
13784 (if org-use-tag-inheritance
13785 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13786 tags)
13787 org-scanner-tags tags-list)
13788 (when org-use-tag-inheritance
13789 (setcdr (car tags-alist)
13790 (mapcar (lambda (x)
13791 (setq x (copy-sequence x))
13792 (org-add-prop-inherited x))
13793 (cdar tags-alist))))
13794 (when (and tags org-use-tag-inheritance
13795 (or (not (eq t org-use-tag-inheritance))
13796 org-tags-exclude-from-inheritance))
13797 ;; selective inheritance, remove uninherited ones
13798 (setcdr (car tags-alist)
13799 (org-remove-uninherited-tags (cdar tags-alist))))
13800 (when (and
13802 ;; eval matcher only when the todo condition is OK
13803 (and (or (not todo-only) (member todo org-not-done-keywords))
13804 (let ((case-fold-search t) (org-trust-scanner-tags t))
13805 (eval matcher)))
13807 ;; Call the skipper, but return t if it does not skip,
13808 ;; so that the `and' form continues evaluating
13809 (progn
13810 (unless (eq action 'sparse-tree) (org-agenda-skip))
13811 t)
13813 ;; Check if timestamps are deselecting this entry
13814 (or (not todo-only)
13815 (and (member todo org-not-done-keywords)
13816 (or (not org-agenda-tags-todo-honor-ignore-options)
13817 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13819 ;; select this headline
13820 (cond
13821 ((eq action 'sparse-tree)
13822 (and org-highlight-sparse-tree-matches
13823 (org-get-heading) (match-end 0)
13824 (org-highlight-new-match
13825 (match-beginning 1) (match-end 1)))
13826 (org-show-context 'tags-tree))
13827 ((eq action 'agenda)
13828 (setq txt (org-agenda-format-item
13829 ""
13830 (concat
13831 (if (eq org-tags-match-list-sublevels 'indented)
13832 (make-string (1- level) ?.) "")
13833 (org-get-heading))
13834 level category
13835 tags-list)
13836 priority (org-get-priority txt))
13837 (goto-char lspos)
13838 (setq marker (org-agenda-new-marker))
13839 (org-add-props txt props
13840 'org-marker marker 'org-hd-marker marker 'org-category category
13841 'todo-state todo
13842 'priority priority 'type "tagsmatch")
13843 (push txt rtn))
13844 ((functionp action)
13845 (setq org-map-continue-from nil)
13846 (save-excursion
13847 (setq rtn1 (funcall action))
13848 (push rtn1 rtn)))
13849 (t (error "Invalid action")))
13851 ;; if we are to skip sublevels, jump to end of subtree
13852 (unless org-tags-match-list-sublevels
13853 (org-end-of-subtree t)
13854 (backward-char 1))))
13855 ;; Get the correct position from where to continue
13856 (if org-map-continue-from
13857 (goto-char org-map-continue-from)
13858 (and (= (point) lspos) (end-of-line 1)))))
13859 (when (and (eq action 'sparse-tree)
13860 (not org-sparse-tree-open-archived-trees))
13861 (org-hide-archived-subtrees (point-min) (point-max)))
13862 (nreverse rtn)))
13864 (defun org-remove-uninherited-tags (tags)
13865 "Remove all tags that are not inherited from the list TAGS."
13866 (cond
13867 ((eq org-use-tag-inheritance t)
13868 (if org-tags-exclude-from-inheritance
13869 (org-delete-all org-tags-exclude-from-inheritance tags)
13870 tags))
13871 ((not org-use-tag-inheritance) nil)
13872 ((stringp org-use-tag-inheritance)
13873 (delq nil (mapcar
13874 (lambda (x)
13875 (if (and (string-match org-use-tag-inheritance x)
13876 (not (member x org-tags-exclude-from-inheritance)))
13877 x nil))
13878 tags)))
13879 ((listp org-use-tag-inheritance)
13880 (delq nil (mapcar
13881 (lambda (x)
13882 (if (member x org-use-tag-inheritance) x nil))
13883 tags)))))
13885 (defun org-match-sparse-tree (&optional todo-only match)
13886 "Create a sparse tree according to tags string MATCH.
13887 MATCH can contain positive and negative selection of tags, like
13889 If optional argument TODO-ONLY is non-nil, only select lines that are
13890 also TODO lines."
13891 (interactive "P")
13892 (org-agenda-prepare-buffers (list (current-buffer)))
13893 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13895 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13897 (defvar org-cached-props nil)
13898 (defun org-cached-entry-get (pom property)
13899 (if (or (eq t org-use-property-inheritance)
13900 (and (stringp org-use-property-inheritance)
13901 (string-match org-use-property-inheritance property))
13902 (and (listp org-use-property-inheritance)
13903 (member property org-use-property-inheritance)))
13904 ;; Caching is not possible, check it directly
13905 (org-entry-get pom property 'inherit)
13906 ;; Get all properties, so that we can do complicated checks easily
13907 (cdr (assoc property (or org-cached-props
13908 (setq org-cached-props
13909 (org-entry-properties pom)))))))
13911 (defun org-global-tags-completion-table (&optional files)
13912 "Return the list of all tags in all agenda buffer/files.
13913 Optional FILES argument is a list of files which can be used
13914 instead of the agenda files."
13915 (save-excursion
13916 (org-uniquify
13917 (delq nil
13918 (apply 'append
13919 (mapcar
13920 (lambda (file)
13921 (set-buffer (find-file-noselect file))
13922 (append (org-get-buffer-tags)
13923 (mapcar (lambda (x) (if (stringp (car-safe x))
13924 (list (car-safe x)) nil))
13925 org-tag-alist)))
13926 (if (and files (car files))
13927 files
13928 (org-agenda-files))))))))
13930 (defun org-make-tags-matcher (match)
13931 "Create the TAGS/TODO matcher form for the selection string MATCH.
13933 The variable `todo-only' is scoped dynamically into this function.
13934 It will be set to t if the matcher restricts matching to TODO entries,
13935 otherwise will not be touched.
13937 Returns a cons of the selection string MATCH and the constructed
13938 lisp form implementing the matcher. The matcher is to be evaluated
13939 at an Org entry, with point on the headline, and returns t if the
13940 entry matches the selection string MATCH. The returned lisp form
13941 references two variables with information about the entry, which
13942 must be bound around the form's evaluation: todo, the TODO keyword
13943 at the entry (or nil of none); and tags-list, the list of all tags
13944 at the entry including inherited ones. Additionally, the category
13945 of the entry (if any) must be specified as the text property
13946 'org-category on the headline.
13948 See also `org-scan-tags'.
13949 "
13950 (declare (special todo-only))
13951 (unless (boundp 'todo-only)
13952 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
13953 (unless match
13954 ;; Get a new match request, with completion against the global
13955 ;; tags table and the local tags in current buffer
13956 (let ((org-last-tags-completion-table
13957 (org-uniquify
13958 (delq nil (append (org-get-buffer-tags)
13959 (org-global-tags-completion-table))))))
13960 (setq match (org-completing-read-no-i
13961 "Match: " 'org-tags-completion-function nil nil nil
13962 'org-tags-history))))
13964 ;; Parse the string and create a lisp form
13965 (let ((match0 match)
13966 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13967 minus tag mm
13968 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13969 orterms term orlist re-p str-p level-p level-op time-p
13970 prop-p pn pv po gv rest)
13971 ;; Expand group tags
13972 (setq match (org-tags-expand match))
13973 (if (string-match "/+" match)
13974 ;; match contains also a todo-matching request
13975 (progn
13976 (setq tagsmatch (substring match 0 (match-beginning 0))
13977 todomatch (substring match (match-end 0)))
13978 (if (string-match "^!" todomatch)
13979 (setq todo-only t todomatch (substring todomatch 1)))
13981 (setq todomatch nil)))
13982 ;; only matching tags
13983 (setq tagsmatch match todomatch nil))
13985 ;; Make the tags matcher
13987 (setq tagsmatcher t)
13988 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13989 (while (setq term (pop orterms))
13991 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13992 (while (string-match re term)
13993 (setq rest (substring term (match-end 0))
13994 minus (and (match-end 1)
13995 (equal (match-string 1 term) "-"))
13996 tag (save-match-data (replace-regexp-in-string
13998 (match-string 2 term)))
13999 re-p (equal (string-to-char tag) ?{)
14000 level-p (match-end 4)
14001 prop-p (match-end 5)
14002 mm (cond
14003 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14004 (level-p
14005 (setq level-op (org-op-to-function (match-string 3 term)))
14006 `(,level-op level ,(string-to-number
14007 (match-string 4 term))))
14008 (prop-p
14009 (setq pn (match-string 5 term)
14010 po (match-string 6 term)
14011 pv (match-string 7 term)
14012 re-p (equal (string-to-char pv) ?{)
14014 time-p (save-match-data
14016 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14017 (if time-p (setq pv (org-matcher-time pv)))
14018 (setq po (org-op-to-function po (if time-p 'time str-p)))
14019 (cond
14020 ((equal pn "CATEGORY")
14021 (setq gv '(get-text-property (point) 'org-category)))
14022 ((equal pn "TODO")
14023 (setq gv 'todo))
14024 (t
14025 (setq gv `(org-cached-entry-get nil ,pn))))
14026 (if re-p
14027 (if (eq po 'org<>)
14028 `(not (string-match ,pv (or ,gv "")))
14029 `(string-match ,pv (or ,gv "")))
14030 (if str-p
14031 `(,po (or ,gv "") ,pv)
14032 `(,po (string-to-number (or ,gv ""))
14033 ,(string-to-number pv) ))))
14034 (t `(member ,tag tags-list)))
14035 mm (if minus (list 'not mm) mm)
14036 term rest)
14037 (push mm tagsmatcher))
14038 (push (if (> (length tagsmatcher) 1)
14039 (cons 'and tagsmatcher)
14040 (car tagsmatcher))
14041 orlist)
14042 (setq tagsmatcher nil))
14043 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14044 (setq tagsmatcher
14045 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14046 ;; Make the todo matcher
14048 (setq todomatcher t)
14049 (setq orterms (org-split-string todomatch "|") orlist nil)
14050 (while (setq term (pop orterms))
14051 (while (string-match re term)
14052 (setq minus (and (match-end 1)
14053 (equal (match-string 1 term) "-"))
14054 kwd (match-string 2 term)
14055 re-p (equal (string-to-char kwd) ?{)
14056 term (substring term (match-end 0))
14057 mm (if re-p
14058 `(string-match ,(substring kwd 1 -1) todo)
14059 (list 'equal 'todo kwd))
14060 mm (if minus (list 'not mm) mm))
14061 (push mm todomatcher))
14062 (push (if (> (length todomatcher) 1)
14063 (cons 'and todomatcher)
14064 (car todomatcher))
14065 orlist)
14066 (setq todomatcher nil))
14067 (setq todomatcher (if (> (length orlist) 1)
14068 (cons 'or orlist) (car orlist))))
14070 ;; Return the string and lisp forms of the matcher
14071 (setq matcher (if todomatcher
14072 (list 'and tagsmatcher todomatcher)
14073 tagsmatcher))
14074 (when todo-only
14075 (setq matcher (list 'and '(member todo org-not-done-keywords)
14076 matcher)))
14077 (cons match0 matcher)))
14079 (defun org-tags-expand (match &optional single-as-list downcased)
14080 "Expand group tags in MATCH.
14082 This replaces every group tag in MATCH with a regexp tag search.
14084 will be replaced like this:
14090 Replacing by a regexp preserves the structure of the match.
14091 E.g., this expansion
14098 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14099 assumed to be a single group tag, and the function will return
14100 the list of tags in this group.
14102 When DOWNCASE is non-nil, expand downcased TAGS."
14103 (if org-group-tags
14104 (let* ((case-fold-search t)
14105 (stable org-mode-syntax-table)
14106 (tal (or org-tag-groups-alist-for-agenda
14107 org-tag-groups-alist))
14108 (tal (if downcased
14109 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14110 (tml (mapcar 'car tal))
14111 (rtnmatch match) rpl)
14112 ;; @ and _ are allowed as word-components in tags
14113 (modify-syntax-entry ?@ "w" stable)
14114 (modify-syntax-entry ?_ "w" stable)
14115 (while (and tml
14116 (string-match
14119 (let* ((dir (match-string 1 rtnmatch))
14120 (tag (match-string 2 rtnmatch))
14121 (tag (if downcased (downcase tag) tag)))
14122 (setq tml (delete tag tml))
14123 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14124 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14126 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14127 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14128 (if single-as-list
14129 (or (reverse rpl) (list rtnmatch))
14130 rtnmatch))
14131 (if single-as-list (list (if downcased (downcase match) match))
14132 match)))
14134 (defun org-op-to-function (op &optional stringp)
14135 "Turn an operator into the appropriate function."
14136 (setq op
14137 (cond
14138 ((equal op "<" ) '(< string< org-time<))
14139 ((equal op ">" ) '(> org-string> org-time>))
14140 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14141 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14142 ((member op '("=" "==")) '(= string= org-time=))
14143 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14144 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14146 (defun org<> (a b) (not (= a b)))
14147 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14148 (defun org-string>= (a b) (not (string< a b)))
14149 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14150 (defun org-string<> (a b) (not (string= 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) (> a b)))
14155 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14156 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14157 (defun org-2ft (s)
14158 "Convert S to a floating point time.
14159 If S is already a number, just return it. If it is a string, parse
14160 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14161 (cond
14162 ((numberp s) s)
14163 ((stringp s)
14164 (condition-case nil
14165 (float-time (apply 'encode-time (org-parse-time-string s)))
14166 (error 0.)))
14167 (t 0.)))
14169 (defun org-time-today ()
14170 "Time in seconds today at 0:00.
14171 Returns the float number of seconds since the beginning of the
14172 epoch to the beginning of today (00:00)."
14173 (float-time (apply 'encode-time
14174 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14176 (defun org-matcher-time (s)
14177 "Interpret a time comparison value."
14178 (save-match-data
14179 (cond
14180 ((string= s "<now>") (float-time))
14181 ((string= s "<today>") (org-time-today))
14182 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14183 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14185 (+ (org-time-today)
14186 (* (string-to-number (match-string 1 s))
14187 (cdr (assoc (match-string 2 s)
14188 '(("d" . 86400.0) ("w" . 604800.0)
14189 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14190 (t (org-2ft s)))))
14192 (defun org-match-any-p (re list)
14193 "Does re match any element of list?"
14194 (setq list (mapcar (lambda (x) (string-match re x)) list))
14195 (delq nil list))
14197 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14198 (defvar org-tags-overlay (make-overlay 1 1))
14199 (org-detach-overlay org-tags-overlay)
14201 (defun org-get-local-tags-at (&optional pos)
14202 "Get a list of tags defined in the current headline."
14203 (org-get-tags-at pos 'local))
14205 (defun org-get-local-tags ()
14206 "Get a list of tags defined in the current headline."
14207 (org-get-tags-at nil 'local))
14209 (defun org-get-tags-at (&optional pos local)
14210 "Get a list of all headline tags applicable at POS.
14211 POS defaults to point. If tags are inherited, the list contains
14212 the targets in the same sequence as the headlines appear, i.e.
14213 the tags of the current headline come last.
14214 When LOCAL is non-nil, only return tags from the current headline,
14215 ignore inherited ones."
14216 (interactive)
14217 (if (and org-trust-scanner-tags
14218 (or (not pos) (equal pos (point)))
14219 (not local))
14220 org-scanner-tags
14221 (let (tags ltags lastpos parent)
14222 (save-excursion
14223 (save-restriction
14224 (widen)
14225 (goto-char (or pos (point)))
14226 (save-match-data
14227 (catch 'done
14228 (condition-case nil
14229 (progn
14230 (org-back-to-heading t)
14231 (while (not (equal lastpos (point)))
14232 (setq lastpos (point))
14233 (when (looking-at
14235 (setq ltags (org-split-string
14236 (org-match-string-no-properties 1) ":"))
14237 (when parent
14238 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14239 (setq tags (append
14240 (if parent
14241 (org-remove-uninherited-tags ltags)
14242 ltags)
14243 tags)))
14244 (or org-use-tag-inheritance (throw 'done t))
14245 (if local (throw 'done t))
14246 (or (org-up-heading-safe) (error nil))
14247 (setq parent t)))
14248 (error nil)))))
14249 (if local
14250 tags
14251 (reverse (delete-dups
14252 (reverse (append
14253 (org-remove-uninherited-tags
14254 org-file-tags) tags)))))))))
14256 (defun org-add-prop-inherited (s)
14257 (add-text-properties 0 (length s) '(inherited t) s)
14258 s)
14260 (defun org-toggle-tag (tag &optional onoff)
14261 "Toggle the tag TAG for the current line.
14262 If ONOFF is `on' or `off', don't toggle but set to this state."
14263 (let (res current)
14264 (save-excursion
14265 (org-back-to-heading t)
14267 (point-at-eol) t)
14268 (progn
14269 (setq current (match-string 1))
14270 (replace-match ""))
14271 (setq current ""))
14272 (setq current (nreverse (org-split-string current ":")))
14273 (cond
14274 ((eq onoff 'on)
14275 (setq res t)
14276 (or (member tag current) (push tag current)))
14277 ((eq onoff 'off)
14278 (or (not (member tag current)) (setq current (delete tag current))))
14279 (t (if (member tag current)
14280 (setq current (delete tag current))
14281 (setq res t)
14282 (push tag current))))
14283 (end-of-line 1)
14284 (if current
14285 (progn
14286 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14287 (org-set-tags nil t))
14288 (delete-horizontal-space))
14289 (run-hooks 'org-after-tags-change-hook))
14290 res))
14292 (defun org-align-tags-here (to-col)
14293 ;; Assumes that this is a headline
14294 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14295 (beginning-of-line 1)
14297 (< pos (match-beginning 2)))
14298 (progn
14299 (setq tags-l (- (match-end 2) (match-beginning 2)))
14300 (goto-char (match-beginning 1))
14301 (insert " ")
14302 (delete-region (point) (1+ (match-beginning 2)))
14303 (setq ncol (max (current-column)
14304 (1+ col)
14305 (if (> to-col 0)
14306 to-col
14307 (- (abs to-col) tags-l))))
14308 (setq p (point))
14309 (insert (make-string (- ncol (current-column)) ?\ ))
14310 (setq ncol (current-column))
14311 (when indent-tabs-mode (tabify p (point-at-eol)))
14312 (org-move-to-column (min ncol col) t))
14313 (goto-char pos))))
14315 (defun org-set-tags-command (&optional arg just-align)
14316 "Call the set-tags command for the current entry."
14317 (interactive "P")
14318 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14319 (org-set-tags arg just-align)
14320 (save-excursion
14321 (unless (and (org-region-active-p)
14322 org-loop-over-headlines-in-active-region)
14323 (org-back-to-heading t))
14324 (org-set-tags arg just-align))))
14326 (defun org-set-tags-to (data)
14327 "Set the tags of the current entry to DATA, replacing the current tags.
14328 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14329 If DATA is nil or the empty string, any tags will be removed."
14330 (interactive "sTags: ")
14331 (setq data
14332 (cond
14333 ((eq data nil) "")
14334 ((equal data "") "")
14335 ((stringp data)
14336 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14337 ":"))
14338 ((listp data)
14339 (concat ":" (mapconcat 'identity data ":") ":"))))
14340 (when data
14341 (save-excursion
14342 (org-back-to-heading t)
14343 (when (looking-at org-complex-heading-regexp)
14344 (if (match-end 5)
14345 (progn
14346 (goto-char (match-beginning 5))
14347 (insert data)
14348 (delete-region (point) (point-at-eol))
14349 (org-set-tags nil 'align))
14350 (goto-char (point-at-eol))
14351 (insert " " data)
14352 (org-set-tags nil 'align)))
14353 (beginning-of-line 1)
14355 (delete-region (match-beginning 1) (match-end 1))))))
14357 (defun org-align-all-tags ()
14358 "Align the tags i all headings."
14359 (interactive)
14360 (save-excursion
14361 (or (ignore-errors (org-back-to-heading t))
14362 (outline-next-heading))
14363 (if (org-at-heading-p)
14364 (org-set-tags t)
14365 (message "No headings"))))
14367 (defvar org-indent-indentation-per-level)
14368 (defun org-set-tags (&optional arg just-align)
14369 "Set the tags for the current headline.
14370 With prefix ARG, realign all tags in headings in the current buffer."
14371 (interactive "P")
14372 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14373 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14374 'region-start-level 'region))
14375 org-loop-over-headlines-in-active-region)
14376 (org-map-entries
14377 ;; We don't use ARG and JUST-ALIGN here these args are not
14378 ;; useful when looping over headlines
14379 `(org-set-tags)
14380 org-loop-over-headlines-in-active-region
14381 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14382 (let* ((re org-outline-regexp-bol)
14383 (current (unless arg (org-get-tags-string)))
14384 (col (current-column))
14385 (org-setting-tags t)
14386 table current-tags inherited-tags ; computed below when needed
14387 tags p0 c0 c1 rpl di tc level)
14388 (if arg
14389 (save-excursion
14390 (goto-char (point-min))
14391 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14392 (while (re-search-forward re nil t)
14393 (org-set-tags nil t)
14394 (end-of-line 1)))
14395 (message "All tags realigned to column %d" org-tags-column))
14396 (if just-align
14397 (setq tags current)
14398 ;; Get a new set of tags from the user
14399 (save-excursion
14400 (setq table (append org-tag-persistent-alist
14401 (or org-tag-alist (org-get-buffer-tags))
14402 (and
14403 org-complete-tags-always-offer-all-agenda-tags
14404 (org-global-tags-completion-table
14405 (org-agenda-files))))
14406 org-last-tags-completion-table table
14407 current-tags (org-split-string current ":")
14408 inherited-tags (nreverse
14409 (nthcdr (length current-tags)
14410 (nreverse (org-get-tags-at))))
14411 tags
14412 (if (or (eq t org-use-fast-tag-selection)
14413 (and org-use-fast-tag-selection
14414 (delq nil (mapcar 'cdr table))))
14415 (org-fast-tag-selection
14416 current-tags inherited-tags table
14417 (if org-fast-tag-selection-include-todo
14418 org-todo-key-alist))
14419 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14420 (org-trim
14421 (org-icompleting-read "Tags: "
14422 'org-tags-completion-function
14423 nil nil current 'org-tags-history))))))
14424 (while (string-match "[-+&]+" tags)
14425 ;; No boolean logic, just a list
14426 (setq tags (replace-match ":" t t tags))))
14428 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14430 (if org-tags-sort-function
14431 (setq tags (mapconcat 'identity
14432 (sort (org-split-string
14433 tags (org-re "[^[:alnum:]_@#%]+"))
14434 org-tags-sort-function) ":")))
14437 (setq tags "")
14438 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14439 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14441 ;; Insert new tags at the correct column
14442 (beginning-of-line 1)
14443 (setq level (or (and (looking-at org-outline-regexp)
14444 (- (match-end 0) (point) 1))
14445 1))
14446 (cond
14447 ((and (equal current "") (equal tags "")))
14448 ((re-search-forward
14450 (point-at-eol) t)
14451 (if (equal tags "")
14452 (setq rpl "")
14453 (goto-char (match-beginning 0))
14454 (setq c0 (current-column)
14455 ;; compute offset for the case of org-indent-mode active
14456 di (if org-indent-mode
14457 (* (1- org-indent-indentation-per-level) (1- level))
14458 0)
14459 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14460 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14461 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14462 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14463 (replace-match rpl t t)
14464 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14465 tags)
14466 (t (error "Tags alignment failed")))
14467 (org-move-to-column col)
14468 (unless just-align
14469 (run-hooks 'org-after-tags-change-hook))))))
14471 (defun org-change-tag-in-region (beg end tag off)
14472 "Add or remove TAG for each entry in the region.
14473 This works in the agenda, and also in an org-mode buffer."
14474 (interactive
14475 (list (region-beginning) (region-end)
14476 (let ((org-last-tags-completion-table
14477 (if (derived-mode-p 'org-mode)
14478 (org-uniquify
14479 (delq nil (append (org-get-buffer-tags)
14480 (org-global-tags-completion-table))))
14481 (org-global-tags-completion-table))))
14482 (org-icompleting-read
14483 "Tag: " 'org-tags-completion-function nil nil nil
14484 'org-tags-history))
14485 (progn
14487 (equal (read-char-exclusive) ?r))))
14488 (if (fboundp 'deactivate-mark) (deactivate-mark))
14489 (let ((agendap (equal major-mode 'org-agenda-mode))
14490 l1 l2 m buf pos newhead (cnt 0))
14491 (goto-char end)
14492 (setq l2 (1- (org-current-line)))
14493 (goto-char beg)
14494 (setq l1 (org-current-line))
14495 (loop for l from l1 to l2 do
14496 (org-goto-line l)
14497 (setq m (get-text-property (point) 'org-hd-marker))
14498 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14499 (and agendap m))
14500 (setq buf (if agendap (marker-buffer m) (current-buffer))
14501 pos (if agendap m (point)))
14502 (with-current-buffer buf
14503 (save-excursion
14504 (save-restriction
14505 (goto-char pos)
14506 (setq cnt (1+ cnt))
14507 (org-toggle-tag tag (if off 'off 'on))
14508 (setq newhead (org-get-heading)))))
14509 (and agendap (org-agenda-change-all-lines newhead m))))
14510 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14512 (defun org-tags-completion-function (string predicate &optional flag)
14513 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14514 (confirm (lambda (x) (stringp (car x)))))
14516 (setq s1 (match-string 1 string)
14517 s2 (match-string 2 string))
14518 (setq s1 "" s2 string))
14519 (cond
14520 ((eq flag nil)
14521 ;; try completion
14522 (setq rtn (try-completion s2 ctable confirm))
14523 (if (stringp rtn)
14524 (setq rtn
14525 (concat s1 s2 (substring rtn (length s2))
14526 (if (and org-add-colon-after-tag-completion
14527 (assoc rtn ctable))
14528 ":" ""))))
14529 rtn)
14530 ((eq flag t)
14531 ;; all-completions
14532 (all-completions s2 ctable confirm))
14533 ((eq flag 'lambda)
14534 ;; exact match?
14535 (assoc s2 ctable)))))
14537 (defun org-fast-tag-insert (kwd tags face &optional end)
14538 "Insert KDW, and the TAGS, the latter with face FACE.
14539 Also insert END."
14540 (insert (format "%-12s" (concat kwd ":"))
14541 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14542 (or end "")))
14544 (defun org-fast-tag-show-exit (flag)
14545 (save-excursion
14546 (org-goto-line 3)
14548 (replace-match ""))
14549 (when flag
14550 (end-of-line 1)
14551 (org-move-to-column (- (window-width) 19) t)
14552 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14554 (defun org-set-current-tags-overlay (current prefix)
14555 "Add an overlay to CURRENT tag with PREFIX."
14556 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14557 (if (featurep 'xemacs)
14558 (org-overlay-display org-tags-overlay (concat prefix s)
14559 'secondary-selection)
14560 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14561 (org-overlay-display org-tags-overlay (concat prefix s)))))
14563 (defvar org-last-tag-selection-key nil)
14564 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14565 "Fast tag selection with single keys.
14566 CURRENT is the current list of tags in the headline, INHERITED is the
14567 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14568 possibly with grouping information. TODO-TABLE is a similar table with
14569 TODO keywords, should these have keys assigned to them.
14570 If the keys are nil, a-z are automatically assigned.
14571 Returns the new tags string, or nil to not change the current settings."
14572 (let* ((fulltable (append table todo-table))
14573 (maxlen (apply 'max (mapcar
14574 (lambda (x)
14575 (if (stringp (car x)) (string-width (car x)) 0))
14576 fulltable)))
14577 (buf (current-buffer))
14578 (expert (eq org-fast-tag-selection-single-key 'expert))
14579 (buffer-tags nil)
14580 (fwidth (+ maxlen 3 1 3))
14581 (ncol (/ (- (window-width) 4) fwidth))
14582 (i-face 'org-done)
14583 (c-face 'org-todo)
14584 tg cnt e c char c1 c2 ntable tbl rtn
14585 ov-start ov-end ov-prefix
14586 (exit-after-next org-fast-tag-selection-single-key)
14587 (done-keywords org-done-keywords)
14588 groups ingroup)
14589 (save-excursion
14590 (beginning-of-line 1)
14591 (if (looking-at
14593 (setq ov-start (match-beginning 1)
14594 ov-end (match-end 1)
14595 ov-prefix "")
14596 (setq ov-start (1- (point-at-eol))
14597 ov-end (1+ ov-start))
14599 (setq ov-prefix
14600 (concat
14601 (buffer-substring (1- (point)) (point))
14602 (if (> (current-column) org-tags-column)
14603 " "
14604 (make-string (- org-tags-column (current-column)) ?\ ))))))
14605 (move-overlay org-tags-overlay ov-start ov-end)
14606 (save-window-excursion
14607 (if expert
14608 (set-buffer (get-buffer-create " *Org tags*"))
14609 (delete-other-windows)
14610 (split-window-vertically)
14611 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14612 (erase-buffer)
14613 (org-set-local 'org-done-keywords done-keywords)
14616 (org-fast-tag-show-exit exit-after-next)
14617 (org-set-current-tags-overlay current ov-prefix)
14618 (setq tbl fulltable char ?a cnt 0)
14619 (while (setq e (pop tbl))
14620 (cond
14621 ((equal (car e) :startgroup)
14622 (push '() groups) (setq ingroup t)
14623 (when (not (= cnt 0))
14624 (setq cnt 0)
14626 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14627 ((equal (car e) :endgroup)
14628 (setq ingroup nil cnt 0)
14630 ((equal e '(:newline))
14631 (when (not (= cnt 0))
14632 (setq cnt 0)
14634 (setq e (car tbl))
14635 (while (equal (car tbl) '(:newline))
14637 (setq tbl (cdr tbl)))))
14638 ((equal e '(:grouptags)) nil)
14639 (t
14640 (setq tg (copy-sequence (car e)) c2 nil)
14641 (if (cdr e)
14642 (setq c (cdr e))
14643 ;; automatically assign a character.
14644 (setq c1 (string-to-char
14645 (downcase (substring
14646 tg (if (= (string-to-char tg) ?@) 1 0)))))
14647 (if (or (rassoc c1 ntable) (rassoc c1 table))
14648 (while (or (rassoc char ntable) (rassoc char table))
14649 (setq char (1+ char)))
14650 (setq c2 c1))
14651 (setq c (or c2 char)))
14652 (if ingroup (push tg (car groups)))
14653 (setq tg (org-add-props tg nil 'face
14654 (cond
14655 ((not (assoc tg table))
14656 (org-get-todo-face tg))
14657 ((member tg current) c-face)
14658 ((member tg inherited) i-face))))
14659 (if (equal (caar tbl) :grouptags)
14660 (org-add-props tg nil 'face 'org-tag-group))
14661 (if (and (= cnt 0) (not ingroup)) (insert " "))
14662 (insert "[" c "] " tg (make-string
14663 (- fwidth 4 (length tg)) ?\ ))
14664 (push (cons tg c) ntable)
14665 (when (= (setq cnt (1+ cnt)) ncol)
14667 (if ingroup (insert " "))
14668 (setq cnt 0)))))
14669 (setq ntable (nreverse ntable))
14671 (goto-char (point-min))
14672 (if (not expert) (org-fit-window-to-buffer))
14673 (setq rtn
14674 (catch 'exit
14675 (while t
14676 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14677 (if (not groups) "no " "")
14678 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14679 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14680 (setq org-last-tag-selection-key c)
14681 (cond
14683 ((= c ?!)
14684 (setq groups (not groups))
14685 (goto-char (point-min))
14686 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14687 ((= c ?\C-c)
14688 (if (not expert)
14689 (org-fast-tag-show-exit
14690 (setq exit-after-next (not exit-after-next)))
14691 (setq expert nil)
14692 (delete-other-windows)
14693 (set-window-buffer (split-window-vertically) " *Org tags*")
14694 (org-switch-to-buffer-other-window " *Org tags*")
14695 (org-fit-window-to-buffer)))
14696 ((or (= c ?\C-g)
14697 (and (= c ?q) (not (rassoc c ntable))))
14698 (org-detach-overlay org-tags-overlay)
14699 (setq quit-flag t))
14700 ((= c ?\ )
14701 (setq current nil)
14702 (if exit-after-next (setq exit-after-next 'now)))
14704 (condition-case nil
14705 (setq tg (org-icompleting-read
14706 "Tag: "
14707 (or buffer-tags
14708 (with-current-buffer buf
14709 (org-get-buffer-tags)))))
14710 (quit (setq tg "")))
14712 (add-to-list 'buffer-tags (list tg))
14713 (if (member tg current)
14714 (setq current (delete tg current))
14715 (push tg current)))
14716 (if exit-after-next (setq exit-after-next 'now)))
14717 ((setq e (rassoc c todo-table) tg (car e))
14718 (with-current-buffer buf
14719 (save-excursion (org-todo tg)))
14720 (if exit-after-next (setq exit-after-next 'now)))
14721 ((setq e (rassoc c ntable) tg (car e))
14722 (if (member tg current)
14723 (setq current (delete tg current))
14724 (loop for g in groups do
14725 (if (member tg g)
14726 (mapc (lambda (x)
14727 (setq current (delete x current)))
14728 g)))
14729 (push tg current))
14730 (if exit-after-next (setq exit-after-next 'now))))
14732 ;; Create a sorted list
14733 (setq current
14734 (sort current
14735 (lambda (a b)
14736 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14737 (if (eq exit-after-next 'now) (throw 'exit t))
14738 (goto-char (point-min))
14739 (beginning-of-line 2)
14740 (delete-region (point) (point-at-eol))
14741 (org-fast-tag-insert "Current" current c-face)
14742 (org-set-current-tags-overlay current ov-prefix)
14743 (while (re-search-forward
14745 (setq tg (match-string 1))
14746 (add-text-properties
14747 (match-beginning 1) (match-end 1)
14748 (list 'face
14749 (cond
14750 ((member tg current) c-face)
14751 ((member tg inherited) i-face)
14752 (t (get-text-property (match-beginning 1) 'face))))))
14753 (goto-char (point-min)))))
14754 (org-detach-overlay org-tags-overlay)
14755 (if rtn
14756 (mapconcat 'identity current ":")
14757 nil))))
14759 (defun org-get-tags-string ()
14760 "Get the TAGS string in the current headline."
14761 (unless (org-at-heading-p t)
14762 (error "Not on a heading"))
14763 (save-excursion
14764 (beginning-of-line 1)
14766 (org-match-string-no-properties 1)
14767 "")))
14769 (defun org-get-tags ()
14770 "Get the list of tags specified in the current headline."
14771 (org-split-string (org-get-tags-string) ":"))
14773 (defun org-get-buffer-tags ()
14774 "Get a table of all tags used in the buffer, for completion."
14775 (let (tags)
14776 (save-excursion
14777 (goto-char (point-min))
14778 (while (re-search-forward
14780 (when (equal (char-after (point-at-bol 0)) ?*)
14781 (mapc (lambda (x) (add-to-list 'tags x))
14782 (org-split-string (org-match-string-no-properties 1) ":")))))
14783 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14784 (mapcar 'list tags)))
14786 ;;;; The mapping API
14788 (defun org-map-entries (func &optional match scope &rest skip)
14789 "Call FUNC at each headline selected by MATCH in SCOPE.
14791 FUNC is a function or a lisp form. The function will be called without
14792 arguments, with the cursor positioned at the beginning of the headline.
14793 The return values of all calls to the function will be collected and
14794 returned as a list.
14796 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14797 does not need to preserve point. After evaluation, the cursor will be
14798 moved to the end of the line (presumably of the headline of the
14799 processed entry) and search continues from there. Under some
14800 circumstances, this may not produce the wanted results. For example,
14801 if you have removed (e.g. archived) the current (sub)tree it could
14802 mean that the next entry will be skipped entirely. In such cases, you
14803 can specify the position from where search should continue by making
14804 FUNC set the variable `org-map-continue-from' to the desired buffer
14805 position.
14807 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14808 Only headlines that are matched by this query will be considered during
14809 the iteration. When MATCH is nil or t, all headlines will be
14810 visited by the iteration.
14812 SCOPE determines the scope of this command. It can be any of:
14814 nil The current buffer, respecting the restriction if any
14815 tree The subtree started with the entry at point
14816 region The entries within the active region, if any
14817 region-start-level
14818 The entries within the active region, but only those at
14819 the same level than the first one.
14820 file The current buffer, without restriction
14821 file-with-archives
14822 The current buffer, and any archives associated with it
14823 agenda All agenda files
14824 agenda-with-archives
14825 All agenda files with any archive files associated with them
14826 \(file1 file2 ...)
14827 If this is a list, all files in the list will be scanned
14829 The remaining args are treated as settings for the skipping facilities of
14830 the scanner. The following items can be given here:
14832 archive skip trees with the archive tag
14833 comment skip trees with the COMMENT keyword
14834 function or Emacs Lisp form:
14835 will be used as value for `org-agenda-skip-function', so
14836 whenever the function returns a position, FUNC will not be
14837 called for that entry and search will continue from the
14838 position returned
14840 If your function needs to retrieve the tags including inherited tags
14841 at the *current* entry, you can use the value of the variable
14842 `org-scanner-tags' which will be much faster than getting the value
14843 with `org-get-tags-at'. If your function gets properties with
14844 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14845 to t around the call to `org-entry-properties' to get the same speedup.
14846 Note that if your function moves around to retrieve tags and properties at
14847 a *different* entry, you cannot use these techniques."
14848 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14849 (not (org-region-active-p)))
14850 (let* ((org-agenda-archives-mode nil) ; just to make sure
14851 (org-agenda-skip-archived-trees (memq 'archive skip))
14852 (org-agenda-skip-comment-trees (memq 'comment skip))
14853 (org-agenda-skip-function
14854 (car (org-delete-all '(comment archive) skip)))
14855 (org-tags-match-list-sublevels t)
14856 (start-level (eq scope 'region-start-level))
14857 matcher file res
14858 org-todo-keywords-for-agenda
14859 org-done-keywords-for-agenda
14860 org-todo-keyword-alist-for-agenda
14861 org-drawers-for-agenda
14862 org-tag-alist-for-agenda
14863 todo-only)
14865 (cond
14866 ((eq match t) (setq matcher t))
14867 ((eq match nil) (setq matcher t))
14868 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14870 (save-window-excursion
14871 (save-restriction
14872 (cond ((eq scope 'tree)
14873 (org-back-to-heading t)
14874 (org-narrow-to-subtree)
14875 (setq scope nil))
14876 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14877 (org-region-active-p))
14878 ;; If needed, set start-level to a string like "2"
14879 (when start-level
14880 (save-excursion
14881 (goto-char (region-beginning))
14882 (unless (org-at-heading-p) (outline-next-heading))
14883 (setq start-level (org-current-level))))
14884 (narrow-to-region (region-beginning)
14885 (save-excursion
14886 (goto-char (region-end))
14887 (unless (and (bolp) (org-at-heading-p))
14888 (outline-next-heading))
14889 (point)))
14890 (setq scope nil)))
14892 (if (not scope)
14893 (progn
14894 (org-agenda-prepare-buffers
14895 (list (buffer-file-name (current-buffer))))
14896 (setq res (org-scan-tags func matcher todo-only start-level)))
14897 ;; Get the right scope
14898 (cond
14899 ((and scope (listp scope) (symbolp (car scope)))
14900 (setq scope (eval scope)))
14901 ((eq scope 'agenda)
14902 (setq scope (org-agenda-files t)))
14903 ((eq scope 'agenda-with-archives)
14904 (setq scope (org-agenda-files t))
14905 (setq scope (org-add-archive-files scope)))
14906 ((eq scope 'file)
14907 (setq scope (list (buffer-file-name))))
14908 ((eq scope 'file-with-archives)
14909 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14910 (org-agenda-prepare-buffers scope)
14911 (while (setq file (pop scope))
14912 (with-current-buffer (org-find-base-buffer-visiting file)
14913 (save-excursion
14914 (save-restriction
14915 (widen)
14916 (goto-char (point-min))
14917 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14918 res)))
14920 ;;;; Properties
14922 ;;; Setting and retrieving properties
14924 (defconst org-special-properties
14925 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14926 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14927 "The special properties valid in Org-mode.
14929 These are properties that are not defined in the property drawer,
14930 but in some other way.")
14932 (defconst org-default-properties
14933 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14934 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14935 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14936 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14937 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14938 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14939 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14940 "Some properties that are used by Org-mode for various purposes.
14941 Being in this list makes sure that they are offered for completion.")
14944 "Regular expression matching the first line of a property drawer.")
14947 "Regular expression matching the last line of a property drawer.")
14950 "Regular expression matching the first line of a property drawer.")
14953 "Regular expression matching the first line of a property drawer.")
14955 (defconst org-property-drawer-re
14958 "Matches an entire property drawer.")
14960 (defconst org-clock-drawer-re
14963 "Matches an entire clock drawer.")
14965 (defsubst org-re-property (property)
14966 "Return a regexp matching a PROPERTY line.
14967 Match group 1 will be set to the value."
14970 (defsubst org-re-property-keyword (property)
14971 "Return a regexp matching a PROPERTY line, possibly with no
14972 value for the property."
14975 (defun org-property-action ()
14976 "Do an action on properties."
14977 (interactive)
14978 (let (c)
14979 (org-at-property-p)
14980 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14981 (setq c (read-char-exclusive))
14982 (cond
14983 ((equal c ?s)
14984 (call-interactively 'org-set-property))
14985 ((equal c ?d)
14986 (call-interactively 'org-delete-property))
14987 ((equal c ?D)
14988 (call-interactively 'org-delete-property-globally))
14989 ((equal c ?c)
14990 (call-interactively 'org-compute-property-at-point))
14991 (t (error "No such property action %c" c)))))
14993 (defun org-inc-effort ()
14994 "Increment the value of the effort property in the current entry."
14995 (interactive)
14996 (org-set-effort nil t))
14998 (defvar org-clock-effort) ;; Defined in org-clock.el
14999 (defvar org-clock-current-task) ;; Defined in org-clock.el
15000 (defun org-set-effort (&optional value increment)
15001 "Set the effort property of the current entry.
15002 With numerical prefix arg, use the nth allowed value, 0 stands for the
15003 10th allowed value.
15005 When INCREMENT is non-nil, set the property to the next allowed value."
15006 (interactive "P")
15007 (if (equal value 0) (setq value 10))
15008 (let* ((completion-ignore-case t)
15009 (prop org-effort-property)
15010 (cur (org-entry-get nil prop))
15011 (allowed (org-property-get-allowed-values nil prop 'table))
15012 (existing (mapcar 'list (org-property-values prop)))
15013 (heading (nth 4 (org-heading-components)))
15014 rpl
15015 (val (cond
15016 ((stringp value) value)
15017 ((and allowed (integerp value))
15018 (or (car (nth (1- value) allowed))
15019 (car (org-last allowed))))
15020 ((and allowed increment)
15021 (or (caadr (member (list cur) allowed))
15022 (error "Allowed effort values are not set")))
15023 (allowed
15024 (message "Select 1-9,0, [RET%s]: %s"
15025 (if cur (concat "=" cur) "")
15026 (mapconcat 'car allowed " "))
15027 (setq rpl (read-char-exclusive))
15029 cur
15030 (setq rpl (- rpl ?0))
15031 (if (equal rpl 0) (setq rpl 10))
15032 (if (and (> rpl 0) (<= rpl (length allowed)))
15033 (car (nth (1- rpl) allowed))
15034 (org-completing-read "Effort: " allowed nil))))
15035 (t
15036 (let (org-completion-use-ido org-completion-use-iswitchb)
15037 (org-completing-read
15039 (concat "[" cur "]") "")
15040 ": ")
15041 existing nil nil "" nil cur))))))
15042 (unless (equal (org-entry-get nil prop) val)
15043 (org-entry-put nil prop val))
15044 (save-excursion
15045 (org-back-to-heading t)
15046 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15047 (when (string= heading org-clock-current-task)
15048 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15049 (org-clock-update-mode-line))
15050 (message "%s is now %s" prop val)))
15052 (defun org-at-property-p ()
15053 "Is cursor inside a property drawer?"
15054 (save-excursion
15055 (beginning-of-line 1)
15057 (save-match-data ;; Used by calling procedures
15058 (let ((p (point))
15059 (range (unless (org-before-first-heading-p)
15060 (org-get-property-block))))
15061 (and range (<= (car range) p) (< p (cdr range))))))))
15063 (defun org-get-property-block (&optional beg end force)
15064 "Return the (beg . end) range of the body of the property drawer.
15065 BEG and END are the beginning and end of the current subtree, or of
15066 the part before the first headline. If they are not given, they will
15067 be found. If the drawer does not exist and FORCE is non-nil, create
15068 the drawer."
15069 (catch 'exit
15070 (save-excursion
15071 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15072 (progn (org-back-to-heading t) (point))))
15073 (end (or end (and (not (outline-next-heading)) (point-max))
15074 (point))))
15075 (goto-char beg)
15076 (if (re-search-forward org-property-start-re end t)
15077 (setq beg (1+ (match-end 0)))
15078 (if force
15079 (save-excursion
15080 (org-insert-property-drawer)
15081 (setq end (progn (outline-next-heading) (point))))
15082 (throw 'exit nil))
15083 (goto-char beg)
15084 (if (re-search-forward org-property-start-re end t)
15085 (setq beg (1+ (match-end 0)))))
15086 (if (re-search-forward org-property-end-re end t)
15087 (setq end (match-beginning 0))
15088 (or force (throw 'exit nil))
15089 (goto-char beg)
15090 (setq end beg)
15091 (org-indent-line)
15093 (cons beg end)))))
15095 (defun org-entry-properties (&optional pom which specific)
15096 "Get all properties of the entry at point-or-marker POM.
15097 This includes the TODO keyword, the tags, time strings for deadline,
15098 scheduled, and clocking, and any additional properties defined in the
15099 entry. The return value is an alist, keys may occur multiple times
15100 if the property key was used several times.
15101 POM may also be nil, in which case the current entry is used.
15102 If WHICH is nil or `all', get all properties. If WHICH is
15103 `special' or `standard', only get that subclass. If WHICH
15104 is a string only get exactly this property. SPECIFIC can be a string, the
15105 specific property we are interested in. Specifying it can speed
15106 things up because then unnecessary parsing is avoided."
15107 (setq which (or which 'all))
15108 (org-with-point-at pom
15109 (let ((clockstr (substring org-clock-string 0 -1))
15110 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15111 (case-fold-search nil)
15112 beg end range props sum-props key key1 value string clocksum clocksumt)
15113 (save-excursion
15114 (when (condition-case nil
15115 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15116 (error nil))
15117 (setq beg (point))
15118 (setq sum-props (get-text-property (point) 'org-summaries))
15119 (setq clocksum (get-text-property (point) :org-clock-minutes)
15120 clocksumt (get-text-property (point) :org-clock-minutes-today))
15121 (outline-next-heading)
15122 (setq end (point))
15123 (when (memq which '(all special))
15124 ;; Get the special properties, like TODO and tags
15125 (goto-char beg)
15126 (when (and (or (not specific) (string= specific "TODO"))
15127 (looking-at org-todo-line-regexp) (match-end 2))
15128 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15129 (when (and (or (not specific) (string= specific "PRIORITY"))
15130 (looking-at org-priority-regexp))
15131 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15132 (when (or (not specific) (string= specific "FILE"))
15133 (push (cons "FILE" buffer-file-name) props))
15134 (when (and (or (not specific) (string= specific "TAGS"))
15135 (setq value (org-get-tags-string))
15137 (push (cons "TAGS" value) props))
15138 (when (and (or (not specific) (string= specific "ALLTAGS"))
15139 (setq value (org-get-tags-at)))
15140 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15141 ":"))
15142 props))
15143 (when (or (not specific) (string= specific "BLOCKED"))
15144 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15145 (when (or (not specific)
15146 (member specific
15147 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15148 "TIMESTAMP" "TIMESTAMP_IA")))
15149 (catch 'match
15150 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15151 (setq key (if (match-end 1)
15152 (substring (org-match-string-no-properties 1)
15153 0 -1))
15154 string (if (equal key clockstr)
15155 (org-trim
15156 (buffer-substring-no-properties
15157 (match-beginning 3) (goto-char
15158 (point-at-eol))))
15159 (substring (org-match-string-no-properties 3)
15160 1 -1)))
15161 ;; Get the correct property name from the key. This is
15162 ;; necessary if the user has configured time keywords.
15163 (setq key1 (concat key ":"))
15164 (cond
15165 ((not key)
15166 (setq key
15167 (if (= (char-after (match-beginning 3)) ?\[)
15168 "TIMESTAMP_IA" "TIMESTAMP")))
15169 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15170 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15171 ((equal key1 org-closed-string) (setq key "CLOSED"))
15172 ((equal key1 org-clock-string) (setq key "CLOCK")))
15173 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15174 (progn
15175 (push (cons key string) props)
15176 ;; no need to search further if match is found
15177 (throw 'match t))
15178 (when (or (equal key "CLOCK") (not (assoc key props)))
15179 (push (cons key string) props)))))))
15181 (when (memq which '(all standard))
15182 ;; Get the standard properties, like :PROP: ...
15183 (setq range (org-get-property-block beg end))
15184 (when range
15185 (goto-char (car range))
15186 (while (re-search-forward
15188 (cdr range) t)
15189 (setq key (org-match-string-no-properties 1)
15190 value (org-trim (or (org-match-string-no-properties 2) "")))
15191 (unless (member key excluded)
15192 (push (cons key (or value "")) props)))))
15193 (if clocksum
15194 (push (cons "CLOCKSUM"
15195 (org-columns-number-to-string (/ (float clocksum) 60.)
15196 'add_times))
15197 props))
15198 (if clocksumt
15199 (push (cons "CLOCKSUM_T"
15200 (org-columns-number-to-string (/ (float clocksumt) 60.)
15201 'add_times))
15202 props))
15203 (unless (assoc "CATEGORY" props)
15204 (push (cons "CATEGORY" (org-get-category)) props))
15205 (append sum-props (nreverse props)))))))
15207 (defun org-entry-get (pom property &optional inherit literal-nil)
15208 "Get value of PROPERTY for entry or content at point-or-marker POM.
15209 If INHERIT is non-nil and the entry does not have the property,
15210 then also check higher levels of the hierarchy.
15211 If INHERIT is the symbol `selective', use inheritance only if the setting
15212 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15213 If the property is present but empty, the return value is the empty string.
15214 If the property is not present at all, nil is returned.
15217 do not interpret it as the list atom nil. This is used for inheritance
15219 (org-with-point-at pom
15220 (if (and inherit (if (eq inherit 'selective)
15221 (org-property-inherit-p property)
15222 t))
15223 (org-entry-get-with-inheritance property literal-nil)
15224 (if (member property org-special-properties)
15225 ;; We need a special property. Use `org-entry-properties' to
15226 ;; retrieve it, but specify the wanted property
15227 (cdr (assoc property (org-entry-properties nil 'special property)))
15228 (let ((range (org-get-property-block)))
15229 (when (and range (not (eq (car range) (cdr range))))
15230 (let* ((props (list (or (assoc property org-file-properties)
15231 (assoc property org-global-properties)
15232 (assoc property org-global-properties-fixed))))
15233 (ap (lambda (key)
15234 (when (re-search-forward
15235 (org-re-property key) (cdr range) t)
15236 (setq props
15237 (org-update-property-plist
15238 key
15239 (if (match-end 1)
15240 (org-match-string-no-properties 1) "")
15241 props)))))
15242 val)
15243 (goto-char (car range))
15244 (funcall ap property)
15245 (goto-char (car range))
15246 (while (funcall ap (concat property "+")))
15247 (setq val (cdr (assoc property props)))
15248 (when val (if literal-nil val (org-not-nil val))))))))))
15250 (defun org-property-or-variable-value (var &optional inherit)
15251 "Check if there is a property fixing the value of VAR.
15252 If yes, return this value. If not, return the current value of the variable."
15253 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15255 (read prop)
15256 (symbol-value var))))
15258 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15259 "Delete the property PROPERTY from entry at point-or-marker POM.
15260 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15261 an empty drawer to delete."
15262 (org-with-point-at pom
15263 (if (member property org-special-properties)
15264 nil ; cannot delete these properties.
15265 (let ((range (org-get-property-block)))
15266 (if (and range
15267 (goto-char (car range))
15268 (re-search-forward
15269 (org-re-property property)
15270 (cdr range) t))
15271 (progn
15272 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15273 (and delete-empty-drawer
15274 (org-remove-empty-drawer-at
15275 delete-empty-drawer (car range)))
15276 t)
15277 nil)))))
15279 ;; Multi-values properties are properties that contain multiple values
15280 ;; These values are assumed to be single words, separated by whitespace.
15281 (defun org-entry-add-to-multivalued-property (pom property value)
15282 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15283 (let* ((old (org-entry-get pom property))
15285 (setq value (org-entry-protect-space value))
15286 (unless (member value values)
15287 (setq values (append values (list value)))
15288 (org-entry-put pom property
15289 (mapconcat 'identity values " ")))))
15291 (defun org-entry-remove-from-multivalued-property (pom property value)
15292 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15293 (let* ((old (org-entry-get pom property))
15295 (setq value (org-entry-protect-space value))
15296 (when (member value values)
15297 (setq values (delete value values))
15298 (org-entry-put pom property
15299 (mapconcat 'identity values " ")))))
15301 (defun org-entry-member-in-multivalued-property (pom property value)
15302 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15303 (let* ((old (org-entry-get pom property))
15305 (setq value (org-entry-protect-space value))
15306 (member value values)))
15308 (defun org-entry-get-multivalued-property (pom property)
15309 "Return a list of values in a multivalued property."
15310 (let* ((value (org-entry-get pom property))
15312 (mapcar 'org-entry-restore-space values)))
15314 (defun org-entry-put-multivalued-property (pom property &rest values)
15315 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15316 VALUES should be a list of strings. Spaces will be protected."
15317 (org-entry-put pom property
15318 (mapconcat 'org-entry-protect-space values " "))
15319 (let* ((value (org-entry-get pom property))
15321 (mapcar 'org-entry-restore-space values)))
15323 (defun org-entry-protect-space (s)
15324 "Protect spaces and newline in string S."
15325 (while (string-match " " s)
15326 (setq s (replace-match "%20" t t s)))
15328 (setq s (replace-match "%0A" t t s)))
15329 s)
15331 (defun org-entry-restore-space (s)
15332 "Restore spaces and newline in string S."
15333 (while (string-match "%20" s)
15334 (setq s (replace-match " " t t s)))
15335 (while (string-match "%0A" s)
15337 s)
15339 (defvar org-entry-property-inherited-from (make-marker)
15340 "Marker pointing to the entry from where a property was inherited.
15341 Each call to `org-entry-get-with-inheritance' will set this marker to the
15342 location of the entry where the inheritance search matched. If there was
15343 no match, the marker will point nowhere.
15344 Note that also `org-entry-get' calls this function, if the INHERIT flag
15345 is set.")
15347 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15348 "Get PROPERTY of entry or content at point, search higher levels if needed.
15349 The search will stop at the first ancestor which has the property defined.
15351 should be considered as undefined (this is the meaning of nil here).
15353 (move-marker org-entry-property-inherited-from nil)
15354 (let (tmp)
15355 (save-excursion
15356 (save-restriction
15357 (widen)
15358 (catch 'ex
15359 (while t
15360 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15361 (or (ignore-errors (org-back-to-heading t))
15362 (goto-char (point-min)))
15363 (move-marker org-entry-property-inherited-from (point))
15364 (throw 'ex tmp))
15365 (or (ignore-errors (org-up-heading-safe))
15366 (throw 'ex nil))))))
15367 (setq tmp (or tmp
15368 (cdr (assoc property org-file-properties))
15369 (cdr (assoc property org-global-properties))
15370 (cdr (assoc property org-global-properties-fixed))))
15371 (if literal-nil tmp (org-not-nil tmp))))
15373 (defvar org-property-changed-functions nil
15374 "Hook called when the value of a property has changed.
15375 Each hook function should accept two arguments, the name of the property
15376 and the new value.")
15378 (defun org-entry-put (pom property value)
15379 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15380 (org-with-point-at pom
15381 (org-back-to-heading t)
15382 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15383 range)
15384 (cond
15385 ((equal property "TODO")
15387 (not (member value org-todo-keywords-1)))
15389 (if (or (not value)
15391 (setq value 'none))
15392 (org-todo value)
15393 (org-set-tags nil 'align))
15394 ((equal property "PRIORITY")
15396 (string-to-char value) ?\ ))
15397 (org-set-tags nil 'align))
15398 ((equal property "CLOCKSUM")
15399 (if (not (re-search-forward
15401 (error "Cannot find a clock log")
15402 (goto-char (- (match-end 1) 2))
15403 (cond
15404 ((eq value 'earlier) (org-timestamp-down))
15405 ((eq value 'later) (org-timestamp-up)))
15406 (org-clock-sum-current-item)))
15407 ((equal property "SCHEDULED")
15408 (if (re-search-forward org-scheduled-time-regexp end t)
15409 (cond
15410 ((eq value 'earlier) (org-timestamp-change -1 'day))
15411 ((eq value 'later) (org-timestamp-change 1 'day))
15412 (t (call-interactively 'org-schedule)))
15413 (call-interactively 'org-schedule)))
15414 ((equal property "DEADLINE")
15415 (if (re-search-forward org-deadline-time-regexp end t)
15416 (cond
15417 ((eq value 'earlier) (org-timestamp-change -1 'day))
15418 ((eq value 'later) (org-timestamp-change 1 'day))
15419 (t (call-interactively 'org-deadline)))
15420 (call-interactively 'org-deadline)))
15421 ((member property org-special-properties)
15422 (error "The %s property can not yet be set with `org-entry-put'"
15423 property))
15424 (t ; a non-special property
15425 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15426 (setq range (org-get-property-block beg end 'force))
15427 (goto-char (car range))
15428 (if (re-search-forward
15429 (org-re-property-keyword property) (cdr range) t)
15430 (progn
15431 (delete-region (match-beginning 0) (match-end 0))
15432 (goto-char (match-beginning 0)))
15433 (goto-char (cdr range))
15435 (backward-char 1)
15436 (org-indent-line))
15437 (insert ":" property ":")
15438 (and value (insert " " value))
15439 (org-indent-line)))))
15440 (run-hook-with-args 'org-property-changed-functions property value)))
15442 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15443 "Get all property keys in the current buffer.
15444 With INCLUDE-SPECIALS, also list the special properties that reflect things
15445 like tags and TODO state.
15446 With INCLUDE-DEFAULTS, also include properties that has special meaning
15447 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15448 and others.
15449 With INCLUDE-COLUMNS, also include property names given in COLUMN
15450 formats in the current buffer."
15451 (let (rtn range cfmt s p)
15452 (save-excursion
15453 (save-restriction
15454 (widen)
15455 (goto-char (point-min))
15456 (while (re-search-forward org-property-start-re nil t)
15457 (setq range (org-get-property-block))
15458 (goto-char (car range))
15459 (while (re-search-forward
15461 (cdr range) t)
15462 (add-to-list 'rtn (org-match-string-no-properties 1)))
15463 (outline-next-heading))))
15465 (when include-specials
15466 (setq rtn (append org-special-properties rtn)))
15468 (when include-defaults
15469 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15470 (add-to-list 'rtn org-effort-property))
15472 (when include-columns
15473 (save-excursion
15474 (save-restriction
15475 (widen)
15476 (goto-char (point-min))
15477 (while (re-search-forward
15479 nil t)
15480 (setq cfmt (match-string 2) s 0)
15482 cfmt s)
15483 (setq s (match-end 0)
15484 p (match-string 1 cfmt))
15485 (unless (or (equal p "ITEM")
15486 (member p org-special-properties))
15487 (add-to-list 'rtn (match-string 1 cfmt))))))))
15489 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15491 (defun org-property-values (key)
15492 "Return a list of all values of property KEY in the current buffer."
15493 (save-excursion
15494 (save-restriction
15495 (widen)
15496 (goto-char (point-min))
15497 (let ((re (org-re-property key))
15498 values)
15499 (while (re-search-forward re nil t)
15500 (add-to-list 'values (org-trim (match-string 1))))
15501 (delete "" values)))))
15503 (defun org-insert-property-drawer ()
15504 "Insert a property drawer into the current entry."
15505 (org-back-to-heading t)
15506 (looking-at org-outline-regexp)
15507 (let ((indent (if org-adapt-indentation
15508 (- (match-end 0) (match-beginning 0))
15509 0))
15510 (beg (point))
15512 end hiddenp)
15513 (outline-next-heading)
15514 (setq end (point))
15515 (goto-char beg)
15516 (while (re-search-forward re end t))
15517 (setq hiddenp (outline-invisible-p))
15518 (end-of-line 1)
15521 (if (member (match-string 1) '("CLOCK:" ":END:"))
15522 ;; just skip this line
15523 (beginning-of-line 2)
15524 ;; Drawer start, find the end
15526 (beginning-of-line 1)))
15527 (org-skip-over-state-notes)
15529 (if (eq (char-before) ?*) (forward-char 1))
15531 (beginning-of-line 0)
15532 (org-indent-to-column indent)
15533 (beginning-of-line 2)
15534 (org-indent-to-column indent)
15535 (beginning-of-line 0)
15536 (if hiddenp
15537 (save-excursion
15538 (org-back-to-heading t)
15539 (hide-entry))
15540 (org-flag-drawer t))))
15542 (defun org-insert-drawer (&optional arg drawer)
15543 "Insert a drawer at point.
15545 Optional argument DRAWER, when non-nil, is a string representing
15546 drawer's name. Otherwise, the user is prompted for a name.
15548 If a region is active, insert the drawer around that region
15549 instead.
15551 Point is left between drawer's boundaries."
15552 (interactive "P")
15553 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15554 "LOGBOOK"))
15555 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15556 ;; internally by Org. They are meant to be inserted
15557 ;; automatically.
15558 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15559 ;; Remove system drawers from list. Note: For some reason,
15560 ;; `org-completing-read' ignores the predicate while
15561 ;; `completing-read' handles it fine.
15562 (drawer (if arg "PROPERTIES"
15563 (or drawer
15564 (completing-read
15565 "Drawer: " org-drawers
15566 (lambda (d) (not (member d system-drawers))))))))
15567 (cond
15568 ;; With C-u, fall back on `org-insert-property-drawer'
15569 (arg (org-insert-property-drawer))
15570 ;; With an active region, insert a drawer at point.
15571 ((not (org-region-active-p))
15572 (progn
15575 (forward-line -2)))
15576 ;; Otherwise, insert the drawer at point
15577 (t
15578 (let ((rbeg (region-beginning))
15579 (rend (copy-marker (region-end))))
15580 (unwind-protect
15581 (progn
15582 (goto-char rbeg)
15583 (beginning-of-line)
15584 (when (save-excursion
15585 (re-search-forward org-outline-regexp-bol rend t))
15586 (error "Drawers cannot contain headlines"))
15587 ;; Position point at the beginning of the first
15588 ;; non-blank line in region. Insert drawer's opening
15589 ;; there, then indent it.
15590 (org-skip-whitespace)
15591 (beginning-of-line)
15593 (forward-line -1)
15594 (indent-for-tab-command)
15595 ;; Move point to the beginning of the first blank line
15596 ;; after the last non-blank line in region. Insert
15597 ;; drawer's closing, then indent it.
15598 (goto-char rend)
15601 (deactivate-mark t)
15602 (indent-for-tab-command)
15604 ;; Clear marker, whatever the outcome of insertion is.
15605 (set-marker rend nil)))))))
15607 (defvar org-property-set-functions-alist nil
15608 "Property set function alist.
15609 Each entry should have the following format:
15611 (PROPERTY . READ-FUNCTION)
15613 The read function will be called with the same argument as
15614 `org-completing-read'.")
15616 (defun org-set-property-function (property)
15617 "Get the function that should be used to set PROPERTY.
15618 This is computed according to `org-property-set-functions-alist'."
15619 (or (cdr (assoc property org-property-set-functions-alist))
15620 'org-completing-read))
15622 (defun org-read-property-value (property)
15623 "Read PROPERTY value from user."
15624 (let* ((completion-ignore-case t)
15625 (allowed (org-property-get-allowed-values nil property 'table))
15626 (cur (org-entry-get nil property))
15627 (prompt (concat property " value"
15629 (concat " [" cur "]") "") ": "))
15630 (set-function (org-set-property-function property))
15631 (val (if allowed
15632 (funcall set-function prompt allowed nil
15633 (not (get-text-property 0 'org-unrestricted
15634 (caar allowed))))
15635 (let (org-completion-use-ido org-completion-use-iswitchb)
15636 (funcall set-function prompt
15637 (mapcar 'list (org-property-values property))
15638 nil nil "" nil cur)))))
15639 (if (equal val "")
15640 cur
15641 val)))
15643 (defvar org-last-set-property nil)
15644 (defvar org-last-set-property-value nil)
15645 (defun org-read-property-name ()
15646 "Read a property name."
15647 (let* ((completion-ignore-case t)
15648 (keys (org-buffer-property-keys nil t t))
15649 (default-prop (or (save-excursion
15650 (save-match-data
15651 (beginning-of-line)
15653 (null (string= (match-string 1) "END"))
15654 (match-string 1))))
15655 org-last-set-property))
15656 (property (org-icompleting-read
15657 (concat "Property"
15658 (if default-prop (concat " [" default-prop "]") "")
15659 ": ")
15660 (mapcar 'list keys)
15661 nil nil nil nil
15662 default-prop)))
15663 (if (member property keys)
15664 property
15665 (or (cdr (assoc (downcase property)
15666 (mapcar (lambda (x) (cons (downcase x) x))
15667 keys)))
15668 property))))
15670 (defun org-set-property-and-value (use-last)
15671 "Allow to set [PROPERTY]: [value] direction from prompt.
15672 When use-default, don't even ask, just use the last
15674 (interactive "P")
15675 (let* ((completion-ignore-case t)
15676 (pv (or (and use-last org-last-set-property-value)
15677 (org-completing-read
15679 nil nil nil nil nil
15680 org-last-set-property-value)))
15681 prop val)
15683 (setq prop (match-string 1 pv)
15684 val (match-string 2 pv))
15685 (org-set-property prop val))))
15687 (defun org-set-property (property value)
15688 "In the current entry, set PROPERTY to VALUE.
15689 When called interactively, this will prompt for a property name, offering
15690 completion on existing and default properties. And then it will prompt
15691 for a value, offering completion either on allowed values (via an inherited
15692 xxx_ALL property) or on existing values in other instances of this property
15693 in the current file."
15694 (interactive (list nil nil))
15695 (let* ((property (or property (org-read-property-name)))
15696 (value (or value (org-read-property-value property)))
15697 (fn (cdr (assoc property org-properties-postprocess-alist))))
15698 (setq org-last-set-property property)
15699 (setq org-last-set-property-value (concat property ": " value))
15700 ;; Possibly postprocess the inserted value:
15701 (when fn (setq value (funcall fn value)))
15702 (unless (equal (org-entry-get nil property) value)
15703 (org-entry-put nil property value))))
15705 (defun org-delete-property (property &optional delete-empty-drawer)
15706 "In the current entry, delete PROPERTY.
15707 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15708 an empty drawer to delete."
15709 (interactive
15710 (let* ((completion-ignore-case t)
15711 (prop (org-icompleting-read "Property: "
15712 (org-entry-properties nil 'standard))))
15713 (list prop)))
15714 (message "Property %s %s" property
15715 (if (org-entry-delete nil property delete-empty-drawer)
15716 "deleted"
15717 "was not present in the entry")))
15719 (defun org-delete-property-globally (property)
15720 "Remove PROPERTY globally, from all entries."
15721 (interactive
15722 (let* ((completion-ignore-case t)
15723 (prop (org-icompleting-read
15724 "Globally remove property: "
15725 (mapcar 'list (org-buffer-property-keys)))))
15726 (list prop)))
15727 (save-excursion
15728 (save-restriction
15729 (widen)
15730 (goto-char (point-min))
15731 (let ((cnt 0))
15732 (while (re-search-forward
15733 (org-re-property property)
15734 nil t)
15735 (setq cnt (1+ cnt))
15736 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15739 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15741 (defun org-compute-property-at-point ()
15742 "Compute the property at point.
15743 This looks for an enclosing column format, extracts the operator and
15744 then applies it to the property in the column format's scope."
15745 (interactive)
15746 (unless (org-at-property-p)
15747 (error "Not at a property"))
15748 (let ((prop (org-match-string-no-properties 2)))
15749 (org-columns-get-format-and-top-level)
15750 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15751 (error "No operator defined for property %s" prop))
15752 (org-columns-compute prop)))
15754 (defvar org-property-allowed-value-functions nil
15755 "Hook for functions supplying allowed values for a specific property.
15756 The functions must take a single argument, the name of the property, and
15758 the values, this means that these values are intended as defaults for
15759 completion, but that other values should be allowed too.
15760 The functions must return nil if they are not responsible for this
15761 property.")
15763 (defun org-property-get-allowed-values (pom property &optional table)
15764 "Get allowed values for the property PROPERTY.
15765 When TABLE is non-nil, return an alist that can directly be used for
15766 completion."
15767 (let (vals)
15768 (cond
15769 ((equal property "TODO")
15770 (setq vals (org-with-point-at pom
15771 (append org-todo-keywords-1 '("")))))
15772 ((equal property "PRIORITY")
15773 (let ((n org-lowest-priority))
15774 (while (>= n org-highest-priority)
15775 (push (char-to-string n) vals)
15776 (setq n (1- n)))))
15777 ((member property org-special-properties))
15778 ((setq vals (run-hook-with-args-until-success
15779 'org-property-allowed-value-functions property)))
15780 (t
15781 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15783 (setq vals (car (read-from-string (concat "(" vals ")"))))
15784 (setq vals (mapcar (lambda (x)
15785 (cond ((stringp x) x)
15786 ((numberp x) (number-to-string x))
15787 ((symbolp x) (symbol-name x))
15788 (t "???")))
15789 vals)))))
15790 (when (member ":ETC" vals)
15791 (setq vals (remove ":ETC" vals))
15792 (org-add-props (car vals) '(org-unrestricted t)))
15793 (if table (mapcar 'list vals) vals)))
15795 (defun org-property-previous-allowed-value (&optional previous)
15796 "Switch to the next allowed value for this property."
15797 (interactive)
15798 (org-property-next-allowed-value t))
15800 (defun org-property-next-allowed-value (&optional previous)
15801 "Switch to the next allowed value for this property."
15802 (interactive)
15803 (unless (org-at-property-p)
15804 (error "Not at a property"))
15805 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15806 (key (match-string 2))
15807 (value (match-string 3))
15808 (allowed (or (org-property-get-allowed-values (point) key)
15809 (and (member value '("[ ]" "[-]" "[X]"))
15810 '("[ ]" "[X]"))))
15811 (heading (save-match-data (nth 4 (org-heading-components))))
15812 nval)
15813 (unless allowed
15814 (error "Allowed values for this property have not been defined"))
15815 (if previous (setq allowed (reverse allowed)))
15816 (if (member value allowed)
15817 (setq nval (car (cdr (member value allowed)))))
15818 (setq nval (or nval (car allowed)))
15819 (if (equal nval value)
15820 (error "Only one allowed value for this property"))
15821 (org-at-property-p)
15822 (replace-match (concat " :" key ": " nval) t t)
15823 (org-indent-line)
15824 (beginning-of-line 1)
15826 (when (equal prop org-effort-property)
15827 (save-excursion
15828 (org-back-to-heading t)
15829 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15830 (when (string= org-clock-current-task heading)
15831 (setq org-clock-effort nval)
15832 (org-clock-update-mode-line)))
15833 (run-hook-with-args 'org-property-changed-functions key nval)))
15835 (defun org-find-olp (path &optional this-buffer)
15836 "Return a marker pointing to the entry at outline path OLP.
15837 If anything goes wrong, throw an error.
15838 You can wrap this call to catch the error like this:
15840 (condition-case msg
15841 (org-mobile-locate-entry (match-string 4))
15842 (error (nth 1 msg)))
15844 The return value will then be either a string with the error message,
15845 or a marker if everything is OK.
15847 If THIS-BUFFER is set, the outline path does not contain a file,
15848 only headings."
15849 (let* ((file (if this-buffer buffer-file-name (pop path)))
15850 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15851 (level 1)
15852 (lmin 1)
15853 (lmax 1)
15854 limit re end found pos heading cnt flevel)
15855 (unless buffer (error "File not found :%s" file))
15856 (with-current-buffer buffer
15857 (save-excursion
15858 (save-restriction
15859 (widen)
15860 (setq limit (point-max))
15861 (goto-char (point-min))
15862 (while (setq heading (pop path))
15863 (setq re (format org-complex-heading-regexp-format
15864 (regexp-quote heading)))
15865 (setq cnt 0 pos (point))
15866 (while (re-search-forward re end t)
15867 (setq level (- (match-end 1) (match-beginning 1)))
15868 (if (and (>= level lmin) (<= level lmax))
15869 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15870 (when (= cnt 0) (error "Heading not found on level %d: %s"
15871 lmax heading))
15872 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15873 lmax heading))
15874 (goto-char found)
15875 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15876 (setq end (save-excursion (org-end-of-subtree t t))))
15877 (when (org-at-heading-p)
15878 (point-marker)))))))
15880 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15881 "Find node HEADING in BUFFER.
15882 Return a marker to the heading if it was found, or nil if not.
15883 If POS-ONLY is set, return just the position instead of a marker.
15885 The heading text must match exact, but it may have a TODO keyword,
15886 a priority cookie and tags in the standard locations."
15887 (with-current-buffer (or buffer (current-buffer))
15888 (save-excursion
15889 (save-restriction
15890 (widen)
15891 (goto-char (point-min))
15892 (let (case-fold-search)
15893 (if (re-search-forward
15894 (format org-complex-heading-regexp-format
15895 (regexp-quote heading)) nil t)
15896 (if pos-only
15897 (match-beginning 0)
15898 (move-marker (make-marker) (match-beginning 0)))))))))
15900 (defun org-find-exact-heading-in-directory (heading &optional dir)
15901 "Find Org node headline HEADING in all .org files in directory DIR.
15902 When the target headline is found, return a marker to this location."
15903 (let ((files (directory-files (or dir default-directory)
15905 file visiting m buffer)
15906 (catch 'found
15907 (while (setq file (pop files))
15908 (message "trying %s" file)
15909 (setq visiting (org-find-base-buffer-visiting file))
15910 (setq buffer (or visiting (find-file-noselect file)))
15911 (setq m (org-find-exact-headline-in-buffer
15912 heading buffer))
15913 (when (and (not m) (not visiting)) (kill-buffer buffer))
15914 (and m (throw 'found m))))))
15916 (defun org-find-entry-with-id (ident)
15917 "Locate the entry that contains the ID property with exact value IDENT.
15918 IDENT can be a string, a symbol or a number, this function will search for
15919 the string representation of it.
15920 Return the position where this entry starts, or nil if there is no such entry."
15921 (interactive "sID: ")
15922 (let ((id (cond
15923 ((stringp ident) ident)
15924 ((symbol-name ident) (symbol-name ident))
15925 ((numberp ident) (number-to-string ident))
15926 (t (error "IDENT %s must be a string, symbol or number" ident))))
15927 (case-fold-search nil))
15928 (save-excursion
15929 (save-restriction
15930 (widen)
15931 (goto-char (point-min))
15932 (when (re-search-forward
15934 nil t)
15935 (org-back-to-heading t)
15936 (point))))))
15938 ;;;; Timestamps
15940 (defvar org-last-changed-timestamp nil)
15941 (defvar org-last-inserted-timestamp nil
15942 "The last time stamp inserted with `org-insert-time-stamp'.")
15943 (defvar org-time-was-given) ; dynamically scoped parameter
15944 (defvar org-end-time-was-given) ; dynamically scoped parameter
15945 (defvar org-ts-what) ; dynamically scoped parameter
15947 (defun org-time-stamp (arg &optional inactive)
15948 "Prompt for a date/time and insert a time stamp.
15949 If the user specifies a time like HH:MM or if this command is
15950 called with at least one prefix argument, the time stamp contains
15951 the date and the time. Otherwise, only the date is be included.
15953 All parts of a date not specified by the user is filled in from
15954 the current date/time. So if you just press return without
15955 typing anything, the time stamp will represent the current
15956 date/time.
15958 If there is already a timestamp at the cursor, it will be
15959 modified.
15961 With two universal prefix arguments, insert an active timestamp
15962 with the current time without prompting the user."
15963 (interactive "P")
15964 (let* ((ts nil)
15965 (default-time
15966 ;; Default time is either today, or, when entering a range,
15967 ;; the range start.
15968 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15969 (save-excursion
15970 (re-search-backward
15972 (- (point) 20) t)))
15973 (apply 'encode-time (org-parse-time-string (match-string 1)))
15974 (current-time)))
15975 (default-input (and ts (org-get-compact-tod ts)))
15976 (repeater (save-excursion
15977 (save-match-data
15978 (beginning-of-line)
15979 (when (re-search-forward
15981 (save-excursion (progn (end-of-line) (point))) t)
15982 (match-string 0)))))
15983 org-time-was-given org-end-time-was-given time)
15984 (cond
15985 ((and (org-at-timestamp-p t)
15986 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15987 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15988 (insert "--")
15989 (setq time (let ((this-command this-command))
15990 (org-read-date arg 'totime nil nil
15991 default-time default-input inactive)))
15992 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15993 ((org-at-timestamp-p t)
15994 (setq time (let ((this-command this-command))
15995 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15996 (when (org-at-timestamp-p t) ; just to get the match data
15997 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15998 (replace-match "")
15999 (setq org-last-changed-timestamp
16000 (org-insert-time-stamp
16001 time (or org-time-was-given arg)
16002 inactive nil nil (list org-end-time-was-given)))
16003 (when repeater (goto-char (1- (point))) (insert " " repeater)
16004 (setq org-last-changed-timestamp
16005 (concat (substring org-last-inserted-timestamp 0 -1)
16006 " " repeater ">"))))
16007 (message "Timestamp updated"))
16008 ((equal arg '(16))
16009 (org-insert-time-stamp (current-time) t))
16010 (t
16011 (setq time (let ((this-command this-command))
16012 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16013 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16014 nil nil (list org-end-time-was-given))))))
16016 ;; FIXME: can we use this for something else, like computing time differences?
16017 (defun org-get-compact-tod (s)
16018 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16019 (let* ((t1 (match-string 1 s))
16020 (h1 (string-to-number (match-string 2 s)))
16021 (m1 (string-to-number (match-string 3 s)))
16022 (t2 (and (match-end 4) (match-string 5 s)))
16023 (h2 (and t2 (string-to-number (match-string 6 s))))
16024 (m2 (and t2 (string-to-number (match-string 7 s))))
16025 dh dm)
16026 (if (not t2)
16027 t1
16028 (setq dh (- h2 h1) dm (- m2 m1))
16029 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16030 (concat t1 "+" (number-to-string dh)
16031 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
16033 (defun org-time-stamp-inactive (&optional arg)
16034 "Insert an inactive time stamp.
16035 An inactive time stamp is enclosed in square brackets instead of angle
16036 brackets. It is inactive in the sense that it does not trigger agenda entries,
16037 does not link to the calendar and cannot be changed with the S-cursor keys.
16038 So these are more for recording a certain time/date."
16039 (interactive "P")
16040 (org-time-stamp arg 'inactive))
16042 (defvar org-date-ovl (make-overlay 1 1))
16043 (overlay-put org-date-ovl 'face 'org-date-selected)
16044 (org-detach-overlay org-date-ovl)
16046 (defvar org-ans1) ; dynamically scoped parameter
16047 (defvar org-ans2) ; dynamically scoped parameter
16049 (defvar org-plain-time-of-day-regexp) ; defined below
16051 (defvar org-overriding-default-time nil) ; dynamically scoped
16052 (defvar org-read-date-overlay nil)
16053 (defvar org-dcst nil) ; dynamically scoped
16054 (defvar org-read-date-history nil)
16055 (defvar org-read-date-final-answer nil)
16056 (defvar org-read-date-analyze-futurep nil)
16057 (defvar org-read-date-analyze-forced-year nil)
16058 (defvar org-read-date-inactive)
16060 (defvar org-read-date-minibuffer-local-map
16061 (let ((map (make-sparse-keymap)))
16062 (set-keymap-parent map minibuffer-local-map)
16063 (org-defkey map (kbd ".")
16064 (lambda () (interactive)
16065 (org-eval-in-calendar '(calendar-goto-today))))
16066 (org-defkey map [(meta shift left)]
16067 (lambda () (interactive)
16068 (org-eval-in-calendar '(calendar-backward-month 1))))
16069 (org-defkey map [(meta shift right)]
16070 (lambda () (interactive)
16071 (org-eval-in-calendar '(calendar-forward-month 1))))
16072 (org-defkey map [(meta shift up)]
16073 (lambda () (interactive)
16074 (org-eval-in-calendar '(calendar-backward-year 1))))
16075 (org-defkey map [(meta shift down)]
16076 (lambda () (interactive)
16077 (org-eval-in-calendar '(calendar-forward-year 1))))
16078 (org-defkey map [?\e (shift left)]
16079 (lambda () (interactive)
16080 (org-eval-in-calendar '(calendar-backward-month 1))))
16081 (org-defkey map [?\e (shift right)]
16082 (lambda () (interactive)
16083 (org-eval-in-calendar '(calendar-forward-month 1))))
16084 (org-defkey map [?\e (shift up)]
16085 (lambda () (interactive)
16086 (org-eval-in-calendar '(calendar-backward-year 1))))
16087 (org-defkey map [?\e (shift down)]
16088 (lambda () (interactive)
16089 (org-eval-in-calendar '(calendar-forward-year 1))))
16090 (org-defkey map [(shift up)]
16091 (lambda () (interactive)
16092 (org-eval-in-calendar '(calendar-backward-week 1))))
16093 (org-defkey map [(shift down)]
16094 (lambda () (interactive)
16095 (org-eval-in-calendar '(calendar-forward-week 1))))
16096 (org-defkey map [(shift left)]
16097 (lambda () (interactive)
16098 (org-eval-in-calendar '(calendar-backward-day 1))))
16099 (org-defkey map [(shift right)]
16100 (lambda () (interactive)
16101 (org-eval-in-calendar '(calendar-forward-day 1))))
16102 (org-defkey map "!"
16103 (lambda () (interactive)
16104 (org-eval-in-calendar '(diary-view-entries))
16105 (message "")))
16106 (org-defkey map ">"
16107 (lambda () (interactive)
16108 (org-eval-in-calendar '(scroll-calendar-left 1))))
16109 (org-defkey map "<"
16110 (lambda () (interactive)
16111 (org-eval-in-calendar '(scroll-calendar-right 1))))
16112 (org-defkey map "\C-v"
16113 (lambda () (interactive)
16114 (org-eval-in-calendar
16115 '(calendar-scroll-left-three-months 1))))
16116 (org-defkey map "\M-v"
16117 (lambda () (interactive)
16118 (org-eval-in-calendar
16119 '(calendar-scroll-right-three-months 1))))
16120 map)
16121 "Keymap for minibuffer commands when using `org-read-date'.")
16123 (defun org-read-date (&optional org-with-time to-time from-string prompt
16124 default-time default-input inactive)
16125 "Read a date, possibly a time, and make things smooth for the user.
16126 The prompt will suggest to enter an ISO date, but you can also enter anything
16127 which will at least partially be understood by `parse-time-string'.
16128 Unrecognized parts of the date will default to the current day, month, year,
16129 hour and minute. If this command is called to replace a timestamp at point,
16130 or to enter the second timestamp of a range, the default time is taken
16131 from the existing stamp. Furthermore, the command prefers the future,
16132 so if you are giving a date where the year is not given, and the day-month
16133 combination is already past in the current year, it will assume you
16134 mean next year. For details, see the manual. A few examples:
16136 3-2-5 --> 2003-02-05
16137 feb 15 --> currentyear-02-15
16138 2/15 --> currentyear-02-15
16139 sep 12 9 --> 2009-09-12
16140 12:45 --> today 12:45
16141 22 sept 0:34 --> currentyear-09-22 0:34
16142 12 --> currentyear-currentmonth-12
16143 Fri --> nearest Friday after today
16144 -Tue --> last Tuesday
16145 etc.
16147 Furthermore you can specify a relative date by giving, as the *first* thing
16148 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16149 change in days weeks, months, years.
16150 With a single plus or minus, the date is relative to today. With a double
16151 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16152 +4d --> four days from today
16153 +4 --> same as above
16154 +2w --> two weeks from today
16155 ++5 --> five days from default date
16157 The function understands only English month and weekday abbreviations.
16159 While prompting, a calendar is popped up - you can also select the
16160 date with the mouse (button 1). The calendar shows a period of three
16161 months. To scroll it to other months, use the keys `>' and `<'.
16162 If you don't like the calendar, turn it off with
16163 \(setq org-read-date-popup-calendar nil)
16165 With optional argument TO-TIME, the date will immediately be converted
16166 to an internal time.
16167 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16168 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16169 still enter a time, and this function will inform the calling routine
16170 about this change. The calling routine may then choose to change the
16171 format used to insert the time stamp into the buffer to include the time.
16172 With optional argument FROM-STRING, read from this string instead from
16173 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16174 the time/date that is used for everything that is not specified by the
16175 user."
16176 (require 'parse-time)
16177 (let* ((org-time-stamp-rounding-minutes
16178 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16179 (org-dcst org-display-custom-times)
16180 (ct (org-current-time))
16181 (org-def (or org-overriding-default-time default-time ct))
16182 (org-defdecode (decode-time org-def))
16183 (dummy (progn
16184 (when (< (nth 2 org-defdecode) org-extend-today-until)
16185 (setcar (nthcdr 2 org-defdecode) -1)
16186 (setcar (nthcdr 1 org-defdecode) 59)
16187 (setq org-def (apply 'encode-time org-defdecode)
16188 org-defdecode (decode-time org-def)))))
16189 (mouse-autoselect-window nil) ; Don't let the mouse jump
16190 (calendar-frame-setup nil)
16191 (calendar-setup nil)
16192 (calendar-move-hook nil)
16193 (calendar-view-diary-initially-flag nil)
16194 (calendar-view-holidays-initially-flag nil)
16195 (timestr (format-time-string
16196 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16197 (prompt (concat (if prompt (concat prompt " ") "")
16198 (format "Date+time [%s]: " timestr)))
16199 ans (org-ans0 "") org-ans1 org-ans2 final)
16201 (cond
16202 (from-string (setq ans from-string))
16203 (org-read-date-popup-calendar
16204 (save-excursion
16205 (save-window-excursion
16206 (calendar)
16207 (org-eval-in-calendar '(setq cursor-type nil) t)
16208 (unwind-protect
16209 (progn
16210 (calendar-forward-day (- (time-to-days org-def)
16211 (calendar-absolute-from-gregorian
16212 (calendar-current-date))))
16213 (org-eval-in-calendar nil t)
16214 (let* ((old-map (current-local-map))
16215 (map (copy-keymap calendar-mode-map))
16216 (minibuffer-local-map
16217 (copy-keymap org-read-date-minibuffer-local-map)))
16218 (org-defkey map (kbd "RET") 'org-calendar-select)
16219 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16220 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16221 (unwind-protect
16222 (progn
16223 (use-local-map map)
16224 (setq org-read-date-inactive inactive)
16225 (add-hook 'post-command-hook 'org-read-date-display)
16226 (setq org-ans0 (read-string prompt default-input
16227 'org-read-date-history nil))
16228 ;; org-ans0: from prompt
16229 ;; org-ans1: from mouse click
16230 ;; org-ans2: from calendar motion
16231 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16232 (remove-hook 'post-command-hook 'org-read-date-display)
16233 (use-local-map old-map)
16234 (when org-read-date-overlay
16235 (delete-overlay org-read-date-overlay)
16236 (setq org-read-date-overlay nil)))))
16237 (bury-buffer "*Calendar*")))))
16239 (t ; Naked prompt only
16240 (unwind-protect
16241 (setq ans (read-string prompt default-input
16242 'org-read-date-history timestr))
16243 (when org-read-date-overlay
16244 (delete-overlay org-read-date-overlay)
16245 (setq org-read-date-overlay nil)))))
16247 (setq final (org-read-date-analyze ans org-def org-defdecode))
16249 (when org-read-date-analyze-forced-year
16250 (message "Year was forced into %s"
16251 (if org-read-date-force-compatible-dates
16252 "compatible range (1970-2037)"
16253 "range representable on this machine"))
16254 (ding))
16256 ;; One round trip to get rid of 34th of August and stuff like that....
16257 (setq final (decode-time (apply 'encode-time final)))
16259 (setq org-read-date-final-answer ans)
16261 (if to-time
16262 (apply 'encode-time final)
16263 (if (and (boundp 'org-time-was-given) org-time-was-given)
16264 (format "%04d-%02d-%02d %02d:%02d"
16265 (nth 5 final) (nth 4 final) (nth 3 final)
16266 (nth 2 final) (nth 1 final))
16267 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16269 (defvar org-def)
16270 (defvar org-defdecode)
16271 (defvar org-with-time)
16272 (defun org-read-date-display ()
16273 "Display the current date prompt interpretation in the minibuffer."
16274 (when org-read-date-display-live
16275 (when org-read-date-overlay
16276 (delete-overlay org-read-date-overlay))
16277 (when (minibufferp (current-buffer))
16278 (save-excursion
16279 (end-of-line 1)
16280 (while (not (equal (buffer-substring
16281 (max (point-min) (- (point) 4)) (point))
16282 " "))
16283 (insert " ")))
16284 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16285 " " (or org-ans1 org-ans2)))
16286 (org-end-time-was-given nil)
16287 (f (org-read-date-analyze ans org-def org-defdecode))
16288 (fmts (if org-dcst
16289 org-time-stamp-custom-formats
16290 org-time-stamp-formats))
16291 (fmt (if (or org-with-time
16292 (and (boundp 'org-time-was-given) org-time-was-given))
16293 (cdr fmts)
16294 (car fmts)))
16295 (txt (format-time-string fmt (apply 'encode-time f)))
16296 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16297 (txt (concat "=> " txt)))
16298 (when (and org-end-time-was-given
16299 (string-match org-plain-time-of-day-regexp txt))
16300 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16301 org-end-time-was-given
16302 (substring txt (match-end 0)))))
16303 (when org-read-date-analyze-futurep
16304 (setq txt (concat txt " (=>F)")))
16305 (setq org-read-date-overlay
16306 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16307 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16309 (defun org-read-date-analyze (ans org-def org-defdecode)
16310 "Analyze the combined answer of the date prompt."
16311 ;; FIXME: cleanup and comment
16312 (let ((nowdecode (decode-time (current-time)))
16313 delta deltan deltaw deltadef year month day
16314 hour minute second wday pm h2 m2 tl wday1
16315 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16316 (setq org-read-date-analyze-futurep nil
16317 org-read-date-analyze-forced-year nil)
16319 (setq ans "+0"))
16321 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16322 (setq ans (replace-match "" t t ans)
16323 deltan (car delta)
16324 deltaw (nth 1 delta)
16325 deltadef (nth 2 delta)))
16327 ;; Check if there is an iso week date in there. If yes, store the
16328 ;; info and postpone interpreting it until the rest of the parsing
16329 ;; is done.
16330 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16331 (setq iso-year (if (match-end 1)
16332 (org-small-year-to-year
16333 (string-to-number (match-string 1 ans))))
16334 iso-weekday (if (match-end 3)
16335 (string-to-number (match-string 3 ans)))
16336 iso-week (string-to-number (match-string 2 ans)))
16337 (setq ans (replace-match "" t t ans)))
16339 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16340 (when (string-match
16342 (setq year (if (match-end 2)
16343 (string-to-number (match-string 2 ans))
16344 (progn (setq kill-year t)
16345 (string-to-number (format-time-string "%Y"))))
16346 month (string-to-number (match-string 3 ans))
16347 day (string-to-number (match-string 4 ans)))
16348 (if (< year 100) (setq year (+ 2000 year)))
16350 t nil ans)))
16352 ;; Help matching dotted european dates
16353 (when (string-match
16354 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16355 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16356 (setq kill-year t)
16357 (string-to-number (format-time-string "%Y")))
16358 day (string-to-number (match-string 1 ans))
16359 month (string-to-number (match-string 2 ans))
16360 ans (replace-match (format "%04d-%02d-%02d" year month day)
16361 t nil ans)))
16363 ;; Help matching american dates, like 5/30 or 5/30/7
16364 (when (string-match
16365 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16366 (setq year (if (match-end 4)
16367 (string-to-number (match-string 4 ans))
16368 (progn (setq kill-year t)
16369 (string-to-number (format-time-string "%Y"))))
16370 month (string-to-number (match-string 1 ans))
16371 day (string-to-number (match-string 2 ans)))
16372 (if (< year 100) (setq year (+ 2000 year)))
16374 t nil ans)))
16375 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16376 ;; If there is a time with am/pm, and *no* time without it, we convert
16377 ;; so that matching will be successful.
16378 (loop for i from 1 to 2 do ; twice, for end time as well
16381 (setq hour (string-to-number (match-string 1 ans))
16382 minute (if (match-end 3)
16383 (string-to-number (match-string 3 ans))
16384 0)
16385 pm (equal ?p
16386 (string-to-char (downcase (match-string 4 ans)))))
16387 (if (and (= hour 12) (not pm))
16388 (setq hour 0)
16389 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16390 (setq ans (replace-match (format "%02d:%02d" hour minute)
16391 t t ans))))
16393 ;; Check if a time range is given as a duration
16394 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16395 (setq hour (string-to-number (match-string 1 ans))
16396 h2 (+ hour (string-to-number (match-string 3 ans)))
16397 minute (string-to-number (match-string 2 ans))
16398 m2 (+ minute (if (match-end 5) (string-to-number
16399 (match-string 5 ans))0)))
16400 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16401 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16402 t t ans)))
16404 ;; Check if there is a time range
16405 (when (boundp 'org-end-time-was-given)
16406 (setq org-time-was-given nil)
16407 (when (and (string-match org-plain-time-of-day-regexp ans)
16408 (match-end 8))
16409 (setq org-end-time-was-given (match-string 8 ans))
16410 (setq ans (concat (substring ans 0 (match-beginning 7))
16411 (substring ans (match-end 7))))))
16413 (setq tl (parse-time-string ans)
16414 day (or (nth 3 tl) (nth 3 org-defdecode))
16415 month (or (nth 4 tl)
16416 (if (and org-read-date-prefer-future
16417 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16418 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16419 (nth 4 org-defdecode)))
16420 year (or (and (not kill-year) (nth 5 tl))
16421 (if (and org-read-date-prefer-future
16422 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16423 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16424 (nth 5 org-defdecode)))
16425 hour (or (nth 2 tl) (nth 2 org-defdecode))
16426 minute (or (nth 1 tl) (nth 1 org-defdecode))
16427 second (or (nth 0 tl) 0)
16428 wday (nth 6 tl))
16430 (when (and (eq org-read-date-prefer-future 'time)
16431 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16432 (equal day (nth 3 nowdecode))
16433 (equal month (nth 4 nowdecode))
16434 (equal year (nth 5 nowdecode))
16435 (nth 2 tl)
16436 (or (< (nth 2 tl) (nth 2 nowdecode))
16437 (and (= (nth 2 tl) (nth 2 nowdecode))
16438 (nth 1 tl)
16439 (< (nth 1 tl) (nth 1 nowdecode)))))
16440 (setq day (1+ day)
16441 futurep t))
16443 ;; Special date definitions below
16444 (cond
16445 (iso-week
16446 ;; There was an iso week
16447 (require 'cal-iso)
16448 (setq futurep nil)
16449 (setq year (or iso-year year)
16450 day (or iso-weekday wday 1)
16451 wday nil ; to make sure that the trigger below does not match
16452 iso-date (calendar-gregorian-from-absolute
16453 (calendar-absolute-from-iso
16454 (list iso-week day year))))
16455 ; FIXME: Should we also push ISO weeks into the future?
16456 ; (when (and org-read-date-prefer-future
16457 ; (not iso-year)
16458 ; (< (calendar-absolute-from-gregorian iso-date)
16459 ; (time-to-days (current-time))))
16460 ; (setq year (1+ year)
16461 ; iso-date (calendar-gregorian-from-absolute
16462 ; (calendar-absolute-from-iso
16463 ; (list iso-week day year)))))
16464 (setq month (car iso-date)
16465 year (nth 2 iso-date)
16466 day (nth 1 iso-date)))
16467 (deltan
16468 (setq futurep nil)
16469 (unless deltadef
16470 (let ((now (decode-time (current-time))))
16471 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16472 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16473 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16474 ((equal deltaw "m") (setq month (+ month deltan)))
16475 ((equal deltaw "y") (setq year (+ year deltan)))))
16476 ((and wday (not (nth 3 tl)))
16477 ;; Weekday was given, but no day, so pick that day in the week
16478 ;; on or after the derived date.
16479 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16480 (unless (equal wday wday1)
16481 (setq day (+ day (% (- wday wday1 -7) 7))))))
16482 (if (and (boundp 'org-time-was-given)
16483 (nth 2 tl))
16484 (setq org-time-was-given t))
16485 (if (< year 100) (setq year (+ 2000 year)))
16486 ;; Check of the date is representable
16487 (if org-read-date-force-compatible-dates
16488 (progn
16489 (if (< year 1970)
16490 (setq year 1970 org-read-date-analyze-forced-year t))
16491 (if (> year 2037)
16492 (setq year 2037 org-read-date-analyze-forced-year t)))
16493 (condition-case nil
16494 (ignore (encode-time second minute hour day month year))
16495 (error
16496 (setq year (nth 5 org-defdecode))
16497 (setq org-read-date-analyze-forced-year t))))
16498 (setq org-read-date-analyze-futurep futurep)
16499 (list second minute hour day month year)))
16501 (defvar parse-time-weekdays)
16502 (defun org-read-date-get-relative (s today default)
16503 "Check string S for special relative date string.
16504 TODAY and DEFAULT are internal times, for today and for a default.
16505 Return shift list (N what def-flag)
16507 N is the number of WHATs to shift.
16508 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16509 the DEFAULT date rather than TODAY."
16510 (require 'parse-time)
16511 (when (and
16512 (string-match
16513 (concat
16518 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16519 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16520 (string-to-char (substring (match-string 1 s) -1))
16521 ?+))
16522 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16523 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16524 (what (if (match-end 3) (match-string 3 s) "d"))
16525 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16526 (date (if rel default today))
16527 (wday (nth 6 (decode-time date)))
16528 delta)
16529 (if wday1
16530 (progn
16531 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16532 (if (= delta 0) (setq delta 7))
16533 (if (= dir ?-)
16534 (progn
16535 (setq delta (- delta 7))
16536 (if (= delta 0) (setq delta -7))))
16537 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16538 (list delta "d" rel))
16539 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16541 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16542 "Turn a user-specified date into the internal representation.
16543 The internal representation needed by the calendar is (month day year).
16544 This is a wrapper to handle the brain-dead convention in calendar that
16545 user function argument order change dependent on argument order."
16546 (if (boundp 'calendar-date-style)
16547 (cond
16548 ((eq calendar-date-style 'american)
16549 (list arg1 arg2 arg3))
16550 ((eq calendar-date-style 'european)
16551 (list arg2 arg1 arg3))
16552 ((eq calendar-date-style 'iso)
16553 (list arg2 arg3 arg1)))
16554 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16555 (if (org-bound-and-true-p european-calendar-style)
16556 (list arg2 arg1 arg3)
16557 (list arg1 arg2 arg3)))))
16559 (defun org-eval-in-calendar (form &optional keepdate)
16560 "Eval FORM in the calendar window and return to current window.
16561 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16562 otherwise stick to the current value of `org-ans2'."
16563 (let ((sf (selected-frame))
16564 (sw (selected-window)))
16565 (select-window (get-buffer-window "*Calendar*" t))
16566 (eval form)
16567 (when (and (not keepdate) (calendar-cursor-to-date))
16568 (let* ((date (calendar-cursor-to-date))
16569 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16570 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16571 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16572 (select-window sw)
16573 (org-select-frame-set-input-focus sf)))
16575 (defun org-calendar-select ()
16576 "Return to `org-read-date' with the date currently selected.
16577 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16578 (interactive)
16579 (when (calendar-cursor-to-date)
16580 (let* ((date (calendar-cursor-to-date))
16581 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16582 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16583 (if (active-minibuffer-window) (exit-minibuffer))))
16585 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16586 "Insert a date stamp for the date given by the internal TIME.
16587 WITH-HM means use the stamp format that includes the time of the day.
16588 INACTIVE means use square brackets instead of angular ones, so that the
16589 stamp will not contribute to the agenda.
16590 PRE and POST are optional strings to be inserted before and after the
16591 stamp.
16592 The command returns the inserted time stamp."
16593 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16594 stamp)
16595 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16596 (insert-before-markers (or pre ""))
16597 (when (listp extra)
16598 (setq extra (car extra))
16599 (if (and (stringp extra)
16601 (setq extra (format "-%02d:%02d"
16602 (string-to-number (match-string 1 extra))
16603 (string-to-number (match-string 2 extra))))
16604 (setq extra nil)))
16605 (when extra
16606 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16607 (insert-before-markers (setq stamp (format-time-string fmt time)))
16608 (insert-before-markers (or post ""))
16609 (setq org-last-inserted-timestamp stamp)))
16611 (defun org-toggle-time-stamp-overlays ()
16612 "Toggle the use of custom time stamp formats."
16613 (interactive)
16614 (setq org-display-custom-times (not org-display-custom-times))
16615 (unless org-display-custom-times
16616 (let ((p (point-min)) (bmp (buffer-modified-p)))
16617 (while (setq p (next-single-property-change p 'display))
16618 (if (and (get-text-property p 'display)
16619 (eq (get-text-property p 'face) 'org-date))
16620 (remove-text-properties
16621 p (setq p (next-single-property-change p 'display))
16622 '(display t))))
16623 (set-buffer-modified-p bmp)))
16624 (if (featurep 'xemacs)
16625 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16626 (org-restart-font-lock)
16627 (setq org-table-may-need-update t)
16628 (if org-display-custom-times
16629 (message "Time stamps are overlaid with custom format")
16630 (message "Time stamp overlays removed")))
16632 (defun org-display-custom-time (beg end)
16633 "Overlay modified time stamp format over timestamp between BEG and END."
16634 (let* ((ts (buffer-substring beg end))
16635 t1 w1 with-hm tf time str w2 (off 0))
16636 (save-match-data
16637 (setq t1 (org-parse-time-string ts t))
16638 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16639 (setq off (- (match-end 0) (match-beginning 0)))))
16640 (setq end (- end off))
16641 (setq w1 (- end beg)
16642 with-hm (and (nth 1 t1) (nth 2 t1))
16643 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16644 time (org-fix-decoded-time t1)
16645 str (org-add-props
16646 (format-time-string
16647 (substring tf 1 -1) (apply 'encode-time time))
16648 nil 'mouse-face 'highlight)
16649 w2 (length str))
16650 (if (not (= w2 w1))
16651 (add-text-properties (1+ beg) (+ 2 beg)
16652 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16653 (if (featurep 'xemacs)
16654 (progn
16655 (put-text-property beg end 'invisible t)
16656 (put-text-property beg end 'end-glyph (make-glyph str)))
16657 (put-text-property beg end 'display str))))
16659 (defun org-translate-time (string)
16660 "Translate all timestamps in STRING to custom format.
16661 But do this only if the variable `org-display-custom-times' is set."
16662 (when org-display-custom-times
16663 (save-match-data
16664 (let* ((start 0)
16665 (re org-ts-regexp-both)
16666 t1 with-hm inactive tf time str beg end)
16667 (while (setq start (string-match re string start))
16668 (setq beg (match-beginning 0)
16669 end (match-end 0)
16670 t1 (save-match-data
16671 (org-parse-time-string (substring string beg end) t))
16672 with-hm (and (nth 1 t1) (nth 2 t1))
16673 inactive (equal (substring string beg (1+ beg)) "[")
16674 tf (funcall (if with-hm 'cdr 'car)
16675 org-time-stamp-custom-formats)
16676 time (org-fix-decoded-time t1)
16677 str (format-time-string
16678 (concat
16679 (if inactive "[" "<") (substring tf 1 -1)
16680 (if inactive "]" ">"))
16681 (apply 'encode-time time))
16682 string (replace-match str t t string)
16683 start (+ start (length str)))))))
16684 string)
16686 (defun org-fix-decoded-time (time)
16687 "Set 0 instead of nil for the first 6 elements of time.
16688 Don't touch the rest."
16689 (let ((n 0))
16690 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16692 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16694 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16695 "Difference between TIMESTAMP-STRING and now in days.
16696 If SECONDS is non-nil, return the difference in seconds."
16697 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16698 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16699 (funcall fdiff (current-time)))))
16701 (defun org-deadline-close (timestamp-string &optional ndays)
16702 "Is the time in TIMESTAMP-STRING close to the current date?"
16703 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16704 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16705 (not (org-entry-is-done-p))))
16707 (defun org-get-wdays (ts &optional delay zero-delay)
16708 "Get the deadline lead time appropriate for timestring TS.
16709 When DELAY is non-nil, get the delay time for scheduled items
16710 instead of the deadline lead time. When ZERO-DELAY is non-nil
16711 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16712 don't try to find the delay cookie in the scheduled timestamp."
16713 (let ((tv (if delay org-scheduled-delay-days
16714 org-deadline-warning-days)))
16715 (cond
16716 ((or (and delay (< tv 0))
16717 (and delay zero-delay (<= tv 0))
16718 (and (not delay) (<= tv 0)))
16719 ;; Enforce this value no matter what
16720 (- tv))
16722 ;; lead time is specified.
16723 (floor (* (string-to-number (match-string 1 ts))
16724 (cdr (assoc (match-string 2 ts)
16725 '(("d" . 1) ("w" . 7)
16726 ("m" . 30.4) ("y" . 365.25)
16727 ("h" . 0.041667)))))))
16728 ;; go for the default.
16729 (t tv))))
16731 (defun org-calendar-select-mouse (ev)
16732 "Return to `org-read-date' with the date currently selected.
16733 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16734 (interactive "e")
16735 (mouse-set-point ev)
16736 (when (calendar-cursor-to-date)
16737 (let* ((date (calendar-cursor-to-date))
16738 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16739 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16740 (if (active-minibuffer-window) (exit-minibuffer))))
16742 (defun org-check-deadlines (ndays)
16743 "Check if there are any deadlines due or past due.
16744 A deadline is considered due if it happens within `org-deadline-warning-days'
16745 days from today's date. If the deadline appears in an entry marked DONE,
16746 it is not shown. The prefix arg NDAYS can be used to test that many
16748 (interactive "P")
16749 (let* ((org-warn-days
16750 (cond
16751 ((equal ndays '(4)) 100000)
16752 (ndays (prefix-numeric-value ndays))
16753 (t (abs org-deadline-warning-days))))
16754 (case-fold-search nil)
16756 (callback
16757 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16759 (message "%d deadlines past-due or due within %d days"
16760 (org-occur regexp nil callback)
16761 org-warn-days)))
16763 (defsubst org-re-timestamp (type)
16764 "Return a regexp for timestamp TYPE.
16765 Allowed values for TYPE are:
16767 all: all timestamps
16768 active: only active timestamps (<...>)
16769 inactive: only inactive timestamps ([...])
16770 scheduled: only scheduled timestamps
16771 deadline: only deadline timestamps
16772 closed: only closed time-stamps
16774 When TYPE is nil, fall back on returning a regexp that matches
16775 both scheduled and deadline timestamps."
16776 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16777 ((eq type 'active) org-ts-regexp)
16781 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16782 ((eq type 'scheduled-or-deadline)
16785 (defun org-check-before-date (date)
16786 "Check if there are deadlines or scheduled entries before DATE."
16787 (interactive (list (org-read-date)))
16788 (let ((case-fold-search nil)
16789 (regexp (org-re-timestamp org-ts-type))
16790 (callback
16791 (lambda () (time-less-p
16792 (org-time-string-to-time (match-string 1))
16793 (org-time-string-to-time date)))))
16794 (message "%d entries before %s"
16795 (org-occur regexp nil callback) date)))
16797 (defun org-check-after-date (date)
16798 "Check if there are deadlines or scheduled entries after DATE."
16799 (interactive (list (org-read-date)))
16800 (let ((case-fold-search nil)
16801 (regexp (org-re-timestamp org-ts-type))
16802 (callback
16803 (lambda () (not
16804 (time-less-p
16805 (org-time-string-to-time (match-string 1))
16806 (org-time-string-to-time date))))))
16807 (message "%d entries after %s"
16808 (org-occur regexp nil callback) date)))
16810 (defun org-check-dates-range (start-date end-date)
16811 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16812 (interactive (list (org-read-date nil nil nil "Range starts")
16813 (org-read-date nil nil nil "Range end")))
16814 (let ((case-fold-search nil)
16815 (regexp (org-re-timestamp org-ts-type))
16816 (callback
16817 (lambda ()
16818 (let ((match (match-string 1)))
16819 (and
16820 (not (time-less-p
16821 (org-time-string-to-time match)
16822 (org-time-string-to-time start-date)))
16823 (time-less-p
16824 (org-time-string-to-time match)
16825 (org-time-string-to-time end-date)))))))
16826 (message "%d entries between %s and %s"
16827 (org-occur regexp nil callback) start-date end-date)))
16829 (defun org-evaluate-time-range (&optional to-buffer)
16830 "Evaluate a time range by computing the difference between start and end.
16831 Normally the result is just printed in the echo area, but with prefix arg
16832 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16833 If the time range is actually in a table, the result is inserted into the
16834 next column.
16835 For time difference computation, a year is assumed to be exactly 365
16836 days in order to avoid rounding problems."
16837 (interactive "P")
16838 (or
16839 (org-clock-update-time-maybe)
16840 (save-excursion
16841 (unless (org-at-date-range-p t)
16842 (goto-char (point-at-bol))
16843 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16844 (if (not (org-at-date-range-p t))
16845 (error "Not at a time-stamp range, and none found in current line")))
16846 (let* ((ts1 (match-string 1))
16847 (ts2 (match-string 2))
16848 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16849 (match-end (match-end 0))
16850 (time1 (org-time-string-to-time ts1))
16851 (time2 (org-time-string-to-time ts2))
16852 (t1 (org-float-time time1))
16853 (t2 (org-float-time time2))
16854 (diff (abs (- t2 t1)))
16855 (negative (< (- t2 t1) 0))
16856 ;; (ys (floor (* 365 24 60 60)))
16857 (ds (* 24 60 60))
16858 (hs (* 60 60))
16859 (fy "%dy %dd %02d:%02d")
16860 (fy1 "%dy %dd")
16861 (fd "%dd %02d:%02d")
16862 (fd1 "%dd")
16863 (fh "%02d:%02d")
16864 y d h m align)
16865 (if havetime
16866 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16867 y 0
16868 d (floor (/ diff ds)) diff (mod diff ds)
16869 h (floor (/ diff hs)) diff (mod diff hs)
16870 m (floor (/ diff 60)))
16871 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16872 y 0
16873 d (floor (+ (/ diff ds) 0.5))
16874 h 0 m 0))
16875 (if (not to-buffer)
16876 (message "%s" (org-make-tdiff-string y d h m))
16877 (if (org-at-table-p)
16878 (progn
16879 (goto-char match-end)
16880 (setq align t)
16881 (and (looking-at " *|") (goto-char (match-end 0))))
16882 (goto-char match-end))
16883 (if (looking-at
16885 (replace-match ""))
16886 (if negative (insert " -"))
16887 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16888 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16889 (insert " " (format fh h m))))
16890 (if align (org-table-align))
16891 (message "Time difference inserted")))))
16893 (defun org-make-tdiff-string (y d h m)
16894 (let ((fmt "")
16895 (l nil))
16896 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16897 l (push y l)))
16898 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16899 l (push d l)))
16900 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16901 l (push h l)))
16902 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16903 l (push m l)))
16904 (apply 'format fmt (nreverse l))))
16906 (defun org-time-string-to-time (s &optional buffer pos)
16907 "Convert a timestamp string into internal time."
16908 (condition-case errdata
16909 (apply 'encode-time (org-parse-time-string s))
16911 s (if (not (and buffer pos))
16912 ""
16913 (format " at %d in buffer `%s'" pos buffer))
16914 (cdr errdata)))))
16916 (defun org-time-string-to-seconds (s)
16917 "Convert a timestamp string to a number of seconds."
16918 (org-float-time (org-time-string-to-time s)))
16920 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16921 "Convert a time stamp to an absolute day number.
16922 If there is a specifier for a cyclic time stamp, get the closest
16923 date to DAYNR.
16924 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16925 The variable `date' is bound by the calendar when this is called."
16926 (cond
16928 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16929 daynr
16930 (+ daynr 1000)))
16932 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16933 (time-to-days (current-time))) (match-string 0 s)
16934 prefer show-all))
16935 (t (time-to-days
16936 (condition-case errdata
16937 (apply 'encode-time (org-parse-time-string s))
16939 s (if (not (and buffer pos))
16940 ""
16941 (format " at %d in buffer `%s'" pos buffer))
16942 (cdr errdata))))))))
16944 (defun org-days-to-iso-week (days)
16945 "Return the iso week number."
16946 (require 'cal-iso)
16947 (car (calendar-iso-from-absolute days)))
16949 (defun org-small-year-to-year (year)
16950 "Convert 2-digit years into 4-digit years.
16951 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
16952 The year 2000 cannot be abbreviated. Any year larger than 99
16953 is returned unchanged."
16954 (if (< year 38)
16955 (setq year (+ 2000 year))
16956 (if (< year 100)
16957 (setq year (+ 1900 year))))
16958 year)
16960 (defun org-time-from-absolute (d)
16961 "Return the time corresponding to date D.
16962 D may be an absolute day number, or a calendar-type list (month day year)."
16963 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16964 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16966 (defun org-calendar-holiday ()
16967 "List of holidays, for Diary display in Org-mode."
16968 (require 'holidays)
16969 (let ((hl (funcall
16970 (if (fboundp 'calendar-check-holidays)
16971 'calendar-check-holidays 'check-calendar-holidays) date)))
16972 (if hl (mapconcat 'identity hl "; "))))
16974 (defun org-diary-sexp-entry (sexp entry date)
16975 "Process a SEXP diary ENTRY for DATE."
16976 (require 'diary-lib)
16977 (let ((result (if calendar-debug-sexp
16978 (let ((stack-trace-on-error t))
16979 (eval (car (read-from-string sexp))))
16980 (condition-case nil
16981 (eval (car (read-from-string sexp)))
16982 (error
16983 (beep)
16984 (message "Bad sexp at line %d in %s: %s"
16985 (org-current-line)
16986 (buffer-file-name) sexp)
16987 (sleep-for 2))))))
16988 (cond ((stringp result) (split-string result "; "))
16989 ((and (consp result)
16990 (not (consp (cdr result)))
16991 (stringp (cdr result))) (cdr result))
16992 ((and (consp result)
16993 (stringp (car result))) result)
16994 (result entry))))
16996 (defun org-diary-to-ical-string (frombuf)
16997 "Get iCalendar entries from diary entries in buffer FROMBUF.
16998 This uses the icalendar.el library."
16999 (let* ((tmpdir (if (featurep 'xemacs)
17000 (temp-directory)
17001 temporary-file-directory))
17002 (tmpfile (make-temp-name
17003 (expand-file-name "orgics" tmpdir)))
17004 buf rtn b e)
17005 (with-current-buffer frombuf
17006 (icalendar-export-region (point-min) (point-max) tmpfile)
17007 (setq buf (find-buffer-visiting tmpfile))
17008 (set-buffer buf)
17009 (goto-char (point-min))
17010 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17011 (setq b (match-beginning 0)))
17012 (goto-char (point-max))
17013 (if (re-search-backward "^END:VEVENT" nil t)
17014 (setq e (match-end 0)))
17016 (kill-buffer buf)
17017 (delete-file tmpfile)
17018 rtn))
17020 (defun org-closest-date (start current change prefer show-all)
17021 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17022 When PREFER is `past', return a date that is either CURRENT or past.
17023 When PREFER is `future', return a date that is either CURRENT or future.
17024 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17025 ;; Make the proper lists from the dates
17026 (catch 'exit
17027 (let ((a1 '(("h" . hour)
17028 ("d" . day)
17029 ("w" . week)
17030 ("m" . month)
17031 ("y" . year)))
17032 (shour (nth 2 (org-parse-time-string start)))
17033 dn dw sday cday n1 n2 n0
17034 d m y y1 y2 date1 date2 nmonths nm ny m2)
17036 (setq start (org-date-to-gregorian start)
17037 current (org-date-to-gregorian
17038 (if show-all
17039 current
17040 (time-to-days (current-time))))
17041 sday (calendar-absolute-from-gregorian start)
17042 cday (calendar-absolute-from-gregorian current))
17044 (if (<= cday sday) (throw 'exit sday))
17047 (setq dn (string-to-number (match-string 1 change))
17048 dw (cdr (assoc (match-string 2 change) a1)))
17049 (error "Invalid change specifier: %s" change))
17050 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17051 (cond
17052 ((eq dw 'hour)
17053 (let ((missing-hours
17054 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17055 dn)))
17056 (setq n1 (if (zerop missing-hours) cday
17057 (- cday (1+ (floor (/ missing-hours 24)))))
17058 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17059 ((eq dw 'day)
17060 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17061 n2 (+ n1 dn)))
17062 ((eq dw 'year)
17063 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17064 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17065 (setq date1 (list m d y1)
17066 n1 (calendar-absolute-from-gregorian date1)
17067 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17068 n2 (calendar-absolute-from-gregorian date2)))
17069 ((eq dw 'month)
17070 ;; approx number of month between the two dates
17071 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17072 ;; How often does dn fit in there?
17073 (setq d (nth 1 start) m (car start) y (nth 2 start)
17074 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17075 m (+ m nm)
17076 ny (floor (/ m 12))
17077 y (+ y ny)
17078 m (- m (* ny 12)))
17079 (while (> m 12) (setq m (- m 12) y (1+ y)))
17080 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17081 (setq m2 (+ m dn) y2 y)
17082 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17083 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17084 (while (<= n2 cday)
17085 (setq n1 n2 m m2 y y2)
17086 (setq m2 (+ m dn) y2 y)
17087 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17088 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17089 ;; Make sure n1 is the earlier date
17090 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17091 (if show-all
17092 (cond
17093 ((eq prefer 'past) (if (= cday n2) n2 n1))
17094 ((eq prefer 'future) (if (= cday n1) n1 n2))
17095 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17096 (cond
17097 ((eq prefer 'past) (if (= cday n2) n2 n1))
17098 ((eq prefer 'future) (if (= cday n1) n1 n2))
17099 (t (if (= cday n1) n1 n2)))))))
17101 (defun org-date-to-gregorian (date)
17102 "Turn any specification of DATE into a Gregorian date for the calendar."
17103 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17104 ((and (listp date) (= (length date) 3)) date)
17105 ((stringp date)
17106 (setq date (org-parse-time-string date))
17107 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17108 ((listp date)
17109 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17111 (defun org-parse-time-string (s &optional nodefault)
17112 "Parse the standard Org-mode time string.
17113 This should be a lot faster than the normal `parse-time-string'.
17114 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17115 hour and minute fields will be nil if not given."
17116 (cond ((string-match org-ts-regexp0 s)
17117 (list 0
17118 (if (or (match-beginning 8) (not nodefault))
17119 (string-to-number (or (match-string 8 s) "0")))
17120 (if (or (match-beginning 7) (not nodefault))
17121 (string-to-number (or (match-string 7 s) "0")))
17122 (string-to-number (match-string 4 s))
17123 (string-to-number (match-string 3 s))
17124 (string-to-number (match-string 2 s))
17125 nil nil nil))
17126 ((string-match "^<[^>]+>$" s)
17127 (decode-time (seconds-to-time (org-matcher-time s))))
17128 (t (error "Not a standard Org-mode time string: %s" s))))
17130 (defun org-timestamp-up (&optional arg)
17131 "Increase the date item at the cursor by one.
17132 If the cursor is on the year, change the year. If it is on the month,
17133 the day or the time, change that.
17134 With prefix ARG, change by that many units."
17135 (interactive "p")
17136 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17138 (defun org-timestamp-down (&optional arg)
17139 "Decrease the date item at the cursor by one.
17140 If the cursor is on the year, change the year. If it is on the month,
17141 the day or the time, change that.
17142 With prefix ARG, change by that many units."
17143 (interactive "p")
17144 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17146 (defun org-timestamp-up-day (&optional arg)
17147 "Increase the date in the time stamp by one day.
17148 With prefix ARG, change that many days."
17149 (interactive "p")
17150 (if (and (not (org-at-timestamp-p t))
17151 (org-at-heading-p))
17152 (org-todo 'up)
17153 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17155 (defun org-timestamp-down-day (&optional arg)
17156 "Decrease the date in the time stamp by one day.
17157 With prefix ARG, change that many days."
17158 (interactive "p")
17159 (if (and (not (org-at-timestamp-p t))
17160 (org-at-heading-p))
17161 (org-todo 'down)
17162 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17164 (defun org-at-timestamp-p (&optional inactive-ok)
17165 "Determine if the cursor is in or at a timestamp."
17166 (interactive)
17167 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17168 (pos (point))
17169 (ans (or (looking-at tsr)
17170 (save-excursion
17172 (if (> (point) (point-min)) (backward-char 1))
17173 (and (looking-at tsr)
17174 (> (- (match-end 0) pos) -1))))))
17175 (and ans
17176 (boundp 'org-ts-what)
17177 (setq org-ts-what
17178 (cond
17179 ((= pos (match-beginning 0)) 'bracket)
17180 ;; Point is considered to be "on the bracket" whether
17181 ;; it's really on it or right after it.
17182 ((= pos (1- (match-end 0))) 'bracket)
17183 ((= pos (match-end 0)) 'after)
17184 ((org-pos-in-match-range pos 2) 'year)
17185 ((org-pos-in-match-range pos 3) 'month)
17186 ((org-pos-in-match-range pos 7) 'hour)
17187 ((org-pos-in-match-range pos 8) 'minute)
17188 ((or (org-pos-in-match-range pos 4)
17189 (org-pos-in-match-range pos 5)) 'day)
17190 ((and (> pos (or (match-end 8) (match-end 5)))
17191 (< pos (match-end 0)))
17192 (- pos (or (match-end 8) (match-end 5))))
17193 (t 'day))))
17194 ans))
17196 (defun org-toggle-timestamp-type ()
17197 "Toggle the type (<active> or [inactive]) of a time stamp."
17198 (interactive)
17199 (when (org-at-timestamp-p t)
17200 (let ((beg (match-beginning 0)) (end (match-end 0))
17201 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17202 (save-excursion
17203 (goto-char beg)
17204 (while (re-search-forward "[][<>]" end t)
17205 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17206 t t)))
17207 (message "Timestamp is now %sactive"
17208 (if (equal (char-after beg) ?<) "" "in")))))
17210 (defun org-at-clock-log-p nil
17211 "Is the cursor on the clock log line?"
17212 (save-excursion
17213 (move-beginning-of-line 1)
17216 (defvar org-clock-history) ; defined in org-clock.el
17217 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17218 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17219 "Change the date in the time stamp at point.
17220 The date will be changed by N times WHAT. WHAT can be `day', `month',
17221 `year', `minute', `second'. If WHAT is not given, the cursor position
17222 in the timestamp determines what will be changed.
17224 (let ((origin (point)) origin-cat
17225 with-hm inactive
17226 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17227 org-ts-what
17228 extra rem
17229 ts time time0 fixnext clrgx)
17230 (if (not (org-at-timestamp-p t))
17231 (error "Not at a timestamp"))
17232 (if (and (not what) (eq org-ts-what 'bracket))
17233 (org-toggle-timestamp-type)
17234 ;; Point isn't on brackets. Remember the part of the time-stamp
17235 ;; the point was in. Indeed, size of time-stamps may change,
17236 ;; but point must be kept in the same category nonetheless.
17237 (setq origin-cat org-ts-what)
17238 (if (and (not what) (not (eq org-ts-what 'day))
17239 org-display-custom-times
17240 (get-text-property (point) 'display)
17241 (not (get-text-property (1- (point)) 'display)))
17242 (setq org-ts-what 'day))
17243 (setq org-ts-what (or what org-ts-what)
17244 inactive (= (char-after (match-beginning 0)) ?\[)
17245 ts (match-string 0))
17246 (replace-match "")
17247 (when (string-match
17248 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17249 ts)
17250 (setq extra (match-string 1 ts))
17251 (if suppress-tmp-delay
17252 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17254 (setq with-hm t))
17255 (setq time0 (org-parse-time-string ts))
17256 (when (and updown
17257 (eq org-ts-what 'minute)
17258 (not current-prefix-arg))
17259 ;; This looks like s-up and s-down. Change by one rounding step.
17260 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17261 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17262 (setcar (cdr time0) (+ (nth 1 time0)
17263 (if (> n 0) (- rem) (- dm rem))))))
17264 (setq time
17265 (encode-time (or (car time0) 0)
17266 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17267 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17268 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17269 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17270 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17271 (nthcdr 6 time0)))
17272 (when (and (member org-ts-what '(hour minute))
17273 extra
17275 (setq extra (org-modify-ts-extra
17276 extra
17277 (if (eq org-ts-what 'hour) 2 5)
17278 n dm)))
17279 (when (integerp org-ts-what)
17280 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17281 (if (eq what 'calendar)
17282 (let ((cal-date (org-get-date-from-calendar)))
17283 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17284 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17285 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17286 (setcar time0 (or (car time0) 0))
17287 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17288 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17289 (setq time (apply 'encode-time time0))))
17290 ;; Insert the new time-stamp, and ensure point stays in the same
17291 ;; category as before (i.e. not after the last position in that
17292 ;; category).
17293 (let ((pos (point)))
17294 ;; Stay before inserted string. `save-excursion' is of no use.
17295 (setq org-last-changed-timestamp
17296 (org-insert-time-stamp time with-hm inactive nil nil extra))
17297 (goto-char pos))
17298 (save-match-data
17299 (looking-at org-ts-regexp3)
17300 (goto-char (cond
17301 ;; `day' category ends before `hour' if any, or at
17302 ;; the end of the day name.
17303 ((eq origin-cat 'day)
17304 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17305 ((eq origin-cat 'hour) (min (match-end 7) origin))
17306 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17307 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17308 ;; `year' and `month' have both fixed size: point
17309 ;; couldn't have moved into another part.
17310 (t origin))))
17311 ;; Update clock if on a CLOCK line.
17312 (org-clock-update-time-maybe)
17313 ;; Maybe adjust the closest clock in `org-clock-history'
17314 (when org-clock-adjust-closest
17315 (if (not (and (org-at-clock-log-p)
17316 (< 1 (length (delq nil (mapcar 'marker-position
17317 org-clock-history))))))
17318 (message "No clock to adjust")
17319 (cond ((save-excursion ; fix previous clock?
17320 (re-search-backward org-ts-regexp0 nil t)
17323 ((save-excursion ; fix next clock?
17324 (re-search-backward org-ts-regexp0 nil t)
17327 (save-window-excursion
17328 ;; Find closest clock to point, adjust the previous/next one in history
17329 (let* ((p (save-excursion (org-back-to-heading t)))
17330 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17331 (clfixnth
17332 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17333 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17334 (if (not clfixpos)
17335 (message "No clock to adjust")
17336 (save-excursion
17337 (org-goto-marker-or-bmk clfixpos)
17338 (org-show-subtree)
17339 (when (re-search-forward clrgx nil t)
17340 (goto-char (match-beginning 1))
17341 (let (org-clock-adjust-closest)
17342 (org-timestamp-change n org-ts-what updown))
17343 (message "Clock adjusted in %s for heading: %s"
17344 (file-name-nondirectory (buffer-file-name))
17345 (org-get-heading t t)))))))))
17346 ;; Try to recenter the calendar window, if any.
17347 (if (and org-calendar-follow-timestamp-change
17348 (get-buffer-window "*Calendar*" t)
17349 (memq org-ts-what '(day month year)))
17350 (org-recenter-calendar (time-to-days time))))))
17352 (defun org-modify-ts-extra (s pos n dm)
17353 "Change the different parts of the lead-time and repeat fields in timestamp."
17354 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17355 ng h m new rem)
17356 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17357 (cond
17358 ((or (org-pos-in-match-range pos 2)
17359 (org-pos-in-match-range pos 3))
17360 (setq m (string-to-number (match-string 3 s))
17361 h (string-to-number (match-string 2 s)))
17362 (if (org-pos-in-match-range pos 2)
17363 (setq h (+ h n))
17364 (setq n (* dm (org-no-warnings (signum n))))
17365 (when (not (= 0 (setq rem (% m dm))))
17366 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17367 (setq m (+ m n)))
17368 (if (< m 0) (setq m (+ m 60) h (1- h)))
17369 (if (> m 59) (setq m (- m 60) h (1+ h)))
17370 (setq h (min 24 (max 0 h)))
17371 (setq ng 1 new (format "-%02d:%02d" h m)))
17372 ((org-pos-in-match-range pos 6)
17373 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17374 ((org-pos-in-match-range pos 5)
17375 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17377 ((org-pos-in-match-range pos 9)
17378 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17379 ((org-pos-in-match-range pos 8)
17380 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17382 (when ng
17383 (setq s (concat
17384 (substring s 0 (match-beginning ng))
17385 new
17386 (substring s (match-end ng))))))
17387 s))
17389 (defun org-recenter-calendar (date)
17390 "If the calendar is visible, recenter it to DATE."
17391 (let ((cwin (get-buffer-window "*Calendar*" t)))
17392 (when cwin
17393 (let ((calendar-move-hook nil))
17394 (with-selected-window cwin
17395 (calendar-goto-date (if (listp date) date
17396 (calendar-gregorian-from-absolute date))))))))
17398 (defun org-goto-calendar (&optional arg)
17399 "Go to the Emacs calendar at the current date.
17400 If there is a time stamp in the current line, go to that date.
17401 A prefix ARG can be used to force the current date."
17402 (interactive "P")
17403 (let ((tsr org-ts-regexp) diff
17404 (calendar-move-hook nil)
17405 (calendar-view-holidays-initially-flag nil)
17406 (calendar-view-diary-initially-flag nil))
17407 (if (or (org-at-timestamp-p)
17408 (save-excursion
17409 (beginning-of-line 1)
17410 (looking-at (concat ".*" tsr))))
17411 (let ((d1 (time-to-days (current-time)))
17412 (d2 (time-to-days
17413 (org-time-string-to-time (match-string 1)))))
17414 (setq diff (- d2 d1))))
17415 (calendar)
17416 (calendar-goto-today)
17417 (if (and diff (not arg)) (calendar-forward-day diff))))
17419 (defun org-get-date-from-calendar ()
17420 "Return a list (month day year) of date at point in calendar."
17421 (with-current-buffer "*Calendar*"
17422 (save-match-data
17423 (calendar-cursor-to-date))))
17425 (defun org-date-from-calendar ()
17426 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17427 If there is already a time stamp at the cursor position, update it."
17428 (interactive)
17429 (if (org-at-timestamp-p t)
17430 (org-timestamp-change 0 'calendar)
17431 (let ((cal-date (org-get-date-from-calendar)))
17432 (org-insert-time-stamp
17433 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17435 (defcustom org-effort-durations
17436 `(("h" . 60)
17437 ("d" . ,(* 60 8))
17438 ("w" . ,(* 60 8 5))
17439 ("m" . ,(* 60 8 5 4))
17440 ("y" . ,(* 60 8 5 40)))
17441 "Conversion factor to minutes for an effort modifier.
17443 Each entry has the form (MODIFIER . MINUTES).
17445 In an effort string, a number followed by MODIFIER is multiplied
17446 by the specified number of MINUTES to obtain an effort in
17447 minutes.
17451 :group 'org-agenda
17452 :version "24.1"
17453 :type '(alist :key-type (string :tag "Modifier")
17454 :value-type (number :tag "Minutes")))
17456 (defun org-minutes-to-clocksum-string (m)
17457 "Format number of minutes as a clocksum string.
17458 The format is determined by `org-time-clocksum-format',
17459 `org-time-clocksum-use-fractional' and
17460 `org-time-clocksum-fractional-format' and
17461 `org-time-clocksum-use-effort-durations'."
17462 (let ((clocksum "")
17463 (m (round m)) ; Don't allow fractions of minutes
17464 h d w mo y fmt n)
17465 (setq h (if org-time-clocksum-use-effort-durations
17466 (cdr (assoc "h" org-effort-durations)) 60)
17467 d (if org-time-clocksum-use-effort-durations
17468 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17469 w (if org-time-clocksum-use-effort-durations
17470 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17471 mo (if org-time-clocksum-use-effort-durations
17472 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17473 y (if org-time-clocksum-use-effort-durations
17474 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17475 ;; fractional format
17476 (if org-time-clocksum-use-fractional
17477 (cond
17478 ;; single format string
17479 ((stringp org-time-clocksum-fractional-format)
17480 (format org-time-clocksum-fractional-format (/ m (float h))))
17481 ;; choice of fractional formats for different time units
17482 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17483 (> (/ (truncate m) (* y d h)) 0))
17484 (format fmt (/ m (* y d (float h)))))
17485 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17486 (> (/ (truncate m) (* mo d h)) 0))
17487 (format fmt (/ m (* mo d (float h)))))
17488 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17489 (> (/ (truncate m) (* w d h)) 0))
17490 (format fmt (/ m (* w d (float h)))))
17491 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17492 (> (/ (truncate m) (* d h)) 0))
17493 (format fmt (/ m (* d (float h)))))
17494 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17495 (> (/ (truncate m) h) 0))
17496 (format fmt (/ m (float h))))
17497 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17498 (format fmt m))
17499 ;; fall back to smallest time unit with a format
17500 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17501 (format fmt (/ m (float h))))
17502 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17503 (format fmt (/ m (* d (float h)))))
17504 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17505 (format fmt (/ m (* w d (float h)))))
17506 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17507 (format fmt (/ m (* mo d (float h)))))
17508 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17509 (format fmt (/ m (* y d (float h))))))
17510 ;; standard (non-fractional) format, with single format string
17511 (if (stringp org-time-clocksum-format)
17512 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17513 ;; separate formats components
17514 (and (setq fmt (plist-get org-time-clocksum-format :years))
17515 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17516 (plist-get org-time-clocksum-format :require-years))
17517 (setq clocksum (concat clocksum (format fmt n))
17518 m (- m (* n y d h))))
17519 (and (setq fmt (plist-get org-time-clocksum-format :months))
17520 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17521 (plist-get org-time-clocksum-format :require-months))
17522 (setq clocksum (concat clocksum (format fmt n))
17523 m (- m (* n mo d h))))
17524 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17525 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17526 (plist-get org-time-clocksum-format :require-weeks))
17527 (setq clocksum (concat clocksum (format fmt n))
17528 m (- m (* n w d h))))
17529 (and (setq fmt (plist-get org-time-clocksum-format :days))
17530 (or (> (setq n (/ (truncate m) (* d h))) 0)
17531 (plist-get org-time-clocksum-format :require-days))
17532 (setq clocksum (concat clocksum (format fmt n))
17533 m (- m (* n d h))))
17534 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17535 (or (> (setq n (/ (truncate m) h)) 0)
17536 (plist-get org-time-clocksum-format :require-hours))
17537 (setq clocksum (concat clocksum (format fmt n))
17538 m (- m (* n h))))
17539 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17540 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17541 (setq clocksum (concat clocksum (format fmt m))))
17542 ;; return formatted time duration
17543 clocksum))))
17545 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17546 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17547 "Org mode version 8.0")
17549 (defun org-hours-to-clocksum-string (n)
17550 (org-minutes-to-clocksum-string (* n 60)))
17552 (defun org-hh:mm-string-to-minutes (s)
17553 "Convert a string H:MM to a number of minutes.
17554 If the string is just a number, interpret it as minutes.
17555 In fact, the first hh:mm or number in the string will be taken,
17556 there can be extra stuff in the string.
17557 If no number is found, the return value is 0."
17558 (cond
17559 ((integerp s) s)
17561 (+ (* (string-to-number (match-string 1 s)) 60)
17562 (string-to-number (match-string 2 s))))
17564 (string-to-number (match-string 1 s)))
17565 (t 0)))
17567 (defcustom org-image-actual-width t
17568 "Should we use the actual width of images when inlining them?
17570 When set to `t', always use the image width.
17572 When set to a number, use imagemagick (when available) to set
17573 the image's width to this value.
17575 When set to a number in a list, try to get the width from any
17576 #+ATTR.* keyword if it matches a width specification like
17578 #+ATTR_HTML: :width 300px
17580 and fall back on that number if none is found.
17582 When set to nil, try to get the width from an #+ATTR.* keyword
17583 and fall back on the original width if none is found.
17585 This requires Emacs >= 24.1, build with imagemagick support."
17586 :group 'org-appearance
17587 :version "24.4"
17588 :package-version '(Org . "8.0")
17589 :type '(choice
17590 (const :tag "Use the image width" t)
17591 (integer :tag "Use a number of pixels")
17592 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17593 (const :tag "Use #+ATTR* or don't resize" nil)))
17595 (defcustom org-agenda-inhibit-startup nil
17596 "Inhibit startup when preparing agenda buffers.
17597 When this variable is `t' (the default), the initialization of
17598 the Org agenda buffers is inhibited: e.g. the visibility state
17599 is not set, the tables are not re-aligned, etc."
17600 :type 'boolean
17601 :version "24.3"
17602 :group 'org-agenda)
17604 (defun org-duration-string-to-minutes (s &optional output-to-string)
17605 "Convert a duration string S to minutes.
17607 A bare number is interpreted as minutes, modifiers can be set by
17608 customizing `org-effort-durations' (which see).
17610 Entries containing a colon are interpreted as H:MM by
17611 `org-hh:mm-string-to-minutes'."
17612 (let ((result 0)
17614 (regexp-opt (mapcar 'car org-effort-durations))
17616 (while (string-match re s)
17617 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17618 (string-to-number (match-string 1 s))))
17619 (setq s (replace-match "" nil t s)))
17620 (setq result (floor result))
17621 (incf result (org-hh:mm-string-to-minutes s))
17622 (if output-to-string (number-to-string result) result)))
17624 ;;;; Files
17626 (defun org-save-all-org-buffers ()
17627 "Save all Org-mode buffers without user confirmation."
17628 (interactive)
17629 (message "Saving all Org-mode buffers...")
17630 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17631 (when (featurep 'org-id) (org-id-locations-save))
17632 (message "Saving all Org-mode buffers... done"))
17634 (defun org-revert-all-org-buffers ()
17635 "Revert all Org-mode buffers.
17636 Prompt for confirmation when there are unsaved changes.
17637 Be sure you know what you are doing before letting this function
17638 overwrite your changes.
17640 This function is useful in a setup where one tracks org files
17641 with a version control system, to revert on one machine after pulling
17642 changes from another. I believe the procedure must be like this:
17644 1. M-x org-save-all-org-buffers
17645 2. Pull changes from the other machine, resolve conflicts
17646 3. M-x org-revert-all-org-buffers"
17647 (interactive)
17648 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17649 (error "Abort"))
17650 (save-excursion
17651 (save-window-excursion
17652 (mapc
17653 (lambda (b)
17654 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17655 (with-current-buffer b buffer-file-name))
17656 (org-pop-to-buffer-same-window b)
17657 (revert-buffer t 'no-confirm)))
17658 (buffer-list))
17659 (when (and (featurep 'org-id) org-id-track-globally)
17660 (org-id-locations-load)))))
17662 ;;;; Agenda files
17664 ;;;###autoload
17665 (defun org-switchb (&optional arg)
17666 "Switch between Org buffers.
17667 With one prefix argument, restrict available buffers to files.
17668 With two prefix arguments, restrict available buffers to agenda files.
17670 Defaults to `iswitchb' for buffer name completion.
17671 Set `org-completion-use-ido' to make it use ido instead."
17672 (interactive "P")
17673 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17674 ((equal arg '(16)) (org-buffer-list 'agenda))
17675 (t (org-buffer-list))))
17676 (org-completion-use-iswitchb org-completion-use-iswitchb)
17677 (org-completion-use-ido org-completion-use-ido))
17678 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17679 (setq org-completion-use-iswitchb t))
17680 (org-pop-to-buffer-same-window
17681 (org-icompleting-read "Org buffer: "
17682 (mapcar 'list (mapcar 'buffer-name blist))
17683 nil t))))
17685 ;;; Define some older names previously used for this functionality
17686 ;;;###autoload
17687 (defalias 'org-ido-switchb 'org-switchb)
17688 ;;;###autoload
17689 (defalias 'org-iswitchb 'org-switchb)
17691 (defun org-buffer-list (&optional predicate exclude-tmp)
17692 "Return a list of Org buffers.
17693 PREDICATE can be `export', `files' or `agenda'.
17695 export restrict the list to Export buffers.
17696 files restrict the list to buffers visiting Org files.
17697 agenda restrict the list to buffers visiting agenda files.
17699 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17700 (let* ((bfn nil)
17701 (agenda-files (and (eq predicate 'agenda)
17702 (mapcar 'file-truename (org-agenda-files t))))
17703 (filter
17704 (cond
17705 ((eq predicate 'files)
17706 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17707 ((eq predicate 'export)
17708 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17709 ((eq predicate 'agenda)
17710 (lambda (b)
17711 (with-current-buffer b
17712 (and (derived-mode-p 'org-mode)
17713 (setq bfn (buffer-file-name b))
17714 (member (file-truename bfn) agenda-files)))))
17715 (t (lambda (b) (with-current-buffer b
17716 (or (derived-mode-p 'org-mode)
17717 (string-match "\*Org .*Export"
17718 (buffer-name b)))))))))
17719 (delq nil
17720 (mapcar
17721 (lambda(b)
17722 (if (and (funcall filter b)
17723 (or (not exclude-tmp)
17724 (not (string-match "tmp" (buffer-name b)))))
17725 b
17726 nil))
17727 (buffer-list)))))
17729 (defun org-agenda-files (&optional unrestricted archives)
17730 "Get the list of agenda files.
17731 Optional UNRESTRICTED means return the full list even if a restriction
17732 is currently in place.
17733 When ARCHIVES is t, include all archive files that are really being
17734 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17735 `org-agenda-archives-mode' is t."
17736 (let ((files
17737 (cond
17738 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17739 ((stringp org-agenda-files) (org-read-agenda-file-list))
17740 ((listp org-agenda-files) org-agenda-files)
17741 (t (error "Invalid value of `org-agenda-files'")))))
17742 (setq files (apply 'append
17743 (mapcar (lambda (f)
17744 (if (file-directory-p f)
17745 (directory-files
17746 f t org-agenda-file-regexp)
17747 (list f)))
17748 files)))
17749 (when org-agenda-skip-unavailable-files
17750 (setq files (delq nil
17751 (mapcar (function
17752 (lambda (file)
17753 (and (file-readable-p file) file)))
17754 files))))
17755 (when (or (eq archives t)
17756 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17757 (setq files (org-add-archive-files files)))
17758 files))
17760 (defun org-agenda-file-p (&optional file)
17761 "Return non-nil, if FILE is an agenda file.
17762 If FILE is omitted, use the file associated with the current
17763 buffer."
17764 (member (or file (buffer-file-name))
17765 (org-agenda-files t)))
17767 (defun org-edit-agenda-file-list ()
17768 "Edit the list of agenda files.
17769 Depending on setup, this either uses customize to edit the variable
17770 `org-agenda-files', or it visits the file that is holding the list. In the
17771 latter case, the buffer is set up in a way that saving it automatically kills
17772 the buffer and restores the previous window configuration."
17773 (interactive)
17774 (if (stringp org-agenda-files)
17775 (let ((cw (current-window-configuration)))
17776 (find-file org-agenda-files)
17777 (org-set-local 'org-window-configuration cw)
17778 (org-add-hook 'after-save-hook
17779 (lambda ()
17780 (set-window-configuration
17781 (prog1 org-window-configuration
17782 (kill-buffer (current-buffer))))
17783 (org-install-agenda-files-menu)
17784 (message "New agenda file list installed"))
17785 nil 'local)
17786 (message "%s" (substitute-command-keys
17788 (customize-variable 'org-agenda-files)))
17790 (defun org-store-new-agenda-file-list (list)
17791 "Set new value for the agenda file list and save it correctly."
17792 (if (stringp org-agenda-files)
17793 (let ((fe (org-read-agenda-file-list t)) b u)
17794 (while (setq b (find-buffer-visiting org-agenda-files))
17795 (kill-buffer b))
17796 (with-temp-file org-agenda-files
17797 (insert
17798 (mapconcat
17799 (lambda (f) ;; Keep un-expanded entries.
17800 (if (setq u (assoc f fe))
17801 (cdr u)
17802 f))
17805 (let ((org-mode-hook nil) (org-inhibit-startup t)
17806 (org-insert-mode-line-in-empty-file nil))
17807 (setq org-agenda-files list)
17808 (customize-save-variable 'org-agenda-files org-agenda-files))))
17810 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17811 "Read the list of agenda files from a file.
17812 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17813 filenames, used by `org-store-new-agenda-file-list' to write back
17814 un-expanded file names."
17815 (when (file-directory-p org-agenda-files)
17816 (error "`org-agenda-files' cannot be a single directory"))
17817 (when (stringp org-agenda-files)
17818 (with-temp-buffer
17819 (insert-file-contents org-agenda-files)
17820 (mapcar
17821 (lambda (f)
17822 (let ((e (expand-file-name (substitute-in-file-name f)
17823 org-directory)))
17824 (if pair-with-expansion
17825 (cons e f)
17826 e)))
17829 ;;;###autoload
17830 (defun org-cycle-agenda-files ()
17831 "Cycle through the files in `org-agenda-files'.
17832 If the current buffer visits an agenda file, find the next one in the list.
17833 If the current buffer does not, find the first agenda file."
17834 (interactive)
17835 (let* ((fs (org-agenda-files t))
17836 (files (append fs (list (car fs))))
17837 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17838 file)
17839 (unless files (error "No agenda files"))
17840 (catch 'exit
17841 (while (setq file (pop files))
17842 (if (equal (file-truename file) tcf)
17843 (when (car files)
17844 (find-file (car files))
17845 (throw 'exit t))))
17846 (find-file (car fs)))
17847 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17849 (defun org-agenda-file-to-front (&optional to-end)
17850 "Move/add the current file to the top of the agenda file list.
17851 If the file is not present in the list, it is added to the front. If it is
17852 present, it is moved there. With optional argument TO-END, add/move to the
17853 end of the list."
17854 (interactive "P")
17855 (let ((org-agenda-skip-unavailable-files nil)
17856 (file-alist (mapcar (lambda (x)
17857 (cons (file-truename x) x))
17858 (org-agenda-files t)))
17859 (ctf (file-truename
17860 (or buffer-file-name
17861 (error "Please save the current buffer to a file"))))
17862 x had)
17863 (setq x (assoc ctf file-alist) had x)
17865 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17866 (if to-end
17867 (setq file-alist (append (delq x file-alist) (list x)))
17868 (setq file-alist (cons x (delq x file-alist))))
17869 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17870 (org-install-agenda-files-menu)
17871 (message "File %s to %s of agenda file list"
17872 (if had "moved" "added") (if to-end "end" "front"))))
17874 (defun org-remove-file (&optional file)
17875 "Remove current file from the list of files in variable `org-agenda-files'.
17876 These are the files which are being checked for agenda entries.
17877 Optional argument FILE means use this file instead of the current."
17878 (interactive)
17879 (let* ((org-agenda-skip-unavailable-files nil)
17880 (file (or file buffer-file-name
17881 (error "Current buffer does not visit a file")))
17882 (true-file (file-truename file))
17883 (afile (abbreviate-file-name file))
17884 (files (delq nil (mapcar
17885 (lambda (x)
17886 (if (equal true-file
17887 (file-truename x))
17888 nil x))
17889 (org-agenda-files t)))))
17890 (if (not (= (length files) (length (org-agenda-files t))))
17891 (progn
17892 (org-store-new-agenda-file-list files)
17893 (org-install-agenda-files-menu)
17894 (message "Removed file: %s" afile))
17895 (message "File was not in list: %s (not removed)" afile))))
17897 (defun org-file-menu-entry (file)
17898 (vector file (list 'find-file file) t))
17900 (defun org-check-agenda-file (file)
17901 "Make sure FILE exists. If not, ask user what to do."
17902 (when (not (file-exists-p file))
17903 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17904 (abbreviate-file-name file))
17905 (let ((r (downcase (read-char-exclusive))))
17906 (cond
17907 ((equal r ?r)
17908 (org-remove-file file)
17909 (throw 'nextfile t))
17910 (t (error "Abort"))))))
17912 (defun org-get-agenda-file-buffer (file)
17913 "Get a buffer visiting FILE. If the buffer needs to be created, add
17914 it to the list of buffers which might be released later."
17915 (let ((buf (org-find-base-buffer-visiting file)))
17916 (if buf
17917 buf ; just return it
17918 ;; Make a new buffer and remember it
17919 (setq buf (find-file-noselect file))
17920 (if buf (push buf org-agenda-new-buffers))
17921 buf)))
17923 (defun org-release-buffers (blist)
17924 "Release all buffers in list, asking the user for confirmation when needed.
17925 When a buffer is unmodified, it is just killed. When modified, it is saved
17926 \(if the user agrees) and then killed."
17927 (let (buf file)
17928 (while (setq buf (pop blist))
17929 (setq file (buffer-file-name buf))
17930 (when (and (buffer-modified-p buf)
17931 file
17932 (y-or-n-p (format "Save file %s? " file)))
17933 (with-current-buffer buf (save-buffer)))
17934 (kill-buffer buf))))
17936 (defun org-agenda-prepare-buffers (files)
17937 "Create buffers for all agenda files, protect archived trees and comments."
17938 (interactive)
17939 (let ((pa '(:org-archived t))
17940 (pc '(:org-comment t))
17941 (pall '(:org-archived t :org-comment t))
17942 (inhibit-read-only t)
17943 (org-inhibit-startup org-agenda-inhibit-startup)
17944 (rea (concat ":" org-archive-tag ":"))
17945 file re)
17946 (setq org-tag-alist-for-agenda nil
17947 org-tag-groups-alist-for-agenda nil)
17948 (save-excursion
17949 (save-restriction
17950 (while (setq file (pop files))
17951 (catch 'nextfile
17952 (if (bufferp file)
17953 (set-buffer file)
17954 (org-check-agenda-file file)
17955 (set-buffer (org-get-agenda-file-buffer file)))
17956 (widen)
17957 (org-set-regexps-and-options-for-tags)
17958 (org-refresh-category-properties)
17959 (org-refresh-properties org-effort-property 'org-effort)
17960 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
17961 (setq org-todo-keywords-for-agenda
17962 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17963 (setq org-done-keywords-for-agenda
17964 (append org-done-keywords-for-agenda org-done-keywords))
17965 (setq org-todo-keyword-alist-for-agenda
17966 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17967 (setq org-drawers-for-agenda
17968 (append org-drawers-for-agenda org-drawers))
17969 (unless (equal org-tag-alist-for-agenda org-tag-alist)
17970 (setq org-tag-alist-for-agenda
17971 (append org-tag-alist-for-agenda org-tag-alist)))
17972 (if org-group-tags
17973 (setq org-tag-groups-alist-for-agenda
17974 (org-uniquify-alist
17975 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
17976 (org-with-silent-modifications
17977 (save-excursion
17978 (remove-text-properties (point-min) (point-max) pall)
17979 (when org-agenda-skip-archived-trees
17980 (goto-char (point-min))
17981 (while (re-search-forward rea nil t)
17982 (if (org-at-heading-p t)
17983 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17984 (goto-char (point-min))
17985 (setq re (format org-heading-keyword-regexp-format
17986 org-comment-string))
17987 (while (re-search-forward re nil t)
17988 (add-text-properties
17989 (match-beginning 0) (org-end-of-subtree t) pc))))))))
17990 (setq org-todo-keywords-for-agenda
17991 (org-uniquify org-todo-keywords-for-agenda))
17992 (setq org-todo-keyword-alist-for-agenda
17993 (org-uniquify org-todo-keyword-alist-for-agenda))))
17995 \f
17996 ;;;; CDLaTeX minor mode
17998 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17999 "Keymap for the minor `org-cdlatex-mode'.")
18001 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18002 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18003 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18004 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18005 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18007 (defvar org-cdlatex-texmathp-advice-is-done nil
18008 "Flag remembering if we have applied the advice to texmathp already.")
18010 (define-minor-mode org-cdlatex-mode
18011 "Toggle the minor `org-cdlatex-mode'.
18012 This mode supports entering LaTeX environment and math in LaTeX fragments
18013 in Org-mode.
18015 nil " OCDL" nil
18016 (when org-cdlatex-mode
18017 (require 'cdlatex)
18018 (run-hooks 'cdlatex-mode-hook)
18019 (cdlatex-compute-tables))
18020 (unless org-cdlatex-texmathp-advice-is-done
18021 (setq org-cdlatex-texmathp-advice-is-done t)
18022 (defadvice texmathp (around org-math-always-on activate)
18023 "Always return t in org-mode buffers.
18024 This is because we want to insert math symbols without dollars even outside
18025 the LaTeX math segments. If Orgmode thinks that point is actually inside
18026 an embedded LaTeX fragment, let texmathp do its job.
18028 (interactive)
18029 (let (p)
18030 (cond
18031 ((not (derived-mode-p 'org-mode)) ad-do-it)
18032 ((eq this-command 'cdlatex-math-symbol)
18033 (setq ad-return-value t
18034 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18035 (t
18036 (let ((p (org-inside-LaTeX-fragment-p)))
18037 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18038 (setq ad-return-value t
18039 texmathp-why '("Org-mode embedded math" . 0))
18040 (if p ad-do-it)))))))))
18042 (defun turn-on-org-cdlatex ()
18043 "Unconditionally turn on `org-cdlatex-mode'."
18044 (org-cdlatex-mode 1))
18046 (defun org-try-cdlatex-tab ()
18047 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18048 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18049 - inside a LaTeX fragment, or
18050 - after the first word in a line, where an abbreviation expansion could
18051 insert a LaTeX environment."
18052 (when org-cdlatex-mode
18053 (cond
18054 ;; Before any word on the line: No expansion possible.
18056 ;; Just after first word on the line: Expand it. Make sure it
18057 ;; cannot happen on headlines, though.
18058 ((save-excursion
18059 (skip-chars-backward "a-zA-Z0-9*")
18061 (and (bolp) (not (org-at-heading-p))))
18062 (cdlatex-tab) t)
18063 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18065 (defun org-cdlatex-underscore-caret (&optional arg)
18066 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18067 Revert to the normal definition outside of these fragments."
18068 (interactive "P")
18069 (if (org-inside-LaTeX-fragment-p)
18070 (call-interactively 'cdlatex-sub-superscript)
18071 (let (org-cdlatex-mode)
18072 (call-interactively (key-binding (vector last-input-event))))))
18074 (defun org-cdlatex-math-modify (&optional arg)
18075 "Execute `cdlatex-math-modify' in LaTeX fragments.
18076 Revert to the normal definition outside of these fragments."
18077 (interactive "P")
18078 (if (org-inside-LaTeX-fragment-p)
18079 (call-interactively 'cdlatex-math-modify)
18080 (let (org-cdlatex-mode)
18081 (call-interactively (key-binding (vector last-input-event))))))
18084 \f
18085 ;;;; LaTeX fragments
18087 (defvar org-latex-regexps
18089 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18092 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18096 "Regular expressions for matching embedded LaTeX.")
18098 (defun org-inside-LaTeX-fragment-p ()
18099 "Test if point is inside a LaTeX fragment.
18101 sequence appearing also before point.
18102 Even though the matchers for math are configurable, this function assumes
18104 delimiters are skipped when they have been removed by customization.
18105 The return value is nil, or a cons cell with the delimiter and the
18106 position of this delimiter.
18108 This function does a reasonably good job, but can locally be fooled by
18109 for example currency specifications. For example it will assume being in
18111 fragments that are properly closed, but during editing, we have to live
18112 with the uncertainty caused by missing closing delimiters. This function
18113 looks only before point, not after."
18114 (catch 'exit
18115 (let ((pos (point))
18116 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18117 (lim (progn
18119 (point)))
18120 dd-on str (start 0) m re)
18121 (goto-char pos)
18122 (when dodollar
18124 re (nth 1 (assoc "$" org-latex-regexps)))
18125 (while (string-match re str start)
18126 (cond
18127 ((= (match-end 0) (length str))
18128 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18129 ((= (match-end 0) (- (length str) 5))
18130 (throw 'exit nil))
18131 (t (setq start (match-end 0))))))
18132 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18133 (goto-char pos)
18134 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18135 (and (match-beginning 2) (throw 'exit nil))
18136 ;; count $$
18138 (setq dd-on (not dd-on)))
18139 (goto-char pos)
18140 (if dd-on (cons "$$" m))))))
18142 (defun org-inside-latex-macro-p ()
18143 "Is point inside a LaTeX macro or its arguments?"
18144 (save-match-data
18145 (org-in-regexp
18148 (defvar org-latex-fragment-image-overlays nil
18149 "List of overlays carrying the images of latex fragments.")
18150 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18152 (defun org-remove-latex-fragment-image-overlays ()
18153 "Remove all overlays with LaTeX fragment images in current buffer."
18154 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18155 (setq org-latex-fragment-image-overlays nil))
18157 (defun org-preview-latex-fragment (&optional subtree)
18158 "Preview the LaTeX fragment at point, or all locally or globally.
18159 If the cursor is in a LaTeX fragment, create the image and overlay
18160 it over the source code. If there is no fragment at point, display
18161 all fragments in the current text, from one headline to the next. With
18162 prefix SUBTREE, display all fragments in the current subtree. With a
18164 the cursor is before the first headline,
18165 display all fragments in the buffer.
18167 (interactive "P")
18168 (unless buffer-file-name
18169 (error "Can't preview LaTeX fragment in a non-file buffer"))
18170 (org-remove-latex-fragment-image-overlays)
18171 (save-excursion
18172 (save-restriction
18173 (let (beg end at msg)
18174 (cond
18175 ((or (equal subtree '(16))
18176 (not (save-excursion
18177 (re-search-backward org-outline-regexp-bol nil t))))
18178 (setq beg (point-min) end (point-max)
18179 msg "Creating images for buffer...%s"))
18180 ((equal subtree '(4))
18181 (org-back-to-heading)
18182 (setq beg (point) end (org-end-of-subtree t)
18183 msg "Creating images for subtree...%s"))
18184 (t
18185 (if (setq at (org-inside-LaTeX-fragment-p))
18186 (goto-char (max (point-min) (- (cdr at) 2)))
18187 (org-back-to-heading))
18188 (setq beg (point) end (progn (outline-next-heading) (point))
18189 msg (if at "Creating image...%s"
18190 "Creating images for entry...%s"))))
18191 (message msg "")
18192 (narrow-to-region beg end)
18193 (goto-char beg)
18194 (org-format-latex
18195 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18196 (file-name-nondirectory
18197 buffer-file-name)))
18198 default-directory 'overlays msg at 'forbuffer
18199 org-latex-create-formula-image-program)
18200 (message msg "done. Use `C-c C-c' to remove images.")))))
18202 (defun org-format-latex (prefix &optional dir overlays msg at
18203 forbuffer processing-type)
18204 "Replace LaTeX fragments with links to an image, and produce images.
18205 Some of the options can be changed using the variable
18206 `org-format-latex-options'."
18207 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18208 (let* ((prefixnodir (file-name-nondirectory prefix))
18209 (absprefix (expand-file-name prefix dir))
18210 (todir (file-name-directory absprefix))
18211 (opt org-format-latex-options)
18212 (optnew org-format-latex-options)
18213 (matchers (plist-get opt :matchers))
18214 (re-list org-latex-regexps)
18215 (cnt 0) txt hash link beg end re e checkdir
18216 string
18217 m n block-type block linkfile movefile ov)
18218 ;; Check the different regular expressions
18219 (while (setq e (pop re-list))
18220 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18222 (when (member m matchers)
18223 (goto-char (point-min))
18224 (while (re-search-forward re nil t)
18225 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18226 (or (not overlays)
18227 (not (eq (get-char-property (match-beginning n)
18228 'org-overlay-type)
18229 'org-latex-overlay))))
18230 (cond
18231 ((eq processing-type 'verbatim))
18232 ((eq processing-type 'mathjax)
18233 ;; Prepare for MathJax processing.
18234 (setq string (match-string n))
18235 (when (member m '("$" "$1"))
18236 (save-excursion
18237 (delete-region (match-beginning n) (match-end n))
18238 (goto-char (match-beginning n))
18240 ((or (eq processing-type 'dvipng)
18241 (eq processing-type 'imagemagick))
18242 ;; Process to an image.
18243 (setq txt (match-string n)
18244 beg (match-beginning n) end (match-end n)
18245 cnt (1+ cnt))
18246 (let ((face (face-at-point))
18247 (fg (plist-get opt :foreground))
18248 (bg (plist-get opt :background))
18249 ;; Ensure full list is printed.
18250 print-length print-level)
18251 (when forbuffer
18252 ;; Get the colors from the face at point.
18253 (goto-char beg)
18254 (when (eq fg 'auto)
18255 (setq fg (face-attribute face :foreground nil 'default)))
18256 (when (eq bg 'auto)
18257 (setq bg (face-attribute face :background nil 'default)))
18258 (setq optnew (copy-sequence opt))
18259 (plist-put optnew :foreground fg)
18260 (plist-put optnew :background bg))
18261 (setq hash (sha1 (prin1-to-string
18262 (list org-format-latex-header
18263 org-latex-default-packages-alist
18264 org-latex-packages-alist
18265 org-format-latex-options
18266 forbuffer txt fg bg)))
18267 linkfile (format "%s_%s.png" prefix hash)
18268 movefile (format "%s_%s.png" absprefix hash)))
18269 (setq link (concat block "[[file:" linkfile "]]" block))
18270 (if msg (message msg cnt))
18271 (goto-char beg)
18272 (unless checkdir ; Ensure the directory exists.
18273 (setq checkdir t)
18274 (or (file-directory-p todir) (make-directory todir t)))
18275 (unless (file-exists-p movefile)
18276 (org-create-formula-image
18277 txt movefile optnew forbuffer processing-type))
18278 (if overlays
18279 (progn
18280 (mapc (lambda (o)
18281 (if (eq (overlay-get o 'org-overlay-type)
18282 'org-latex-overlay)
18283 (delete-overlay o)))
18284 (overlays-in beg end))
18285 (setq ov (make-overlay beg end))
18286 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18287 (if (featurep 'xemacs)
18288 (progn
18289 (overlay-put ov 'invisible t)
18290 (overlay-put
18291 ov 'end-glyph
18292 (make-glyph (vector 'png :file movefile))))
18293 (overlay-put
18294 ov 'display
18295 (list 'image :type 'png :file movefile :ascent 'center)))
18296 (push ov org-latex-fragment-image-overlays)
18297 (goto-char end))
18298 (delete-region beg end)
18299 (insert (org-add-props link
18300 (list 'org-latex-src
18301 (replace-regexp-in-string
18303 'org-latex-src-embed-type
18304 (if block-type 'paragraph 'character))))))
18305 ((eq processing-type 'mathml)
18306 ;; Process to MathML
18307 (unless (save-match-data (org-format-latex-mathml-available-p))
18308 (error "LaTeX to MathML converter not configured"))
18309 (setq txt (match-string n)
18310 beg (match-beginning n) end (match-end n)
18311 cnt (1+ cnt))
18312 (if msg (message msg cnt))
18313 (goto-char beg)
18314 (delete-region beg end)
18315 (insert (org-format-latex-as-mathml
18316 txt block-type prefix dir)))
18317 (t
18318 (error "Unknown conversion type %s for latex fragments"
18319 processing-type)))))))))
18321 (defun org-create-math-formula (latex-frag &optional mathml-file)
18322 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18323 Use `org-latex-to-mathml-convert-command'. If the conversion is
18325 elements otherwise return nil. When MATHML-FILE is specified,
18326 write the results in to that file. When invoked as an
18327 interactive command, prompt for LATEX-FRAG, with initial value
18328 set to the current active region and echo the results for user
18329 inspection."
18330 (interactive (list (let ((frag (when (org-region-active-p)
18331 (buffer-substring-no-properties
18332 (region-beginning) (region-end)))))
18333 (read-string "LaTeX Fragment: " frag nil frag))))
18334 (unless latex-frag (error "Invalid latex-frag"))
18335 (let* ((tmp-in-file (file-relative-name
18336 (make-temp-name (expand-file-name "ltxmathml-in"))))
18337 (ignore (write-region latex-frag nil tmp-in-file))
18338 (tmp-out-file (file-relative-name
18339 (make-temp-name (expand-file-name "ltxmathml-out"))))
18340 (cmd (format-spec
18341 org-latex-to-mathml-convert-command
18342 `((?j . ,(shell-quote-argument
18343 (expand-file-name org-latex-to-mathml-jar-file)))
18344 (?I . ,(shell-quote-argument tmp-in-file))
18345 (?o . ,(shell-quote-argument tmp-out-file)))))
18346 mathml shell-command-output)
18347 (when (org-called-interactively-p 'any)
18348 (unless (org-format-latex-mathml-available-p)
18349 (error "LaTeX to MathML converter not configured")))
18350 (message "Running %s" cmd)
18351 (setq shell-command-output (shell-command-to-string cmd))
18352 (setq mathml
18353 (when (file-readable-p tmp-out-file)
18354 (with-current-buffer (find-file-noselect tmp-out-file t)
18355 (goto-char (point-min))
18356 (when (re-search-forward
18357 (concat
18358 (regexp-quote
18361 (regexp-quote "</math>")) nil t)
18362 (prog1 (match-string 0) (kill-buffer))))))
18363 (cond
18364 (mathml
18365 (setq mathml
18367 (when mathml-file
18368 (write-region mathml nil mathml-file))
18369 (when (org-called-interactively-p 'any)
18370 (message mathml)))
18371 ((message "LaTeX to MathML conversion failed")
18372 (message shell-command-output)))
18373 (delete-file tmp-in-file)
18374 (when (file-exists-p tmp-out-file)
18375 (delete-file tmp-out-file))
18376 mathml))
18378 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18379 prefix &optional dir)
18380 "Use `org-create-math-formula' but check local cache first."
18381 (let* ((absprefix (expand-file-name prefix dir))
18382 (print-length nil) (print-level nil)
18383 (formula-id (concat
18384 "formula-"
18385 (sha1
18386 (prin1-to-string
18387 (list latex-frag
18388 org-latex-to-mathml-convert-command)))))
18389 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18390 (formula-cache-dir (file-name-directory formula-cache)))
18392 (unless (file-directory-p formula-cache-dir)
18393 (make-directory formula-cache-dir t))
18395 (unless (file-exists-p formula-cache)
18396 (org-create-math-formula latex-frag formula-cache))
18398 (if (file-exists-p formula-cache)
18399 ;; Successful conversion. Return the link to MathML file.
18400 (org-add-props
18401 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18403 'org-latex-src-embed-type (if latex-frag-type
18404 'paragraph 'character)))
18405 ;; Failed conversion. Return the LaTeX fragment verbatim
18406 latex-frag)))
18408 (defun org-create-formula-image (string tofile options buffer &optional type)
18409 "Create an image from LaTeX source using dvipng or convert.
18410 This function calls either `org-create-formula-image-with-dvipng'
18411 or `org-create-formula-image-with-imagemagick' depending on the
18412 value of `org-latex-create-formula-image-program' or on the value
18413 of the optional TYPE variable.
18415 Note: ultimately these two function should be combined as they
18416 share a good deal of logic."
18417 (org-check-external-command
18418 "latex" "needed to convert LaTeX fragments to images")
18419 (funcall
18420 (case (or type org-latex-create-formula-image-program)
18421 ('dvipng
18422 (org-check-external-command
18423 "dvipng" "needed to convert LaTeX fragments to images")
18424 #'org-create-formula-image-with-dvipng)
18425 ('imagemagick
18426 (org-check-external-command
18427 "convert" "you need to install imagemagick")
18428 #'org-create-formula-image-with-imagemagick)
18429 (t (error
18430 "invalid value of `org-latex-create-formula-image-program'")))
18431 string tofile options buffer))
18433 (declare-function org-export--get-global-options "ox" (&optional backend))
18434 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18435 (defun org-create-formula--latex-header ()
18436 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18437 (org-latex-guess-inputenc
18438 (org-splice-latex-header
18439 org-format-latex-header
18440 org-latex-default-packages-alist
18441 org-latex-packages-alist t
18442 (plist-get
18443 (org-combine-plists
18444 (org-export--get-global-options 'latex)
18445 (org-export--get-inbuffer-options 'latex))
18446 :latex-header))))
18448 ;; This function borrows from Ganesh Swami's latex2png.el
18449 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18450 "This calls dvipng."
18451 (require 'ox-latex)
18452 (let* ((tmpdir (if (featurep 'xemacs)
18453 (temp-directory)
18454 temporary-file-directory))
18455 (texfilebase (make-temp-name
18456 (expand-file-name "orgtex" tmpdir)))
18457 (texfile (concat texfilebase ".tex"))
18458 (dvifile (concat texfilebase ".dvi"))
18459 (pngfile (concat texfilebase ".png"))
18460 (fnh (if (featurep 'xemacs)
18461 (font-height (face-font 'default))
18462 (face-attribute 'default :height nil)))
18463 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18464 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18465 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18466 "Black"))
18467 (bg (or (plist-get options (if buffer :background :html-background))
18468 "Transparent")))
18469 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18470 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18471 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18472 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18473 (let ((latex-header (org-create-formula--latex-header)))
18474 (with-temp-file texfile
18475 (insert latex-header)
18477 (let ((dir default-directory))
18478 (condition-case nil
18479 (progn
18480 (cd tmpdir)
18481 (call-process "latex" nil nil nil texfile))
18482 (error nil))
18483 (cd dir))
18484 (if (not (file-exists-p dvifile))
18485 (progn (message "Failed to create dvi file from %s" texfile) nil)
18486 (condition-case nil
18487 (if (featurep 'xemacs)
18488 (call-process "dvipng" nil nil nil
18489 "-fg" fg "-bg" bg
18490 "-T" "tight"
18491 "-o" pngfile
18492 dvifile)
18493 (call-process "dvipng" nil nil nil
18494 "-fg" fg "-bg" bg
18495 "-D" dpi
18496 ;;"-x" scale "-y" scale
18497 "-T" "tight"
18498 "-o" pngfile
18499 dvifile))
18500 (error nil))
18501 (if (not (file-exists-p pngfile))
18502 (if org-format-latex-signal-error
18503 (error "Failed to create png file from %s" texfile)
18504 (message "Failed to create png file from %s" texfile)
18505 nil)
18506 ;; Use the requested file name and clean up
18507 (copy-file pngfile tofile 'replace)
18508 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18509 (if (file-exists-p (concat texfilebase e))
18510 (delete-file (concat texfilebase e))))
18511 pngfile))))
18513 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18514 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18515 "This calls convert, which is included into imagemagick."
18516 (require 'ox-latex)
18517 (let* ((tmpdir (if (featurep 'xemacs)
18518 (temp-directory)
18519 temporary-file-directory))
18520 (texfilebase (make-temp-name
18521 (expand-file-name "orgtex" tmpdir)))
18522 (texfile (concat texfilebase ".tex"))
18523 (pdffile (concat texfilebase ".pdf"))
18524 (pngfile (concat texfilebase ".png"))
18525 (fnh (if (featurep 'xemacs)
18526 (font-height (face-font 'default))
18527 (face-attribute 'default :height nil)))
18528 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18529 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18530 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18531 "black"))
18532 (bg (or (plist-get options (if buffer :background :html-background))
18533 "white")))
18534 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18535 (setq fg (org-latex-color-format fg)))
18536 (if (eq bg 'default) (setq bg (org-latex-color :background))
18537 (setq bg (org-latex-color-format
18538 (if (string= bg "Transparent") "white" bg))))
18539 (let ((latex-header (org-create-formula--latex-header)))
18540 (with-temp-file texfile
18541 (insert latex-header)
18547 string
18550 (org-latex-compile texfile t)
18551 (if (not (file-exists-p pdffile))
18552 (progn (message "Failed to create pdf file from %s" texfile) nil)
18553 (condition-case nil
18554 (if (featurep 'xemacs)
18555 (call-process "convert" nil nil nil
18556 "-density" "96"
18557 "-trim"
18558 "-antialias"
18559 pdffile
18560 "-quality" "100"
18561 ;; "-sharpen" "0x1.0"
18562 pngfile)
18563 (call-process "convert" nil nil nil
18564 "-density" dpi
18565 "-trim"
18566 "-antialias"
18567 pdffile
18568 "-quality" "100"
18569 ;; "-sharpen" "0x1.0"
18570 pngfile))
18571 (error nil))
18572 (if (not (file-exists-p pngfile))
18573 (if org-format-latex-signal-error
18574 (error "Failed to create png file from %s" texfile)
18575 (message "Failed to create png file from %s" texfile)
18576 nil)
18577 ;; Use the requested file name and clean up
18578 (copy-file pngfile tofile 'replace)
18579 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18580 (if (file-exists-p (concat texfilebase e))
18581 (delete-file (concat texfilebase e))))
18582 pngfile))))
18584 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18585 "Fill a LaTeX header template TPL.
18586 In the template, the following place holders will be recognized:
18589 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18591 [NO-PACKAGES] do not include PKG
18592 [EXTRA] the string EXTRA
18593 [NO-EXTRA] do not include EXTRA
18595 For backward compatibility, if both the positive and the negative place
18597 assumed to be present at the end of the template.
18598 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18599 EXTRA is a string.
18600 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18601 (let (rpl (end ""))
18603 (setq rpl (if (or (match-end 1) (not def-pkg))
18604 "" (org-latex-packages-to-string def-pkg snippets-p t))
18605 tpl (replace-match rpl t t tpl))
18606 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18609 (setq rpl (if (or (match-end 1) (not pkg))
18610 "" (org-latex-packages-to-string pkg snippets-p t))
18611 tpl (replace-match rpl t t tpl))
18612 (if pkg (setq end
18614 (org-latex-packages-to-string pkg snippets-p)))))
18617 (setq rpl (if (or (match-end 1) (not extra))
18619 tpl (replace-match rpl t t tpl))
18625 tpl)))
18627 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18629 (setq pkg (mapconcat (lambda(p)
18630 (cond
18631 ((stringp p) p)
18632 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18633 (format "%% Package %s omitted" (cadr p)))
18634 ((equal "" (car p))
18636 (t
18638 (car p) (cadr p)))))
18639 pkg
18643 (defun org-dvipng-color (attr)
18644 "Return a RGB color specification for dvipng."
18645 (apply 'format "rgb %s %s %s"
18646 (mapcar 'org-normalize-color
18647 (if (featurep 'xemacs)
18648 (color-rgb-components
18649 (face-property 'default
18650 (cond ((eq attr :foreground) 'foreground)
18651 ((eq attr :background) 'background))))
18652 (color-values (face-attribute 'default attr nil))))))
18654 (defun org-dvipng-color-format (color-name)
18655 "Convert COLOR-NAME to a RGB color value for dvipng."
18656 (apply 'format "rgb %s %s %s"
18657 (mapcar 'org-normalize-color
18658 (color-values color-name))))
18660 (defun org-latex-color (attr)
18661 "Return a RGB color for the LaTeX color package."
18662 (apply 'format "%s,%s,%s"
18663 (mapcar 'org-normalize-color
18664 (if (featurep 'xemacs)
18665 (color-rgb-components
18666 (face-property 'default
18667 (cond ((eq attr :foreground) 'foreground)
18668 ((eq attr :background) 'background))))
18669 (color-values (face-attribute 'default attr nil))))))
18671 (defun org-latex-color-format (color-name)
18672 "Convert COLOR-NAME to a RGB color value."
18673 (apply 'format "%s,%s,%s"
18674 (mapcar 'org-normalize-color
18675 (color-values color-name))))
18677 (defun org-normalize-color (value)
18678 "Return string to be used as color value for an RGB component."
18679 (format "%g" (/ value 65535.0)))
18682 \f
18683 ;; Image display
18685 (defvar org-inline-image-overlays nil)
18686 (make-variable-buffer-local 'org-inline-image-overlays)
18688 (defun org-toggle-inline-images (&optional include-linked)
18689 "Toggle the display of inline images.
18690 INCLUDE-LINKED is passed to `org-display-inline-images'."
18691 (interactive "P")
18692 (if org-inline-image-overlays
18693 (progn
18694 (org-remove-inline-images)
18695 (message "Inline image display turned off"))
18696 (org-display-inline-images include-linked)
18697 (if (and (org-called-interactively-p)
18698 org-inline-image-overlays)
18699 (message "%d images displayed inline"
18700 (length org-inline-image-overlays))
18701 (message "No images to display inline"))))
18703 (defun org-redisplay-inline-images ()
18704 "Refresh the display of inline images."
18705 (interactive)
18706 (if (not org-inline-image-overlays)
18707 (org-toggle-inline-images)
18708 (org-toggle-inline-images)
18709 (org-toggle-inline-images)))
18711 (defun org-display-inline-images (&optional include-linked refresh beg end)
18712 "Display inline images.
18713 Normally only links without a description part are inlined, because this
18714 is how it will work for export. When INCLUDE-LINKED is set, also links
18715 with a description part will be inlined. This can be nice for a quick
18716 look at those images, but it does not reflect what exported files will look
18717 like.
18718 When REFRESH is set, refresh existing images between BEG and END.
18719 This will create new image displays only if necessary.
18720 BEG and END default to the buffer boundaries."
18721 (interactive "P")
18722 (unless refresh
18723 (org-remove-inline-images)
18724 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18725 (save-excursion
18726 (save-restriction
18727 (widen)
18728 (setq beg (or beg (point-min)) end (or end (point-max)))
18729 (goto-char beg)
18731 (substring (org-image-file-name-regexp) 0 -2)
18733 (case-fold-search t)
18734 old file ov img type attrwidth width)
18735 (while (re-search-forward re end t)
18736 (setq old (get-char-property-and-overlay (match-beginning 1)
18737 'org-image-overlay)
18738 file (expand-file-name
18739 (concat (or (match-string 3) "") (match-string 4))))
18740 (when (image-type-available-p 'imagemagick)
18741 (setq attrwidth (if (or (listp org-image-actual-width)
18742 (null org-image-actual-width))
18743 (save-excursion
18744 (save-match-data
18745 (when (re-search-backward
18747 (save-excursion
18749 (string-to-number (match-string 1))))))
18750 width (cond ((eq org-image-actual-width t) nil)
18751 ((null org-image-actual-width) attrwidth)
18752 ((numberp org-image-actual-width)
18753 org-image-actual-width)
18754 ((listp org-image-actual-width)
18755 (or attrwidth (car org-image-actual-width))))
18756 type (if width 'imagemagick)))
18757 (when (file-exists-p file)
18758 (if (and (car-safe old) refresh)
18759 (image-refresh (overlay-get (cdr old) 'display))
18760 (setq img (save-match-data (create-image file type nil :width width)))
18761 (when img
18762 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18763 (overlay-put ov 'display img)
18764 (overlay-put ov 'face 'default)
18765 (overlay-put ov 'org-image-overlay t)
18766 (overlay-put ov 'modification-hooks
18767 (list 'org-display-inline-remove-overlay))
18768 (push ov org-inline-image-overlays)))))))))
18770 (define-obsolete-function-alias
18771 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18773 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18774 "Remove inline-display overlay if a corresponding region is modified."
18775 (let ((inhibit-modification-hooks t))
18776 (when (and ov after)
18777 (delete ov org-inline-image-overlays)
18778 (delete-overlay ov))))
18780 (defun org-remove-inline-images ()
18781 "Remove inline display of images."
18782 (interactive)
18783 (mapc 'delete-overlay org-inline-image-overlays)
18784 (setq org-inline-image-overlays nil))
18786 ;;;; Key bindings
18788 ;; Outline functions from `outline-mode-prefix-map'
18789 ;; that can be remapped in Org:
18790 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18791 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18792 (define-key org-mode-map [remap outline-forward-same-level]
18793 'org-forward-heading-same-level)
18794 (define-key org-mode-map [remap outline-backward-same-level]
18795 'org-backward-heading-same-level)
18796 (define-key org-mode-map [remap show-branches]
18797 'org-kill-note-or-show-branches)
18798 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18799 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18800 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18802 ;; Outline functions from `outline-mode-prefix-map' that can not
18803 ;; be remapped in Org:
18804 ;;
18805 ;; - the column "key binding" shows whether the Outline function is still
18806 ;; available in Org mode on the same key that it has been bound to in
18807 ;; Outline mode:
18808 ;; - "overridden": key used for a different functionality in Org mode
18809 ;; - else: key still bound to the same Outline function in Org mode
18810 ;;
18811 ;; | Outline function | key binding | Org replacement |
18812 ;; |------------------------------------+-------------+-----------------------|
18813 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18814 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18815 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18816 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18817 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18818 ;; | `show-entry' | overridden | no replacement |
18819 ;; | `show-children' | `C-c C-i' | visibility cycling |
18820 ;; | `show-branches' | `C-c C-k' | still same function |
18821 ;; | `show-subtree' | overridden | visibility cycling |
18822 ;; | `show-all' | overridden | no replacement |
18823 ;; | `hide-subtree' | overridden | visibility cycling |
18824 ;; | `hide-body' | overridden | no replacement |
18825 ;; | `hide-entry' | overridden | visibility cycling |
18826 ;; | `hide-leaves' | overridden | no replacement |
18827 ;; | `hide-sublevels' | overridden | no replacement |
18828 ;; | `hide-other' | overridden | no replacement |
18830 ;; Make `C-c C-x' a prefix key
18831 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18833 ;; TAB key with modifiers
18834 (org-defkey org-mode-map "\C-i" 'org-cycle)
18835 (org-defkey org-mode-map [(tab)] 'org-cycle)
18836 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18838 ;; The following line is necessary under Suse GNU/Linux
18839 (unless (featurep 'xemacs)
18840 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18841 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18842 (define-key org-mode-map [backtab] 'org-shifttab)
18844 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18845 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18846 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18848 ;; Cursor keys with modifiers
18849 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18850 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18851 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18852 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18854 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18855 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18856 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18857 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18859 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18860 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18861 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18862 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18864 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18865 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18866 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18867 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18869 ;; Babel keys
18870 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18871 (mapc (lambda (pair)
18872 (define-key org-babel-map (car pair) (cdr pair)))
18873 org-babel-key-bindings)
18875 ;;; Extra keys for tty access.
18876 ;; We only set them when really needed because otherwise the
18877 ;; menus don't show the simple keys
18879 (when (or org-use-extra-keys
18880 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18881 (not window-system))
18882 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18883 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18884 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18885 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18886 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18887 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18888 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18889 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18890 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18891 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18892 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18893 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18894 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18895 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18896 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18897 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18898 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18899 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18900 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18901 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18902 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18903 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18904 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18905 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18906 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18907 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18908 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18909 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18911 ;; All the other keys
18913 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18914 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18915 (if (boundp 'narrow-map)
18916 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18917 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18918 (if (boundp 'narrow-map)
18919 (org-defkey narrow-map "b" 'org-narrow-to-block)
18920 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18921 (if (boundp 'narrow-map)
18922 (org-defkey narrow-map "e" 'org-narrow-to-element)
18923 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18924 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18925 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18926 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18927 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18928 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18929 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18930 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18931 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
18932 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
18933 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18934 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18935 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18936 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18937 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18938 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18939 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18940 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
18941 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18942 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18943 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18944 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18945 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18946 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18947 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18948 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18949 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18951 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18952 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18953 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18954 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18955 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18956 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18957 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18958 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18959 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18960 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18961 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18962 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18963 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18964 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18965 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18966 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18967 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18968 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18969 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18970 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18971 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18973 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18974 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18975 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18976 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18977 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18978 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18979 (org-defkey org-mode-map "\C-c^" 'org-sort)
18980 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18981 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18982 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18983 (org-defkey org-mode-map [remap open-line] 'org-open-line)
18984 (org-defkey org-mode-map "\C-m" 'org-return)
18985 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18986 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18987 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18988 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18989 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18990 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18991 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18992 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18993 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18994 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18995 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18996 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18997 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
18998 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
18999 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19000 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19001 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19002 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19003 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19004 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19005 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19006 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19007 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19009 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19010 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19011 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19013 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19014 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19015 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19016 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19017 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19018 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19019 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19020 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19021 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19022 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19023 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19024 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19025 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19027 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19028 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19029 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19030 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19031 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19032 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19033 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19034 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19035 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19037 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19038 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19039 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19040 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19041 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19043 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19045 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19047 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19048 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19050 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19053 (when (featurep 'xemacs)
19054 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19057 (defconst org-speed-commands-default
19058 '(
19059 ("Outline Navigation")
19060 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19061 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19062 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19063 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19064 ("F" . org-next-block)
19065 ("B" . org-previous-block)
19066 ("u" . (org-speed-move-safe 'outline-up-heading))
19067 ("j" . org-goto)
19068 ("g" . (org-refile t))
19069 ("Outline Visibility")
19070 ("c" . org-cycle)
19071 ("C" . org-shifttab)
19072 (" " . org-display-outline-path)
19073 ("s" . org-narrow-to-subtree)
19074 ("=" . org-columns)
19075 ("Outline Structure Editing")
19076 ("U" . org-shiftmetaup)
19077 ("D" . org-shiftmetadown)
19078 ("r" . org-metaright)
19079 ("l" . org-metaleft)
19080 ("R" . org-shiftmetaright)
19081 ("L" . org-shiftmetaleft)
19082 ("i" . (progn (forward-char 1) (call-interactively
19083 'org-insert-heading-respect-content)))
19084 ("^" . org-sort)
19085 ("w" . org-refile)
19086 ("a" . org-archive-subtree-default-with-confirmation)
19087 ("@" . org-mark-subtree)
19088 ("#" . org-toggle-comment)
19089 ("Clock Commands")
19090 ("I" . org-clock-in)
19091 ("O" . org-clock-out)
19092 ("Meta Data Editing")
19093 ("t" . org-todo)
19094 ("," . (org-priority))
19095 ("0" . (org-priority ?\ ))
19096 ("1" . (org-priority ?A))
19097 ("2" . (org-priority ?B))
19098 ("3" . (org-priority ?C))
19099 (":" . org-set-tags-command)
19100 ("e" . org-set-effort)
19101 ("E" . org-inc-effort)
19102 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19103 (org-entry-put (point) "APPT_WARNTIME" m)))
19104 ("Agenda Views etc")
19105 ("v" . org-agenda)
19106 ("/" . org-sparse-tree)
19107 ("Misc")
19108 ("o" . org-open-at-point)
19109 ("?" . org-speed-command-help)
19110 ("<" . (org-agenda-set-restriction-lock 'subtree))
19111 (">" . (org-agenda-remove-restriction-lock))
19112 )
19113 "The default speed commands.")
19115 (defun org-print-speed-command (e)
19116 (if (> (length (car e)) 1)
19117 (progn
19119 (princ (car e))
19121 (princ (make-string (length (car e)) ?-))
19123 (princ (car e))
19124 (princ " ")
19125 (if (symbolp (cdr e))
19126 (princ (symbol-name (cdr e)))
19127 (prin1 (cdr e)))
19130 (defun org-speed-command-help ()
19131 "Show the available speed commands."
19132 (interactive)
19133 (if (not org-use-speed-commands)
19134 (error "Speed commands are not activated, customize `org-use-speed-commands'")
19135 (with-output-to-temp-buffer "*Help*"
19137 (mapc 'org-print-speed-command org-speed-commands-user)
19140 (mapc 'org-print-speed-command org-speed-commands-default))
19141 (with-current-buffer "*Help*"
19142 (setq truncate-lines t))))
19144 (defun org-speed-move-safe (cmd)
19145 "Execute CMD, but make sure that the cursor always ends up in a headline.
19146 If not, return to the original position and throw an error."
19147 (interactive)
19148 (let ((pos (point)))
19149 (call-interactively cmd)
19150 (unless (and (bolp) (org-at-heading-p))
19151 (goto-char pos)
19152 (error "Boundary reached while executing %s" cmd))))
19154 (defvar org-self-insert-command-undo-counter 0)
19156 (defvar org-table-auto-blank-field) ; defined in org-table.el
19157 (defvar org-speed-command nil)
19159 (define-obsolete-function-alias
19160 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19162 (defun org-speed-command-activate (keys)
19163 "Hook for activating single-letter speed commands.
19164 `org-speed-commands-default' specifies a minimal command set.
19165 Use `org-speed-commands-user' for further customization."
19166 (when (or (and (bolp) (looking-at org-outline-regexp))
19167 (and (functionp org-use-speed-commands)
19168 (funcall org-use-speed-commands)))
19169 (cdr (assoc keys (append org-speed-commands-user
19170 org-speed-commands-default)))))
19172 (define-obsolete-function-alias
19173 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19175 (defun org-babel-speed-command-activate (keys)
19176 "Hook for activating single-letter code block commands."
19177 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19178 (cdr (assoc keys org-babel-key-bindings))))
19180 (defcustom org-speed-command-hook
19181 '(org-speed-command-default-hook org-babel-speed-command-hook)
19182 "Hook for activating speed commands at strategic locations.
19183 Hook functions are called in sequence until a valid handler is
19184 found.
19186 Each hook takes a single argument, a user-pressed command key
19187 which is also a `self-insert-command' from the global map.
19189 Within the hook, examine the cursor position and the command key
19190 and return nil or a valid handler as appropriate. Handler could
19191 be one of an interactive command, a function, or a form.
19193 Set `org-use-speed-commands' to non-nil value to enable this
19194 hook. The default setting is `org-speed-command-activate'."
19195 :group 'org-structure
19196 :version "24.1"
19197 :type 'hook)
19199 (defun org-self-insert-command (N)
19200 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19201 If the cursor is in a table looking at whitespace, the whitespace is
19202 overwritten, and the table is not marked as requiring realignment."
19203 (interactive "p")
19204 (org-check-before-invisible-edit 'insert)
19205 (cond
19206 ((and org-use-speed-commands
19207 (setq org-speed-command
19208 (run-hook-with-args-until-success
19209 'org-speed-command-hook (this-command-keys))))
19210 (cond
19211 ((commandp org-speed-command)
19212 (setq this-command org-speed-command)
19213 (call-interactively org-speed-command))
19214 ((functionp org-speed-command)
19215 (funcall org-speed-command))
19216 ((and org-speed-command (listp org-speed-command))
19217 (eval org-speed-command))
19218 (t (let (org-use-speed-commands)
19219 (call-interactively 'org-self-insert-command)))))
19220 ((and
19221 (org-table-p)
19222 (progn
19223 ;; check if we blank the field, and if that triggers align
19224 (and (featurep 'org-table) org-table-auto-blank-field
19225 (member last-command
19226 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19228 ;; got extra space, this field does not determine column width
19229 (let (org-table-may-need-update) (org-table-blank-field))
19230 ;; no extra space, this field may determine column width
19231 (org-table-blank-field)))
19232 t)
19233 (eq N 1)
19235 (let (org-table-may-need-update)
19236 (goto-char (1- (match-end 0)))
19237 (backward-delete-char 1)
19238 (goto-char (match-beginning 0))
19239 (self-insert-command N)))
19240 (t
19241 (setq org-table-may-need-update t)
19242 (self-insert-command N)
19243 (org-fix-tags-on-the-fly)
19244 (if org-self-insert-cluster-for-undo
19245 (if (not (eq last-command 'org-self-insert-command))
19246 (setq org-self-insert-command-undo-counter 1)
19247 (if (>= org-self-insert-command-undo-counter 20)
19248 (setq org-self-insert-command-undo-counter 1)
19249 (and (> org-self-insert-command-undo-counter 0)
19250 buffer-undo-list (listp buffer-undo-list)
19251 (not (cadr buffer-undo-list)) ; remove nil entry
19252 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19253 (setq org-self-insert-command-undo-counter
19254 (1+ org-self-insert-command-undo-counter))))))))
19256 (defun org-check-before-invisible-edit (kind)
19257 "Check is editing if kind KIND would be dangerous with invisible text around.
19258 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19259 ;; First, try to get out of here as quickly as possible, to reduce overhead
19260 (if (and org-catch-invisible-edits
19261 (or (not (boundp 'visible-mode)) (not visible-mode))
19262 (or (get-char-property (point) 'invisible)
19263 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19264 ;; OK, we need to take a closer look
19265 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19266 (invisible-before-point (if (bobp) nil (get-char-property
19267 (1- (point)) 'invisible)))
19268 (border-and-ok-direction
19269 (or
19270 ;; Check if we are acting predictably before invisible text
19271 (and invisible-at-point (not invisible-before-point)
19272 (memq kind '(insert delete-backward)))
19273 ;; Check if we are acting predictably after invisible text
19274 ;; This works not well, and I have turned it off. It seems
19275 ;; better to always show and stop after invisible text.
19276 ;; (and (not invisible-at-point) invisible-before-point
19277 ;; (memq kind '(insert delete)))
19278 )))
19279 (when (or (memq invisible-at-point '(outline org-hide-block t))
19280 (memq invisible-before-point '(outline org-hide-block t)))
19281 (if (eq org-catch-invisible-edits 'error)
19282 (error "Editing in invisible areas is prohibited - make visible first"))
19283 (if (and org-custom-properties-overlays
19284 (y-or-n-p "Display invisible properties in this buffer? "))
19285 (org-toggle-custom-properties-visibility)
19286 ;; Make the area visible
19287 (save-excursion
19288 (if invisible-before-point
19289 (goto-char (previous-single-char-property-change
19290 (point) 'invisible)))
19291 (org-cycle))
19292 (cond
19293 ((eq org-catch-invisible-edits 'show)
19294 ;; That's it, we do the edit after showing
19295 (message
19296 "Unfolding invisible region around point before editing")
19297 (sit-for 1))
19298 ((and (eq org-catch-invisible-edits 'smart)
19299 border-and-ok-direction)
19300 (message "Unfolding invisible region around point before editing"))
19301 (t
19302 ;; Don't do the edit, make the user repeat it in full visibility
19303 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19305 (defun org-fix-tags-on-the-fly ()
19306 (when (and (equal (char-after (point-at-bol)) ?*)
19307 (org-at-heading-p))
19308 (org-align-tags-here org-tags-column)))
19310 (defun org-delete-backward-char (N)
19311 "Like `delete-backward-char', insert whitespace at field end in tables.
19312 When deleting backwards, in tables this function will insert whitespace in
19314 still be marked for re-alignment if the field did fill the entire column,
19315 because, in this case the deletion might narrow the column."
19316 (interactive "p")
19317 (save-match-data
19318 (org-check-before-invisible-edit 'delete-backward)
19319 (if (and (org-table-p)
19320 (eq N 1)
19321 (string-match "|" (buffer-substring (point-at-bol) (point)))
19322 (looking-at ".*?|"))
19323 (let ((pos (point))
19325 (c org-table-may-need-update))
19326 (backward-delete-char N)
19327 (if (not overwrite-mode)
19328 (progn
19329 (skip-chars-forward "^|")
19330 (insert " ")
19331 (goto-char (1- pos))))
19332 ;; noalign: if there were two spaces at the end, this field
19333 ;; does not determine the width of the column.
19334 (if noalign (setq org-table-may-need-update c)))
19335 (backward-delete-char N)
19336 (org-fix-tags-on-the-fly))))
19338 (defun org-delete-char (N)
19339 "Like `delete-char', but insert whitespace at field end in tables.
19340 When deleting characters, in tables this function will insert whitespace in
19342 still be marked for re-alignment if the field did fill the entire column,
19343 because, in this case the deletion might narrow the column."
19344 (interactive "p")
19345 (save-match-data
19346 (org-check-before-invisible-edit 'delete)
19347 (if (and (org-table-p)
19348 (not (bolp))
19349 (not (= (char-after) ?|))
19350 (eq N 1))
19351 (if (looking-at ".*?|")
19352 (let ((pos (point))
19354 (c org-table-may-need-update))
19355 (replace-match
19356 (concat (substring (match-string 0) 1 -1) " |") nil t)
19357 (goto-char pos)
19358 ;; noalign: if there were two spaces at the end, this field
19359 ;; does not determine the width of the column.
19360 (if noalign (setq org-table-may-need-update c)))
19361 (delete-char N))
19362 (delete-char N)
19363 (org-fix-tags-on-the-fly))))
19365 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19366 (put 'org-self-insert-command 'delete-selection t)
19367 (put 'orgtbl-self-insert-command 'delete-selection t)
19368 (put 'org-delete-char 'delete-selection 'supersede)
19369 (put 'org-delete-backward-char 'delete-selection 'supersede)
19370 (put 'org-yank 'delete-selection 'yank)
19372 ;; Make `flyspell-mode' delay after some commands
19373 (put 'org-self-insert-command 'flyspell-delayed t)
19374 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19375 (put 'org-delete-char 'flyspell-delayed t)
19376 (put 'org-delete-backward-char 'flyspell-delayed t)
19378 ;; Make pabbrev-mode expand after org-mode commands
19379 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19380 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19382 ;; How to do this: Measure non-white length of current string
19383 ;; If equal to column width, we should realign.
19385 (defun org-remap (map &rest commands)
19386 "In MAP, remap the functions given in COMMANDS.
19387 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19388 (let (new old)
19389 (while commands
19390 (setq old (pop commands) new (pop commands))
19391 (if (fboundp 'command-remapping)
19392 (org-defkey map (vector 'remap old) new)
19393 (substitute-key-definition old new map global-map)))))
19395 (defun org-transpose-words ()
19396 "Transpose words for Org.
19397 This uses the `org-mode-transpose-word-syntax-table' syntax
19398 table, which interprets characters in `org-emphasis-alist' as
19399 word constituants."
19400 (interactive)
19401 (with-syntax-table org-mode-transpose-word-syntax-table
19402 (call-interactively 'transpose-words)))
19403 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19405 (when (eq org-enable-table-editor 'optimized)
19406 ;; If the user wants maximum table support, we need to hijack
19407 ;; some standard editing functions
19408 (org-remap org-mode-map
19409 'self-insert-command 'org-self-insert-command
19410 'delete-char 'org-delete-char
19411 'delete-backward-char 'org-delete-backward-char)
19412 (org-defkey org-mode-map "|" 'org-force-self-insert))
19414 (defvar org-ctrl-c-ctrl-c-hook nil
19415 "Hook for functions attaching themselves to `C-c C-c'.
19417 This can be used to add additional functionality to the C-c C-c
19418 key which executes context-dependent commands. This hook is run
19419 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19420 run after the last test.
19422 Each function will be called with no arguments. The function
19423 must check if the context is appropriate for it to act. If yes,
19424 it should do its thing and then return a non-nil value. If the
19425 context is wrong, just do nothing and return nil.")
19427 (defvar org-ctrl-c-ctrl-c-final-hook nil
19428 "Hook for functions attaching themselves to `C-c C-c'.
19430 This can be used to add additional functionality to the C-c C-c
19431 key which executes context-dependent commands. This hook is run
19432 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19433 before the first test.
19435 Each function will be called with no arguments. The function
19436 must check if the context is appropriate for it to act. If yes,
19437 it should do its thing and then return a non-nil value. If the
19438 context is wrong, just do nothing and return nil.")
19440 (defvar org-tab-first-hook nil
19441 "Hook for functions to attach themselves to TAB.
19442 See `org-ctrl-c-ctrl-c-hook' for more information.
19443 This hook runs as the first action when TAB is pressed, even before
19444 `org-cycle' messes around with the `outline-regexp' to cater for
19445 inline tasks and plain list item folding.
19446 If any function in this hook returns t, any other actions that
19447 would have been caused by TAB (such as table field motion or visibility
19448 cycling) will not occur.")
19450 (defvar org-tab-after-check-for-table-hook nil
19451 "Hook for functions to attach themselves to TAB.
19452 See `org-ctrl-c-ctrl-c-hook' for more information.
19453 This hook runs after it has been established that the cursor is not in a
19454 table, but before checking if the cursor is in a headline or if global cycling
19455 should be done.
19456 If any function in this hook returns t, not other actions like visibility
19457 cycling will be done.")
19459 (defvar org-tab-after-check-for-cycling-hook nil
19460 "Hook for functions to attach themselves to TAB.
19461 See `org-ctrl-c-ctrl-c-hook' for more information.
19462 This hook runs after it has been established that not table field motion and
19463 not visibility should be done because of current context. This is probably
19464 the place where a package like yasnippets can hook in.")
19466 (defvar org-tab-before-tab-emulation-hook nil
19467 "Hook for functions to attach themselves to TAB.
19468 See `org-ctrl-c-ctrl-c-hook' for more information.
19469 This hook runs after every other options for TAB have been exhausted, but
19472 (defvar org-metaleft-hook nil
19473 "Hook for functions attaching themselves to `M-left'.
19474 See `org-ctrl-c-ctrl-c-hook' for more information.")
19475 (defvar org-metaright-hook nil
19476 "Hook for functions attaching themselves to `M-right'.
19477 See `org-ctrl-c-ctrl-c-hook' for more information.")
19478 (defvar org-metaup-hook nil
19479 "Hook for functions attaching themselves to `M-up'.
19480 See `org-ctrl-c-ctrl-c-hook' for more information.")
19481 (defvar org-metadown-hook nil
19482 "Hook for functions attaching themselves to `M-down'.
19483 See `org-ctrl-c-ctrl-c-hook' for more information.")
19484 (defvar org-shiftmetaleft-hook nil
19485 "Hook for functions attaching themselves to `M-S-left'.
19486 See `org-ctrl-c-ctrl-c-hook' for more information.")
19487 (defvar org-shiftmetaright-hook nil
19488 "Hook for functions attaching themselves to `M-S-right'.
19489 See `org-ctrl-c-ctrl-c-hook' for more information.")
19490 (defvar org-shiftmetaup-hook nil
19491 "Hook for functions attaching themselves to `M-S-up'.
19492 See `org-ctrl-c-ctrl-c-hook' for more information.")
19493 (defvar org-shiftmetadown-hook nil
19494 "Hook for functions attaching themselves to `M-S-down'.
19495 See `org-ctrl-c-ctrl-c-hook' for more information.")
19496 (defvar org-metareturn-hook nil
19497 "Hook for functions attaching themselves to `M-RET'.
19498 See `org-ctrl-c-ctrl-c-hook' for more information.")
19499 (defvar org-shiftup-hook nil
19500 "Hook for functions attaching themselves to `S-up'.
19501 See `org-ctrl-c-ctrl-c-hook' for more information.")
19502 (defvar org-shiftup-final-hook nil
19503 "Hook for functions attaching themselves to `S-up'.
19504 This one runs after all other options except shift-select have been excluded.
19505 See `org-ctrl-c-ctrl-c-hook' for more information.")
19506 (defvar org-shiftdown-hook nil
19507 "Hook for functions attaching themselves to `S-down'.
19508 See `org-ctrl-c-ctrl-c-hook' for more information.")
19509 (defvar org-shiftdown-final-hook nil
19510 "Hook for functions attaching themselves to `S-down'.
19511 This one runs after all other options except shift-select have been excluded.
19512 See `org-ctrl-c-ctrl-c-hook' for more information.")
19513 (defvar org-shiftleft-hook nil
19514 "Hook for functions attaching themselves to `S-left'.
19515 See `org-ctrl-c-ctrl-c-hook' for more information.")
19516 (defvar org-shiftleft-final-hook nil
19517 "Hook for functions attaching themselves to `S-left'.
19518 This one runs after all other options except shift-select have been excluded.
19519 See `org-ctrl-c-ctrl-c-hook' for more information.")
19520 (defvar org-shiftright-hook nil
19521 "Hook for functions attaching themselves to `S-right'.
19522 See `org-ctrl-c-ctrl-c-hook' for more information.")
19523 (defvar org-shiftright-final-hook nil
19524 "Hook for functions attaching themselves to `S-right'.
19525 This one runs after all other options except shift-select have been excluded.
19526 See `org-ctrl-c-ctrl-c-hook' for more information.")
19528 (defun org-modifier-cursor-error ()
19529 "Throw an error, a modified cursor command was applied in wrong context."
19530 (error "This command is active in special context like tables, headlines or items"))
19532 (defun org-shiftselect-error ()
19533 "Throw an error because Shift-Cursor command was applied in wrong context."
19534 (if (and (boundp 'shift-select-mode) shift-select-mode)
19535 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19536 (error "This command works only in special context like headlines or timestamps")))
19538 (defun org-call-for-shift-select (cmd)
19539 (let ((this-command-keys-shift-translated t))
19540 (call-interactively cmd)))
19542 (defun org-shifttab (&optional arg)
19543 "Global visibility cycling or move to previous table field.
19544 Call `org-table-previous-field' within a table.
19545 When ARG is nil, cycle globally through visibility states.
19546 When ARG is a numeric prefix, show contents of this level."
19547 (interactive "P")
19548 (cond
19549 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19550 ((integerp arg)
19551 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19552 (message "Content view to level: %d" arg)
19553 (org-content (prefix-numeric-value arg2))
19554 (org-cycle-show-empty-lines t)
19555 (setq org-cycle-global-status 'overview)))
19556 (t (call-interactively 'org-global-cycle))))
19558 (defun org-shiftmetaleft ()
19559 "Promote subtree or delete table column.
19560 Calls `org-promote-subtree', `org-outdent-item-tree', or
19561 `org-table-delete-column', depending on context. See the
19562 individual commands for more information."
19563 (interactive)
19564 (cond
19565 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19566 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19567 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19568 ((if (not (org-region-active-p)) (org-at-item-p)
19569 (save-excursion (goto-char (region-beginning))
19570 (org-at-item-p)))
19571 (call-interactively 'org-outdent-item-tree))
19572 (t (org-modifier-cursor-error))))
19574 (defun org-shiftmetaright ()
19575 "Demote subtree or insert table column.
19576 Calls `org-demote-subtree', `org-indent-item-tree', or
19577 `org-table-insert-column', depending on context. See the
19578 individual commands for more information."
19579 (interactive)
19580 (cond
19581 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19582 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19583 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19584 ((if (not (org-region-active-p)) (org-at-item-p)
19585 (save-excursion (goto-char (region-beginning))
19586 (org-at-item-p)))
19587 (call-interactively 'org-indent-item-tree))
19588 (t (org-modifier-cursor-error))))
19590 (defun org-shiftmetaup (&optional arg)
19591 "Move subtree up or kill table row.
19592 Calls `org-move-subtree-up' or `org-table-kill-row' or
19593 `org-move-item-up' or `org-timestamp-up', depending on context.
19594 See the individual commands for more information."
19595 (interactive "P")
19596 (cond
19597 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19598 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19599 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19600 ((org-at-item-p) (call-interactively 'org-move-item-up))
19601 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19602 (call-interactively 'org-timestamp-up)))
19603 (t (call-interactively 'org-drag-line-backward))))
19605 (defun org-shiftmetadown (&optional arg)
19606 "Move subtree down or insert table row.
19607 Calls `org-move-subtree-down' or `org-table-insert-row' or
19608 `org-move-item-down' or `org-timestamp-up', depending on context.
19609 See the individual commands for more information."
19610 (interactive "P")
19611 (cond
19612 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19613 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19614 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19615 ((org-at-item-p) (call-interactively 'org-move-item-down))
19616 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19617 (call-interactively 'org-timestamp-down)))
19618 (t (call-interactively 'org-drag-line-forward))))
19620 (defsubst org-hidden-tree-error ()
19621 (error
19622 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19624 (defun org-metaleft (&optional arg)
19625 "Promote heading or move table column to left.
19626 Calls `org-do-promote' or `org-table-move-column', depending on context.
19627 With no specific context, calls the Emacs default `backward-word'.
19628 See the individual commands for more information."
19629 (interactive "P")
19630 (cond
19631 ((run-hook-with-args-until-success 'org-metaleft-hook))
19632 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19633 ((org-with-limited-levels
19634 (or (org-at-heading-p)
19635 (and (org-region-active-p)
19636 (save-excursion
19637 (goto-char (region-beginning))
19638 (org-at-heading-p)))))
19639 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19640 (call-interactively 'org-do-promote))
19641 ;; At an inline task.
19642 ((org-at-heading-p)
19643 (call-interactively 'org-inlinetask-promote))
19644 ((or (org-at-item-p)
19645 (and (org-region-active-p)
19646 (save-excursion
19647 (goto-char (region-beginning))
19648 (org-at-item-p))))
19649 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19650 (call-interactively 'org-outdent-item))
19651 (t (call-interactively 'backward-word))))
19653 (defun org-metaright (&optional arg)
19654 "Demote a subtree, a list item or move table column to right.
19655 In front of a drawer or a block keyword, indent it correctly.
19656 With no specific context, calls the Emacs default `forward-word'.
19657 See the individual commands for more information."
19658 (interactive "P")
19659 (cond
19660 ((run-hook-with-args-until-success 'org-metaright-hook))
19661 ((org-at-table-p) (call-interactively 'org-table-move-column))
19662 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19663 ((org-at-block-p) (call-interactively 'org-indent-block))
19664 ((org-with-limited-levels
19665 (or (org-at-heading-p)
19666 (and (org-region-active-p)
19667 (save-excursion
19668 (goto-char (region-beginning))
19669 (org-at-heading-p)))))
19670 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19671 (call-interactively 'org-do-demote))
19672 ;; At an inline task.
19673 ((org-at-heading-p)
19674 (call-interactively 'org-inlinetask-demote))
19675 ((or (org-at-item-p)
19676 (and (org-region-active-p)
19677 (save-excursion
19678 (goto-char (region-beginning))
19679 (org-at-item-p))))
19680 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19681 (call-interactively 'org-indent-item))
19682 (t (call-interactively 'forward-word))))
19684 (defun org-check-for-hidden (what)
19685 "Check if there are hidden headlines/items in the current visual line.
19686 WHAT can be either `headlines' or `items'. If the current line is
19687 an outline or item heading and it has a folded subtree below it,
19688 this function returns t, nil otherwise."
19689 (let ((re (cond
19690 ((eq what 'headlines) org-outline-regexp-bol)
19691 ((eq what 'items) (org-item-beginning-re))
19692 (t (error "This should not happen"))))
19693 beg end)
19694 (save-excursion
19695 (catch 'exit
19696 (unless (org-region-active-p)
19697 (setq beg (point-at-bol))
19698 (beginning-of-line 2)
19699 (while (and (not (eobp)) ;; this is like `next-line'
19700 (get-char-property (1- (point)) 'invisible))
19701 (beginning-of-line 2))
19702 (setq end (point))
19703 (goto-char beg)
19704 (goto-char (point-at-eol))
19705 (setq end (max end (point)))
19706 (while (re-search-forward re end t)
19707 (if (get-char-property (match-beginning 0) 'invisible)
19708 (throw 'exit t))))
19709 nil))))
19711 (defun org-metaup (&optional arg)
19712 "Move subtree up or move table row up.
19713 Calls `org-move-subtree-up' or `org-table-move-row' or
19714 `org-move-item-up', depending on context. See the individual commands
19715 for more information."
19716 (interactive "P")
19717 (cond
19718 ((run-hook-with-args-until-success 'org-metaup-hook))
19719 ((org-region-active-p)
19720 (let* ((a (min (region-beginning) (region-end)))
19721 (b (1- (max (region-beginning) (region-end))))
19722 (c (save-excursion (goto-char a)
19723 (move-beginning-of-line 0)))
19724 (d (save-excursion (goto-char a)
19725 (move-end-of-line 0) (point))))
19726 (transpose-regions a b c d)
19727 (goto-char c)))
19728 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19729 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19730 ((org-at-item-p) (call-interactively 'org-move-item-up))
19731 (t (org-drag-element-backward))))
19733 (defun org-metadown (&optional arg)
19734 "Move subtree down or move table row down.
19735 Calls `org-move-subtree-down' or `org-table-move-row' or
19736 `org-move-item-down', depending on context. See the individual
19737 commands for more information."
19738 (interactive "P")
19739 (cond
19740 ((run-hook-with-args-until-success 'org-metadown-hook))
19741 ((org-region-active-p)
19742 (let* ((a (min (region-beginning) (region-end)))
19743 (b (max (region-beginning) (region-end)))
19744 (c (save-excursion (goto-char b)
19745 (move-beginning-of-line 1)))
19746 (d (save-excursion (goto-char b)
19747 (move-end-of-line 1) (1+ (point)))))
19748 (transpose-regions a b c d)
19749 (goto-char d)))
19750 ((org-at-table-p) (call-interactively 'org-table-move-row))
19751 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19752 ((org-at-item-p) (call-interactively 'org-move-item-down))
19753 (t (org-drag-element-forward))))
19755 (defun org-shiftup (&optional arg)
19756 "Increase item in timestamp or increase priority of current headline.
19757 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19758 depending on context. See the individual commands for more information."
19759 (interactive "P")
19760 (cond
19761 ((run-hook-with-args-until-success 'org-shiftup-hook))
19762 ((and org-support-shift-select (org-region-active-p))
19763 (org-call-for-shift-select 'previous-line))
19764 ((org-at-timestamp-p t)
19765 (call-interactively (if org-edit-timestamp-down-means-later
19766 'org-timestamp-down 'org-timestamp-up)))
19767 ((and (not (eq org-support-shift-select 'always))
19768 org-enable-priority-commands
19769 (org-at-heading-p))
19770 (call-interactively 'org-priority-up))
19771 ((and (not org-support-shift-select) (org-at-item-p))
19772 (call-interactively 'org-previous-item))
19773 ((org-clocktable-try-shift 'up arg))
19774 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19775 (org-support-shift-select
19776 (org-call-for-shift-select 'previous-line))
19777 (t (org-shiftselect-error))))
19779 (defun org-shiftdown (&optional arg)
19780 "Decrease item in timestamp or decrease priority of current headline.
19781 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19782 depending on context. See the individual commands for more information."
19783 (interactive "P")
19784 (cond
19785 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19786 ((and org-support-shift-select (org-region-active-p))
19787 (org-call-for-shift-select 'next-line))
19788 ((org-at-timestamp-p t)
19789 (call-interactively (if org-edit-timestamp-down-means-later
19790 'org-timestamp-up 'org-timestamp-down)))
19791 ((and (not (eq org-support-shift-select 'always))
19792 org-enable-priority-commands
19793 (org-at-heading-p))
19794 (call-interactively 'org-priority-down))
19795 ((and (not org-support-shift-select) (org-at-item-p))
19796 (call-interactively 'org-next-item))
19797 ((org-clocktable-try-shift 'down arg))
19798 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19799 (org-support-shift-select
19800 (org-call-for-shift-select 'next-line))
19801 (t (org-shiftselect-error))))
19803 (defun org-shiftright (&optional arg)
19804 "Cycle the thing at point or in the current line, depending on context.
19805 Depending on context, this does one of the following:
19807 - switch a timestamp at point one day into the future
19808 - on a headline, switch to the next TODO keyword.
19809 - on an item, switch entire list to the next bullet type
19810 - on a property line, switch to the next allowed value
19811 - on a clocktable definition line, move time block into the future"
19812 (interactive "P")
19813 (cond
19814 ((run-hook-with-args-until-success 'org-shiftright-hook))
19815 ((and org-support-shift-select (org-region-active-p))
19816 (org-call-for-shift-select 'forward-char))
19817 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19818 ((and (not (eq org-support-shift-select 'always))
19819 (org-at-heading-p))
19820 (let ((org-inhibit-logging
19821 (not org-treat-S-cursor-todo-selection-as-state-change))
19822 (org-inhibit-blocking
19823 (not org-treat-S-cursor-todo-selection-as-state-change)))
19824 (org-call-with-arg 'org-todo 'right)))
19825 ((or (and org-support-shift-select
19826 (not (eq org-support-shift-select 'always))
19827 (org-at-item-bullet-p))
19828 (and (not org-support-shift-select) (org-at-item-p)))
19829 (org-call-with-arg 'org-cycle-list-bullet nil))
19830 ((and (not (eq org-support-shift-select 'always))
19831 (org-at-property-p))
19832 (call-interactively 'org-property-next-allowed-value))
19833 ((org-clocktable-try-shift 'right arg))
19834 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19835 (org-support-shift-select
19836 (org-call-for-shift-select 'forward-char))
19837 (t (org-shiftselect-error))))
19839 (defun org-shiftleft (&optional arg)
19840 "Cycle the thing at point or in the current line, depending on context.
19841 Depending on context, this does one of the following:
19843 - switch a timestamp at point one day into the past
19844 - on a headline, switch to the previous TODO keyword.
19845 - on an item, switch entire list to the previous bullet type
19846 - on a property line, switch to the previous allowed value
19847 - on a clocktable definition line, move time block into the past"
19848 (interactive "P")
19849 (cond
19850 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19851 ((and org-support-shift-select (org-region-active-p))
19852 (org-call-for-shift-select 'backward-char))
19853 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19854 ((and (not (eq org-support-shift-select 'always))
19855 (org-at-heading-p))
19856 (let ((org-inhibit-logging
19857 (not org-treat-S-cursor-todo-selection-as-state-change))
19858 (org-inhibit-blocking
19859 (not org-treat-S-cursor-todo-selection-as-state-change)))
19860 (org-call-with-arg 'org-todo 'left)))
19861 ((or (and org-support-shift-select
19862 (not (eq org-support-shift-select 'always))
19863 (org-at-item-bullet-p))
19864 (and (not org-support-shift-select) (org-at-item-p)))
19865 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19866 ((and (not (eq org-support-shift-select 'always))
19867 (org-at-property-p))
19868 (call-interactively 'org-property-previous-allowed-value))
19869 ((org-clocktable-try-shift 'left arg))
19870 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19871 (org-support-shift-select
19872 (org-call-for-shift-select 'backward-char))
19873 (t (org-shiftselect-error))))
19875 (defun org-shiftcontrolright ()
19876 "Switch to next TODO set."
19877 (interactive)
19878 (cond
19879 ((and org-support-shift-select (org-region-active-p))
19880 (org-call-for-shift-select 'forward-word))
19881 ((and (not (eq org-support-shift-select 'always))
19882 (org-at-heading-p))
19883 (org-call-with-arg 'org-todo 'nextset))
19884 (org-support-shift-select
19885 (org-call-for-shift-select 'forward-word))
19886 (t (org-shiftselect-error))))
19888 (defun org-shiftcontrolleft ()
19889 "Switch to previous TODO set."
19890 (interactive)
19891 (cond
19892 ((and org-support-shift-select (org-region-active-p))
19893 (org-call-for-shift-select 'backward-word))
19894 ((and (not (eq org-support-shift-select 'always))
19895 (org-at-heading-p))
19896 (org-call-with-arg 'org-todo 'previousset))
19897 (org-support-shift-select
19898 (org-call-for-shift-select 'backward-word))
19899 (t (org-shiftselect-error))))
19901 (defun org-shiftcontrolup (&optional n)
19902 "Change timestamps synchronously up in CLOCK log lines.
19903 Optional argument N tells to change by that many units."
19904 (interactive "P")
19905 (cond ((and (not org-support-shift-select)
19906 (org-at-clock-log-p)
19907 (org-at-timestamp-p t))
19908 (org-clock-timestamps-up n))
19909 (t (org-shiftselect-error))))
19911 (defun org-shiftcontroldown (&optional n)
19912 "Change timestamps synchronously down in CLOCK log lines.
19913 Optional argument N tells to change by that many units."
19914 (interactive "P")
19915 (cond ((and (not org-support-shift-select)
19916 (org-at-clock-log-p)
19917 (org-at-timestamp-p t))
19918 (org-clock-timestamps-down n))
19919 (t (org-shiftselect-error))))
19921 (defun org-ctrl-c-ret ()
19922 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19923 (interactive)
19924 (cond
19925 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19926 (t (call-interactively 'org-insert-heading))))
19928 (defun org-find-visible ()
19929 (let ((s (point)))
19930 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19931 (get-char-property s 'invisible)))
19932 s))
19933 (defun org-find-invisible ()
19934 (let ((s (point)))
19935 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19936 (not (get-char-property s 'invisible))))
19937 s))
19939 (defun org-copy-visible (beg end)
19940 "Copy the visible parts of the region."
19941 (interactive "r")
19942 (let (snippets s)
19943 (save-excursion
19944 (save-restriction
19945 (narrow-to-region beg end)
19946 (setq s (goto-char (point-min)))
19947 (while (not (= (point) (point-max)))
19948 (goto-char (org-find-invisible))
19949 (push (buffer-substring s (point)) snippets)
19950 (setq s (goto-char (org-find-visible))))))
19951 (kill-new (apply 'concat (nreverse snippets)))))
19953 (defun org-copy-special ()
19954 "Copy region in table or copy current subtree.
19955 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19956 See the individual commands for more information."
19957 (interactive)
19958 (call-interactively
19959 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19961 (defun org-cut-special ()
19962 "Cut region in table or cut current subtree.
19963 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19964 See the individual commands for more information."
19965 (interactive)
19966 (call-interactively
19967 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19969 (defun org-paste-special (arg)
19970 "Paste rectangular region into table, or past subtree relative to level.
19971 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19972 See the individual commands for more information."
19973 (interactive "P")
19974 (if (org-at-table-p)
19975 (org-table-paste-rectangle)
19976 (org-paste-subtree arg)))
19978 (defsubst org-in-fixed-width-region-p ()
19979 "Is point in a fixed-width region?"
19980 (save-match-data
19981 (eq 'fixed-width (org-element-type (org-element-at-point)))))
19983 (defun org-edit-special (&optional arg)
19984 "Call a special editor for the element at point.
19985 When at a table, call the formula editor with `org-table-edit-formulas'.
19986 When in a source code block, call `org-edit-src-code'.
19987 When in a fixed-width region, call `org-edit-fixed-width-region'.
19988 When at an #+INCLUDE keyword, visit the included file.
19989 On a link, call `ffap' to visit the link at point.
19990 Otherwise, return a user error."
19991 (interactive "P")
19992 (let ((element (org-element-at-point)))
19993 (assert (not buffer-read-only) nil
19994 "Buffer is read-only: %s" (buffer-name))
19995 (case (org-element-type element)
19996 (src-block
19997 (if (not arg) (org-edit-src-code)
19998 (let* ((info (org-babel-get-src-block-info))
19999 (lang (nth 0 info))
20000 (params (nth 2 info))
20001 (session (cdr (assq :session params))))
20002 (if (not session) (org-edit-src-code)
20003 ;; At a src-block with a session and function called with
20004 ;; an ARG: switch to the buffer related to the inferior
20005 ;; process.
20006 (switch-to-buffer
20007 (funcall (intern (concat "org-babel-prep-session:" lang))
20008 session params))))))
20009 (keyword
20010 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20011 (find-file
20012 (org-remove-double-quotes
20013 (car (org-split-string (org-element-property :value element)))))
20014 (user-error "No special environment to edit here")))
20015 (table
20016 (if (eq (org-element-property :type element) 'table.el)
20017 (org-edit-src-code)
20018 (call-interactively 'org-table-edit-formulas)))
20019 ;; Only Org tables contain `table-row' type elements.
20020 (table-row (call-interactively 'org-table-edit-formulas))
20021 ((example-block export-block) (org-edit-src-code))
20022 (fixed-width (org-edit-fixed-width-region))
20023 (otherwise
20024 ;; No notable element at point. Though, we may be at a link,
20025 ;; which is an object. Thus, scan deeper.
20026 (if (eq (org-element-type (org-element-context element)) 'link)
20027 (call-interactively 'ffap)
20028 (user-error "No special environment to edit here"))))))
20030 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20031 (defun org-ctrl-c-ctrl-c (&optional arg)
20032 "Set tags in headline, or update according to changed information at point.
20034 This command does many different things, depending on context:
20036 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20037 this is what we do.
20039 - If the cursor is on a statistics cookie, update it.
20041 - If the cursor is in a headline, prompt for tags and insert them
20042 into the current line, aligned to `org-tags-column'. When called
20043 with prefix arg, realign all tags in the current buffer.
20045 - If the cursor is in one of the special #+KEYWORD lines, this
20046 triggers scanning the buffer for these lines and updating the
20047 information.
20049 - If the cursor is inside a table, realign the table. This command
20050 works even if the automatic table editor has been turned off.
20052 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20053 the entire table.
20055 - If the cursor is at a footnote reference or definition, jump to
20056 the corresponding definition or references, respectively.
20058 - If the cursor is a the beginning of a dynamic block, update it.
20060 - If the current buffer is a capture buffer, close note and file it.
20062 - If the cursor is on a <<<target>>>, update radio targets and
20063 corresponding links in this buffer.
20065 - If the cursor is on a numbered item in a plain list, renumber the
20066 ordered list.
20068 - If the cursor is on a checkbox, toggle it.
20070 - If the cursor is on a code block, evaluate it. The variable
20071 `org-confirm-babel-evaluate' can be used to control prompting
20072 before code block evaluation, by default every code block
20073 evaluation requires confirmation. Code block evaluation can be
20074 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20075 (interactive "P")
20076 (cond
20077 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20078 org-occur-highlights
20079 org-latex-fragment-image-overlays)
20080 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20081 (org-remove-occur-highlights)
20082 (org-remove-latex-fragment-image-overlays)
20083 (message "Temporary highlights/overlays removed from current buffer"))
20084 ((and (local-variable-p 'org-finish-function (current-buffer))
20085 (fboundp org-finish-function))
20086 (funcall org-finish-function))
20087 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20088 (t
20089 (let* ((context (org-element-context)) (type (org-element-type context)))
20090 ;; Test if point is within a blank line.
20092 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20093 (user-error "C-c C-c can do nothing useful at this location"))
20094 ;; For convenience: at the first line of a paragraph on the
20095 ;; same line as an item, apply function on that item instead.
20096 (when (eq type 'paragraph)
20097 (let ((parent (org-element-property :parent context)))
20098 (when (and (eq (org-element-type parent) 'item)
20099 (= (point-at-bol) (org-element-property :begin parent)))
20100 (setq context parent type 'item))))
20101 ;; Act according to type of element or object at point.
20102 (case type
20103 (clock (org-clock-update-time-maybe))
20104 (dynamic-block
20105 (save-excursion
20106 (goto-char (org-element-property :post-affiliated context))
20107 (org-update-dblock)))
20108 (footnote-definition
20109 (goto-char (org-element-property :post-affiliated context))
20110 (call-interactively 'org-footnote-action))
20111 (footnote-reference (call-interactively 'org-footnote-action))
20112 ((headline inlinetask)
20113 (save-excursion (goto-char (org-element-property :begin context))
20114 (call-interactively 'org-set-tags)))
20115 (item
20116 ;; At an item: a double C-u set checkbox to "[-]"
20117 ;; unconditionally, whereas a single one will toggle its
20118 ;; presence. Without an universal argument, if the item
20119 ;; has a checkbox, toggle it. Otherwise repair the list.
20120 (let* ((box (org-element-property :checkbox context))
20121 (struct (org-element-property :structure context))
20122 (old-struct (copy-tree struct))
20123 (parents (org-list-parents-alist struct))
20124 (prevs (org-list-prevs-alist struct))
20125 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20126 (org-list-set-checkbox
20127 (org-element-property :begin context) struct
20128 (cond ((equal arg '(16)) "[-]")
20129 ((and (not box) (equal arg '(4))) "[ ]")
20130 ((or (not box) (equal arg '(4))) nil)
20131 ((eq box 'on) "[ ]")
20132 (t "[X]")))
20133 ;; Mimic `org-list-write-struct' but with grabbing
20134 ;; a return value from `org-list-struct-fix-box'.
20135 (org-list-struct-fix-ind struct parents 2)
20136 (org-list-struct-fix-item-end struct)
20137 (org-list-struct-fix-bul struct prevs)
20138 (org-list-struct-fix-ind struct parents)
20139 (let ((block-item
20140 (org-list-struct-fix-box struct parents prevs orderedp)))
20141 (if (and box (equal struct old-struct))
20142 (if (equal arg '(16))
20143 (message "Checkboxes already reset")
20144 (user-error "Cannot toggle this checkbox: %s"
20145 (if (eq box 'on)
20146 "all subitems checked"
20147 "unchecked subitems")))
20148 (org-list-struct-apply-struct struct old-struct)
20149 (org-update-checkbox-count-maybe))
20150 (when block-item
20151 (message "Checkboxes were removed due to empty box at line %d"
20152 (org-current-line block-item))))))
20153 (keyword
20154 (let ((org-inhibit-startup-visibility-stuff t)
20155 (org-startup-align-all-tables nil))
20156 (when (boundp 'org-table-coordinate-overlays)
20157 (mapc 'delete-overlay org-table-coordinate-overlays)
20158 (setq org-table-coordinate-overlays nil))
20159 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20160 (message "Local setup has been refreshed"))
20161 (plain-list
20162 ;; At a plain list, with a double C-u argument, set
20163 ;; checkboxes of each item to "[-]", whereas a single one
20164 ;; will toggle their presence according to the state of the
20165 ;; first item in the list. Without an argument, repair the
20166 ;; list.
20167 (let* ((begin (org-element-property :contents-begin context))
20168 (beginm (move-marker (make-marker) begin))
20169 (struct (org-element-property :structure context))
20170 (old-struct (copy-tree struct))
20171 (first-box (save-excursion
20172 (goto-char begin)
20173 (looking-at org-list-full-item-re)
20174 (match-string-no-properties 3)))
20175 (new-box (cond ((equal arg '(16)) "[-]")
20176 ((equal arg '(4)) (unless first-box "[ ]"))
20177 ((equal first-box "[X]") "[ ]")
20178 (t "[X]"))))
20179 (cond
20180 (arg
20181 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20182 (org-list-get-all-items
20183 begin struct (org-list-prevs-alist struct))))
20184 ((and first-box (eq (point) begin))
20185 ;; For convenience, when point is at bol on the first
20186 ;; item of the list and no argument is provided, simply
20187 ;; toggle checkbox of that item, if any.
20188 (org-list-set-checkbox begin struct new-box)))
20189 (org-list-write-struct
20190 struct (org-list-parents-alist struct) old-struct)
20191 (org-update-checkbox-count-maybe)
20192 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20193 ((property-drawer node-property)
20194 (call-interactively 'org-property-action))
20195 ((radio-target target)
20196 (call-interactively 'org-update-radio-target-regexp))
20197 (statistics-cookie
20198 (call-interactively 'org-update-statistics-cookies))
20199 ((table table-cell table-row)
20200 ;; At a table, recalculate every field and align it. Also
20201 ;; send the table if necessary. If the table has
20202 ;; a `table.el' type, just give up. At a table row or
20203 ;; cell, maybe recalculate line but always align table.
20204 (if (eq (org-element-property :type context) 'table.el)
20205 (message "Use C-c ' to edit table.el tables")
20206 (let ((org-enable-table-editor t))
20207 (if (or (eq type 'table)
20208 ;; Check if point is at a TBLFM line.
20209 (and (eq type 'table-row)
20210 (= (point) (org-element-property :end context))))
20211 (save-excursion
20212 (if (org-at-TBLFM-p) (org-calc-current-TBLFM)
20213 (goto-char (org-element-property :contents-begin context))
20214 (org-call-with-arg 'org-table-recalculate (or arg t))
20215 (orgtbl-send-table 'maybe)))
20216 (org-table-maybe-eval-formula)
20217 (cond (arg (call-interactively 'org-table-recalculate))
20218 ((org-table-maybe-recalculate-line))
20219 (t (org-table-align)))))))
20220 (timestamp (org-timestamp-change 0 'day))
20221 (otherwise
20222 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20223 (user-error
20224 "C-c C-c can do nothing useful at this location")))))))))
20226 (defun org-mode-restart ()
20227 "Restart Org-mode, to scan again for special lines.
20228 Also updates the keyword regular expressions."
20229 (interactive)
20230 (org-mode)
20231 (message "Org-mode restarted"))
20233 (defun org-kill-note-or-show-branches ()
20234 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20235 (interactive)
20236 (if (not org-finish-function)
20237 (progn
20238 (hide-subtree)
20239 (call-interactively 'show-branches))
20240 (let ((org-note-abort t))
20241 (funcall org-finish-function))))
20243 (defun org-open-line (n)
20244 "Insert a new row in tables, call `open-line' elsewhere."
20245 (interactive "*p")
20246 (if (org-at-table-p)
20247 (org-table-insert-row)
20248 (open-line n)))
20250 (defun org-return (&optional indent)
20251 "Goto next table row or insert a newline.
20252 Calls `org-table-next-row' or `newline', depending on context.
20253 See the individual commands for more information."
20254 (interactive)
20255 (let (org-ts-what)
20256 (cond
20257 ((or (bobp) (org-in-src-block-p))
20258 (if indent (newline-and-indent) (newline)))
20259 ((org-at-table-p)
20260 (org-table-justify-field-maybe)
20261 (call-interactively 'org-table-next-row))
20262 ;; when `newline-and-indent' is called within a list, make sure
20263 ;; text moved stays inside the item.
20264 ((and (org-in-item-p) indent)
20265 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20266 (progn
20267 (save-match-data (newline))
20268 (org-indent-line-to (length (match-string 0))))
20269 (let ((ind (org-get-indentation)))
20270 (newline)
20271 (if (org-looking-back org-list-end-re)
20272 (org-indent-line)
20273 (org-indent-line-to ind)))))
20274 ((and org-return-follows-link
20275 (org-at-timestamp-p t)
20276 (not (eq org-ts-what 'after)))
20277 (org-follow-timestamp-link))
20278 ((and org-return-follows-link
20279 (let ((tprop (get-text-property (point) 'face)))
20280 (or (eq tprop 'org-link)
20281 (and (listp tprop) (memq 'org-link tprop)))))
20282 (call-interactively 'org-open-at-point))
20283 ((and (org-at-heading-p)
20284 (looking-at
20286 (org-show-entry)
20287 (end-of-line 1)
20288 (newline))
20289 (t (if indent (newline-and-indent) (newline))))))
20291 (defun org-return-indent ()
20292 "Goto next table row or insert a newline and indent.
20293 Calls `org-table-next-row' or `newline-and-indent', depending on
20294 context. See the individual commands for more information."
20295 (interactive)
20296 (org-return t))
20298 (defun org-ctrl-c-star ()
20299 "Compute table, or change heading status of lines.
20300 Calls `org-table-recalculate' or `org-toggle-heading',
20301 depending on context."
20302 (interactive)
20303 (cond
20304 ((org-at-table-p)
20305 (call-interactively 'org-table-recalculate))
20306 (t
20307 ;; Convert all lines in region to list items
20308 (call-interactively 'org-toggle-heading))))
20310 (defun org-ctrl-c-minus ()
20311 "Insert separator line in table or modify bullet status of line.
20312 Also turns a plain line or a region of lines into list items.
20313 Calls `org-table-insert-hline', `org-toggle-item', or
20314 `org-cycle-list-bullet', depending on context."
20315 (interactive)
20316 (cond
20317 ((org-at-table-p)
20318 (call-interactively 'org-table-insert-hline))
20319 ((org-region-active-p)
20320 (call-interactively 'org-toggle-item))
20321 ((org-in-item-p)
20322 (call-interactively 'org-cycle-list-bullet))
20323 (t
20324 (call-interactively 'org-toggle-item))))
20326 (defun org-toggle-item (arg)
20327 "Convert headings or normal lines to items, items to normal lines.
20328 If there is no active region, only the current line is considered.
20330 If the first non blank line in the region is a headline, convert
20331 all headlines to items, shifting text accordingly.
20333 If it is an item, convert all items to normal lines.
20335 If it is normal text, change region into a list of items.
20336 With a prefix argument ARG, change the region in a single item."
20337 (interactive "P")
20338 (let ((shift-text
20339 (function
20340 ;; Shift text in current section to IND, from point to END.
20341 ;; The function leaves point to END line.
20342 (lambda (ind end)
20343 (let ((min-i 1000) (end (copy-marker end)))
20344 ;; First determine the minimum indentation (MIN-I) of
20345 ;; the text.
20346 (save-excursion
20347 (catch 'exit
20348 (while (< (point) end)
20349 (let ((i (org-get-indentation)))
20350 (cond
20351 ;; Skip blank lines and inline tasks.
20353 ((looking-at org-outline-regexp-bol))
20354 ;; We can't find less than 0 indentation.
20355 ((zerop i) (throw 'exit (setq min-i 0)))
20356 ((< i min-i) (setq min-i i))))
20357 (forward-line))))
20358 ;; Then indent each line so that a line indented to
20359 ;; MIN-I becomes indented to IND. Ignore blank lines
20360 ;; and inline tasks in the process.
20361 (let ((delta (- ind min-i)))
20362 (while (< (point) end)
20364 (looking-at org-outline-regexp-bol))
20365 (org-indent-line-to (+ (org-get-indentation) delta)))
20366 (forward-line)))))))
20367 (skip-blanks
20368 (function
20369 ;; Return beginning of first non-blank line, starting from
20370 ;; line at POS.
20371 (lambda (pos)
20372 (save-excursion
20373 (goto-char pos)
20375 (point-at-bol)))))
20376 beg end)
20377 ;; Determine boundaries of changes.
20378 (if (org-region-active-p)
20379 (setq beg (funcall skip-blanks (region-beginning))
20380 end (copy-marker (region-end)))
20381 (setq beg (funcall skip-blanks (point-at-bol))
20382 end (copy-marker (point-at-eol))))
20383 ;; Depending on the starting line, choose an action on the text
20384 ;; between BEG and END.
20385 (org-with-limited-levels
20386 (save-excursion
20387 (goto-char beg)
20388 (cond
20389 ;; Case 1. Start at an item: de-itemize. Note that it only
20390 ;; happens when a region is active: `org-ctrl-c-minus'
20391 ;; would call `org-cycle-list-bullet' otherwise.
20392 ((org-at-item-p)
20393 (while (< (point) end)
20394 (when (org-at-item-p)
20396 (delete-region (point) (match-end 0)))
20397 (forward-line)))
20398 ;; Case 2. Start at an heading: convert to items.
20399 ((org-at-heading-p)
20400 (let* ((bul (org-list-bullet-string "-"))
20401 (bul-len (length bul))
20402 ;; Indentation of the first heading. It should be
20403 ;; relative to the indentation of its parent, if any.
20404 (start-ind (save-excursion
20405 (cond
20406 ((not org-adapt-indentation) 0)
20407 ((not (outline-previous-heading)) 0)
20408 (t (length (match-string 0))))))
20409 ;; Level of first heading. Further headings will be
20410 ;; compared to it to determine hierarchy in the list.
20411 (ref-level (org-reduced-level (org-outline-level))))
20412 (while (< (point) end)
20413 (let* ((level (org-reduced-level (org-outline-level)))
20414 (delta (max 0 (- level ref-level))))
20415 ;; If current headline is less indented than the first
20416 ;; one, set it as reference, in order to preserve
20417 ;; subtrees.
20418 (when (< level ref-level) (setq ref-level level))
20419 (replace-match bul t t)
20420 (org-indent-line-to (+ start-ind (* delta bul-len)))
20421 ;; Ensure all text down to END (or SECTION-END) belongs
20422 ;; to the newly created item.
20423 (let ((section-end (save-excursion
20424 (or (outline-next-heading) (point)))))
20425 (forward-line)
20426 (funcall shift-text
20427 (+ start-ind (* (1+ delta) bul-len))
20428 (min end section-end)))))))
20429 ;; Case 3. Normal line with ARG: make the first line of region
20430 ;; an item, and shift indentation of others lines to
20431 ;; set them as item's body.
20432 (arg (let* ((bul (org-list-bullet-string "-"))
20433 (bul-len (length bul))
20434 (ref-ind (org-get-indentation)))
20436 (insert bul)
20437 (forward-line)
20438 (while (< (point) end)
20439 ;; Ensure that lines less indented than first one
20440 ;; still get included in item body.
20441 (funcall shift-text
20442 (+ ref-ind bul-len)
20443 (min end (save-excursion (or (outline-next-heading)
20444 (point)))))
20445 (forward-line))))
20446 ;; Case 4. Normal line without ARG: turn each non-item line
20447 ;; into an item.
20448 (t
20449 (while (< (point) end)
20450 (unless (or (org-at-heading-p) (org-at-item-p))
20452 (replace-match
20454 (forward-line))))))))
20456 (defun org-toggle-heading (&optional nstars)
20457 "Convert headings to normal text, or items or text to headings.
20458 If there is no active region, only convert the current line.
20461 point into heading.
20463 In a region:
20465 - If the first non blank line is a headline, remove the stars
20466 from all headlines in the region.
20468 - If it is a normal line, turn each and every normal line (i.e.,
20469 not an heading or an item) in the region into headings. If you
20470 want to convert only the first line of this region, use one
20471 universal prefix argument.
20473 - If it is a plain list item, turn all plain list items into headings.
20475 When converting a line into a heading, the number of stars is chosen
20476 such that the lines become children of the current entry. However,
20477 when a numeric prefix argument is given, its value determines the
20478 number of stars to add."
20479 (interactive "P")
20480 (let ((skip-blanks
20481 (function
20482 ;; Return beginning of first non-blank line, starting from
20483 ;; line at POS.
20484 (lambda (pos)
20485 (save-excursion
20486 (goto-char pos)
20487 (while (org-at-comment-p) (forward-line))
20489 (point-at-bol)))))
20490 beg end toggled)
20491 ;; Determine boundaries of changes. If a universal prefix has
20492 ;; been given, put the list in a region. If region ends at a bol,
20493 ;; do not consider the last line to be in the region.
20495 (when (and current-prefix-arg (org-at-item-p))
20496 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20497 (org-mark-element))
20499 (if (org-region-active-p)
20500 (setq beg (funcall skip-blanks (region-beginning))
20501 end (copy-marker (save-excursion
20502 (goto-char (region-end))
20503 (if (bolp) (point) (point-at-eol)))))
20504 (setq beg (funcall skip-blanks (point-at-bol))
20505 end (copy-marker (point-at-eol))))
20506 ;; Ensure inline tasks don't count as headings.
20507 (org-with-limited-levels
20508 (save-excursion
20509 (goto-char beg)
20510 (cond
20511 ;; Case 1. Started at an heading: de-star headings.
20512 ((org-at-heading-p)
20513 (while (< (point) end)
20514 (when (org-at-heading-p t)
20515 (looking-at org-outline-regexp) (replace-match "")
20516 (setq toggled t))
20517 (forward-line)))
20518 ;; Case 2. Started at an item: change items into headlines.
20519 ;; One star will be added by `org-list-to-subtree'.
20520 ((org-at-item-p)
20521 (let* ((stars (make-string
20522 ;; subtract the star that will be added again by
20523 ;; `org-list-to-subtree'
20524 (if (numberp nstars) (1- nstars)
20525 (or (org-current-level) 0))
20526 ?*))
20527 (add-stars
20528 (cond (nstars "") ; stars from prefix only
20529 ((equal stars "") "") ; before first heading
20530 (org-odd-levels-only "*") ; inside heading, odd
20531 (t "")))) ; inside heading, oddeven
20532 (while (< (point) end)
20533 (when (org-at-item-p)
20534 ;; Pay attention to cases when region ends before list.
20535 (let* ((struct (org-list-struct))
20536 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20537 (save-restriction
20538 (narrow-to-region (point) list-end)
20539 (insert
20540 (org-list-to-subtree
20541 (org-list-parse-list t)
20542 '(:istart (concat stars add-stars (funcall get-stars depth))
20543 :icount (concat stars add-stars (funcall get-stars depth)))))))
20544 (setq toggled t))
20545 (forward-line))))
20546 ;; Case 3. Started at normal text: make every line an heading,
20547 ;; skipping headlines and items.
20548 (t (let* ((stars
20549 (make-string
20550 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20551 (add-stars
20552 (cond (nstars "") ; stars from prefix only
20553 ((equal stars "") "*") ; before first heading
20554 (org-odd-levels-only "**") ; inside heading, odd
20555 (t "*"))) ; inside heading, oddeven
20556 (rpl (concat stars add-stars " "))
20557 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20558 (while (< (point) (if (equal nstars '(4)) lend end))
20559 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20561 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20562 (forward-line)))))))
20563 (unless toggled (message "Cannot toggle heading from here"))))
20565 (defun org-meta-return (&optional arg)
20566 "Insert a new heading or wrap a region in a table.
20567 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20568 See the individual commands for more information."
20569 (interactive "P")
20570 (cond
20571 ((run-hook-with-args-until-success 'org-metareturn-hook))
20572 ((or (org-at-drawer-p) (org-at-property-p))
20573 (newline-and-indent))
20574 ((org-at-table-p)
20575 (call-interactively 'org-table-wrap-region))
20576 (t (call-interactively 'org-insert-heading))))
20578 ;;; Menu entries
20580 (defsubst org-in-subtree-not-table-p ()
20581 "Are we in a subtree and not in a table?"
20582 (and (not (org-before-first-heading-p))
20583 (not (org-at-table-p))))
20585 ;; Define the Org-mode menus
20586 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20587 '("Tbl"
20588 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20589 ["Next Field" org-cycle (org-at-table-p)]
20590 ["Previous Field" org-shifttab (org-at-table-p)]
20591 ["Next Row" org-return (org-at-table-p)]
20592 "--"
20593 ["Blank Field" org-table-blank-field (org-at-table-p)]
20594 ["Edit Field" org-table-edit-field (org-at-table-p)]
20595 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20596 "--"
20597 ("Column"
20598 ["Move Column Left" org-metaleft (org-at-table-p)]
20599 ["Move Column Right" org-metaright (org-at-table-p)]
20600 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20601 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20602 ("Row"
20603 ["Move Row Up" org-metaup (org-at-table-p)]
20604 ["Move Row Down" org-metadown (org-at-table-p)]
20605 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20606 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20607 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20608 "--"
20609 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20610 ("Rectangle"
20611 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20612 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20613 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20614 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20615 "--"
20616 ("Calculate"
20617 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20618 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20619 ["Edit Formulas" org-edit-special (org-at-table-p)]
20620 "--"
20621 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20622 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20623 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20624 "--"
20625 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20626 "--"
20627 ["Sum Column/Rectangle" org-table-sum
20628 (or (org-at-table-p) (org-region-active-p))]
20629 ["Which Column?" org-table-current-column (org-at-table-p)])
20630 ["Debug Formulas"
20631 org-table-toggle-formula-debugger
20632 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20633 ["Show Col/Row Numbers"
20634 org-table-toggle-coordinate-overlays
20635 :style toggle
20636 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20637 "--"
20638 ["Create" org-table-create (and (not (org-at-table-p))
20639 org-enable-table-editor)]
20640 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20641 ["Import from File" org-table-import (not (org-at-table-p))]
20642 ["Export to File" org-table-export (org-at-table-p)]
20643 "--"
20644 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20646 (easy-menu-define org-org-menu org-mode-map "Org menu"
20647 '("Org"
20648 ("Show/Hide"
20649 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20650 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20651 ["Sparse Tree..." org-sparse-tree t]
20652 ["Reveal Context" org-reveal t]
20653 ["Show All" show-all t]
20654 "--"
20655 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20656 "--"
20657 ["New Heading" org-insert-heading t]
20658 ("Navigate Headings"
20659 ["Up" outline-up-heading t]
20660 ["Next" outline-next-visible-heading t]
20661 ["Previous" outline-previous-visible-heading t]
20662 ["Next Same Level" outline-forward-same-level t]
20663 ["Previous Same Level" outline-backward-same-level t]
20664 "--"
20665 ["Jump" org-goto t])
20666 ("Edit Structure"
20667 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20668 "--"
20669 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20670 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20671 "--"
20672 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20673 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20674 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20675 "--"
20676 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20677 "--"
20678 ["Copy visible text" org-copy-visible t]
20679 "--"
20680 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20681 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20682 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20683 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20684 "--"
20685 ["Sort Region/Children" org-sort t]
20686 "--"
20687 ["Convert to odd levels" org-convert-to-odd-levels t]
20688 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20689 ("Editing"
20690 ["Emphasis..." org-emphasize t]
20691 ["Edit Source Example" org-edit-special t]
20692 "--"
20693 ["Footnote new/jump" org-footnote-action t]
20694 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20695 ("Archive"
20696 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20697 "--"
20698 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20699 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20700 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20701 )
20702 "--"
20703 ("Hyperlinks"
20704 ["Store Link (Global)" org-store-link t]
20705 ["Find existing link to here" org-occur-link-in-agenda-files t]
20706 ["Insert Link" org-insert-link t]
20707 ["Follow Link" org-open-at-point t]
20708 "--"
20709 ["Next link" org-next-link t]
20710 ["Previous link" org-previous-link t]
20711 "--"
20712 ["Descriptive Links"
20713 org-toggle-link-display
20714 :style radio
20715 :selected org-descriptive-links
20716 ]
20717 ["Literal Links"
20718 org-toggle-link-display
20719 :style radio
20720 :selected (not org-descriptive-links)])
20721 "--"
20722 ("TODO Lists"
20723 ["TODO/DONE/-" org-todo t]
20724 ("Select keyword"
20725 ["Next keyword" org-shiftright (org-at-heading-p)]
20726 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20727 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20728 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20729 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20730 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20731 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20732 "--"
20733 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20734 :selected org-enforce-todo-dependencies :style toggle :active t]
20735 "Settings for tree at point"
20736 ["Do Children sequentially" org-toggle-ordered-property :style radio
20737 :selected (org-entry-get nil "ORDERED")
20738 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20739 ["Do Children parallel" org-toggle-ordered-property :style radio
20740 :selected (not (org-entry-get nil "ORDERED"))
20741 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20742 "--"
20743 ["Set Priority" org-priority t]
20744 ["Priority Up" org-shiftup t]
20745 ["Priority Down" org-shiftdown t]
20746 "--"
20747 ["Get news from all feeds" org-feed-update-all t]
20748 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20749 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20750 ("TAGS and Properties"
20751 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20752 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20753 "--"
20754 ["Set property" org-set-property (not (org-before-first-heading-p))]
20755 ["Column view of properties" org-columns t]
20756 ["Insert Column View DBlock" org-insert-columns-dblock t])
20757 ("Dates and Scheduling"
20758 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20759 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20760 ("Change Date"
20761 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20762 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20763 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20764 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20765 ["Compute Time Range" org-evaluate-time-range t]
20766 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20767 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20768 "--"
20769 ["Custom time format" org-toggle-time-stamp-overlays
20770 :style radio :selected org-display-custom-times]
20771 "--"
20772 ["Goto Calendar" org-goto-calendar t]
20773 ["Date from Calendar" org-date-from-calendar t]
20774 "--"
20775 ["Start/Restart Timer" org-timer-start t]
20776 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20777 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20778 ["Insert Timer String" org-timer t]
20779 ["Insert Timer Item" org-timer-item t])
20780 ("Logging work"
20781 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20782 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20783 ["Clock out" org-clock-out t]
20784 ["Clock cancel" org-clock-cancel t]
20785 "--"
20786 ["Mark as default task" org-clock-mark-default-task t]
20787 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20788 ["Goto running clock" org-clock-goto t]
20789 "--"
20790 ["Display times" org-clock-display t]
20791 ["Create clock table" org-clock-report t]
20792 "--"
20793 ["Record DONE time"
20794 (progn (setq org-log-done (not org-log-done))
20795 (message "Switching to %s will %s record a timestamp"
20796 (car org-done-keywords)
20797 (if org-log-done "automatically" "not")))
20798 :style toggle :selected org-log-done])
20799 "--"
20800 ["Agenda Command..." org-agenda t]
20801 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20802 ("File List for Agenda")
20803 ("Special views current file"
20804 ["TODO Tree" org-show-todo-tree t]
20805 ["Check Deadlines" org-check-deadlines t]
20806 ["Timeline" org-timeline t]
20807 ["Tags/Property tree" org-match-sparse-tree t])
20808 "--"
20809 ["Export/Publish..." org-export-dispatch t]
20810 ("LaTeX"
20811 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20812 :selected org-cdlatex-mode]
20813 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20814 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20815 ["Modify math symbol" org-cdlatex-math-modify
20816 (org-inside-LaTeX-fragment-p)]
20817 ["Insert citation" org-reftex-citation t]
20818 "--"
20819 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20820 "--"
20821 ("MobileOrg"
20822 ["Push Files and Views" org-mobile-push t]
20823 ["Get Captured and Flagged" org-mobile-pull t]
20824 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20825 "--"
20826 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20827 "--"
20828 ("Documentation"
20829 ["Show Version" org-version t]
20830 ["Info Documentation" org-info t])
20831 ("Customize"
20832 ["Browse Org Group" org-customize t]
20833 "--"
20834 ["Expand This Menu" org-create-customize-menu
20835 (fboundp 'customize-menu-create)])
20836 ["Send bug report" org-submit-bug-report t]
20837 "--"
20838 ("Refresh/Reload"
20839 ["Refresh setup current buffer" org-mode-restart t]
20840 ["Reload Org (after update)" org-reload t]
20841 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20842 ))
20844 (defun org-info (&optional node)
20845 "Read documentation for Org-mode in the info system.
20846 With optional NODE, go directly to that node."
20847 (interactive)
20848 (info (format "(org)%s" (or node ""))))
20850 ;;;###autoload
20851 (defun org-submit-bug-report ()
20852 "Submit a bug report on Org-mode via mail.
20854 Don't hesitate to report any problems or inaccurate documentation.
20856 If you don't have setup sending mail from (X)Emacs, please copy the
20857 output buffer into your mail program, as it gives us important
20858 information about your Org-mode version and configuration."
20859 (interactive)
20860 (require 'reporter)
20861 (org-load-modules-maybe)
20862 (org-require-autoloaded-modules)
20863 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20864 (reporter-submit-bug-report
20865 "emacs-orgmode@gnu.org"
20866 (org-version nil 'full)
20867 (let (list)
20868 (save-window-excursion
20869 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20870 (delete-other-windows)
20871 (erase-buffer)
20872 (insert "You are about to submit a bug report to the Org-mode mailing list.
20874 We would like to add your full Org-mode and Outline configuration to the
20875 bug report. This greatly simplifies the work of the maintainer and
20876 other experts on the mailing list.
20878 HOWEVER, some variables you have customized may contain private
20879 information. The names of customers, colleagues, or friends, might
20880 appear in the form of file names, tags, todo states, or search strings.
20881 If you answer yes to the prompt, you might want to check and remove
20882 such private information before sending the email.")
20883 (add-text-properties (point-min) (point-max) '(face org-warning))
20884 (when (yes-or-no-p "Include your Org-mode configuration ")
20885 (mapatoms
20886 (lambda (v)
20887 (and (boundp v)
20889 (or (and (symbol-value v)
20891 (and
20892 (get v 'custom-type) (get v 'standard-value)
20893 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20894 (push v list)))))
20895 (kill-buffer (get-buffer "*Warn about privacy*"))
20896 list))
20897 nil nil
20898 "Remember to cover the basics, that is, what you expected to happen and
20899 what in fact did happen. You don't know how to make a good report? See
20901 http://orgmode.org/manual/Feedback.html#Feedback
20903 Your bug report will be posted to the Org-mode mailing list.
20904 ------------------------------------------------------------------------")
20905 (save-excursion
20910 (defun org-install-agenda-files-menu ()
20911 (let ((bl (buffer-list)))
20912 (save-excursion
20913 (while bl
20914 (set-buffer (pop bl))
20915 (if (derived-mode-p 'org-mode) (setq bl nil)))
20916 (when (derived-mode-p 'org-mode)
20917 (easy-menu-change
20918 '("Org") "File List for Agenda"
20919 (append
20920 (list
20921 ["Edit File List" (org-edit-agenda-file-list) t]
20922 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20923 ["Remove Current File from List" org-remove-file t]
20924 ["Cycle through agenda files" org-cycle-agenda-files t]
20925 ["Occur in all agenda files" org-occur-in-agenda-files t]
20926 "--")
20927 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20929 ;;;; Documentation
20931 (defun org-require-autoloaded-modules ()
20932 (interactive)
20933 (mapc 'require
20934 '(org-agenda org-archive org-attach org-clock org-colview org-id
20935 org-remember org-table org-timer)))
20937 ;;;###autoload
20938 (defun org-reload (&optional uncompiled)
20939 "Reload all org lisp files.
20940 With prefix arg UNCOMPILED, load the uncompiled versions."
20941 (interactive "P")
20942 (require 'loadhist)
20943 (let* ((org-dir (org-find-library-dir "org"))
20944 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20946 (remove-re (mapconcat 'identity
20947 (mapcar (lambda (f) (concat "^" f "$"))
20948 (list (if (featurep 'xemacs)
20949 "org-colview"
20950 "org-colview-xemacs")
20951 "org" "org-loaddefs" "org-version"))
20953 (feats (delete-dups
20954 (mapcar 'file-name-sans-extension
20955 (mapcar 'file-name-nondirectory
20956 (delq nil
20957 (mapcar 'feature-file
20958 features))))))
20959 (lfeat (append
20960 (sort
20961 (setq feats
20962 (delq nil (mapcar
20963 (lambda (f)
20964 (if (and (string-match feature-re f)
20965 (not (string-match remove-re f)))
20966 f nil))
20967 feats)))
20968 'string-lessp)
20969 (list "org-version" "org")))
20970 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
20971 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20972 load-uncore load-misses)
20973 (setq load-misses
20974 (delq 't
20975 (mapcar (lambda (f)
20976 (or (org-load-noerror-mustsuffix (concat org-dir f))
20977 (and (string= org-dir contrib-dir)
20978 (org-load-noerror-mustsuffix (concat contrib-dir f)))
20979 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
20980 (add-to-list 'load-uncore f 'append)
20981 't)
20982 f))
20983 lfeat)))
20984 (if load-uncore
20986 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20987 (if load-misses
20989 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20992 ;;;###autoload
20993 (defun org-customize ()
20994 "Call the customize function with org as argument."
20995 (interactive)
20996 (org-load-modules-maybe)
20997 (org-require-autoloaded-modules)
20998 (customize-browse 'org))
21000 (defun org-create-customize-menu ()
21001 "Create a full customization menu for Org-mode, insert it into the menu."
21002 (interactive)
21003 (org-load-modules-maybe)
21004 (org-require-autoloaded-modules)
21005 (if (fboundp 'customize-menu-create)
21006 (progn
21007 (easy-menu-change
21008 '("Org") "Customize"
21009 `(["Browse Org group" org-customize t]
21010 "--"
21011 ,(customize-menu-create 'org)
21012 ["Set" Custom-set t]
21013 ["Save" Custom-save t]
21014 ["Reset to Current" Custom-reset-current t]
21015 ["Reset to Saved" Custom-reset-saved t]
21016 ["Reset to Standard Settings" Custom-reset-standard t]))
21018 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21020 ;;;; Miscellaneous stuff
21022 ;;; Generally useful functions
21024 (defun org-get-at-bol (property)
21025 "Get text property PROPERTY at beginning of line."
21026 (get-text-property (point-at-bol) property))
21028 (defun org-find-text-property-in-string (prop s)
21029 "Return the first non-nil value of property PROP in string S."
21030 (or (get-text-property 0 prop s)
21031 (get-text-property (or (next-single-property-change 0 prop s) 0)
21032 prop s)))
21034 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21035 "Display the given MESSAGE as a warning."
21036 (if (fboundp 'display-warning)
21037 (display-warning 'org message
21038 (if (featurep 'xemacs) 'warning :warning))
21039 (let ((buf (get-buffer-create "*Org warnings*")))
21040 (with-current-buffer buf
21041 (goto-char (point-max))
21042 (insert "Warning (Org): " message)
21043 (unless (bolp)
21044 (newline)))
21045 (display-buffer buf)
21046 (sit-for 0))))
21048 (defun org-eval (form)
21049 "Eval FORM and return result."
21050 (condition-case error
21051 (eval form)
21052 (error (format "%%![Error: %s]" error))))
21054 (defun org-in-clocktable-p ()
21055 "Check if the cursor is in a clocktable."
21056 (let ((pos (point)) start)
21057 (save-excursion
21058 (end-of-line 1)
21060 (setq start (match-beginning 0))
21062 (>= (match-end 0) pos)
21063 start))))
21065 (defun org-in-commented-line ()
21066 "Is point in a line starting with `#'?"
21067 (equal (char-after (point-at-bol)) ?#))
21069 (defun org-in-indented-comment-line ()
21070 "Is point in a line starting with `#' after some white space?"
21071 (save-excursion
21072 (save-match-data
21073 (goto-char (point-at-bol))
21076 (defun org-in-verbatim-emphasis ()
21077 (save-match-data
21078 (and (org-in-regexp org-emph-re 2)
21079 (>= (point) (match-beginning 3))
21080 (<= (point) (match-end 4))
21081 (member (match-string 3) '("=" "~")))))
21083 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21084 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21085 (if (and marker (marker-buffer marker)
21086 (buffer-live-p (marker-buffer marker)))
21087 (progn
21088 (org-pop-to-buffer-same-window (marker-buffer marker))
21089 (if (or (> marker (point-max)) (< marker (point-min)))
21090 (widen))
21091 (goto-char marker)
21092 (org-show-context 'org-goto))
21093 (if bookmark
21094 (bookmark-jump bookmark)
21095 (error "Cannot find location"))))
21097 (defun org-quote-csv-field (s)
21098 "Quote field for inclusion in CSV material."
21101 s))
21103 (defun org-force-self-insert (N)
21104 "Needed to enforce self-insert under remapping."
21105 (interactive "p")
21106 (self-insert-command N))
21108 (defun org-string-width (s)
21109 "Compute width of string, ignoring invisible characters.
21110 This ignores character with invisibility property `org-link', and also
21111 characters with property `org-cwidth', because these will become invisible
21112 upon the next fontification round."
21113 (let (b l)
21114 (when (or (eq t buffer-invisibility-spec)
21115 (assq 'org-link buffer-invisibility-spec))
21116 (while (setq b (text-property-any 0 (length s)
21117 'invisible 'org-link s))
21118 (setq s (concat (substring s 0 b)
21119 (substring s (or (next-single-property-change
21120 b 'invisible s) (length s)))))))
21121 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21122 (setq s (concat (substring s 0 b)
21123 (substring s (or (next-single-property-change
21124 b 'org-cwidth s) (length s))))))
21125 (setq l (string-width s) b -1)
21126 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21127 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21128 l))
21130 (defun org-shorten-string (s maxlength)
21131 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21132 If the string is shorter or has length MAXLENGTH, just return the
21133 original string. If it is longer, the functions finds a space in the
21134 string, breaks this string off at that locations and adds three dots
21135 as ellipsis. Including the ellipsis, the string will not be longer
21136 than MAXLENGTH. If finding a good breaking point in the string does
21137 not work, the string is just chopped off in the middle of a word
21138 if necessary."
21139 (if (<= (length s) maxlength)
21140 s
21141 (let* ((n (max (- maxlength 4) 1))
21143 (if (string-match re s)
21144 (concat (match-string 1 s) "...")
21145 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21147 (defun org-get-indentation (&optional line)
21148 "Get the indentation of the current line, interpreting tabs.
21149 When LINE is given, assume it represents a line and compute its indentation."
21150 (if line
21151 (if (string-match "^ *" (org-remove-tabs line))
21152 (match-end 0))
21153 (save-excursion
21154 (beginning-of-line 1)
21156 (current-column))))
21158 (defun org-get-string-indentation (s)
21159 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21160 (let ((n -1) (i 0) (w tab-width) c)
21161 (catch 'exit
21162 (while (< (setq n (1+ n)) (length s))
21163 (setq c (aref s n))
21164 (cond ((= c ?\ ) (setq i (1+ i)))
21166 (t (throw 'exit t)))))
21167 i))
21169 (defun org-remove-tabs (s &optional width)
21170 "Replace tabulators in S with spaces.
21171 Assumes that s is a single line, starting in column 0."
21172 (setq width (or width tab-width))
21174 (setq s (replace-match
21175 (make-string
21176 (- (* width (/ (+ (match-beginning 0) width) width))
21177 (match-beginning 0)) ?\ )
21178 t t s)))
21179 s)
21181 (defun org-fix-indentation (line ind)
21182 "Fix indentation in LINE.
21183 IND is a cons cell with target and minimum indentation.
21184 If the current indentation in LINE is smaller than the minimum,
21185 leave it alone. If it is larger than ind, set it to the target."
21186 (let* ((l (org-remove-tabs line))
21187 (i (org-get-indentation l))
21188 (i1 (car ind)) (i2 (cdr ind)))
21189 (if (>= i i2) (setq l (substring line i2)))
21190 (if (> i1 0)
21191 (concat (make-string i1 ?\ ) l)
21192 l)))
21194 (defun org-remove-indentation (code &optional n)
21195 "Remove the maximum common indentation from the lines in CODE.
21196 N may optionally be the number of spaces to remove."
21197 (with-temp-buffer
21198 (insert code)
21199 (org-do-remove-indentation n)
21200 (buffer-string)))
21202 (defun org-do-remove-indentation (&optional n)
21203 "Remove the maximum common indentation from the buffer."
21204 (untabify (point-min) (point-max))
21205 (let ((min 10000) re)
21206 (if n
21207 (setq min n)
21208 (goto-char (point-min))
21210 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21211 (unless (or (= min 0) (= min 10000))
21213 (goto-char (point-min))
21214 (while (re-search-forward re nil t)
21215 (replace-match "")
21216 (end-of-line 1))
21217 min)))
21219 (defun org-fill-template (template alist)
21220 "Find each %key of ALIST in TEMPLATE and replace it."
21221 (let ((case-fold-search nil)
21222 entry key value)
21223 (setq alist (sort (copy-sequence alist)
21224 (lambda (a b) (< (length (car a)) (length (car b))))))
21225 (while (setq entry (pop alist))
21226 (setq template
21227 (replace-regexp-in-string
21228 (concat "%" (regexp-quote (car entry)))
21229 (or (cdr entry) "") template t t)))
21230 template))
21232 (defun org-base-buffer (buffer)
21233 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21234 (if (not buffer)
21235 buffer
21236 (or (buffer-base-buffer buffer)
21237 buffer)))
21239 (defun org-trim (s)
21240 "Remove whitespace at beginning and end of string."
21243 s)
21245 (defun org-wrap (string &optional width lines)
21246 "Wrap string to either a number of lines, or a width in characters.
21247 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21248 that costs. If there is a word longer than WIDTH, the text is actually
21249 wrapped to the length of that word.
21250 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21251 many lines, whatever width that takes.
21252 The return value is a list of lines, without newlines at the end."
21254 (maxword (apply 'max (mapcar 'org-string-width words)))
21255 w ll)
21256 (cond (width
21257 (org-do-wrap words (max maxword width)))
21258 (lines
21259 (setq w maxword)
21260 (setq ll (org-do-wrap words maxword))
21261 (if (<= (length ll) lines)
21262 ll
21263 (setq ll words)
21264 (while (> (length ll) lines)
21265 (setq w (1+ w))
21266 (setq ll (org-do-wrap words w)))
21267 ll))
21268 (t (error "Cannot wrap this")))))
21270 (defun org-do-wrap (words width)
21271 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21272 (let (lines line)
21273 (while words
21274 (setq line (pop words))
21275 (while (and words (< (+ (length line) (length (car words))) width))
21276 (setq line (concat line " " (pop words))))
21277 (setq lines (push line lines)))
21278 (nreverse lines)))
21280 (defun org-split-string (string &optional separators)
21281 "Splits STRING into substrings at SEPARATORS.
21282 No empty strings are returned if there are matches at the beginning
21283 and end of string."
21285 (start 0)
21286 notfirst
21287 (list nil))
21288 (while (and (string-match rexp string
21289 (if (and notfirst
21290 (= start (match-beginning 0))
21291 (< start (length string)))
21292 (1+ start) start))
21293 (< (match-beginning 0) (length string)))
21294 (setq notfirst t)
21295 (or (eq (match-beginning 0) 0)
21296 (and (eq (match-beginning 0) (match-end 0))
21297 (eq (match-beginning 0) start))
21298 (setq list
21299 (cons (substring string start (match-beginning 0))
21300 list)))
21301 (setq start (match-end 0)))
21302 (or (eq start (length string))
21303 (setq list
21304 (cons (substring string start)
21305 list)))
21306 (nreverse list)))
21308 (defun org-quote-vert (s)
21310 (while (string-match "|" s)
21312 s)
21314 (defun org-uuidgen-p (s)
21315 "Is S an ID created by UUIDGEN?"
21316 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21318 (defun org-in-src-block-p (&optional inside)
21319 "Whether point is in a code source block.
21320 When INSIDE is non-nil, don't consider we are within a src block
21321 when point is at #+BEGIN_SRC or #+END_SRC."
21322 (let ((case-fold-search t) ov)
21323 (or (and (setq ov (overlays-at (point)))
21324 (memq 'org-block-background
21325 (overlay-properties (car ov))))
21326 (and (not inside)
21327 (save-match-data
21328 (save-excursion
21329 (beginning-of-line)
21332 (defun org-context ()
21333 "Return a list of contexts of the current cursor position.
21334 If several contexts apply, all are returned.
21335 Each context entry is a list with a symbol naming the context, and
21336 two positions indicating start and end of the context. Possible
21337 contexts are:
21339 :headline anywhere in a headline
21340 :headline-stars on the leading stars in a headline
21341 :todo-keyword on a TODO keyword (including DONE) in a headline
21342 :tags on the TAGS in a headline
21343 :priority on the priority cookie in a headline
21344 :item on the first line of a plain list item
21345 :item-bullet on the bullet/number of a plain list item
21346 :checkbox on the checkbox in a plain list item
21347 :table in an org-mode table
21348 :table-special on a special filed in a table
21349 :table-table in a table.el table
21350 :clocktable in a clocktable
21351 :src-block in a source block
21352 :link on a hyperlink
21353 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21354 :target on a <<target>>
21355 :radio-target on a <<<radio-target>>>
21356 :latex-fragment on a LaTeX fragment
21357 :latex-preview on a LaTeX fragment with overlaid preview image
21359 This function expects the position to be visible because it uses font-lock
21360 faces as a help to recognize the following contexts: :table-special, :link,
21361 and :keyword."
21362 (let* ((f (get-text-property (point) 'face))
21363 (faces (if (listp f) f (list f)))
21364 (case-fold-search t)
21365 (p (point)) clist o)
21366 ;; First the large context
21367 (cond
21368 ((org-at-heading-p t)
21369 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21370 (when (progn
21371 (beginning-of-line 1)
21372 (looking-at org-todo-line-tags-regexp))
21373 (push (org-point-in-group p 1 :headline-stars) clist)
21374 (push (org-point-in-group p 2 :todo-keyword) clist)
21375 (push (org-point-in-group p 4 :tags) clist))
21376 (goto-char p)
21379 (push (org-point-in-group p 0 :priority) clist)))
21381 ((org-at-item-p)
21382 (push (org-point-in-group p 2 :item-bullet) clist)
21383 (push (list :item (point-at-bol)
21384 (save-excursion (org-end-of-item) (point)))
21385 clist)
21386 (and (org-at-item-checkbox-p)
21387 (push (org-point-in-group p 0 :checkbox) clist)))
21389 ((org-at-table-p)
21390 (push (list :table (org-table-begin) (org-table-end)) clist)
21391 (if (memq 'org-formula faces)
21392 (push (list :table-special
21393 (previous-single-property-change p 'face)
21394 (next-single-property-change p 'face)) clist)))
21395 ((org-at-table-p 'any)
21396 (push (list :table-table) clist)))
21397 (goto-char p)
21399 (let ((case-fold-search t))
21400 ;; New the "medium" contexts: clocktables, source blocks
21401 (cond ((org-in-clocktable-p)
21402 (push (list :clocktable
21404 (search-backward "#+BEGIN: clocktable" nil t))
21405 (match-beginning 0))
21407 (match-end 0))) clist))
21408 ((org-in-src-block-p)
21409 (push (list :src-block
21411 (search-backward "#+BEGIN_SRC" nil t))
21412 (match-beginning 0))
21413 (and (search-forward "#+END_SRC" nil t)
21414 (match-beginning 0))) clist))))
21415 (goto-char p)
21417 ;; Now the small context
21418 (cond
21419 ((org-at-timestamp-p)
21420 (push (org-point-in-group p 0 :timestamp) clist))
21421 ((memq 'org-link faces)
21422 (push (list :link
21423 (previous-single-property-change p 'face)
21424 (next-single-property-change p 'face)) clist))
21425 ((memq 'org-special-keyword faces)
21426 (push (list :keyword
21427 (previous-single-property-change p 'face)
21428 (next-single-property-change p 'face)) clist))
21429 ((org-at-target-p)
21430 (push (org-point-in-group p 0 :target) clist)
21431 (goto-char (1- (match-beginning 0)))
21432 (if (looking-at org-radio-target-regexp)
21433 (push (org-point-in-group p 0 :radio-target) clist))
21434 (goto-char p))
21435 ((setq o (car (delq nil
21436 (mapcar
21437 (lambda (x)
21438 (if (memq x org-latex-fragment-image-overlays) x))
21439 (overlays-at (point))))))
21440 (push (list :latex-fragment
21441 (overlay-start o) (overlay-end o)) clist)
21442 (push (list :latex-preview
21443 (overlay-start o) (overlay-end o)) clist))
21444 ((org-inside-LaTeX-fragment-p)
21445 ;; FIXME: positions wrong.
21446 (push (list :latex-fragment (point) (point)) clist)))
21448 (setq clist (nreverse (delq nil clist)))
21449 clist))
21451 ;; FIXME: Compare with at-regexp-p Do we need both?
21452 (defun org-in-regexp (re &optional nlines visually)
21453 "Check if point is inside a match of regexp.
21454 Normally only the current line is checked, but you can include NLINES extra
21455 lines both before and after point into the search.
21456 If VISUALLY is set, require that the cursor is not after the match but
21457 really on, so that the block visually is on the match."
21458 (catch 'exit
21459 (let ((pos (point))
21460 (eol (point-at-eol (+ 1 (or nlines 0))))
21461 (inc (if visually 1 0)))
21462 (save-excursion
21463 (beginning-of-line (- 1 (or nlines 0)))
21464 (while (re-search-forward re eol t)
21465 (if (and (<= (match-beginning 0) pos)
21466 (>= (+ inc (match-end 0)) pos))
21467 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21469 (defun org-at-regexp-p (regexp)
21470 "Is point inside a match of REGEXP in the current line?"
21471 (catch 'exit
21472 (save-excursion
21473 (let ((pos (point)) (end (point-at-eol)))
21474 (beginning-of-line 1)
21475 (while (re-search-forward regexp end t)
21476 (if (and (<= (match-beginning 0) pos)
21477 (>= (match-end 0) pos))
21478 (throw 'exit t)))
21479 nil))))
21481 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21482 "Non-nil when point is between matches of START-RE and END-RE.
21484 Also return a non-nil value when point is on one of the matches.
21486 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21487 buffer positions. Default values are the positions of headlines
21488 surrounding the point.
21490 The functions returns a cons cell whose car (resp. cdr) is the
21491 position before START-RE (resp. after END-RE)."
21492 (save-match-data
21493 (let ((pos (point))
21494 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21495 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21496 beg end)
21497 (save-excursion
21498 ;; Point is on a block when on START-RE or if START-RE can be
21499 ;; found before it...
21500 (and (or (org-at-regexp-p start-re)
21501 (re-search-backward start-re limit-up t))
21502 (setq beg (match-beginning 0))
21503 ;; ... and END-RE after it...
21504 (goto-char (match-end 0))
21505 (re-search-forward end-re limit-down t)
21506 (> (setq end (match-end 0)) pos)
21507 ;; ... without another START-RE in-between.
21508 (goto-char (match-beginning 0))
21509 (not (re-search-backward start-re (1+ beg) t))
21510 ;; Return value.
21511 (cons beg end))))))
21513 (defun org-in-block-p (names)
21514 "Non-nil when point belongs to a block whose name belongs to NAMES.
21516 NAMES is a list of strings containing names of blocks.
21518 Return first block name matched, or nil. Beware that in case of
21519 nested blocks, the returned name may not belong to the closest
21520 block from point."
21521 (save-match-data
21522 (catch 'exit
21523 (let ((case-fold-search t)
21524 (lim-up (save-excursion (outline-previous-heading)))
21525 (lim-down (save-excursion (outline-next-heading))))
21526 (mapc (lambda (name)
21527 (let ((n (regexp-quote name)))
21528 (when (org-between-regexps-p
21531 lim-up lim-down)
21532 (throw 'exit n))))
21533 names))
21534 nil)))
21536 (defun org-occur-in-agenda-files (regexp &optional nlines)
21537 "Call `multi-occur' with buffers for all agenda files."
21539 (let* ((files (org-agenda-files))
21540 (tnames (mapcar 'file-truename files))
21541 (extra org-agenda-text-search-extra-files)
21542 f)
21543 (when (eq (car extra) 'agenda-archives)
21544 (setq extra (cdr extra))
21545 (setq files (org-add-archive-files files)))
21546 (while (setq f (pop extra))
21547 (unless (member (file-truename f) tnames)
21548 (add-to-list 'files f 'append)
21549 (add-to-list 'tnames (file-truename f) 'append)))
21550 (multi-occur
21551 (mapcar (lambda (x)
21552 (with-current-buffer
21553 (or (get-file-buffer x) (find-file-noselect x))
21554 (widen)
21555 (current-buffer)))
21556 files)
21557 regexp)))
21559 (if (boundp 'occur-mode-find-occurrence-hook)
21560 ;; Emacs 23
21561 (add-hook 'occur-mode-find-occurrence-hook
21562 (lambda ()
21563 (when (derived-mode-p 'org-mode)
21564 (org-reveal))))
21565 ;; Emacs 22
21566 (defadvice occur-mode-goto-occurrence
21567 (after org-occur-reveal activate)
21568 (and (derived-mode-p 'org-mode) (org-reveal)))
21569 (defadvice occur-mode-goto-occurrence-other-window
21570 (after org-occur-reveal activate)
21571 (and (derived-mode-p 'org-mode) (org-reveal)))
21572 (defadvice occur-mode-display-occurrence
21573 (after org-occur-reveal activate)
21574 (when (derived-mode-p 'org-mode)
21575 (let ((pos (occur-mode-find-occurrence)))
21576 (with-current-buffer (marker-buffer pos)
21577 (save-excursion
21578 (goto-char pos)
21579 (org-reveal)))))))
21581 (defun org-occur-link-in-agenda-files ()
21582 "Create a link and search for it in the agendas.
21583 The link is not stored in `org-stored-links', it is just created
21584 for the search purpose."
21585 (interactive)
21586 (let ((link (condition-case nil
21587 (org-store-link nil)
21588 (error "Unable to create a link to here"))))
21589 (org-occur-in-agenda-files (regexp-quote link))))
21591 (defun org-reverse-string (string)
21592 "Return the reverse of STRING."
21593 (apply 'string (reverse (string-to-list string))))
21595 (defsubst org-uniquify (list)
21596 "Non-destructively remove duplicate elements from LIST."
21597 (let ((res (copy-sequence list))) (delete-dups res)))
21599 (defun org-uniquify-alist (alist)
21600 "Merge elements of ALIST with the same key.
21602 For example, in this alist:
21604 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21605 => '((a 1 3) (b 2))
21607 merge (a 1) and (a 3) into (a 1 3).
21609 The function returns the new ALIST."
21610 (let (rtn)
21611 (mapc
21612 (lambda (e)
21613 (let (n)
21614 (if (not (assoc (car e) rtn))
21615 (push e rtn)
21616 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21617 (setq rtn (assq-delete-all (car e) rtn))
21618 (push n rtn))))
21619 alist)
21620 rtn))
21622 (defun org-delete-all (elts list)
21623 "Remove all elements in ELTS from LIST."
21624 (while elts
21625 (setq list (delete (pop elts) list)))
21626 list)
21628 (defun org-count (cl-item cl-seq)
21629 "Count the number of occurrences of ITEM in SEQ.
21630 Taken from `count' in cl-seq.el with all keyword arguments removed."
21631 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21632 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21633 (while (< cl-start cl-end)
21634 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21635 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21636 (setq cl-start (1+ cl-start)))
21637 cl-count))
21639 (defun org-remove-if (predicate seq)
21640 "Remove everything from SEQ that fulfills PREDICATE."
21641 (let (res e)
21642 (while seq
21643 (setq e (pop seq))
21644 (if (not (funcall predicate e)) (push e res)))
21645 (nreverse res)))
21647 (defun org-remove-if-not (predicate seq)
21648 "Remove everything from SEQ that does not fulfill PREDICATE."
21649 (let (res e)
21650 (while seq
21651 (setq e (pop seq))
21652 (if (funcall predicate e) (push e res)))
21653 (nreverse res)))
21655 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21656 "Reduce two-argument FUNCTION across SEQ.
21657 Taken from `reduce' in cl-seq.el with all keyword arguments but
21659 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21660 (cadr (memq :initial-value cl-keys)))
21661 (cl-seq (pop cl-seq))
21662 (t (funcall cl-func)))))
21663 (while cl-seq
21664 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21665 cl-accum))
21667 (defun org-back-over-empty-lines ()
21668 "Move backwards over whitespace, to the beginning of the first empty line.
21669 Returns the number of empty lines passed."
21670 (let ((pos (point)))
21671 (if (cdr (assoc 'heading org-blank-before-new-entry))
21673 (unless (eobp)
21674 (forward-line -1)))
21675 (beginning-of-line 2)
21676 (goto-char (min (point) pos))
21677 (count-lines (point) pos)))
21679 (defun org-skip-whitespace ()
21682 (defun org-point-in-group (point group &optional context)
21683 "Check if POINT is in match-group GROUP.
21684 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21685 match. If the match group does not exist or point is not inside it,
21686 return nil."
21687 (and (match-beginning group)
21688 (>= point (match-beginning group))
21689 (<= point (match-end group))
21690 (if context
21691 (list context (match-beginning group) (match-end group))
21692 t)))
21694 (defun org-switch-to-buffer-other-window (&rest args)
21695 "Switch to buffer in a second window on the current frame.
21696 In particular, do not allow pop-up frames.
21697 Returns the newly created buffer."
21698 (org-no-popups
21699 (apply 'switch-to-buffer-other-window args)))
21701 (defun org-combine-plists (&rest plists)
21702 "Create a single property list from all plists in PLISTS.
21703 The process starts by copying the first list, and then setting properties
21704 from the other lists. Settings in the last list are the most significant
21705 ones and overrule settings in the other lists."
21706 (let ((rtn (copy-sequence (pop plists)))
21707 p v ls)
21708 (while plists
21709 (setq ls (pop plists))
21710 (while ls
21711 (setq p (pop ls) v (pop ls))
21712 (setq rtn (plist-put rtn p v))))
21713 rtn))
21715 (defun org-replace-escapes (string table)
21716 "Replace %-escapes in STRING with values in TABLE.
21718 The sequences in STRING may contain normal field width and padding information,
21720 so values can contain further %-escapes if they are define later in TABLE."
21721 (let ((tbl (copy-alist table))
21722 (case-fold-search nil)
21723 (pchg 0)
21724 e re rpl)
21725 (while (setq e (pop tbl))
21726 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21727 (when (and (cdr e) (string-match re (cdr e)))
21728 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21729 (safe "SREF"))
21730 (add-text-properties 0 3 (list 'sref sref) safe)
21731 (setcdr e (replace-match safe t t (cdr e)))))
21732 (while (string-match re string)
21733 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21734 (cdr e)))
21735 (setq string (replace-match rpl t t string))))
21736 (while (setq pchg (next-property-change pchg string))
21737 (let ((sref (get-text-property pchg 'sref string)))
21738 (when (and sref (string-match "SREF" string pchg))
21739 (setq string (replace-match sref t t string)))))
21740 string))
21742 (defun org-sublist (list start end)
21743 "Return a section of LIST, from START to END.
21744 Counting starts at 1."
21745 (let (rtn (c start))
21746 (setq list (nthcdr (1- start) list))
21747 (while (and list (<= c end))
21748 (push (pop list) rtn)
21749 (setq c (1+ c)))
21750 (nreverse rtn)))
21752 (defun org-find-base-buffer-visiting (file)
21753 "Like `find-buffer-visiting' but always return the base buffer and
21754 not an indirect buffer."
21755 (let ((buf (or (get-file-buffer file)
21756 (find-buffer-visiting file))))
21757 (if buf
21758 (or (buffer-base-buffer buf) buf)
21759 nil)))
21761 (defun org-image-file-name-regexp (&optional extensions)
21762 "Return regexp matching the file names of images.
21763 If EXTENSIONS is given, only match these."
21764 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21765 (image-file-name-regexp)
21766 (let ((image-file-name-extensions
21767 (or extensions
21768 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21769 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21771 (regexp-opt (nconc (mapcar 'upcase
21772 image-file-name-extensions)
21773 image-file-name-extensions)
21774 t)
21777 (defun org-file-image-p (file &optional extensions)
21778 "Return non-nil if FILE is an image."
21779 (save-match-data
21780 (string-match (org-image-file-name-regexp extensions) file)))
21782 (defun org-get-cursor-date (&optional with-time)
21783 "Return the date at cursor in as a time.
21784 This works in the calendar and in the agenda, anywhere else it just
21785 returns the current time.
21786 If WITH-TIME is non-nil, returns the time of the event at point (in
21787 the agenda) or the current time of the day."
21788 (let (date day defd tp tm hod mod)
21789 (when with-time
21790 (setq tp (get-text-property (point) 'time))
21792 (setq hod (string-to-number (match-string 1 tp))
21793 mod (string-to-number (match-string 2 tp))))
21794 (or tp (setq hod (nth 2 (decode-time (current-time)))
21795 mod (nth 1 (decode-time (current-time))))))
21796 (cond
21797 ((eq major-mode 'calendar-mode)
21798 (setq date (calendar-cursor-to-date)
21799 defd (encode-time 0 (or mod 0) (or hod 0)
21800 (nth 1 date) (nth 0 date) (nth 2 date))))
21801 ((eq major-mode 'org-agenda-mode)
21802 (setq day (get-text-property (point) 'day))
21803 (if day
21804 (setq date (calendar-gregorian-from-absolute day)
21805 defd (encode-time 0 (or mod 0) (or hod 0)
21806 (nth 1 date) (nth 0 date) (nth 2 date))))))
21807 (or defd (current-time))))
21809 (defun org-mark-subtree (&optional up)
21810 "Mark the current subtree.
21811 This puts point at the start of the current subtree, and mark at
21812 the end. If a numeric prefix UP is given, move up into the
21813 hierarchy of headlines by UP levels before marking the subtree."
21814 (interactive "P")
21815 (org-with-limited-levels
21816 (cond ((org-at-heading-p) (beginning-of-line))
21817 ((org-before-first-heading-p) (error "Not in a subtree"))
21818 (t (outline-previous-visible-heading 1))))
21819 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21820 (if (org-called-interactively-p 'any)
21821 (call-interactively 'org-mark-element)
21822 (org-mark-element)))
21825 ;;; Indentation
21827 (defun org-indent-line ()
21828 "Indent line depending on context."
21829 (interactive)
21830 (let* ((pos (point))
21831 (itemp (org-at-item-p))
21832 (case-fold-search t)
21834 (inline-task-p (and (featurep 'org-inlinetask)
21835 (org-inlinetask-in-task-p)))
21836 (inline-re (and inline-task-p
21837 (org-inlinetask-outline-regexp)))
21838 column)
21839 (if (and orgstruct-is-++ (eq pos (point)))
21840 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21841 (indent-according-to-mode))
21842 (beginning-of-line 1)
21843 (cond
21844 ;; Headings
21845 ((looking-at org-outline-regexp) (setq column 0))
21846 ;; Footnote definition
21847 ((looking-at org-footnote-definition-re) (setq column 0))
21848 ;; Literal examples
21850 (setq column (org-get-indentation))) ; do nothing
21851 ;; Lists
21852 ((ignore-errors (goto-char (org-in-item-p)))
21853 (setq column (if itemp
21854 (org-get-indentation)
21855 (org-list-item-body-column (point))))
21856 (goto-char pos))
21857 ;; Drawers
21859 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21860 (save-excursion
21861 (goto-char (1- (match-beginning 1)))
21862 (setq column (current-column))))
21863 ;; Special blocks
21865 (save-excursion
21866 (re-search-backward
21868 (setq column (org-get-indentation (match-string 0))))
21871 (save-excursion
21873 (setq column
21874 (cond ((equal (downcase (match-string 1)) "src")
21875 ;; src blocks: let `org-edit-src-exit' handle them
21876 (org-get-indentation))
21877 ((equal (downcase (match-string 1)) "example")
21878 (max (org-get-indentation)
21879 (org-get-indentation (match-string 0))))
21880 (t
21881 (org-get-indentation (match-string 0))))))
21882 ;; This line has nothing special, look at the previous relevant
21883 ;; line to compute indentation
21884 (t
21885 (beginning-of-line 0)
21886 (while (and (not (bobp))
21887 (not (looking-at org-table-line-regexp))
21888 (not (looking-at org-drawer-regexp))
21889 ;; When point started in an inline task, do not move
21890 ;; above task starting line.
21891 (not (and inline-task-p (looking-at inline-re)))
21892 ;; Skip drawers, blocks, empty lines, verbatim,
21893 ;; comments, tables, footnotes definitions, lists,
21894 ;; inline tasks.
21896 (re-search-backward org-drawer-regexp nil t))
21900 (looking-at org-footnote-definition-re)
21901 (and (not inline-task-p)
21902 (featurep 'org-inlinetask)
21903 (org-inlinetask-in-task-p)
21904 (or (org-inlinetask-goto-beginning) t))))
21905 (beginning-of-line 0))
21906 (cond
21907 ;; There was a list item above.
21908 ((save-excursion
21909 (and (ignore-errors (goto-char (org-in-item-p)))
21910 (goto-char
21911 (org-list-get-top-point (org-list-struct)))))
21912 (looking-at org-list-full-item-re)
21913 (setq column (length (match-string 0))))
21914 ;; There was an heading above.
21916 (if (not org-adapt-indentation)
21917 (setq column 0)
21918 (goto-char (match-end 0))
21919 (setq column (current-column))))
21920 ;; A drawer had started and is unfinished
21921 ((looking-at org-drawer-regexp)
21922 (goto-char (1- (match-beginning 1)))
21923 (setq column (current-column)))
21924 ;; Else, nothing noticeable found: get indentation and go on.
21925 (t (setq column (org-get-indentation))))))
21926 ;; Now apply indentation and move cursor accordingly
21927 (goto-char pos)
21928 (if (<= (current-column) (current-indentation))
21929 (org-indent-line-to column)
21930 (save-excursion (org-indent-line-to column)))
21931 ;; Special polishing for properties, see `org-property-format'
21932 (setq column (current-column))
21933 (beginning-of-line 1)
21934 (if (looking-at
21936 (replace-match (concat (match-string 1)
21937 (format org-property-format
21938 (match-string 2) (match-string 3)))
21939 t t))
21940 (org-move-to-column column))))
21942 (defun org-indent-drawer ()
21943 "Indent the drawer at point."
21944 (interactive)
21945 (let ((p (point))
21946 (e (and (save-excursion (re-search-forward ":END:" nil t))
21947 (match-end 0)))
21948 (folded
21949 (save-excursion
21950 (end-of-line)
21951 (when (overlays-at (point))
21952 (member 'invisible (overlay-properties
21953 (car (overlays-at (point)))))))))
21954 (when folded (org-cycle))
21955 (indent-for-tab-command)
21956 (while (and (move-beginning-of-line 2) (< (point) e))
21957 (indent-for-tab-command))
21958 (goto-char p)
21959 (when folded (org-cycle)))
21960 (message "Drawer at point indented"))
21962 (defun org-indent-block ()
21963 "Indent the block at point."
21964 (interactive)
21965 (let ((p (point))
21966 (case-fold-search t)
21968 (match-end 0)))
21969 (folded
21970 (save-excursion
21971 (end-of-line)
21972 (when (overlays-at (point))
21973 (member 'invisible (overlay-properties
21974 (car (overlays-at (point)))))))))
21975 (when folded (org-cycle))
21976 (indent-for-tab-command)
21977 (while (and (move-beginning-of-line 2) (< (point) e))
21978 (indent-for-tab-command))
21979 (goto-char p)
21980 (when folded (org-cycle)))
21981 (message "Block at point indented"))
21983 (defun org-indent-region (start end)
21984 "Indent region."
21985 (interactive "r")
21986 (save-excursion
21987 (let ((line-end (org-current-line end)))
21988 (goto-char start)
21989 (while (< (org-current-line) line-end)
21990 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21991 (t (call-interactively 'org-indent-line)))
21992 (move-beginning-of-line 2)))))
21995 ;;; Filling
21997 ;; We use our own fill-paragraph and auto-fill functions.
21999 ;; `org-fill-paragraph' relies on adaptive filling and context
22000 ;; checking. Appropriate `fill-prefix' is computed with
22001 ;; `org-adaptive-fill-function'.
22003 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22004 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22005 ;; `org-adaptive-fill-function' value. Internally,
22006 ;; `org-comment-line-break-function' breaks the line.
22008 ;; `org-setup-filling' installs filling and auto-filling related
22009 ;; variables during `org-mode' initialization.
22011 (defun org-setup-filling ()
22012 (interactive)
22013 ;; Prevent auto-fill from inserting unwanted new items.
22014 (when (boundp 'fill-nobreak-predicate)
22015 (org-set-local
22016 'fill-nobreak-predicate
22017 (org-uniquify
22018 (append fill-nobreak-predicate
22019 '(org-fill-paragraph-separate-nobreak-p
22020 org-fill-line-break-nobreak-p
22021 org-fill-paragraph-with-timestamp-nobreak-p)))))
22022 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22023 (org-set-local 'auto-fill-inhibit-regexp nil)
22024 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22025 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22026 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22028 (defvar org-element-paragraph-separate) ; org-element.el
22029 (defun org-fill-paragraph-separate-nobreak-p ()
22030 "Non-nil when a line break at point would insert a new item."
22031 (looking-at (substring org-element-paragraph-separate 1)))
22033 (defun org-fill-line-break-nobreak-p ()
22034 "Non-nil when a line break at point would create an Org line break."
22035 (save-excursion
22040 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22041 "Non-nil when a line break at point would insert a new item."
22042 (and (org-at-timestamp-p t)
22043 (not (looking-at org-ts-regexp-both))))
22045 (declare-function message-in-body-p "message" ())
22046 (defvar orgtbl-line-start-regexp) ; From org-table.el
22047 (defun org-adaptive-fill-function ()
22048 "Compute a fill prefix for the current line.
22049 Return fill prefix, as a string, or nil if current line isn't
22050 meant to be filled."
22051 (let (prefix)
22052 (catch 'exit
22053 (when (derived-mode-p 'message-mode)
22054 (save-excursion
22055 (beginning-of-line)
22056 (cond ((or (not (message-in-body-p))
22057 (looking-at orgtbl-line-start-regexp))
22058 (throw 'exit nil))
22059 ((looking-at message-cite-prefix-regexp)
22060 (throw 'exit (match-string-no-properties 0)))
22061 ((looking-at org-outline-regexp)
22062 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22063 (org-with-wide-buffer
22064 (let* ((p (line-beginning-position))
22065 (element (save-excursion
22066 (beginning-of-line)
22067 (or (ignore-errors (org-element-at-point))
22068 (user-error "An element cannot be parsed line %d"
22069 (line-number-at-pos (point))))))
22070 (type (org-element-type element))
22071 (post-affiliated (org-element-property :post-affiliated element)))
22072 (unless (and post-affiliated (< p post-affiliated))
22073 (case type
22075 (footnote-definition "")
22076 ((item plain-list)
22077 (make-string (org-list-item-body-column
22078 (or post-affiliated
22079 (org-element-property :begin element)))
22080 ? ))
22081 (paragraph
22082 ;; Fill prefix is usually the same as the current line,
22083 ;; except if the paragraph is at the beginning of an item.
22084 (let ((parent (org-element-property :parent element)))
22085 (cond ((eq (org-element-type parent) 'item)
22086 (make-string (org-list-item-body-column
22087 (org-element-property :begin parent))
22088 ? ))
22090 (match-string 0))
22091 (t ""))))
22092 (comment-block
22093 ;; Only fill contents if P is within block boundaries.
22094 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22095 (forward-line)
22096 (point)))
22097 (cend (save-excursion
22098 (goto-char (org-element-property :end element))
22100 (line-beginning-position))))
22101 (when (and (>= p cbeg) (< p cend))
22103 (match-string 0)
22104 "")))))))))))
22106 (declare-function message-goto-body "message" ())
22107 (defvar message-cite-prefix-regexp) ; From message.el
22108 (defun org-fill-paragraph (&optional justify)
22109 "Fill element at point, when applicable.
22111 This function only applies to comment blocks, comments, example
22112 blocks and paragraphs. Also, as a special case, re-align table
22113 when point is at one.
22115 If JUSTIFY is non-nil (interactively, with prefix argument),
22116 justify as well. If `sentence-end-double-space' is non-nil, then
22117 period followed by one space does not end a sentence, so don't
22118 break a line there. The variable `fill-column' controls the
22119 width for filling.
22121 For convenience, when point is at a plain list, an item or
22122 a footnote definition, try to fill the first paragraph within."
22123 (interactive)
22124 (if (and (derived-mode-p 'message-mode)
22125 (or (not (message-in-body-p))
22126 (save-excursion (move-beginning-of-line 1)
22127 (looking-at message-cite-prefix-regexp))))
22128 ;; First ensure filling is correct in message-mode.
22129 (let ((fill-paragraph-function
22130 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22131 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22132 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22133 (paragraph-separate
22134 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22135 (fill-paragraph nil))
22136 (with-syntax-table org-mode-transpose-word-syntax-table
22137 ;; Move to end of line in order to get the first paragraph
22138 ;; within a plain list or a footnote definition.
22139 (let ((element (save-excursion
22140 (end-of-line)
22141 (or (ignore-errors (org-element-at-point))
22142 (user-error "An element cannot be parsed line %d"
22143 (line-number-at-pos (point)))))))
22144 ;; First check if point is in a blank line at the beginning of
22145 ;; the buffer. In that case, ignore filling.
22146 (case (org-element-type element)
22147 ;; Use major mode filling function is src blocks.
22148 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22149 ;; Align Org tables, leave table.el tables as-is.
22150 (table-row (org-table-align) t)
22151 (table
22152 (when (eq (org-element-property :type element) 'org)
22153 (org-table-align))
22154 t)
22155 (paragraph
22156 ;; Paragraphs may contain `line-break' type objects.
22157 (let ((beg (max (point-min)
22158 (org-element-property :contents-begin element)))
22159 (end (min (point-max)
22160 (org-element-property :contents-end element))))
22161 ;; Do nothing if point is at an affiliated keyword.
22162 (if (< (line-end-position) beg) t
22163 (when (derived-mode-p 'message-mode)
22164 ;; In `message-mode', do not fill following citation
22165 ;; in current paragraph nor text before message body.
22166 (let ((body-start (save-excursion (message-goto-body))))
22167 (when body-start (setq beg (max body-start beg))))
22168 (when (save-excursion
22169 (re-search-forward
22170 (concat "^" message-cite-prefix-regexp) end t))
22171 (setq end (match-beginning 0))))
22172 ;; Fill paragraph, taking line breaks into account.
22173 ;; For that, slice the paragraph using line breaks as
22174 ;; separators, and fill the parts in reverse order to
22175 ;; avoid messing with markers.
22176 (save-excursion
22177 (goto-char end)
22178 (mapc
22179 (lambda (pos)
22180 (fill-region-as-paragraph pos (point) justify)
22181 (goto-char pos))
22182 ;; Find the list of ending positions for line breaks
22183 ;; in the current paragraph. Add paragraph
22184 ;; beginning to include first slice.
22185 (nreverse
22186 (cons beg
22187 (org-element-map
22188 (org-element--parse-objects
22189 beg end nil (org-element-restriction 'paragraph))
22190 'line-break
22191 (lambda (lb) (org-element-property :end lb)))))))
22192 t)))
22193 ;; Contents of `comment-block' type elements should be
22194 ;; filled as plain text, but only if point is within block
22195 ;; markers.
22196 (comment-block
22197 (let* ((case-fold-search t)
22198 (beg (save-excursion
22199 (goto-char (org-element-property :begin element))
22201 (forward-line)
22202 (point)))
22203 (end (save-excursion
22204 (goto-char (org-element-property :end element))
22206 (line-beginning-position))))
22207 (when (and (>= (point) beg) (< (point) end))
22208 (fill-region-as-paragraph
22209 (save-excursion
22210 (end-of-line)
22212 (line-beginning-position))
22213 (save-excursion
22214 (beginning-of-line)
22216 (line-beginning-position))
22217 justify)))
22218 t)
22219 ;; Fill comments.
22220 (comment (fill-comment-paragraph justify))
22221 ;; Ignore every other element.
22222 (otherwise t))))))
22224 (defun org-auto-fill-function ()
22225 "Auto-fill function."
22226 ;; Check if auto-filling is meaningful.
22227 (let ((fc (current-fill-column)))
22228 (when (and fc (> (current-column) fc))
22229 (let* ((fill-prefix (org-adaptive-fill-function))
22230 ;; Enforce empty fill prefix, if required. Otherwise, it
22231 ;; will be computed again.
22232 (adaptive-fill-mode (not (equal fill-prefix ""))))
22233 (when fill-prefix (do-auto-fill))))))
22235 (defun org-comment-line-break-function (&optional soft)
22236 "Break line at point and indent, continuing comment if within one.
22237 The inserted newline is marked hard if variable
22238 `use-hard-newlines' is true, unless optional argument SOFT is
22239 non-nil."
22241 (save-excursion (forward-char -1) (delete-horizontal-space))
22242 (delete-horizontal-space)
22243 (indent-to-left-margin)
22244 (insert-before-markers-and-inherit fill-prefix))
22247 ;;; Comments
22249 ;; Org comments syntax is quite complex. It requires the entire line
22250 ;; to be just a comment. Also, even with the right syntax at the
22251 ;; beginning of line, some some elements (i.e. verse-block or
22252 ;; example-block) don't accept comments. Usual Emacs comment commands
22253 ;; cannot cope with those requirements. Therefore, Org replaces them.
22255 ;; Org still relies on `comment-dwim', but cannot trust
22256 ;; `comment-only-p'. So, `comment-region-function' and
22257 ;; `uncomment-region-function' both point
22258 ;; to`org-comment-or-uncomment-region'. Eventually,
22259 ;; `org-insert-comment' takes care of insertion of comments at the
22260 ;; beginning of line.
22262 ;; `org-setup-comments-handling' install comments related variables
22263 ;; during `org-mode' initialization.
22265 (defun org-setup-comments-handling ()
22266 (interactive)
22267 (org-set-local 'comment-use-syntax nil)
22268 (org-set-local 'comment-start "# ")
22270 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22271 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22272 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22274 (defun org-insert-comment ()
22275 "Insert an empty comment above current line.
22276 If the line is empty, insert comment at its beginning."
22277 (beginning-of-line)
22279 (org-indent-line)
22280 (insert "# "))
22282 (defvar comment-empty-lines) ; From newcomment.el.
22283 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22284 "Comment or uncomment each non-blank line in the region.
22285 Uncomment each non-blank line between BEG and END if it only
22286 contains commented lines. Otherwise, comment them."
22287 (save-restriction
22288 ;; Restrict region
22289 (narrow-to-region (save-excursion (goto-char beg)
22291 (line-beginning-position))
22292 (save-excursion (goto-char end)
22294 (line-end-position)))
22295 (let ((uncommentp
22296 ;; UNCOMMENTP is non-nil when every non blank line between
22297 ;; BEG and END is a comment.
22298 (save-excursion
22299 (goto-char (point-min))
22300 (while (and (not (eobp))
22301 (let ((element (org-element-at-point)))
22302 (and (eq (org-element-type element) 'comment)
22303 (goto-char (min (point-max)
22304 (org-element-property
22305 :end element)))))))
22306 (eobp))))
22307 (if uncommentp
22308 ;; Only blank lines and comments in region: uncomment it.
22309 (save-excursion
22310 (goto-char (point-min))
22311 (while (not (eobp))
22313 (replace-match "" nil nil nil 1))
22314 (forward-line)))
22315 ;; Comment each line in region.
22316 (let ((min-indent (point-max)))
22317 ;; First find the minimum indentation across all lines.
22318 (save-excursion
22319 (goto-char (point-min))
22320 (while (and (not (eobp)) (not (zerop min-indent)))
22322 (setq min-indent (min min-indent (current-indentation))))
22323 (forward-line)))
22324 ;; Then loop over all lines.
22325 (save-excursion
22326 (goto-char (point-min))
22327 (while (not (eobp))
22329 ;; Don't get fooled by invisible text (e.g. link path)
22330 ;; when moving to column MIN-INDENT.
22331 (let ((buffer-invisibility-spec nil))
22332 (org-move-to-column min-indent t))
22333 (insert comment-start))
22334 (forward-line))))))))
22337 ;;; Planning
22339 ;; This section contains tools to operate on timestamp objects, as
22340 ;; returned by, e.g. `org-element-context'.
22342 (defun org-timestamp-has-time-p (timestamp)
22343 "Non-nil when TIMESTAMP has a time specified."
22344 (org-element-property :hour-start timestamp))
22346 (defun org-timestamp-format (timestamp format &optional end utc)
22347 "Format a TIMESTAMP element into a string.
22349 FORMAT is a format specifier to be passed to
22350 `format-time-string'.
22352 When optional argument END is non-nil, use end of date-range or
22353 time-range, if possible.
22355 When optional argument UTC is non-nil, time will be expressed as
22356 Universal Time."
22357 (format-time-string
22358 format
22359 (apply 'encode-time
22360 (cons 0
22361 (mapcar
22362 (lambda (prop) (or (org-element-property prop timestamp) 0))
22363 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22364 '(:minute-start :hour-start :day-start :month-start
22365 :year-start)))))
22366 utc))
22368 (defun org-timestamp-split-range (timestamp &optional end)
22369 "Extract a timestamp object from a date or time range.
22371 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22372 the end of the range. Otherwise, extract its start.
22374 Return a new timestamp object sharing the same parent as
22375 TIMESTAMP."
22376 (let ((type (org-element-property :type timestamp)))
22377 (if (memq type '(active inactive diary)) timestamp
22378 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22379 ;; Set new type.
22380 (org-element-put-property
22381 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22382 ;; Copy start properties over end properties if END is
22383 ;; non-nil. Otherwise, copy end properties over `start' ones.
22384 (let ((p-alist '((:minute-start . :minute-end)
22385 (:hour-start . :hour-end)
22386 (:day-start . :day-end)
22387 (:month-start . :month-end)
22388 (:year-start . :year-end))))
22389 (dolist (p-cell p-alist)
22390 (org-element-put-property
22391 split-ts
22392 (funcall (if end 'car 'cdr) p-cell)
22393 (org-element-property
22394 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22395 ;; Eventually refresh `:raw-value'.
22396 (org-element-put-property split-ts :raw-value nil)
22397 (org-element-put-property
22398 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22400 (defun org-timestamp-translate (timestamp &optional boundary)
22401 "Apply `org-translate-time' on a TIMESTAMP object.
22402 When optional argument BOUNDARY is non-nil, it is either the
22403 symbol `start' or `end'. In this case, only translate the
22404 starting or ending part of TIMESTAMP if it is a date or time
22405 range. Otherwise, translate both parts."
22406 (if (and (not boundary)
22407 (memq (org-element-property :type timestamp)
22408 '(active-range inactive-range)))
22409 (concat
22410 (org-translate-time
22411 (org-element-property :raw-value
22412 (org-timestamp-split-range timestamp)))
22413 "--"
22414 (org-translate-time
22415 (org-element-property :raw-value
22416 (org-timestamp-split-range timestamp t))))
22417 (org-translate-time
22418 (org-element-property
22419 :raw-value
22420 (if (not boundary) timestamp
22421 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22425 ;;; Other stuff.
22427 (defun org-toggle-fixed-width-section (arg)
22428 "Toggle the fixed-width export.
22429 If there is no active region, the QUOTE keyword at the current headline is
22430 inserted or removed. When present, it causes the text between this headline
22431 and the next to be exported as fixed-width text, and unmodified.
22432 If there is an active region, this command adds or removes a colon as the
22433 first character of this line. If the first character of a line is a colon,
22434 this line is also exported in fixed-width font."
22435 (interactive "P")
22436 (let* ((cc 0)
22437 (regionp (org-region-active-p))
22438 (beg (if regionp (region-beginning) (point)))
22439 (end (if regionp (region-end)))
22440 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22441 (case-fold-search nil)
22443 off)
22444 (if regionp
22445 (save-excursion
22446 (goto-char beg)
22447 (setq cc (current-column))
22448 (beginning-of-line 1)
22449 (setq off (looking-at re))
22450 (while (> nlines 0)
22451 (setq nlines (1- nlines))
22452 (beginning-of-line 1)
22453 (cond
22454 (arg
22455 (org-move-to-column cc t)
22457 (forward-line -1))
22458 ((and off (looking-at re))
22459 (replace-match "" t t nil 1))
22460 ((not off) (org-move-to-column cc t) (insert ": ")))
22461 (forward-line 1)))
22462 (save-excursion
22463 (org-back-to-heading)
22464 (cond
22465 ((looking-at (format org-heading-keyword-regexp-format
22466 org-quote-string))
22467 (goto-char (match-end 1))
22468 (looking-at (concat " +" org-quote-string))
22469 (replace-match "" t t)
22470 (when (eolp) (insert " ")))
22471 ((looking-at org-outline-regexp)
22472 (goto-char (match-end 0))
22473 (insert org-quote-string " ")))))))
22475 (defun org-reftex-citation ()
22476 "Use reftex-citation to insert a citation into the buffer.
22477 This looks for a line like
22479 #+BIBLIOGRAPHY: foo plain option:-d
22481 and derives from it that foo.bib is the bibliography file relevant
22482 for this document. It then installs the necessary environment for RefTeX
22483 to work in this buffer and calls `reftex-citation' to insert a citation
22484 into the buffer.
22486 Export of such citations to both LaTeX and HTML is handled by the contributed
22487 package org-exp-bibtex by Taru Karttunen."
22488 (interactive)
22489 (let ((reftex-docstruct-symbol 'rds)
22491 rds bib)
22492 (save-excursion
22493 (save-restriction
22494 (widen)
22495 (let ((case-fold-search t)
22497 (if (not (save-excursion
22498 (or (re-search-forward re nil t)
22499 (re-search-backward re nil t))))
22500 (error "No bibliography defined in file")
22501 (setq bib (concat (match-string 1) ".bib")
22502 rds (list (list 'bib bib)))))))
22503 (call-interactively 'reftex-citation)))
22505 ;;;; Functions extending outline functionality
22507 (defun org-beginning-of-line (&optional arg)
22508 "Go to the beginning of the current line. If that is invisible, continue
22509 to a visible line beginning. This makes the function of C-a more intuitive.
22510 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22511 first attempt, and only move to after the tags when the cursor is already
22512 beyond the end of the headline."
22513 (interactive "P")
22514 (let ((pos (point))
22515 (special (if (consp org-special-ctrl-a/e)
22516 (car org-special-ctrl-a/e)
22517 org-special-ctrl-a/e))
22518 refpos)
22519 (if (org-bound-and-true-p visual-line-mode)
22520 (beginning-of-visual-line 1)
22521 (beginning-of-line 1))
22522 (if (and arg (fboundp 'move-beginning-of-line))
22523 (call-interactively 'move-beginning-of-line)
22524 (if (bobp)
22525 nil
22526 (backward-char 1)
22527 (if (org-truely-invisible-p)
22528 (while (and (not (bobp)) (org-truely-invisible-p))
22529 (backward-char 1)
22530 (beginning-of-line 1))
22531 (forward-char 1))))
22532 (when special
22533 (cond
22534 ((and (looking-at org-complex-heading-regexp)
22535 (= (char-after (match-end 1)) ?\ ))
22536 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22537 (point-at-eol)))
22538 (goto-char
22539 (if (eq special t)
22540 (cond ((> pos refpos) refpos)
22541 ((= pos (point)) refpos)
22542 (t (point)))
22543 (cond ((> pos (point)) (point))
22544 ((not (eq last-command this-command)) (point))
22545 (t refpos)))))
22546 ((org-at-item-p)
22547 ;; Being at an item and not looking at an the item means point
22548 ;; was previously moved to beginning of a visual line, which
22549 ;; doesn't contain the item. Therefore, do nothing special,
22550 ;; just stay here.
22551 (when (looking-at org-list-full-item-re)
22552 ;; Set special position at first white space character after
22553 ;; bullet, and check-box, if any.
22554 (let ((after-bullet
22555 (let ((box (match-end 3)))
22556 (if (not box) (match-end 1)
22557 (let ((after (char-after box)))
22558 (if (and after (= after ? )) (1+ box) box))))))
22559 ;; Special case: Move point to special position when
22560 ;; currently after it or at beginning of line.
22561 (if (eq special t)
22562 (when (or (> pos after-bullet) (= (point) pos))
22563 (goto-char after-bullet))
22564 ;; Reversed case: Move point to special position when
22565 ;; point was already at beginning of line and command is
22566 ;; repeated.
22567 (when (and (= (point) pos) (eq last-command this-command))
22568 (goto-char after-bullet))))))))
22569 (org-no-warnings
22570 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22572 (defun org-end-of-line (&optional arg)
22573 "Go to the end of the line.
22574 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22575 tags on the first attempt, and only move to after the tags when
22576 the cursor is already beyond the end of the headline."
22577 (interactive "P")
22578 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22579 org-special-ctrl-a/e))
22580 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22581 'end-of-visual-line)
22582 ((fboundp 'move-end-of-line) 'move-end-of-line)
22583 (t 'end-of-line))))
22584 (if (or (not special) arg) (call-interactively move-fun)
22585 (let* ((element (save-excursion (beginning-of-line)
22586 (org-element-at-point)))
22587 (type (org-element-type element)))
22588 (cond
22589 ((memq type '(headline inlinetask))
22590 (let ((pos (point)))
22591 (beginning-of-line 1)
22593 (if (eq special t)
22594 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22595 (goto-char (match-beginning 1))
22596 (goto-char (match-end 0)))
22597 (if (or (< pos (match-end 0))
22598 (not (eq this-command last-command)))
22599 (goto-char (match-end 0))
22600 (goto-char (match-beginning 1))))
22601 (call-interactively move-fun))))
22602 ((org-element-property :hiddenp element)
22603 ;; If element is hidden, `move-end-of-line' would put point
22604 ;; after it. Use `end-of-line' to stay on current line.
22605 (call-interactively 'end-of-line))
22606 (t (call-interactively move-fun)))))
22607 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22609 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22610 (define-key org-mode-map "\C-e" 'org-end-of-line)
22612 (defun org-backward-sentence (&optional arg)
22613 "Go to beginning of sentence, or beginning of table field.
22614 This will call `backward-sentence' or `org-table-beginning-of-field',
22615 depending on context."
22616 (interactive "P")
22617 (cond
22618 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22619 (t (call-interactively 'backward-sentence))))
22621 (defun org-forward-sentence (&optional arg)
22622 "Go to end of sentence, or end of table field.
22623 This will call `forward-sentence' or `org-table-end-of-field',
22624 depending on context."
22625 (interactive "P")
22626 (cond
22627 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22628 (t (call-interactively 'forward-sentence))))
22630 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22631 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22633 (defun org-kill-line (&optional arg)
22634 "Kill line, to tags or end of line."
22635 (interactive "P")
22636 (cond
22637 ((or (not org-special-ctrl-k)
22638 (bolp)
22639 (not (org-at-heading-p)))
22640 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22641 org-ctrl-k-protect-subtree)
22642 (if (or (eq org-ctrl-k-protect-subtree 'error)
22643 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22644 (error "C-k aborted - would kill hidden subtree")))
22645 (call-interactively
22646 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22648 (kill-region (point) (match-beginning 1))
22649 (org-set-tags nil t))
22650 (t (kill-region (point) (point-at-eol)))))
22652 (define-key org-mode-map "\C-k" 'org-kill-line)
22654 (defun org-yank (&optional arg)
22655 "Yank. If the kill is a subtree, treat it specially.
22656 This command will look at the current kill and check if is a single
22657 subtree, or a series of subtrees[1]. If it passes the test, and if the
22658 cursor is at the beginning of a line or after the stars of a currently
22659 empty headline, then the yank is handled specially. How exactly depends
22660 on the value of the following variables, both set by default.
22662 org-yank-folded-subtrees
22663 When set, the subtree(s) will be folded after insertion, but only
22664 if doing so would now swallow text after the yanked text.
22666 org-yank-adjusted-subtrees
22667 When set, the subtree will be promoted or demoted in order to
22668 fit into the local outline tree structure, which means that the level
22669 will be adjusted so that it becomes the smaller one of the two
22670 *visible* surrounding headings.
22672 Any prefix to this command will cause `yank' to be called directly with
22674 will just
22675 plainly yank the text as it is.
22677 \[1] The test checks if the first non-white line is a heading
22678 and if there are no other headings with fewer stars."
22679 (interactive "P")
22680 (org-yank-generic 'yank arg))
22682 (defun org-yank-generic (command arg)
22683 "Perform some yank-like command.
22685 This function implements the behavior described in the `org-yank'
22686 documentation. However, it has been generalized to work for any
22687 interactive command with similar behavior."
22689 ;; pretend to be command COMMAND
22690 (setq this-command command)
22692 (if arg
22693 (call-interactively command)
22695 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22696 (and (org-kill-is-subtree-p)
22697 (or (bolp)
22699 (string-match
22701 (buffer-substring (point-at-bol) (point)))))))
22702 swallowp)
22703 (cond
22704 ((and subtreep org-yank-folded-subtrees)
22705 (let ((beg (point))
22706 end)
22707 (if (and subtreep org-yank-adjusted-subtrees)
22708 (org-paste-subtree nil nil 'for-yank)
22709 (call-interactively command))
22711 (setq end (point))
22712 (goto-char beg)
22713 (when (and (bolp) subtreep
22714 (not (setq swallowp
22715 (org-yank-folding-would-swallow-text beg end))))
22716 (org-with-limited-levels
22717 (or (looking-at org-outline-regexp)
22718 (re-search-forward org-outline-regexp-bol end t))
22719 (while (and (< (point) end) (looking-at org-outline-regexp))
22720 (hide-subtree)
22721 (org-cycle-show-empty-lines 'folded)
22722 (condition-case nil
22723 (outline-forward-same-level 1)
22724 (error (goto-char end))))))
22725 (when swallowp
22726 (message
22727 "Inserted text not folded because that would swallow text"))
22729 (goto-char end)
22731 (beginning-of-line 1)
22732 (push-mark beg 'nomsg)))
22733 ((and subtreep org-yank-adjusted-subtrees)
22734 (let ((beg (point-at-bol)))
22735 (org-paste-subtree nil nil 'for-yank)
22736 (push-mark beg 'nomsg)))
22737 (t
22738 (call-interactively command))))))
22740 (defun org-yank-folding-would-swallow-text (beg end)
22741 "Would hide-subtree at BEG swallow any text after END?"
22742 (let (level)
22743 (org-with-limited-levels
22744 (save-excursion
22745 (goto-char beg)
22746 (when (or (looking-at org-outline-regexp)
22747 (re-search-forward org-outline-regexp-bol end t))
22748 (setq level (org-outline-level)))
22749 (goto-char end)
22751 (if (or (eobp)
22752 (and (bolp) (looking-at org-outline-regexp)
22753 (<= (org-outline-level) level)))
22754 nil ; Nothing would be swallowed
22755 t))))) ; something would swallow
22757 (define-key org-mode-map "\C-y" 'org-yank)
22759 (defun org-truely-invisible-p ()
22760 "Check if point is at a character currently not visible.
22761 This version does not only check the character property, but also
22762 `visible-mode'."
22763 ;; Early versions of noutline don't have `outline-invisible-p'.
22764 (if (org-bound-and-true-p visible-mode)
22765 nil
22766 (outline-invisible-p)))
22768 (defun org-invisible-p2 ()
22769 "Check if point is at a character currently not visible."
22770 (save-excursion
22771 (if (and (eolp) (not (bobp))) (backward-char 1))
22772 ;; Early versions of noutline don't have `outline-invisible-p'.
22773 (outline-invisible-p)))
22775 (defun org-back-to-heading (&optional invisible-ok)
22776 "Call `outline-back-to-heading', but provide a better error message."
22777 (condition-case nil
22778 (outline-back-to-heading invisible-ok)
22779 (error (error "Before first headline at position %d in buffer %s"
22780 (point) (current-buffer)))))
22782 (defun org-before-first-heading-p ()
22783 "Before first heading?"
22784 (save-excursion
22785 (end-of-line)
22786 (null (re-search-backward org-outline-regexp-bol nil t))))
22788 (defun org-at-heading-p (&optional ignored)
22789 (outline-on-heading-p t))
22790 ;; Compatibility alias with Org versions < 7.8.03
22791 (defalias 'org-on-heading-p 'org-at-heading-p)
22793 (defun org-at-comment-p nil
22794 "Is cursor in a line starting with a # character?"
22795 (save-excursion
22796 (beginning-of-line)
22797 (looking-at "^#")))
22799 (defun org-at-drawer-p nil
22800 "Is cursor at a drawer keyword?"
22801 (save-excursion
22802 (move-beginning-of-line 1)
22803 (looking-at org-drawer-regexp)))
22805 (defun org-at-block-p nil
22806 "Is cursor at a block keyword?"
22807 (save-excursion
22808 (move-beginning-of-line 1)
22809 (looking-at org-block-regexp)))
22811 (defun org-point-at-end-of-empty-headline ()
22812 "If point is at the end of an empty headline, return t, else nil.
22813 If the heading only contains a TODO keyword, it is still still considered
22814 empty."
22816 (when org-todo-line-regexp
22817 (save-excursion
22818 (beginning-of-line 1)
22819 (let ((case-fold-search nil))
22820 (looking-at org-todo-line-regexp)
22821 (string= (match-string 3) ""))))))
22823 (defun org-at-heading-or-item-p ()
22824 (or (org-at-heading-p) (org-at-item-p)))
22826 (defun org-at-target-p ()
22827 (or (org-in-regexp org-radio-target-regexp)
22828 (org-in-regexp org-target-regexp)))
22829 ;; Compatibility alias with Org versions < 7.8.03
22830 (defalias 'org-on-target-p 'org-at-target-p)
22832 (defun org-up-heading-all (arg)
22833 "Move to the heading line of which the present line is a subheading.
22834 This function considers both visible and invisible heading lines.
22835 With argument, move up ARG levels."
22836 (if (fboundp 'outline-up-heading-all)
22837 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22838 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22840 (defun org-up-heading-safe ()
22841 "Move to the heading line of which the present line is a subheading.
22842 This version will not throw an error. It will return the level of the
22843 headline found, or nil if no higher level is found.
22845 Also, this function will be a lot faster than `outline-up-heading',
22846 because it relies on stars being the outline starters. This can really
22847 make a significant difference in outlines with very many siblings."
22848 (let (start-level re)
22849 (org-back-to-heading t)
22850 (setq start-level (funcall outline-level))
22851 (if (equal start-level 1)
22852 nil
22854 (if (re-search-backward re nil t)
22855 (funcall outline-level)))))
22857 (defun org-first-sibling-p ()
22858 "Is this heading the first child of its parents?"
22859 (interactive)
22860 (let ((re org-outline-regexp-bol)
22861 level l)
22862 (unless (org-at-heading-p t)
22863 (error "Not at a heading"))
22864 (setq level (funcall outline-level))
22865 (save-excursion
22866 (if (not (re-search-backward re nil t))
22867 t
22868 (setq l (funcall outline-level))
22869 (< l level)))))
22871 (defun org-goto-sibling (&optional previous)
22872 "Goto the next sibling, even if it is invisible.
22873 When PREVIOUS is set, go to the previous sibling instead. Returns t
22874 when a sibling was found. When none is found, return nil and don't
22875 move point."
22876 (let ((fun (if previous 're-search-backward 're-search-forward))
22877 (pos (point))
22878 (re org-outline-regexp-bol)
22879 level l)
22880 (when (condition-case nil (org-back-to-heading t) (error nil))
22881 (setq level (funcall outline-level))
22882 (catch 'exit
22883 (or previous (forward-char 1))
22884 (while (funcall fun re nil t)
22885 (setq l (funcall outline-level))
22886 (when (< l level) (goto-char pos) (throw 'exit nil))
22887 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22888 (goto-char pos)
22889 nil))))
22891 (defun org-show-siblings ()
22892 "Show all siblings of the current headline."
22893 (save-excursion
22894 (while (org-goto-sibling) (org-flag-heading nil)))
22895 (save-excursion
22896 (while (org-goto-sibling 'previous)
22897 (org-flag-heading nil))))
22899 (defun org-goto-first-child ()
22900 "Goto the first child, even if it is invisible.
22901 Return t when a child was found. Otherwise don't move point and
22902 return nil."
22903 (let (level (pos (point)) (re org-outline-regexp-bol))
22904 (when (condition-case nil (org-back-to-heading t) (error nil))
22905 (setq level (outline-level))
22906 (forward-char 1)
22907 (if (and (re-search-forward re nil t) (> (outline-level) level))
22908 (progn (goto-char (match-beginning 0)) t)
22909 (goto-char pos) nil))))
22911 (defun org-show-hidden-entry ()
22912 "Show an entry where even the heading is hidden."
22913 (save-excursion
22914 (org-show-entry)))
22916 (defun org-flag-heading (flag &optional entry)
22917 "Flag the current heading. FLAG non-nil means make invisible.
22918 When ENTRY is non-nil, show the entire entry."
22919 (save-excursion
22920 (org-back-to-heading t)
22921 ;; Check if we should show the entire entry
22922 (if entry
22923 (progn
22924 (org-show-entry)
22925 (save-excursion
22926 (and (outline-next-heading)
22927 (org-flag-heading nil))))
22928 (outline-flag-region (max (point-min) (1- (point)))
22929 (save-excursion (outline-end-of-heading) (point))
22930 flag))))
22932 (defun org-get-next-sibling ()
22933 "Move to next heading of the same level, and return point.
22934 If there is no such heading, return nil.
22935 This is like outline-next-sibling, but invisible headings are ok."
22936 (let ((level (funcall outline-level)))
22937 (outline-next-heading)
22938 (while (and (not (eobp)) (> (funcall outline-level) level))
22939 (outline-next-heading))
22940 (if (or (eobp) (< (funcall outline-level) level))
22941 nil
22942 (point))))
22944 (defun org-get-last-sibling ()
22945 "Move to previous heading of the same level, and return point.
22946 If there is no such heading, return nil."
22947 (let ((opoint (point))
22948 (level (funcall outline-level)))
22949 (outline-previous-heading)
22950 (when (and (/= (point) opoint) (outline-on-heading-p t))
22951 (while (and (> (funcall outline-level) level)
22952 (not (bobp)))
22953 (outline-previous-heading))
22954 (if (< (funcall outline-level) level)
22955 nil
22956 (point)))))
22958 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22959 "Goto to the end of a subtree."
22960 ;; This contains an exact copy of the original function, but it uses
22961 ;; `org-back-to-heading', to make it work also in invisible
22962 ;; trees. And is uses an invisible-ok argument.
22963 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22964 ;; Furthermore, when used inside Org, finding the end of a large subtree
22965 ;; with many children and grandchildren etc, this can be much faster
22966 ;; than the outline version.
22967 (org-back-to-heading invisible-ok)
22968 (let ((first t)
22969 (level (funcall outline-level)))
22970 (if (and (derived-mode-p 'org-mode) (< level 1000))
22971 ;; A true heading (not a plain list item), in Org-mode
22972 ;; This means we can easily find the end by looking
22973 ;; only for the right number of stars. Using a regexp to do
22974 ;; this is so much faster than using a Lisp loop.
22976 (forward-char 1)
22977 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22978 ;; something else, do it the slow way
22979 (while (and (not (eobp))
22980 (or first (> (funcall outline-level) level)))
22981 (setq first nil)
22982 (outline-next-heading)))
22983 (unless to-heading
22985 (progn
22986 ;; Go to end of line before heading
22987 (forward-char -1)
22989 ;; leave blank line before heading
22990 (forward-char -1))))))
22991 (point))
22993 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22994 "Use Org version in org-mode, for dramatic speed-up."
22995 (if (derived-mode-p 'org-mode)
22996 (progn
22997 (org-end-of-subtree nil t)
22998 (unless (eobp) (backward-char 1)))
22999 ad-do-it))
23001 (defun org-end-of-meta-data-and-drawers ()
23002 "Jump to the first text after meta data and drawers in the current entry.
23003 This will move over empty lines, lines with planning time stamps,
23004 clocking lines, and drawers."
23005 (org-back-to-heading t)
23006 (let ((end (save-excursion (outline-next-heading) (point)))
23009 (forward-line 1)
23010 (while (re-search-forward re end t)
23011 (if (not (match-end 1))
23012 ;; empty or planning line
23013 (forward-line 1)
23014 ;; a drawer, find the end
23016 (forward-line 1)))
23018 (point)))
23020 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23021 "Move forward to the ARG'th subheading at same level as this one.
23022 Stop at the first and last subheadings of a superior heading.
23023 Normally this only looks at visible headings, but when INVISIBLE-OK is
23024 non-nil it will also look at invisible ones."
23025 (interactive "p")
23026 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23027 (if (and arg (< arg 0))
23028 (goto-char (point-min))
23029 (outline-next-heading))
23030 (org-at-heading-p)
23031 (let ((level (- (match-end 0) (match-beginning 0) 1))
23032 (f (if (and arg (< arg 0))
23033 're-search-backward
23034 're-search-forward))
23035 (count (if arg (abs arg) 1))
23036 (result (point)))
23037 (while (and (prog1 (> count 0)
23038 (forward-char (if (and arg (< arg 0)) -1 1)))
23039 (funcall f org-outline-regexp-bol nil 'move))
23040 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23041 (cond ((< l level) (setq count 0))
23042 ((and (= l level)
23043 (or invisible-ok
23044 (progn
23045 (goto-char (line-beginning-position))
23046 (not (outline-invisible-p)))))
23047 (setq count (1- count))
23048 (when (eq l level)
23049 (setq result (point)))))))
23050 (goto-char result))
23051 (beginning-of-line 1)))
23053 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23054 "Move backward to the ARG'th subheading at same level as this one.
23055 Stop at the first and last subheadings of a superior heading."
23056 (interactive "p")
23057 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23059 (defun org-next-block (arg &optional backward block-regexp)
23060 "Jump to the next block.
23061 With a prefix argument ARG, jump forward ARG many source blocks.
23062 When BACKWARD is non-nil, jump to the previous block.
23063 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23064 (interactive "p")
23065 (let ((re (or block-regexp org-block-regexp))
23066 (re-search-fn (or (and backward 're-search-backward)
23067 're-search-forward)))
23068 (if (looking-at re) (forward-char 1))
23069 (condition-case nil
23070 (funcall re-search-fn re nil nil arg)
23071 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23072 (goto-char (match-beginning 0)) (org-show-context)))
23074 (defun org-previous-block (arg &optional block-regexp)
23075 "Jump to the previous block.
23076 With a prefix argument ARG, jump backward ARG many source blocks.
23077 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23078 (interactive "p")
23079 (org-next-block arg t block-regexp))
23081 (defun org-forward-element ()
23082 "Move forward by one element.
23083 Move to the next element at the same level, when possible."
23084 (interactive)
23085 (cond ((eobp) (user-error "Cannot move further down"))
23086 ((org-with-limited-levels (org-at-heading-p))
23087 (let ((origin (point)))
23088 (goto-char (org-end-of-subtree nil t))
23089 (unless (org-with-limited-levels (org-at-heading-p))
23090 (goto-char origin)
23091 (user-error "Cannot move further down"))))
23092 (t
23093 (let* ((elem (org-element-at-point))
23094 (end (org-element-property :end elem))
23095 (parent (org-element-property :parent elem)))
23096 (if (and parent (= (org-element-property :contents-end parent) end))
23097 (goto-char (org-element-property :end parent))
23098 (goto-char end))))))
23100 (defun org-backward-element ()
23101 "Move backward by one element.
23102 Move to the previous element at the same level, when possible."
23103 (interactive)
23104 (cond ((bobp) (user-error "Cannot move further up"))
23105 ((org-with-limited-levels (org-at-heading-p))
23106 ;; At a headline, move to the previous one, if any, or stay
23107 ;; here.
23108 (let ((origin (point)))
23109 (org-with-limited-levels (org-backward-heading-same-level 1))
23110 ;; When current headline has no sibling above, move to its
23111 ;; parent.
23112 (when (= (point) origin)
23113 (or (org-with-limited-levels (org-up-heading-safe))
23114 (progn (goto-char origin)
23115 (user-error "Cannot move further up"))))))
23116 (t
23117 (let* ((trail (org-element-at-point 'keep-trail))
23118 (elem (car trail))
23119 (prev-elem (nth 1 trail))
23120 (beg (org-element-property :begin elem)))
23121 (cond
23122 ;; Move to beginning of current element if point isn't
23123 ;; there already.
23124 ((/= (point) beg) (goto-char beg))
23125 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23126 ((org-before-first-heading-p) (goto-char (point-min)))
23127 (t (org-back-to-heading)))))))
23129 (defun org-up-element ()
23130 "Move to upper element."
23131 (interactive)
23132 (if (org-with-limited-levels (org-at-heading-p))
23133 (unless (org-up-heading-safe) (error "No surrounding element"))
23134 (let* ((elem (org-element-at-point))
23135 (parent (org-element-property :parent elem)))
23136 (if parent (goto-char (org-element-property :begin parent))
23137 (if (org-with-limited-levels (org-before-first-heading-p))
23138 (error "No surrounding element")
23139 (org-with-limited-levels (org-back-to-heading)))))))
23141 (defvar org-element-greater-elements)
23142 (defun org-down-element ()
23143 "Move to inner element."
23144 (interactive)
23145 (let ((element (org-element-at-point)))
23146 (cond
23147 ((memq (org-element-type element) '(plain-list table))
23148 (goto-char (org-element-property :contents-begin element))
23149 (forward-char))
23150 ((memq (org-element-type element) org-element-greater-elements)
23151 ;; If contents are hidden, first disclose them.
23152 (when (org-element-property :hiddenp element) (org-cycle))
23153 (goto-char (or (org-element-property :contents-begin element)
23154 (error "No content for this element"))))
23155 (t (error "No inner element")))))
23157 (defun org-drag-element-backward ()
23158 "Move backward element at point."
23159 (interactive)
23160 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23161 (let* ((trail (org-element-at-point 'keep-trail))
23162 (elem (car trail))
23163 (prev-elem (nth 1 trail)))
23164 ;; Error out if no previous element or previous element is
23165 ;; a parent of the current one.
23166 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23167 (error "Cannot drag element backward")
23168 (let ((pos (point)))
23169 (org-element-swap-A-B prev-elem elem)
23170 (goto-char (+ (org-element-property :begin prev-elem)
23171 (- pos (org-element-property :begin elem)))))))))
23173 (defun org-drag-element-forward ()
23174 "Move forward element at point."
23175 (interactive)
23176 (let* ((pos (point))
23177 (elem (org-element-at-point)))
23178 (when (= (point-max) (org-element-property :end elem))
23179 (error "Cannot drag element forward"))
23180 (goto-char (org-element-property :end elem))
23181 (let ((next-elem (org-element-at-point)))
23182 (when (or (org-element-nested-p elem next-elem)
23183 (and (eq (org-element-type next-elem) 'headline)
23184 (not (eq (org-element-type elem) 'headline))))
23185 (goto-char pos)
23186 (error "Cannot drag element forward"))
23187 ;; Compute new position of point: it's shifted by NEXT-ELEM
23188 ;; body's length (without final blanks) and by the length of
23189 ;; blanks between ELEM and NEXT-ELEM.
23190 (let ((size-next (- (save-excursion
23191 (goto-char (org-element-property :end next-elem))
23193 (forward-line)
23194 ;; Small correction if buffer doesn't end
23195 ;; with a newline character.
23196 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23197 (org-element-property :begin next-elem)))
23198 (size-blank (- (org-element-property :end elem)
23199 (save-excursion
23200 (goto-char (org-element-property :end elem))
23202 (forward-line)
23203 (point)))))
23204 (org-element-swap-A-B elem next-elem)
23205 (goto-char (+ pos size-next size-blank))))))
23207 (defun org-drag-line-forward (arg)
23208 "Drag the line at point ARG lines forward."
23209 (interactive "p")
23210 (dotimes (n (abs arg))
23211 (let ((c (current-column)))
23212 (if (< 0 arg)
23213 (progn
23214 (beginning-of-line 2)
23215 (transpose-lines 1)
23216 (beginning-of-line 0))
23217 (transpose-lines 1)
23218 (beginning-of-line -1))
23219 (org-move-to-column c))))
23221 (defun org-drag-line-backward (arg)
23222 "Drag the line at point ARG lines backward."
23223 (interactive "p")
23224 (org-drag-line-forward (- arg)))
23226 (defun org-mark-element ()
23227 "Put point at beginning of this element, mark at end.
23229 Interactively, if this command is repeated or (in Transient Mark
23230 mode) if the mark is active, it marks the next element after the
23231 ones already marked."
23232 (interactive)
23233 (let (deactivate-mark)
23234 (if (and (org-called-interactively-p 'any)
23235 (or (and (eq last-command this-command) (mark t))
23236 (and transient-mark-mode mark-active)))
23237 (set-mark
23238 (save-excursion
23239 (goto-char (mark))
23240 (goto-char (org-element-property :end (org-element-at-point)))))
23241 (let ((element (org-element-at-point)))
23242 (end-of-line)
23243 (push-mark (org-element-property :end element) t t)
23244 (goto-char (org-element-property :begin element))))))
23246 (defun org-narrow-to-element ()
23247 "Narrow buffer to current element."
23248 (interactive)
23249 (let ((elem (org-element-at-point)))
23250 (cond
23251 ((eq (car elem) 'headline)
23252 (narrow-to-region
23253 (org-element-property :begin elem)
23254 (org-element-property :end elem)))
23255 ((memq (car elem) org-element-greater-elements)
23256 (narrow-to-region
23257 (org-element-property :contents-begin elem)
23258 (org-element-property :contents-end elem)))
23259 (t
23260 (narrow-to-region
23261 (org-element-property :begin elem)
23262 (org-element-property :end elem))))))
23264 (defun org-transpose-element ()
23265 "Transpose current and previous elements, keeping blank lines between.
23266 Point is moved after both elements."
23267 (interactive)
23268 (org-skip-whitespace)
23269 (let ((end (org-element-property :end (org-element-at-point))))
23270 (org-drag-element-backward)
23271 (goto-char end)))
23273 (defun org-unindent-buffer ()
23274 "Un-indent the visible part of the buffer.
23275 Relative indentation (between items, inside blocks, etc.) isn't
23276 modified."
23277 (interactive)
23278 (unless (eq major-mode 'org-mode)
23279 (error "Cannot un-indent a buffer not in Org mode"))
23280 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23281 unindent-tree ; For byte-compiler.
23282 (unindent-tree
23283 (function
23284 (lambda (contents)
23285 (mapc
23286 (lambda (element)
23287 (if (memq (org-element-type element) '(headline section))
23288 (funcall unindent-tree (org-element-contents element))
23289 (save-excursion
23290 (save-restriction
23291 (narrow-to-region
23292 (org-element-property :begin element)
23293 (org-element-property :end element))
23294 (org-do-remove-indentation)))))
23295 (reverse contents))))))
23296 (funcall unindent-tree (org-element-contents parse-tree))))
23298 (defun org-show-subtree ()
23299 "Show everything after this heading at deeper levels."
23300 (interactive)
23301 (outline-flag-region
23302 (point)
23303 (save-excursion
23304 (org-end-of-subtree t t))
23305 nil))
23307 (defun org-show-entry ()
23308 "Show the body directly following this heading.
23309 Show the heading too, if it is currently invisible."
23310 (interactive)
23311 (save-excursion
23312 (condition-case nil
23313 (progn
23314 (org-back-to-heading t)
23315 (outline-flag-region
23316 (max (point-min) (1- (point)))
23317 (save-excursion
23318 (if (re-search-forward
23320 (match-beginning 1)
23321 (point-max)))
23322 nil)
23323 (org-cycle-hide-drawers 'children))
23324 (error nil))))
23326 (defun org-make-options-regexp (kwds &optional extra)
23327 "Make a regular expression for keyword lines."
23328 (concat
23334 ;; Make isearch reveal the necessary context
23335 (defun org-isearch-end ()
23336 "Reveal context after isearch exits."
23337 (when isearch-success ; only if search was successful
23338 (if (featurep 'xemacs)
23339 ;; Under XEmacs, the hook is run in the correct place,
23340 ;; we directly show the context.
23341 (org-show-context 'isearch)
23342 ;; In Emacs the hook runs *before* restoring the overlays.
23343 ;; So we have to use a one-time post-command-hook to do this.
23344 ;; (Emacs 22 has a special variable, see function `org-mode')
23345 (unless (and (boundp 'isearch-mode-end-hook-quit)
23346 isearch-mode-end-hook-quit)
23347 ;; Only when the isearch was not quitted.
23348 (org-add-hook 'post-command-hook 'org-isearch-post-command
23349 'append 'local)))
23350 (org-fix-ellipsis-at-bol)))
23352 (defun org-isearch-post-command ()
23353 "Remove self from hook, and show context."
23354 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23355 (org-show-context 'isearch))
23358 ;;;; Integration with and fixes for other packages
23360 ;;; Imenu support
23362 (defvar org-imenu-markers nil
23363 "All markers currently used by Imenu.")
23364 (make-variable-buffer-local 'org-imenu-markers)
23366 (defun org-imenu-new-marker (&optional pos)
23367 "Return a new marker for use by Imenu, and remember the marker."
23368 (let ((m (make-marker)))
23369 (move-marker m (or pos (point)))
23370 (push m org-imenu-markers)
23371 m))
23373 (defun org-imenu-get-tree ()
23374 "Produce the index for Imenu."
23375 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23376 (setq org-imenu-markers nil)
23377 (let* ((n org-imenu-depth)
23378 (re (concat "^" (org-get-limited-outline-regexp)))
23379 (subs (make-vector (1+ n) nil))
23380 (last-level 0)
23381 m level head0 head)
23382 (save-excursion
23383 (save-restriction
23384 (widen)
23385 (goto-char (point-max))
23386 (while (re-search-backward re nil t)
23387 (setq level (org-reduced-level (funcall outline-level)))
23388 (when (and (<= level n)
23389 (looking-at org-complex-heading-regexp)
23390 (setq head0 (org-match-string-no-properties 4)))
23391 (setq head (org-link-display-format head0)
23392 m (org-imenu-new-marker))
23393 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23394 (if (>= level last-level)
23395 (push (cons head m) (aref subs level))
23396 (push (cons head (aref subs (1+ level))) (aref subs level))
23397 (loop for i from (1+ level) to n do (aset subs i nil)))
23398 (setq last-level level)))))
23399 (aref subs 1)))
23401 (eval-after-load "imenu"
23402 '(progn
23403 (add-hook 'imenu-after-jump-hook
23404 (lambda ()
23405 (if (derived-mode-p 'org-mode)
23406 (org-show-context 'org-goto))))))
23408 (defun org-link-display-format (link)
23409 "Replace a link with its the description.
23410 If there is no description, use the link target."
23411 (save-match-data
23412 (if (string-match org-bracket-link-analytic-regexp link)
23413 (replace-match (if (match-end 5)
23414 (match-string 5 link)
23415 (concat (match-string 1 link)
23416 (match-string 3 link)))
23417 nil t link)
23418 link)))
23420 (defun org-toggle-link-display ()
23421 "Toggle the literal or descriptive display of links."
23422 (interactive)
23423 (if org-descriptive-links
23424 (progn (org-remove-from-invisibility-spec '(org-link))
23425 (org-restart-font-lock)
23426 (setq org-descriptive-links nil))
23427 (progn (add-to-invisibility-spec '(org-link))
23428 (org-restart-font-lock)
23429 (setq org-descriptive-links t))))
23431 ;; Speedbar support
23433 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23434 "Overlay marking the agenda restriction line in speedbar.")
23435 (overlay-put org-speedbar-restriction-lock-overlay
23436 'face 'org-agenda-restriction-lock)
23437 (overlay-put org-speedbar-restriction-lock-overlay
23438 'help-echo "Agendas are currently limited to this item.")
23439 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23441 (defun org-speedbar-set-agenda-restriction ()
23442 "Restrict future agenda commands to the location at point in speedbar.
23444 (interactive)
23445 (require 'org-agenda)
23446 (let (p m tp np dir txt)
23447 (cond
23448 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23449 'org-imenu t))
23450 (setq m (get-text-property p 'org-imenu-marker))
23451 (with-current-buffer (marker-buffer m)
23452 (goto-char m)
23453 (org-agenda-set-restriction-lock 'subtree)))
23454 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23455 'speedbar-function 'speedbar-find-file))
23456 (setq tp (previous-single-property-change
23457 (1+ p) 'speedbar-function)
23458 np (next-single-property-change
23459 tp 'speedbar-function)
23460 dir (speedbar-line-directory)
23461 txt (buffer-substring-no-properties (or tp (point-min))
23462 (or np (point-max))))
23463 (with-current-buffer (find-file-noselect
23464 (let ((default-directory dir))
23465 (expand-file-name txt)))
23466 (unless (derived-mode-p 'org-mode)
23467 (error "Cannot restrict to non-Org-mode file"))
23468 (org-agenda-set-restriction-lock 'file)))
23469 (t (error "Don't know how to restrict Org-mode's agenda")))
23470 (move-overlay org-speedbar-restriction-lock-overlay
23471 (point-at-bol) (point-at-eol))
23472 (setq current-prefix-arg nil)
23473 (org-agenda-maybe-redo)))
23475 (eval-after-load "speedbar"
23476 '(progn
23477 (speedbar-add-supported-extension ".org")
23478 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23479 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23480 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23481 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23482 (add-hook 'speedbar-visiting-tag-hook
23483 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23485 ;;; Fixes and Hacks for problems with other packages
23487 ;; Make flyspell not check words in links, to not mess up our keymap
23488 (defvar org-element-affiliated-keywords) ; From org-element.el
23489 (defvar org-element-block-name-alist) ; From org-element.el
23490 (defun org-mode-flyspell-verify ()
23491 "Don't let flyspell put overlays at active buttons, or on
23492 {todo,all-time,additional-option-like}-keywords."
23493 (require 'org-element) ; For `org-element-affiliated-keywords'
23494 (let ((pos (max (1- (point)) (point-min)))
23495 (word (thing-at-point 'word)))
23496 (and (not (get-text-property pos 'keymap))
23497 (not (get-text-property pos 'org-no-flyspell))
23498 (not (member word org-todo-keywords-1))
23499 (not (member word org-all-time-keywords))
23500 (not (member word org-options-keywords))
23501 (not (member word (mapcar 'car org-startup-options)))
23502 (not (member-ignore-case word org-element-affiliated-keywords))
23503 (not (member-ignore-case word (org-get-export-keywords)))
23504 (not (member-ignore-case
23505 word (mapcar 'car org-element-block-name-alist)))
23506 (not (member-ignore-case word '("BEGIN" "END" "ATTR"))))))
23508 (defun org-remove-flyspell-overlays-in (beg end)
23509 "Remove flyspell overlays in region."
23510 (and (org-bound-and-true-p flyspell-mode)
23511 (fboundp 'flyspell-delete-region-overlays)
23512 (flyspell-delete-region-overlays beg end))
23513 (add-text-properties beg end '(org-no-flyspell t)))
23515 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23516 (eval-after-load "bookmark"
23517 '(if (boundp 'bookmark-after-jump-hook)
23518 ;; We can use the hook
23519 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23520 ;; Hook not available, use advice
23521 (defadvice bookmark-jump (after org-make-visible activate)
23522 "Make the position visible."
23523 (org-bookmark-jump-unhide))))
23525 ;; Make sure saveplace shows the location if it was hidden
23526 (eval-after-load "saveplace"
23527 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23528 "Make the position visible."
23529 (org-bookmark-jump-unhide)))
23531 ;; Make sure ecb shows the location if it was hidden
23532 (eval-after-load "ecb"
23533 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23534 "Make hierarchy visible when jumping into location from ECB tree buffer."
23535 (if (derived-mode-p 'org-mode)
23536 (org-show-context))))
23538 (defun org-bookmark-jump-unhide ()
23539 "Unhide the current position, to show the bookmark location."
23540 (and (derived-mode-p 'org-mode)
23541 (or (outline-invisible-p)
23542 (save-excursion (goto-char (max (point-min) (1- (point))))
23543 (outline-invisible-p)))
23544 (org-show-context 'bookmark-jump)))
23546 ;; Make session.el ignore our circular variable
23547 (eval-after-load "session"
23548 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23550 ;;;; Finish up
23552 (provide 'org)
23554 (run-hooks 'org-load-hook)
23556 ;;; org.el ends here