| blob | 26e653fbce690a28e69e512e1ed1e0995bb49d30 |
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: Carsten Dominik <carsten at orgmode 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))
163 ;; load languages based on value of `org-babel-load-languages'
166 ;;;###autoload
168 "Load the languages defined in `org-babel-load-languages'."
180 org-babel-load-languages))
182 ;;;###autoload
184 "Load Emacs Lisp source code blocks in the Org-mode FILE.
185 This function exports the source code using `org-babel-tangle'
186 and then loads the resulting file using `load-file'. With prefix
187 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
188 file to byte-code before it is loaded."
198 ;; tangle if the org-mode file is newer than the elisp file
207 exported-file)))
210 "Languages which can be evaluated in Org-mode buffers.
211 This list can be used to load support for any of the languages
212 below, note that each language will depend on a different set of
213 system executables and/or Emacs modes. When a language is
215 with `org-babel-execute-src-block' bound by default to C-c
216 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
217 be set to remove code block evaluation from the C-c C-c
218 keybinding. By default only Emacs Lisp (which has no
219 requirements) is loaded."
224 :key-type
268 ;;;; Customization variables
270 "Remove ID property of clones of a subtree.
271 When non-nil, clones of a subtree don't inherit the ID property.
272 Otherwise they inherit the ID property with a new unique
273 identifier."
278 ;;; Version
281 ;;;###autoload
283 "Show the org-mode version in the echo area.
284 With prefix argument HERE, insert it at point.
285 When FULL is non-nil, use a verbose version string.
286 When MESSAGE is non-nil, display a message with the version."
299 org-version
300 git-version
303 org-install-dir
312 _version)))
316 ;;; Compatibility constants
318 ;;; The custom variables
321 "Outline-based notes management and organizer."
327 "Mode hook for Org-mode, run after the mode was turned on."
332 "Hook that is run after org.el has been loaded."
337 "Hook that is run after an Org log buffer is created."
347 "Load all extensions listed in `org-modules'."
352 org-modules)
356 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
361 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
362 "Modules that should always be loaded together with org.el.
364 If a description starts with <C>, the file is not part of Emacs
365 and loading it will require that you have downloaded and properly
366 installed the Org mode distribution.
368 You can also use this system to load external packages (i.e. neither Org
369 core modules, nor modules from the CONTRIB directory). Just add symbols
370 to the end of the list. If the package is called org-xyz.el, then you need
371 to add the symbol `xyz', and the package must have a call to:
373 \(provide 'org-xyz)
375 For export specific modules, see also `org-export-backends'."
380 :type
405 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
414 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
419 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
443 "List of export back-ends that should be always available.
445 If a description starts with <C>, the file is not part of Emacs
446 and loading it will require that you have downloaded and properly
447 installed the Org mode distribution.
449 Unlike to `org-modules', libraries in this list will not be
450 loaded along with Org, but only once the export framework is
451 needed.
453 This variable needs to be set before org.el is loaded. If you
454 need to make a change while Emacs is running, use the customize
455 interface or run the following code, where VAL stands for the new
456 value of the variable, after updating it:
458 \(progn
459 \(setq org-export--registered-backends
460 \(org-remove-if-not
461 \(lambda (backend)
462 \(let ((name (org-export-backend-name backend)))
463 \(or (memq name val)
464 \(catch 'parentp
465 \(dolist (b val)
466 \(and (org-export-derived-backend-p b name)
467 \(throw 'parentp t)))))))
468 org-export--registered-backends))
469 \(let ((new-list (mapcar 'org-export-backend-name
470 org-export--registered-backends)))
471 \(dolist (backend val)
472 \(cond
475 backend))
476 \((not (memq backend new-list)) (push backend new-list))))
477 \(set-default 'org-export-backends new-list)))
479 Adding a back-end to this list will also pull the back-end it
480 depends on, if any."
488 ;; Any back-end not required anymore (not present in VAL and not
489 ;; a parent of any back-end in the new value) is removed from the
490 ;; list of registered back-ends.
500 org-export--registered-backends))
501 ;; Now build NEW-LIST of both new back-ends and required
502 ;; parents.
504 org-export--registered-backends)))
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."
1790 "Non-nil means use indirect buffer to display infile links.
1791 Activating internal links (from one location in a file to another location
1792 in the same file) normally just jumps to the location. When the link is
1794 is displayed in
1795 another window. When this option is set, the other window actually displays
1796 an indirect buffer clone of the current buffer, to avoid any visibility
1797 changes to the current buffer."
1802 "Non-nil means `org-open-file' will open non-existing files.
1803 When nil, an error will be generated.
1804 This variable applies only to external applications because they
1805 might choke on non-existing files. If the link is to a file that
1806 will be opened in Emacs, the variable is ignored."
1811 "Non-nil means a link to a directory really means to index.org.
1812 When nil, following a directory link will run dired or open a finder/explorer
1813 window on that directory."
1818 "Function and arguments to call for following mailto links.
1819 This is a list with the first element being a Lisp function, and the
1820 remaining elements being arguments to the function. In string arguments,
1821 %a will be replaced by the address, and %s will be replaced by the subject
1822 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1831 "Non-nil means ask for confirmation before executing shell links.
1832 Shell links can be dangerous: just think about a link
1834 [[shell:rm -rf ~/*][Google Search]]
1837 but really it would remove your entire home directory.
1838 Therefore we advise against setting this variable to nil.
1839 Just change it to `y-or-n-p' if you want to confirm with a
1847 'safe-local-variable
1851 "A regexp to skip confirmation for shell links."
1857 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1858 Elisp links can be dangerous: just think about a link
1863 but really it would remove your entire home directory.
1864 Therefore we advise against setting this variable to nil.
1865 Just change it to `y-or-n-p' if you want to confirm with a
1873 'safe-local-variable
1877 "A regexp to skip confirmation for Elisp links."
1886 "Default file applications on a UNIX or GNU/Linux system.
1897 "Default file applications on a MacOS X system.
1899 for some files for which the OS does not have a good default.
1907 'mswindows-shell-execute
1912 'mswindows-shell-execute
1915 "Default file applications on a Windows NT system.
1924 "External applications for opening `file:path' items in a document.
1925 Org-mode uses system defaults for different file types, but
1926 you can use this variable to set the application for a given file
1927 extension. The entries in this list are cons cells where the car identifies
1928 files and the cdr the corresponding command. Possible values for the
1929 file identifier are
1931 ways, depending on its contents:
1933 - Alphanumeric characters only:
1934 Match links with this file extension.
1936 to open PDFs with evince.
1938 - Regular expression: Match links where the
1939 filename matches the regexp. If you want to
1940 use groups here, use shy groups.
1944 to open *.html and *.xhtml with firefox.
1946 - Regular expression which contains (non-shy) groups:
1948 anything after that, matches the regexp.
1949 In a custom command string, %1, %2, etc. are replaced with
1950 the parts of the link that were matched by the groups.
1951 For backwards compatibility, if a command string is given
1952 that does not use any of the group matches, this case is
1953 handled identically to the second one (i.e. match against
1954 file name only).
1955 In a custom lisp form, you can access the group matches with
1956 (match-string n link).
1959 to open [[file:document.pdf::5]] with evince at page 5.
1961 `directory' Matches a directory
1962 `remote' Matches a remote file, accessible through tramp or efs.
1963 Remote files most likely should be visited through Emacs
1964 because external applications cannot handle such paths.
1965 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1966 so all files Emacs knows how to handle. Using this with
1967 command `emacs' will open most files in Emacs. Beware that this
1968 will also open html files inside Emacs, unless you add
1970 t Default for files not matched by any of the other options.
1971 `system' The system command to open files, like `open' on Windows
1972 and Mac OS X, and mailcap under GNU/Linux. This is the command
1973 that will be selected if you call `C-c C-o' with a double
1976 Possible values for the command are:
1977 `emacs' The file will be visited by the current Emacs process.
1978 `default' Use the default application for this file type, which is the
1979 association for t in the list, most likely in the system-specific
1980 part.
1981 This can be used to overrule an unwanted setting in the
1982 system-specific variable.
1984 This command is specified by the entry whose car is `system'.
1985 Most likely, the system-specific version of this variable
1986 does define this command, but you can overrule/replace it
1987 here.
1988 string A command to be executed by a shell; %s will be replaced
1989 by the path to the file.
1990 sexp A Lisp form which will be evaluated. The file path will
1991 be available in the Lisp variable `file'.
1992 For more examples, see the system specific constants
1993 `org-file-apps-defaults-macosx'
1994 `org-file-apps-defaults-windowsnt'
1995 `org-file-apps-defaults-gnu'."
2005 auto-mode))
2014 "The URL of the DOI server."
2020 "Options concerning refiling entries in Org-mode."
2025 "Directory with org files.
2026 This is just a default location to look for Org files. There is no need
2027 at all to put your files into this directory. It is only used in the
2028 following situations:
2030 1. When a capture template specifies a target file that is not an
2031 absolute path. The path will then be interpreted relative to
2032 `org-directory'
2033 2. When a capture note is filed away in an interactive way (when exiting the
2034 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2035 with `org-directory' as the default path."
2042 "Default target for storing notes.
2043 Used as a fall back file for org-remember.el and org-capture.el, for
2044 templates that do not specify a target file."
2050 file))
2053 "The default interface to be used for `org-goto'.
2054 Allowed values are:
2055 outline The interface shows an outline of the relevant file
2056 and the correct heading is found by moving through
2057 the outline or by searching with incremental search.
2058 outline-path-completion Headlines in the current buffer are offered via
2059 completion. This is the interface also used by
2060 the refile command."
2067 "Maximum target level when running `org-goto' with refile interface."
2072 "Non-nil means store new notes at the beginning of a file or entry.
2073 When nil, new notes will be filed to the end of a file or entry.
2074 This can also be a list with cons cells of regular expressions that
2075 are matched against file names, and values."
2086 "Information to record when a task is refiled.
2088 Possible values are:
2090 nil Don't add anything
2091 time Add a time stamp to the task
2092 note Prompt for a note and add it with template `org-log-note-headings'
2094 This option can also be set with on a per-file-basis with
2096 #+STARTUP: nologrefile
2097 #+STARTUP: logrefile
2098 #+STARTUP: lognoterefile
2100 You can have local logging settings for a subtree by setting the LOGGING
2101 property to one or more of these keywords.
2103 When bulk-refiling from the agenda, the value `note' is forbidden and
2104 will temporarily be changed to `time'."
2115 This is a list of cons cells. Each cell contains:
2116 - a specification of the files to be considered, either a list of files,
2117 or a symbol whose function or variable value will be used to retrieve
2118 a file name or a list of file names. If you use `org-agenda-files' for
2119 that, all agenda files will be scanned for targets. Nil means consider
2120 headings in the current buffer.
2121 - A specification of how to find candidate refile targets. This may be
2122 any of:
2124 This tag has to be present in all target headlines, inheritance will
2125 not be considered.
2127 todo keyword.
2129 headlines that are refiling targets.
2130 - a cons cell (:level . N). Any headline of level N is considered a target.
2131 Note that, when `org-odd-levels-only' is set, level corresponds to
2132 order in hierarchy, not to the number of stars.
2133 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2134 Note that, when `org-odd-levels-only' is set, level corresponds to
2135 order in hierarchy, not to the number of stars.
2137 Each element of this list generates a set of possible targets.
2138 The union of these sets is presented (with completion) to
2139 the user by `org-refile'.
2141 You can set the variable `org-refile-target-verify-function' to a function
2142 to verify each headline found by the simple criteria above.
2144 When this variable is nil, all top-level headlines in the current buffer
2145 are used, equivalent to the value `((nil . (:level . 1))'."
2161 "Function to verify if the headline at point should be a refile target.
2162 The function will be called without arguments, with point at the
2163 beginning of the headline. It should return t and leave point
2164 where it is if the headline is a valid target for refiling.
2166 If the target should not be selected, the function must return nil.
2167 In addition to this, it may move point to a place from where the search
2168 should be continued. For example, the function may decide that the entire
2169 subtree of the current entry should be excluded and move point to the end
2170 of the subtree."
2177 "Non-nil means cache refile targets to speed up the process.
2178 The cache for a particular file will be updated automatically when
2179 the buffer has been killed, or when any of the marker used for flagging
2180 refile targets no longer points at a live buffer.
2181 If you have added new entries to a buffer that might themselves be targets,
2182 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2183 find that easier, `C-u C-u C-u C-c C-w'."
2189 "Non-nil means provide refile targets as paths.
2190 So a level 3 headline will be available as level1/level2/level3.
2192 When the value is `file', also include the file name (without directory)
2193 into the path. In this case, you can also stop the completion after
2194 the file name, to get entries inserted as top level in the file.
2196 When `full-file-path', include the full file path."
2205 "Non-nil means complete the outline path in hierarchical steps.
2206 When Org-mode uses the refile interface to select an outline path
2207 \(see variable `org-refile-use-outline-path'), the completion of
2208 the path can be done is a single go, or if can be done in steps down
2209 the headline hierarchy. Going in steps is probably the best if you
2210 do not use a special completion package like `ido' or `icicles'.
2211 However, when using these packages, going in one step can be very
2212 fast, while still showing the whole path to the entry."
2217 "Non-nil means allow to create new nodes as refile targets.
2219 of an existing node. When the value of this variable is `confirm',
2220 new node creation must be confirmed by the user (recommended)
2221 When nil, the completion must match an existing entry.
2223 Note that, if the new heading is not seen by the criteria
2224 listed in `org-refile-targets', multiple instances of the same
2225 heading would be created by trying again to file under the new
2226 heading."
2234 "Non-nil means also refile active region within a subtree.
2236 By default `org-refile' doesn't allow refiling regions if they
2237 don't contain a set of subtrees, but it might be convenient to
2238 do so sometimes: in that case, the first line of the region is
2239 converted to a headline before refiling."
2245 "Options concerning TODO items in Org-mode."
2250 "Options concerning Progress logging in Org-mode."
2257 "The available interpretation symbols for customizing `org-todo-keywords'.
2261 "List of TODO entry keyword sequences and their interpretation.
2264 Each sequence starts with a symbol, either `sequence' or `type',
2265 indicating if the keywords should be interpreted as a sequence of
2266 action steps, or as different types of TODO items. The first
2267 keywords are states requiring action - these states will select a headline
2268 for inclusion into the global TODO list Org-mode produces. If one of
2271 the last keyword is treated as the only DONE state of the sequence.
2274 additional state where no keyword is present. For details about this
2275 cycling, see the manual.
2277 TODO keywords and interpretation can also be set on a per-file basis with
2278 the special #+SEQ_TODO and #+TYP_TODO lines.
2280 Each keyword can optionally specify a character for fast state selection
2281 \(in combination with the variable `org-use-fast-todo-selection')
2282 and specifiers for state change logging, using the same syntax that
2285 indicates to record a time stamp each time this state is selected.
2287 Each keyword may also specify if a timestamp or a note should be
2288 recorded when entering or leaving the state, by adding additional
2289 characters in the parenthesis after the keyword. This looks like this:
2291 record only the time of the state change. With X and Y being either
2293 Y when leaving the state if and only if the *target* state does not
2294 define X. You may omit any of the fast-selection key or X or /Y,
2295 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2297 For backward compatibility, this variable may also be just a list
2298 of keywords. In this case the interpretation (sequence or type) will be
2299 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2309 ;;Quick and dirty way to see
2310 ;;`org-todo-interpretations'. This takes the
2311 ;;place of item arguments
2312 :convert-widget
2319 org-todo-interpretation-widgets))
2320 widget))
2356 "Controls how TODO keywords are interpreted.
2357 This variable is in principle obsolete and is only used for
2358 backward compatibility, if the interpretation of todo keywords is
2359 not given already in `org-todo-keywords'. See that variable for
2360 more information."
2367 "Non-nil means use the fast todo selection scheme with C-c C-t.
2368 This variable describes if and under what circumstances the cycling
2369 mechanism for TODO keywords will be replaced by a single-key, direct
2370 selection scheme.
2372 When nil, fast selection is never used.
2374 When the symbol `prefix', it will be used when `org-todo' is called
2375 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2376 `C-u t' in an agenda buffer.
2378 When t, fast selection is used by default. In this case, the prefix
2379 argument forces cycling instead.
2381 In all cases, the special interface is only used if access keys have
2382 actually been assigned by the user, i.e. if keywords in the configuration
2383 are followed by a letter in parenthesis, like TODO(t)."
2391 "Non-nil means update todo statistics after insert and toggle.
2392 ALL-HEADLINES means update todo statistics by including headlines
2393 with no TODO keyword as well, counting them as not done.
2394 A list of TODO keywords means the same, but skip keywords that are
2395 not in this list.
2397 When this is set, todo statistics is updated in the parent of the
2398 current entry each time a todo state is changed."
2408 "Non-nil means TODO statistics covers just direct children.
2409 When nil, all entries in the subtree are considered.
2410 This has only an effect if `org-provide-todo-statistics' is set.
2411 To set this to nil for only a single subtree, use a COOKIE_DATA
2417 "Hook which is run after the state of a TODO item was changed.
2418 The new state (a string with a TODO keyword, or nil) is available in the
2419 Lisp variable `org-state'."
2424 "Hook for functions that are allowed to block a state change.
2426 Functions in this hook should not modify the buffer.
2427 Each function gets as its single argument a property list,
2428 see `org-trigger-hook' for more information about this list.
2430 If any of the functions in this hook returns nil, the state change
2434 "Hook for functions that are triggered by a state change.
2436 Each function gets as its single argument a property list with at
2437 least the following elements:
2439 (:type type-of-change :position pos-at-entry-start
2440 :from old-state :to new-state)
2442 Depending on the type, more properties may be present.
2444 This mechanism is currently implemented for:
2446 TODO state changes
2447 ------------------
2448 :type todo-state-change
2449 :from previous state (keyword as a string), or nil, or a symbol
2450 'todo' or 'done', to indicate the general type of state.
2454 "Non-nil means undone TODO entries will block switching the parent to DONE.
2455 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2456 be blocked if any prior sibling is not yet done.
2457 Finally, if the parent is blocked because of ordered siblings of its own,
2458 the child will also be blocked."
2470 "Non-nil means unchecked boxes will block switching the parent to DONE.
2471 When this is nil, checkboxes have no influence on switching TODO states.
2472 When non-nil, you first need to check off all check boxes before the TODO
2473 entry can be switched to DONE.
2474 This variable needs to be set before org.el is loaded, and you need to
2475 restart Emacs after a change to make the change effective. The only way
2476 to change is while Emacs is running is through the customize interface."
2488 "Non-nil means inserting a TODO heading is treated as state change.
2490 logging will apply if appropriate. When nil, the new TODO item will
2491 be inserted directly, and no logging will take place."
2496 "Non-nil means switching TODO states with S-cursor counts as state change.
2497 This is the default behavior. However, setting this to nil allows a
2498 convenient way to select a TODO state and bypass any logging associated
2499 with that."
2504 "Tag changes that should be triggered by TODO state changes.
2505 This is a list. Each entry is
2507 (state-change (tag . flag) .......)
2509 State-change can be a string with a state, and empty string to indicate the
2510 state that has no TODO keyword, or it can be one of the symbols `todo'
2511 or `done', meaning any not-done or done state, respectively."
2525 "Information to record when a task moves to the DONE state.
2527 Possible values are:
2529 nil Don't add anything, just change the keyword
2530 time Add a time stamp to the task
2531 note Prompt for a note and add it with template `org-log-note-headings'
2533 This option can also be set with on a per-file-basis with
2535 #+STARTUP: nologdone
2536 #+STARTUP: logdone
2537 #+STARTUP: lognotedone
2539 You can have local logging settings for a subtree by setting the LOGGING
2540 property to one or more of these keywords."
2548 ;; Normalize old uses of org-log-done.
2555 "Information to record when the scheduling date of a tasks is modified.
2557 Possible values are:
2559 nil Don't add anything, just change the date
2560 time Add a time stamp to the task
2561 note Prompt for a note and add it with template `org-log-note-headings'
2563 This option can also be set with on a per-file-basis with
2565 #+STARTUP: nologreschedule
2566 #+STARTUP: logreschedule
2567 #+STARTUP: lognotereschedule"
2576 "Information to record when the deadline date of a tasks is modified.
2578 Possible values are:
2580 nil Don't add anything, just change the date
2581 time Add a time stamp to the task
2582 note Prompt for a note and add it with template `org-log-note-headings'
2584 This option can also be set with on a per-file-basis with
2586 #+STARTUP: nologredeadline
2587 #+STARTUP: logredeadline
2588 #+STARTUP: lognoteredeadline
2590 You can have local logging settings for a subtree by setting the LOGGING
2591 property to one or more of these keywords."
2600 "Non-nil means record a note when clocking out of an item.
2601 This can also be configured on a per-file basis by adding one of
2602 the following lines anywhere in the buffer:
2604 #+STARTUP: lognoteclock-out
2605 #+STARTUP: nolognoteclock-out"
2611 "Non-nil means the CLOSED time stamp will contain date and time.
2612 When nil, only the date will be recorded."
2626 "Headings for notes added to entries.
2627 The value is an alist, with the car being a symbol indicating the note
2628 context, and the cdr is the heading to be used. The heading may also be the
2629 empty string.
2630 %t in the heading will be replaced by a time stamp.
2631 %T will be an active time stamp instead the default inactive one
2632 %d will be replaced by a short-format time stamp.
2633 %D will be replaced by an active short-format time stamp.
2634 %s will be replaced by the new TODO state, in double quotes.
2635 %S will be replaced by the old TODO state, in double quotes.
2636 %u will be replaced by the user name.
2637 %U will be replaced by the full user name.
2639 In fact, it is not a good idea to change the `state' entry, because
2640 agenda log mode depends on the format of these entries."
2646 "Heading when changing todo state (todo sequence only)"
2660 "Non-nil means insert state change notes and time stamps into a drawer.
2661 When nil, state changes notes will be inserted after the headline and
2662 any scheduling and clock lines, but not inside a drawer.
2664 The value of this variable should be the name of the drawer to use.
2665 LOGBOOK is proposed as the default drawer for this purpose, you can
2666 also set this to a string to define the drawer of your choice.
2670 A value of t or nil can also be set with on a per-file-basis with
2672 #+STARTUP: logdrawer
2673 #+STARTUP: nologdrawer
2675 If this variable is set, `org-log-state-notes-insert-after-drawers'
2676 will be ignored.
2678 You can set the property LOG_INTO_DRAWER to overrule this setting for
2679 a subtree."
2690 "Return the value of `org-log-into-drawer', but let properties overrule.
2691 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2692 used instead of the default value."
2701 "Non-nil means insert state change notes after any drawers in entry.
2702 Only the drawers that *immediately* follow the headline and the
2703 deadline/scheduled line are skipped.
2704 When nil, insert notes right after the heading and perhaps the line
2705 with deadline/scheduling if present.
2707 This variable will have no effect if `org-log-into-drawer' is
2708 set."
2714 "Non-nil means the latest state note will be directly after heading.
2715 When nil, the state change notes will be ordered according to time.
2717 This option can also be set with on a per-file-basis with
2719 #+STARTUP: logstatesreversed
2720 #+STARTUP: nologstatesreversed"
2726 "The TODO state to which a repeater should return the repeating task.
2727 By default this is the first task in a TODO sequence, or the previous state
2728 in a TODO_TYP set. But you can specify another task here.
2729 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2736 "Non-nil means record moving through the DONE state when triggering repeat.
2737 An auto-repeating task is immediately switched back to TODO when
2740 record a closing note, there will be no record of the task moving
2741 through DONE. This variable forces taking a note anyway.
2743 nil Don't force a record
2744 time Record a time stamp
2745 note Prompt for a note and add it with template `org-log-note-headings'
2747 This option can also be set with on a per-file-basis with
2749 #+STARTUP: nologrepeat
2750 #+STARTUP: logrepeat
2751 #+STARTUP: lognoterepeat
2753 You can have local logging settings for a subtree by setting the LOGGING
2754 property to one or more of these keywords."
2764 "Priorities in Org-mode."
2769 "Non-nil means priority commands are active.
2770 When nil, these commands will be disabled, so that you never accidentally
2771 set a priority."
2776 "The highest priority of TODO items. A character like ?A, ?B etc.
2777 Must have a smaller ASCII number than `org-lowest-priority'."
2782 "The lowest priority of TODO items. A character like ?A, ?B etc.
2783 Must have a larger ASCII number than `org-highest-priority'."
2788 "The default priority of TODO items.
2789 This is the priority an item gets if no explicit priority is given.
2790 When starting to cycle on an empty priority the first step in the cycle
2791 depends on `org-priority-start-cycle-with-default'. The resulting first
2792 step priority must not exceed the range from `org-highest-priority' to
2793 `org-lowest-priority' which means that `org-default-priority' has to be
2794 in this range exclusive or inclusive the range boundaries. Else the
2795 first step refuses to set the default and the second will fall back
2796 to (depending on the command used) the highest or lowest priority."
2801 "Non-nil means start with default priority when starting to cycle.
2802 When this is nil, the first step in the cycle will be (depending on the
2803 command used) one higher or lower than the default priority.
2804 See also `org-default-priority'."
2809 "Function to extract the priority from a string.
2810 The string is normally the headline. If this is nil Org computes the
2811 priority from the priority cookie like [#A] in the headline. It returns
2812 an integer, increasing by 1000 for each priority level.
2813 The user can set a different function here, which should take a string
2814 as an argument and return the numeric priority."
2822 "Options concerning time stamps and deadlines in Org-mode."
2827 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2828 When nil, these labeled time stamps are forces into the second line of an
2829 entry, just after the headline. When scheduling from the global TODO list,
2830 the time stamp will always be forced into the second line."
2835 "Formats for `format-time-string' which are used for time stamps.
2839 "Number of minutes to round time stamps to.
2840 These are two values, the first applies when first creating a time stamp.
2841 The second applies when changing it with the commands `S-up' and `S-down'.
2842 When changing the time stamp, this means that it will change in steps
2843 of N minutes, as given by the second value.
2845 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2846 numbers should be factors of 60, so for example 5, 10, 15.
2848 When this is larger than 1, you can still force an exact time stamp by using
2849 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2850 and by using a prefix arg to `S-up/down' to specify the exact number
2851 of minutes to shift."
2861 ;; Normalize old customizations of this variable.
2865 org-time-stamp-rounding-minutes)))
2868 "Non-nil means overlay custom formats over all time stamps.
2869 The formats are defined through the variable `org-time-stamp-custom-formats'.
2870 To turn this on on a per-file basis, insert anywhere in the file:
2871 #+STARTUP: customtime"
2879 "Custom formats for time stamps. See `format-time-string' for the syntax.
2880 These are overlaid over the default ISO format if the variable
2881 `org-display-custom-times' is set. Time like %H:%M should be at the
2882 end of the second format. The custom formats are also honored by export
2883 commands, if custom time display is turned on at the time of export."
2888 "Get the right format for a time string."
2893 f)))
2897 "The format string used when creating CLOCKSUM lines.
2898 This is also used when Org mode generates a time duration.
2900 The value can be a single format string containing two
2901 %-sequences, which will be filled with the number of hours and
2902 minutes in that order.
2904 Alternatively, the value can be a plist associating any of the
2905 keys :years, :months, :weeks, :days, :hours or :minutes with
2906 format strings. The time duration is formatted using only the
2907 time components that are needed and concatenating the results.
2908 If a time unit in absent, it falls back to the next smallest
2909 unit.
2911 The keys :require-years, :require-months, :require-days,
2912 :require-weeks, :require-hours, :require-minutes are also
2913 meaningful. A non-nil value for these keys indicates that the
2914 corresponding time component should always be included, even if
2915 its value is 0.
2918 For example,
2921 :require-minutes t)
2923 means durations longer than a day will be expressed in days,
2924 hours and minutes, and durations less than a day will always be
2925 expressed in hours and minutes (even for durations less than an
2926 hour).
2928 The value
2932 means durations longer than a day will be expressed in days and
2933 minutes, and durations less than a day will be expressed entirely
2934 in minutes (even for durations longer than an hour)."
2974 See `org-time-clocksum-format' for more on time clock formats."
2982 E.g. by default, one day is considered to be a 8 hours effort,
2983 so a task that has been clocked for 16 hours will be displayed
2984 as during 2 days in the clock display or in the clocktable.
2986 See `org-effort-durations' on how to set effort durations
2987 and `org-time-clocksum-format' for more on time clock formats."
2995 "The format string used when creating CLOCKSUM lines,
2996 or when Org mode generates a time duration, if
2997 `org-time-clocksum-use-fractional' is enabled.
2999 The value can be a single format string containing one
3000 %-sequence, which will be filled with the number of hours as
3001 a float.
3003 Alternatively, the value can be a plist associating any of the
3004 keys :years, :months, :weeks, :days, :hours or :minutes with
3005 a format string. The time duration is formatted using the
3006 largest time unit which gives a non-zero integer part. If all
3007 specified formats have zero integer part, the smallest time unit
3008 is used."
3025 "Number of days before expiration during which a deadline becomes active.
3026 This variable governs the display in sparse trees and in the agenda.
3027 When 0 or negative, it means use this number (the absolute value of it)
3028 even if a deadline has a different individual lead time specified.
3030 Custom commands can set this variable in the options section."
3036 "Number of days before a scheduled item becomes active.
3037 This variable governs the display in sparse trees and in the agenda.
3038 The default value (i.e. 0) means: don't delay scheduled item.
3039 When negative, it means use this number (the absolute value of it)
3040 even if a scheduled item has a different individual delay time
3041 specified.
3043 Custom commands can set this variable in the options section."
3051 "Non-nil means assume future for incomplete date input from user.
3052 This affects the following situations:
3053 1. The user gives a month but not a year.
3056 2. The user gives a day, but no month.
3059 it will be considered as *this* month.
3061 If you set this variable to the symbol `time', then also the following
3062 will work:
3064 3. If the user gives a time.
3065 If the time is before now, it will be interpreted as tomorrow.
3067 Currently none of this works for ISO week specifications.
3069 When this option is nil, the current day, month and year will always be
3070 used as defaults.
3072 See also `org-agenda-jump-prefer-future'."
3080 "Should the agenda jump command prefer the future for incomplete dates?
3081 The default is to do the same as configured in `org-read-date-prefer-future'.
3082 But you can also set a deviating value here.
3083 This may t or nil, or the symbol `org-read-date-prefer-future'."
3089 org-read-date-prefer-future)
3094 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3096 Depending on the system Emacs is running on, certain dates cannot
3097 be represented with the type used internally to represent time.
3098 Dates between 1970-1-1 and 2038-1-1 can always be represented
3099 correctly. Some systems allow for earlier dates, some for later,
3100 some for both. One way to find out it to insert any date into an
3101 Org buffer, putting the cursor on the year and hitting S-up and
3102 S-down to test the range.
3104 When this variable is set to t, the date/time prompt will not let
3105 you specify dates outside the 1970-2037 range, so it is certain that
3106 these dates will work in whatever version of Emacs you are
3107 running, and also that you can move a file from one Emacs implementation
3108 to another. WHenever Org is forcing the year for you, it will display
3109 a message and beep.
3111 When this variable is nil, Org will check if the date is
3112 representable in the specific Emacs implementation you are using.
3113 If not, it will force a year, usually the current year, and beep
3114 to remind you. Currently this setting is not recommended because
3115 the likelihood that you will open your Org files in an Emacs that
3116 has limited date range is not negligible.
3118 A workaround for this problem is to use diary sexp dates for time
3119 stamps outside of this range."
3125 "Non-nil means display current interpretation of date prompt live.
3126 This display will be in an overlay, in the minibuffer."
3131 "Non-nil means pop up a calendar when prompting for a date.
3132 In the calendar, the date can be selected with mouse-1. However, the
3133 minibuffer will also be active, and you can simply enter the date as well.
3134 When nil, only the minibuffer will be available."
3141 'org-read-date-minibuffer-setup-hook
3144 "Hook to be used to set up keys for the date/time interface.
3145 Add key definitions to `minibuffer-local-map', which will be a
3146 temporary copy.
3148 WARNING: This option is obsolete, you should use
3149 `org-read-date-minibuffer-local-map' to set up keys."
3154 "The hour when your day really ends. Must be an integer.
3155 This has influence for the following applications:
3157 the time given here, the day recognized as TODAY is actually yesterday.
3158 - When a date is read from the user and it is still before the time given
3159 here, the current date and time will be assumed to be yesterday, 23:59.
3160 Also, timestamps inserted in capture templates follow this rule.
3162 IMPORTANT: This is a feature whose implementation is and likely will
3163 remain incomplete. Really, it is only here because past midnight seems to
3164 be the favorite working time of John Wiegley :-)"
3169 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3170 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3172 23:59 of the previous day."
3178 "When non-nil, use the last clock out time for `org-todo'.
3179 Note that this option has precedence over the combined use of
3180 `org-use-effective-time' and `org-extend-today-until'."
3187 "Non-nil means S-down will increase the time in a time stamp.
3188 When nil, S-up will increase."
3193 "Non-nil means make the calendar window follow timestamp changes.
3194 When a timestamp is modified and the calendar window is visible, it will be
3195 moved to the new date."
3200 "Options concerning tags in Org-mode."
3205 "List of tags allowed in Org-mode files.
3206 When this list is nil, Org-mode will base TAG input on what is already in the
3207 buffer.
3208 The value of this variable is an alist, the car of each entry must be a
3209 keyword as a string, the cdr may be a character that is used to select
3210 that tag through the fast-tag-selection interface.
3211 See the manual for details."
3228 "List of tags that will always appear in all Org-mode files.
3229 This is in addition to any in buffer settings or customizations
3230 of `org-tag-alist'.
3231 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3232 The value of this variable is an alist, the car of each entry must be a
3233 keyword as a string, the cdr may be a character that is used to select
3234 that tag through the fast-tag-selection interface.
3235 See the manual for details.
3236 To disable these tags on a per-file basis, insert anywhere in the file:
3237 #+STARTUP: noptag"
3249 "If non-nil, always offer completion for all tags of all agenda files.
3250 Instead of customizing this variable directly, you might want to
3251 set it locally for capture buffers, because there no list of
3252 tags in that file can be created dynamically (there are none).
3254 (add-hook 'org-capture-mode-hook
3255 (lambda ()
3256 (set (make-local-variable
3257 'org-complete-tags-always-offer-all-agenda-tags)
3258 t)))"
3264 "List of tags that can be inherited by all entries in the file.
3265 The tags will be inherited if the variable `org-use-tag-inheritance'
3266 says they should be.
3270 "Non-nil means use fast tag selection scheme.
3271 This is a special interface to select and deselect tags with single keys.
3272 When nil, fast selection is never used.
3273 When the symbol `auto', fast selection is used if and only if selection
3274 characters for tags have been configured, either through the variable
3275 `org-tag-alist' or through a #+TAGS line in the buffer.
3276 When t, fast selection is always used and selection keys are assigned
3277 automatically if necessary."
3285 "Non-nil means fast tag selection exits after first change.
3286 When nil, you have to press RET to exit it.
3287 During fast tag selection, you can toggle this flag with `C-c'.
3288 This variable can also have the value `expert'. In this case, the window
3289 displaying the tags menu is not even shown, until you press C-c again."
3297 "Non-nil means fast tags selection interface will also offer TODO states.
3301 "The column to which tags should be indented in a headline.
3302 If this number is positive, it specifies the column. If it is negative,
3303 it means that the tags should be flushright to that column. For example,
3304 -80 works well for a normal 80 character screen.
3305 When 0, place tags directly after headline text, with only one space in
3306 between."
3311 "Non-nil keeps tags aligned when modifying headlines.
3312 Some operations (i.e. demoting) change the length of a headline and
3313 therefore shift the tags around. With this option turned on, after
3314 each such operation the tags are again aligned to `org-tags-column'."
3319 "Non-nil means tags in levels apply also for sublevels.
3320 When nil, only the tags directly given in a specific line apply there.
3321 This may also be a list of tags that should be inherited, or a regexp that
3322 matches tags that should be inherited. Additional control is possible
3323 with the variable `org-tags-exclude-from-inheritance' which gives an
3324 explicit list of tags to be excluded from inheritance, even if the value of
3325 `org-use-tag-inheritance' would select it for inheritance.
3327 If this option is t, a match early-on in a tree can lead to a large
3328 number of matches in the subtree when constructing the agenda or creating
3329 a sparse tree. If you only want to see the first match in a tree during
3330 a search, check out the variable `org-tags-match-list-sublevels'."
3339 "List of tags that should never be inherited.
3340 This is a way to exclude a few tags from inheritance. For way to do
3341 the opposite, to actively allow inheritance for selected tags,
3342 see the variable `org-use-tag-inheritance'."
3347 "Check if TAG is one that should be inherited."
3359 "Non-nil means list also sublevels of headlines matching a search.
3360 This variable applies to tags/property searches, and also to stuck
3361 projects because this search is based on a tags match as well.
3363 When set to the symbol `indented', sublevels are indented with
3364 leading dots.
3366 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3367 the sublevels of a headline matching a tag search often also match
3368 the same search. Listing all of them can create very long lists.
3369 Setting this variable to nil causes subtrees of a match to be skipped.
3371 This variable is semi-obsolete and probably should always be true. It
3372 is better to limit inheritance to certain tags using the variables
3373 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3381 "When set, tags are sorted using this function as a comparator."
3397 "Options concerning properties in Org-mode."
3402 "How property key/value pairs should be formatted by `indent-line'.
3403 When `indent-line' hits a property definition, it will format the line
3404 according to this format, mainly to make sure that the values are
3405 lined-up with respect to each other."
3410 "Alist of properties and functions to adjust inserted values.
3411 Elements of this alist must be of the form
3413 ([string] [function])
3415 where [string] must be a property name and [function] must be a
3416 lambda expression: this lambda expression must take one argument,
3417 the value to adjust, and return the new value as a string.
3421 and the clock summary:
3424 (let ((clocksum (org-clock-sum-current-item))
3425 (effort (org-duration-string-to-minutes
3427 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3434 "Non-nil means properties apply also for sublevels.
3436 This setting is chiefly used during property searches. Turning it on can
3437 cause significant overhead when doing a search, which is why it is not
3438 on by default.
3440 When nil, only the properties directly given in the current entry count.
3441 When t, every property is inherited. The value may also be a list of
3442 properties that should have inheritance, or a regular expression matching
3443 properties that should be inherited.
3445 However, note that some special properties use inheritance under special
3446 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3448 for valid values of a property.
3450 Note for programmers:
3451 When querying an entry with `org-entry-get', you can control if inheritance
3452 should be used. By default, `org-entry-get' looks only at the local
3453 properties. You can request inheritance by setting the inherit argument
3454 to t (to force inheritance) or to `selective' (to respect the setting
3455 in this variable)."
3464 "Check if PROPERTY is one that should be inherited."
3475 "The default column format, if no other format has been defined.
3476 This variable can be set on the per-file basis by inserting a line
3478 #+COLUMNS: %25ITEM ....."
3483 "The ellipses to be used when a field in column view is truncated.
3484 When this is the empty string, as many characters as possible are shown,
3485 but then there will be no visual indication that the field has been truncated.
3486 When this is a string of length N, the last N characters of a truncated
3487 field are replaced by this string. If the column is narrower than the
3488 ellipses string, only part of the ellipses string will be shown."
3493 "Function that modifies values for display in column view.
3494 For example, it can be used to cut out a certain part from a time stamp.
3495 The function must take 2 arguments:
3497 column-title The title of the column (*not* the property name)
3498 value The value that should be modified.
3500 The function should return the value that should be displayed,
3501 or nil if the normal value should be used."
3506 "The property that is being used to keep track of effort estimates.
3507 Effort estimates given in this property need to have the format H:MM."
3515 "List of property/value pairs that can be inherited by any entry.
3517 These are fixed values, for the preset properties. The user variable
3518 that can be used to add to this list is `org-global-properties'.
3520 The entries in this list are cons cells where the car is a property
3521 name and cdr is a string with the value. If the value represents
3526 "List of property/value pairs that can be inherited by any entry.
3528 This list will be combined with the constant `org-global-properties-fixed'.
3530 The entries in this list are cons cells where the car is a property
3531 name and cdr is a string with the value.
3533 You can set buffer-local values for the same purpose in the variable
3534 `org-file-properties' this by adding lines like
3536 #+PROPERTY: NAME VALUE"
3543 "List of property/value pairs that can be inherited by any entry.
3544 Valid for the current buffer.
3549 "Options concerning agenda views in Org-mode."
3554 "Variable used by org files to set a category for agenda display.
3555 Such files should use a file variable to set it, for example
3559 or contain a special line
3561 #+CATEGORY: ELisp
3563 If the file does not specify a category, then file's base name
3569 "The files to be used for agenda display.
3573 If an entry is a directory, all files in that directory that are matched by
3574 `org-agenda-file-regexp' will be part of the file list.
3576 If the value of the variable is not a list but a single file name, then
3577 the list of agenda files is actually stored and maintained in that file, one
3578 agenda file per line. In this file paths can be given relative to
3579 `org-directory'. Tilde expansion and environment variable substitution
3580 are also made."
3587 "Regular expression to match files for `org-agenda-files'.
3588 If any element in the list in that variable contains a directory instead
3589 of a normal file, all files in that directory that are matched by this
3590 regular expression will be included."
3595 "List of extra files to be searched by text search commands.
3596 These files will be searched in addition to the agenda files by the
3597 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3598 Note that these files will only be searched for text search commands,
3599 not for the other agenda views like todo lists, tag searches or the weekly
3600 agenda. This variable is intended to list notes and possibly archive files
3601 that should also be searched by these two commands.
3602 In fact, if the first element in the list is the symbol `agenda-archives',
3603 then all archive files of all agenda files will be added to the search
3604 scope."
3614 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3615 A nil value means to remove them, after a query, from the list."
3620 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3621 The command `org-calendar-goto-agenda' will be bound to this key. The
3622 default is the character `c' because then `c' can be used to switch back and
3623 forth between agenda and calendar."
3628 "The key to be installed in `calendar-mode-map' for adding diary entries.
3629 This option is irrelevant until `org-agenda-diary-file' has been configured
3630 to point to an Org-mode file. When that is the case, the command
3631 `org-agenda-diary-entry' will be bound to the key given here, by default
3632 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3633 if you want to continue doing this, you need to change this to a different
3634 key."
3639 "File to which to add new entries with the `i' key in agenda and calendar.
3640 When this is the symbol `diary-file', the functionality in the Emacs
3641 calendar will be used to add entries to the `diary-file'. But when this
3642 points to a file, `org-agenda-diary-entry' will be used instead."
3656 org-calendar-insert-diary-entry-key
3660 "Options for embedding LaTeX code into Org-mode."
3668 "Options for creating images from LaTeX fragments.
3669 This is a property list with the following properties:
3671 `default' means use the foreground of the default face.
3672 `auto' means use the foreground from the text face.
3674 `default' means use the background of the default face.
3675 `auto' means use the background from the text face.
3676 :scale a scaling factor for the size of the images, to get more pixels
3677 :html-foreground, :html-background, :html-scale
3678 the same numbers for HTML export.
3679 :matchers a list indicating which matchers should be used to
3680 find LaTeX fragments. Valid members of this list are:
3691 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3692 When nil, just push out a message."
3699 Use this to specify additional executable file say a jar file.
3701 When using MathToWeb as the converter, specify the full-path to
3702 your mathtoweb.jar file."
3710 "Command to convert LaTeX fragments to MathML.
3711 Replace format-specifiers in the command as noted below and use
3712 `shell-command' to convert LaTeX to MathML.
3713 %j: Executable file in fully expanded form as specified by
3714 `org-latex-to-mathml-jar-file'.
3715 %I: Input LaTeX file in fully expanded form
3716 %o: Output MathML file
3717 This command is used by `org-create-math-formula'.
3719 When using MathToWeb as the converter, set this to
3728 "Program to convert LaTeX fragments with.
3730 dvipng Process the LaTeX fragments to dvi file, then convert
3731 dvi files to png files using dvipng.
3732 This will also include processing of non-math environments.
3733 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3734 to convert pdf files to png files"
3742 "Path to store latex preview images.
3743 A relative path here creates many directories relative to the
3744 processed org files paths. An absolute path puts all preview
3745 images at the same place."
3751 "Return t if `org-latex-to-mathml-convert-command' is usable."
3754 org-latex-to-mathml-convert-command)
3756 org-latex-to-mathml-convert-command))))
3761 t))))))
3767 \[PACKAGES]
3768 \[DEFAULT-PACKAGES]
3770 % The settings below are copied from fullpage.sty
3783 "The document header used for processing LaTeX fragments.
3784 It is imperative that this header make sure that no page number
3785 appears on the page. The package defined in the variables
3786 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3788 header, or they will be appended."
3793 "Set the packages alist and make sure it has 3 elements per entry."
3797 x))
3798 val)))
3801 "Get the packages alist and make sure it has 3 elements per entry."
3805 x))
3825 "Alist of default packages to be inserted in the header.
3827 Change this only if one of the packages here causes an
3828 incompatibility with another package you are using.
3830 The packages in this list are needed by one part or another of
3831 Org mode to function properly:
3833 - inputenc, fontenc: for basic font and character selection
3834 - amstext: for subscript and superscript
3835 - textcomp, marvosymb, wasysym, latexsym, amssym: for various
3836 symbols used for interpreting the entities in `org-entities'.
3837 You can skip some of these packages if you don't use any of the
3838 symbols in it.
3839 - ulem: for underline and strike-through
3840 - graphicx: for including images
3841 - float, wrapfig: for figure placement
3842 - longtable: for long tables
3843 - hyperref: for cross references
3845 Therefore you should not modify this variable unless you know
3846 what you are doing. The one reason to change it anyway is that
3847 you might be loading some other package that conflicts with one
3848 of the default packages. Each cell is of the format
3850 the package also needs to be included when compiling LaTeX
3851 snippets into images for inclusion into non-LaTeX output."
3866 "Alist of packages to be inserted in every LaTeX header.
3868 These will be inserted after `org-latex-default-packages-alist'.
3869 Each cell is of the format:
3873 SNIPPET-FLAG, when t, indicates that this package is also needed
3874 when turning LaTeX snippets into images for inclusion into
3875 non-LaTeX output.
3877 Make sure that you only list packages here which:
3879 - you want in every file
3880 - do not conflict with the setup in `org-format-latex-header'.
3881 - do not conflict with the default packages in
3882 `org-latex-default-packages-alist'."
3896 "Settings for Org-mode appearance."
3901 "Non-nil means fontify only the stars in each headline.
3902 When nil, the entire headline is fontified.
3903 Changing it requires restart of `font-lock-mode' to become effective
3904 also in regions already fontified."
3909 "Non-nil means hide the first N-1 stars in a headline.
3910 This works by using the face `org-hide' for these stars. This
3911 face is white for a light background, and black for a dark
3912 background. You may have to customize the face `org-hide' to
3913 make this work.
3914 Changing it requires restart of `font-lock-mode' to become effective
3915 also in regions already fontified.
3916 You may also set this on a per-file basis by adding one of the following
3917 lines to the buffer:
3919 #+STARTUP: hidestars
3920 #+STARTUP: showstars"
3925 "List of symbols corresponding to keywords to be hidden the org buffer.
3926 For example, a value '(title) for this list will make the document's title
3927 appear in the buffer without the initial #+TITLE: keyword."
3936 "List of properties (as strings) with a special meaning.
3937 The default use of these custom properties is to let the user
3938 hide them with `org-toggle-custom-properties-visibility'."
3945 "Non-nil means change the face of a headline if it is marked DONE.
3946 Normally, only the TODO/DONE keyword indicates the state of a headline.
3947 When this is non-nil, the headline after the keyword is set to the
3948 `org-headline-done' as an additional indication."
3953 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3954 Changing this variable requires a restart of Emacs to take effect."
3959 "Non-nil means fontify the whole line for headings.
3960 This is useful when setting a background color for the
3961 org-level-* faces."
3966 "Non-nil means highlight LaTeX related syntax in the buffer.
3967 When non nil, the value should be a list containing any of the
3968 following symbols:
3969 `latex' Highlight LaTeX snippets and environments.
3970 `script' Highlight subscript and superscript.
3971 `entities' Highlight entities."
3983 "Non-nil mean font-lock should hide the emphasis marker characters."
3988 "Non-nil means show entities as UTF8 characters.
3995 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4001 "Regular expression for matching emphasis.
4002 After a match, the match groups contain these elements:
4003 0 The match of the full regular expression, including the characters
4004 before and after the proper match
4005 1 The character before the proper match, or empty at beginning of line
4006 2 The proper match, including the leading and trailing markers
4007 3 The leading marker like * or /, indicating the type of highlighting
4008 4 The text between the emphasis markers, not including the markers
4015 "Set variable and compute the emphasis regular expression."
4019 org-emphasis-alist org-emphasis-regexp-components)
4031 ;; make sure special characters appear at the right position in the class
4043 ;; Make the regexp
4051 body1
4063 body1
4069 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4070 ;; set this option proved cumbersome. See this message/thread:
4071 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4074 "Components used to build the regular expression for emphasis.
4075 This is a list with five entries. Terminology: In an emphasis string
4079 specify what is allowed/forbidden in each part:
4081 pre Chars allowed as prematch. Beginning of line will be allowed too.
4082 post Chars allowed as postmatch. End of line will be allowed too.
4083 border The chars *forbidden* as border characters.
4085 non-shy groups here, and don't allow newline here.
4086 newline The maximum number of newlines allowed in an emphasis exp.
4097 "Alist of characters and faces to emphasize text.
4098 Text starting and ending with a special character will be emphasized,
4099 for example *bold*, _underlined_ and /italic/. This variable sets the
4100 marker characters and the face to be used by font-lock for highlighting
4101 in Org-mode Emacs buffers.
4103 You need to reload Org or to restart Emacs after customizing this."
4118 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4121 ;;; Miscellaneous options
4124 "Completion in Org-mode."
4129 "Non-nil means use ido completion wherever possible.
4130 Note that `ido-mode' must be active for this variable to be relevant.
4131 If you decide to turn this variable on, you might well want to turn off
4132 `org-outline-path-complete-in-steps'.
4133 See also `org-completion-use-iswitchb'."
4138 "Non-nil means use iswitchb completion wherever possible.
4139 Note that `iswitchb-mode' must be active for this variable to be relevant.
4140 If you decide to turn this variable on, you might well want to turn off
4141 `org-outline-path-complete-in-steps'.
4142 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4148 Normal means, no org-mode-specific context."
4152 ;;; Functions and variables from their packages
4153 ;; Declared here to avoid compiler warnings
4155 ;; XEmacs only
4161 ;; Emacs only
4164 ;; Various packages
4183 org-agenda-format-item "org-agenda"
4210 ;;; Autoload and prepare some org modules
4212 ;; Some table stuff that needs to be defined here, because it is used
4213 ;; by the functions setting up org-mode or checking for table context.
4226 "Detect the first line outside a table when searching from within it.
4229 ;; Autoload the functions in org-table.el that are needed by functions here.
4238 ;;;###autoload
4240 "Unconditionally turn on `orgtbl-mode'."
4245 "Return t if the cursor is inside an org-type table.
4246 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4251 org-table-line-regexp)))
4252 nil))
4256 "Return t if and only if we are at a table.el table."
4263 "If there is a table.el table nearby, recognize it and move into it."
4269 nil
4279 t
4284 t)
4285 nil)
4286 nil))
4289 "Return t if the cursor is inside a hline in a table."
4294 nil))
4297 "Apply FUNCTION to the start of all tables in the buffer."
4307 ;; Exclude tables in src/example/verbatim/clocktable blocks
4315 ;; Declare and autoload functions from org-agenda.el
4327 "Return t when point (or POS) is in #+TBLFM line."
4342 "Return the buffer where the clock is currently running.
4343 Return nil if no clock is running."
4348 org-clock-update-time-maybe
4349 org-clocktable-shift)))
4352 "Check if the current buffer contains the running clock.
4353 If yes, offer to stop it and to save the buffer with the changes."
4362 "Check if this line starts a clock table, if yes, shift the time block."
4366 ;;;###autoload
4368 "Set up hooks for clock persistence."
4373 ;; Define the variable already here, to make sure we have it.
4375 "Non-nil if Org-Indent mode is enabled.
4378 ;; Autoload archiving code
4379 ;; The stuff that is needed for cycling and tags has to be defined here.
4382 "Options concerning archiving in Org-mode."
4387 "The location where subtrees should be archived.
4389 The value of this variable is a string, consisting of two parts,
4390 separated by a double-colon. The first part is a filename and
4391 the second part is a headline.
4393 When the filename is omitted, archiving happens in the same file.
4394 %s in the filename will be replaced by the current file
4395 name (without the directory part). Archiving to a different file
4396 is useful to keep archived entries from contributing to the
4397 Org-mode Agenda.
4399 The archived entries will be filed as subtrees of the specified
4400 headline. When the headline is omitted, the subtrees are simply
4401 filed away at the end of the file, as top-level entries. Also in
4402 the heading you can use %s to represent the file name, this can be
4403 useful when using the same archive for a number of different files.
4405 Here are a few examples:
4407 If the current file is Projects.org, archive in file
4408 Projects.org_archive, as top-level trees. This is the default.
4411 Archive in the current file, under the top-level headline
4415 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4418 Archive in file ~/org/archive.org (absolute path), under headlines
4423 items to the datetree. Items are placed in either the CLOSED
4424 date of the item, or the current date if there is no CLOSED date.
4425 The heading will be a subentry to the current date. There doesn't
4426 need to be a heading, but there always needs to be a slash after
4427 datetree. For example, to store archived items directly in the
4431 Archive in file ./basement (relative path), as level 3 trees
4434 You may set this option on a per-file basis by adding to the buffer a
4435 line like
4437 #+ARCHIVE: basement::** Finished Tasks
4439 You may also define it locally for a subtree by setting an ARCHIVE property
4440 in the entry. If such a property is found in an entry, or anywhere up
4441 the hierarchy, it will be used."
4446 "The tag that marks a subtree as archived.
4447 An archived subtree does not open during visibility cycling, and does
4448 not contribute to the agenda listings.
4449 After changing this, font-lock must be restarted in the relevant buffers to
4450 get the proper fontification."
4456 "Non-nil means the agenda will skip any items located in archived trees.
4457 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4458 variable is no longer recommended, you should leave it at the value t.
4459 Instead, use the key `v' to cycle the archives-mode in the agenda."
4465 "Non-nil means ignore archived trees when creating column view."
4471 "Non-nil means `org-cycle' will open archived trees.
4472 An archived tree is a tree marked with the tag ARCHIVE.
4473 When nil, archived trees will stay folded. You can still open them with
4474 normal outline commands like `show-all', but not with the cycling commands."
4480 "Non-nil means sparse tree construction shows matches in archived trees.
4481 When nil, matches in these trees are highlighted, but the trees are kept in
4482 collapsed state."
4488 "The default date type when building a sparse tree.
4489 When this is nil, a date is a scheduled or a deadline timestamp.
4490 Otherwise, these types are allowed:
4492 all: all timestamps
4493 active: only active timestamps (<...>)
4494 inactive: only inactive timestamps (<...)
4495 scheduled: only scheduled timestamps
4496 deadline: only deadline timestamps"
4508 "Re-hide all archived subtrees after a visibility state change."
4519 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4522 "Cycle subtree even if it is archived."
4529 "Re-hide all archived subtrees after a visibility state change."
4546 flag)))
4554 ;; Autoload Column View Code
4562 org-columns-get-format-and-top-level
4563 org-columns-compute
4564 org-columns-remove-overlays))
4566 ;; Autoload ID code
4574 org-id-copy
4575 org-id-get-with-outline-path-completion
4576 org-id-get-with-outline-drilling))
4578 ;;; Variables for pre-computed regular expressions, all buffer local
4596 "Matches a headline and puts everything into groups:
4597 group 1: the stars
4598 group 2: The todo keyword, maybe
4599 group 3: Priority cookie
4600 group 4: True headline
4604 "Printf format to make regexp to match an exact headline.
4605 This regexp will match the headline of any node which has the
4606 exact headline text that is put into the format, but may have any
4610 "Matches a headline and puts TODO state into group 2 if present.
4662 "Regular expression to match a plain time or time range.
4663 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4664 groups carry important information:
4665 0 the full match
4666 1 the first time, range or not
4674 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4675 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4676 groups carry important information:
4677 0 the full match
4678 7 hours of duration
4687 "Regular expression to match a timestamp time or time range.
4688 After a match, the following groups carry important information:
4689 0 the full match
4690 1 date plus weekday, for back referencing to make sure both times are on the same day
4691 2 the first time, range or not
4752 "Variable associated with STARTUP options for org-mode.
4753 Each element is a list of three items: the startup options (as written
4754 in the #+STARTUP line), the corresponding variable, and the value to set
4755 this variable to if the option is found. An optional forth element PUSH
4759 "Update PROPS with KEY and VAL."
4773 "Printf format for a regexp matching a headline with some keyword.
4774 This regexp will match the headline of any node which has the
4775 exact keyword that is put into the format. The keyword isn't in
4779 "Printf format for a regexp matching a headline, possibly with some keyword.
4780 This regexp can match any headline with the specified keyword, or
4781 without a keyword. The keyword isn't in any group by default,
4785 "When non-nil (the default), use group tags.
4786 This can be turned on/off through `org-toggle-tags-groups'."
4792 "Toggle support for group tags.
4793 Support for group tags is controlled by the option
4794 `org-group-tags', which is non-nil by default."
4798 org-group-tags)
4806 "Precompute variables used for tags."
4812 tags ftags key value)
4829 ftags
4833 ;; Process the file tags.
4837 ;; Process the tags.
4848 org-tag-alist)))
4857 org-tag-groups-alist)
4880 ;; Return a list with tag variables
4885 "Precompute regular expressions used in the current buffer."
4903 kwds kws0 kwsa key log value cat arch const links hw dws
4904 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4912 ext-setup-or-nil
4920 ;; Append setupfile tags to existing tags
4924 org-tag-alist
4926 org-tag-groups-alist
4944 ;; general TODO-like setup
4953 links)))
4960 props))))
4967 l var val)
4985 ;; Prevent checking in Gnus messages
4997 ;; search for property blocks
5006 props)))))))
5021 ;; Process the TODO keywords
5023 ;; Use the global values as if they had been given locally.
5035 kws)))
5038 kwsa nil
5041 ;; 1 2
5049 kw)
5051 kws0)
5068 ;; Compute the regular expressions and other local variables.
5069 ;; Using `org-outline-regexp-bol' would complicate them much,
5070 ;; because of the fixed white space at the end of that string.
5078 org-drawer-regexp
5082 org-not-done-keywords
5084 org-todo-regexp
5088 org-not-done-regexp
5092 org-not-done-heading-regexp
5094 org-todo-line-regexp
5096 org-complex-heading-regexp
5103 org-complex-heading-regexp-format
5108 ;; Stats cookies can be stuck to body.
5115 org-todo-line-tags-regexp
5122 org-deadline-time-regexp
5124 org-deadline-time-hour-regexp
5127 org-deadline-line-regexp
5129 org-scheduled-regexp
5131 org-scheduled-time-regexp
5133 org-scheduled-time-hour-regexp
5136 org-closed-time-regexp
5138 org-keyword-time-regexp
5144 org-keyword-time-not-clock-regexp
5150 org-maybe-keyword-time-regexp
5156 org-all-time-keywords
5159 org-clock-string org-closed-string)))
5164 "Return the contents of FILE, as a string."
5175 "Extract the log state setting from a TODO keyword string.
5189 "Remove a pair of parenthesis at the end of each string in LIST."
5193 x))
5194 list))
5197 "Assign fast keys to a keyword-key alist.
5198 Respect keys that are already there."
5216 ;;; Some variables used in various places
5223 "Function to be called when `C-c C-c' is used.
5227 ;; FIXME: Occasionally check by commenting these, to make sure
5228 ;; no other functions uses these, forgetting to let-bind them.
5233 ;; Defined somewhere in this file, but used before definition.
5239 ;;;; Define the Org-mode
5241 ;; We use a before-change function to check if a table might need
5242 ;; an update.
5244 "Indicates that a table might need an update.
5245 This variable is set by `org-before-change-function'.
5248 "Every change indicates that a table might need an update."
5263 (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"))
5266 ;; Other stuff we need.
5272 ;; (require 'org-macs) moved higher up in the file before it is first used
5274 ;; (require 'org-compat) moved higher up in the file before it is first used
5282 ;; babel
5285 ;;;###autoload
5287 "Outline-based notes management and organizer, alias
5290 Org-mode develops organizational tasks around a NOTES file which
5291 contains information about projects as plain text. Org-mode is
5292 implemented on top of outline-mode, which is ideal to keep the content
5293 of large files well structured. It supports ToDo items, deadlines and
5294 time stamps, which magically appear in the diary listing of the Emacs
5295 calendar. Tables are easily created with a built-in table editor.
5296 Plain text URL-like links connect to websites, emails (VM), Usenet
5297 messages (Gnus), BBDB entries, and any files related to the project.
5298 For printing and sharing of notes, an Org-mode file (or a part of it)
5299 can be exported as a structured ASCII or HTML file.
5301 The following commands are available:
5305 ;; Get rid of Outline menus, they are not needed
5306 ;; Need to do this here because define-derived-mode sets up
5307 ;; the keymap so late. Still, it is a waste to call this each time
5308 ;; we switch another buffer into org-mode.
5311 ;; Assume this is Greg's port, it uses easymenu
5337 org-display-table 4
5340 org-ellipsis)))
5347 ;; tag faces set outside customize.... force initialization.
5349 ;; Calc embedded
5351 ;; Modify a few syntax entries
5358 ;; Activate before-change-function
5362 ;; Check for running clock before killing a buffer
5364 ;; Initialize macros templates.
5366 ;; Initialize radio targets.
5368 ;; Indentation.
5371 ;; Filling and auto-filling.
5373 ;; Comments.
5375 ;; Beginning/end of defun
5378 ;; Next error for sparse trees
5380 ;; Make sure dependence stuff works reliably, even for users who set it
5381 ;; too late :-(
5393 ;; Align options lines
5395 'align-mode-rules-list
5400 ;; Imenu
5404 ;; Make isearch reveal context
5407 ;; Emacs 21 and XEmacs make use of the hook
5409 ;; Emacs 22 deals with this through a special variable
5414 ;; Setup the pcomplete hooks
5427 ;; If empty file that did not turn on org-mode automatically, make it to.
5443 ;; Try to set org-hide correctly
5446 ;; Update `customize-package-emacs-version-alist'
5456 org-emphasis-alist)
5457 st))
5470 "unspecified-bg"
5483 "Current time, possibly rounded to ROUNDING-MINUTES.
5484 When ROUNDING-MINUTES is not an integer, fall back on the car of
5485 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5486 the rounding returns a past time."
5498 res))))
5501 "Return today date, considering `org-extend-today-until'."
5506 ;;;; Font-Lock stuff, including the activators
5537 "Regular expression used to analyze links.
5538 Here is what the match groups contain after a match:
5539 1: http:
5540 2: http
5541 3: path
5542 4: [desc]
5553 "Create a regular expression which will match a balanced sexp.
5554 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5555 as single character strings.
5556 The regexp returned will match the entire expression including the
5557 delimiters. It will also define a single group which contains the
5558 match except for the outermost delimiters. The maximum depth of
5559 stacked delimiters is N. Escaping delimiters is not possible."
5588 "Update the link regular expressions.
5589 This should be called after the variable `org-link-types' has changed."
5593 org-link-re-with-space
5599 org-link-re-with-space2
5605 org-link-re-with-space3
5610 org-angle-link-re
5616 org-plain-link-re
5620 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5621 org-bracket-link-regexp
5623 org-bracket-link-analytic-regexp
5631 org-bracket-link-analytic-regexp++
5639 org-any-link-re
5648 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5651 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5652 "Regular expression matching time strings for analysis.
5653 This one does not require the space after the date, so it can be used
5655 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5672 "Regular expression matching a time stamp or time stamp range.
5678 "Run through the buffer and add overlays to emphasized strings."
5687 'face
5700 rtn))
5703 "Insert or change an emphasis, i.e. a font like bold or italic.
5704 If there is an active region, change that region to a new emphasis.
5705 If there is no region, just insert the marker characters and position
5706 the cursor between them.
5707 CHAR should be the marker character. If it is a space, it means to
5708 remove the emphasis of the selected region.
5709 If CHAR is not given (for example in an interactive call) it will be
5710 prompted for."
5753 "Run through the buffer and add overlays to links."
5762 nil
5769 t)))
5777 t)))
5780 "When non-nil, fontify code in code blocks."
5787 "When non-nil, allow promoting a top level subtree.
5788 The leading star of the top level headline will be replaced
5789 by a #."
5800 "Fontify #+ lines and blocks."
5803 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5804 limit t)
5812 end end1 quoting block-type ovl)
5815 ;; a single line of backend-specific content
5823 ; for backend-specific code
5824 t)
5826 ;; Truly a block
5839 beg end
5847 ;; remove old background overlays
5852 ;; add a background overlay
5867 t))
5887 t)
5893 ;; just any other in-buffer setting, but not indented
5897 t)
5901 "Run through the buffer and add overlays to links."
5910 t)))
5913 "Run through the buffer and add overlays to footnotes."
5920 'keymap org-mouse-map
5921 'help-echo
5923 "Footnote definition"
5925 'font-lock-fontified t
5926 'font-lock-multiline t
5930 "Run through the buffer and add overlays to bracketed links."
5943 ;; We need to remove the invisible property here. Table narrowing
5944 ;; may have made some of this invisible.
5962 t)))
5965 "Run through the buffer and add overlays to dates."
5978 t)))
5987 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5991 "Run through the buffer and add overlays to target matches."
5999 'keymap org-mouse-map
6003 t)))))
6006 "Find all radio targets in this file and update the regular expression."
6021 t)))
6029 "Compute regular expression for LaTeX, entities and sub/superscript.
6030 Result depends on variable `org-highlight-latex-and-related'."
6032 'org-latex-and-related-regexp
6044 org-latex-regexps)))))
6051 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6052 LIMIT bounds the search for syntax to highlight. Stop at first
6053 highlighted object, if any. Return t if some highlighting was
6054 done, nil otherwise."
6063 1
6071 nil)))
6074 "Restart `font-lock-mode', to force refontification."
6080 "Return a list of all targets in this file.
6081 When optional argument RADIO is non-nil, only find radio
6082 targets."
6087 ;; Make sure point is really within the object.
6092 rtn)))
6095 "Make regular expression matching all strings in TARGETS.
6096 The regular expression finds the targets also if there is a line break
6097 between words."
6106 x)
6107 targets
6119 t)))
6122 "Compute the outline level of the heading at point.
6123 If this is called at a normal headline, the level is the number of stars.
6124 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6129 0
6136 "Return a regexp matching a PROPERTY line.
6137 Match group 3 will be set to the value if it exists."
6144 "Regular expression matching a property line.
6145 There are four matching groups:
6146 1: :PROPKEY: including the leading and trailing colon,
6147 2: PROPKEY without the leading and trailing colon,
6148 3: PROPVAL without leading or trailing spaces,
6149 4: the indentation of the current line,
6156 "Functions that can manipulate `org-font-lock-extra-keywords'.
6157 This is called after `org-font-lock-extra-keywords' is defined, but before
6158 it is installed to be used by font lock. This can be useful if something
6162 "Run `org-font-lock-hook' within LIMIT."
6166 "Set font lock defaults for the current buffer."
6171 ;; Call the hook
6173 ;; Headlines
6180 ;; Table lines
6183 ;; Table internals
6188 ;; Drawers
6191 ;; Properties
6195 ;; Links
6203 ;; Targets.
6205 ;; Diary sexps.
6207 ;; Macro
6210 ;; TODO keyword
6212 org-todo-regexp)
6214 ;; DONE
6222 nil)
6223 ;; Priorities
6225 ;; Tags
6227 ;; Tags groups
6233 ;; Special keywords
6238 ;; Emphasis
6243 ;; Checkboxes
6244 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6249 ;; Description list items
6252 ;; ARCHIVEd headings
6254 org-outline-regexp-bol
6257 ;; Specials
6261 ;; Code
6263 ;; COMMENT
6269 ;; Blocks and meta lines
6273 ;; Now set the full font-lock-keywords
6280 "Toggle the composition display of entities as UTF8 characters."
6296 "Display or hide properties in `org-custom-properties'."
6313 org-custom-properties)))))))
6316 "Find an entity to fontify."
6322 limit t)
6337 nil))))
6340 "Fontify string S like in Org-mode."
6352 "Get the right face for match N in font-lock matching of headlines."
6365 "Get the right face for a TODO keyword KWD.
6366 If KWD is a number, get the corresponding match group."
6374 "Create a face list that inherits INHERIT, but sets the foreground color.
6375 When FACE-OR-COLOR is not a string, just return it."
6379 face-or-color)
6380 face-or-color))
6383 "Add the special tag faces."
6392 "Add the special priority faces."
6400 org-priority-faces)))
6405 "Get the right face for a TODO keyword KWD.
6406 If KWD is a number, get the corresponding match group."
6413 "Remove fontification and activation overlays from links."
6418 deactivate-mark buffer-file-name buffer-file-truename)
6422 invisible t intangible t
6423 org-no-flyspell t org-emphasis t))
6433 "Remove specific display properties that have been added by font lock.
6434 The will remove the raise properties that are used to show superscripts
6435 and subscripts."
6445 "Add raise properties to sub/superscripts."
6449 org-match-substring-regexp
6450 org-match-substring-with-braces-regexp)
6451 limit t)
6461 ;; Handle a_b^c
6464 t
6466 'display
6482 t)))))
6484 ;;;; Visibility cycling, including org-goto and indirect buffer
6486 ;;; Cycling
6497 ;;;###autoload
6499 "TAB-action and visibility cycling for Org-mode.
6501 This is the command invoked in Org-mode by the TAB key. Its main purpose
6502 is outline visibility cycling, but it also invokes other actions
6503 in special contexts.
6505 - When this function is called with a prefix argument, rotate the entire
6506 buffer through 3 states (global cycling)
6507 1. OVERVIEW: Show only top-level headlines.
6508 2. CONTENTS: Show all headlines of all levels, but no body text.
6509 3. SHOW ALL: Show everything.
6510 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6511 determined by the variable `org-startup-folded', and by any VISIBILITY
6512 properties in the buffer.
6513 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6514 including any drawers.
6516 - When inside a table, re-align the table and move to the next field.
6518 - When point is at the beginning of a headline, rotate the subtree started
6519 by this line through 3 different states (local cycling)
6520 1. FOLDED: Only the main headline is shown.
6521 2. CHILDREN: The main headline and the direct children are shown.
6522 From this state, you can move to one of the children
6523 and zoom in further.
6524 3. SUBTREE: Show the entire subtree, including body text.
6525 If there is no subtree, switch directly from CHILDREN to FOLDED.
6527 - When point is at the beginning of an empty headline and the variable
6528 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6529 of the headline by demoting and promoting it to likely levels. This
6530 speeds up creation document structure by pressing TAB once or several
6531 times right after creating a new headline.
6533 - When there is a numeric prefix, go up to a heading with level ARG, do
6534 a `show-subtree' and return to the previous cursor position. If ARG
6535 is negative, go up that many levels.
6537 - When point is not at the beginning of a headline, execute the global
6538 binding for TAB, which is re-indenting the line. See the option
6539 `org-cycle-emulate-tab' for details.
6541 - Special case: if point is at the beginning of the buffer and there is
6542 no headline in line 1, this function will act as if called with prefix arg
6543 (C-u TAB, same as S-TAB) also when called without prefix arg.
6544 But only if also the variable `org-cycle-global-at-bob' is t."
6555 org-inlinetask-min-level
6560 limit-level)))
6563 outline-regexp
6571 org-cycle-hook))
6575 ;; special case: use global cycling
6589 ;; Table: enter it or move to the next field.
6600 ;; Global cycling: delegate to `org-cycle-internal-global'.
6603 ;; Drawers: delegate to `org-flag-drawer'.
6611 ;; Show-subtree, ARG levels up from here.
6619 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6627 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6634 ;; From there: TAB emulation and template completion.
6656 t
6665 "Do the global cycling action."
6666 ;; Hack to avoid display of messages for .org attachments in Gnus
6672 ;; We just created the overview - now do table of contents
6673 ;; This can be slow in very large buffers, so indicate action
6683 ;; We just showed the table of contents - now show everything
6691 ;; Default action: go to overview
6699 "Do the local cycling action."
6702 ;; First, determine end of headline (EOH), end of subtree or item
6703 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6723 ;; Determine end invisible part of buffer (EOL)
6725 ;; XEmacs doesn't have `next-single-char-property-change'
6735 ;; Find out what to do next and set `this-command'
6738 ;; Nothing is hidden behind this heading
6751 org-cycle-skip-children-state-if-no-children))))
6752 ;; Entire subtree is hidden in one line: children view
6759 ;; FIXME: This slows down the func way too much.
6760 ;; How keep drawers hidden in subtree anyway?
6761 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6762 ;; (org-cycle-hide-drawers 'subtree))
6764 ;; Fold every list in subtree to top-level items.
6787 ;; We just showed the children, or no children are there,
6788 ;; now show everything.
6797 ;; Default action: hide the subtree.
6805 ;;;###autoload
6807 "Cycle the global visibility. For details see `org-cycle'.
6809 With a numeric prefix, show all headlines up to that level."
6825 "Set the visibility required by startup options and properties."
6840 "Switch subtree visibilities according to :VISIBILITY: property."
6847 nil t)
6871 ;; This function uses outline-regexp instead of the more fundamental
6872 ;; org-outline-regexp so that org-cycle-global works outside of Org
6873 ;; buffers, where outline-regexp is needed.
6875 "Switch to overview mode, showing only top-level headlines.
6876 Really, this shows all headlines with level equal or greater than the level
6877 of the first headline in the buffer. This is important, because if the
6878 first headline is not level one, then (hide-sublevels 1) gives confusing
6879 results."
6893 "Show all headlines in the buffer, like a table of contents.
6894 With numerical argument N, show content up to level N."
6897 ;; Visit all headings and show their offspring
6904 t)
6913 "Adjust the window after a change in outline visibility.
6914 This function is the default value of the hook `org-cycle-hook'."
6924 "Remove outline overlays that do not contain non-white stuff."
6934 "Fix visibility issues after moving a subtree."
6935 ;; First, find a reasonable region to look at:
6936 ;; Start two siblings above, end three below
6954 ;; Properly fold already folded siblings
6965 "Show empty lines above all visible headlines.
6966 The region to be covered depends on STATE when called through
6967 `org-cycle-hook'. Lisp program can use t for STATE to get the
6968 entire buffer covered. Note that an empty line is only shown if there
6969 are at least `org-cycle-separator-lines' empty lines before the headline."
6979 beg end b e)
7003 ;; Never hide empty lines at the end of the file.
7013 "Move to the parent and re-show empty lines before visible headlines."
7019 "Return `org-agenda-files' list, plus all open org-mode files.
7020 This is useful for operations that need to scan all of a user's
7021 open and agenda-wise Org files."
7029 files))
7032 "Return the beginning position of the current entry."
7036 "Return the end position of the current entry."
7040 "Re-hide all drawers after a visibility state change."
7055 "Re-hide inline task when switching to 'contents visibility state."
7058 org-inlinetask-min-level)
7062 "When FLAG is non-nil, hide the drawer we are within.
7063 Otherwise make it visible."
7075 "Is the end of the current subtree visible?"
7080 "Move cursor to the first headline and recenter the headline.
7081 Optional argument N means put the headline into the Nth line of the window."
7087 ;;; Saving and restoring visibility
7090 "Return a list of the locations of all outline overlays.
7091 These are overlays with the `invisible' property value `outline'.
7092 The return value is a list of cons cells, with start and stop
7093 positions for each overlay.
7094 If USE-MARKERS is set, return the positions as markers."
7112 "Create visibility overlays for all positions in DATA.
7113 DATA should have been made by `org-outline-overlay-data'."
7121 data)))))
7123 ;;; Folding of blocks
7130 "Call FUNCTION at the head of all source blocks in the current buffer.
7131 Optional arguments START and END can be used to limit the range."
7143 "Toggle the visibility of all blocks in the current buffer."
7147 "Fold all blocks in the current buffer."
7153 "Unfold all blocks in the current buffer."
7159 "Toggle visibility of block at point."
7170 "Toggle the visibility of the current block."
7177 ov)
7193 ;; make the block accessible to isearch
7195 ov 'isearch-open-invisible
7206 ;; org-tab-after-check-for-cycling-hook
7208 ;; Remove overlays when changing major mode
7213 ;;; Org-goto
7219 "Set the keymap `org-goto'."
7223 mouse-drag-region universal-argument org-occur))
7224 cmd)
7240 nil)
7241 (org-defkey map "q" 'org-goto-quit)
7242 (org-defkey map "n" 'outline-next-visible-heading)
7243 (org-defkey map "p" 'outline-previous-visible-heading)
7244 (org-defkey map "f" 'outline-forward-same-level)
7245 (org-defkey map "b" 'outline-backward-same-level)
7246 (org-defkey map "u" 'outline-up-heading))
7247 (org-defkey map "/" 'org-occur)
7248 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7249 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7250 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7251 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7252 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7253 map)))
7255 (defconst org-goto-help
7256 "Browse buffer copy, to find location or copy text.%s
7257 RET=jump to location C-g=quit and return to previous location
7258 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7260 (defvar org-goto-start-pos) ; dynamically scoped parameter
7262 (defun org-goto (&optional alternative-interface)
7263 "Look up a different location in the current file, keeping current visibility.
7265 When you want look-up or go to a different location in a
7266 document, the fastest way is often to fold the entire buffer and
7267 then dive into the tree. This method has the disadvantage, that
7268 the previous location will be folded, which may not be what you
7269 want.
7271 This command works around this by showing a copy of the current
7272 buffer in an indirect buffer, in overview mode. You can dive
7273 into the tree in that copy, use org-occur and incremental search
7274 to find a location. When pressing RET or `Q', the command
7275 returns to the original buffer in which the visibility is still
7276 unchanged. After RET it will also jump to the location selected
7277 in the indirect buffer and expose the headline hierarchy above.
7279 With a prefix argument, use the alternative interface: e.g. if
7280 `org-goto-interface' is 'outline use 'outline-path-completion."
7281 (interactive "P")
7282 (org-goto-map)
7283 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7284 (org-refile-use-outline-path t)
7285 (org-refile-target-verify-function nil)
7286 (interface
7287 (if (not alternative-interface)
7288 org-goto-interface
7289 (if (eq org-goto-interface 'outline)
7290 'outline-path-completion
7291 'outline)))
7292 (org-goto-start-pos (point))
7293 (selected-point
7294 (if (eq interface 'outline)
7295 (car (org-get-location (current-buffer) org-goto-help))
7296 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7297 (org-refile-check-position pa)
7298 (nth 3 pa)))))
7299 (if selected-point
7300 (progn
7301 (org-mark-ring-push org-goto-start-pos)
7302 (goto-char selected-point)
7303 (if (or (outline-invisible-p) (org-invisible-p2))
7304 (org-show-context 'org-goto)))
7305 (message "Quit"))))
7307 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7308 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7309 (defvar org-goto-local-auto-isearch-map) ; defined below
7311 (defun org-get-location (buf help)
7312 "Let the user select a location in the Org-mode buffer BUF.
7313 This function uses a recursive edit. It returns the selected position
7314 or nil."
7315 (org-no-popups
7316 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7317 (isearch-hide-immediately nil)
7318 (isearch-search-fun-function
7319 (lambda () 'org-goto-local-search-headings))
7320 (org-goto-selected-point org-goto-exit-command))
7321 (save-excursion
7322 (save-window-excursion
7323 (delete-other-windows)
7324 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7325 (org-pop-to-buffer-same-window
7326 (condition-case nil
7327 (make-indirect-buffer (current-buffer) "*org-goto*")
7328 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7329 (with-output-to-temp-buffer "*Org Help*"
7330 (princ (format help (if org-goto-auto-isearch
7331 " Just type for auto-isearch."
7332 " n/p/f/b/u to navigate, q to quit."))))
7333 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7334 (setq buffer-read-only nil)
7335 (let ((org-startup-truncated t)
7336 (org-startup-folded nil)
7337 (org-startup-align-all-tables nil))
7338 (org-mode)
7339 (org-overview))
7340 (setq buffer-read-only t)
7341 (if (and (boundp 'org-goto-start-pos)
7342 (integer-or-marker-p org-goto-start-pos))
7343 (let ((org-show-hierarchy-above t)
7344 (org-show-siblings t)
7345 (org-show-following-heading t))
7346 (goto-char org-goto-start-pos)
7347 (and (outline-invisible-p) (org-show-context)))
7348 (goto-char (point-min)))
7349 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7350 (message "Select location and press RET")
7351 (use-local-map org-goto-map)
7352 (recursive-edit)))
7353 (kill-buffer "*org-goto*")
7354 (cons org-goto-selected-point org-goto-exit-command))))
7356 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7357 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7358 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7359 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7361 (defun org-goto-local-search-headings (string bound noerror)
7362 "Search and make sure that any matches are in headlines."
7363 (catch 'return
7364 (while (if isearch-forward
7365 (search-forward string bound noerror)
7366 (search-backward string bound noerror))
7367 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7368 (and (member :headline context)
7369 (not (member :tags context))))
7370 (throw 'return (point))))))
7372 (defun org-goto-local-auto-isearch ()
7373 "Start isearch."
7374 (interactive)
7375 (goto-char (point-min))
7376 (let ((keys (this-command-keys)))
7377 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7378 (isearch-mode t)
7379 (isearch-process-search-char (string-to-char keys)))))
7381 (defun org-goto-ret (&optional arg)
7382 "Finish `org-goto' by going to the new location."
7383 (interactive "P")
7384 (setq org-goto-selected-point (point)
7385 org-goto-exit-command 'return)
7386 (throw 'exit nil))
7388 (defun org-goto-left ()
7389 "Finish `org-goto' by going to the new location."
7390 (interactive)
7391 (if (org-at-heading-p)
7392 (progn
7393 (beginning-of-line 1)
7394 (setq org-goto-selected-point (point)
7395 org-goto-exit-command 'left)
7396 (throw 'exit nil))
7397 (user-error "Not on a heading")))
7399 (defun org-goto-right ()
7400 "Finish `org-goto' by going to the new location."
7401 (interactive)
7402 (if (org-at-heading-p)
7403 (progn
7404 (setq org-goto-selected-point (point)
7405 org-goto-exit-command 'right)
7406 (throw 'exit nil))
7407 (user-error "Not on a heading")))
7409 (defun org-goto-quit ()
7410 "Finish `org-goto' without cursor motion."
7411 (interactive)
7412 (setq org-goto-selected-point nil)
7413 (setq org-goto-exit-command 'quit)
7414 (throw 'exit nil))
7416 ;;; Indirect buffer display of subtrees
7418 (defvar org-indirect-dedicated-frame nil
7419 "This is the frame being used for indirect tree display.")
7420 (defvar org-last-indirect-buffer nil)
7422 (defun org-tree-to-indirect-buffer (&optional arg)
7423 "Create indirect buffer and narrow it to current subtree.
7424 With a numerical prefix ARG, go up to this level and then take that tree.
7425 If ARG is negative, go up that many levels.
7427 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7428 indirect buffer previously made with this command, to avoid proliferation of
7429 indirect buffers. However, when you call the command with a \
7431 when `org-indirect-buffer-display' is `new-frame', the last buffer
7432 is kept so that you can work with several indirect buffers at the same time.
7433 If `org-indirect-buffer-display' is `dedicated-frame', the \
7435 requests that a new frame be made for the new buffer, so that the dedicated
7436 frame is not changed."
7437 (interactive "P")
7438 (let ((cbuf (current-buffer))
7439 (cwin (selected-window))
7440 (pos (point))
7441 beg end level heading ibuf)
7442 (save-excursion
7443 (org-back-to-heading t)
7444 (when (numberp arg)
7445 (setq level (org-outline-level))
7446 (if (< arg 0) (setq arg (+ level arg)))
7447 (while (> (setq level (org-outline-level)) arg)
7448 (org-up-heading-safe)))
7449 (setq beg (point)
7450 heading (org-get-heading))
7451 (org-end-of-subtree t t)
7452 (if (org-at-heading-p) (backward-char 1))
7453 (setq end (point)))
7454 (if (and (buffer-live-p org-last-indirect-buffer)
7455 (not (eq org-indirect-buffer-display 'new-frame))
7456 (not arg))
7457 (kill-buffer org-last-indirect-buffer))
7458 (setq ibuf (org-get-indirect-buffer cbuf)
7459 org-last-indirect-buffer ibuf)
7460 (cond
7461 ((or (eq org-indirect-buffer-display 'new-frame)
7462 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7463 (select-frame (make-frame))
7464 (delete-other-windows)
7465 (org-pop-to-buffer-same-window ibuf)
7466 (org-set-frame-title heading))
7467 ((eq org-indirect-buffer-display 'dedicated-frame)
7468 (raise-frame
7469 (select-frame (or (and org-indirect-dedicated-frame
7470 (frame-live-p org-indirect-dedicated-frame)
7471 org-indirect-dedicated-frame)
7472 (setq org-indirect-dedicated-frame (make-frame)))))
7473 (delete-other-windows)
7474 (org-pop-to-buffer-same-window ibuf)
7475 (org-set-frame-title (concat "Indirect: " heading)))
7476 ((eq org-indirect-buffer-display 'current-window)
7477 (org-pop-to-buffer-same-window ibuf))
7478 ((eq org-indirect-buffer-display 'other-window)
7479 (pop-to-buffer ibuf))
7480 (t (error "Invalid value")))
7481 (if (featurep 'xemacs)
7482 (save-excursion (org-mode) (turn-on-font-lock)))
7483 (narrow-to-region beg end)
7484 (show-all)
7485 (goto-char pos)
7486 (run-hook-with-args 'org-cycle-hook 'all)
7487 (and (window-live-p cwin) (select-window cwin))))
7489 (defun org-get-indirect-buffer (&optional buffer)
7490 (setq buffer (or buffer (current-buffer)))
7491 (let ((n 1) (base (buffer-name buffer)) bname)
7492 (while (buffer-live-p
7493 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7494 (setq n (1+ n)))
7495 (condition-case nil
7496 (make-indirect-buffer buffer bname 'clone)
7497 (error (make-indirect-buffer buffer bname)))))
7499 (defun org-set-frame-title (title)
7500 "Set the title of the current frame to the string TITLE."
7501 ;; FIXME: how to name a single frame in XEmacs???
7502 (unless (featurep 'xemacs)
7503 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7505 ;;;; Structure editing
7507 ;;; Inserting headlines
7509 (defun org-previous-line-empty-p (&optional next)
7510 "Is the previous line a blank line?
7511 When NEXT is non-nil, check the next line instead."
7512 (save-excursion
7513 (and (not (bobp))
7514 (or (beginning-of-line (if next 2 0)) t)
7515 (save-match-data
7518 (defun org-insert-heading (&optional arg invisible-ok)
7519 "Insert a new heading or item with same depth at point.
7520 If point is in a plain list and ARG is nil, create a new list item.
7521 With one universal prefix argument, insert a heading even in lists.
7522 With two universal prefix arguments, insert the heading at the end
7523 of the parent subtree.
7525 If point is at the beginning of a headline, insert a sibling before
7526 the current headline. If point is not at the beginning, split the line
7527 and create a new headline with the text in the current line after point
7528 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7530 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7531 This is important for non-interactive uses of the command."
7532 (interactive "P")
7533 (if (org-called-interactively-p 'any) (org-reveal))
7534 (let ((itemp (org-in-item-p)))
7535 (cond
7536 ((or (= (buffer-size) 0)
7537 (and (not (save-excursion
7538 (and (ignore-errors (org-back-to-heading invisible-ok))
7539 (org-at-heading-p))))
7540 (or arg (not itemp))))
7541 (insert
7543 (if (org-in-src-block-p) ",* " "* "))
7544 (run-hooks 'org-insert-heading-hook))
7545 ((or arg
7546 (and (not itemp) org-insert-heading-respect-content)
7547 (not (org-insert-item
7548 (save-excursion
7549 (and itemp
7550 (goto-char itemp)
7551 (looking-at org-list-full-item-re)
7552 (match-string 3))))))
7553 (let (begn endn)
7554 (when (org-buffer-narrowed-p)
7555 (setq begn (point-min) endn (point-max))
7556 (widen))
7557 (let* ((empty-line-p nil)
7558 (eops (equal arg '(16))) ; insert at end of parent subtree
7559 (org-insert-heading-respect-content
7560 (or (not (null arg)) org-insert-heading-respect-content))
7561 (level nil)
7562 (on-heading (org-at-heading-p))
7563 ;; Get a level to fall back on
7564 (fix-level
7565 (save-excursion
7566 (org-back-to-heading t)
7567 (looking-at org-outline-regexp)
7568 (make-string (1- (length (match-string 0))) ?*)))
7569 (on-empty-line
7571 (head (save-excursion
7572 (condition-case nil
7573 (progn
7574 (org-back-to-heading invisible-ok)
7575 (when (and (not on-heading)
7576 (featurep 'org-inlinetask)
7577 (integerp org-inlinetask-min-level)
7578 (>= (length (match-string 0))
7579 org-inlinetask-min-level))
7580 ;; Find a heading level before the inline task
7581 (while (and (setq level (org-up-heading-safe))
7582 (>= level org-inlinetask-min-level)))
7583 (if (org-at-heading-p)
7584 (org-back-to-heading invisible-ok)
7585 (error "This should not happen")))
7586 (unless (and (save-excursion
7587 (save-match-data
7588 (org-backward-heading-same-level 1 invisible-ok))
7589 (= (point) (match-beginning 0)))
7590 (not (org-previous-line-empty-p t)))
7591 (setq empty-line-p (org-previous-line-empty-p)))
7592 (match-string 0))
7593 (error (or fix-level "* ")))))
7594 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7595 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7596 pos hide-previous previous-pos)
7597 (if ;; At the beginning of a heading, open a new line for insertion
7598 (and (bolp) (org-at-heading-p)
7599 (not eops)
7600 (or (bobp)
7601 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7602 (open-line (if blank 2 1))
7603 (save-excursion
7604 (setq previous-pos (point-at-bol))
7605 (end-of-line)
7606 (setq hide-previous (outline-invisible-p)))
7607 (and org-insert-heading-respect-content
7608 (save-excursion
7609 (while (outline-invisible-p)
7610 (org-show-subtree)
7611 (org-up-heading-safe))))
7612 (let ((split
7613 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7614 (save-excursion
7615 (let ((p (point)))
7616 (goto-char (point-at-bol))
7617 (and (looking-at org-complex-heading-regexp)
7618 (match-beginning 4)
7619 (> p (match-beginning 4)))))))
7620 tags pos)
7621 (cond
7622 ;; Insert a new line, possibly at end of parent subtree
7623 ((and (not arg) (not on-heading) (not on-empty-line)
7624 (not (save-excursion
7625 (beginning-of-line 1)
7626 (or (looking-at org-list-full-item-re)
7627 ;; Don't convert :end: lines to headline
7630 (beginning-of-line 1))
7631 (org-insert-heading-respect-content
7632 (if (not eops)
7633 (progn
7634 (org-end-of-subtree nil t)
7636 (while (and (not (bobp))
7637 ;; Don't delete spaces in empty headlines
7638 (not (looking-back org-outline-regexp))
7640 (backward-delete-char 1)))
7641 (let ((p (point)))
7642 (org-up-heading-safe)
7643 (if (= p (point))
7644 (goto-char (point-max))
7645 (org-end-of-subtree nil t))))
7646 (when (featurep 'org-inlinetask)
7647 (while (and (not (eobp))
7649 (>= (length (match-string 1))
7650 org-inlinetask-min-level))
7651 (org-end-of-subtree nil t)))
7652 (or (bolp) (newline))
7653 (or (org-previous-line-empty-p)
7654 (and blank (newline)))
7655 (if (or empty-line-p eops) (open-line 1)))
7656 ;; Insert a headling containing text after point
7657 ((org-at-heading-p)
7658 (when hide-previous
7659 (show-children)
7660 (org-show-entry))
7662 (setq tags (and (match-end 2) (match-string 2)))
7663 (and (match-end 1)
7664 (delete-region (match-beginning 1) (match-end 1)))
7665 (setq pos (point-at-bol))
7666 (or split (end-of-line 1))
7667 (delete-horizontal-space)
7669 (buffer-substring (point-at-bol) (point)))
7670 (insert " "))
7671 (newline (if blank 2 1))
7672 (when tags
7673 (save-excursion
7674 (goto-char pos)
7675 (end-of-line 1)
7676 (insert " " tags)
7677 (org-set-tags nil 'align))))
7678 (t
7679 (or split (end-of-line 1))
7680 (newline (cond ((and blank (not on-empty-line)) 2)
7681 (blank 1)
7682 (on-empty-line 0) (t 1)))))))
7683 (insert head) (just-one-space)
7684 (setq pos (point))
7685 (end-of-line 1)
7686 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7687 (when (and org-insert-heading-respect-content hide-previous)
7688 (save-excursion
7689 (goto-char previous-pos)
7690 (hide-subtree)))
7691 (when (and begn endn)
7692 (narrow-to-region (min (point) begn) (max (point) endn)))
7693 (run-hooks 'org-insert-heading-hook)))))))
7695 (defun org-get-heading (&optional no-tags no-todo)
7696 "Return the heading of the current entry, without the stars.
7697 When NO-TAGS is non-nil, don't include tags.
7698 When NO-TODO is non-nil, don't include TODO keywords."
7699 (save-excursion
7700 (org-back-to-heading t)
7701 (cond
7702 ((and no-tags no-todo)
7703 (looking-at org-complex-heading-regexp)
7704 (match-string 4))
7705 (no-tags
7706 (looking-at (concat org-outline-regexp
7709 (match-string 1))
7710 (no-todo
7711 (looking-at org-todo-line-regexp)
7712 (match-string 3))
7713 (t (looking-at org-heading-regexp)
7714 (match-string 2)))))
7716 (defvar orgstruct-mode) ; defined below
7718 (defun org-heading-components ()
7719 "Return the components of the current heading.
7720 This is a list with the following elements:
7721 - the level as an integer
7722 - the reduced level, different if `org-odd-levels-only' is set.
7723 - the TODO keyword, or nil
7724 - the priority character, like ?A, or nil if no priority is given
7725 - the headline text itself, or the tags string if no headline text
7726 - the tags string, or nil."
7727 (save-excursion
7728 (org-back-to-heading t)
7729 (if (let (case-fold-search)
7730 (looking-at
7731 (if orgstruct-mode
7732 org-heading-regexp
7733 org-complex-heading-regexp)))
7734 (if orgstruct-mode
7735 (list (length (match-string 1))
7736 (org-reduced-level (length (match-string 1)))
7737 nil
7738 nil
7739 (match-string 2)
7740 nil)
7741 (list (length (match-string 1))
7742 (org-reduced-level (length (match-string 1)))
7743 (org-match-string-no-properties 2)
7744 (and (match-end 3) (aref (match-string 3) 2))
7745 (org-match-string-no-properties 4)
7746 (org-match-string-no-properties 5))))))
7748 (defun org-get-entry ()
7749 "Get the entry text, after heading, entire subtree."
7750 (save-excursion
7751 (org-back-to-heading t)
7752 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7754 (defun org-insert-heading-after-current ()
7755 "Insert a new heading with same level as current, after current subtree."
7756 (interactive)
7757 (org-back-to-heading)
7758 (org-insert-heading)
7759 (org-move-subtree-down)
7760 (end-of-line 1))
7762 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7763 "Insert heading with `org-insert-heading-respect-content' set to t."
7764 (interactive "P")
7765 (let ((org-insert-heading-respect-content t))
7766 (org-insert-heading arg invisible-ok)))
7768 (defun org-insert-todo-heading-respect-content (&optional force-state)
7769 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7770 (interactive "P")
7771 (let ((org-insert-heading-respect-content t))
7772 (org-insert-todo-heading force-state t)))
7774 (defun org-insert-todo-heading (arg &optional force-heading)
7775 "Insert a new heading with the same level and TODO state as current heading.
7776 If the heading has no TODO state, or if the state is DONE, use the first
7777 state (TODO by default). Also one prefix arg, force first state. With two
7778 prefix args, force inserting at the end of the parent subtree."
7779 (interactive "P")
7780 (when (or force-heading (not (org-insert-item 'checkbox)))
7781 (org-insert-heading (or (and (equal arg '(16)) '(16))
7782 force-heading))
7783 (save-excursion
7784 (org-back-to-heading)
7785 (outline-previous-heading)
7786 (looking-at org-todo-line-regexp))
7787 (let*
7788 ((new-mark-x
7789 (if (or arg
7790 (not (match-beginning 2))
7791 (member (match-string 2) org-done-keywords))
7792 (car org-todo-keywords-1)
7793 (match-string 2)))
7794 (new-mark
7795 (or
7796 (run-hook-with-args-until-success
7797 'org-todo-get-default-hook new-mark-x nil)
7798 new-mark-x)))
7799 (beginning-of-line 1)
7800 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7801 (if org-treat-insert-todo-heading-as-state-change
7802 (org-todo new-mark)
7803 (insert new-mark " "))))
7804 (when org-provide-todo-statistics
7805 (org-update-parent-todo-statistics))))
7807 (defun org-insert-subheading (arg)
7808 "Insert a new subheading and demote it.
7809 Works for outline headings and for plain lists alike."
7810 (interactive "P")
7811 (org-insert-heading arg)
7812 (cond
7813 ((org-at-heading-p) (org-do-demote))
7814 ((org-at-item-p) (org-indent-item))))
7816 (defun org-insert-todo-subheading (arg)
7817 "Insert a new subheading with TODO keyword or checkbox and demote it.
7818 Works for outline headings and for plain lists alike."
7819 (interactive "P")
7820 (org-insert-todo-heading arg)
7821 (cond
7822 ((org-at-heading-p) (org-do-demote))
7823 ((org-at-item-p) (org-indent-item))))
7825 ;;; Promotion and Demotion
7827 (defvar org-after-demote-entry-hook nil
7828 "Hook run after an entry has been demoted.
7829 The cursor will be at the beginning of the entry.
7830 When a subtree is being demoted, the hook will be called for each node.")
7832 (defvar org-after-promote-entry-hook nil
7833 "Hook run after an entry has been promoted.
7834 The cursor will be at the beginning of the entry.
7835 When a subtree is being promoted, the hook will be called for each node.")
7837 (defun org-promote-subtree ()
7838 "Promote the entire subtree.
7839 See also `org-promote'."
7840 (interactive)
7841 (save-excursion
7842 (org-with-limited-levels (org-map-tree 'org-promote)))
7843 (org-fix-position-after-promote))
7845 (defun org-demote-subtree ()
7846 "Demote the entire subtree. See `org-demote'.
7847 See also `org-promote'."
7848 (interactive)
7849 (save-excursion
7850 (org-with-limited-levels (org-map-tree 'org-demote)))
7851 (org-fix-position-after-promote))
7854 (defun org-do-promote ()
7855 "Promote the current heading higher up the tree.
7856 If the region is active in `transient-mark-mode', promote all headings
7857 in the region."
7858 (interactive)
7859 (save-excursion
7860 (if (org-region-active-p)
7861 (org-map-region 'org-promote (region-beginning) (region-end))
7862 (org-promote)))
7863 (org-fix-position-after-promote))
7865 (defun org-do-demote ()
7866 "Demote the current heading lower down the tree.
7867 If the region is active in `transient-mark-mode', demote all headings
7868 in the region."
7869 (interactive)
7870 (save-excursion
7871 (if (org-region-active-p)
7872 (org-map-region 'org-demote (region-beginning) (region-end))
7873 (org-demote)))
7874 (org-fix-position-after-promote))
7876 (defun org-fix-position-after-promote ()
7877 "Make sure that after pro/demotion cursor position is right."
7878 (let ((pos (point)))
7879 (when (save-excursion
7880 (beginning-of-line 1)
7881 (looking-at org-todo-line-regexp)
7882 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7883 (cond ((eobp) (insert " "))
7884 ((eolp) (insert " "))
7885 ((equal (char-after) ?\ ) (forward-char 1))))))
7887 (defun org-current-level ()
7888 "Return the level of the current entry, or nil if before the first headline.
7889 The level is the number of stars at the beginning of the headline."
7890 (save-excursion
7891 (org-with-limited-levels
7892 (if (ignore-errors (org-back-to-heading t))
7893 (funcall outline-level)))))
7895 (defun org-get-previous-line-level ()
7896 "Return the outline depth of the last headline before the current line.
7897 Returns 0 for the first headline in the buffer, and nil if before the
7898 first headline."
7899 (let ((current-level (org-current-level))
7900 (prev-level (when (> (line-number-at-pos) 1)
7901 (save-excursion
7902 (beginning-of-line 0)
7903 (org-current-level)))))
7904 (cond ((null current-level) nil) ; Before first headline
7905 ((null prev-level) 0) ; At first headline
7906 (prev-level))))
7908 (defun org-reduced-level (l)
7909 "Compute the effective level of a heading.
7910 This takes into account the setting of `org-odd-levels-only'."
7911 (cond
7912 ((zerop l) 0)
7913 (org-odd-levels-only (1+ (floor (/ l 2))))
7914 (t l)))
7916 (defun org-level-increment ()
7917 "Return the number of stars that will be added or removed at a
7918 time to headlines when structure editing, based on the value of
7919 `org-odd-levels-only'."
7920 (if org-odd-levels-only 2 1))
7922 (defun org-get-valid-level (level &optional change)
7923 "Rectify a level change under the influence of `org-odd-levels-only'
7924 LEVEL is a current level, CHANGE is by how much the level should be
7925 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7926 even level numbers will become the next higher odd number."
7927 (if org-odd-levels-only
7928 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7929 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7930 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7931 (max 1 (+ level (or change 0)))))
7933 (if (boundp 'define-obsolete-function-alias)
7934 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7935 (define-obsolete-function-alias 'org-get-legal-level
7936 'org-get-valid-level)
7937 (define-obsolete-function-alias 'org-get-legal-level
7938 'org-get-valid-level "23.1")))
7940 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7941 ;; ̀org-with-limited-levels'
7942 (defun org-promote ()
7943 "Promote the current heading higher up the tree.
7944 If the region is active in `transient-mark-mode', promote all headings
7945 in the region."
7946 (org-back-to-heading t)
7947 (let* ((level (save-match-data (funcall outline-level)))
7948 (after-change-functions (remove 'flyspell-after-change-function
7949 after-change-functions))
7950 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7951 (diff (abs (- level (length up-head) -1))))
7952 (cond ((and (= level 1) org-called-with-limited-levels
7953 org-allow-promoting-top-level-subtree)
7954 (replace-match "# " nil t))
7955 ((= level 1)
7956 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7957 (t (replace-match up-head nil t)))
7958 ;; Fixup tag positioning
7959 (unless (= level 1)
7960 (and org-auto-align-tags (org-set-tags nil t))
7961 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7962 (run-hooks 'org-after-promote-entry-hook)))
7964 (defun org-demote ()
7965 "Demote the current heading lower down the tree.
7966 If the region is active in `transient-mark-mode', demote all headings
7967 in the region."
7968 (org-back-to-heading t)
7969 (let* ((level (save-match-data (funcall outline-level)))
7970 (after-change-functions (remove 'flyspell-after-change-function
7971 after-change-functions))
7972 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7973 (diff (abs (- level (length down-head) -1))))
7974 (replace-match down-head nil t)
7975 ;; Fixup tag positioning
7976 (and org-auto-align-tags (org-set-tags nil t))
7977 (if org-adapt-indentation (org-fixup-indentation diff))
7978 (run-hooks 'org-after-demote-entry-hook)))
7980 (defun org-cycle-level ()
7981 "Cycle the level of an empty headline through possible states.
7982 This goes first to child, then to parent, level, then up the hierarchy.
7983 After top level, it switches back to sibling level."
7984 (interactive)
7985 (let ((org-adapt-indentation nil))
7986 (when (org-point-at-end-of-empty-headline)
7987 (setq this-command 'org-cycle-level) ; Only needed for caching
7988 (let ((cur-level (org-current-level))
7989 (prev-level (org-get-previous-line-level)))
7990 (cond
7991 ;; If first headline in file, promote to top-level.
7992 ((= prev-level 0)
7993 (loop repeat (/ (- cur-level 1) (org-level-increment))
7994 do (org-do-promote)))
7995 ;; If same level as prev, demote one.
7996 ((= prev-level cur-level)
7997 (org-do-demote))
7998 ;; If parent is top-level, promote to top level if not already.
7999 ((= prev-level 1)
8000 (loop repeat (/ (- cur-level 1) (org-level-increment))
8001 do (org-do-promote)))
8002 ;; If top-level, return to prev-level.
8003 ((= cur-level 1)
8004 (loop repeat (/ (- prev-level 1) (org-level-increment))
8005 do (org-do-demote)))
8006 ;; If less than prev-level, promote one.
8007 ((< cur-level prev-level)
8008 (org-do-promote))
8009 ;; If deeper than prev-level, promote until higher than
8010 ;; prev-level.
8011 ((> cur-level prev-level)
8012 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8013 do (org-do-promote))))
8014 t))))
8016 (defun org-map-tree (fun)
8017 "Call FUN for every heading underneath the current one."
8018 (org-back-to-heading)
8019 (let ((level (funcall outline-level)))
8020 (save-excursion
8021 (funcall fun)
8022 (while (and (progn
8023 (outline-next-heading)
8024 (> (funcall outline-level) level))
8025 (not (eobp)))
8026 (funcall fun)))))
8028 (defun org-map-region (fun beg end)
8029 "Call FUN for every heading between BEG and END."
8030 (let ((org-ignore-region t))
8031 (save-excursion
8032 (setq end (copy-marker end))
8033 (goto-char beg)
8034 (if (and (re-search-forward org-outline-regexp-bol nil t)
8035 (< (point) end))
8036 (funcall fun))
8037 (while (and (progn
8038 (outline-next-heading)
8039 (< (point) end))
8040 (not (eobp)))
8041 (funcall fun)))))
8043 (defvar org-property-end-re) ; silence byte-compiler
8044 (defun org-fixup-indentation (diff)
8045 "Change the indentation in the current entry by DIFF.
8046 However, if any line in the current entry has no indentation, or if it
8047 would end up with no indentation after the change, nothing at all is done."
8048 (save-excursion
8049 (let ((end (save-excursion (outline-next-heading)
8050 (point-marker)))
8051 (prohibit (if (> diff 0)
8054 col)
8055 (unless (save-excursion (end-of-line 1)
8056 (re-search-forward prohibit end t))
8057 (while (and (< (point) end)
8059 (goto-char (match-end 0))
8060 (setq col (current-column))
8061 (if (< diff 0) (replace-match ""))
8062 (org-indent-to-column (+ diff col))))
8063 (move-marker end nil))))
8065 (defun org-convert-to-odd-levels ()
8066 "Convert an org-mode file with all levels allowed to one with odd levels.
8067 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8068 level 5 etc."
8069 (interactive)
8070 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8071 (let ((outline-level 'org-outline-level)
8072 (org-odd-levels-only nil) n)
8073 (save-excursion
8074 (goto-char (point-min))
8076 (setq n (- (length (match-string 0)) 2))
8077 (while (>= (setq n (1- n)) 0)
8078 (org-demote))
8079 (end-of-line 1))))))
8081 (defun org-convert-to-oddeven-levels ()
8082 "Convert an org-mode file with only odd levels to one with odd/even levels.
8083 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8084 file contains a section with an even level, conversion would
8085 destroy the structure of the file. An error is signaled in this
8086 case."
8087 (interactive)
8088 (goto-char (point-min))
8089 ;; First check if there are no even levels
8091 (org-show-context t)
8092 (error "Not all levels are odd in this file. Conversion not possible"))
8093 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8094 (let ((outline-regexp org-outline-regexp)
8095 (outline-level 'org-outline-level)
8096 (org-odd-levels-only nil) n)
8097 (save-excursion
8098 (goto-char (point-min))
8100 (setq n (/ (1- (length (match-string 0))) 2))
8101 (while (>= (setq n (1- n)) 0)
8102 (org-promote))
8103 (end-of-line 1))))))
8105 (defun org-tr-level (n)
8106 "Make N odd if required."
8107 (if org-odd-levels-only (1+ (/ n 2)) n))
8109 ;;; Vertical tree motion, cutting and pasting of subtrees
8111 (defun org-move-subtree-up (&optional arg)
8112 "Move the current subtree up past ARG headlines of the same level."
8113 (interactive "p")
8114 (org-move-subtree-down (- (prefix-numeric-value arg))))
8116 (defun org-move-subtree-down (&optional arg)
8117 "Move the current subtree down past ARG headlines of the same level."
8118 (interactive "p")
8119 (setq arg (prefix-numeric-value arg))
8120 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8121 'org-get-last-sibling))
8122 (ins-point (make-marker))
8123 (cnt (abs arg))
8124 (col (current-column))
8125 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8126 ;; Select the tree
8127 (org-back-to-heading)
8128 (setq beg0 (point))
8129 (save-excursion
8130 (setq ne-beg (org-back-over-empty-lines))
8131 (setq beg (point)))
8132 (save-match-data
8133 (save-excursion (outline-end-of-heading)
8134 (setq folded (outline-invisible-p)))
8135 (outline-end-of-subtree))
8136 (outline-next-heading)
8137 (setq ne-end (org-back-over-empty-lines))
8138 (setq end (point))
8139 (goto-char beg0)
8140 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8141 ;; include less whitespace
8142 (save-excursion
8143 (goto-char beg)
8144 (forward-line (- ne-beg ne-end))
8145 (setq beg (point))))
8146 ;; Find insertion point, with error handling
8147 (while (> cnt 0)
8148 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8149 (progn (goto-char beg0)
8150 (user-error "Cannot move past superior level or buffer limit")))
8151 (setq cnt (1- cnt)))
8152 (if (> arg 0)
8153 ;; Moving forward - still need to move over subtree
8154 (progn (org-end-of-subtree t t)
8155 (save-excursion
8156 (org-back-over-empty-lines)
8157 (or (bolp) (newline)))))
8158 (setq ne-ins (org-back-over-empty-lines))
8159 (move-marker ins-point (point))
8160 (setq txt (buffer-substring beg end))
8161 (org-save-markers-in-region beg end)
8162 (delete-region beg end)
8163 (org-remove-empty-overlays-at beg)
8164 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8165 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8167 (let ((bbb (point)))
8168 (insert-before-markers txt)
8169 (org-reinstall-markers-in-region bbb)
8170 (move-marker ins-point bbb))
8172 (setq ins-end (point))
8173 (goto-char ins-point)
8174 (org-skip-whitespace)
8175 (when (and (< arg 0)
8176 (org-first-sibling-p)
8177 (> ne-ins ne-beg))
8178 ;; Move whitespace back to beginning
8179 (save-excursion
8180 (goto-char ins-end)
8181 (let ((kill-whole-line t))
8182 (kill-line (- ne-ins ne-beg)) (point)))
8184 (move-marker ins-point nil)
8185 (if folded
8186 (hide-subtree)
8187 (org-show-entry)
8188 (show-children)
8189 (org-cycle-hide-drawers 'children))
8190 (org-clean-visibility-after-subtree-move)
8191 ;; move back to the initial column we were at
8192 (move-to-column col)))
8194 (defvar org-subtree-clip ""
8195 "Clipboard for cut and paste of subtrees.
8196 This is actually only a copy of the kill, because we use the normal kill
8197 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8199 (defvar org-subtree-clip-folded nil
8200 "Was the last copied subtree folded?
8201 This is used to fold the tree back after pasting.")
8203 (defun org-cut-subtree (&optional n)
8204 "Cut the current subtree into the clipboard.
8205 With prefix arg N, cut this many sequential subtrees.
8206 This is a short-hand for marking the subtree and then cutting it."
8207 (interactive "p")
8208 (org-copy-subtree n 'cut))
8210 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8211 "Copy the current subtree it in the clipboard.
8212 With prefix arg N, copy this many sequential subtrees.
8213 This is a short-hand for marking the subtree and then copying it.
8214 If CUT is non-nil, actually cut the subtree.
8215 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8216 of some markers in the region, even if CUT is non-nil. This is
8217 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8218 (interactive "p")
8219 (let (beg end folded (beg0 (point)))
8220 (if (org-called-interactively-p 'any)
8221 (org-back-to-heading nil) ; take what looks like a subtree
8222 (org-back-to-heading t)) ; take what is really there
8223 (setq beg (point))
8225 (save-match-data
8226 (if nosubtrees
8227 (outline-next-heading)
8228 (save-excursion (outline-end-of-heading)
8229 (setq folded (outline-invisible-p)))
8230 (condition-case nil
8231 (org-forward-heading-same-level (1- n) t)
8232 (error nil))
8233 (org-end-of-subtree t t)))
8234 (setq end (point))
8235 (goto-char beg0)
8236 (when (> end beg)
8237 (setq org-subtree-clip-folded folded)
8238 (when (or cut force-store-markers)
8239 (org-save-markers-in-region beg end))
8240 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8241 (setq org-subtree-clip (current-kill 0))
8242 (message "%s: Subtree(s) with %d characters"
8243 (if cut "Cut" "Copied")
8244 (length org-subtree-clip)))))
8246 (defun org-paste-subtree (&optional level tree for-yank)
8247 "Paste the clipboard as a subtree, with modification of headline level.
8248 The entire subtree is promoted or demoted in order to match a new headline
8249 level.
8251 If the cursor is at the beginning of a headline, the same level as
8252 that headline is used to paste the tree.
8254 If not, the new level is derived from the *visible* headings
8255 before and after the insertion point, and taken to be the inferior headline
8256 level of the two. So if the previous visible heading is level 3 and the
8257 next is level 4 (or vice versa), level 4 will be used for insertion.
8258 This makes sure that the subtree remains an independent subtree and does
8259 not swallow low level entries.
8261 You can also force a different level, either by using a numeric prefix
8262 argument, or by inserting the heading marker by hand. For example, if the
8265 If optional TREE is given, use this text instead of the kill ring.
8267 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8268 move back over whitespace before inserting, and move point to the end of
8269 the inserted text when done."
8270 (interactive "P")
8271 (setq tree (or tree (and kill-ring (current-kill 0))))
8272 (unless (org-kill-is-subtree-p tree)
8273 (user-error "%s"
8274 (substitute-command-keys
8276 (org-with-limited-levels
8277 (let* ((visp (not (outline-invisible-p)))
8278 (txt tree)
8280 (old-level (if (string-match org-outline-regexp-bol txt)
8281 (- (match-end 0) (match-beginning 0) 1)
8282 -1))
8283 (force-level (cond (level (prefix-numeric-value level))
8285 (string-match
8287 (point-at-bol) (point))))
8288 (- (match-end 1) (match-beginning 1)))
8289 ((and (bolp)
8290 (looking-at org-outline-regexp))
8291 (- (match-end 0) (point) 1))))
8292 (previous-level (save-excursion
8293 (condition-case nil
8294 (progn
8295 (outline-previous-visible-heading 1)
8296 (if (looking-at ^re_)
8297 (- (match-end 0) (match-beginning 0) 1)
8298 1))
8299 (error 1))))
8300 (next-level (save-excursion
8301 (condition-case nil
8302 (progn
8303 (or (looking-at org-outline-regexp)
8304 (outline-next-visible-heading 1))
8305 (if (looking-at ^re_)
8306 (- (match-end 0) (match-beginning 0) 1)
8307 1))
8308 (error 1))))
8309 (new-level (or force-level (max previous-level next-level)))
8310 (shift (if (or (= old-level -1)
8311 (= new-level -1)
8312 (= old-level new-level))
8313 0
8314 (- new-level old-level)))
8315 (delta (if (> shift 0) -1 1))
8316 (func (if (> shift 0) 'org-demote 'org-promote))
8317 (org-odd-levels-only nil)
8318 beg end newend)
8319 ;; Remove the forced level indicator
8320 (if force-level
8321 (delete-region (point-at-bol) (point)))
8322 ;; Paste
8323 (beginning-of-line (if (bolp) 1 2))
8324 (setq beg (point))
8325 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8326 (insert-before-markers txt)
8328 (setq newend (point))
8329 (org-reinstall-markers-in-region beg)
8330 (setq end (point))
8331 (goto-char beg)
8333 (setq beg (point))
8334 (if (and (outline-invisible-p) visp)
8335 (save-excursion (outline-show-heading)))
8336 ;; Shift if necessary
8337 (unless (= shift 0)
8338 (save-restriction
8339 (narrow-to-region beg end)
8340 (while (not (= shift 0))
8341 (org-map-region func (point-min) (point-max))
8342 (setq shift (+ delta shift)))
8343 (goto-char (point-min))
8344 (setq newend (point-max))))
8345 (when (or (org-called-interactively-p 'interactive) for-yank)
8346 (message "Clipboard pasted as level %d subtree" new-level))
8347 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8348 kill-ring
8349 (eq org-subtree-clip (current-kill 0))
8350 org-subtree-clip-folded)
8351 ;; The tree was folded before it was killed/copied
8352 (hide-subtree))
8353 (and for-yank (goto-char newend)))))
8355 (defun org-kill-is-subtree-p (&optional txt)
8356 "Check if the current kill is an outline subtree, or a set of trees.
8357 Returns nil if kill does not start with a headline, or if the first
8358 headline level is not the largest headline level in the tree.
8359 So this will actually accept several entries of equal levels as well,
8360 which is OK for `org-paste-subtree'.
8361 If optional TXT is given, check this string instead of the current kill."
8362 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8363 (re (org-get-limited-outline-regexp))
8364 (^re (concat "^" re))
8365 (start-level (and kill
8366 (string-match
8368 kill)
8369 (- (match-end 2) (match-beginning 2) 1)))
8370 (start (1+ (or (match-beginning 2) -1))))
8371 (if (not start-level)
8372 (progn
8373 nil) ;; does not even start with a heading
8374 (catch 'exit
8375 (while (setq start (string-match ^re kill (1+ start)))
8376 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8377 (throw 'exit nil)))
8378 t))))
8380 (defvar org-markers-to-move nil
8381 "Markers that should be moved with a cut-and-paste operation.
8382 Those markers are stored together with their positions relative to
8383 the start of the region.")
8385 (defun org-save-markers-in-region (beg end)
8386 "Check markers in region.
8387 If these markers are between BEG and END, record their position relative
8388 to BEG, so that after moving the block of text, we can put the markers back
8389 into place.
8390 This function gets called just before an entry or tree gets cut from the
8391 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8392 called immediately, to move the markers with the entries."
8393 (setq org-markers-to-move nil)
8394 (when (featurep 'org-clock)
8395 (org-clock-save-markers-for-cut-and-paste beg end))
8396 (when (featurep 'org-agenda)
8397 (org-agenda-save-markers-for-cut-and-paste beg end)))
8399 (defun org-check-and-save-marker (marker beg end)
8400 "Check if MARKER is between BEG and END.
8401 If yes, remember the marker and the distance to BEG."
8402 (when (and (marker-buffer marker)
8403 (equal (marker-buffer marker) (current-buffer)))
8404 (if (and (>= marker beg) (< marker end))
8405 (push (cons marker (- marker beg)) org-markers-to-move))))
8407 (defun org-reinstall-markers-in-region (beg)
8408 "Move all remembered markers to their position relative to BEG."
8409 (mapc (lambda (x)
8410 (move-marker (car x) (+ beg (cdr x))))
8411 org-markers-to-move)
8412 (setq org-markers-to-move nil))
8414 (defun org-narrow-to-subtree ()
8415 "Narrow buffer to the current subtree."
8416 (interactive)
8417 (save-excursion
8418 (save-match-data
8419 (org-with-limited-levels
8420 (narrow-to-region
8421 (progn (org-back-to-heading t) (point))
8422 (progn (org-end-of-subtree t t)
8423 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8424 (point)))))))
8426 (defun org-narrow-to-block ()
8427 "Narrow buffer to the current block."
8428 (interactive)
8429 (let* ((case-fold-search t)
8432 (if blockp
8433 (narrow-to-region (car blockp) (cdr blockp))
8434 (user-error "Not in a block"))))
8436 (eval-when-compile
8437 (defvar org-property-drawer-re))
8439 (defvar org-property-start-re) ;; defined below
8440 (defun org-clone-subtree-with-time-shift (n &optional shift)
8441 "Clone the task (subtree) at point N times.
8442 The clones will be inserted as siblings.
8444 In interactive use, the user will be prompted for the number of
8445 clones to be produced. If the entry has a timestamp, the user
8446 will also be prompted for a time shift, which may be a repeater
8447 as used in time stamps, for example `+3d'. To disable this,
8448 you can call the function with a universal prefix argument.
8450 When a valid repeater is given and the entry contains any time
8451 stamps, the clones will become a sequence in time, with time
8452 stamps in the subtree shifted for each clone produced. If SHIFT
8453 is nil or the empty string, time stamps will be left alone. The
8454 ID property of the original subtree is removed.
8456 If the original subtree did contain time stamps with a repeater,
8457 the following will happen:
8458 - the repeater will be removed in each clone
8459 - an additional clone will be produced, with the current, unshifted
8460 date(s) in the entry.
8461 - the original entry will be placed *after* all the clones, with
8462 repeater intact.
8463 - the start days in the repeater in the original entry will be shifted
8464 to past the last clone.
8465 In this way you can spell out a number of instances of a repeating task,
8466 and still retain the repeater to cover future instances of the task."
8467 (interactive "nNumber of clones to produce: ")
8468 (let ((shift
8469 (or shift
8470 (if (and (not (equal current-prefix-arg '(4)))
8471 (save-excursion
8472 (re-search-forward org-ts-regexp-both
8473 (save-excursion
8474 (org-end-of-subtree t)
8475 (point)) t)))
8476 (read-from-minibuffer
8477 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8478 ""))) ;; No time shift
8479 (n-no-remove -1)
8480 (drawer-re org-drawer-regexp)
8481 beg end template task idprop
8482 shift-n shift-what doshift nmin nmax)
8483 (if (not (and (integerp n) (> n 0)))
8484 (error "Invalid number of replications %s" n))
8487 shift)))
8488 (error "Invalid shift specification %s" shift))
8489 (when doshift
8490 (setq shift-n (string-to-number (match-string 1 shift))
8491 shift-what (cdr (assoc (match-string 2 shift)
8492 '(("d" . day) ("w" . week)
8493 ("m" . month) ("y" . year))))))
8494 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8495 (setq nmin 1 nmax n)
8496 (org-back-to-heading t)
8497 (setq beg (point))
8498 (setq idprop (org-entry-get nil "ID"))
8499 (org-end-of-subtree t t)
8501 (setq end (point))
8502 (setq template (buffer-substring beg end))
8503 (when (and doshift
8505 (delete-region beg end)
8506 (setq end beg)
8507 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8508 (goto-char end)
8509 (loop for n from nmin to nmax do
8510 ;; prepare clone
8511 (with-temp-buffer
8512 (insert template)
8513 (org-mode)
8514 (goto-char (point-min))
8515 (org-show-subtree)
8516 (and idprop (if org-clone-delete-id
8517 (org-entry-delete nil "ID")
8518 (org-id-get-create t)))
8519 (unless (= n 0)
8521 (kill-whole-line))
8522 (goto-char (point-min))
8523 (while (re-search-forward drawer-re nil t)
8524 (mapc (lambda (d)
8525 (org-remove-empty-drawer-at d (point))) org-drawers)))
8526 (goto-char (point-min))
8527 (when doshift
8528 (while (re-search-forward org-ts-regexp-both nil t)
8529 (org-timestamp-change (* n shift-n) shift-what))
8530 (unless (= n n-no-remove)
8531 (goto-char (point-min))
8532 (while (re-search-forward org-ts-regexp nil t)
8533 (save-excursion
8534 (goto-char (match-beginning 0))
8536 (delete-region (match-beginning 1) (match-end 1)))))))
8537 (setq task (buffer-string)))
8538 (insert task))
8539 (goto-char beg)))
8541 ;;; Outline Sorting
8543 (defun org-sort (with-case)
8544 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8545 Optional argument WITH-CASE means sort case-sensitively."
8546 (interactive "P")
8547 (cond
8548 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8549 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8550 (t
8551 (org-call-with-arg 'org-sort-entries with-case))))
8553 (defun org-sort-remove-invisible (s)
8554 "Remove invisible links from string S."
8555 (remove-text-properties 0 (length s) org-rm-props s)
8556 (while (string-match org-bracket-link-regexp s)
8557 (setq s (replace-match (if (match-end 2)
8558 (match-string 3 s)
8559 (match-string 1 s)) t t s)))
8560 (let ((st (format " %s " s)))
8561 (while (string-match org-emph-re st)
8562 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8563 (setq s (substring st 1 -1)))
8564 s)
8566 (defvar org-priority-regexp) ; defined later in the file
8568 (defvar org-after-sorting-entries-or-items-hook nil
8569 "Hook that is run after a bunch of entries or items have been sorted.
8570 When children are sorted, the cursor is in the parent line when this
8571 hook gets called. When a region or a plain list is sorted, the cursor
8572 will be in the first entry of the sorted region/list.")
8574 (defun org-sort-entries
8575 (&optional with-case sorting-type getkey-func compare-func property)
8576 "Sort entries on a certain level of an outline tree.
8577 If there is an active region, the entries in the region are sorted.
8578 Else, if the cursor is before the first entry, sort the top-level items.
8579 Else, the children of the entry at point are sorted.
8581 Sorting can be alphabetically, numerically, by date/time as given by
8582 a time stamp, by a property, by priority order, or by a custom function.
8584 The command prompts for the sorting type unless it has been given to the
8585 function through the SORTING-TYPE argument, which needs to be a character,
8586 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8587 precise meaning of each character:
8589 n Numerically, by converting the beginning of the entry/item to a number.
8590 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8591 o By order of TODO keywords.
8592 t By date/time, either the first active time stamp in the entry, or, if
8593 none exist, by the first inactive one.
8594 s By the scheduled date/time.
8595 d By deadline date/time.
8596 c By creation time, which is assumed to be the first inactive time stamp
8597 at the beginning of a line.
8598 p By priority according to the cookie.
8599 r By the value of a property.
8601 Capital letters will reverse the sort order.
8603 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8604 called with point at the beginning of the record. It must return either
8605 a string or a number that should serve as the sorting key for that record.
8607 Comparing entries ignores case by default. However, with an optional argument
8608 WITH-CASE, the sorting considers case as well.
8610 Sorting is done against the visible part of the headlines, it ignores hidden
8611 links."
8612 (interactive "P")
8613 (let ((case-func (if with-case 'identity 'downcase))
8614 (cmstr
8615 ;; The clock marker is lost when using `sort-subr', let's
8616 ;; store the clocking string.
8617 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8618 (save-excursion
8619 (goto-char org-clock-marker)
8620 (looking-back "^.*") (match-string-no-properties 0))))
8621 start beg end stars re re2
8622 txt what tmp)
8623 ;; Find beginning and end of region to sort
8624 (cond
8625 ((org-region-active-p)
8626 ;; we will sort the region
8627 (setq end (region-end)
8628 what "region")
8629 (goto-char (region-beginning))
8630 (if (not (org-at-heading-p)) (outline-next-heading))
8631 (setq start (point)))
8632 ((or (org-at-heading-p)
8633 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8634 ;; we will sort the children of the current headline
8635 (org-back-to-heading)
8636 (setq start (point)
8637 end (progn (org-end-of-subtree t t)
8639 (org-back-over-empty-lines)
8640 (point))
8641 what "children")
8642 (goto-char start)
8643 (show-subtree)
8644 (outline-next-heading))
8645 (t
8646 ;; we will sort the top-level entries in this file
8647 (goto-char (point-min))
8648 (or (org-at-heading-p) (outline-next-heading))
8649 (setq start (point))
8650 (goto-char (point-max))
8651 (beginning-of-line 1)
8653 ;; File ends in a non-white line
8654 (end-of-line 1)
8656 (setq end (point-max))
8657 (setq what "top-level")
8658 (goto-char start)
8659 (show-all)))
8661 (setq beg (point))
8662 (if (>= beg end) (user-error "Nothing to sort"))
8665 (setq stars (match-string 1)
8666 re (concat "^" (regexp-quote stars) " +")
8668 txt (buffer-substring beg end))
8670 (if (and (not (equal stars "*")) (string-match re2 txt))
8671 (user-error "Region to sort contains a level above the first entry"))
8673 (unless sorting-type
8674 (message
8675 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8677 A/N/P/R/O/F/T/S/D/C means reversed:"
8678 what)
8679 (setq sorting-type (read-char-exclusive))
8681 (unless getkey-func
8682 (and (= (downcase sorting-type) ?f)
8683 (setq getkey-func
8684 (org-icompleting-read "Sort using function: "
8685 obarray 'fboundp t nil nil))
8686 (setq getkey-func (intern getkey-func))))
8688 (and (= (downcase sorting-type) ?r)
8689 (not property)
8690 (setq property
8691 (org-icompleting-read "Property: "
8692 (mapcar 'list (org-buffer-property-keys t))
8693 nil t))))
8695 (message "Sorting entries...")
8697 (save-restriction
8698 (narrow-to-region start end)
8699 (let ((dcst (downcase sorting-type))
8700 (case-fold-search nil)
8701 (now (current-time)))
8702 (sort-subr
8703 (/= dcst sorting-type)
8704 ;; This function moves to the beginning character of the "record" to
8705 ;; be sorted.
8706 (lambda nil
8707 (if (re-search-forward re nil t)
8708 (goto-char (match-beginning 0))
8709 (goto-char (point-max))))
8710 ;; This function moves to the last character of the "record" being
8711 ;; sorted.
8712 (lambda nil
8713 (save-match-data
8714 (condition-case nil
8715 (outline-forward-same-level 1)
8716 (error
8717 (goto-char (point-max))))))
8718 ;; This function returns the value that gets sorted against.
8719 (lambda nil
8720 (cond
8721 ((= dcst ?n)
8722 (if (looking-at org-complex-heading-regexp)
8723 (string-to-number (org-sort-remove-invisible (match-string 4)))
8724 nil))
8725 ((= dcst ?a)
8726 (if (looking-at org-complex-heading-regexp)
8727 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8728 nil))
8729 ((= dcst ?t)
8730 (let ((end (save-excursion (outline-next-heading) (point))))
8731 (if (or (re-search-forward org-ts-regexp end t)
8732 (re-search-forward org-ts-regexp-both end t))
8733 (org-time-string-to-seconds (match-string 0))
8734 (org-float-time now))))
8735 ((= dcst ?c)
8736 (let ((end (save-excursion (outline-next-heading) (point))))
8737 (if (re-search-forward
8739 end t)
8740 (org-time-string-to-seconds (match-string 0))
8741 (org-float-time now))))
8742 ((= dcst ?s)
8743 (let ((end (save-excursion (outline-next-heading) (point))))
8744 (if (re-search-forward org-scheduled-time-regexp end t)
8745 (org-time-string-to-seconds (match-string 1))
8746 (org-float-time now))))
8747 ((= dcst ?d)
8748 (let ((end (save-excursion (outline-next-heading) (point))))
8749 (if (re-search-forward org-deadline-time-regexp end t)
8750 (org-time-string-to-seconds (match-string 1))
8751 (org-float-time now))))
8752 ((= dcst ?p)
8753 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8754 (string-to-char (match-string 2))
8755 org-default-priority))
8756 ((= dcst ?r)
8757 (or (org-entry-get nil property) ""))
8758 ((= dcst ?o)
8759 (if (looking-at org-complex-heading-regexp)
8760 (- 9999 (length (member (match-string 2)
8761 org-todo-keywords-1)))))
8762 ((= dcst ?f)
8763 (if getkey-func
8764 (progn
8765 (setq tmp (funcall getkey-func))
8766 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8767 tmp)
8768 (error "Invalid key function `%s'" getkey-func)))
8769 (t (error "Invalid sorting type `%c'" sorting-type))))
8770 nil
8771 (cond
8772 ((= dcst ?a) 'string<)
8773 ((= dcst ?f) compare-func)
8774 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8775 (run-hooks 'org-after-sorting-entries-or-items-hook)
8776 ;; Reset the clock marker if needed
8777 (when cmstr
8778 (save-excursion
8779 (goto-char start)
8780 (search-forward cmstr nil t)
8781 (move-marker org-clock-marker (point))))
8782 (message "Sorting entries...done")))
8784 (defun org-do-sort (table what &optional with-case sorting-type)
8785 "Sort TABLE of WHAT according to SORTING-TYPE.
8786 The user will be prompted for the SORTING-TYPE if the call to this
8787 function does not specify it. WHAT is only for the prompt, to indicate
8788 what is being sorted. The sorting key will be extracted from
8789 the car of the elements of the table.
8790 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8791 (unless sorting-type
8792 (message
8793 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8794 what)
8795 (setq sorting-type (read-char-exclusive)))
8796 (let ((dcst (downcase sorting-type))
8797 extractfun comparefun)
8798 ;; Define the appropriate functions
8799 (cond
8800 ((= dcst ?n)
8801 (setq extractfun 'string-to-number
8802 comparefun (if (= dcst sorting-type) '< '>)))
8803 ((= dcst ?a)
8804 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8805 (lambda(x) (downcase (org-sort-remove-invisible x))))
8806 comparefun (if (= dcst sorting-type)
8807 'string<
8808 (lambda (a b) (and (not (string< a b))
8809 (not (string= a b)))))))
8810 ((= dcst ?t)
8811 (setq extractfun
8812 (lambda (x)
8813 (if (or (string-match org-ts-regexp x)
8814 (string-match org-ts-regexp-both x))
8815 (org-float-time
8816 (org-time-string-to-time (match-string 0 x)))
8817 0))
8818 comparefun (if (= dcst sorting-type) '< '>)))
8819 (t (error "Invalid sorting type `%c'" sorting-type)))
8821 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8822 table)
8823 (lambda (a b) (funcall comparefun (car a) (car b))))))
8826 ;;; The orgstruct minor mode
8828 ;; Define a minor mode which can be used in other modes in order to
8829 ;; integrate the org-mode structure editing commands.
8831 ;; This is really a hack, because the org-mode structure commands use
8832 ;; keys which normally belong to the major mode. Here is how it
8833 ;; works: The minor mode defines all the keys necessary to operate the
8834 ;; structure commands, but wraps the commands into a function which
8835 ;; tests if the cursor is currently at a headline or a plain list
8836 ;; item. If that is the case, the structure command is used,
8837 ;; temporarily setting many Org-mode variables like regular
8838 ;; expressions for filling etc. However, when any of those keys is
8839 ;; used at a different location, function uses `key-binding' to look
8840 ;; up if the key has an associated command in another currently active
8841 ;; keymap (minor modes, major mode, global), and executes that
8842 ;; command. There might be problems if any of the keys is otherwise
8843 ;; used as a prefix key.
8845 (defcustom orgstruct-heading-prefix-regexp nil
8846 "Regexp that matches the custom prefix of Org headlines in
8847 orgstruct(++)-mode."
8848 :group 'org
8849 :version "24.4"
8850 :package-version '(Org . "8.0")
8851 :type 'string)
8852 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8854 (defcustom orgstruct-setup-hook nil
8855 "Hook run after orgstruct-mode-map is filled."
8856 :group 'org
8857 :version "24.4"
8858 :package-version '(Org . "8.0")
8859 :type 'hook)
8861 (defvar orgstruct-initialized nil)
8863 (defvar org-local-vars nil
8864 "List of local variables, for use by `orgstruct-mode'.")
8866 ;;;###autoload
8867 (define-minor-mode orgstruct-mode
8868 "Toggle the minor mode `orgstruct-mode'.
8869 This mode is for using Org-mode structure commands in other
8870 modes. The following keys behave as if Org-mode were active, if
8871 the cursor is on a headline, or on a plain list item (both as
8872 defined by Org-mode)."
8873 nil " OrgStruct" (make-sparse-keymap)
8874 (funcall (if orgstruct-mode
8875 'add-to-invisibility-spec
8876 'remove-from-invisibility-spec)
8877 '(outline . t))
8878 (when orgstruct-mode
8879 (org-load-modules-maybe)
8880 (unless orgstruct-initialized
8881 (orgstruct-setup)
8882 (setq orgstruct-initialized t))))
8884 ;;;###autoload
8885 (defun turn-on-orgstruct ()
8886 "Unconditionally turn on `orgstruct-mode'."
8887 (orgstruct-mode 1))
8889 (defvar org-fb-vars nil)
8890 (make-variable-buffer-local 'org-fb-vars)
8891 (defun orgstruct++-mode (&optional arg)
8892 "Toggle `orgstruct-mode', the enhanced version of it.
8893 In addition to setting orgstruct-mode, this also exports all
8894 indentation and autofilling variables from org-mode into the
8895 buffer. It will also recognize item context in multiline items."
8896 (interactive "P")
8897 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8898 (if (< arg 1)
8899 (progn (orgstruct-mode -1)
8900 (mapc (lambda(v)
8901 (org-set-local (car v)
8902 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8903 org-fb-vars))
8904 (orgstruct-mode 1)
8905 (setq org-fb-vars nil)
8906 (unless org-local-vars
8907 (setq org-local-vars (org-get-local-variables)))
8908 (let (var val)
8909 (mapc
8910 (lambda (x)
8911 (when (string-match
8913 (symbol-name (car x)))
8914 (setq var (car x) val (nth 1 x))
8915 (push (list var `(quote ,(eval var))) org-fb-vars)
8916 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8917 org-local-vars)
8918 (org-set-local 'orgstruct-is-++ t))))
8920 (defvar orgstruct-is-++ nil
8921 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8922 (make-variable-buffer-local 'orgstruct-is-++)
8924 ;;;###autoload
8925 (defun turn-on-orgstruct++ ()
8926 "Unconditionally turn on `orgstruct++-mode'."
8927 (orgstruct++-mode 1))
8929 (defun orgstruct-error ()
8930 "Error when there is no default binding for a structure key."
8931 (interactive)
8932 (funcall (if (fboundp 'user-error)
8933 'user-error
8934 'error)
8935 "This key has no function outside structure elements"))
8937 (defun orgstruct-setup ()
8938 "Setup orgstruct keymap."
8939 (dolist (cell '((org-demote . t)
8940 (org-metaleft . t)
8941 (org-metaright . t)
8942 (org-promote . t)
8943 (org-shiftmetaleft . t)
8944 (org-shiftmetaright . t)
8945 org-backward-element
8946 org-backward-heading-same-level
8947 org-ctrl-c-ret
8948 org-ctrl-c-minus
8949 org-ctrl-c-star
8950 org-cycle
8951 org-forward-heading-same-level
8952 org-insert-heading
8953 org-insert-heading-respect-content
8954 org-kill-note-or-show-branches
8955 org-mark-subtree
8956 org-meta-return
8957 org-metadown
8958 org-metaup
8959 org-narrow-to-subtree
8960 org-promote-subtree
8961 org-reveal
8962 org-shiftdown
8963 org-shiftleft
8964 org-shiftmetadown
8965 org-shiftmetaup
8966 org-shiftright
8967 org-shifttab
8968 org-shifttab
8969 org-shiftup
8970 org-show-subtree
8971 org-sort
8972 org-up-element
8973 outline-demote
8974 outline-next-visible-heading
8975 outline-previous-visible-heading
8976 outline-promote
8977 outline-up-heading
8978 show-children))
8979 (let ((f (or (car-safe cell) cell))
8980 (disable-when-heading-prefix (cdr-safe cell)))
8981 (when (fboundp f)
8982 (let ((new-bindings))
8983 (dolist (binding (nconc (where-is-internal f org-mode-map)
8984 (where-is-internal f outline-mode-map)))
8985 (push binding new-bindings)
8986 ;; TODO use local-function-key-map
8987 (dolist (rep '(("<tab>" . "TAB")
8988 ("<return>" . "RET")
8989 ("<escape>" . "ESC")
8990 ("<delete>" . "DEL")))
8991 (setq binding (read-kbd-macro
8992 (let ((case-fold-search))
8993 (replace-regexp-in-string
8994 (regexp-quote (cdr rep))
8995 (car rep)
8996 (key-description binding)))))
8997 (pushnew binding new-bindings :test 'equal)))
8998 (dolist (binding new-bindings)
8999 (let ((key (lookup-key orgstruct-mode-map binding)))
9000 (when (or (not key) (numberp key))
9001 (condition-case nil
9002 (org-defkey orgstruct-mode-map
9003 binding
9004 (orgstruct-make-binding f binding disable-when-heading-prefix))
9005 (error nil)))))))))
9006 (run-hooks 'orgstruct-setup-hook))
9008 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9009 "Create a function for binding in the structure minor mode.
9010 FUN is the command to call inside a table. KEY is the key that
9011 should be checked in for a command to execute outside of tables.
9012 Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
9013 if `orgstruct-heading-prefix-regexp' is non-nil."
9014 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9015 (let ((nname name)
9016 (i 0))
9017 (while (fboundp (intern nname))
9018 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9019 (setq name (intern nname)))
9020 (eval
9021 (let ((bindings '((org-heading-regexp
9022 (concat "^"
9023 orgstruct-heading-prefix-regexp
9025 (org-outline-regexp
9027 (org-outline-regexp-bol
9028 (concat "^" org-outline-regexp))
9029 (outline-regexp org-outline-regexp)
9031 (outline-level 'org-outline-level)
9032 (outline-heading-alist))))
9033 `(defun ,name (arg)
9035 "Outside of structure, run the binding of `"
9036 (key-description key) "'."
9037 (when disable-when-heading-prefix
9038 (concat
9041 "`" (symbol-name fun) "'.")))
9042 (interactive "p")
9043 (let* ((disable
9044 ,(when disable-when-heading-prefix
9045 '(and orgstruct-heading-prefix-regexp
9046 (not (string= orgstruct-heading-prefix-regexp "")))))
9047 (fallback
9048 (or disable
9049 (not
9050 (let* ,bindings
9051 (org-context-p 'headline 'item
9052 ,(when (memq fun
9053 '(org-insert-heading
9054 org-insert-heading-respect-content
9055 org-meta-return))
9056 '(when orgstruct-is-++
9057 'item-body))))))))
9058 (if fallback
9059 (let* ((orgstruct-mode)
9060 (binding
9061 (loop with key = ,key
9062 for rep in
9063 '(nil
9068 do
9069 (when rep
9070 (setq key (read-kbd-macro
9071 (let ((case-fold-search))
9072 (replace-regexp-in-string
9073 (car rep)
9074 (cdr rep)
9075 (key-description key))))))
9076 thereis (key-binding key))))
9077 (if (keymapp binding)
9078 (set-temporary-overlay-map binding)
9079 (let ((func (or binding
9080 (unless disable
9081 'orgstruct-error))))
9082 (when func
9083 (call-interactively func)))))
9084 (org-run-like-in-org-mode
9085 (lambda ()
9086 (interactive)
9087 (let* ,bindings
9088 (call-interactively ',fun)))))))))
9089 name))
9091 (defun org-contextualize-keys (alist contexts)
9092 "Return valid elements in ALIST depending on CONTEXTS.
9094 `org-agenda-custom-commands' or `org-capture-templates' are the
9095 values used for ALIST, and `org-agenda-custom-commands-contexts'
9096 or `org-capture-templates-contexts' are the associated contexts
9097 definitions."
9098 (let ((contexts
9099 ;; normalize contexts
9100 (mapcar
9101 (lambda(c) (cond ((listp (cadr c))
9102 (list (car c) (car c) (cadr c)))
9103 ((string= "" (cadr c))
9104 (list (car c) (car c) (caddr c)))
9105 (t c))) contexts))
9106 (a alist) c r s)
9107 ;; loop over all commands or templates
9108 (while (setq c (pop a))
9109 (let (vrules repl)
9110 (cond
9111 ((not (assoc (car c) contexts))
9112 (push c r))
9113 ((and (assoc (car c) contexts)
9114 (setq vrules (org-contextualize-validate-key
9115 (car c) contexts)))
9116 (mapc (lambda (vr)
9117 (when (not (equal (car vr) (cadr vr)))
9118 (setq repl vr))) vrules)
9119 (if (not repl) (push c r)
9120 (push (cadr repl) s)
9121 (push
9122 (cons (car c)
9123 (cdr (or (assoc (cadr repl) alist)
9124 (error "Undefined key `%s' as contextual replacement for `%s'"
9125 (cadr repl) (car c)))))
9126 r))))))
9127 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9128 (delq
9129 nil
9130 (delete-dups
9131 (mapcar (lambda (x)
9132 (let ((tpl (car x)))
9133 (when (not (delq
9134 nil
9135 (mapcar (lambda(y)
9136 (equal y tpl)) s))) x)))
9137 (reverse r))))))
9139 (defun org-contextualize-validate-key (key contexts)
9140 "Check CONTEXTS for agenda or capture KEY."
9141 (let (r rr res)
9142 (while (setq r (pop contexts))
9143 (mapc
9144 (lambda (rr)
9145 (when
9146 (and (equal key (car r))
9147 (if (functionp rr) (funcall rr)
9148 (or (and (eq (car rr) 'in-file)
9149 (buffer-file-name)
9150 (string-match (cdr rr) (buffer-file-name)))
9151 (and (eq (car rr) 'in-mode)
9152 (string-match (cdr rr) (symbol-name major-mode)))
9153 (and (eq (car rr) 'in-buffer)
9154 (string-match (cdr rr) (buffer-name)))
9155 (when (and (eq (car rr) 'not-in-file)
9156 (buffer-file-name))
9157 (not (string-match (cdr rr) (buffer-file-name))))
9158 (when (eq (car rr) 'not-in-mode)
9159 (not (string-match (cdr rr) (symbol-name major-mode))))
9160 (when (eq (car rr) 'not-in-buffer)
9161 (not (string-match (cdr rr) (buffer-name)))))))
9162 (push r res)))
9163 (car (last r))))
9164 (delete-dups (delq nil res))))
9166 (defun org-context-p (&rest contexts)
9167 "Check if local context is any of CONTEXTS.
9168 Possible values in the list of contexts are `table', `headline', and `item'."
9169 (let ((pos (point)))
9170 (goto-char (point-at-bol))
9171 (prog1 (or (and (memq 'table contexts)
9173 (and (memq 'headline contexts)
9174 (looking-at org-outline-regexp))
9175 (and (memq 'item contexts)
9177 (and (memq 'item-body contexts)
9178 (org-in-item-p)))
9179 (goto-char pos))))
9181 (defun org-get-local-variables ()
9182 "Return a list of all local variables in an Org mode buffer."
9183 (let (varlist)
9184 (with-current-buffer (get-buffer-create "*Org tmp*")
9185 (erase-buffer)
9186 (org-mode)
9187 (setq varlist (buffer-local-variables)))
9188 (kill-buffer "*Org tmp*")
9189 (delq nil
9190 (mapcar
9191 (lambda (x)
9192 (setq x
9193 (if (symbolp x)
9194 (list x)
9195 (list (car x) (cdr x))))
9196 (if (and (not (get (car x) 'org-state))
9197 (string-match
9198 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9199 (symbol-name (car x))))
9200 x nil))
9201 varlist))))
9203 (defun org-clone-local-variables (from-buffer &optional regexp)
9204 "Clone local variables from FROM-BUFFER.
9205 Optional argument REGEXP selects variables to clone."
9206 (mapc
9207 (lambda (pair)
9208 (and (symbolp (car pair))
9209 (or (null regexp)
9210 (string-match regexp (symbol-name (car pair))))
9211 (set (make-local-variable (car pair))
9212 (cdr pair))))
9213 (buffer-local-variables from-buffer)))
9215 ;;;###autoload
9216 (defun org-run-like-in-org-mode (cmd)
9217 "Run a command, pretending that the current buffer is in Org-mode.
9218 This will temporarily bind local variables that are typically bound in
9219 Org-mode to the values they have in Org-mode, and then interactively
9220 call CMD."
9221 (org-load-modules-maybe)
9222 (unless org-local-vars
9223 (setq org-local-vars (org-get-local-variables)))
9224 (let (binds)
9225 (dolist (var org-local-vars)
9226 (when (or (not (boundp (car var)))
9227 (eq (symbol-value (car var))
9228 (default-value (car var))))
9229 (push (list (car var) `(quote ,(cadr var))) binds)))
9230 (eval `(let ,binds
9231 (call-interactively (quote ,cmd))))))
9233 ;;;; Archiving
9235 (defun org-get-category (&optional pos force-refresh)
9236 "Get the category applying to position POS."
9237 (save-match-data
9238 (if force-refresh (org-refresh-category-properties))
9239 (let ((pos (or pos (point))))
9240 (or (get-text-property pos 'org-category)
9241 (progn (org-refresh-category-properties)
9242 (get-text-property pos 'org-category))))))
9244 (defun org-refresh-category-properties ()
9245 "Refresh category text properties in the buffer."
9246 (let ((case-fold-search t)
9247 (inhibit-read-only t)
9248 (def-cat (cond
9249 ((null org-category)
9250 (if buffer-file-name
9251 (file-name-sans-extension
9252 (file-name-nondirectory buffer-file-name))
9253 "???"))
9254 ((symbolp org-category) (symbol-name org-category))
9255 (t org-category)))
9256 beg end cat pos optionp)
9257 (org-with-silent-modifications
9258 (save-excursion
9259 (save-restriction
9260 (widen)
9261 (goto-char (point-min))
9262 (put-text-property (point) (point-max) 'org-category def-cat)
9263 (while (re-search-forward
9265 (setq pos (match-end 0)
9266 optionp (equal (char-after (match-beginning 0)) ?#)
9267 cat (org-trim (match-string 2)))
9268 (if optionp
9269 (setq beg (point-at-bol) end (point-max))
9270 (org-back-to-heading t)
9271 (setq beg (point) end (org-end-of-subtree t t)))
9272 (put-text-property beg end 'org-category cat)
9273 (put-text-property beg end 'org-category-position beg)
9274 (goto-char pos)))))))
9276 (defun org-refresh-properties (dprop tprop)
9277 "Refresh buffer text properties.
9278 DPROP is the drawer property and TPROP is the corresponding text
9279 property to set."
9280 (let ((case-fold-search t)
9281 (inhibit-read-only t) p)
9282 (org-with-silent-modifications
9283 (save-excursion
9284 (save-restriction
9285 (widen)
9286 (goto-char (point-min))
9288 (setq p (org-match-string-no-properties 1))
9289 (save-excursion
9290 (org-back-to-heading t)
9291 (put-text-property
9292 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9295 ;;;; Link Stuff
9297 ;;; Link abbreviations
9299 (defun org-link-expand-abbrev (link)
9300 "Apply replacements as defined in `org-link-abbrev-alist'."
9302 (let* ((key (match-string 1 link))
9303 (as (or (assoc key org-link-abbrev-alist-local)
9304 (assoc key org-link-abbrev-alist)))
9305 (tag (and (match-end 2) (match-string 3 link)))
9306 rpl)
9307 (if (not as)
9308 link
9309 (setq rpl (cdr as))
9310 (cond
9311 ((symbolp rpl) (funcall rpl tag))
9313 (replace-match
9314 (save-match-data
9315 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9316 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9317 ((string-match "%h" rpl)
9318 (replace-match (url-hexify-string (or tag "")) t t rpl))
9319 (t (concat rpl tag)))))
9320 link))
9322 ;;; Storing and inserting links
9324 (defvar org-insert-link-history nil
9325 "Minibuffer history for links inserted with `org-insert-link'.")
9327 (defvar org-stored-links nil
9328 "Contains the links stored with `org-store-link'.")
9330 (defvar org-store-link-plist nil
9331 "Plist with info about the most recently link created with `org-store-link'.")
9333 (defvar org-link-protocols nil
9334 "Link protocols added to Org-mode using `org-add-link-type'.")
9336 (defvar org-store-link-functions nil
9337 "List of functions that are called to create and store a link.
9338 Each function will be called in turn until one returns a non-nil
9339 value. Each function should check if it is responsible for creating
9340 this link (for example by looking at the major mode).
9341 If not, it must exit and return nil.
9342 If yes, it should return a non-nil value after a calling
9343 `org-store-link-props' with a list of properties and values.
9344 Special properties are:
9348 This is obligatory as well.
9349 :description Optional default description for the second pair
9350 of brackets in an Org-mode link. The user can still change
9351 this when inserting this link into an Org-mode buffer.
9353 In addition to these, any additional properties can be specified
9354 and then used in capture templates.")
9356 (defun org-add-link-type (type &optional follow export)
9357 "Add TYPE to the list of `org-link-types'.
9358 Re-compute all regular expressions depending on `org-link-types'
9360 FOLLOW and EXPORT are two functions.
9362 FOLLOW should take the link path as the single argument and do whatever
9363 is necessary to follow the link, for example find a file or display
9364 a mail message.
9366 EXPORT should format the link path for export to one of the export formats.
9367 It should be a function accepting three arguments:
9370 desc the description of the link, if any, or a description added by
9371 org-export-normalize-links if there is none
9372 format the export format, a symbol like `html' or `latex' or `ascii'..
9374 The function may use the FORMAT information to return different values
9375 depending on the format. The return value will be put literally into
9376 the exported file. If the return value is nil, this means Org should
9377 do what it normally does with links which do not have EXPORT defined.
9379 Org-mode has a built-in default for exporting links. If you are happy with
9380 this default, there is no need to define an export function for the link
9381 type. For a simple example of an export function, see `org-bbdb.el'."
9382 (add-to-list 'org-link-types type t)
9383 (org-make-link-regexps)
9384 (if (assoc type org-link-protocols)
9385 (setcdr (assoc type org-link-protocols) (list follow export))
9386 (push (list type follow export) org-link-protocols)))
9388 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9389 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9391 ;;;###autoload
9392 (defun org-store-link (arg)
9394 This link is added to `org-stored-links' and can later be inserted
9397 For some link types, a prefix arg is interpreted.
9398 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9399 For file links, arg negates `org-context-in-file-links'.
9401 A double prefix arg force skipping storing functions that are not
9402 part of Org's core.
9404 A triple prefix arg force storing a link for each line in the
9405 active region."
9406 (interactive "P")
9407 (org-load-modules-maybe)
9408 (if (and (equal arg '(64)) (org-region-active-p))
9409 (save-excursion
9410 (let ((end (region-end)))
9411 (goto-char (region-beginning))
9412 (set-mark (point))
9413 (while (< (point-at-eol) end)
9414 (move-end-of-line 1) (activate-mark)
9415 (let (current-prefix-arg)
9416 (call-interactively 'org-store-link))
9417 (move-beginning-of-line 2)
9418 (set-mark (point)))))
9419 (org-with-limited-levels
9420 (setq org-store-link-plist nil)
9421 (let (link cpltxt desc description search
9422 txt custom-id agenda-link sfuns sfunsn)
9423 (cond
9425 ;; Store a link using an external link type
9426 ((and (not (equal arg '(16)))
9427 (setq sfuns
9428 (delq
9429 nil (mapcar (lambda (f)
9430 (let (fs) (if (funcall f) (push f fs))))
9431 org-store-link-functions))
9432 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9433 (or (and (cdr sfuns)
9434 (funcall (intern
9435 (completing-read
9436 "Which function for creating the link? "
9437 sfunsn t (car sfunsn)))))
9438 (funcall (caar sfuns)))
9439 (setq link (plist-get org-store-link-plist :link)
9440 desc (or (plist-get org-store-link-plist
9441 :description) link))))
9443 ;; Store a link from a source code buffer
9444 ((org-src-edit-buffer-p)
9445 (let (label gc)
9446 (while (or (not label)
9447 (save-excursion
9448 (save-restriction
9449 (widen)
9450 (goto-char (point-min))
9451 (re-search-forward
9452 (regexp-quote (format org-coderef-label-format label))
9453 nil t))))
9454 (when label (message "Label exists already") (sit-for 2))
9455 (setq label (read-string "Code line label: " label)))
9456 (end-of-line 1)
9457 (setq link (format org-coderef-label-format label))
9458 (setq gc (- 79 (length link)))
9459 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9460 (insert link)
9461 (setq link (concat "(" label ")") desc nil)))
9463 ;; We are in the agenda, link to referenced location
9464 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9465 (let ((m (or (get-text-property (point) 'org-hd-marker)
9466 (get-text-property (point) 'org-marker))))
9467 (when m
9468 (org-with-point-at m
9469 (setq agenda-link
9470 (if (org-called-interactively-p 'any)
9471 (call-interactively 'org-store-link)
9472 (org-store-link nil)))))))
9474 ((eq major-mode 'calendar-mode)
9475 (let ((cd (calendar-cursor-to-date)))
9476 (setq link
9477 (format-time-string
9478 (car org-time-stamp-formats)
9479 (apply 'encode-time
9480 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9481 nil nil nil))))
9482 (org-store-link-props :type "calendar" :date cd)))
9484 ((eq major-mode 'help-mode)
9485 (setq link (concat "help:" (save-excursion
9486 (goto-char (point-min))
9487 (looking-at "^[^ ]+")
9488 (match-string 0))))
9489 (org-store-link-props :type "help"))
9491 ((eq major-mode 'w3-mode)
9492 (setq cpltxt (if (and (buffer-name)
9493 (not (string-match "Untitled" (buffer-name))))
9494 (buffer-name)
9495 (url-view-url t))
9496 link (url-view-url t))
9497 (org-store-link-props :type "w3" :url (url-view-url t)))
9499 ((eq major-mode 'image-mode)
9500 (setq cpltxt (concat "file:"
9501 (abbreviate-file-name buffer-file-name))
9502 link cpltxt)
9503 (org-store-link-props :type "image" :file buffer-file-name))
9505 ;; In dired, store a link to the file of the current line
9506 ((eq major-mode 'dired-mode)
9507 (let ((file (dired-get-filename nil t)))
9508 (setq file (if file
9509 (abbreviate-file-name
9510 (expand-file-name (dired-get-filename nil t)))
9511 ;; otherwise, no file so use current directory.
9512 default-directory))
9513 (setq cpltxt (concat "file:" file)
9514 link cpltxt)))
9516 ((setq search (run-hook-with-args-until-success
9517 'org-create-file-search-functions))
9518 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9519 "::" search))
9520 (setq cpltxt (or description link)))
9522 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9523 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9524 (cond
9525 ;; Store a link using the target at point
9527 (setq cpltxt
9528 (concat "file:"
9529 (abbreviate-file-name
9530 (buffer-file-name (buffer-base-buffer)))
9531 "::" (match-string 1))
9532 link cpltxt))
9533 ((and (featurep 'org-id)
9534 (or (eq org-id-link-to-org-use-id t)
9535 (and (org-called-interactively-p 'any)
9536 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9537 (and (eq org-id-link-to-org-use-id
9538 'create-if-interactive-and-no-custom-id)
9539 (not custom-id))))
9540 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9541 ;; Store a link using the ID at point
9542 (setq link (condition-case nil
9543 (prog1 (org-id-store-link)
9544 (setq desc (plist-get org-store-link-plist
9545 :description)))
9546 (error
9547 ;; Probably before first headline, link only to file
9548 (concat "file:"
9549 (abbreviate-file-name
9550 (buffer-file-name (buffer-base-buffer))))))))
9551 (t
9552 ;; Just link to current headline
9553 (setq cpltxt (concat "file:"
9554 (abbreviate-file-name
9555 (buffer-file-name (buffer-base-buffer)))))
9556 ;; Add a context search string
9557 (when (org-xor org-context-in-file-links arg)
9558 (let* ((ee (org-element-at-point))
9559 (et (org-element-type ee))
9560 (ev (plist-get (cadr ee) :value))
9561 (ek (plist-get (cadr ee) :key))
9562 (eok (and (stringp ek) (string-match "name" ek))))
9563 (setq txt (cond
9564 ((org-at-heading-p) nil)
9565 ((and (eq et 'keyword) eok) ev)
9566 ((org-region-active-p)
9567 (buffer-substring (region-beginning) (region-end)))))
9569 (setq cpltxt
9570 (concat cpltxt "::"
9571 (condition-case nil
9572 (org-make-org-heading-search-string txt)
9573 (error "")))
9574 desc (or (and (eq et 'keyword) eok ev)
9575 (nth 4 (ignore-errors (org-heading-components)))
9576 "NONE")))))
9578 (setq cpltxt (substring cpltxt 0 -2)))
9579 (setq link cpltxt))))
9581 ((buffer-file-name (buffer-base-buffer))
9582 ;; Just link to this file here.
9583 (setq cpltxt (concat "file:"
9584 (abbreviate-file-name
9585 (buffer-file-name (buffer-base-buffer)))))
9586 ;; Add a context string.
9587 (when (org-xor org-context-in-file-links arg)
9588 (setq txt (if (org-region-active-p)
9589 (buffer-substring (region-beginning) (region-end))
9590 (buffer-substring (point-at-bol) (point-at-eol))))
9591 ;; Only use search option if there is some text.
9593 (setq cpltxt
9594 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9595 desc "NONE")))
9596 (setq link cpltxt))
9598 ((org-called-interactively-p 'interactive)
9599 (user-error "No method for storing a link from this buffer"))
9601 (t (setq link nil)))
9603 ;; We're done setting link and desc, clean up
9604 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9605 (setq link (or link cpltxt)
9606 desc (or desc cpltxt))
9607 (cond ((equal desc "NONE") (setq desc nil))
9608 ((string-match org-bracket-link-analytic-regexp desc)
9609 (let ((d0 (match-string 3 desc))
9610 (p0 (match-string 5 desc)))
9611 (setq desc
9612 (replace-regexp-in-string
9613 org-bracket-link-regexp
9614 (concat (or p0 d0)
9615 (if (equal (length (match-string 0 desc))
9616 (length desc)) "*" "")) desc)))))
9618 ;; Return the link
9619 (if (not (and (or (org-called-interactively-p 'any)
9620 executing-kbd-macro) link))
9621 (or agenda-link (and link (org-make-link-string link desc)))
9622 (push (list link desc) org-stored-links)
9623 (message "Stored: %s" (or desc link))
9624 (when custom-id
9625 (setq link (concat "file:" (abbreviate-file-name
9626 (buffer-file-name)) "::#" custom-id))
9627 (push (list link desc) org-stored-links)))))))
9629 (defun org-store-link-props (&rest plist)
9630 "Store link properties, extract names and addresses."
9631 (let (x adr)
9632 (when (setq x (plist-get plist :from))
9633 (setq adr (mail-extract-address-components x))
9634 (setq plist (plist-put plist :fromname (car adr)))
9635 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9636 (when (setq x (plist-get plist :to))
9637 (setq adr (mail-extract-address-components x))
9638 (setq plist (plist-put plist :toname (car adr)))
9639 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9640 (let ((from (plist-get plist :from))
9641 (to (plist-get plist :to)))
9642 (when (and from to org-from-is-user-regexp)
9643 (setq plist
9644 (plist-put plist :fromto
9645 (if (string-match org-from-is-user-regexp from)
9646 (concat "to %t")
9647 (concat "from %f"))))))
9648 (setq org-store-link-plist plist))
9650 (defun org-add-link-props (&rest plist)
9651 "Add these properties to the link property list."
9652 (let (key value)
9653 (while plist
9654 (setq key (pop plist) value (pop plist))
9655 (setq org-store-link-plist
9656 (plist-put org-store-link-plist key value)))))
9658 (defun org-email-link-description (&optional fmt)
9659 "Return the description part of an email link.
9660 This takes information from `org-store-link-plist' and formats it
9661 according to FMT (default from `org-email-link-description-format')."
9662 (setq fmt (or fmt org-email-link-description-format))
9663 (let* ((p org-store-link-plist)
9664 (to (plist-get p :toaddress))
9665 (from (plist-get p :fromaddress))
9666 (table
9667 (list
9668 (cons "%c" (plist-get p :fromto))
9669 (cons "%F" (plist-get p :from))
9670 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9671 (cons "%T" (plist-get p :to))
9672 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9673 (cons "%s" (plist-get p :subject))
9674 (cons "%d" (plist-get p :date))
9675 (cons "%m" (plist-get p :message-id)))))
9676 (when (string-match "%c" fmt)
9677 ;; Check if the user wrote this message
9678 (if (and org-from-is-user-regexp from to
9679 (save-match-data (string-match org-from-is-user-regexp from)))
9680 (setq fmt (replace-match "to %t" t t fmt))
9681 (setq fmt (replace-match "from %f" t t fmt))))
9682 (org-replace-escapes fmt table)))
9684 (defun org-make-org-heading-search-string (&optional string)
9685 "Make search string for the current headline or STRING."
9686 (let ((s (or string
9687 (and (derived-mode-p 'org-mode)
9688 (save-excursion
9689 (org-back-to-heading t)
9690 (org-element-property :raw-value (org-element-at-point))))))
9691 (lines org-context-in-file-links))
9692 (or string (setq s (concat "*" s))) ; Add * for headlines
9694 (when (and string (integerp lines) (> lines 0))
9696 (when (< lines (length slines))
9697 (setq s (mapconcat
9698 'identity
9699 (reverse (nthcdr (- (length slines) lines)
9703 (defun org-make-link-string (link &optional description)
9704 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9706 (error "Empty link"))
9707 (when (and description
9708 (stringp description)
9710 (setq description nil))
9711 (when (stringp description)
9712 ;; Remove brackets from the description, they are fatal.
9714 (setq description (replace-match "{" t t description)))
9716 (setq description (replace-match "}" t t description))))
9717 (when (equal link description)
9718 ;; No description needed, it is identical
9719 (setq description nil))
9720 (when (and (not description)
9721 (not (string-match (org-image-file-name-regexp) link))
9722 (not (equal link (org-link-escape link))))
9723 (setq description (org-extract-attributes link)))
9724 (setq link
9725 (cond ((string-match (org-image-file-name-regexp) link) link)
9726 ((string-match org-link-types-re link)
9727 (concat (match-string 1 link)
9728 (org-link-escape (substring link (match-end 1)))))
9729 (t (org-link-escape link))))
9730 (concat "[[" link "]"
9731 (if description (concat "[" description "]") "")
9732 "]"))
9734 (defconst org-link-escape-chars
9735 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9736 "List of characters that should be escaped in link.
9737 This is the list that is used for internal purposes.")
9739 (defconst org-link-escape-chars-browser
9741 "List of escapes for characters that are problematic in links.
9742 This is the list that is used before handing over to the browser.")
9744 (defun org-link-escape (text &optional table merge)
9745 "Return percent escaped representation of TEXT.
9746 TEXT is a string with the text to escape.
9747 Optional argument TABLE is a list with characters that should be
9748 escaped. When nil, `org-link-escape-chars' is used.
9749 If optional argument MERGE is set, merge TABLE into
9750 `org-link-escape-chars'."
9751 (cond
9752 ((and table merge)
9753 (mapc (lambda (defchr)
9754 (unless (member defchr table)
9755 (setq table (cons defchr table)))) org-link-escape-chars))
9756 ((null table)
9757 (setq table org-link-escape-chars)))
9758 (mapconcat
9759 (lambda (char)
9760 (if (or (member char table)
9761 (and (or (< char 32) (= char 37) (> char 126))
9762 org-url-hexify-p))
9763 (mapconcat (lambda (sequence-element)
9764 (format "%%%.2X" sequence-element))
9765 (or (encode-coding-char char 'utf-8)
9766 (error "Unable to percent escape character: %s"
9767 (char-to-string char))) "")
9768 (char-to-string char))) text ""))
9770 (defun org-link-unescape (str)
9771 "Unhex hexified Unicode strings as returned from the JavaScript function
9772 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9773 (unless (and (null str) (string= "" str))
9774 (let ((pos 0) (case-fold-search t) unhexed)
9776 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9777 (setq str (replace-match unhexed t t str))
9778 (setq pos (+ pos (length unhexed))))))
9779 str)
9781 (defun org-link-unescape-compound (hex)
9782 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9783 Note: this function also decodes single byte encodings like
9784 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9785 (save-match-data
9786 (let* ((bytes (cdr (split-string hex "%")))
9787 (ret "")
9788 (eat 0)
9789 (sum 0))
9790 (while bytes
9791 (let* ((val (string-to-number (pop bytes) 16))
9792 (shift-xor
9793 (if (= 0 eat)
9794 (cond
9795 ((>= val 252) (cons 6 252))
9796 ((>= val 248) (cons 5 248))
9797 ((>= val 240) (cons 4 240))
9798 ((>= val 224) (cons 3 224))
9799 ((>= val 192) (cons 2 192))
9800 (t (cons 0 0)))
9801 (cons 6 128))))
9802 (if (>= val 192) (setq eat (car shift-xor)))
9803 (setq val (logxor val (cdr shift-xor)))
9804 (setq sum (+ (lsh sum (car shift-xor)) val))
9805 (if (> eat 0) (setq eat (- eat 1)))
9806 (cond
9807 ((= 0 eat) ;multi byte
9808 (setq ret (concat ret (org-char-to-string sum)))
9809 (setq sum 0))
9810 ((not bytes) ; single byte(s)
9811 (setq ret (org-link-unescape-single-byte-sequence hex))))
9812 )) ;; end (while bytes
9813 ret )))
9815 (defun org-link-unescape-single-byte-sequence (hex)
9816 "Unhexify hex-encoded single byte character sequences."
9817 (mapconcat (lambda (byte)
9818 (char-to-string (string-to-number byte 16)))
9819 (cdr (split-string hex "%")) ""))
9821 (defun org-xor (a b)
9822 "Exclusive or."
9823 (if a (not b) b))
9825 (defun org-fixup-message-id-for-http (s)
9826 "Replace special characters in a message id, so it can be used in an http query."
9827 (when (string-match "%" s)
9828 (setq s (mapconcat (lambda (c)
9829 (if (eq c ?%)
9830 "%25"
9831 (char-to-string c)))
9832 s "")))
9833 (while (string-match "<" s)
9834 (setq s (replace-match "%3C" t t s)))
9835 (while (string-match ">" s)
9836 (setq s (replace-match "%3E" t t s)))
9837 (while (string-match "@" s)
9838 (setq s (replace-match "%40" t t s)))
9839 s)
9841 (defun org-link-prettify (link)
9842 "Return a human-readable representation of LINK.
9843 The car of LINK must be a raw link the cdr of LINK must be either
9844 a link description or nil."
9845 (let ((desc (or (cadr link) "<no description>")))
9846 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9847 "<" (car link) ">")))
9849 ;;;###autoload
9850 (defun org-insert-link-global ()
9851 "Insert a link like Org-mode does.
9852 This command can be called in any mode to insert a link in Org-mode syntax."
9853 (interactive)
9854 (org-load-modules-maybe)
9855 (org-run-like-in-org-mode 'org-insert-link))
9857 (defun org-insert-all-links (&optional keep)
9858 "Insert all links in `org-stored-links'."
9859 (interactive "P")
9860 (let ((links (copy-sequence org-stored-links)) l)
9861 (while (setq l (if keep (pop links) (pop org-stored-links)))
9862 (insert "- ")
9863 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9866 (defun org-link-fontify-links-to-this-file ()
9867 "Fontify links to the current file in `org-stored-links'."
9868 (let ((f (buffer-file-name)) a b)
9869 (setq a (mapcar (lambda(l)
9870 (let ((ll (car l)))
9872 (equal f (expand-file-name (match-string 1 ll))))
9873 ll)))
9874 org-stored-links))
9875 (when (featurep 'org-id)
9876 (setq b (mapcar (lambda(l)
9877 (let ((ll (car l)))
9879 (equal f (expand-file-name
9880 (or (org-id-find-id-file
9881 (match-string 1 ll)) ""))))
9882 ll)))
9883 org-stored-links)))
9884 (mapcar (lambda(l)
9885 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9886 (delq nil (append a b)))))
9888 (defvar org-link-links-in-this-file nil)
9889 (defun org-insert-link (&optional complete-file link-location default-description)
9890 "Insert a link. At the prompt, enter the link.
9892 Completion can be used to insert any of the link protocol prefixes like
9893 http or ftp in use.
9895 The history can be used to select a link previously stored with
9896 `org-store-link'. When the empty string is entered (i.e. if you just
9897 press RET at the prompt), the link defaults to the most recently
9898 stored link. As SPC triggers completion in the minibuffer, you need to
9899 use M-SPC or C-q SPC to force the insertion of a space character.
9901 You will also be prompted for a description, and if one is given, it will
9902 be displayed in the buffer instead of the link.
9904 If there is already a link at point, this command will allow you to edit link
9905 and description parts.
9908 be selected using completion. The path to the file will be relative to the
9909 current directory if the file is in the current directory or a subdirectory.
9910 Otherwise, the link will be the absolute path as completed in the minibuffer
9911 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9912 option `org-link-file-path-type'.
9915 the current directory or below.
9918 `org-keep-stored-link-after-insertion'.
9920 If `org-make-link-description-function' is non-nil, this function will be
9921 called with the link target, and the result will be the default
9922 link description.
9924 If the LINK-LOCATION parameter is non-nil, this value will be
9925 used as the link location instead of reading one interactively.
9927 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9928 be used as the default description."
9929 (interactive "P")
9930 (let* ((wcf (current-window-configuration))
9931 (origbuf (current-buffer))
9932 (region (if (org-region-active-p)
9933 (buffer-substring (region-beginning) (region-end))))
9934 (remove (and region (list (region-beginning) (region-end))))
9935 (desc region)
9936 tmphist ; byte-compile incorrectly complains about this
9937 (link link-location)
9938 (abbrevs org-link-abbrev-alist-local)
9939 entry file all-prefixes auto-desc)
9940 (cond
9941 (link-location) ; specified by arg, just use it.
9942 ((org-in-regexp org-bracket-link-regexp 1)
9943 ;; We do have a link at point, and we are going to edit it.
9944 (setq remove (list (match-beginning 0) (match-end 0)))
9945 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9946 (setq link (read-string "Link: "
9947 (org-link-unescape
9948 (org-match-string-no-properties 1)))))
9949 ((or (org-in-regexp org-angle-link-re)
9950 (org-in-regexp org-plain-link-re))
9951 ;; Convert to bracket link
9952 (setq remove (list (match-beginning 0) (match-end 0))
9953 link (read-string "Link: "
9954 (org-remove-angle-brackets (match-string 0)))))
9955 ((member complete-file '((4) (16)))
9956 ;; Completing read for file names.
9957 (setq link (org-file-complete-link complete-file)))
9958 (t
9959 ;; Read link, with completion for stored links.
9960 (org-link-fontify-links-to-this-file)
9961 (org-switch-to-buffer-other-window "*Org Links*")
9962 (with-current-buffer "*Org Links*"
9963 (erase-buffer)
9964 (insert "Insert a link.
9966 (when org-stored-links
9968 (insert (mapconcat 'org-link-prettify
9970 (goto-char (point-min)))
9971 (let ((cw (selected-window)))
9972 (select-window (get-buffer-window "*Org Links*" 'visible))
9973 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9974 (unless (pos-visible-in-window-p (point-max))
9975 (org-fit-window-to-buffer))
9976 (and (window-live-p cw) (select-window cw)))
9977 ;; Fake a link history, containing the stored links.
9978 (setq tmphist (append (mapcar 'car org-stored-links)
9979 org-insert-link-history))
9980 (setq all-prefixes (append (mapcar 'car abbrevs)
9981 (mapcar 'car org-link-abbrev-alist)
9982 org-link-types))
9983 (unwind-protect
9984 (progn
9985 (setq link
9986 (org-completing-read
9987 "Link: "
9988 (append
9989 (mapcar (lambda (x) (concat x ":"))
9990 all-prefixes)
9991 (mapcar 'car org-stored-links))
9992 nil nil nil
9993 'tmphist
9994 (caar org-stored-links)))
9996 (user-error "No link selected"))
9997 (mapc (lambda(l)
9998 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9999 org-stored-links)
10000 (if (or (member link all-prefixes)
10001 (and (equal ":" (substring link -1))
10002 (member (substring link 0 -1) all-prefixes)
10003 (setq link (substring link 0 -1))))
10004 (setq link (with-current-buffer origbuf
10005 (org-link-try-special-completion link)))))
10006 (set-window-configuration wcf)
10007 (kill-buffer "*Org Links*"))
10008 (setq entry (assoc link org-stored-links))
10009 (or entry (push link org-insert-link-history))
10010 (setq desc (or desc (nth 1 entry)))))
10012 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10013 (not org-keep-stored-link-after-insertion))
10014 (setq org-stored-links (delq (assoc link org-stored-links)
10015 org-stored-links)))
10017 (if (string-match org-plain-link-re link)
10018 ;; URL-like link, normalize the use of angular brackets.
10019 (setq link (org-remove-angle-brackets link)))
10021 ;; Check if we are linking to the current file with a search
10022 ;; option If yes, simplify the link by using only the search
10023 ;; option.
10024 (when (and buffer-file-name
10026 (let* ((path (match-string 1 link))
10027 (case-fold-search nil)
10028 (search (match-string 2 link)))
10029 (save-match-data
10030 (if (equal (file-truename buffer-file-name) (file-truename path))
10031 ;; We are linking to this same file, with a search option
10032 (setq link search)))))
10034 ;; Check if we can/should use a relative path. If yes, simplify the link
10036 (let* ((type (match-string 1 link))
10037 (path (match-string 2 link))
10038 (origpath path)
10039 (case-fold-search nil))
10040 (cond
10041 ((or (eq org-link-file-path-type 'absolute)
10042 (equal complete-file '(16)))
10043 (setq path (abbreviate-file-name (expand-file-name path))))
10044 ((eq org-link-file-path-type 'noabbrev)
10045 (setq path (expand-file-name path)))
10046 ((eq org-link-file-path-type 'relative)
10047 (setq path (file-relative-name path)))
10048 (t
10049 (save-match-data
10050 (if (string-match (concat "^" (regexp-quote
10051 (expand-file-name
10052 (file-name-as-directory
10053 default-directory))))
10054 (expand-file-name path))
10055 ;; We are linking a file with relative path name.
10056 (setq path (substring (expand-file-name path)
10057 (match-end 0)))
10058 (setq path (abbreviate-file-name (expand-file-name path)))))))
10059 (setq link (concat type path))
10060 (if (equal desc origpath)
10061 (setq desc path))))
10063 (if org-make-link-description-function
10064 (setq desc
10065 (or (condition-case nil
10066 (funcall org-make-link-description-function link desc)
10067 (error (progn (message "Can't get link description from `%s'"
10068 (symbol-name org-make-link-description-function))
10069 (sit-for 2) nil)))
10070 (read-string "Description: " default-description)))
10071 (if default-description (setq desc default-description)
10072 (setq desc (or (and auto-desc desc)
10073 (read-string "Description: " desc)))))
10076 (if remove (apply 'delete-region remove))
10077 (insert (org-make-link-string link desc))))
10079 (defun org-link-try-special-completion (type)
10080 "If there is completion support for link type TYPE, offer it."
10081 (let ((fun (intern (concat "org-" type "-complete-link"))))
10082 (if (functionp fun)
10083 (funcall fun)
10084 (read-string "Link (no completion support): " (concat type ":")))))
10086 (defun org-file-complete-link (&optional arg)
10087 "Create a file link using completion."
10088 (let (file link)
10089 (setq file (org-iread-file-name "File: "))
10090 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10091 (pwd1 (file-name-as-directory (abbreviate-file-name
10092 (expand-file-name ".")))))
10093 (cond
10094 ((equal arg '(16))
10095 (setq link (concat
10096 "file:"
10097 (abbreviate-file-name (expand-file-name file)))))
10099 (setq link (concat "file:" (match-string 1 file))))
10101 (expand-file-name file))
10102 (setq link (concat
10103 "file:" (match-string 1 (expand-file-name file)))))
10104 (t (setq link (concat "file:" file)))))
10105 link))
10107 (defun org-iread-file-name (&rest args)
10108 "Read-file-name using `ido-mode' speedup if available.
10109 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10110 See `read-file-name' for a description of parameters."
10111 (org-without-partial-completion
10112 (if (and org-completion-use-ido
10113 (fboundp 'ido-read-file-name)
10114 (boundp 'ido-mode) ido-mode
10115 (listp (second args)))
10116 (let ((ido-enter-matching-directory nil))
10117 (apply 'ido-read-file-name args))
10118 (apply 'read-file-name args))))
10120 (defun org-completing-read (&rest args)
10121 "Completing-read with SPACE being a normal character."
10122 (let ((enable-recursive-minibuffers t)
10123 (minibuffer-local-completion-map
10124 (copy-keymap minibuffer-local-completion-map)))
10125 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10126 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10127 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10128 (apply 'org-icompleting-read args)))
10130 (defun org-completing-read-no-i (&rest args)
10131 (let (org-completion-use-ido org-completion-use-iswitchb)
10132 (apply 'org-completing-read args)))
10134 (defun org-iswitchb-completing-read (prompt choices &rest args)
10135 "Use iswitch as a completing-read replacement to choose from choices.
10136 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10137 from."
10138 (let* ((iswitchb-use-virtual-buffers nil)
10139 (iswitchb-make-buflist-hook
10140 (lambda ()
10141 (setq iswitchb-temp-buflist choices))))
10142 (iswitchb-read-buffer prompt)))
10144 (defun org-icompleting-read (&rest args)
10145 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10146 (org-without-partial-completion
10147 (if (and org-completion-use-ido
10148 (fboundp 'ido-completing-read)
10149 (boundp 'ido-mode) ido-mode
10150 (listp (second args)))
10151 (let ((ido-enter-matching-directory nil))
10152 (apply 'ido-completing-read (concat (car args))
10153 (if (consp (car (nth 1 args)))
10154 (mapcar 'car (nth 1 args))
10155 (nth 1 args))
10156 (cddr args)))
10157 (if (and org-completion-use-iswitchb
10158 (boundp 'iswitchb-mode) iswitchb-mode
10159 (listp (second args)))
10160 (apply 'org-iswitchb-completing-read (concat (car args))
10161 (if (consp (car (nth 1 args)))
10162 (mapcar 'car (nth 1 args))
10163 (nth 1 args))
10164 (cddr args))
10165 (apply 'completing-read args)))))
10167 (defun org-extract-attributes (s)
10168 "Extract the attributes cookie from a string and set as text property."
10169 (let (a attr (start 0) key value)
10170 (save-match-data
10172 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10174 (setq key (match-string 1 a) value (match-string 2 a)
10175 start (match-end 0)
10176 attr (plist-put attr (intern key) value))))
10177 (org-add-props s nil 'org-attr attr))
10178 s))
10180 ;;; Opening/following a link
10182 (defvar org-link-search-failed nil)
10184 (defvar org-open-link-functions nil
10185 "Hook for functions finding a plain text link.
10186 These functions must take a single argument, the link content.
10187 They will be called for links that look like [[link text][description]]
10191 These functions will be called *before* Org attempts to resolve the
10192 link by doing text searches in the current buffer - so if you want a
10194 handle this as a special case.
10196 When the function does handle the link, it must return a non-nil value.
10197 If it decides that it is not responsible for this link, it must return
10198 nil to indicate that that Org-mode can continue with other options
10199 like exact and fuzzy text search.")
10201 (defun org-next-link (&optional search-backward)
10202 "Move forward to the next link.
10203 If the link is in hidden text, expose it."
10204 (interactive "P")
10205 (when (and org-link-search-failed (eq this-command last-command))
10206 (goto-char (point-min))
10207 (message "Link search wrapped back to beginning of buffer"))
10208 (setq org-link-search-failed nil)
10209 (let* ((pos (point))
10210 (ct (org-context))
10211 (a (assoc :link ct))
10212 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10213 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10214 ((looking-at org-any-link-re)
10215 ;; Don't stay stuck at link without an org-link face
10216 (forward-char (if search-backward -1 1))))
10217 (if (funcall srch-fun org-any-link-re nil t)
10218 (progn
10219 (goto-char (match-beginning 0))
10220 (if (outline-invisible-p) (org-show-context)))
10221 (goto-char pos)
10222 (setq org-link-search-failed t)
10223 (message "No further link found"))))
10225 (defun org-previous-link ()
10226 "Move backward to the previous link.
10227 If the link is in hidden text, expose it."
10228 (interactive)
10229 (funcall 'org-next-link t))
10231 (defun org-translate-link (s)
10232 "Translate a link string if a translation function has been defined."
10233 (if (and org-link-translation-function
10234 (fboundp org-link-translation-function)
10236 (progn
10237 (setq s (funcall org-link-translation-function
10238 (match-string 1 s) (match-string 2 s)))
10239 (concat (car s) ":" (cdr s)))
10240 s))
10242 (defun org-translate-link-from-planner (type path)
10243 "Translate a link from Emacs Planner syntax so that Org can follow it.
10244 This is still an experimental function, your mileage may vary."
10245 (cond
10246 ((member type '("http" "https" "news" "ftp"))
10247 ;; standard Internet links are the same.
10248 nil)
10249 ((and (equal type "irc") (string-match "^//" path))
10250 ;; Planner has two / at the beginning of an irc link, we have 1.
10251 ;; We should have zero, actually....
10252 (setq path (substring path 1)))
10253 ((and (equal type "lisp") (string-match "^/" path))
10254 ;; Planner has a slash, we do not.
10255 (setq type "elisp" path (substring path 1)))
10257 ;; A typical message link. Planner has the id after the final slash,
10258 ;; we separate it with a hash mark
10259 (setq path (concat (match-string 1 path) "#"
10260 (org-remove-angle-brackets (match-string 2 path))))))
10261 (cons type path))
10263 (defun org-find-file-at-mouse (ev)
10264 "Open file link or URL at mouse."
10265 (interactive "e")
10266 (mouse-set-point ev)
10267 (org-open-at-point 'in-emacs))
10269 (defun org-open-at-mouse (ev)
10270 "Open file link or URL at mouse.
10271 See the docstring of `org-open-file' for details."
10272 (interactive "e")
10273 (mouse-set-point ev)
10274 (if (eq major-mode 'org-agenda-mode)
10275 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10276 (org-open-at-point))
10278 (defvar org-window-config-before-follow-link nil
10279 "The window configuration before following a link.
10280 This is saved in case the need arises to restore it.")
10282 (defvar org-open-link-marker (make-marker)
10283 "Marker pointing to the location where `org-open-at-point; was called.")
10285 ;;;###autoload
10286 (defun org-open-at-point-global ()
10287 "Follow a link like Org-mode does.
10288 This command can be called in any mode to follow a link that has
10289 Org-mode syntax."
10290 (interactive)
10291 (org-run-like-in-org-mode 'org-open-at-point))
10293 ;;;###autoload
10294 (defun org-open-link-from-string (s &optional arg reference-buffer)
10295 "Open a link in the string S, as if it was in Org-mode."
10297 (let ((reference-buffer (or reference-buffer (current-buffer))))
10298 (with-temp-buffer
10299 (let ((org-inhibit-startup (not reference-buffer)))
10300 (org-mode)
10301 (insert s)
10302 (goto-char (point-min))
10303 (when reference-buffer
10304 (setq org-link-abbrev-alist-local
10305 (with-current-buffer reference-buffer
10306 org-link-abbrev-alist-local)))
10307 (org-open-at-point arg reference-buffer)))))
10309 (defvar org-open-at-point-functions nil
10310 "Hook that is run when following a link at point.
10312 Functions in this hook must return t if they identify and follow
10313 a link at point. If they don't find anything interesting at point,
10314 they must return nil.")
10316 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10317 (defun org-open-at-point (&optional arg reference-buffer)
10318 "Open link at or after point.
10319 If there is no link at point, this function will search forward up to
10320 the end of the current line.
10321 Normally, files will be opened by an appropriate application. If the
10322 optional prefix argument ARG is non-nil, Emacs will visit the file.
10323 With a double prefix argument, try to open outside of Emacs, in the
10324 application the system uses for this file type."
10325 (interactive "P")
10326 ;; if in a code block, then open the block's results
10327 (unless (call-interactively #'org-babel-open-src-block-result)
10328 (org-load-modules-maybe)
10329 (move-marker org-open-link-marker (point))
10330 (setq org-window-config-before-follow-link (current-window-configuration))
10331 (org-remove-occur-highlights nil nil t)
10332 (cond
10333 ((and (org-at-heading-p)
10334 (not (org-at-timestamp-p t))
10335 (not (org-in-regexp
10340 (not (get-text-property (point) 'org-linked-text)))
10341 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10342 (lk0 (car lkall))
10343 (lk (if (stringp lk0) (list lk0) lk0))
10344 (lkend (cdr lkall)))
10345 (mapcar (lambda(l)
10346 (search-forward l nil lkend)
10347 (goto-char (match-beginning 0))
10348 (org-open-at-point))
10349 lk))
10350 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10351 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10352 ((and (org-at-timestamp-p t)
10353 (not (org-in-regexp org-bracket-link-regexp)))
10354 (org-follow-timestamp-link))
10355 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10356 (not (org-in-regexp org-any-link-re)))
10357 (org-footnote-action))
10358 (t
10359 (let (type path link line search (pos (point)))
10360 (catch 'match
10361 (save-excursion
10363 (when (org-in-regexp org-bracket-link-regexp 1)
10364 (setq link (org-extract-attributes
10365 (org-link-unescape (org-match-string-no-properties 1))))
10367 (setq link (replace-match " " t t link)))
10368 (setq link (org-link-expand-abbrev link))
10369 (cond
10370 ((or (file-name-absolute-p link)
10372 (setq type "file" path link))
10373 ((string-match org-link-re-with-space3 link)
10374 (setq type (match-string 1 link) path (match-string 2 link)))
10376 (setq type "help" path (match-string 1 link)))
10377 (t (setq type "thisfile" path link)))
10378 (throw 'match t)))
10380 (when (get-text-property (point) 'org-linked-text)
10381 (setq type "thisfile"
10382 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10383 (1+ (point)) (point))
10384 path (buffer-substring
10385 (or (previous-single-property-change pos 'org-linked-text)
10386 (point-min))
10387 (or (next-single-property-change pos 'org-linked-text)
10388 (point-max)))
10389 ;; Ensure we will search for a <<<radio>>> link, not
10390 ;; a simple reference like <<ref>>
10391 path (concat "<" path))
10392 (throw 'match t))
10394 (save-excursion
10395 (when (or (org-in-regexp org-angle-link-re)
10396 (let ((match (org-in-regexp org-plain-link-re)))
10397 ;; Check a plain link is not within a bracket link
10398 (and match
10399 (save-excursion
10400 (progn
10401 (goto-char (car match))
10402 (not (org-in-regexp org-bracket-link-regexp))))))
10403 (let ((line_ending (save-excursion (end-of-line) (point))))
10404 ;; We are in a line before a plain or bracket link
10405 (or (re-search-forward org-plain-link-re line_ending t)
10406 (re-search-forward org-bracket-link-regexp line_ending t))))
10407 (setq type (match-string 1)
10408 path (org-link-unescape (match-string 2)))
10409 (throw 'match t)))
10410 (save-excursion
10412 (setq type "tags"
10413 path (match-string 1))
10414 (while (string-match ":" path)
10415 (setq path (replace-match "+" t t path)))
10416 (throw 'match t)))
10418 (setq type "tree-match"
10419 path (match-string 1))
10420 (throw 'match t)))
10421 (unless path
10422 (user-error "No link found"))
10424 ;; switch back to reference buffer
10425 ;; needed when if called in a temporary buffer through
10426 ;; org-open-link-from-string
10427 (with-current-buffer (or reference-buffer (current-buffer))
10429 ;; Remove any trailing spaces in path
10431 (setq path (replace-match "" t t path)))
10432 (if (and org-link-translation-function
10433 (fboundp org-link-translation-function))
10434 ;; Check if we need to translate the link
10435 (let ((tmp (funcall org-link-translation-function type path)))
10436 (setq type (car tmp) path (cdr tmp))))
10438 (cond
10440 ((assoc type org-link-protocols)
10441 (funcall (nth 1 (assoc type org-link-protocols)) path))
10443 ((equal type "help")
10444 (let ((f-or-v (intern path)))
10445 (cond ((fboundp f-or-v)
10446 (describe-function f-or-v))
10447 ((boundp f-or-v)
10448 (describe-variable f-or-v))
10449 (t (error "Not a known function or variable")))))
10451 ((equal type "mailto")
10452 (let ((cmd (car org-link-mailto-program))
10453 (args (cdr org-link-mailto-program)) args1
10454 (address path) (subject "") a)
10456 (setq address (match-string 1 path)
10457 subject (org-link-escape (match-string 2 path))))
10458 (while args
10459 (cond
10460 ((not (stringp (car args))) (push (pop args) args1))
10461 (t (setq a (pop args))
10462 (if (string-match "%a" a)
10463 (setq a (replace-match address t t a)))
10464 (if (string-match "%s" a)
10465 (setq a (replace-match subject t t a)))
10466 (push a args1))))
10467 (apply cmd (nreverse args1))))
10469 ((member type '("http" "https" "ftp" "news"))
10470 (browse-url
10471 (concat type ":"
10472 (if (org-string-match-p
10473 (concat "[[:nonascii:]"
10474 org-link-escape-chars-browser "]")
10475 path)
10476 (org-link-escape path org-link-escape-chars-browser)
10477 path))))
10479 ((string= type "doi")
10480 (browse-url
10481 (concat org-doi-server-url
10482 (if (org-string-match-p
10483 (concat "[[:nonascii:]"
10484 org-link-escape-chars-browser "]")
10485 path)
10486 (org-link-escape path org-link-escape-chars-browser)
10487 path))))
10489 ((member type '("message"))
10490 (browse-url (concat type ":" path)))
10492 ((string= type "tags")
10493 (org-tags-view arg path))
10495 ((string= type "tree-match")
10498 ((string= type "file")
10500 (setq line (string-to-number (match-string 1 path))
10501 path (substring path 0 (match-beginning 0)))
10503 (setq search (match-string 1 path)
10504 path (substring path 0 (match-beginning 0)))))
10505 (if (string-match "[*?{]" (file-name-nondirectory path))
10506 (dired path)
10507 (org-open-file path arg line search)))
10509 ((string= type "shell")
10510 (let ((buf (generate-new-buffer "*Org Shell Output"))
10511 (cmd path))
10512 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10513 (string-match org-confirm-shell-link-not-regexp cmd))
10514 (not org-confirm-shell-link-function)
10515 (funcall org-confirm-shell-link-function
10517 (org-add-props cmd nil
10518 'face 'org-warning))))
10519 (progn
10520 (message "Executing %s" cmd)
10521 (shell-command cmd buf)
10522 (if (featurep 'midnight)
10523 (setq clean-buffer-list-kill-buffer-names
10524 (cons buf clean-buffer-list-kill-buffer-names))))
10525 (error "Abort"))))
10527 ((string= type "elisp")
10528 (let ((cmd path))
10529 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10530 (string-match org-confirm-elisp-link-not-regexp cmd))
10531 (not org-confirm-elisp-link-function)
10532 (funcall org-confirm-elisp-link-function
10534 (org-add-props cmd nil
10535 'face 'org-warning))))
10536 (message "%s => %s" cmd
10537 (if (equal (string-to-char cmd) ?\()
10538 (eval (read cmd))
10539 (call-interactively (read cmd))))
10540 (error "Abort"))))
10542 ((and (string= type "thisfile")
10543 (run-hook-with-args-until-success
10544 'org-open-link-functions path)))
10546 ((string= type "thisfile")
10547 (if arg
10548 (switch-to-buffer-other-window
10549 (org-get-buffer-for-internal-link (current-buffer)))
10550 (org-mark-ring-push))
10551 (let ((cmd `(org-link-search
10552 ,path
10553 ,(cond ((equal arg '(4)) ''occur)
10554 ((equal arg '(16)) ''org-occur))
10555 ,pos)))
10556 (condition-case nil (let ((org-link-search-inhibit-query t))
10557 (eval cmd))
10558 (error (progn (widen) (eval cmd))))))
10560 (t (browse-url-at-point)))))))
10561 (move-marker org-open-link-marker nil)
10562 (run-hook-with-args 'org-follow-link-hook)))
10564 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10565 "Offer links in the current entry and return the selected link.
10566 If there is only one link, return it.
10567 If NTH is an integer, return the NTH link found.
10568 If ZERO is a string, check also this string for a link, and if
10569 there is one, return it."
10570 (with-current-buffer buffer
10571 (save-excursion
10572 (save-restriction
10573 (widen)
10574 (goto-char marker)
10578 (cnt ?0)
10579 (in-emacs (if (integerp nth) nil nth))
10580 have-zero end links link c)
10581 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10582 (push (match-string 0 zero) links)
10583 (setq cnt (1- cnt) have-zero t))
10584 (save-excursion
10585 (org-back-to-heading t)
10586 (setq end (save-excursion (outline-next-heading) (point)))
10587 (while (re-search-forward re end t)
10588 (push (match-string 0) links))
10589 (setq links (org-uniquify (reverse links))))
10590 (cond
10591 ((null links)
10592 (message "No links"))
10593 ((equal (length links) 1)
10594 (setq link (car links)))
10595 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10596 (setq link (nth (if have-zero nth (1- nth)) links)))
10597 (t ; we have to select a link
10598 (save-excursion
10599 (save-window-excursion
10600 (delete-other-windows)
10601 (with-output-to-temp-buffer "*Select Link*"
10602 (mapc (lambda (l)
10603 (if (not (string-match org-bracket-link-regexp l))
10605 (org-remove-angle-brackets l)))
10606 (if (match-end 3)
10608 (match-string 3 l) (match-string 1 l)))
10610 (match-string 1 l))))))
10611 links))
10612 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10613 (message "Select link to open, RET to open all:")
10614 (setq c (read-char-exclusive))
10615 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10616 (when (equal c ?q) (error "Abort"))
10617 (if (equal c ?\C-m)
10618 (setq link links)
10619 (setq nth (- c ?0))
10620 (if have-zero (setq nth (1+ nth)))
10621 (unless (and (integerp nth) (>= (length links) nth))
10622 (user-error "Invalid link selection"))
10623 (setq link (nth (1- nth) links)))))
10624 (cons link end))))))
10626 ;; Add special file links that specify the way of opening
10628 (org-add-link-type "file+sys" 'org-open-file-with-system)
10629 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10630 (defun org-open-file-with-system (path)
10631 "Open file at PATH using the system way of opening it."
10632 (org-open-file path 'system))
10633 (defun org-open-file-with-emacs (path)
10634 "Open file at PATH in Emacs."
10635 (org-open-file path 'emacs))
10638 ;;; File search
10640 (defvar org-create-file-search-functions nil
10641 "List of functions to construct the right search string for a file link.
10642 These functions are called in turn with point at the location to
10643 which the link should point.
10645 A function in the hook should first test if it would like to
10646 handle this file type, for example by checking the `major-mode'
10647 or the file extension. If it decides not to handle this file, it
10648 should just return nil to give other functions a chance. If it
10649 does handle the file, it must return the search string to be used
10650 when following the link. The search string will be part of the
10651 file link, given after a double colon, and `org-open-at-point'
10652 will automatically search for it. If special measures must be
10653 taken to make the search successful, another function should be
10654 added to the companion hook `org-execute-file-search-functions',
10655 which see.
10657 A function in this hook may also use `setq' to set the variable
10658 `description' to provide a suggestion for the descriptive text to
10659 be used for this link when it gets inserted into an Org-mode
10662 (defvar org-execute-file-search-functions nil
10663 "List of functions to execute a file search triggered by a link.
10665 Functions added to this hook must accept a single argument, the
10666 search string that was part of the file link, the part after the
10667 double colon. The function must first check if it would like to
10668 handle this search, for example by checking the `major-mode' or
10669 the file extension. If it decides not to handle this search, it
10670 should just return nil to give other functions a chance. If it
10671 does handle the search, it must return a non-nil value to keep
10672 other functions from trying.
10674 Each function can access the current prefix argument through the
10675 variable `current-prefix-arg'. Note that a single prefix is used
10676 to force opening a link in Emacs, so it may be good to only use a
10677 numeric or double prefix to guide the search function.
10679 In case this is needed, a function in this hook can also restore
10680 the window configuration before `org-open-at-point' was called using:
10682 (set-window-configuration org-window-config-before-follow-link)")
10684 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10685 (defun org-link-search (s &optional type avoid-pos stealth)
10686 "Search for a link search option.
10687 If S is surrounded by forward slashes, it is interpreted as a
10688 regular expression. In org-mode files, this will create an `org-occur'
10689 sparse tree. In ordinary files, `occur' will be used to list matches.
10690 If the current buffer is in `dired-mode', grep will be used to search
10691 in all files. If AVOID-POS is given, ignore matches near that position.
10693 When optional argument STEALTH is non-nil, do not modify
10694 visibility around point, thus ignoring
10695 `org-show-hierarchy-above', `org-show-following-heading' and
10696 `org-show-siblings' variables."
10697 (let ((case-fold-search t)
10701 org-emphasis-alist)
10703 (pos (point))
10704 (pre nil) (post nil)
10705 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10706 (cond
10707 ;; First check if there are any special search functions
10708 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10709 ;; Now try the builtin stuff
10710 ((and (equal (string-to-char s0) ?#)
10711 (> (length s0) 1)
10712 (save-excursion
10713 (goto-char (point-min))
10714 (and
10715 (re-search-forward
10718 (setq type 'dedicated
10719 pos (match-beginning 0))))
10720 ;; There is an exact target for this
10721 (goto-char pos)
10722 (org-back-to-heading t)))
10723 ((save-excursion
10724 (goto-char (point-min))
10725 (and
10726 (re-search-forward
10727 (concat "<<" (regexp-quote s0) ">>") nil t)
10728 (setq type 'dedicated
10729 pos (match-beginning 0))))
10730 ;; There is an exact target for this
10731 (goto-char pos))
10732 ((save-excursion
10733 (goto-char (point-min))
10734 (and
10735 (re-search-forward
10737 (setq type 'dedicated pos (match-beginning 0))))
10738 ;; Found an element with a matching #+name affiliated keyword.
10739 (goto-char pos))
10741 (save-excursion
10742 (goto-char (point-min))
10743 (and
10744 (re-search-forward
10745 (concat "[^[]" (regexp-quote
10746 (format org-coderef-label-format
10747 (match-string 1 s0))))
10748 nil t)
10749 (setq type 'dedicated
10750 pos (1+ (match-beginning 0))))))
10751 ;; There is a coderef target for this
10752 (goto-char pos))
10754 ;; A regular expression
10755 (cond
10756 ((derived-mode-p 'org-mode)
10757 (org-occur (match-string 1 s)))
10758 (t (org-do-occur (match-string 1 s)))))
10759 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10760 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10761 (goto-char (point-min))
10762 (cond
10763 ((let (case-fold-search)
10764 (re-search-forward (format org-complex-heading-regexp-format
10765 (regexp-quote s))
10766 nil t))
10767 ;; OK, found a match
10768 (setq type 'dedicated)
10769 (goto-char (match-beginning 0)))
10770 ((and (not org-link-search-inhibit-query)
10771 (eq org-link-search-must-match-exact-headline 'query-to-create)
10772 (y-or-n-p "No match - create this as a new heading? "))
10773 (goto-char (point-max))
10774 (or (bolp) (newline))
10776 (beginning-of-line 0))
10777 (t
10778 (goto-char pos)
10779 (error "No match"))))
10780 (t
10781 ;; A normal search string
10782 (when (equal (string-to-char s) ?*)
10783 ;; Anchor on headlines, post may include tags.
10786 s (substring s 1)))
10787 (remove-text-properties
10788 0 (length s)
10789 '(face nil mouse-face nil keymap nil fontified nil) s)
10790 ;; Make a series of regular expressions to find a match
10801 re4 (concat "[^a-zA-Z_]" re4_)
10803 re1 (concat pre re2 post)
10804 re3 (concat pre (if pre re4_ re4) post)
10805 re5 (concat pre ".*" re4)
10806 re2 (concat pre re2)
10807 re2a (concat pre (if pre re2a_ re2a))
10808 re4 (concat pre (if pre re4_ re4))
10812 (cond
10813 ((eq type 'org-occur) (org-occur reall))
10814 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10815 (t (goto-char (point-min))
10816 (setq type 'fuzzy)
10817 (if (or (and (org-search-not-self 1 re0 nil t)
10818 (setq type 'dedicated))
10819 (org-search-not-self 1 re1 nil t)
10820 (org-search-not-self 1 re2 nil t)
10821 (org-search-not-self 1 re2a nil t)
10822 (org-search-not-self 1 re3 nil t)
10823 (org-search-not-self 1 re4 nil t)
10824 (org-search-not-self 1 re5 nil t))
10825 (goto-char (match-beginning 1))
10826 (goto-char pos)
10827 (error "No match"))))))
10828 (and (derived-mode-p 'org-mode)
10829 (not stealth)
10830 (org-show-context 'link-search))
10831 type))
10833 (defun org-search-not-self (group &rest args)
10834 "Execute `re-search-forward', but only accept matches that do not
10835 enclose the position of `org-open-link-marker'."
10836 (let ((m org-open-link-marker))
10837 (catch 'exit
10838 (while (apply 're-search-forward args)
10839 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10840 (goto-char (match-end group))
10841 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10842 (> (match-beginning 0) (marker-position m))
10843 (< (match-end 0) (marker-position m)))
10844 (save-match-data
10845 (or (not (org-in-regexp
10846 org-bracket-link-analytic-regexp 1))
10847 (not (match-end 4)) ; no description
10848 (and (<= (match-beginning 4) (point))
10849 (>= (match-end 4) (point))))))
10850 (throw 'exit (point))))))))
10852 (defun org-get-buffer-for-internal-link (buffer)
10853 "Return a buffer to be used for displaying the link target of internal links."
10854 (cond
10855 ((not org-display-internal-link-with-indirect-buffer)
10856 buffer)
10857 ((string-match "(Clone)$" (buffer-name buffer))
10858 (message "Buffer is already a clone, not making another one")
10859 ;; we also do not modify visibility in this case
10860 buffer)
10861 (t ; make a new indirect buffer for displaying the link
10862 (let* ((bn (buffer-name buffer))
10863 (ibn (concat bn "(Clone)"))
10864 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10865 (with-current-buffer ib (org-overview))
10866 ib))))
10868 (defun org-do-occur (regexp &optional cleanup)
10869 "Call the Emacs command `occur'.
10870 If CLEANUP is non-nil, remove the printout of the regular expression
10871 in the *Occur* buffer. This is useful if the regex is long and not useful
10872 to read."
10873 (occur regexp)
10874 (when cleanup
10875 (let ((cwin (selected-window)) win beg end)
10876 (when (setq win (get-buffer-window "*Occur*"))
10877 (select-window win))
10878 (goto-char (point-min))
10879 (when (re-search-forward "match[a-z]+" nil t)
10880 (setq beg (match-end 0))
10882 (setq end (1- (match-beginning 0)))))
10883 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10884 (goto-char (point-min))
10885 (select-window cwin))))
10887 ;;; The mark ring for links jumps
10889 (defvar org-mark-ring nil
10890 "Mark ring for positions before jumps in Org-mode.")
10891 (defvar org-mark-ring-last-goto nil
10892 "Last position in the mark ring used to go back.")
10893 ;; Fill and close the ring
10894 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10895 (loop for i from 1 to org-mark-ring-length do
10896 (push (make-marker) org-mark-ring))
10897 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10898 org-mark-ring)
10900 (defun org-mark-ring-push (&optional pos buffer)
10901 "Put the current position or POS into the mark ring and rotate it."
10902 (interactive)
10903 (setq pos (or pos (point)))
10904 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10905 (move-marker (car org-mark-ring)
10906 (or pos (point))
10907 (or buffer (current-buffer)))
10908 (message "%s"
10909 (substitute-command-keys
10912 (defun org-mark-ring-goto (&optional n)
10913 "Jump to the previous position in the mark ring.
10914 With prefix arg N, jump back that many stored positions. When
10915 called several times in succession, walk through the entire ring.
10916 Org-mode commands jumping to a different position in the current file,
10917 or to another Org-mode file, automatically push the old position
10918 onto the ring."
10919 (interactive "p")
10920 (let (p m)
10921 (if (eq last-command this-command)
10922 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10923 (setq p org-mark-ring))
10924 (setq org-mark-ring-last-goto p)
10925 (setq m (car p))
10926 (org-pop-to-buffer-same-window (marker-buffer m))
10927 (goto-char m)
10928 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10930 (defun org-remove-angle-brackets (s)
10931 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10932 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10933 s)
10934 (defun org-add-angle-brackets (s)
10935 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10936 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10937 s)
10938 (defun org-remove-double-quotes (s)
10941 s)
10943 ;;; Following specific links
10945 (defun org-follow-timestamp-link ()
10946 "Open an agenda view for the time-stamp date/range at point."
10947 (cond
10948 ((org-at-date-range-p t)
10949 (let ((org-agenda-start-on-weekday)
10950 (t1 (match-string 1))
10951 (t2 (match-string 2)) tt1 tt2)
10952 (setq tt1 (time-to-days (org-time-string-to-time t1))
10953 tt2 (time-to-days (org-time-string-to-time t2)))
10954 (let ((org-agenda-buffer-tmp-name
10955 (format "*Org Agenda(a:%s)"
10956 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10957 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10958 ((org-at-timestamp-p t)
10959 (let ((org-agenda-buffer-tmp-name
10960 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10961 (org-agenda-list nil (time-to-days (org-time-string-to-time
10962 (substring (match-string 1) 0 10)))
10963 1)))
10964 (t (error "This should not happen"))))
10967 ;;; Following file links
10968 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10969 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10970 (declare-function mailcap-mime-info
10971 "mailcap" (string &optional request no-decode))
10972 (defvar org-wait nil)
10973 (defun org-open-file (path &optional in-emacs line search)
10974 "Open the file at PATH.
10975 First, this expands any special file name abbreviations. Then the
10976 configuration variable `org-file-apps' is checked if it contains an
10977 entry for this file type, and if yes, the corresponding command is launched.
10979 If no application is found, Emacs simply visits the file.
10981 With optional prefix argument IN-EMACS, Emacs will visit the file.
10983 prefix arg, Org tries to avoid opening in Emacs
10984 and to use an external application to visit the file.
10986 Optional LINE specifies a line to go to, optional SEARCH a string
10987 to search for. If LINE or SEARCH is given, the file will be
10988 opened in Emacs, unless an entry from org-file-apps that makes
10989 use of groups in a regexp matches.
10991 If you want to change the way frames are used when following a
10992 link, please customize `org-link-frame-setup'.
10994 If the file does not exist, an error is thrown."
10995 (let* ((file (if (equal path "")
10996 buffer-file-name
10997 (substitute-in-file-name (expand-file-name path))))
10998 (file-apps (append org-file-apps (org-default-apps)))
10999 (apps (org-remove-if
11000 'org-file-apps-entry-match-against-dlink-p file-apps))
11001 (apps-dlink (org-remove-if-not
11002 'org-file-apps-entry-match-against-dlink-p file-apps))
11003 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11004 (dirp (if remp nil (file-directory-p file)))
11005 (file (if (and dirp org-open-directory-means-index-dot-org)
11006 (concat (file-name-as-directory file) "index.org")
11007 file))
11008 (a-m-a-p (assq 'auto-mode apps))
11009 (dfile (downcase file))
11010 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11011 (link (cond ((and (eq line nil)
11012 (eq search nil))
11013 file)
11014 (line
11015 (concat file "::" (number-to-string line)))
11016 (search
11017 (concat file "::" search))))
11018 (dlink (downcase link))
11019 (old-buffer (current-buffer))
11020 (old-pos (point))
11021 (old-mode major-mode)
11022 ext cmd link-match-data)
11024 (setq ext (match-string 1 dfile))
11026 (setq ext (match-string 1 dfile))))
11027 (cond
11028 ((member in-emacs '((16) system))
11029 (setq cmd (cdr (assoc 'system apps))))
11030 (in-emacs (setq cmd 'emacs))
11031 (t
11032 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11033 (and dirp (cdr (assoc 'directory apps)))
11034 ; first, try matching against apps-dlink
11035 ; if we get a match here, store the match data for later
11036 (let ((match (assoc-default dlink apps-dlink
11037 'string-match)))
11038 (if match
11039 (progn (setq link-match-data (match-data))
11040 match)
11041 (progn (setq in-emacs (or in-emacs line search))
11042 nil))) ; if we have no match in apps-dlink,
11043 ; always open the file in emacs if line or search
11044 ; is given (for backwards compatibility)
11045 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11046 'string-match)
11047 (cdr (assoc ext apps))
11048 (cdr (assoc t apps))))))
11049 (when (eq cmd 'system)
11050 (setq cmd (cdr (assoc 'system apps))))
11051 (when (eq cmd 'default)
11052 (setq cmd (cdr (assoc t apps))))
11053 (when (eq cmd 'mailcap)
11054 (require 'mailcap)
11055 (mailcap-parse-mailcaps)
11056 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11057 (command (mailcap-mime-info mime-type)))
11058 (if (stringp command)
11059 (setq cmd command)
11060 (setq cmd 'emacs))))
11061 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11062 (not (file-exists-p file))
11063 (not org-open-non-existing-files))
11064 (user-error "No such file: %s" file))
11065 (cond
11067 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11069 (setq cmd (replace-match "%s" t t cmd)))
11070 (while (string-match "%s" cmd)
11071 (setq cmd (replace-match
11072 (save-match-data
11073 (shell-quote-argument
11074 (convert-standard-filename file)))
11075 t t cmd)))
11077 ;; Replace "%1", "%2" etc. in command with group matches from regex
11078 (save-match-data
11079 (let ((match-index 1)
11080 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11081 (set-match-data link-match-data)
11082 (while (<= match-index number-of-groups)
11083 (let ((regex (concat "%" (number-to-string match-index)))
11084 (replace-with (match-string match-index dlink)))
11085 (while (string-match regex cmd)
11086 (setq cmd (replace-match replace-with t t cmd))))
11087 (setq match-index (+ match-index 1)))))
11089 (save-window-excursion
11090 (message "Running %s...done" cmd)
11091 (start-process-shell-command cmd nil cmd)
11092 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11093 ((or (stringp cmd)
11094 (eq cmd 'emacs))
11095 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11096 (widen)
11097 (if line (org-goto-line line)
11098 (if search (org-link-search search))))
11099 ((consp cmd)
11100 (let ((file (convert-standard-filename file)))
11101 (save-match-data
11102 (set-match-data link-match-data)
11103 (eval cmd))))
11104 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11105 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11106 (or (not (equal old-buffer (current-buffer)))
11107 (not (equal old-pos (point))))
11108 (org-mark-ring-push old-pos old-buffer))))
11110 (defun org-file-apps-entry-match-against-dlink-p (entry)
11111 "This function returns non-nil if `entry' uses a regular
11112 expression which should be matched against the whole link by
11113 org-open-file.
11115 It assumes that is the case when the entry uses a regular
11116 expression which has at least one grouping construct and the
11117 action is either a lisp form or a command string containing
11118 '%1', i.e. using at least one subexpression match as a
11119 parameter."
11120 (let ((selector (car entry))
11121 (action (cdr entry)))
11122 (if (stringp selector)
11123 (and (> (regexp-opt-depth selector) 0)
11124 (or (and (stringp action)
11125 (string-match "%[0-9]" action))
11126 (consp action)))
11127 nil)))
11129 (defun org-default-apps ()
11130 "Return the default applications for this operating system."
11131 (cond
11132 ((eq system-type 'darwin)
11133 org-file-apps-defaults-macosx)
11134 ((eq system-type 'windows-nt)
11135 org-file-apps-defaults-windowsnt)
11136 (t org-file-apps-defaults-gnu)))
11138 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11139 "Convert extensions to regular expressions in the cars of LIST.
11140 Also, weed out any non-string entries, because the return value is used
11141 only for regexp matching.
11142 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11143 point to the symbol `emacs', indicating that the file should
11144 be opened in Emacs."
11145 (append
11146 (delq nil
11147 (mapcar (lambda (x)
11148 (if (not (stringp (car x)))
11149 nil
11151 x
11153 list))
11154 (if add-auto-mode
11155 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11157 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11158 (defun org-file-remote-p (file)
11159 "Test whether FILE specifies a location on a remote system.
11160 Return non-nil if the location is indeed remote.
11164 (cond ((fboundp 'file-remote-p)
11165 (file-remote-p file))
11166 ((fboundp 'tramp-handle-file-remote-p)
11167 (tramp-handle-file-remote-p file))
11168 ((and (boundp 'ange-ftp-name-format)
11169 (string-match (car ange-ftp-name-format) file))
11170 t)))
11173 ;;;; Refiling
11175 (defun org-get-org-file ()
11176 "Read a filename, with default directory `org-directory'."
11177 (let ((default (or org-default-notes-file remember-data-file)))
11178 (read-file-name (format "File name [%s]: " default)
11179 (file-name-as-directory org-directory)
11180 default)))
11182 (defun org-notes-order-reversed-p ()
11183 "Check if the current file should receive notes in reversed order."
11184 (cond
11185 ((not org-reverse-note-order) nil)
11186 ((eq t org-reverse-note-order) t)
11187 ((not (listp org-reverse-note-order)) nil)
11188 (t (catch 'exit
11189 (let ((all org-reverse-note-order)
11190 entry)
11191 (while (setq entry (pop all))
11192 (if (string-match (car entry) buffer-file-name)
11193 (throw 'exit (cdr entry))))
11194 nil)))))
11196 (defvar org-refile-target-table nil
11197 "The list of refile targets, created by `org-refile'.")
11199 (defvar org-agenda-new-buffers nil
11200 "Buffers created to visit agenda files.")
11202 (defvar org-refile-cache nil
11203 "Cache for refile targets.")
11205 (defvar org-refile-markers nil
11206 "All the markers used for caching refile locations.")
11208 (defun org-refile-marker (pos)
11209 "Get a new refile marker, but only if caching is in use."
11210 (if (not org-refile-use-cache)
11211 pos
11212 (let ((m (make-marker)))
11213 (move-marker m pos)
11214 (push m org-refile-markers)
11215 m)))
11217 (defun org-refile-cache-clear ()
11218 "Clear the refile cache and disable all the markers."
11219 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11220 (setq org-refile-markers nil)
11221 (setq org-refile-cache nil)
11222 (message "Refile cache has been cleared"))
11224 (defun org-refile-cache-check-set (set)
11225 "Check if all the markers in the cache still have live buffers."
11226 (let (marker)
11227 (catch 'exit
11228 (while (and set (setq marker (nth 3 (pop set))))
11229 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11230 (when (and marker (null (marker-buffer marker)))
11231 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11232 (sit-for 3)
11233 (throw 'exit nil)))
11234 t)))
11236 (defun org-refile-cache-put (set &rest identifiers)
11237 "Push the refile targets SET into the cache, under IDENTIFIERS."
11238 (let* ((key (sha1 (prin1-to-string identifiers)))
11239 (entry (assoc key org-refile-cache)))
11240 (if entry
11241 (setcdr entry set)
11242 (push (cons key set) org-refile-cache))))
11244 (defun org-refile-cache-get (&rest identifiers)
11245 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11246 (cond
11247 ((not org-refile-cache) nil)
11248 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11249 (t
11250 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11251 org-refile-cache))))
11252 (and set (org-refile-cache-check-set set) set)))))
11254 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11255 "Produce a table with refile targets."
11256 (let ((case-fold-search nil)
11257 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11258 (entries (or org-refile-targets '((nil . (:level . 1)))))
11259 targets tgs txt re files f desc descre fast-path-p level pos0)
11260 (message "Getting targets...")
11261 (with-current-buffer (or default-buffer (current-buffer))
11262 (while (setq entry (pop entries))
11263 (setq files (car entry) desc (cdr entry))
11264 (setq fast-path-p nil)
11265 (cond
11266 ((null files) (setq files (list (current-buffer))))
11267 ((eq files 'org-agenda-files)
11268 (setq files (org-agenda-files 'unrestricted)))
11269 ((and (symbolp files) (fboundp files))
11270 (setq files (funcall files)))
11271 ((and (symbolp files) (boundp files))
11272 (setq files (symbol-value files))))
11273 (if (stringp files) (setq files (list files)))
11274 (cond
11275 ((eq (car desc) :tag)
11277 ((eq (car desc) :todo)
11279 ((eq (car desc) :regexp)
11280 (setq descre (cdr desc)))
11281 ((eq (car desc) :level)
11283 (if org-odd-levels-only
11284 (1- (* 2 (cdr desc)))
11285 (cdr desc)))
11287 ((eq (car desc) :maxlevel)
11288 (setq fast-path-p t)
11290 (if org-odd-levels-only
11291 (1- (* 2 (cdr desc)))
11292 (cdr desc)))
11294 (t (error "Bad refiling target description %s" desc)))
11295 (while (setq f (pop files))
11296 (with-current-buffer
11297 (if (bufferp f) f (org-get-agenda-file-buffer f))
11298 (or
11299 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11300 (progn
11301 (if (bufferp f) (setq f (buffer-file-name
11302 (buffer-base-buffer f))))
11303 (setq f (and f (expand-file-name f)))
11304 (if (eq org-refile-use-outline-path 'file)
11305 (push (list (file-name-nondirectory f) f nil nil) tgs))
11306 (save-excursion
11307 (save-restriction
11308 (widen)
11309 (goto-char (point-min))
11310 (while (re-search-forward descre nil t)
11311 (goto-char (setq pos0 (point-at-bol)))
11312 (catch 'next
11313 (when org-refile-target-verify-function
11314 (save-match-data
11315 (or (funcall org-refile-target-verify-function)
11316 (throw 'next t))))
11317 (when (and (looking-at org-complex-heading-regexp)
11318 (not (member (match-string 4) excluded-entries))
11319 (match-string 4))
11320 (setq level (org-reduced-level
11321 (- (match-end 1) (match-beginning 1)))
11322 txt (org-link-display-format (match-string 4))
11324 re (format org-complex-heading-regexp-format
11325 (regexp-quote (match-string 4))))
11326 (when org-refile-use-outline-path
11327 (setq txt (mapconcat
11328 'org-protect-slash
11329 (append
11330 (if (eq org-refile-use-outline-path
11331 'file)
11332 (list (file-name-nondirectory
11333 (buffer-file-name
11334 (buffer-base-buffer))))
11335 (if (eq org-refile-use-outline-path
11336 'full-file-path)
11337 (list (buffer-file-name
11338 (buffer-base-buffer)))))
11339 (org-get-outline-path fast-path-p
11340 level txt)
11341 (list txt))
11342 "/")))
11343 (push (list txt f re (org-refile-marker (point)))
11344 tgs)))
11345 (when (= (point) pos0)
11346 ;; verification function has not moved point
11347 (goto-char (point-at-eol))))))))
11348 (when org-refile-use-cache
11349 (org-refile-cache-put tgs (buffer-file-name) descre))
11350 (setq targets (append tgs targets))))))
11351 (message "Getting targets...done")
11352 (nreverse targets)))
11354 (defun org-protect-slash (s)
11355 (while (string-match "/" s)
11357 s)
11359 (defvar org-olpa (make-vector 20 nil))
11361 (defun org-get-outline-path (&optional fastp level heading)
11362 "Return the outline path to the current entry, as a list.
11364 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11365 routine which makes outline path derivations for an entire file,
11366 avoiding backtracing. Refile target collection makes use of that."
11367 (if fastp
11368 (progn
11369 (if (> level 19)
11370 (error "Outline path failure, more than 19 levels"))
11371 (loop for i from level upto 19 do
11372 (aset org-olpa i nil))
11373 (prog1
11374 (delq nil (append org-olpa nil))
11375 (aset org-olpa level heading)))
11376 (let (rtn case-fold-search)
11377 (save-excursion
11378 (save-restriction
11379 (widen)
11380 (while (org-up-heading-safe)
11381 (when (looking-at org-complex-heading-regexp)
11382 (push (org-trim
11383 (replace-regexp-in-string
11384 ;; Remove statistical/checkboxes cookies
11386 (org-match-string-no-properties 4)))
11387 rtn)))
11388 rtn)))))
11390 (defun org-format-outline-path (path &optional width prefix separator)
11391 "Format the outline path PATH for display.
11392 WIDTH is the maximum number of characters that is available.
11393 PREFIX is a prefix to be included in the returned string,
11394 such as the file name.
11395 SEPARATOR is inserted between the different parts of the path,
11397 (setq width (or width 79))
11398 (if prefix (setq width (- width (length prefix))))
11399 (if (not path)
11400 (or prefix "")
11401 (let* ((nsteps (length path))
11402 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11403 (maxwidth (if (<= total-width width)
11404 10000 ;; everything fits
11405 ;; we need to shorten the level headings
11406 (/ (- width nsteps) nsteps)))
11407 (org-odd-levels-only nil)
11408 (n 0)
11409 (total (1+ (length prefix))))
11410 (setq maxwidth (max maxwidth 10))
11411 (concat prefix
11412 (if prefix (or separator "/"))
11413 (mapconcat
11414 (lambda (h)
11415 (setq n (1+ n))
11416 (if (and (= n nsteps) (< maxwidth 10000))
11417 (setq maxwidth (- total-width total)))
11418 (if (< (length h) maxwidth)
11419 (progn (setq total (+ total (length h) 1)) h)
11420 (setq h (substring h 0 (- maxwidth 2))
11421 total (+ total maxwidth 1))
11423 (setq h (substring h 0 (match-beginning 0))))
11424 (setq h (concat h "..")))
11425 (org-add-props h nil 'face
11426 (nth (% (1- n) org-n-level-faces)
11427 org-level-faces))
11428 h)
11429 path (or separator "/"))))))
11431 (defun org-display-outline-path (&optional file current separator just-return-string)
11432 "Display the current outline path in the echo area.
11434 If FILE is non-nil, prepend the output with the file name.
11435 If CURRENT is non-nil, append the current heading to the output.
11436 SEPARATOR is passed through to `org-format-outline-path'. It separates
11438 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11439 (interactive "P")
11440 (let* (case-fold-search
11441 message-log-max ; Don't populate the *Messages* buffer
11442 (bfn (buffer-file-name (buffer-base-buffer)))
11443 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11444 res)
11445 (if current (setq path (append path
11446 (save-excursion
11447 (org-back-to-heading t)
11448 (if (looking-at org-complex-heading-regexp)
11449 (list (match-string 4)))))))
11450 (setq res
11451 (org-format-outline-path
11452 path
11453 (1- (frame-width))
11454 (and file bfn (concat (file-name-nondirectory bfn) separator))
11455 separator))
11456 (if just-return-string
11457 (org-no-properties res)
11458 (message "%s" res))))
11460 (defvar org-refile-history nil
11461 "History for refiling operations.")
11463 (defvar org-after-refile-insert-hook nil
11464 "Hook run after `org-refile' has inserted its stuff at the new location.
11465 Note that this is still *before* the stuff will be removed from
11466 the *old* location.")
11468 (defvar org-capture-last-stored-marker)
11469 (defvar org-refile-keep nil
11470 "Non-nil means `org-refile' will copy instead of refile.")
11472 (defun org-copy ()
11473 "Like `org-refile', but copy."
11474 (interactive)
11475 (let ((org-refile-keep t))
11476 (funcall 'org-refile nil nil nil "Copy")))
11478 (defun org-refile (&optional goto default-buffer rfloc msg)
11479 "Move the entry or entries at point to another heading.
11480 The list of target headings is compiled using the information in
11481 `org-refile-targets', which see.
11483 At the target location, the entry is filed as a subitem of the target
11484 heading. Depending on `org-reverse-note-order', the new subitem will
11485 either be the first or the last subitem.
11487 If there is an active region, all entries in that region will be moved.
11488 However, the region must fulfill the requirement that the first heading
11489 is the first one sets the top-level of the moved text - at most siblings
11490 below it are allowed.
11492 With prefix arg GOTO, the command will only visit the target location
11493 and not actually move anything.
11496 go to the location where the last refiling operation has put the subtree.
11498 With a numeric prefix argument of `2', refile to the running clock.
11500 With a numeric prefix argument of `3', emulate `org-refile-keep'
11501 being set to `t' and copy to the target location, don't move it.
11502 Beware that keeping refiled entries may result in duplicated ID
11503 properties.
11505 RFLOC can be a refile location obtained in a different way.
11510 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11512 If you are using target caching (see `org-refile-use-cache'),
11513 you have to clear the target cache in order to find new targets.
11514 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11515 prefix argument (`C-u C-u C-u C-c C-w')."
11517 (interactive "P")
11518 (if (member goto '(0 (64)))
11519 (org-refile-cache-clear)
11520 (let* ((actionmsg (or msg "Refile"))
11521 (cbuf (current-buffer))
11522 (regionp (org-region-active-p))
11523 (region-start (and regionp (region-beginning)))
11524 (region-end (and regionp (region-end)))
11525 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11526 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11527 pos it nbuf file re level reversed)
11528 (setq last-command nil)
11529 (when regionp
11530 (goto-char region-start)
11531 (or (bolp) (goto-char (point-at-bol)))
11532 (setq region-start (point))
11533 (unless (or (org-kill-is-subtree-p
11534 (buffer-substring region-start region-end))
11535 (prog1 org-refile-active-region-within-subtree
11536 (let ((s (point-at-eol)))
11537 (org-toggle-heading)
11538 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11539 (user-error "The region is not a (sequence of) subtree(s)")))
11540 (if (equal goto '(16))
11541 (org-refile-goto-last-stored)
11542 (when (or
11543 (and (equal goto 2)
11544 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11545 (prog1
11546 (setq it (list (or org-clock-heading "running clock")
11547 (buffer-file-name
11548 (marker-buffer org-clock-hd-marker))
11549 ""
11550 (marker-position org-clock-hd-marker)))
11551 (setq goto nil)))
11552 (setq it (or rfloc
11553 (let (heading-text)
11554 (save-excursion
11555 (unless goto
11556 (org-back-to-heading t)
11557 (setq heading-text
11558 (nth 4 (org-heading-components))))
11560 (org-refile-get-location
11561 (cond (goto "Goto")
11562 (regionp (concat actionmsg " region to"))
11565 default-buffer
11566 (and (not (equal '(4) goto))
11567 org-refile-allow-creating-parent-nodes)
11568 goto))))))
11569 (setq file (nth 1 it)
11570 re (nth 2 it)
11571 pos (nth 3 it))
11572 (if (and (not goto)
11573 pos
11574 (equal (buffer-file-name) file)
11575 (if regionp
11576 (and (>= pos region-start)
11577 (<= pos region-end))
11578 (and (>= pos (point))
11579 (< pos (save-excursion
11580 (org-end-of-subtree t t))))))
11581 (error "Cannot refile to position inside the tree or region"))
11583 (setq nbuf (or (find-buffer-visiting file)
11584 (find-file-noselect file)))
11585 (if (and goto (not (equal goto 3)))
11586 (progn
11587 (org-pop-to-buffer-same-window nbuf)
11588 (goto-char pos)
11589 (org-show-context 'org-goto))
11590 (if regionp
11591 (progn
11592 (org-kill-new (buffer-substring region-start region-end))
11593 (org-save-markers-in-region region-start region-end))
11594 (org-copy-subtree 1 nil t))
11595 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11596 (find-file-noselect file)))
11597 (setq reversed (org-notes-order-reversed-p))
11598 (save-excursion
11599 (save-restriction
11600 (widen)
11601 (if pos
11602 (progn
11603 (goto-char pos)
11604 (looking-at org-outline-regexp)
11605 (setq level (org-get-valid-level (funcall outline-level) 1))
11606 (goto-char
11607 (if reversed
11608 (or (outline-next-heading) (point-max))
11609 (or (save-excursion (org-get-next-sibling))
11610 (org-end-of-subtree t t)
11611 (point-max)))))
11612 (setq level 1)
11613 (if (not reversed)
11614 (goto-char (point-max))
11615 (goto-char (point-min))
11616 (or (outline-next-heading) (goto-char (point-max)))))
11617 (if (not (bolp)) (newline))
11618 (org-paste-subtree level)
11619 (when org-log-refile
11620 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11621 (unless (eq org-log-refile 'note)
11622 (save-excursion (org-add-log-note))))
11623 (and org-auto-align-tags
11624 (let ((org-loop-over-headlines-in-active-region nil))
11625 (org-set-tags nil t)))
11626 (with-demoted-errors
11627 (bookmark-set "org-refile-last-stored"))
11628 ;; If we are refiling for capture, make sure that the
11629 ;; last-capture pointers point here
11630 (when (org-bound-and-true-p org-refile-for-capture)
11631 (with-demoted-errors
11632 (bookmark-set "org-capture-last-stored-marker"))
11633 (move-marker org-capture-last-stored-marker (point)))
11634 (if (fboundp 'deactivate-mark) (deactivate-mark))
11635 (run-hooks 'org-after-refile-insert-hook))))
11636 (unless org-refile-keep
11637 (if regionp
11638 (delete-region (point) (+ (point) (- region-end region-start)))
11639 (delete-region
11640 (and (org-back-to-heading t) (point))
11641 (min (buffer-size) (org-end-of-subtree t t) (point)))))
11642 (when (featurep 'org-inlinetask)
11643 (org-inlinetask-remove-END-maybe))
11644 (setq org-markers-to-move nil)
11647 (defun org-refile-goto-last-stored ()
11648 "Go to the location where the last refile was stored."
11649 (interactive)
11650 (bookmark-jump "org-refile-last-stored")
11651 (message "This is the location of the last refile"))
11653 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11654 no-exclude)
11655 "Prompt the user for a refile location, using PROMPT.
11656 PROMPT should not be suffixed with a colon and a space, because
11657 this function appends the default value from
11658 `org-refile-history' automatically, if that is not empty.
11659 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11660 this is used for the GOTO interface."
11661 (let ((org-refile-targets org-refile-targets)
11662 (org-refile-use-outline-path org-refile-use-outline-path)
11663 excluded-entries)
11664 (when (and (derived-mode-p 'org-mode)
11665 (not org-refile-use-cache)
11666 (not no-exclude))
11667 (org-map-tree
11668 (lambda()
11669 (setq excluded-entries
11670 (append excluded-entries (list (org-get-heading t t)))))))
11671 (setq org-refile-target-table
11672 (org-refile-get-targets default-buffer excluded-entries)))
11673 (unless org-refile-target-table
11674 (user-error "No refile targets"))
11675 (let* ((cbuf (current-buffer))
11676 (partial-completion-mode nil)
11677 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11678 (cfunc (if (and org-refile-use-outline-path
11679 org-outline-path-complete-in-steps)
11680 'org-olpath-completing-read
11681 'org-icompleting-read))
11682 (extra (if org-refile-use-outline-path "/" ""))
11683 (cbnex (concat (buffer-name) extra))
11684 (filename (and cfn (expand-file-name cfn)))
11685 (tbl (mapcar
11686 (lambda (x)
11687 (if (and (not (member org-refile-use-outline-path
11688 '(file full-file-path)))
11689 (not (equal filename (nth 1 x))))
11690 (cons (concat (car x) extra " ("
11691 (file-name-nondirectory (nth 1 x)) ")")
11692 (cdr x))
11693 (cons (concat (car x) extra) (cdr x))))
11694 org-refile-target-table))
11695 (completion-ignore-case t)
11696 cdef
11697 (prompt (concat prompt
11698 (or (and (car org-refile-history)
11699 (concat " (default " (car org-refile-history) ")"))
11700 (and (assoc cbnex tbl) (setq cdef cbnex)
11701 (concat " (default " cbnex ")"))) ": "))
11702 pa answ parent-target child parent old-hist)
11703 (setq old-hist org-refile-history)
11704 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11705 nil 'org-refile-history (or cdef (car org-refile-history))))
11706 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11707 (org-refile-check-position pa)
11708 (if pa
11709 (progn
11710 (when (or (not org-refile-history)
11711 (not (eq old-hist org-refile-history))
11712 (not (equal (car pa) (car org-refile-history))))
11713 (setq org-refile-history
11714 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11715 org-refile-history
11716 (cdr org-refile-history))))
11717 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11718 (pop org-refile-history)))
11719 pa)
11721 (progn
11722 (setq parent (match-string 1 answ)
11723 child (match-string 2 answ))
11724 (setq parent-target (or (assoc parent tbl)
11725 (assoc (concat parent "/") tbl)))
11726 (when (and parent-target
11727 (or (eq new-nodes t)
11728 (and (eq new-nodes 'confirm)
11730 child)))))
11731 (org-refile-new-child parent-target child)))
11732 (user-error "Invalid target location")))))
11734 (declare-function org-string-nw-p "org-macs" (s))
11735 (defun org-refile-check-position (refile-pointer)
11736 "Check if the refile pointer matches the headline to which it points."
11737 (let* ((file (nth 1 refile-pointer))
11738 (re (nth 2 refile-pointer))
11739 (pos (nth 3 refile-pointer))
11740 buffer)
11741 (if (and (not (markerp pos)) (not file))
11742 (user-error "Please save the buffer to a file before refiling")
11743 (when (org-string-nw-p re)
11744 (setq buffer (if (markerp pos)
11745 (marker-buffer pos)
11746 (or (find-buffer-visiting file)
11747 (find-file-noselect file))))
11748 (with-current-buffer buffer
11749 (save-excursion
11750 (save-restriction
11751 (widen)
11752 (goto-char pos)
11753 (beginning-of-line 1)
11754 (unless (org-looking-at-p re)
11755 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11757 (defun org-refile-new-child (parent-target child)
11758 "Use refile target PARENT-TARGET to add new CHILD below it."
11759 (unless parent-target
11760 (error "Cannot find parent for new node"))
11761 (let ((file (nth 1 parent-target))
11762 (pos (nth 3 parent-target))
11763 level)
11764 (with-current-buffer (or (find-buffer-visiting file)
11765 (find-file-noselect file))
11766 (save-excursion
11767 (save-restriction
11768 (widen)
11769 (if pos
11770 (goto-char pos)
11771 (goto-char (point-max))
11772 (if (not (bolp)) (newline)))
11773 (when (looking-at org-outline-regexp)
11774 (setq level (funcall outline-level))
11775 (org-end-of-subtree t t))
11776 (org-back-over-empty-lines)
11778 (if pos (org-get-valid-level level 1) 1) ?*)
11780 (beginning-of-line 0)
11781 (list (concat (car parent-target) "/" child) file "" (point)))))))
11783 (defun org-olpath-completing-read (prompt collection &rest args)
11784 "Read an outline path like a file name."
11785 (let ((thetable collection)
11786 (org-completion-use-ido nil) ; does not work with ido.
11787 (org-completion-use-iswitchb nil)) ; or iswitchb
11788 (apply
11789 'org-icompleting-read prompt
11790 (lambda (string predicate &optional flag)
11791 (let (rtn r f (l (length string)))
11792 (cond
11793 ((eq flag nil)
11794 ;; try completion
11795 (try-completion string thetable))
11796 ((eq flag t)
11797 ;; all-completions
11798 (setq rtn (all-completions string thetable predicate))
11799 (mapcar
11800 (lambda (x)
11801 (setq r (substring x l))
11802 (if (string-match " ([^)]*)$" x)
11803 (setq f (match-string 0 x))
11804 (setq f ""))
11805 (if (string-match "/" r)
11806 (concat string (substring r 0 (match-end 0)) f)
11807 x))
11808 rtn))
11809 ((eq flag 'lambda)
11810 ;; exact match?
11811 (assoc string thetable)))))
11812 args)))
11814 ;;;; Dynamic blocks
11816 (defun org-find-dblock (name)
11817 "Find the first dynamic block with name NAME in the buffer.
11818 If not found, stay at current position and return nil."
11819 (let ((case-fold-search t) pos)
11820 (save-excursion
11821 (goto-char (point-min))
11822 (setq pos (and (re-search-forward
11824 (match-beginning 0))))
11825 (if pos (goto-char pos))
11826 pos))
11828 (defconst org-dblock-start-re
11830 "Matches the start line of a dynamic block, with parameters.")
11833 "Matches the end of a dynamic block.")
11835 (defun org-create-dblock (plist)
11836 "Create a dynamic block section, with parameters taken from PLIST.
11837 PLIST must contain a :name entry which is used as name of the block."
11839 (end-of-line 1)
11840 (newline))
11841 (let ((col (current-column))
11842 (name (plist-get plist :name)))
11843 (insert "#+BEGIN: " name)
11844 (while plist
11845 (if (eq (car plist) :name)
11846 (setq plist (cddr plist))
11847 (insert " " (prin1-to-string (pop plist)))))
11849 (beginning-of-line -2)))
11851 (defun org-prepare-dblock ()
11852 "Prepare dynamic block for refresh.
11853 This empties the block, puts the cursor at the insert position and returns
11854 the property list including an extra property :name with the block name."
11855 (unless (looking-at org-dblock-start-re)
11856 (user-error "Not at a dynamic block"))
11857 (let* ((begdel (1+ (match-end 0)))
11858 (name (org-no-properties (match-string 1)))
11859 (params (append (list :name name)
11860 (read (concat "(" (match-string 3) ")")))))
11861 (save-excursion
11862 (beginning-of-line 1)
11864 (setq params (plist-put params :indentation-column (current-column))))
11865 (unless (re-search-forward org-dblock-end-re nil t)
11866 (error "Dynamic block not terminated"))
11867 (setq params
11868 (append params
11869 (list :content (buffer-substring
11870 begdel (match-beginning 0)))))
11871 (delete-region begdel (match-beginning 0))
11872 (goto-char begdel)
11873 (open-line 1)
11874 params))
11876 (defun org-map-dblocks (&optional command)
11877 "Apply COMMAND to all dynamic blocks in the current buffer.
11878 If COMMAND is not given, use `org-update-dblock'."
11879 (let ((cmd (or command 'org-update-dblock)))
11880 (save-excursion
11881 (goto-char (point-min))
11882 (while (re-search-forward org-dblock-start-re nil t)
11883 (goto-char (match-beginning 0))
11884 (save-excursion
11885 (condition-case nil
11886 (funcall cmd)
11887 (error (message "Error during update of dynamic block"))))
11888 (unless (re-search-forward org-dblock-end-re nil t)
11889 (error "Dynamic block not terminated"))))))
11891 (defun org-dblock-update (&optional arg)
11892 "User command for updating dynamic blocks.
11893 Update the dynamic block at point. With prefix ARG, update all dynamic
11894 blocks in the buffer."
11895 (interactive "P")
11896 (if arg
11897 (org-update-all-dblocks)
11898 (or (looking-at org-dblock-start-re)
11899 (org-beginning-of-dblock))
11900 (org-update-dblock)))
11902 (defun org-update-dblock ()
11903 "Update the dynamic block at point.
11904 This means to empty the block, parse for parameters and then call
11905 the correct writing function."
11906 (interactive)
11907 (save-window-excursion
11908 (let* ((pos (point))
11909 (line (org-current-line))
11910 (params (org-prepare-dblock))
11911 (name (plist-get params :name))
11912 (indent (plist-get params :indentation-column))
11913 (cmd (intern (concat "org-dblock-write:" name))))
11914 (message "Updating dynamic block `%s' at line %d..." name line)
11915 (funcall cmd params)
11916 (message "Updating dynamic block `%s' at line %d...done" name line)
11917 (goto-char pos)
11918 (when (and indent (> indent 0))
11919 (setq indent (make-string indent ?\ ))
11920 (save-excursion
11921 (org-beginning-of-dblock)
11922 (forward-line 1)
11923 (while (not (looking-at org-dblock-end-re))
11924 (insert indent)
11925 (beginning-of-line 2))
11926 (when (looking-at org-dblock-end-re)
11928 (replace-match ""))
11929 (insert indent)))))))
11931 (defun org-beginning-of-dblock ()
11932 "Find the beginning of the dynamic block at point.
11933 Error if there is no such block at point."
11934 (let ((pos (point))
11935 beg)
11936 (end-of-line 1)
11937 (if (and (re-search-backward org-dblock-start-re nil t)
11938 (setq beg (match-beginning 0))
11939 (re-search-forward org-dblock-end-re nil t)
11940 (> (match-end 0) pos))
11941 (goto-char beg)
11942 (goto-char pos)
11943 (error "Not in a dynamic block"))))
11945 (defun org-update-all-dblocks ()
11946 "Update all dynamic blocks in the buffer.
11947 This function can be used in a hook."
11948 (interactive)
11949 (when (derived-mode-p 'org-mode)
11950 (org-map-dblocks 'org-update-dblock)))
11953 ;;;; Completion
11955 (declare-function org-export-backend-name "org-export" (cl-x))
11956 (declare-function org-export-backend-options "org-export" (cl-x))
11957 (defun org-get-export-keywords ()
11958 "Return a list of all currently understood export keywords.
11959 Export keywords include options, block names, attributes and
11960 keywords relative to each registered export back-end."
11961 (let (keywords)
11962 (dolist (backend
11963 (org-bound-and-true-p org-export--registered-backends)
11964 (delq nil keywords))
11965 ;; Back-end name (for keywords, like #+LATEX:)
11966 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
11967 (dolist (option-entry (org-export-backend-options backend))
11968 ;; Back-end options.
11969 (push (nth 1 option-entry) keywords)))))
11971 (defconst org-options-keywords
11972 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11973 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11974 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11975 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11976 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11978 (defcustom org-structure-template-alist
11992 ("A" "#+ASCII: " "")
11993 ("i" "#+INDEX: ?" "#+INDEX: ?")
11994 ("I" "#+INCLUDE: %file ?"
11996 "Structure completion elements.
11997 This is a list of abbreviation keys and values. The value gets inserted
11998 if you type `<' followed by the key and then press the completion key,
11999 usually `M-TAB'. %file will be replaced by a file name after prompting
12000 for the file using completion. The cursor will be placed at the position
12001 of the `?` in the template.
12002 There are two templates for each key, the first uses the original Org syntax,
12003 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12004 the default when the /org-mtags.el/ module has been loaded. See also the
12005 variable `org-mtags-prefer-muse-templates'."
12006 :group 'org-completion
12007 :type '(repeat
12008 (list
12009 (string :tag "Key")
12010 (string :tag "Template")
12011 (string :tag "Muse Template"))))
12013 (defun org-try-structure-completion ()
12014 "Try to complete a structure template before point.
12016 expands them."
12017 (let ((l (buffer-substring (point-at-bol) (point)))
12018 a)
12021 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12022 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12023 (match-beginning 1)) a)
12024 t)))
12026 (defun org-complete-expand-structure-template (start cell)
12027 "Expand a structure template."
12028 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12029 (rpl (nth (if musep 2 1) cell))
12030 (ind ""))
12031 (delete-region start (point))
12033 (cond
12034 ((bolp))
12036 (setq ind (buffer-substring (point-at-bol) (point))))
12037 (t (newline))))
12038 (setq start (point))
12039 (if (string-match "%file" rpl)
12040 (setq rpl (replace-match
12041 (concat
12043 (save-match-data
12044 (abbreviate-file-name (read-file-name "Include file: ")))
12046 t t rpl)))
12049 (insert rpl)
12052 ;;;; TODO, DEADLINE, Comments
12054 (defun org-toggle-comment ()
12055 "Change the COMMENT state of an entry."
12056 (interactive)
12057 (save-excursion
12058 (org-back-to-heading)
12059 (let (case-fold-search)
12060 (cond
12061 ((looking-at (format org-heading-keyword-regexp-format
12062 org-comment-string))
12063 (goto-char (match-end 1))
12064 (looking-at (concat " +" org-comment-string))
12065 (replace-match "" t t)
12066 (when (eolp) (insert " ")))
12067 ((looking-at org-outline-regexp)
12068 (goto-char (match-end 0))
12069 (insert org-comment-string " "))))))
12071 (defvar org-last-todo-state-is-todo nil
12072 "This is non-nil when the last TODO state change led to a TODO state.
12073 If the last change removed the TODO tag or switched to DONE, then
12074 this is nil.")
12076 (defvar org-setting-tags nil) ; dynamically skipped
12078 (defvar org-todo-setup-filter-hook nil
12079 "Hook for functions that pre-filter todo specs.
12080 Each function takes a todo spec and returns either nil or the spec
12081 transformed into canonical form." )
12083 (defvar org-todo-get-default-hook nil
12084 "Hook for functions that get a default item for todo.
12085 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12086 nil or a string to be used for the todo mark." )
12088 (defvar org-agenda-headline-snapshot-before-repeat)
12090 (defun org-current-effective-time ()
12091 "Return current time adjusted for `org-extend-today-until' variable."
12092 (let* ((ct (org-current-time))
12093 (dct (decode-time ct))
12094 (ct1
12095 (cond
12096 (org-use-last-clock-out-time-as-effective-time
12097 (or (org-clock-get-last-clock-out-time) ct))
12098 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12099 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12100 (t ct))))
12101 ct1))
12103 (defun org-todo-yesterday (&optional arg)
12104 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12105 (interactive "P")
12106 (if (eq major-mode 'org-agenda-mode)
12107 (apply 'org-agenda-todo-yesterday arg)
12108 (let* ((hour (third (decode-time
12109 (org-current-time))))
12110 (org-extend-today-until (1+ hour)))
12111 (org-todo arg))))
12113 (defvar org-block-entry-blocking ""
12114 "First entry preventing the TODO state change.")
12116 (defun org-todo (&optional arg)
12117 "Change the TODO state of an item.
12118 The state of an item is given by a keyword at the start of the heading,
12119 like
12120 *** TODO Write paper
12121 *** DONE Call mom
12123 The different keywords are specified in the variable `org-todo-keywords'.
12125 So for this example: when the item starts with TODO, it is changed to DONE.
12126 When it starts with DONE, the DONE is removed. And when neither TODO nor
12127 DONE are present, add TODO at the beginning of the heading.
12130 state.
12131 With numeric prefix arg, switch to that state.
12133 keywords (nextset).
12135 With a numeric prefix arg of 0, inhibit note taking for the change.
12137 For calling through lisp, arg is also interpreted in the following way:
12138 'none -> empty state
12140 'done -> switch to DONE
12141 'nextset -> switch to the next set of keywords
12142 'previousset -> switch to the previous set of keywords
12144 really is a member of `org-todo-keywords'."
12145 (interactive "P")
12146 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12147 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12148 'region-start-level 'region))
12149 org-loop-over-headlines-in-active-region)
12150 (org-map-entries
12151 `(org-todo ,arg)
12152 org-loop-over-headlines-in-active-region
12153 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12154 (if (equal arg '(16)) (setq arg 'nextset))
12155 (let ((org-blocker-hook org-blocker-hook)
12156 commentp
12157 case-fold-search)
12158 (when (equal arg '(64))
12159 (setq arg nil org-blocker-hook nil))
12160 (when (and org-blocker-hook
12161 (or org-inhibit-blocking
12162 (org-entry-get nil "NOBLOCKING")))
12163 (setq org-blocker-hook nil))
12164 (save-excursion
12165 (catch 'exit
12166 (org-back-to-heading t)
12168 (org-toggle-comment)
12169 (setq commentp t))
12170 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12173 (let* ((match-data (match-data))
12174 (startpos (point-at-bol))
12175 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12176 (org-log-done org-log-done)
12177 (org-log-repeat org-log-repeat)
12178 (org-todo-log-states org-todo-log-states)
12179 (org-inhibit-logging
12180 (if (equal arg 0)
12181 (progn (setq arg nil) 'note) org-inhibit-logging))
12182 (this (match-string 1))
12183 (hl-pos (match-beginning 0))
12184 (head (org-get-todo-sequence-head this))
12185 (ass (assoc head org-todo-kwd-alist))
12186 (interpret (nth 1 ass))
12187 (done-word (nth 3 ass))
12188 (final-done-word (nth 4 ass))
12189 (org-last-state (or this ""))
12190 (completion-ignore-case t)
12191 (member (member this org-todo-keywords-1))
12192 (tail (cdr member))
12193 (org-state (cond
12194 ((and org-todo-key-trigger
12195 (or (and (equal arg '(4))
12196 (eq org-use-fast-todo-selection 'prefix))
12197 (and (not arg) org-use-fast-todo-selection
12198 (not (eq org-use-fast-todo-selection
12199 'prefix)))))
12200 ;; Use fast selection
12201 (org-fast-todo-selection))
12202 ((and (equal arg '(4))
12203 (or (not org-use-fast-todo-selection)
12204 (not org-todo-key-trigger)))
12205 ;; Read a state with completion
12206 (org-icompleting-read
12207 "State: " (mapcar 'list org-todo-keywords-1)
12208 nil t))
12209 ((eq arg 'right)
12210 (if this
12211 (if tail (car tail) nil)
12212 (car org-todo-keywords-1)))
12213 ((eq arg 'left)
12214 (if (equal member org-todo-keywords-1)
12215 nil
12216 (if this
12217 (nth (- (length org-todo-keywords-1)
12218 (length tail) 2)
12219 org-todo-keywords-1)
12220 (org-last org-todo-keywords-1))))
12221 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12222 (setq arg nil))) ; hack to fall back to cycling
12223 (arg
12224 ;; user or caller requests a specific state
12225 (cond
12226 ((equal arg "") nil)
12227 ((eq arg 'none) nil)
12228 ((eq arg 'done) (or done-word (car org-done-keywords)))
12229 ((eq arg 'nextset)
12230 (or (car (cdr (member head org-todo-heads)))
12231 (car org-todo-heads)))
12232 ((eq arg 'previousset)
12233 (let ((org-todo-heads (reverse org-todo-heads)))
12234 (or (car (cdr (member head org-todo-heads)))
12235 (car org-todo-heads))))
12236 ((car (member arg org-todo-keywords-1)))
12237 ((stringp arg)
12238 (user-error "State `%s' not valid in this file" arg))
12239 ((nth (1- (prefix-numeric-value arg))
12240 org-todo-keywords-1))))
12241 ((null member) (or head (car org-todo-keywords-1)))
12242 ((equal this final-done-word) nil) ;; -> make empty
12243 ((null tail) nil) ;; -> first entry
12244 ((memq interpret '(type priority))
12245 (if (eq this-command last-command)
12246 (car tail)
12247 (if (> (length tail) 0)
12248 (or done-word (car org-done-keywords))
12249 nil)))
12250 (t
12251 (car tail))))
12252 (org-state (or
12253 (run-hook-with-args-until-success
12254 'org-todo-get-default-hook org-state org-last-state)
12255 org-state))
12256 (next (if org-state (concat " " org-state " ") " "))
12257 (change-plist (list :type 'todo-state-change :from this :to org-state
12258 :position startpos))
12259 dolog now-done-p)
12260 (when org-blocker-hook
12261 (setq org-last-todo-state-is-todo
12262 (not (member this org-done-keywords)))
12263 (unless (save-excursion
12264 (save-match-data
12265 (org-with-wide-buffer
12266 (run-hook-with-args-until-failure
12267 'org-blocker-hook change-plist))))
12268 (if (org-called-interactively-p 'interactive)
12270 this org-state org-block-entry-blocking)
12271 ;; fail silently
12273 this org-state org-block-entry-blocking)
12274 (throw 'exit nil))))
12275 (store-match-data match-data)
12276 (replace-match next t t)
12277 (unless (pos-visible-in-window-p hl-pos)
12278 (message "TODO state changed to %s" (org-trim next)))
12279 (unless head
12280 (setq head (org-get-todo-sequence-head org-state)
12281 ass (assoc head org-todo-kwd-alist)
12282 interpret (nth 1 ass)
12283 done-word (nth 3 ass)
12284 final-done-word (nth 4 ass)))
12285 (when (memq arg '(nextset previousset))
12286 (message "Keyword-Set %d/%d: %s"
12287 (- (length org-todo-sets) -1
12288 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12289 (length org-todo-sets)
12290 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12291 (setq org-last-todo-state-is-todo
12292 (not (member org-state org-done-keywords)))
12293 (setq now-done-p (and (member org-state org-done-keywords)
12294 (not (member this org-done-keywords))))
12295 (and logging (org-local-logging logging))
12296 (when (and (or org-todo-log-states org-log-done)
12297 (not (eq org-inhibit-logging t))
12298 (not (memq arg '(nextset previousset))))
12299 ;; we need to look at recording a time and note
12300 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12301 (nth 2 (assoc this org-todo-log-states))))
12302 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12303 (setq dolog 'time))
12304 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12305 (and org-state
12306 (member org-state org-not-done-keywords)
12307 (not (member this org-not-done-keywords))))
12308 ;; This is now a todo state and was not one before
12309 ;; If there was a CLOSED time stamp, get rid of it.
12310 (org-add-planning-info nil nil 'closed))
12311 (when (and now-done-p org-log-done)
12312 ;; It is now done, and it was not done before
12313 (org-add-planning-info 'closed (org-current-effective-time))
12314 (if (and (not dolog) (eq 'note org-log-done))
12315 (org-add-log-setup 'done org-state this 'findpos 'note)))
12316 (when (and org-state dolog)
12317 ;; This is a non-nil state, and we need to log it
12318 (org-add-log-setup 'state org-state this 'findpos dolog)))
12319 ;; Fixup tag positioning
12320 (org-todo-trigger-tag-changes org-state)
12321 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12322 (when org-provide-todo-statistics
12323 (org-update-parent-todo-statistics))
12324 (run-hooks 'org-after-todo-state-change-hook)
12325 (if (and arg (not (member org-state org-done-keywords)))
12326 (setq head (org-get-todo-sequence-head org-state)))
12327 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12328 ;; Do we need to trigger a repeat?
12329 (when now-done-p
12330 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12331 ;; This is for the agenda, take a snapshot of the headline.
12332 (save-match-data
12333 (setq org-agenda-headline-snapshot-before-repeat
12334 (org-get-heading))))
12335 (org-auto-repeat-maybe org-state))
12336 ;; Fixup cursor location if close to the keyword
12337 (if (and (outline-on-heading-p)
12338 (not (bolp))
12339 (save-excursion (beginning-of-line 1)
12340 (looking-at org-todo-line-regexp))
12341 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12342 (progn
12343 (goto-char (or (match-end 2) (match-end 1)))
12344 (and (looking-at " ") (just-one-space))))
12345 (when org-trigger-hook
12346 (save-excursion
12347 (run-hook-with-args 'org-trigger-hook change-plist)))
12348 (when commentp (org-toggle-comment))))))))
12350 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12351 "Block turning an entry into a TODO, using the hierarchy.
12352 This checks whether the current task should be blocked from state
12353 changes. Such blocking occurs when:
12355 1. The task has children which are not all in a completed state.
12357 2. A task has a parent with the property :ORDERED:, and there
12358 are siblings prior to the current task with incomplete
12359 status.
12361 3. The parent of the task is blocked because it has siblings that should
12362 be done first, or is child of a block grandparent TODO entry."
12364 (if (not org-enforce-todo-dependencies)
12365 t ; if locally turned off don't block
12366 (catch 'dont-block
12367 ;; If this is not a todo state change, or if this entry is already DONE,
12368 ;; do not block
12369 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12370 (member (plist-get change-plist :from)
12371 (cons 'done org-done-keywords))
12372 (member (plist-get change-plist :to)
12373 (cons 'todo org-not-done-keywords))
12374 (not (plist-get change-plist :to)))
12375 (throw 'dont-block t))
12376 ;; If this task has children, and any are undone, it's blocked
12377 (save-excursion
12378 (org-back-to-heading t)
12379 (let ((this-level (funcall outline-level)))
12380 (outline-next-heading)
12381 (let ((child-level (funcall outline-level)))
12382 (while (and (not (eobp))
12383 (> child-level this-level))
12384 ;; this todo has children, check whether they are all
12385 ;; completed
12386 (if (and (not (org-entry-is-done-p))
12387 (org-entry-is-todo-p))
12388 (progn (setq org-block-entry-blocking (org-get-heading))
12389 (throw 'dont-block nil)))
12390 (outline-next-heading)
12391 (setq child-level (funcall outline-level))))))
12392 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12393 ;; any previous siblings are undone, it's blocked
12394 (save-excursion
12395 (org-back-to-heading t)
12396 (let* ((pos (point))
12397 (parent-pos (and (org-up-heading-safe) (point))))
12398 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12399 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12400 (forward-line 1)
12401 (re-search-forward org-not-done-heading-regexp pos t))
12402 (setq org-block-entry-blocking (match-string 0))
12403 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12404 ;; Search further up the hierarchy, to see if an ancestor is blocked
12405 (while t
12406 (goto-char parent-pos)
12407 (if (not (looking-at org-not-done-heading-regexp))
12408 (throw 'dont-block t)) ; do not block, parent is not a TODO
12409 (setq pos (point))
12410 (setq parent-pos (and (org-up-heading-safe) (point)))
12411 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12412 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12413 (forward-line 1)
12414 (re-search-forward org-not-done-heading-regexp pos t)
12415 (setq org-block-entry-blocking (org-get-heading)))
12416 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12418 (defcustom org-track-ordered-property-with-tag nil
12419 "Should the ORDERED property also be shown as a tag?
12420 The ORDERED property decides if an entry should require subtasks to be
12421 completed in sequence. Since a property is not very visible, setting
12422 this option means that toggling the ORDERED property with the command
12423 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12424 not relevant for the behavior, but it makes things more visible.
12426 Note that toggling the tag with tags commands will not change the property
12427 and therefore not influence behavior!
12429 This can be t, meaning the tag ORDERED should be used, It can also be a
12430 string to select a different tag for this task."
12431 :group 'org-todo
12432 :type '(choice
12433 (const :tag "No tracking" nil)
12434 (const :tag "Track with ORDERED tag" t)
12435 (string :tag "Use other tag")))
12437 (defun org-toggle-ordered-property ()
12438 "Toggle the ORDERED property of the current entry.
12439 For better visibility, you can track the value of this property with a tag.
12440 See variable `org-track-ordered-property-with-tag'."
12441 (interactive)
12442 (let* ((t1 org-track-ordered-property-with-tag)
12443 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12444 (save-excursion
12445 (org-back-to-heading)
12446 (if (org-entry-get nil "ORDERED")
12447 (progn
12448 (org-delete-property "ORDERED" "PROPERTIES")
12449 (and tag (org-toggle-tag tag 'off))
12450 (message "Subtasks can be completed in arbitrary order"))
12451 (org-entry-put nil "ORDERED" "t")
12452 (and tag (org-toggle-tag tag 'on))
12453 (message "Subtasks must be completed in sequence")))))
12455 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12456 (defun org-block-todo-from-checkboxes (change-plist)
12457 "Block turning an entry into a TODO, using checkboxes.
12458 This checks whether the current task should be blocked from state
12459 changes because there are unchecked boxes in this entry."
12460 (if (not org-enforce-todo-checkbox-dependencies)
12461 t ; if locally turned off don't block
12462 (catch 'dont-block
12463 ;; If this is not a todo state change, or if this entry is already DONE,
12464 ;; do not block
12465 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12466 (member (plist-get change-plist :from)
12467 (cons 'done org-done-keywords))
12468 (member (plist-get change-plist :to)
12469 (cons 'todo org-not-done-keywords))
12470 (not (plist-get change-plist :to)))
12471 (throw 'dont-block t))
12472 ;; If this task has checkboxes that are not checked, it's blocked
12473 (save-excursion
12474 (org-back-to-heading t)
12475 (let ((beg (point)) end)
12476 (outline-next-heading)
12477 (setq end (point))
12478 (goto-char beg)
12479 (if (org-list-search-forward
12480 (concat (org-item-beginning-re)
12483 end t)
12484 (progn
12485 (if (boundp 'org-blocked-by-checkboxes)
12486 (setq org-blocked-by-checkboxes t))
12487 (throw 'dont-block nil)))))
12488 t))) ; do not block
12490 (defun org-entry-blocked-p ()
12491 "Is the current entry blocked?"
12492 (org-with-silent-modifications
12493 (if (org-entry-get nil "NOBLOCKING")
12494 nil ;; Never block this entry
12495 (not (run-hook-with-args-until-failure
12496 'org-blocker-hook
12497 (list :type 'todo-state-change
12498 :position (point)
12499 :from 'todo
12500 :to 'done))))))
12502 (defun org-update-statistics-cookies (all)
12503 "Update the statistics cookie, either from TODO or from checkboxes.
12504 This should be called with the cursor in a line with a statistics cookie."
12505 (interactive "P")
12506 (if all
12507 (progn
12508 (org-update-checkbox-count 'all)
12509 (org-map-entries 'org-update-parent-todo-statistics))
12510 (if (not (org-at-heading-p))
12511 (org-update-checkbox-count)
12512 (let ((pos (point-marker))
12513 end l1 l2)
12514 (ignore-errors (org-back-to-heading t))
12515 (if (not (org-at-heading-p))
12516 (org-update-checkbox-count)
12517 (setq l1 (org-outline-level))
12518 (setq end (save-excursion
12519 (outline-next-heading)
12520 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12521 (point)))
12522 (if (and (save-excursion
12523 (re-search-forward
12525 (not (save-excursion (re-search-forward
12527 (org-update-checkbox-count)
12528 (if (and l2 (> l2 l1))
12529 (progn
12530 (goto-char end)
12531 (org-update-parent-todo-statistics))
12532 (goto-char pos)
12533 (beginning-of-line 1)
12534 (while (re-search-forward
12536 (point-at-eol) t)
12537 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12538 (goto-char pos)
12539 (move-marker pos nil)))))
12541 (defvar org-entry-property-inherited-from) ;; defined below
12542 (defun org-update-parent-todo-statistics ()
12543 "Update any statistics cookie in the parent of the current headline.
12544 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12545 the entire subtree and this will travel up the hierarchy and update
12546 statistics everywhere."
12547 (let* ((prop (save-excursion (org-up-heading-safe)
12548 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12549 (recursive (or (not org-hierarchical-todo-statistics)
12551 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12552 0))
12553 (first t)
12555 level ltoggle l1 new ndel
12556 (cnt-all 0) (cnt-done 0) is-percent kwd
12557 checkbox-beg ov ovs ove cookie-present)
12558 (catch 'exit
12559 (save-excursion
12560 (beginning-of-line 1)
12561 (setq ltoggle (funcall outline-level))
12562 ;; Three situations are to consider:
12564 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12565 ;; to the top-level ancestor on the headline;
12567 ;; 2. If parent has "recursive" property, repeat up to the
12568 ;; headline setting that property, taking inheritance into
12569 ;; account;
12571 ;; 3. Else, move up to direct parent and proceed only once.
12572 (while (and (setq level (org-up-heading-safe))
12573 (or recursive first)
12574 (>= (point) lim))
12575 (setq first nil cookie-present nil)
12576 (unless (and level
12577 (not (string-match
12579 (downcase (or (org-entry-get nil "COOKIE_DATA")
12580 "")))))
12581 (throw 'exit nil))
12582 (while (re-search-forward box-re (point-at-eol) t)
12583 (setq cnt-all 0 cnt-done 0 cookie-present t)
12584 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12585 (save-match-data
12586 (unless (outline-next-heading) (throw 'exit nil))
12587 (while (and (looking-at org-complex-heading-regexp)
12588 (> (setq l1 (length (match-string 1))) level))
12589 (setq kwd (and (or recursive (= l1 ltoggle))
12590 (match-string 2)))
12591 (if (or (eq org-provide-todo-statistics 'all-headlines)
12592 (and (listp org-provide-todo-statistics)
12593 (or (member kwd org-provide-todo-statistics)
12594 (member kwd org-done-keywords))))
12595 (setq cnt-all (1+ cnt-all))
12596 (if (eq org-provide-todo-statistics t)
12597 (and kwd (setq cnt-all (1+ cnt-all)))))
12598 (and (member kwd org-done-keywords)
12599 (setq cnt-done (1+ cnt-done)))
12600 (outline-next-heading)))
12601 (setq new
12602 (if is-percent
12603 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12604 (format "[%d/%d]" cnt-done cnt-all))
12605 ndel (- (match-end 0) checkbox-beg))
12606 ;; handle overlays when updating cookie from column view
12607 (when (setq ov (car (overlays-at checkbox-beg)))
12608 (setq ovs (overlay-start ov) ove (overlay-end ov))
12609 (delete-overlay ov))
12610 (goto-char checkbox-beg)
12611 (insert new)
12612 (delete-region (point) (+ (point) ndel))
12613 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12614 (when ov (move-overlay ov ovs ove)))
12615 (when cookie-present
12616 (run-hook-with-args 'org-after-todo-statistics-hook
12617 cnt-done (- cnt-all cnt-done))))))
12618 (run-hooks 'org-todo-statistics-hook)))
12620 (defvar org-after-todo-statistics-hook nil
12621 "Hook that is called after a TODO statistics cookie has been updated.
12622 Each function is called with two arguments: the number of not-done entries
12623 and the number of done entries.
12625 For example, the following function, when added to this hook, will switch
12626 an entry to DONE when all children are done, and back to TODO when new
12627 entries are set to a TODO status. Note that this hook is only called
12628 when there is a statistics cookie in the headline!
12630 (defun org-summary-todo (n-done n-not-done)
12632 (let (org-log-done org-log-states) ; turn off logging
12634 ")
12636 (defvar org-todo-statistics-hook nil
12637 "Hook that is run whenever Org thinks TODO statistics should be updated.
12638 This hook runs even if there is no statistics cookie present, in which case
12639 `org-after-todo-statistics-hook' would not run.")
12641 (defun org-todo-trigger-tag-changes (state)
12642 "Apply the changes defined in `org-todo-state-tags-triggers'."
12643 (let ((l org-todo-state-tags-triggers)
12644 changes)
12645 (when (or (not state) (equal state ""))
12646 (setq changes (append changes (cdr (assoc "" l)))))
12647 (when (and (stringp state) (> (length state) 0))
12648 (setq changes (append changes (cdr (assoc state l)))))
12649 (when (member state org-not-done-keywords)
12650 (setq changes (append changes (cdr (assoc 'todo l)))))
12651 (when (member state org-done-keywords)
12652 (setq changes (append changes (cdr (assoc 'done l)))))
12653 (dolist (c changes)
12654 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12656 (defun org-local-logging (value)
12657 "Get logging settings from a property VALUE."
12658 (let* (words w a)
12659 ;; directly set the variables, they are already local.
12660 (setq org-log-done nil
12661 org-log-repeat nil
12662 org-todo-log-states nil)
12663 (setq words (org-split-string value))
12664 (while (setq w (pop words))
12665 (cond
12666 ((setq a (assoc w org-startup-options))
12667 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12668 (set (nth 1 a) (nth 2 a))))
12669 ((setq a (org-extract-log-state-settings w))
12670 (and (member (car a) org-todo-keywords-1)
12671 (push a org-todo-log-states)))))))
12673 (defun org-get-todo-sequence-head (kwd)
12674 "Return the head of the TODO sequence to which KWD belongs.
12675 If KWD is not set, check if there is a text property remembering the
12676 right sequence."
12677 (let (p)
12678 (cond
12679 ((not kwd)
12680 (or (get-text-property (point-at-bol) 'org-todo-head)
12681 (progn
12682 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12683 nil (point-at-eol)))
12684 (get-text-property p 'org-todo-head))))
12685 ((not (member kwd org-todo-keywords-1))
12686 (car org-todo-keywords-1))
12687 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12689 (defun org-fast-todo-selection ()
12690 "Fast TODO keyword selection with single keys.
12691 Returns the new TODO keyword, or nil if no state change should occur."
12692 (let* ((fulltable org-todo-key-alist)
12693 (done-keywords org-done-keywords) ;; needed for the faces.
12694 (maxlen (apply 'max (mapcar
12695 (lambda (x)
12696 (if (stringp (car x)) (string-width (car x)) 0))
12697 fulltable)))
12698 (expert nil)
12699 (fwidth (+ maxlen 3 1 3))
12700 (ncol (/ (- (window-width) 4) fwidth))
12701 tg cnt e c tbl
12702 groups ingroup)
12703 (save-excursion
12704 (save-window-excursion
12705 (if expert
12706 (set-buffer (get-buffer-create " *Org todo*"))
12707 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12708 (erase-buffer)
12709 (org-set-local 'org-done-keywords done-keywords)
12710 (setq tbl fulltable cnt 0)
12711 (while (setq e (pop tbl))
12712 (cond
12713 ((equal e '(:startgroup))
12714 (push '() groups) (setq ingroup t)
12715 (when (not (= cnt 0))
12716 (setq cnt 0)
12718 (insert "{ "))
12719 ((equal e '(:endgroup))
12720 (setq ingroup nil cnt 0)
12722 ((equal e '(:newline))
12723 (when (not (= cnt 0))
12724 (setq cnt 0)
12726 (setq e (car tbl))
12727 (while (equal (car tbl) '(:newline))
12729 (setq tbl (cdr tbl)))))
12730 (t
12731 (setq tg (car e) c (cdr e))
12732 (if ingroup (push tg (car groups)))
12733 (setq tg (org-add-props tg nil 'face
12734 (org-get-todo-face tg)))
12735 (if (and (= cnt 0) (not ingroup)) (insert " "))
12736 (insert "[" c "] " tg (make-string
12737 (- fwidth 4 (length tg)) ?\ ))
12738 (when (= (setq cnt (1+ cnt)) ncol)
12740 (if ingroup (insert " "))
12741 (setq cnt 0)))))
12743 (goto-char (point-min))
12744 (if (not expert) (org-fit-window-to-buffer))
12745 (message "[a-z..]:Set [SPC]:clear")
12746 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12747 (cond
12748 ((or (= c ?\C-g)
12749 (and (= c ?q) (not (rassoc c fulltable))))
12750 (setq quit-flag t))
12751 ((= c ?\ ) nil)
12752 ((setq e (rassoc c fulltable) tg (car e))
12753 tg)
12754 (t (setq quit-flag t)))))))
12756 (defun org-entry-is-todo-p ()
12757 (member (org-get-todo-state) org-not-done-keywords))
12759 (defun org-entry-is-done-p ()
12760 (member (org-get-todo-state) org-done-keywords))
12762 (defun org-get-todo-state ()
12763 "Return the TODO keyword of the current subtree."
12764 (save-excursion
12765 (org-back-to-heading t)
12766 (and (looking-at org-todo-line-regexp)
12767 (match-end 2)
12768 (match-string 2))))
12770 (defun org-at-date-range-p (&optional inactive-ok)
12771 "Is the cursor inside a date range?"
12772 (interactive)
12773 (save-excursion
12774 (catch 'exit
12775 (let ((pos (point)))
12777 (skip-chars-backward "<[")
12778 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12779 (>= (match-end 0) pos)
12780 (throw 'exit t))
12782 (skip-chars-backward "<[")
12783 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12784 (>= (match-end 0) pos)
12785 (throw 'exit t)))
12786 nil)))
12788 (defun org-get-repeat (&optional tagline)
12789 "Check if there is a deadline/schedule with repeater in this entry."
12790 (save-match-data
12791 (save-excursion
12792 (org-back-to-heading t)
12793 (and (re-search-forward (if tagline
12795 org-repeat-re)
12796 (org-entry-end-position) t)
12797 (match-string-no-properties 1)))))
12799 (defvar org-last-changed-timestamp)
12800 (defvar org-last-inserted-timestamp)
12801 (defvar org-log-post-message)
12802 (defvar org-log-note-purpose)
12803 (defvar org-log-note-how)
12804 (defvar org-log-note-extra)
12805 (defun org-auto-repeat-maybe (done-word)
12806 "Check if the current headline contains a repeated deadline/schedule.
12807 If yes, set TODO state back to what it was and change the base date
12808 of repeating deadline/scheduled time stamps to new date.
12809 This function is run automatically after each state change to a DONE state."
12810 ;; last-state is dynamically scoped into this function
12811 (let* ((repeat (org-get-repeat))
12812 (aa (assoc org-last-state org-todo-kwd-alist))
12813 (interpret (nth 1 aa))
12814 (head (nth 2 aa))
12815 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12816 (msg "Entry repeats: ")
12817 (org-log-done nil)
12818 (org-todo-log-states nil)
12819 re type n what ts time to-state)
12820 (when repeat
12821 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12822 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12823 org-todo-repeat-to-state))
12824 (unless (and to-state (member to-state org-todo-keywords-1))
12825 (setq to-state (if (eq interpret 'type) org-last-state head)))
12826 (org-todo to-state)
12827 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12828 (org-entry-put nil "LAST_REPEAT" (format-time-string
12829 (org-time-stamp-format t t))))
12830 (when org-log-repeat
12831 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12832 (memq 'org-add-log-note post-command-hook))
12833 ;; OK, we are already setup for some record
12834 (if (eq org-log-repeat 'note)
12835 ;; make sure we take a note, not only a time stamp
12836 (setq org-log-note-how 'note))
12837 ;; Set up for taking a record
12838 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12839 org-last-state
12840 'findpos org-log-repeat)))
12841 (org-back-to-heading t)
12842 (org-add-planning-info nil nil 'closed)
12846 (while (re-search-forward
12847 re (save-excursion (outline-next-heading) (point)) t)
12848 (setq type (if (match-end 1) org-scheduled-string
12849 (if (match-end 3) org-deadline-string "Plain:"))
12850 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12852 (setq n (string-to-number (match-string 2 ts))
12853 what (match-string 3 ts))
12854 (if (equal what "w") (setq n (* n 7) what "d"))
12856 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12857 ;; Preparation, see if we need to modify the start date for the change
12858 (when (match-end 1)
12859 (setq time (save-match-data (org-time-string-to-time ts)))
12860 (cond
12861 ((equal (match-string 1 ts) ".")
12862 ;; Shift starting date to today
12863 (org-timestamp-change
12864 (- (org-today) (time-to-days time))
12865 'day))
12866 ((equal (match-string 1 ts) "+")
12867 (let ((nshiftmax 10) (nshift 0))
12868 (while (or (= nshift 0)
12869 (<= (time-to-days time)
12870 (time-to-days (current-time))))
12871 (when (= (incf nshift) nshiftmax)
12872 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12873 (error "Abort")))
12874 (org-timestamp-change n (cdr (assoc what whata)))
12875 (org-at-timestamp-p t)
12876 (setq ts (match-string 1))
12877 (setq time (save-match-data (org-time-string-to-time ts)))))
12878 (org-timestamp-change (- n) (cdr (assoc what whata)))
12879 ;; rematch, so that we have everything in place for the real shift
12880 (org-at-timestamp-p t)
12881 (setq ts (match-string 1))
12883 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12884 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12885 (setq org-log-post-message msg)
12886 (message "%s" msg))))
12888 (defun org-show-todo-tree (arg)
12889 "Make a compact tree which shows all headlines marked with TODO.
12890 The tree will show the lines where the regexp matches, and all higher
12891 headlines above the match.
12893 With a numeric prefix N, construct a sparse tree for the Nth element
12894 of `org-todo-keywords-1'."
12895 (interactive "P")
12896 (let ((case-fold-search nil)
12897 (kwd-re
12898 (cond ((null arg) org-not-done-regexp)
12899 ((equal arg '(4))
12900 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12901 (mapcar 'list org-todo-keywords-1))))
12905 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12906 (regexp-quote (nth (1- (prefix-numeric-value arg))
12907 org-todo-keywords-1)))
12908 (t (user-error "Invalid prefix argument: %s" arg)))))
12909 (message "%d TODO entries found"
12910 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12912 (defun org-deadline (arg &optional time)
12914 With one universal prefix argument, remove any deadline from the item.
12915 With two universal prefix arguments, prompt for a warning delay.
12916 With argument TIME, set the deadline at the corresponding date. TIME
12918 (interactive "P")
12919 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12920 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12921 'region-start-level 'region))
12922 org-loop-over-headlines-in-active-region)
12923 (org-map-entries
12924 `(org-deadline ',arg ,time)
12925 org-loop-over-headlines-in-active-region
12926 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12927 (let* ((old-date (org-entry-get nil "DEADLINE"))
12928 (old-date-time (if old-date (org-time-string-to-time old-date)))
12929 (repeater (and old-date
12930 (string-match
12932 old-date)
12933 (match-string 1 old-date))))
12934 (cond
12935 ((equal arg '(4))
12936 (when (and old-date org-log-redeadline)
12937 (org-add-log-setup 'deldeadline nil old-date 'findpos
12938 org-log-redeadline))
12939 (org-remove-timestamp-with-keyword org-deadline-string)
12940 (message "Item no longer has a deadline."))
12941 ((equal arg '(16))
12942 (save-excursion
12943 (if (re-search-forward
12944 org-deadline-time-regexp
12945 (save-excursion (outline-next-heading) (point)) t)
12946 (let* ((rpl0 (match-string 1))
12947 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12948 (replace-match
12949 (concat org-deadline-string
12950 " <" rpl
12951 (format " -%dd"
12952 (abs
12953 (- (time-to-days
12954 (save-match-data
12955 (org-read-date nil t nil "Warn starting from" old-date-time)))
12956 (time-to-days old-date-time))))
12957 ">") t t))
12958 (user-error "No deadline information to update"))))
12959 (t
12960 (org-add-planning-info 'deadline time 'closed)
12961 (when (and old-date org-log-redeadline
12962 (not (equal old-date
12963 (substring org-last-inserted-timestamp 1 -1))))
12964 (org-add-log-setup 'redeadline nil old-date 'findpos
12965 org-log-redeadline))
12966 (when repeater
12967 (save-excursion
12968 (org-back-to-heading t)
12969 (when (re-search-forward (concat org-deadline-string " "
12970 org-last-inserted-timestamp)
12971 (save-excursion
12972 (outline-next-heading) (point)) t)
12973 (goto-char (1- (match-end 0)))
12974 (insert " " repeater)
12975 (setq org-last-inserted-timestamp
12976 (concat (substring org-last-inserted-timestamp 0 -1)
12977 " " repeater
12978 (substring org-last-inserted-timestamp -1))))))
12979 (message "Deadline on %s" org-last-inserted-timestamp))))))
12981 (defun org-schedule (arg &optional time)
12982 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12983 With one universal prefix argument, remove any scheduling date from the item.
12984 With two universal prefix arguments, prompt for a delay cookie.
12985 With argument TIME, scheduled at the corresponding date. TIME can
12987 (interactive "P")
12988 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12989 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12990 'region-start-level 'region))
12991 org-loop-over-headlines-in-active-region)
12992 (org-map-entries
12993 `(org-schedule ',arg ,time)
12994 org-loop-over-headlines-in-active-region
12995 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12996 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12997 (old-date-time (if old-date (org-time-string-to-time old-date)))
12998 (repeater (and old-date
12999 (string-match
13001 old-date)
13002 (match-string 1 old-date))))
13003 (cond
13004 ((equal arg '(4))
13005 (progn
13006 (when (and old-date org-log-reschedule)
13007 (org-add-log-setup 'delschedule nil old-date 'findpos
13008 org-log-reschedule))
13009 (org-remove-timestamp-with-keyword org-scheduled-string)
13010 (message "Item is no longer scheduled.")))
13011 ((equal arg '(16))
13012 (save-excursion
13013 (if (re-search-forward
13014 org-scheduled-time-regexp
13015 (save-excursion (outline-next-heading) (point)) t)
13016 (let* ((rpl0 (match-string 1))
13017 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13018 (replace-match
13019 (concat org-scheduled-string
13020 " <" rpl
13021 (format " -%dd"
13022 (abs
13023 (- (time-to-days
13024 (save-match-data
13025 (org-read-date nil t nil "Delay until" old-date-time)))
13026 (time-to-days old-date-time))))
13027 ">") t t))
13028 (user-error "No scheduled information to update"))))
13029 (t
13030 (org-add-planning-info 'scheduled time 'closed)
13031 (when (and old-date org-log-reschedule
13032 (not (equal old-date
13033 (substring org-last-inserted-timestamp 1 -1))))
13034 (org-add-log-setup 'reschedule nil old-date 'findpos
13035 org-log-reschedule))
13036 (when repeater
13037 (save-excursion
13038 (org-back-to-heading t)
13039 (when (re-search-forward (concat org-scheduled-string " "
13040 org-last-inserted-timestamp)
13041 (save-excursion
13042 (outline-next-heading) (point)) t)
13043 (goto-char (1- (match-end 0)))
13044 (insert " " repeater)
13045 (setq org-last-inserted-timestamp
13046 (concat (substring org-last-inserted-timestamp 0 -1)
13047 " " repeater
13048 (substring org-last-inserted-timestamp -1))))))
13049 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13051 (defun org-get-scheduled-time (pom &optional inherit)
13052 "Get the scheduled time as a time tuple, of a format suitable
13053 for calling org-schedule with, or if there is no scheduling,
13054 returns nil."
13055 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13056 (when time
13057 (apply 'encode-time (org-parse-time-string time)))))
13059 (defun org-get-deadline-time (pom &optional inherit)
13060 "Get the deadline as a time tuple, of a format suitable for
13061 calling org-deadline with, or if there is no scheduling, returns
13062 nil."
13063 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13064 (when time
13065 (apply 'encode-time (org-parse-time-string time)))))
13067 (defun org-remove-timestamp-with-keyword (keyword)
13068 "Remove all time stamps with KEYWORD in the current entry."
13070 beg)
13071 (save-excursion
13072 (org-back-to-heading t)
13073 (setq beg (point))
13074 (outline-next-heading)
13075 (while (re-search-backward re beg t)
13076 (replace-match "")
13078 (equal (char-before) ?\ ))
13079 (backward-delete-char 1)
13081 (point-at-bol) (point-at-eol)))
13082 (delete-region (point-at-bol)
13083 (min (point-max) (1+ (point-at-eol))))))))))
13085 (defun org-add-planning-info (what &optional time &rest remove)
13086 "Insert new timestamp with keyword in the line directly after the headline.
13087 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13088 If non is given, the user is prompted for a date.
13089 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13090 be removed."
13091 (interactive)
13092 (let (org-time-was-given org-end-time-was-given ts
13093 end default-time default-input)
13095 (catch 'exit
13096 (when (and (memq what '(scheduled deadline))
13097 (or (not time)
13098 (and (stringp time)
13099 (string-match "^[-+]+[0-9]" time))))
13100 ;; Try to get a default date/time from existing timestamp
13101 (save-excursion
13102 (org-back-to-heading t)
13103 (setq end (save-excursion (outline-next-heading) (point)))
13104 (when (re-search-forward (if (eq what 'scheduled)
13105 org-scheduled-time-regexp
13106 org-deadline-time-regexp)
13107 end t)
13108 (setq ts (match-string 1)
13109 default-time
13110 (apply 'encode-time (org-parse-time-string ts))
13111 default-input (and ts (org-get-compact-tod ts))))))
13112 (when what
13113 (setq time
13114 (if (stringp time)
13115 ;; This is a string (relative or absolute), set proper date
13116 (apply 'encode-time
13117 (org-read-date-analyze
13118 time default-time (decode-time default-time)))
13119 ;; If necessary, get the time from the user
13120 (or time (org-read-date nil 'to-time nil nil
13121 default-time default-input)))))
13123 (when (and org-insert-labeled-timestamps-at-point
13124 (member what '(scheduled deadline)))
13125 (insert
13126 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13127 (org-insert-time-stamp time org-time-was-given
13128 nil nil nil (list org-end-time-was-given))
13129 (setq what nil))
13130 (save-excursion
13131 (save-restriction
13132 (let (col list elt ts buffer-invisibility-spec)
13133 (org-back-to-heading t)
13135 (goto-char (match-end 1))
13136 (setq col (current-column))
13137 (goto-char (match-end 0))
13139 (when (and (not what)
13140 (not (looking-at
13142 org-keyword-time-not-clock-regexp))))
13143 ;; Nothing to add, nothing to remove...... :-)
13144 (throw 'exit nil))
13145 (if (and (not (looking-at org-outline-regexp))
13148 (not (equal (match-string 1) org-clock-string)))
13149 (narrow-to-region (match-beginning 0) (match-end 0))
13151 (backward-char 1)
13152 (narrow-to-region (point) (point))
13153 (and org-adapt-indentation (org-indent-to-column col)))
13154 ;; Check if we have to remove something.
13155 (setq list (cons what remove))
13156 (while list
13157 (setq elt (pop list))
13158 (when (or (and (eq elt 'scheduled)
13159 (re-search-forward org-scheduled-time-regexp nil t))
13160 (and (eq elt 'deadline)
13161 (re-search-forward org-deadline-time-regexp nil t))
13162 (and (eq elt 'closed)
13163 (re-search-forward org-closed-time-regexp nil t)))
13164 (replace-match "")
13165 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13167 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13168 (when what
13169 (insert
13170 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13171 (cond ((eq what 'scheduled) org-scheduled-string)
13172 ((eq what 'deadline) org-deadline-string)
13173 ((eq what 'closed) org-closed-string))
13174 " ")
13175 (setq ts (org-insert-time-stamp
13176 time
13177 (or org-time-was-given
13178 (and (eq what 'closed) org-log-done-with-time))
13179 (eq what 'closed)
13180 nil nil (list org-end-time-was-given)))
13181 (insert
13182 (if (not (or (bolp) (eq (char-before) ?\ )
13183 (memq (char-after) '(32 10))
13184 (eobp))) " " ""))
13185 (end-of-line 1))
13186 (goto-char (point-min))
13187 (widen)
13190 (delete-region (1- (point)) (point-at-eol)))
13191 ts))))))
13193 (defvar org-log-note-marker (make-marker))
13194 (defvar org-log-note-purpose nil)
13195 (defvar org-log-note-state nil)
13196 (defvar org-log-note-previous-state nil)
13197 (defvar org-log-note-how nil)
13198 (defvar org-log-note-extra nil)
13199 (defvar org-log-note-window-configuration nil)
13200 (defvar org-log-note-return-to (make-marker))
13201 (defvar org-log-note-effective-time nil
13202 "Remembered current time so that dynamically scoped
13203 `org-extend-today-until' affects tha timestamps in state change
13204 log")
13206 (defvar org-log-post-message nil
13207 "Message to be displayed after a log note has been stored.
13208 The auto-repeater uses this.")
13210 (defun org-add-note ()
13211 "Add a note to the current entry.
13212 This is done in the same way as adding a state change note."
13213 (interactive)
13214 (org-add-log-setup 'note nil nil 'findpos nil))
13216 (defvar org-property-end-re)
13217 (defun org-add-log-setup (&optional purpose state prev-state
13218 findpos how extra)
13219 "Set up the post command hook to take a note.
13220 If this is about to TODO state change, the new state is expected in STATE.
13221 When FINDPOS is non-nil, find the correct position for the note in
13222 the current entry. If not, assume that it can be inserted at point.
13223 HOW is an indicator what kind of note should be created.
13224 EXTRA is additional text that will be inserted into the notes buffer."
13225 (let* ((org-log-into-drawer (org-log-into-drawer))
13226 (drawer (cond ((stringp org-log-into-drawer)
13227 org-log-into-drawer)
13228 (org-log-into-drawer "LOGBOOK"))))
13229 (save-restriction
13230 (save-excursion
13231 (when findpos
13232 (org-back-to-heading t)
13233 (narrow-to-region (point) (save-excursion
13234 (outline-next-heading) (point)))
13238 (goto-char (match-end 0))
13239 (cond
13240 (drawer
13242 nil t)
13243 (progn
13244 (goto-char (match-end 0))
13245 (or org-log-states-order-reversed
13246 (and (re-search-forward org-property-end-re nil t)
13247 (goto-char (1- (match-beginning 0))))))
13249 (beginning-of-line 0)
13250 (org-indent-line)
13251 (beginning-of-line 2)
13252 (org-indent-line)
13253 (end-of-line 0)))
13254 ((and org-log-state-notes-insert-after-drawers
13255 (save-excursion
13256 (forward-line) (looking-at org-drawer-regexp)))
13257 (forward-line)
13258 (while (looking-at org-drawer-regexp)
13259 (goto-char (match-end 0))
13260 (re-search-forward org-property-end-re (point-max) t)
13261 (forward-line))
13262 (forward-line -1)))
13263 (unless org-log-states-order-reversed
13265 (org-skip-over-state-notes)
13267 (move-marker org-log-note-marker (point))
13268 (setq org-log-note-purpose purpose
13269 org-log-note-state state
13270 org-log-note-previous-state prev-state
13271 org-log-note-how how
13272 org-log-note-extra extra
13273 org-log-note-effective-time (org-current-effective-time))
13274 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13276 (defun org-skip-over-state-notes ()
13277 "Skip past the list of State notes in an entry."
13279 (when (ignore-errors (goto-char (org-in-item-p)))
13280 (let* ((struct (org-list-struct))
13281 (prevs (org-list-prevs-alist struct)))
13283 (goto-char (or (org-list-get-next-item (point) struct prevs)
13284 (org-list-get-item-end (point) struct)))))))
13286 (defun org-add-log-note (&optional purpose)
13287 "Pop up a window for taking a note, and add this note later at point."
13288 (remove-hook 'post-command-hook 'org-add-log-note)
13289 (setq org-log-note-window-configuration (current-window-configuration))
13290 (delete-other-windows)
13291 (move-marker org-log-note-return-to (point))
13292 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13293 (goto-char org-log-note-marker)
13294 (org-switch-to-buffer-other-window "*Org Note*")
13295 (erase-buffer)
13296 (if (memq org-log-note-how '(time state))
13297 (let (current-prefix-arg) (org-store-log-note))
13298 (let ((org-inhibit-startup t)) (org-mode))
13299 (insert (format "# Insert note for %s.
13301 (cond
13302 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13303 ((eq org-log-note-purpose 'done) "closed todo item")
13304 ((eq org-log-note-purpose 'state)
13306 (or org-log-note-previous-state "")
13307 (or org-log-note-state "")))
13308 ((eq org-log-note-purpose 'reschedule)
13309 "rescheduling")
13310 ((eq org-log-note-purpose 'delschedule)
13311 "no longer scheduled")
13312 ((eq org-log-note-purpose 'redeadline)
13313 "changing deadline")
13314 ((eq org-log-note-purpose 'deldeadline)
13315 "removing deadline")
13316 ((eq org-log-note-purpose 'refile)
13317 "refiling")
13318 ((eq org-log-note-purpose 'note)
13319 "this entry")
13320 (t (error "This should not happen")))))
13321 (if org-log-note-extra (insert org-log-note-extra))
13322 (org-set-local 'org-finish-function 'org-store-log-note)
13323 (run-hooks 'org-log-buffer-setup-hook)))
13325 (defvar org-note-abort nil) ; dynamically scoped
13326 (defun org-store-log-note ()
13327 "Finish taking a log note, and insert it to where it belongs."
13328 (let ((txt (buffer-string)))
13329 (kill-buffer (current-buffer))
13330 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13331 lines ind bul)
13333 (setq txt (replace-match "" t t txt)))
13335 (setq txt (replace-match "" t t txt)))
13338 (setq note
13339 (org-replace-escapes
13340 note
13341 (list (cons "%u" (user-login-name))
13342 (cons "%U" user-full-name)
13343 (cons "%t" (format-time-string
13344 (org-time-stamp-format 'long 'inactive)
13345 org-log-note-effective-time))
13346 (cons "%T" (format-time-string
13347 (org-time-stamp-format 'long nil)
13348 org-log-note-effective-time))
13349 (cons "%d" (format-time-string
13350 (org-time-stamp-format nil 'inactive)
13351 org-log-note-effective-time))
13352 (cons "%D" (format-time-string
13353 (org-time-stamp-format nil nil)
13354 org-log-note-effective-time))
13355 (cons "%s" (if org-log-note-state
13357 ""))
13358 (cons "%S" (if org-log-note-previous-state
13362 (push note lines))
13363 (when (or current-prefix-arg org-note-abort)
13364 (when org-log-into-drawer
13365 (org-remove-empty-drawer-at
13366 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13367 org-log-note-marker))
13368 (setq lines nil))
13369 (when lines
13370 (with-current-buffer (marker-buffer org-log-note-marker)
13371 (save-excursion
13372 (goto-char org-log-note-marker)
13373 (move-marker org-log-note-marker nil)
13374 (end-of-line 1)
13376 (setq ind (save-excursion
13377 (if (ignore-errors (goto-char (org-in-item-p)))
13378 (let ((struct (org-list-struct)))
13379 (org-list-get-ind
13380 (org-list-get-top-point struct) struct))
13382 (cond
13383 ((and (org-at-heading-p)
13384 org-adapt-indentation)
13385 (1+ (org-current-level)))
13386 ((org-at-heading-p) 0)
13387 (t (org-get-indentation))))))
13388 (setq bul (org-list-bullet-string "-"))
13389 (org-indent-line-to ind)
13390 (insert bul (pop lines))
13391 (let ((ind-body (+ (length bul) ind)))
13392 (while lines
13394 (org-indent-line-to ind-body)
13395 (insert (pop lines))))
13396 (message "Note stored")
13397 (org-back-to-heading t)
13398 (org-cycle-hide-drawers 'children))
13399 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13400 ;; from within `org-add-log-note' because `buffer-undo-list'
13401 ;; is then modified outside of `org-with-remote-undo'.
13402 (when (eq this-command 'org-agenda-todo)
13403 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13404 ;; Don't add undo information when called from `org-agenda-todo'
13405 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13406 (set-window-configuration org-log-note-window-configuration)
13407 (with-current-buffer (marker-buffer org-log-note-return-to)
13408 (goto-char org-log-note-return-to))
13409 (move-marker org-log-note-return-to nil)
13410 (and org-log-post-message (message "%s" org-log-post-message))))
13412 (defun org-remove-empty-drawer-at (drawer pos)
13413 "Remove an empty drawer DRAWER at position POS.
13414 POS may also be a marker."
13415 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13416 (save-excursion
13417 (save-restriction
13418 (widen)
13419 (goto-char pos)
13420 (if (org-in-regexp
13422 (replace-match ""))))))
13424 (defvar org-ts-type nil)
13425 (defun org-sparse-tree (&optional arg type)
13426 "Create a sparse tree, prompt for the details.
13427 This command can create sparse trees. You first need to select the type
13428 of match used to create the tree:
13430 t Show all TODO entries.
13431 T Show entries with a specific TODO keyword.
13432 m Show entries selected by a tags/property match.
13433 p Enter a property name and its value (both with completion on existing
13434 names/values) and show entries with that property.
13435 r Show entries matching a regular expression (`/' can be used as well).
13436 b Show deadlines and scheduled items before a date.
13437 a Show deadlines and scheduled items after a date.
13438 d Show deadlines due within `org-deadline-warning-days'.
13439 D Show deadlines and scheduled items between a date range."
13440 (interactive "P")
13441 (let (ans kwd value ts-type)
13442 (setq type (or type org-sparse-tree-default-date-type))
13443 (setq org-ts-type type)
13444 (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"
13445 (cond ((eq type 'all) "all timestamps")
13446 ((eq type 'scheduled) "only scheduled")
13447 ((eq type 'deadline) "only deadline")
13448 ((eq type 'active) "only active timestamps")
13449 ((eq type 'inactive) "only inactive timestamps")
13450 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13451 ((eq type 'closed) "with a closed time-stamp")
13452 (t "scheduled/deadline")))
13453 (setq ans (read-char-exclusive))
13454 (cond
13455 ((equal ans ?c)
13456 (org-sparse-tree
13457 arg (cadr (member type '(scheduled-or-deadline
13458 all scheduled deadline active inactive closed)))))
13459 ((equal ans ?d)
13460 (call-interactively 'org-check-deadlines))
13461 ((equal ans ?b)
13462 (call-interactively 'org-check-before-date))
13463 ((equal ans ?a)
13464 (call-interactively 'org-check-after-date))
13465 ((equal ans ?D)
13466 (call-interactively 'org-check-dates-range))
13467 ((equal ans ?t)
13468 (call-interactively 'org-show-todo-tree))
13469 ((equal ans ?T)
13470 (org-show-todo-tree '(4)))
13471 ((member ans '(?T ?m))
13472 (call-interactively 'org-match-sparse-tree))
13473 ((member ans '(?p ?P))
13474 (setq kwd (org-icompleting-read "Property: "
13475 (mapcar 'list (org-buffer-property-keys))))
13476 (setq value (org-icompleting-read "Value: "
13477 (mapcar 'list (org-property-values kwd))))
13480 (org-match-sparse-tree arg (concat kwd "=" value)))
13481 ((member ans '(?r ?R ?/))
13482 (call-interactively 'org-occur))
13485 (defvar org-occur-highlights nil
13486 "List of overlays used for occur matches.")
13487 (make-variable-buffer-local 'org-occur-highlights)
13488 (defvar org-occur-parameters nil
13489 "Parameters of the active org-occur calls.
13490 This is a list, each call to org-occur pushes as cons cell,
13491 containing the regular expression and the callback, onto the list.
13492 The list can contain several entries if `org-occur' has been called
13493 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13494 will only contain one set of parameters. When the highlights are
13495 removed (for example with `C-c C-c', or with the next edit (depending
13496 on `org-remove-highlights-with-change'), this variable is emptied
13497 as well.")
13498 (make-variable-buffer-local 'org-occur-parameters)
13500 (defun org-occur (regexp &optional keep-previous callback)
13501 "Make a compact tree which shows all matches of REGEXP.
13502 The tree will show the lines where the regexp matches, and all higher
13503 headlines above the match. It will also show the heading after the match,
13504 to make sure editing the matching entry is easy.
13505 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13506 call to `org-occur' will be kept, to allow stacking of calls to this
13507 command.
13508 If CALLBACK is non-nil, it is a function which is called to confirm
13509 that the match should indeed be shown."
13511 (when (equal regexp "")
13512 (user-error "Regexp cannot be empty"))
13513 (unless keep-previous
13514 (org-remove-occur-highlights nil nil t))
13515 (push (cons regexp callback) org-occur-parameters)
13516 (let ((cnt 0))
13517 (save-excursion
13518 (goto-char (point-min))
13519 (if (or (not keep-previous) ; do not want to keep
13520 (not org-occur-highlights)) ; no previous matches
13521 ;; hide everything
13522 (org-overview))
13523 (while (re-search-forward regexp nil t)
13524 (when (or (not callback)
13525 (save-match-data (funcall callback)))
13526 (setq cnt (1+ cnt))
13527 (when org-highlight-sparse-tree-matches
13528 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13529 (org-show-context 'occur-tree))))
13530 (when org-remove-highlights-with-change
13531 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13532 nil 'local))
13533 (unless org-sparse-tree-open-archived-trees
13534 (org-hide-archived-subtrees (point-min) (point-max)))
13535 (run-hooks 'org-occur-hook)
13536 (if (org-called-interactively-p 'interactive)
13537 (message "%d match(es) for regexp %s" cnt regexp))
13538 cnt))
13540 (defun org-occur-next-match (&optional n reset)
13541 "Function for `next-error-function' to find sparse tree matches.
13542 N is the number of matches to move, when negative move backwards.
13543 RESET is entirely ignored - this function always goes back to the
13544 starting point when no match is found."
13545 (let* ((limit (if (< n 0) (point-min) (point-max)))
13546 (search-func (if (< n 0)
13547 'previous-single-char-property-change
13548 'next-single-char-property-change))
13549 (n (abs n))
13550 (pos (point))
13551 p1)
13552 (catch 'exit
13553 (while (setq p1 (funcall search-func (point) 'org-type))
13554 (when (equal p1 limit)
13555 (goto-char pos)
13556 (error "No more matches"))
13557 (when (equal (get-char-property p1 'org-type) 'org-occur)
13558 (setq n (1- n))
13559 (when (= n 0)
13560 (goto-char p1)
13561 (throw 'exit (point))))
13562 (goto-char p1))
13563 (goto-char p1)
13564 (error "No more matches"))))
13566 (defun org-show-context (&optional key)
13567 "Make sure point and context are visible.
13568 How much context is shown depends upon the variables
13569 `org-show-hierarchy-above', `org-show-following-heading',
13570 `org-show-entry-below' and `org-show-siblings'."
13571 (let ((heading-p (org-at-heading-p t))
13572 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13573 (following-p (org-get-alist-option org-show-following-heading key))
13574 (entry-p (org-get-alist-option org-show-entry-below key))
13575 (siblings-p (org-get-alist-option org-show-siblings key)))
13576 ;; Show heading or entry text
13577 (if (and heading-p (not entry-p))
13578 (org-flag-heading nil) ; only show the heading
13579 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13580 (org-show-hidden-entry))) ; show entire entry
13581 (when following-p
13582 ;; Show next sibling, or heading below text
13583 (save-excursion
13584 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13585 (org-flag-heading nil))))
13586 (when siblings-p (org-show-siblings))
13587 (when hierarchy-p
13588 ;; show all higher headings, possibly with siblings
13589 (save-excursion
13590 (while (and (condition-case nil
13591 (progn (org-up-heading-all 1) t)
13592 (error nil))
13593 (not (bobp)))
13594 (org-flag-heading nil)
13595 (when siblings-p (org-show-siblings)))))
13596 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13598 (defvar org-reveal-start-hook nil
13599 "Hook run before revealing a location.")
13601 (defun org-reveal (&optional siblings)
13602 "Show current entry, hierarchy above it, and the following headline.
13603 This can be used to show a consistent set of context around locations
13604 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13605 not t for the search context.
13607 With optional argument SIBLINGS, on each level of the hierarchy all
13608 siblings are shown. This repairs the tree structure to what it would
13609 look like when opened with hierarchical calls to `org-cycle'.
13611 go to the parent and show the
13612 entire tree."
13613 (interactive "P")
13614 (run-hooks 'org-reveal-start-hook)
13615 (let ((org-show-hierarchy-above t)
13616 (org-show-following-heading t)
13617 (org-show-siblings (if siblings t org-show-siblings)))
13618 (org-show-context nil))
13619 (when (equal siblings '(16))
13620 (save-excursion
13621 (when (org-up-heading-safe)
13622 (org-show-subtree)
13623 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13625 (defun org-highlight-new-match (beg end)
13626 "Highlight from BEG to END and mark the highlight is an occur headline."
13627 (let ((ov (make-overlay beg end)))
13628 (overlay-put ov 'face 'secondary-selection)
13629 (overlay-put ov 'org-type 'org-occur)
13630 (push ov org-occur-highlights)))
13632 (defun org-remove-occur-highlights (&optional beg end noremove)
13633 "Remove the occur highlights from the buffer.
13634 BEG and END are ignored. If NOREMOVE is nil, remove this function
13635 from the `before-change-functions' in the current buffer."
13636 (interactive)
13637 (unless org-inhibit-highlight-removal
13638 (mapc 'delete-overlay org-occur-highlights)
13639 (setq org-occur-highlights nil)
13640 (setq org-occur-parameters nil)
13641 (unless noremove
13642 (remove-hook 'before-change-functions
13643 'org-remove-occur-highlights 'local))))
13645 ;;;; Priorities
13648 "Regular expression matching the priority indicator.")
13650 (defvar org-remove-priority-next-time nil)
13652 (defun org-priority-up ()
13653 "Increase the priority of the current item."
13654 (interactive)
13655 (org-priority 'up))
13657 (defun org-priority-down ()
13658 "Decrease the priority of the current item."
13659 (interactive)
13660 (org-priority 'down))
13662 (defun org-priority (&optional action show)
13663 "Change the priority of an item.
13664 ACTION can be `set', `up', `down', or a character."
13665 (interactive "P")
13666 (if (equal action '(4))
13667 (org-show-priority)
13668 (unless org-enable-priority-commands
13669 (user-error "Priority commands are disabled"))
13670 (setq action (or action 'set))
13671 (let (current new news have remove)
13672 (save-excursion
13673 (org-back-to-heading t)
13674 (if (looking-at org-priority-regexp)
13675 (setq current (string-to-char (match-string 2))
13676 have t))
13677 (cond
13678 ((eq action 'remove)
13679 (setq remove t new ?\ ))
13680 ((or (eq action 'set)
13681 (if (featurep 'xemacs) (characterp action) (integerp action)))
13682 (if (not (eq action 'set))
13683 (setq new action)
13684 (message "Priority %c-%c, SPC to remove: "
13685 org-highest-priority org-lowest-priority)
13686 (save-match-data
13687 (setq new (read-char-exclusive))))
13688 (if (and (= (upcase org-highest-priority) org-highest-priority)
13689 (= (upcase org-lowest-priority) org-lowest-priority))
13690 (setq new (upcase new)))
13691 (cond ((equal new ?\ ) (setq remove t))
13692 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13693 (user-error "Priority must be between `%c' and `%c'"
13694 org-highest-priority org-lowest-priority))))
13695 ((eq action 'up)
13696 (setq new (if have
13697 (1- current) ; normal cycling
13698 ;; last priority was empty
13699 (if (eq last-command this-command)
13700 org-lowest-priority ; wrap around empty to lowest
13701 ;; default
13702 (if org-priority-start-cycle-with-default
13703 org-default-priority
13704 (1- org-default-priority))))))
13705 ((eq action 'down)
13706 (setq new (if have
13707 (1+ current) ; normal cycling
13708 ;; last priority was empty
13709 (if (eq last-command this-command)
13710 org-highest-priority ; wrap around empty to highest
13711 ;; default
13712 (if org-priority-start-cycle-with-default
13713 org-default-priority
13714 (1+ org-default-priority))))))
13715 (t (user-error "Invalid action")))
13716 (if (or (< (upcase new) org-highest-priority)
13717 (> (upcase new) org-lowest-priority))
13718 (if (and (memq action '(up down))
13719 (not have) (not (eq last-command this-command)))
13720 ;; `new' is from default priority
13721 (error
13722 "The default can not be set, see `org-default-priority' why")
13723 ;; normal cycling: `new' is beyond highest/lowest priority
13724 ;; and is wrapped around to the empty priority
13725 (setq remove t)))
13726 (setq news (format "%c" new))
13727 (if have
13728 (if remove
13729 (replace-match "" t t nil 1)
13730 (replace-match news t t nil 2))
13731 (if remove
13732 (user-error "No priority cookie found in line")
13733 (let ((case-fold-search nil))
13734 (looking-at org-todo-line-regexp))
13735 (if (match-end 2)
13736 (progn
13737 (goto-char (match-end 2))
13738 (insert " [#" news "]"))
13739 (goto-char (match-beginning 3))
13740 (insert "[#" news "] "))))
13741 (org-preserve-lc (org-set-tags nil 'align)))
13742 (if remove
13743 (message "Priority removed")
13744 (message "Priority of current item set to %s" news)))))
13746 (defun org-show-priority ()
13747 "Show the priority of the current item.
13748 This priority is composed of the main priority given with the [#A] cookies,
13749 and by additional input from the age of a schedules or deadline entry."
13750 (interactive)
13751 (let ((pri (if (eq major-mode 'org-agenda-mode)
13752 (org-get-at-bol 'priority)
13753 (save-excursion
13754 (save-match-data
13755 (beginning-of-line)
13756 (and (looking-at org-heading-regexp)
13757 (org-get-priority (match-string 0))))))))
13758 (message "Priority is %d" (if pri pri -1000))))
13760 (defun org-get-priority (s)
13761 "Find priority cookie and return priority."
13762 (save-match-data
13763 (if (functionp org-get-priority-function)
13764 (funcall org-get-priority-function)
13765 (if (not (string-match org-priority-regexp s))
13766 (* 1000 (- org-lowest-priority org-default-priority))
13767 (* 1000 (- org-lowest-priority
13768 (string-to-char (match-string 2 s))))))))
13770 ;;;; Tags
13772 (defvar org-agenda-archives-mode)
13773 (defvar org-map-continue-from nil
13774 "Position from where mapping should continue.
13775 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13777 (defvar org-scanner-tags nil
13778 "The current tag list while the tags scanner is running.")
13779 (defvar org-trust-scanner-tags nil
13780 "Should `org-get-tags-at' use the tags for the scanner.
13781 This is for internal dynamical scoping only.
13782 When this is non-nil, the function `org-get-tags-at' will return the value
13783 of `org-scanner-tags' instead of building the list by itself. This
13784 can lead to large speed-ups when the tags scanner is used in a file with
13785 many entries, and when the list of tags is retrieved, for example to
13786 obtain a list of properties. Building the tags list for each entry in such
13787 a file becomes an N^2 operation - but with this variable set, it scales
13788 as N.")
13790 (defun org-scan-tags (action matcher todo-only &optional start-level)
13791 "Sca headline tags with inheritance and produce output ACTION.
13793 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13794 or `agenda' to produce an entry list for an agenda view. It can also be
13795 a Lisp form or a function that should be called at each matched headline, in
13796 this case the return value is a list of all return values from these calls.
13798 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13799 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13800 only lines with a not-done TODO keyword are included in the output.
13801 This should be the same variable that was scoped into
13802 and set by `org-make-tags-matcher' when it constructed MATCHER.
13804 START-LEVEL can be a string with asterisks, reducing the scope to
13805 headlines matching this string."
13806 (require 'org-agenda)
13807 (let* ((re (concat "^"
13808 (if start-level
13809 ;; Get the correct level to match
13811 org-outline-regexp)
13815 (props (list 'face 'default
13816 'done-face 'org-agenda-done
13817 'undone-face 'default
13818 'mouse-face 'highlight
13819 'org-not-done-regexp org-not-done-regexp
13820 'org-todo-regexp org-todo-regexp
13821 'org-complex-heading-regexp org-complex-heading-regexp
13822 'help-echo
13823 (format "mouse-2 or RET jump to org file %s"
13824 (abbreviate-file-name
13825 (or (buffer-file-name (buffer-base-buffer))
13826 (buffer-name (buffer-base-buffer)))))))
13827 (org-map-continue-from nil)
13828 lspos tags tags-list
13829 (tags-alist (list (cons 0 org-file-tags)))
13830 (llast 0) rtn rtn1 level category i txt
13831 todo marker entry priority)
13832 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13833 (setq action (list 'lambda nil action)))
13834 (save-excursion
13835 (goto-char (point-min))
13836 (when (eq action 'sparse-tree)
13837 (org-overview)
13838 (org-remove-occur-highlights))
13839 (while (let (case-fold-search)
13840 (re-search-forward re nil t))
13841 (setq org-map-continue-from nil)
13842 (catch :skip
13843 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13844 tags (if (match-end 4) (org-match-string-no-properties 4)))
13845 (goto-char (setq lspos (match-beginning 0)))
13846 (setq level (org-reduced-level (org-outline-level))
13847 category (org-get-category))
13848 (setq i llast llast level)
13849 ;; remove tag lists from same and sublevels
13850 (while (>= i level)
13851 (when (setq entry (assoc i tags-alist))
13852 (setq tags-alist (delete entry tags-alist)))
13853 (setq i (1- i)))
13854 ;; add the next tags
13855 (when tags
13856 (setq tags (org-split-string tags ":")
13857 tags-alist
13858 (cons (cons level tags) tags-alist)))
13859 ;; compile tags for current headline
13860 (setq tags-list
13861 (if org-use-tag-inheritance
13862 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13863 tags)
13864 org-scanner-tags tags-list)
13865 (when org-use-tag-inheritance
13866 (setcdr (car tags-alist)
13867 (mapcar (lambda (x)
13868 (setq x (copy-sequence x))
13869 (org-add-prop-inherited x))
13870 (cdar tags-alist))))
13871 (when (and tags org-use-tag-inheritance
13872 (or (not (eq t org-use-tag-inheritance))
13873 org-tags-exclude-from-inheritance))
13874 ;; selective inheritance, remove uninherited ones
13875 (setcdr (car tags-alist)
13876 (org-remove-uninherited-tags (cdar tags-alist))))
13877 (when (and
13879 ;; eval matcher only when the todo condition is OK
13880 (and (or (not todo-only) (member todo org-not-done-keywords))
13881 (let ((case-fold-search t) (org-trust-scanner-tags t))
13882 (eval matcher)))
13884 ;; Call the skipper, but return t if it does not skip,
13885 ;; so that the `and' form continues evaluating
13886 (progn
13887 (unless (eq action 'sparse-tree) (org-agenda-skip))
13888 t)
13890 ;; Check if timestamps are deselecting this entry
13891 (or (not todo-only)
13892 (and (member todo org-not-done-keywords)
13893 (or (not org-agenda-tags-todo-honor-ignore-options)
13894 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13896 ;; select this headline
13897 (cond
13898 ((eq action 'sparse-tree)
13899 (and org-highlight-sparse-tree-matches
13900 (org-get-heading) (match-end 0)
13901 (org-highlight-new-match
13902 (match-beginning 1) (match-end 1)))
13903 (org-show-context 'tags-tree))
13904 ((eq action 'agenda)
13905 (setq txt (org-agenda-format-item
13906 ""
13907 (concat
13908 (if (eq org-tags-match-list-sublevels 'indented)
13909 (make-string (1- level) ?.) "")
13910 (org-get-heading))
13911 level category
13912 tags-list)
13913 priority (org-get-priority txt))
13914 (goto-char lspos)
13915 (setq marker (org-agenda-new-marker))
13916 (org-add-props txt props
13917 'org-marker marker 'org-hd-marker marker 'org-category category
13918 'todo-state todo
13919 'priority priority 'type "tagsmatch")
13920 (push txt rtn))
13921 ((functionp action)
13922 (setq org-map-continue-from nil)
13923 (save-excursion
13924 (setq rtn1 (funcall action))
13925 (push rtn1 rtn)))
13926 (t (user-error "Invalid action")))
13928 ;; if we are to skip sublevels, jump to end of subtree
13929 (unless org-tags-match-list-sublevels
13930 (org-end-of-subtree t)
13931 (backward-char 1))))
13932 ;; Get the correct position from where to continue
13933 (if org-map-continue-from
13934 (goto-char org-map-continue-from)
13935 (and (= (point) lspos) (end-of-line 1)))))
13936 (when (and (eq action 'sparse-tree)
13937 (not org-sparse-tree-open-archived-trees))
13938 (org-hide-archived-subtrees (point-min) (point-max)))
13939 (nreverse rtn)))
13941 (defun org-remove-uninherited-tags (tags)
13942 "Remove all tags that are not inherited from the list TAGS."
13943 (cond
13944 ((eq org-use-tag-inheritance t)
13945 (if org-tags-exclude-from-inheritance
13946 (org-delete-all org-tags-exclude-from-inheritance tags)
13947 tags))
13948 ((not org-use-tag-inheritance) nil)
13949 ((stringp org-use-tag-inheritance)
13950 (delq nil (mapcar
13951 (lambda (x)
13952 (if (and (string-match org-use-tag-inheritance x)
13953 (not (member x org-tags-exclude-from-inheritance)))
13954 x nil))
13955 tags)))
13956 ((listp org-use-tag-inheritance)
13957 (delq nil (mapcar
13958 (lambda (x)
13959 (if (member x org-use-tag-inheritance) x nil))
13960 tags)))))
13962 (defun org-match-sparse-tree (&optional todo-only match)
13963 "Create a sparse tree according to tags string MATCH.
13964 MATCH can contain positive and negative selection of tags, like
13966 If optional argument TODO-ONLY is non-nil, only select lines that are
13967 also TODO lines."
13968 (interactive "P")
13969 (org-agenda-prepare-buffers (list (current-buffer)))
13970 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13972 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13974 (defvar org-cached-props nil)
13975 (defun org-cached-entry-get (pom property)
13976 (if (or (eq t org-use-property-inheritance)
13977 (and (stringp org-use-property-inheritance)
13978 (string-match org-use-property-inheritance property))
13979 (and (listp org-use-property-inheritance)
13980 (member property org-use-property-inheritance)))
13981 ;; Caching is not possible, check it directly
13982 (org-entry-get pom property 'inherit)
13983 ;; Get all properties, so that we can do complicated checks easily
13984 (cdr (assoc property (or org-cached-props
13985 (setq org-cached-props
13986 (org-entry-properties pom)))))))
13988 (defun org-global-tags-completion-table (&optional files)
13989 "Return the list of all tags in all agenda buffer/files.
13990 Optional FILES argument is a list of files which can be used
13991 instead of the agenda files."
13992 (save-excursion
13993 (org-uniquify
13994 (delq nil
13995 (apply 'append
13996 (mapcar
13997 (lambda (file)
13998 (set-buffer (find-file-noselect file))
13999 (append (org-get-buffer-tags)
14000 (mapcar (lambda (x) (if (stringp (car-safe x))
14001 (list (car-safe x)) nil))
14002 org-tag-alist)))
14003 (if (and files (car files))
14004 files
14005 (org-agenda-files))))))))
14007 (defun org-make-tags-matcher (match)
14008 "Create the TAGS/TODO matcher form for the selection string MATCH.
14010 The variable `todo-only' is scoped dynamically into this function.
14011 It will be set to t if the matcher restricts matching to TODO entries,
14012 otherwise will not be touched.
14014 Returns a cons of the selection string MATCH and the constructed
14015 lisp form implementing the matcher. The matcher is to be evaluated
14016 at an Org entry, with point on the headline, and returns t if the
14017 entry matches the selection string MATCH. The returned lisp form
14018 references two variables with information about the entry, which
14019 must be bound around the form's evaluation: todo, the TODO keyword
14020 at the entry (or nil of none); and tags-list, the list of all tags
14021 at the entry including inherited ones. Additionally, the category
14022 of the entry (if any) must be specified as the text property
14023 'org-category on the headline.
14025 See also `org-scan-tags'.
14026 "
14027 (declare (special todo-only))
14028 (unless (boundp 'todo-only)
14029 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14030 (unless match
14031 ;; Get a new match request, with completion against the global
14032 ;; tags table and the local tags in current buffer
14033 (let ((org-last-tags-completion-table
14034 (org-uniquify
14035 (delq nil (append (org-get-buffer-tags)
14036 (org-global-tags-completion-table))))))
14037 (setq match (org-completing-read-no-i
14038 "Match: " 'org-tags-completion-function nil nil nil
14039 'org-tags-history))))
14041 ;; Parse the string and create a lisp form
14042 (let ((match0 match)
14043 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14044 minus tag mm
14045 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14046 orterms term orlist re-p str-p level-p level-op time-p
14047 prop-p pn pv po gv rest)
14048 ;; Expand group tags
14049 (setq match (org-tags-expand match))
14050 (if (string-match "/+" match)
14051 ;; match contains also a todo-matching request
14052 (progn
14053 (setq tagsmatch (substring match 0 (match-beginning 0))
14054 todomatch (substring match (match-end 0)))
14055 (if (string-match "^!" todomatch)
14056 (setq todo-only t todomatch (substring todomatch 1)))
14058 (setq todomatch nil)))
14059 ;; only matching tags
14060 (setq tagsmatch match todomatch nil))
14062 ;; Make the tags matcher
14064 (setq tagsmatcher t)
14065 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14066 (while (setq term (pop orterms))
14068 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14069 (while (string-match re term)
14070 (setq rest (substring term (match-end 0))
14071 minus (and (match-end 1)
14072 (equal (match-string 1 term) "-"))
14073 tag (save-match-data (replace-regexp-in-string
14075 (match-string 2 term)))
14076 re-p (equal (string-to-char tag) ?{)
14077 level-p (match-end 4)
14078 prop-p (match-end 5)
14079 mm (cond
14080 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14081 (level-p
14082 (setq level-op (org-op-to-function (match-string 3 term)))
14083 `(,level-op level ,(string-to-number
14084 (match-string 4 term))))
14085 (prop-p
14086 (setq pn (match-string 5 term)
14087 po (match-string 6 term)
14088 pv (match-string 7 term)
14089 re-p (equal (string-to-char pv) ?{)
14091 time-p (save-match-data
14093 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14094 (if time-p (setq pv (org-matcher-time pv)))
14095 (setq po (org-op-to-function po (if time-p 'time str-p)))
14096 (cond
14097 ((equal pn "CATEGORY")
14098 (setq gv '(get-text-property (point) 'org-category)))
14099 ((equal pn "TODO")
14100 (setq gv 'todo))
14101 (t
14102 (setq gv `(org-cached-entry-get nil ,pn))))
14103 (if re-p
14104 (if (eq po 'org<>)
14105 `(not (string-match ,pv (or ,gv "")))
14106 `(string-match ,pv (or ,gv "")))
14107 (if str-p
14108 `(,po (or ,gv "") ,pv)
14109 `(,po (string-to-number (or ,gv ""))
14110 ,(string-to-number pv) ))))
14111 (t `(member ,tag tags-list)))
14112 mm (if minus (list 'not mm) mm)
14113 term rest)
14114 (push mm tagsmatcher))
14115 (push (if (> (length tagsmatcher) 1)
14116 (cons 'and tagsmatcher)
14117 (car tagsmatcher))
14118 orlist)
14119 (setq tagsmatcher nil))
14120 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14121 (setq tagsmatcher
14122 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14123 ;; Make the todo matcher
14125 (setq todomatcher t)
14126 (setq orterms (org-split-string todomatch "|") orlist nil)
14127 (while (setq term (pop orterms))
14128 (while (string-match re term)
14129 (setq minus (and (match-end 1)
14130 (equal (match-string 1 term) "-"))
14131 kwd (match-string 2 term)
14132 re-p (equal (string-to-char kwd) ?{)
14133 term (substring term (match-end 0))
14134 mm (if re-p
14135 `(string-match ,(substring kwd 1 -1) todo)
14136 (list 'equal 'todo kwd))
14137 mm (if minus (list 'not mm) mm))
14138 (push mm todomatcher))
14139 (push (if (> (length todomatcher) 1)
14140 (cons 'and todomatcher)
14141 (car todomatcher))
14142 orlist)
14143 (setq todomatcher nil))
14144 (setq todomatcher (if (> (length orlist) 1)
14145 (cons 'or orlist) (car orlist))))
14147 ;; Return the string and lisp forms of the matcher
14148 (setq matcher (if todomatcher
14149 (list 'and tagsmatcher todomatcher)
14150 tagsmatcher))
14151 (when todo-only
14152 (setq matcher (list 'and '(member todo org-not-done-keywords)
14153 matcher)))
14154 (cons match0 matcher)))
14156 (defun org-tags-expand (match &optional single-as-list downcased)
14157 "Expand group tags in MATCH.
14159 This replaces every group tag in MATCH with a regexp tag search.
14161 will be replaced like this:
14167 Replacing by a regexp preserves the structure of the match.
14168 E.g., this expansion
14175 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14176 assumed to be a single group tag, and the function will return
14177 the list of tags in this group.
14179 When DOWNCASE is non-nil, expand downcased TAGS."
14180 (if org-group-tags
14181 (let* ((case-fold-search t)
14182 (stable org-mode-syntax-table)
14183 (tal (or org-tag-groups-alist-for-agenda
14184 org-tag-groups-alist))
14185 (tal (if downcased
14186 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14187 (tml (mapcar 'car tal))
14188 (rtnmatch match) rpl)
14189 ;; @ and _ are allowed as word-components in tags
14190 (modify-syntax-entry ?@ "w" stable)
14191 (modify-syntax-entry ?_ "w" stable)
14192 (while (and tml
14193 (with-syntax-table stable
14194 (string-match
14197 (let* ((dir (match-string 1 rtnmatch))
14198 (tag (match-string 2 rtnmatch))
14199 (tag (if downcased (downcase tag) tag)))
14200 (setq tml (delete tag tml))
14201 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14202 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14204 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14205 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14206 (if single-as-list
14207 (or (reverse rpl) (list rtnmatch))
14208 rtnmatch))
14209 (if single-as-list (list (if downcased (downcase match) match))
14210 match)))
14212 (defun org-op-to-function (op &optional stringp)
14213 "Turn an operator into the appropriate function."
14214 (setq op
14215 (cond
14216 ((equal op "<" ) '(< string< org-time<))
14217 ((equal op ">" ) '(> org-string> org-time>))
14218 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14219 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14220 ((member op '("=" "==")) '(= string= org-time=))
14221 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14222 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14224 (defun org<> (a b) (not (= a b)))
14225 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14226 (defun org-string>= (a b) (not (string< a b)))
14227 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14228 (defun org-string<> (a b) (not (string= a b)))
14229 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14230 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14231 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14232 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14233 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14234 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14235 (defun org-2ft (s)
14236 "Convert S to a floating point time.
14237 If S is already a number, just return it. If it is a string, parse
14238 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14239 (cond
14240 ((numberp s) s)
14241 ((stringp s)
14242 (condition-case nil
14243 (float-time (apply 'encode-time (org-parse-time-string s)))
14244 (error 0.)))
14245 (t 0.)))
14247 (defun org-time-today ()
14248 "Time in seconds today at 0:00.
14249 Returns the float number of seconds since the beginning of the
14250 epoch to the beginning of today (00:00)."
14251 (float-time (apply 'encode-time
14252 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14254 (defun org-matcher-time (s)
14255 "Interpret a time comparison value."
14256 (save-match-data
14257 (cond
14258 ((string= s "<now>") (float-time))
14259 ((string= s "<today>") (org-time-today))
14260 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14261 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14263 (+ (org-time-today)
14264 (* (string-to-number (match-string 1 s))
14265 (cdr (assoc (match-string 2 s)
14266 '(("d" . 86400.0) ("w" . 604800.0)
14267 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14268 (t (org-2ft s)))))
14270 (defun org-match-any-p (re list)
14271 "Does re match any element of list?"
14272 (setq list (mapcar (lambda (x) (string-match re x)) list))
14273 (delq nil list))
14275 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14276 (defvar org-tags-overlay (make-overlay 1 1))
14277 (org-detach-overlay org-tags-overlay)
14279 (defun org-get-local-tags-at (&optional pos)
14280 "Get a list of tags defined in the current headline."
14281 (org-get-tags-at pos 'local))
14283 (defun org-get-local-tags ()
14284 "Get a list of tags defined in the current headline."
14285 (org-get-tags-at nil 'local))
14287 (defun org-get-tags-at (&optional pos local)
14288 "Get a list of all headline tags applicable at POS.
14289 POS defaults to point. If tags are inherited, the list contains
14290 the targets in the same sequence as the headlines appear, i.e.
14291 the tags of the current headline come last.
14292 When LOCAL is non-nil, only return tags from the current headline,
14293 ignore inherited ones."
14294 (interactive)
14295 (if (and org-trust-scanner-tags
14296 (or (not pos) (equal pos (point)))
14297 (not local))
14298 org-scanner-tags
14299 (let (tags ltags lastpos parent)
14300 (save-excursion
14301 (save-restriction
14302 (widen)
14303 (goto-char (or pos (point)))
14304 (save-match-data
14305 (catch 'done
14306 (condition-case nil
14307 (progn
14308 (org-back-to-heading t)
14309 (while (not (equal lastpos (point)))
14310 (setq lastpos (point))
14311 (when (looking-at
14313 (setq ltags (org-split-string
14314 (org-match-string-no-properties 1) ":"))
14315 (when parent
14316 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14317 (setq tags (append
14318 (if parent
14319 (org-remove-uninherited-tags ltags)
14320 ltags)
14321 tags)))
14322 (or org-use-tag-inheritance (throw 'done t))
14323 (if local (throw 'done t))
14324 (or (org-up-heading-safe) (error nil))
14325 (setq parent t)))
14326 (error nil)))))
14327 (if local
14328 tags
14329 (reverse (delete-dups
14330 (reverse (append
14331 (org-remove-uninherited-tags
14332 org-file-tags) tags)))))))))
14334 (defun org-add-prop-inherited (s)
14335 (add-text-properties 0 (length s) '(inherited t) s)
14336 s)
14338 (defun org-toggle-tag (tag &optional onoff)
14339 "Toggle the tag TAG for the current line.
14340 If ONOFF is `on' or `off', don't toggle but set to this state."
14341 (let (res current)
14342 (save-excursion
14343 (org-back-to-heading t)
14345 (point-at-eol) t)
14346 (progn
14347 (setq current (match-string 1))
14348 (replace-match ""))
14349 (setq current ""))
14350 (setq current (nreverse (org-split-string current ":")))
14351 (cond
14352 ((eq onoff 'on)
14353 (setq res t)
14354 (or (member tag current) (push tag current)))
14355 ((eq onoff 'off)
14356 (or (not (member tag current)) (setq current (delete tag current))))
14357 (t (if (member tag current)
14358 (setq current (delete tag current))
14359 (setq res t)
14360 (push tag current))))
14361 (end-of-line 1)
14362 (if current
14363 (progn
14364 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14365 (org-set-tags nil t))
14366 (delete-horizontal-space))
14367 (run-hooks 'org-after-tags-change-hook))
14368 res))
14370 (defun org-align-tags-here (to-col)
14371 ;; Assumes that this is a headline
14372 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14373 (beginning-of-line 1)
14375 (< pos (match-beginning 2)))
14376 (progn
14377 (setq tags-l (- (match-end 2) (match-beginning 2)))
14378 (goto-char (match-beginning 1))
14379 (insert " ")
14380 (delete-region (point) (1+ (match-beginning 2)))
14381 (setq ncol (max (current-column)
14382 (1+ col)
14383 (if (> to-col 0)
14384 to-col
14385 (- (abs to-col) tags-l))))
14386 (setq p (point))
14387 (insert (make-string (- ncol (current-column)) ?\ ))
14388 (setq ncol (current-column))
14389 (when indent-tabs-mode (tabify p (point-at-eol)))
14390 (org-move-to-column (min ncol col) t))
14391 (goto-char pos))))
14393 (defun org-set-tags-command (&optional arg just-align)
14394 "Call the set-tags command for the current entry."
14395 (interactive "P")
14396 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14397 (org-set-tags arg just-align)
14398 (save-excursion
14399 (unless (and (org-region-active-p)
14400 org-loop-over-headlines-in-active-region)
14401 (org-back-to-heading t))
14402 (org-set-tags arg just-align))))
14404 (defun org-set-tags-to (data)
14405 "Set the tags of the current entry to DATA, replacing the current tags.
14406 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14407 If DATA is nil or the empty string, any tags will be removed."
14408 (interactive "sTags: ")
14409 (setq data
14410 (cond
14411 ((eq data nil) "")
14412 ((equal data "") "")
14413 ((stringp data)
14414 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14415 ":"))
14416 ((listp data)
14417 (concat ":" (mapconcat 'identity data ":") ":"))))
14418 (when data
14419 (save-excursion
14420 (org-back-to-heading t)
14421 (when (looking-at org-complex-heading-regexp)
14422 (if (match-end 5)
14423 (progn
14424 (goto-char (match-beginning 5))
14425 (insert data)
14426 (delete-region (point) (point-at-eol))
14427 (org-set-tags nil 'align))
14428 (goto-char (point-at-eol))
14429 (insert " " data)
14430 (org-set-tags nil 'align)))
14431 (beginning-of-line 1)
14433 (delete-region (match-beginning 1) (match-end 1))))))
14435 (defun org-align-all-tags ()
14436 "Align the tags i all headings."
14437 (interactive)
14438 (save-excursion
14439 (or (ignore-errors (org-back-to-heading t))
14440 (outline-next-heading))
14441 (if (org-at-heading-p)
14442 (org-set-tags t)
14443 (message "No headings"))))
14445 (defvar org-indent-indentation-per-level)
14446 (defun org-set-tags (&optional arg just-align)
14447 "Set the tags for the current headline.
14448 With prefix ARG, realign all tags in headings in the current buffer."
14449 (interactive "P")
14450 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14451 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14452 'region-start-level 'region))
14453 org-loop-over-headlines-in-active-region)
14454 (org-map-entries
14455 ;; We don't use ARG and JUST-ALIGN here these args are not
14456 ;; useful when looping over headlines
14457 `(org-set-tags)
14458 org-loop-over-headlines-in-active-region
14459 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14460 (let* ((re org-outline-regexp-bol)
14461 (current (unless arg (org-get-tags-string)))
14462 (col (current-column))
14463 (org-setting-tags t)
14464 table current-tags inherited-tags ; computed below when needed
14465 tags p0 c0 c1 rpl di tc level)
14466 (if arg
14467 (save-excursion
14468 (goto-char (point-min))
14469 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14470 (while (re-search-forward re nil t)
14471 (org-set-tags nil t)
14472 (end-of-line 1)))
14473 (message "All tags realigned to column %d" org-tags-column))
14474 (if just-align
14475 (setq tags current)
14476 ;; Get a new set of tags from the user
14477 (save-excursion
14478 (setq table (append org-tag-persistent-alist
14479 (or org-tag-alist (org-get-buffer-tags))
14480 (and
14481 org-complete-tags-always-offer-all-agenda-tags
14482 (org-global-tags-completion-table
14483 (org-agenda-files))))
14484 org-last-tags-completion-table table
14485 current-tags (org-split-string current ":")
14486 inherited-tags (nreverse
14487 (nthcdr (length current-tags)
14488 (nreverse (org-get-tags-at))))
14489 tags
14490 (if (or (eq t org-use-fast-tag-selection)
14491 (and org-use-fast-tag-selection
14492 (delq nil (mapcar 'cdr table))))
14493 (org-fast-tag-selection
14494 current-tags inherited-tags table
14495 (if org-fast-tag-selection-include-todo
14496 org-todo-key-alist))
14497 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14498 (org-trim
14499 (org-icompleting-read "Tags: "
14500 'org-tags-completion-function
14501 nil nil current 'org-tags-history))))))
14502 (while (string-match "[-+&]+" tags)
14503 ;; No boolean logic, just a list
14504 (setq tags (replace-match ":" t t tags))))
14506 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14508 (if org-tags-sort-function
14509 (setq tags (mapconcat 'identity
14510 (sort (org-split-string
14511 tags (org-re "[^[:alnum:]_@#%]+"))
14512 org-tags-sort-function) ":")))
14515 (setq tags "")
14516 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14517 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14519 ;; Insert new tags at the correct column
14520 (beginning-of-line 1)
14521 (setq level (or (and (looking-at org-outline-regexp)
14522 (- (match-end 0) (point) 1))
14523 1))
14524 (cond
14525 ((and (equal current "") (equal tags "")))
14526 ((re-search-forward
14528 (point-at-eol) t)
14529 (if (equal tags "")
14530 (setq rpl "")
14531 (goto-char (match-beginning 0))
14532 (setq c0 (current-column)
14533 ;; compute offset for the case of org-indent-mode active
14534 di (if org-indent-mode
14535 (* (1- org-indent-indentation-per-level) (1- level))
14536 0)
14537 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14538 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14539 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14540 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14541 (replace-match rpl t t)
14542 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14543 tags)
14544 (t (error "Tags alignment failed")))
14545 (org-move-to-column col)
14546 (unless just-align
14547 (run-hooks 'org-after-tags-change-hook))))))
14549 (defun org-change-tag-in-region (beg end tag off)
14550 "Add or remove TAG for each entry in the region.
14551 This works in the agenda, and also in an org-mode buffer."
14552 (interactive
14553 (list (region-beginning) (region-end)
14554 (let ((org-last-tags-completion-table
14555 (if (derived-mode-p 'org-mode)
14556 (org-uniquify
14557 (delq nil (append (org-get-buffer-tags)
14558 (org-global-tags-completion-table))))
14559 (org-global-tags-completion-table))))
14560 (org-icompleting-read
14561 "Tag: " 'org-tags-completion-function nil nil nil
14562 'org-tags-history))
14563 (progn
14565 (equal (read-char-exclusive) ?r))))
14566 (if (fboundp 'deactivate-mark) (deactivate-mark))
14567 (let ((agendap (equal major-mode 'org-agenda-mode))
14568 l1 l2 m buf pos newhead (cnt 0))
14569 (goto-char end)
14570 (setq l2 (1- (org-current-line)))
14571 (goto-char beg)
14572 (setq l1 (org-current-line))
14573 (loop for l from l1 to l2 do
14574 (org-goto-line l)
14575 (setq m (get-text-property (point) 'org-hd-marker))
14576 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14577 (and agendap m))
14578 (setq buf (if agendap (marker-buffer m) (current-buffer))
14579 pos (if agendap m (point)))
14580 (with-current-buffer buf
14581 (save-excursion
14582 (save-restriction
14583 (goto-char pos)
14584 (setq cnt (1+ cnt))
14585 (org-toggle-tag tag (if off 'off 'on))
14586 (setq newhead (org-get-heading)))))
14587 (and agendap (org-agenda-change-all-lines newhead m))))
14588 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14590 (defun org-tags-completion-function (string predicate &optional flag)
14591 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14592 (confirm (lambda (x) (stringp (car x)))))
14594 (setq s1 (match-string 1 string)
14595 s2 (match-string 2 string))
14596 (setq s1 "" s2 string))
14597 (cond
14598 ((eq flag nil)
14599 ;; try completion
14600 (setq rtn (try-completion s2 ctable confirm))
14601 (if (stringp rtn)
14602 (setq rtn
14603 (concat s1 s2 (substring rtn (length s2))
14604 (if (and org-add-colon-after-tag-completion
14605 (assoc rtn ctable))
14606 ":" ""))))
14607 rtn)
14608 ((eq flag t)
14609 ;; all-completions
14610 (all-completions s2 ctable confirm))
14611 ((eq flag 'lambda)
14612 ;; exact match?
14613 (assoc s2 ctable)))))
14615 (defun org-fast-tag-insert (kwd tags face &optional end)
14616 "Insert KDW, and the TAGS, the latter with face FACE.
14617 Also insert END."
14618 (insert (format "%-12s" (concat kwd ":"))
14619 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14620 (or end "")))
14622 (defun org-fast-tag-show-exit (flag)
14623 (save-excursion
14624 (org-goto-line 3)
14626 (replace-match ""))
14627 (when flag
14628 (end-of-line 1)
14629 (org-move-to-column (- (window-width) 19) t)
14630 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14632 (defun org-set-current-tags-overlay (current prefix)
14633 "Add an overlay to CURRENT tag with PREFIX."
14634 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14635 (if (featurep 'xemacs)
14636 (org-overlay-display org-tags-overlay (concat prefix s)
14637 'secondary-selection)
14638 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14639 (org-overlay-display org-tags-overlay (concat prefix s)))))
14641 (defvar org-last-tag-selection-key nil)
14642 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14643 "Fast tag selection with single keys.
14644 CURRENT is the current list of tags in the headline, INHERITED is the
14645 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14646 possibly with grouping information. TODO-TABLE is a similar table with
14647 TODO keywords, should these have keys assigned to them.
14648 If the keys are nil, a-z are automatically assigned.
14649 Returns the new tags string, or nil to not change the current settings."
14650 (let* ((fulltable (append table todo-table))
14651 (maxlen (apply 'max (mapcar
14652 (lambda (x)
14653 (if (stringp (car x)) (string-width (car x)) 0))
14654 fulltable)))
14655 (buf (current-buffer))
14656 (expert (eq org-fast-tag-selection-single-key 'expert))
14657 (buffer-tags nil)
14658 (fwidth (+ maxlen 3 1 3))
14659 (ncol (/ (- (window-width) 4) fwidth))
14660 (i-face 'org-done)
14661 (c-face 'org-todo)
14662 tg cnt e c char c1 c2 ntable tbl rtn
14663 ov-start ov-end ov-prefix
14664 (exit-after-next org-fast-tag-selection-single-key)
14665 (done-keywords org-done-keywords)
14666 groups ingroup)
14667 (save-excursion
14668 (beginning-of-line 1)
14669 (if (looking-at
14671 (setq ov-start (match-beginning 1)
14672 ov-end (match-end 1)
14673 ov-prefix "")
14674 (setq ov-start (1- (point-at-eol))
14675 ov-end (1+ ov-start))
14677 (setq ov-prefix
14678 (concat
14679 (buffer-substring (1- (point)) (point))
14680 (if (> (current-column) org-tags-column)
14681 " "
14682 (make-string (- org-tags-column (current-column)) ?\ ))))))
14683 (move-overlay org-tags-overlay ov-start ov-end)
14684 (save-window-excursion
14685 (if expert
14686 (set-buffer (get-buffer-create " *Org tags*"))
14687 (delete-other-windows)
14688 (split-window-vertically)
14689 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14690 (erase-buffer)
14691 (org-set-local 'org-done-keywords done-keywords)
14694 (org-fast-tag-show-exit exit-after-next)
14695 (org-set-current-tags-overlay current ov-prefix)
14696 (setq tbl fulltable char ?a cnt 0)
14697 (while (setq e (pop tbl))
14698 (cond
14699 ((equal (car e) :startgroup)
14700 (push '() groups) (setq ingroup t)
14701 (when (not (= cnt 0))
14702 (setq cnt 0)
14704 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14705 ((equal (car e) :endgroup)
14706 (setq ingroup nil cnt 0)
14708 ((equal e '(:newline))
14709 (when (not (= cnt 0))
14710 (setq cnt 0)
14712 (setq e (car tbl))
14713 (while (equal (car tbl) '(:newline))
14715 (setq tbl (cdr tbl)))))
14716 ((equal e '(:grouptags)) nil)
14717 (t
14718 (setq tg (copy-sequence (car e)) c2 nil)
14719 (if (cdr e)
14720 (setq c (cdr e))
14721 ;; automatically assign a character.
14722 (setq c1 (string-to-char
14723 (downcase (substring
14724 tg (if (= (string-to-char tg) ?@) 1 0)))))
14725 (if (or (rassoc c1 ntable) (rassoc c1 table))
14726 (while (or (rassoc char ntable) (rassoc char table))
14727 (setq char (1+ char)))
14728 (setq c2 c1))
14729 (setq c (or c2 char)))
14730 (if ingroup (push tg (car groups)))
14731 (setq tg (org-add-props tg nil 'face
14732 (cond
14733 ((not (assoc tg table))
14734 (org-get-todo-face tg))
14735 ((member tg current) c-face)
14736 ((member tg inherited) i-face))))
14737 (if (equal (caar tbl) :grouptags)
14738 (org-add-props tg nil 'face 'org-tag-group))
14739 (if (and (= cnt 0) (not ingroup)) (insert " "))
14740 (insert "[" c "] " tg (make-string
14741 (- fwidth 4 (length tg)) ?\ ))
14742 (push (cons tg c) ntable)
14743 (when (= (setq cnt (1+ cnt)) ncol)
14745 (if ingroup (insert " "))
14746 (setq cnt 0)))))
14747 (setq ntable (nreverse ntable))
14749 (goto-char (point-min))
14750 (if (not expert) (org-fit-window-to-buffer))
14751 (setq rtn
14752 (catch 'exit
14753 (while t
14754 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14755 (if (not groups) "no " "")
14756 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14757 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14758 (setq org-last-tag-selection-key c)
14759 (cond
14761 ((= c ?!)
14762 (setq groups (not groups))
14763 (goto-char (point-min))
14764 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14765 ((= c ?\C-c)
14766 (if (not expert)
14767 (org-fast-tag-show-exit
14768 (setq exit-after-next (not exit-after-next)))
14769 (setq expert nil)
14770 (delete-other-windows)
14771 (set-window-buffer (split-window-vertically) " *Org tags*")
14772 (org-switch-to-buffer-other-window " *Org tags*")
14773 (org-fit-window-to-buffer)))
14774 ((or (= c ?\C-g)
14775 (and (= c ?q) (not (rassoc c ntable))))
14776 (org-detach-overlay org-tags-overlay)
14777 (setq quit-flag t))
14778 ((= c ?\ )
14779 (setq current nil)
14780 (if exit-after-next (setq exit-after-next 'now)))
14782 (condition-case nil
14783 (setq tg (org-icompleting-read
14784 "Tag: "
14785 (or buffer-tags
14786 (with-current-buffer buf
14787 (org-get-buffer-tags)))))
14788 (quit (setq tg "")))
14790 (add-to-list 'buffer-tags (list tg))
14791 (if (member tg current)
14792 (setq current (delete tg current))
14793 (push tg current)))
14794 (if exit-after-next (setq exit-after-next 'now)))
14795 ((setq e (rassoc c todo-table) tg (car e))
14796 (with-current-buffer buf
14797 (save-excursion (org-todo tg)))
14798 (if exit-after-next (setq exit-after-next 'now)))
14799 ((setq e (rassoc c ntable) tg (car e))
14800 (if (member tg current)
14801 (setq current (delete tg current))
14802 (loop for g in groups do
14803 (if (member tg g)
14804 (mapc (lambda (x)
14805 (setq current (delete x current)))
14806 g)))
14807 (push tg current))
14808 (if exit-after-next (setq exit-after-next 'now))))
14810 ;; Create a sorted list
14811 (setq current
14812 (sort current
14813 (lambda (a b)
14814 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14815 (if (eq exit-after-next 'now) (throw 'exit t))
14816 (goto-char (point-min))
14817 (beginning-of-line 2)
14818 (delete-region (point) (point-at-eol))
14819 (org-fast-tag-insert "Current" current c-face)
14820 (org-set-current-tags-overlay current ov-prefix)
14821 (while (re-search-forward
14823 (setq tg (match-string 1))
14824 (add-text-properties
14825 (match-beginning 1) (match-end 1)
14826 (list 'face
14827 (cond
14828 ((member tg current) c-face)
14829 ((member tg inherited) i-face)
14830 (t (get-text-property (match-beginning 1) 'face))))))
14831 (goto-char (point-min)))))
14832 (org-detach-overlay org-tags-overlay)
14833 (if rtn
14834 (mapconcat 'identity current ":")
14835 nil))))
14837 (defun org-get-tags-string ()
14838 "Get the TAGS string in the current headline."
14839 (unless (org-at-heading-p t)
14840 (user-error "Not on a heading"))
14841 (save-excursion
14842 (beginning-of-line 1)
14844 (org-match-string-no-properties 1)
14845 "")))
14847 (defun org-get-tags ()
14848 "Get the list of tags specified in the current headline."
14849 (org-split-string (org-get-tags-string) ":"))
14851 (defun org-get-buffer-tags ()
14852 "Get a table of all tags used in the buffer, for completion."
14853 (let (tags)
14854 (save-excursion
14855 (goto-char (point-min))
14856 (while (re-search-forward
14858 (when (equal (char-after (point-at-bol 0)) ?*)
14859 (mapc (lambda (x) (add-to-list 'tags x))
14860 (org-split-string (org-match-string-no-properties 1) ":")))))
14861 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14862 (mapcar 'list tags)))
14864 ;;;; The mapping API
14866 (defun org-map-entries (func &optional match scope &rest skip)
14867 "Call FUNC at each headline selected by MATCH in SCOPE.
14869 FUNC is a function or a lisp form. The function will be called without
14870 arguments, with the cursor positioned at the beginning of the headline.
14871 The return values of all calls to the function will be collected and
14872 returned as a list.
14874 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14875 does not need to preserve point. After evaluation, the cursor will be
14876 moved to the end of the line (presumably of the headline of the
14877 processed entry) and search continues from there. Under some
14878 circumstances, this may not produce the wanted results. For example,
14879 if you have removed (e.g. archived) the current (sub)tree it could
14880 mean that the next entry will be skipped entirely. In such cases, you
14881 can specify the position from where search should continue by making
14882 FUNC set the variable `org-map-continue-from' to the desired buffer
14883 position.
14885 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14886 Only headlines that are matched by this query will be considered during
14887 the iteration. When MATCH is nil or t, all headlines will be
14888 visited by the iteration.
14890 SCOPE determines the scope of this command. It can be any of:
14892 nil The current buffer, respecting the restriction if any
14893 tree The subtree started with the entry at point
14894 region The entries within the active region, if any
14895 region-start-level
14896 The entries within the active region, but only those at
14897 the same level than the first one.
14898 file The current buffer, without restriction
14899 file-with-archives
14900 The current buffer, and any archives associated with it
14901 agenda All agenda files
14902 agenda-with-archives
14903 All agenda files with any archive files associated with them
14904 \(file1 file2 ...)
14905 If this is a list, all files in the list will be scanned
14907 The remaining args are treated as settings for the skipping facilities of
14908 the scanner. The following items can be given here:
14910 archive skip trees with the archive tag
14911 comment skip trees with the COMMENT keyword
14912 function or Emacs Lisp form:
14913 will be used as value for `org-agenda-skip-function', so
14914 whenever the function returns a position, FUNC will not be
14915 called for that entry and search will continue from the
14916 position returned
14918 If your function needs to retrieve the tags including inherited tags
14919 at the *current* entry, you can use the value of the variable
14920 `org-scanner-tags' which will be much faster than getting the value
14921 with `org-get-tags-at'. If your function gets properties with
14922 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14923 to t around the call to `org-entry-properties' to get the same speedup.
14924 Note that if your function moves around to retrieve tags and properties at
14925 a *different* entry, you cannot use these techniques."
14926 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14927 (not (org-region-active-p)))
14928 (let* ((org-agenda-archives-mode nil) ; just to make sure
14929 (org-agenda-skip-archived-trees (memq 'archive skip))
14930 (org-agenda-skip-comment-trees (memq 'comment skip))
14931 (org-agenda-skip-function
14932 (car (org-delete-all '(comment archive) skip)))
14933 (org-tags-match-list-sublevels t)
14934 (start-level (eq scope 'region-start-level))
14935 matcher file res
14936 org-todo-keywords-for-agenda
14937 org-done-keywords-for-agenda
14938 org-todo-keyword-alist-for-agenda
14939 org-drawers-for-agenda
14940 org-tag-alist-for-agenda
14941 todo-only)
14943 (cond
14944 ((eq match t) (setq matcher t))
14945 ((eq match nil) (setq matcher t))
14946 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14948 (save-window-excursion
14949 (save-restriction
14950 (cond ((eq scope 'tree)
14951 (org-back-to-heading t)
14952 (org-narrow-to-subtree)
14953 (setq scope nil))
14954 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14955 (org-region-active-p))
14956 ;; If needed, set start-level to a string like "2"
14957 (when start-level
14958 (save-excursion
14959 (goto-char (region-beginning))
14960 (unless (org-at-heading-p) (outline-next-heading))
14961 (setq start-level (org-current-level))))
14962 (narrow-to-region (region-beginning)
14963 (save-excursion
14964 (goto-char (region-end))
14965 (unless (and (bolp) (org-at-heading-p))
14966 (outline-next-heading))
14967 (point)))
14968 (setq scope nil)))
14970 (if (not scope)
14971 (progn
14972 (org-agenda-prepare-buffers
14973 (list (buffer-file-name (current-buffer))))
14974 (setq res (org-scan-tags func matcher todo-only start-level)))
14975 ;; Get the right scope
14976 (cond
14977 ((and scope (listp scope) (symbolp (car scope)))
14978 (setq scope (eval scope)))
14979 ((eq scope 'agenda)
14980 (setq scope (org-agenda-files t)))
14981 ((eq scope 'agenda-with-archives)
14982 (setq scope (org-agenda-files t))
14983 (setq scope (org-add-archive-files scope)))
14984 ((eq scope 'file)
14985 (setq scope (list (buffer-file-name))))
14986 ((eq scope 'file-with-archives)
14987 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14988 (org-agenda-prepare-buffers scope)
14989 (while (setq file (pop scope))
14990 (with-current-buffer (org-find-base-buffer-visiting file)
14991 (save-excursion
14992 (save-restriction
14993 (widen)
14994 (goto-char (point-min))
14995 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14996 res)))
14998 ;;;; Properties
15000 ;;; Setting and retrieving properties
15002 (defconst org-special-properties
15003 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15004 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15005 "The special properties valid in Org-mode.
15007 These are properties that are not defined in the property drawer,
15008 but in some other way.")
15010 (defconst org-default-properties
15011 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15012 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15013 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15014 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15015 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15016 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15017 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15018 "Some properties that are used by Org-mode for various purposes.
15019 Being in this list makes sure that they are offered for completion.")
15022 "Regular expression matching the first line of a property drawer.")
15025 "Regular expression matching the last line of a property drawer.")
15028 "Regular expression matching the first line of a property drawer.")
15031 "Regular expression matching the first line of a property drawer.")
15033 (defconst org-property-drawer-re
15036 "Matches an entire property drawer.")
15038 (defconst org-clock-drawer-re
15041 "Matches an entire clock drawer.")
15043 (defun org-property-action ()
15044 "Do an action on properties."
15045 (interactive)
15046 (let (c)
15047 (org-at-property-p)
15048 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15049 (setq c (read-char-exclusive))
15050 (cond
15051 ((equal c ?s)
15052 (call-interactively 'org-set-property))
15053 ((equal c ?d)
15054 (call-interactively 'org-delete-property))
15055 ((equal c ?D)
15056 (call-interactively 'org-delete-property-globally))
15057 ((equal c ?c)
15058 (call-interactively 'org-compute-property-at-point))
15059 (t (user-error "No such property action %c" c)))))
15061 (defun org-inc-effort ()
15062 "Increment the value of the effort property in the current entry."
15063 (interactive)
15064 (org-set-effort nil t))
15066 (defvar org-clock-effort) ;; Defined in org-clock.el
15067 (defvar org-clock-current-task) ;; Defined in org-clock.el
15068 (defun org-set-effort (&optional value increment)
15069 "Set the effort property of the current entry.
15070 With numerical prefix arg, use the nth allowed value, 0 stands for the
15071 10th allowed value.
15073 When INCREMENT is non-nil, set the property to the next allowed value."
15074 (interactive "P")
15075 (if (equal value 0) (setq value 10))
15076 (let* ((completion-ignore-case t)
15077 (prop org-effort-property)
15078 (cur (org-entry-get nil prop))
15079 (allowed (org-property-get-allowed-values nil prop 'table))
15080 (existing (mapcar 'list (org-property-values prop)))
15081 (heading (nth 4 (org-heading-components)))
15082 rpl
15083 (val (cond
15084 ((stringp value) value)
15085 ((and allowed (integerp value))
15086 (or (car (nth (1- value) allowed))
15087 (car (org-last allowed))))
15088 ((and allowed increment)
15089 (or (caadr (member (list cur) allowed))
15090 (user-error "Allowed effort values are not set")))
15091 (allowed
15092 (message "Select 1-9,0, [RET%s]: %s"
15093 (if cur (concat "=" cur) "")
15094 (mapconcat 'car allowed " "))
15095 (setq rpl (read-char-exclusive))
15097 cur
15098 (setq rpl (- rpl ?0))
15099 (if (equal rpl 0) (setq rpl 10))
15100 (if (and (> rpl 0) (<= rpl (length allowed)))
15101 (car (nth (1- rpl) allowed))
15102 (org-completing-read "Effort: " allowed nil))))
15103 (t
15104 (let (org-completion-use-ido org-completion-use-iswitchb)
15105 (org-completing-read
15107 (concat "[" cur "]") "")
15108 ": ")
15109 existing nil nil "" nil cur))))))
15110 (unless (equal (org-entry-get nil prop) val)
15111 (org-entry-put nil prop val))
15112 (save-excursion
15113 (org-back-to-heading t)
15114 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15115 (when (string= heading org-clock-current-task)
15116 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15117 (org-clock-update-mode-line))
15118 (message "%s is now %s" prop val)))
15120 (defun org-at-property-p ()
15121 "Is cursor inside a property drawer?"
15122 (save-excursion
15123 (when (equal 'node-property (car (org-element-at-point)))
15124 (beginning-of-line 1)
15125 (looking-at org-property-re))))
15127 (defun org-get-property-block (&optional beg end force)
15128 "Return the (beg . end) range of the body of the property drawer.
15129 BEG and END are the beginning and end of the current subtree, or of
15130 the part before the first headline. If they are not given, they will
15131 be found. If the drawer does not exist and FORCE is non-nil, create
15132 the drawer."
15133 (catch 'exit
15134 (save-excursion
15135 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15136 (progn (org-back-to-heading t) (point))))
15137 (end (or end (and (not (outline-next-heading)) (point-max))
15138 (point))))
15139 (goto-char beg)
15140 (if (re-search-forward org-property-start-re end t)
15141 (setq beg (1+ (match-end 0)))
15142 (if force
15143 (save-excursion
15144 (org-insert-property-drawer)
15145 (setq end (progn (outline-next-heading) (point))))
15146 (throw 'exit nil))
15147 (goto-char beg)
15148 (if (re-search-forward org-property-start-re end t)
15149 (setq beg (1+ (match-end 0)))))
15150 (if (re-search-forward org-property-end-re end t)
15151 (setq end (match-beginning 0))
15152 (or force (throw 'exit nil))
15153 (goto-char beg)
15154 (setq end beg)
15155 (org-indent-line)
15157 (cons beg end)))))
15159 (defun org-entry-properties (&optional pom which specific)
15160 "Get all properties of the entry at point-or-marker POM.
15161 This includes the TODO keyword, the tags, time strings for deadline,
15162 scheduled, and clocking, and any additional properties defined in the
15163 entry. The return value is an alist, keys may occur multiple times
15164 if the property key was used several times.
15165 POM may also be nil, in which case the current entry is used.
15166 If WHICH is nil or `all', get all properties. If WHICH is
15167 `special' or `standard', only get that subclass. If WHICH
15168 is a string only get exactly this property. SPECIFIC can be a string, the
15169 specific property we are interested in. Specifying it can speed
15170 things up because then unnecessary parsing is avoided."
15171 (setq which (or which 'all))
15172 (org-with-point-at pom
15173 (let ((clockstr (substring org-clock-string 0 -1))
15174 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15175 (case-fold-search nil)
15176 beg end range props sum-props key key1 value string clocksum clocksumt)
15177 (save-excursion
15178 (when (condition-case nil
15179 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15180 (error nil))
15181 (setq beg (point))
15182 (setq sum-props (get-text-property (point) 'org-summaries))
15183 (setq clocksum (get-text-property (point) :org-clock-minutes)
15184 clocksumt (get-text-property (point) :org-clock-minutes-today))
15185 (outline-next-heading)
15186 (setq end (point))
15187 (when (memq which '(all special))
15188 ;; Get the special properties, like TODO and tags
15189 (goto-char beg)
15190 (when (and (or (not specific) (string= specific "TODO"))
15191 (looking-at org-todo-line-regexp) (match-end 2))
15192 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15193 (when (and (or (not specific) (string= specific "PRIORITY"))
15194 (looking-at org-priority-regexp))
15195 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15196 (when (or (not specific) (string= specific "FILE"))
15197 (push (cons "FILE" buffer-file-name) props))
15198 (when (and (or (not specific) (string= specific "TAGS"))
15199 (setq value (org-get-tags-string))
15201 (push (cons "TAGS" value) props))
15202 (when (and (or (not specific) (string= specific "ALLTAGS"))
15203 (setq value (org-get-tags-at)))
15204 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15205 ":"))
15206 props))
15207 (when (or (not specific) (string= specific "BLOCKED"))
15208 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15209 (when (or (not specific)
15210 (member specific
15211 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15212 "TIMESTAMP" "TIMESTAMP_IA")))
15213 (catch 'match
15214 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15215 (setq key (if (match-end 1)
15216 (substring (org-match-string-no-properties 1)
15217 0 -1))
15218 string (if (equal key clockstr)
15219 (org-trim
15220 (buffer-substring-no-properties
15221 (match-beginning 3) (goto-char
15222 (point-at-eol))))
15223 (substring (org-match-string-no-properties 3)
15224 1 -1)))
15225 ;; Get the correct property name from the key. This is
15226 ;; necessary if the user has configured time keywords.
15227 (setq key1 (concat key ":"))
15228 (cond
15229 ((not key)
15230 (setq key
15231 (if (= (char-after (match-beginning 3)) ?\[)
15232 "TIMESTAMP_IA" "TIMESTAMP")))
15233 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15234 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15235 ((equal key1 org-closed-string) (setq key "CLOSED"))
15236 ((equal key1 org-clock-string) (setq key "CLOCK")))
15237 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15238 (progn
15239 (push (cons key string) props)
15240 ;; no need to search further if match is found
15241 (throw 'match t))
15242 (when (or (equal key "CLOCK") (not (assoc key props)))
15243 (push (cons key string) props)))))))
15245 (when (memq which '(all standard))
15246 ;; Get the standard properties, like :PROP: ...
15247 (setq range (org-get-property-block beg end))
15248 (when range
15249 (goto-char (car range))
15250 (while (re-search-forward org-property-re
15251 (cdr range) t)
15252 (setq key (org-match-string-no-properties 2)
15253 value (org-trim (or (org-match-string-no-properties 3) "")))
15254 (unless (member key excluded)
15255 (push (cons key (or value "")) props)))))
15256 (if clocksum
15257 (push (cons "CLOCKSUM"
15258 (org-columns-number-to-string (/ (float clocksum) 60.)
15259 'add_times))
15260 props))
15261 (if clocksumt
15262 (push (cons "CLOCKSUM_T"
15263 (org-columns-number-to-string (/ (float clocksumt) 60.)
15264 'add_times))
15265 props))
15266 (unless (assoc "CATEGORY" props)
15267 (push (cons "CATEGORY" (org-get-category)) props))
15268 (append sum-props (nreverse props)))))))
15270 (defun org-entry-get (pom property &optional inherit literal-nil)
15271 "Get value of PROPERTY for entry or content at point-or-marker POM.
15272 If INHERIT is non-nil and the entry does not have the property,
15273 then also check higher levels of the hierarchy.
15274 If INHERIT is the symbol `selective', use inheritance only if the setting
15275 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15276 If the property is present but empty, the return value is the empty string.
15277 If the property is not present at all, nil is returned.
15280 do not interpret it as the list atom nil. This is used for inheritance
15282 (org-with-point-at pom
15283 (if (and inherit (if (eq inherit 'selective)
15284 (org-property-inherit-p property)
15285 t))
15286 (org-entry-get-with-inheritance property literal-nil)
15287 (if (member property org-special-properties)
15288 ;; We need a special property. Use `org-entry-properties' to
15289 ;; retrieve it, but specify the wanted property
15290 (cdr (assoc property (org-entry-properties nil 'special property)))
15291 (let ((range (org-get-property-block)))
15292 (when (and range (not (eq (car range) (cdr range))))
15293 (let* ((props (list (or (assoc property org-file-properties)
15294 (assoc property org-global-properties)
15295 (assoc property org-global-properties-fixed))))
15296 (ap (lambda (key)
15297 (when (re-search-forward
15298 (org-re-property key) (cdr range) t)
15299 (setq props
15300 (org-update-property-plist
15301 key
15302 (if (match-end 3)
15303 (org-match-string-no-properties 3) "")
15304 props)))))
15305 val)
15306 (goto-char (car range))
15307 (funcall ap property)
15308 (goto-char (car range))
15309 (while (funcall ap (concat property "+")))
15310 (setq val (cdr (assoc property props)))
15311 (when val (if literal-nil val (org-not-nil val))))))))))
15313 (defun org-property-or-variable-value (var &optional inherit)
15314 "Check if there is a property fixing the value of VAR.
15315 If yes, return this value. If not, return the current value of the variable."
15316 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15318 (read prop)
15319 (symbol-value var))))
15321 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15322 "Delete the property PROPERTY from entry at point-or-marker POM.
15323 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15324 an empty drawer to delete."
15325 (org-with-point-at pom
15326 (if (member property org-special-properties)
15327 nil ; cannot delete these properties.
15328 (let ((range (org-get-property-block)))
15329 (if (and range
15330 (goto-char (car range))
15331 (re-search-forward
15332 (org-re-property property)
15333 (cdr range) t))
15334 (progn
15335 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15336 (and delete-empty-drawer
15337 (org-remove-empty-drawer-at
15338 delete-empty-drawer (car range)))
15339 t)
15340 nil)))))
15342 ;; Multi-values properties are properties that contain multiple values
15343 ;; These values are assumed to be single words, separated by whitespace.
15344 (defun org-entry-add-to-multivalued-property (pom property value)
15345 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15346 (let* ((old (org-entry-get pom property))
15348 (setq value (org-entry-protect-space value))
15349 (unless (member value values)
15350 (setq values (append values (list value)))
15351 (org-entry-put pom property
15352 (mapconcat 'identity values " ")))))
15354 (defun org-entry-remove-from-multivalued-property (pom property value)
15355 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15356 (let* ((old (org-entry-get pom property))
15358 (setq value (org-entry-protect-space value))
15359 (when (member value values)
15360 (setq values (delete value values))
15361 (org-entry-put pom property
15362 (mapconcat 'identity values " ")))))
15364 (defun org-entry-member-in-multivalued-property (pom property value)
15365 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15366 (let* ((old (org-entry-get pom property))
15368 (setq value (org-entry-protect-space value))
15369 (member value values)))
15371 (defun org-entry-get-multivalued-property (pom property)
15372 "Return a list of values in a multivalued property."
15373 (let* ((value (org-entry-get pom property))
15375 (mapcar 'org-entry-restore-space values)))
15377 (defun org-entry-put-multivalued-property (pom property &rest values)
15378 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15379 VALUES should be a list of strings. Spaces will be protected."
15380 (org-entry-put pom property
15381 (mapconcat 'org-entry-protect-space values " "))
15382 (let* ((value (org-entry-get pom property))
15384 (mapcar 'org-entry-restore-space values)))
15386 (defun org-entry-protect-space (s)
15387 "Protect spaces and newline in string S."
15388 (while (string-match " " s)
15389 (setq s (replace-match "%20" t t s)))
15391 (setq s (replace-match "%0A" t t s)))
15392 s)
15394 (defun org-entry-restore-space (s)
15395 "Restore spaces and newline in string S."
15396 (while (string-match "%20" s)
15397 (setq s (replace-match " " t t s)))
15398 (while (string-match "%0A" s)
15400 s)
15402 (defvar org-entry-property-inherited-from (make-marker)
15403 "Marker pointing to the entry from where a property was inherited.
15404 Each call to `org-entry-get-with-inheritance' will set this marker to the
15405 location of the entry where the inheritance search matched. If there was
15406 no match, the marker will point nowhere.
15407 Note that also `org-entry-get' calls this function, if the INHERIT flag
15408 is set.")
15410 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15411 "Get PROPERTY of entry or content at point, search higher levels if needed.
15412 The search will stop at the first ancestor which has the property defined.
15414 should be considered as undefined (this is the meaning of nil here).
15416 (move-marker org-entry-property-inherited-from nil)
15417 (let (tmp)
15418 (save-excursion
15419 (save-restriction
15420 (widen)
15421 (catch 'ex
15422 (while t
15423 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15424 (or (ignore-errors (org-back-to-heading t))
15425 (goto-char (point-min)))
15426 (move-marker org-entry-property-inherited-from (point))
15427 (throw 'ex tmp))
15428 (or (ignore-errors (org-up-heading-safe))
15429 (throw 'ex nil))))))
15430 (setq tmp (or tmp
15431 (cdr (assoc property org-file-properties))
15432 (cdr (assoc property org-global-properties))
15433 (cdr (assoc property org-global-properties-fixed))))
15434 (if literal-nil tmp (org-not-nil tmp))))
15436 (defvar org-property-changed-functions nil
15437 "Hook called when the value of a property has changed.
15438 Each hook function should accept two arguments, the name of the property
15439 and the new value.")
15441 (defun org-entry-put (pom property value)
15442 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15443 (org-with-point-at pom
15444 (org-back-to-heading t)
15445 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15446 range)
15447 (cond
15448 ((equal property "TODO")
15450 (not (member value org-todo-keywords-1)))
15452 (if (or (not value)
15454 (setq value 'none))
15455 (org-todo value)
15456 (org-set-tags nil 'align))
15457 ((equal property "PRIORITY")
15459 (string-to-char value) ?\ ))
15460 (org-set-tags nil 'align))
15461 ((equal property "CLOCKSUM")
15462 (if (not (re-search-forward
15464 (error "Cannot find a clock log")
15465 (goto-char (- (match-end 1) 2))
15466 (cond
15467 ((eq value 'earlier) (org-timestamp-down))
15468 ((eq value 'later) (org-timestamp-up)))
15469 (org-clock-sum-current-item)))
15470 ((equal property "SCHEDULED")
15471 (if (re-search-forward org-scheduled-time-regexp end t)
15472 (cond
15473 ((eq value 'earlier) (org-timestamp-change -1 'day))
15474 ((eq value 'later) (org-timestamp-change 1 'day))
15475 (t (call-interactively 'org-schedule)))
15476 (call-interactively 'org-schedule)))
15477 ((equal property "DEADLINE")
15478 (if (re-search-forward org-deadline-time-regexp end t)
15479 (cond
15480 ((eq value 'earlier) (org-timestamp-change -1 'day))
15481 ((eq value 'later) (org-timestamp-change 1 'day))
15482 (t (call-interactively 'org-deadline)))
15483 (call-interactively 'org-deadline)))
15484 ((member property org-special-properties)
15485 (error "The %s property can not yet be set with `org-entry-put'"
15486 property))
15487 (t ; a non-special property
15488 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15489 (setq range (org-get-property-block beg end 'force))
15490 (goto-char (car range))
15491 (if (re-search-forward
15492 (org-re-property property) (cdr range) t)
15493 (progn
15494 (delete-region (match-beginning 0) (match-end 0))
15495 (goto-char (match-beginning 0)))
15496 (goto-char (cdr range))
15498 (backward-char 1)
15499 (org-indent-line))
15500 (insert ":" property ":")
15501 (and value (insert " " value))
15502 (org-indent-line)))))
15503 (run-hook-with-args 'org-property-changed-functions property value)))
15505 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15506 "Get all property keys in the current buffer.
15507 With INCLUDE-SPECIALS, also list the special properties that reflect things
15508 like tags and TODO state.
15509 With INCLUDE-DEFAULTS, also include properties that has special meaning
15510 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15511 and others.
15512 With INCLUDE-COLUMNS, also include property names given in COLUMN
15513 formats in the current buffer."
15514 (let (rtn range cfmt s p)
15515 (save-excursion
15516 (save-restriction
15517 (widen)
15518 (goto-char (point-min))
15519 (while (re-search-forward org-property-start-re nil t)
15520 (setq range (org-get-property-block))
15521 (goto-char (car range))
15522 (while (re-search-forward org-property-re
15523 (cdr range) t)
15524 (add-to-list 'rtn (org-match-string-no-properties 2)))
15525 (outline-next-heading))))
15527 (when include-specials
15528 (setq rtn (append org-special-properties rtn)))
15530 (when include-defaults
15531 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15532 (add-to-list 'rtn org-effort-property))
15534 (when include-columns
15535 (save-excursion
15536 (save-restriction
15537 (widen)
15538 (goto-char (point-min))
15539 (while (re-search-forward
15541 nil t)
15542 (setq cfmt (match-string 2) s 0)
15544 cfmt s)
15545 (setq s (match-end 0)
15546 p (match-string 1 cfmt))
15547 (unless (or (equal p "ITEM")
15548 (member p org-special-properties))
15549 (add-to-list 'rtn (match-string 1 cfmt))))))))
15551 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15553 (defun org-property-values (key)
15554 "Return a list of all values of property KEY in the current buffer."
15555 (save-excursion
15556 (save-restriction
15557 (widen)
15558 (goto-char (point-min))
15559 (let ((re (org-re-property key))
15560 values)
15561 (while (re-search-forward re nil t)
15562 (add-to-list 'values (org-trim (match-string 3))))
15563 (delete "" values)))))
15565 (defun org-insert-property-drawer ()
15566 "Insert a property drawer into the current entry."
15567 (org-back-to-heading t)
15568 (looking-at org-outline-regexp)
15569 (let ((indent (if org-adapt-indentation
15570 (- (match-end 0) (match-beginning 0))
15571 0))
15572 (beg (point))
15574 end hiddenp)
15575 (outline-next-heading)
15576 (setq end (point))
15577 (goto-char beg)
15578 (while (re-search-forward re end t))
15579 (setq hiddenp (outline-invisible-p))
15580 (end-of-line 1)
15583 (if (member (match-string 1) '("CLOCK:" ":END:"))
15584 ;; just skip this line
15585 (beginning-of-line 2)
15586 ;; Drawer start, find the end
15588 (beginning-of-line 1)))
15589 (org-skip-over-state-notes)
15591 (if (eq (char-before) ?*) (forward-char 1))
15593 (beginning-of-line 0)
15594 (org-indent-to-column indent)
15595 (beginning-of-line 2)
15596 (org-indent-to-column indent)
15597 (beginning-of-line 0)
15598 (if hiddenp
15599 (save-excursion
15600 (org-back-to-heading t)
15601 (hide-entry))
15602 (org-flag-drawer t))))
15604 (defun org-insert-drawer (&optional arg drawer)
15605 "Insert a drawer at point.
15607 Optional argument DRAWER, when non-nil, is a string representing
15608 drawer's name. Otherwise, the user is prompted for a name.
15610 If a region is active, insert the drawer around that region
15611 instead.
15613 Point is left between drawer's boundaries."
15614 (interactive "P")
15615 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15616 "LOGBOOK"))
15617 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15618 ;; internally by Org. They are meant to be inserted
15619 ;; automatically.
15620 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15621 ;; Remove system drawers from list. Note: For some reason,
15622 ;; `org-completing-read' ignores the predicate while
15623 ;; `completing-read' handles it fine.
15624 (drawer (if arg "PROPERTIES"
15625 (or drawer
15626 (completing-read
15627 "Drawer: " org-drawers
15628 (lambda (d) (not (member d system-drawers))))))))
15629 (cond
15630 ;; With C-u, fall back on `org-insert-property-drawer'
15631 (arg (org-insert-property-drawer))
15632 ;; With an active region, insert a drawer at point.
15633 ((not (org-region-active-p))
15634 (progn
15637 (forward-line -2)))
15638 ;; Otherwise, insert the drawer at point
15639 (t
15640 (let ((rbeg (region-beginning))
15641 (rend (copy-marker (region-end))))
15642 (unwind-protect
15643 (progn
15644 (goto-char rbeg)
15645 (beginning-of-line)
15646 (when (save-excursion
15647 (re-search-forward org-outline-regexp-bol rend t))
15648 (user-error "Drawers cannot contain headlines"))
15649 ;; Position point at the beginning of the first
15650 ;; non-blank line in region. Insert drawer's opening
15651 ;; there, then indent it.
15652 (org-skip-whitespace)
15653 (beginning-of-line)
15655 (forward-line -1)
15656 (indent-for-tab-command)
15657 ;; Move point to the beginning of the first blank line
15658 ;; after the last non-blank line in region. Insert
15659 ;; drawer's closing, then indent it.
15660 (goto-char rend)
15663 (deactivate-mark t)
15664 (indent-for-tab-command)
15666 ;; Clear marker, whatever the outcome of insertion is.
15667 (set-marker rend nil)))))))
15669 (defvar org-property-set-functions-alist nil
15670 "Property set function alist.
15671 Each entry should have the following format:
15673 (PROPERTY . READ-FUNCTION)
15675 The read function will be called with the same argument as
15676 `org-completing-read'.")
15678 (defun org-set-property-function (property)
15679 "Get the function that should be used to set PROPERTY.
15680 This is computed according to `org-property-set-functions-alist'."
15681 (or (cdr (assoc property org-property-set-functions-alist))
15682 'org-completing-read))
15684 (defun org-read-property-value (property)
15685 "Read PROPERTY value from user."
15686 (let* ((completion-ignore-case t)
15687 (allowed (org-property-get-allowed-values nil property 'table))
15688 (cur (org-entry-get nil property))
15689 (prompt (concat property " value"
15691 (concat " [" cur "]") "") ": "))
15692 (set-function (org-set-property-function property))
15693 (val (if allowed
15694 (funcall set-function prompt allowed nil
15695 (not (get-text-property 0 'org-unrestricted
15696 (caar allowed))))
15697 (let (org-completion-use-ido org-completion-use-iswitchb)
15698 (funcall set-function prompt
15699 (mapcar 'list (org-property-values property))
15700 nil nil "" nil cur)))))
15701 (if (equal val "")
15702 cur
15703 val)))
15705 (defvar org-last-set-property nil)
15706 (defvar org-last-set-property-value nil)
15707 (defun org-read-property-name ()
15708 "Read a property name."
15709 (let* ((completion-ignore-case t)
15710 (keys (org-buffer-property-keys nil t t))
15711 (default-prop (or (save-excursion
15712 (save-match-data
15713 (beginning-of-line)
15715 (null (string= (match-string 1) "END"))
15716 (match-string 1))))
15717 org-last-set-property))
15718 (property (org-icompleting-read
15719 (concat "Property"
15720 (if default-prop (concat " [" default-prop "]") "")
15721 ": ")
15722 (mapcar 'list keys)
15723 nil nil nil nil
15724 default-prop)))
15725 (if (member property keys)
15726 property
15727 (or (cdr (assoc (downcase property)
15728 (mapcar (lambda (x) (cons (downcase x) x))
15729 keys)))
15730 property))))
15732 (defun org-set-property-and-value (use-last)
15733 "Allow to set [PROPERTY]: [value] direction from prompt.
15734 When use-default, don't even ask, just use the last
15736 (interactive "P")
15737 (let* ((completion-ignore-case t)
15738 (pv (or (and use-last org-last-set-property-value)
15739 (org-completing-read
15741 nil nil nil nil nil
15742 org-last-set-property-value)))
15743 prop val)
15745 (setq prop (match-string 1 pv)
15746 val (match-string 2 pv))
15747 (org-set-property prop val))))
15749 (defun org-set-property (property value)
15750 "In the current entry, set PROPERTY to VALUE.
15751 When called interactively, this will prompt for a property name, offering
15752 completion on existing and default properties. And then it will prompt
15753 for a value, offering completion either on allowed values (via an inherited
15754 xxx_ALL property) or on existing values in other instances of this property
15755 in the current file."
15756 (interactive (list nil nil))
15757 (let* ((property (or property (org-read-property-name)))
15758 (value (or value (org-read-property-value property)))
15759 (fn (cdr (assoc property org-properties-postprocess-alist))))
15760 (setq org-last-set-property property)
15761 (setq org-last-set-property-value (concat property ": " value))
15762 ;; Possibly postprocess the inserted value:
15763 (when fn (setq value (funcall fn value)))
15764 (unless (equal (org-entry-get nil property) value)
15765 (org-entry-put nil property value))))
15767 (defun org-delete-property (property &optional delete-empty-drawer)
15768 "In the current entry, delete PROPERTY.
15769 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15770 an empty drawer to delete."
15771 (interactive
15772 (let* ((completion-ignore-case t)
15773 (prop (org-icompleting-read "Property: "
15774 (org-entry-properties nil 'standard))))
15775 (list prop)))
15776 (message "Property %s %s" property
15777 (if (org-entry-delete nil property delete-empty-drawer)
15778 "deleted"
15779 "was not present in the entry")))
15781 (defun org-delete-property-globally (property)
15782 "Remove PROPERTY globally, from all entries."
15783 (interactive
15784 (let* ((completion-ignore-case t)
15785 (prop (org-icompleting-read
15786 "Globally remove property: "
15787 (mapcar 'list (org-buffer-property-keys)))))
15788 (list prop)))
15789 (save-excursion
15790 (save-restriction
15791 (widen)
15792 (goto-char (point-min))
15793 (let ((cnt 0))
15794 (while (re-search-forward
15795 (org-re-property property)
15796 nil t)
15797 (setq cnt (1+ cnt))
15798 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15801 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15803 (defun org-compute-property-at-point ()
15804 "Compute the property at point.
15805 This looks for an enclosing column format, extracts the operator and
15806 then applies it to the property in the column format's scope."
15807 (interactive)
15808 (unless (org-at-property-p)
15809 (user-error "Not at a property"))
15810 (let ((prop (org-match-string-no-properties 2)))
15811 (org-columns-get-format-and-top-level)
15812 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15813 (user-error "No operator defined for property %s" prop))
15814 (org-columns-compute prop)))
15816 (defvar org-property-allowed-value-functions nil
15817 "Hook for functions supplying allowed values for a specific property.
15818 The functions must take a single argument, the name of the property, and
15820 the values, this means that these values are intended as defaults for
15821 completion, but that other values should be allowed too.
15822 The functions must return nil if they are not responsible for this
15823 property.")
15825 (defun org-property-get-allowed-values (pom property &optional table)
15826 "Get allowed values for the property PROPERTY.
15827 When TABLE is non-nil, return an alist that can directly be used for
15828 completion."
15829 (let (vals)
15830 (cond
15831 ((equal property "TODO")
15832 (setq vals (org-with-point-at pom
15833 (append org-todo-keywords-1 '("")))))
15834 ((equal property "PRIORITY")
15835 (let ((n org-lowest-priority))
15836 (while (>= n org-highest-priority)
15837 (push (char-to-string n) vals)
15838 (setq n (1- n)))))
15839 ((member property org-special-properties))
15840 ((setq vals (run-hook-with-args-until-success
15841 'org-property-allowed-value-functions property)))
15842 (t
15843 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15845 (setq vals (car (read-from-string (concat "(" vals ")"))))
15846 (setq vals (mapcar (lambda (x)
15847 (cond ((stringp x) x)
15848 ((numberp x) (number-to-string x))
15849 ((symbolp x) (symbol-name x))
15850 (t "???")))
15851 vals)))))
15852 (when (member ":ETC" vals)
15853 (setq vals (remove ":ETC" vals))
15854 (org-add-props (car vals) '(org-unrestricted t)))
15855 (if table (mapcar 'list vals) vals)))
15857 (defun org-property-previous-allowed-value (&optional previous)
15858 "Switch to the next allowed value for this property."
15859 (interactive)
15860 (org-property-next-allowed-value t))
15862 (defun org-property-next-allowed-value (&optional previous)
15863 "Switch to the next allowed value for this property."
15864 (interactive)
15865 (unless (org-at-property-p)
15866 (user-error "Not at a property"))
15867 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15868 (key (match-string 2))
15869 (value (match-string 3))
15870 (allowed (or (org-property-get-allowed-values (point) key)
15871 (and (member value '("[ ]" "[-]" "[X]"))
15872 '("[ ]" "[X]"))))
15873 (heading (save-match-data (nth 4 (org-heading-components))))
15874 nval)
15875 (unless allowed
15876 (user-error "Allowed values for this property have not been defined"))
15877 (if previous (setq allowed (reverse allowed)))
15878 (if (member value allowed)
15879 (setq nval (car (cdr (member value allowed)))))
15880 (setq nval (or nval (car allowed)))
15881 (if (equal nval value)
15882 (user-error "Only one allowed value for this property"))
15883 (org-at-property-p)
15884 (replace-match (concat " :" key ": " nval) t t)
15885 (org-indent-line)
15886 (beginning-of-line 1)
15888 (when (equal prop org-effort-property)
15889 (save-excursion
15890 (org-back-to-heading t)
15891 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15892 (when (string= org-clock-current-task heading)
15893 (setq org-clock-effort nval)
15894 (org-clock-update-mode-line)))
15895 (run-hook-with-args 'org-property-changed-functions key nval)))
15897 (defun org-find-olp (path &optional this-buffer)
15898 "Return a marker pointing to the entry at outline path OLP.
15899 If anything goes wrong, throw an error.
15900 You can wrap this call to catch the error like this:
15902 (condition-case msg
15903 (org-mobile-locate-entry (match-string 4))
15904 (error (nth 1 msg)))
15906 The return value will then be either a string with the error message,
15907 or a marker if everything is OK.
15909 If THIS-BUFFER is set, the outline path does not contain a file,
15910 only headings."
15911 (let* ((file (if this-buffer buffer-file-name (pop path)))
15912 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15913 (level 1)
15914 (lmin 1)
15915 (lmax 1)
15916 limit re end found pos heading cnt flevel)
15917 (unless buffer (error "File not found :%s" file))
15918 (with-current-buffer buffer
15919 (save-excursion
15920 (save-restriction
15921 (widen)
15922 (setq limit (point-max))
15923 (goto-char (point-min))
15924 (while (setq heading (pop path))
15925 (setq re (format org-complex-heading-regexp-format
15926 (regexp-quote heading)))
15927 (setq cnt 0 pos (point))
15928 (while (re-search-forward re end t)
15929 (setq level (- (match-end 1) (match-beginning 1)))
15930 (if (and (>= level lmin) (<= level lmax))
15931 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15932 (when (= cnt 0) (error "Heading not found on level %d: %s"
15933 lmax heading))
15934 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15935 lmax heading))
15936 (goto-char found)
15937 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15938 (setq end (save-excursion (org-end-of-subtree t t))))
15939 (when (org-at-heading-p)
15940 (point-marker)))))))
15942 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15943 "Find node HEADING in BUFFER.
15944 Return a marker to the heading if it was found, or nil if not.
15945 If POS-ONLY is set, return just the position instead of a marker.
15947 The heading text must match exact, but it may have a TODO keyword,
15948 a priority cookie and tags in the standard locations."
15949 (with-current-buffer (or buffer (current-buffer))
15950 (save-excursion
15951 (save-restriction
15952 (widen)
15953 (goto-char (point-min))
15954 (let (case-fold-search)
15955 (if (re-search-forward
15956 (format org-complex-heading-regexp-format
15957 (regexp-quote heading)) nil t)
15958 (if pos-only
15959 (match-beginning 0)
15960 (move-marker (make-marker) (match-beginning 0)))))))))
15962 (defun org-find-exact-heading-in-directory (heading &optional dir)
15963 "Find Org node headline HEADING in all .org files in directory DIR.
15964 When the target headline is found, return a marker to this location."
15965 (let ((files (directory-files (or dir default-directory)
15967 file visiting m buffer)
15968 (catch 'found
15969 (while (setq file (pop files))
15970 (message "trying %s" file)
15971 (setq visiting (org-find-base-buffer-visiting file))
15972 (setq buffer (or visiting (find-file-noselect file)))
15973 (setq m (org-find-exact-headline-in-buffer
15974 heading buffer))
15975 (when (and (not m) (not visiting)) (kill-buffer buffer))
15976 (and m (throw 'found m))))))
15978 (defun org-find-entry-with-id (ident)
15979 "Locate the entry that contains the ID property with exact value IDENT.
15980 IDENT can be a string, a symbol or a number, this function will search for
15981 the string representation of it.
15982 Return the position where this entry starts, or nil if there is no such entry."
15983 (interactive "sID: ")
15984 (let ((id (cond
15985 ((stringp ident) ident)
15986 ((symbol-name ident) (symbol-name ident))
15987 ((numberp ident) (number-to-string ident))
15988 (t (error "IDENT %s must be a string, symbol or number" ident))))
15989 (case-fold-search nil))
15990 (save-excursion
15991 (save-restriction
15992 (widen)
15993 (goto-char (point-min))
15994 (when (re-search-forward
15996 nil t)
15997 (org-back-to-heading t)
15998 (point))))))
16000 ;;;; Timestamps
16002 (defvar org-last-changed-timestamp nil)
16003 (defvar org-last-inserted-timestamp nil
16004 "The last time stamp inserted with `org-insert-time-stamp'.")
16005 (defvar org-time-was-given) ; dynamically scoped parameter
16006 (defvar org-end-time-was-given) ; dynamically scoped parameter
16007 (defvar org-ts-what) ; dynamically scoped parameter
16009 (defun org-time-stamp (arg &optional inactive)
16010 "Prompt for a date/time and insert a time stamp.
16011 If the user specifies a time like HH:MM or if this command is
16012 called with at least one prefix argument, the time stamp contains
16013 the date and the time. Otherwise, only the date is be included.
16015 All parts of a date not specified by the user is filled in from
16016 the current date/time. So if you just press return without
16017 typing anything, the time stamp will represent the current
16018 date/time.
16020 If there is already a timestamp at the cursor, it will be
16021 modified.
16023 With two universal prefix arguments, insert an active timestamp
16024 with the current time without prompting the user."
16025 (interactive "P")
16026 (let* ((ts nil)
16027 (default-time
16028 ;; Default time is either today, or, when entering a range,
16029 ;; the range start.
16030 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16031 (save-excursion
16032 (re-search-backward
16034 (- (point) 20) t)))
16035 (apply 'encode-time (org-parse-time-string (match-string 1)))
16036 (current-time)))
16037 (default-input (and ts (org-get-compact-tod ts)))
16038 (repeater (save-excursion
16039 (save-match-data
16040 (beginning-of-line)
16041 (when (re-search-forward
16043 (save-excursion (progn (end-of-line) (point))) t)
16044 (match-string 0)))))
16045 org-time-was-given org-end-time-was-given time)
16046 (cond
16047 ((and (org-at-timestamp-p t)
16048 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16049 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16050 (insert "--")
16051 (setq time (let ((this-command this-command))
16052 (org-read-date arg 'totime nil nil
16053 default-time default-input inactive)))
16054 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16055 ((org-at-timestamp-p t)
16056 (setq time (let ((this-command this-command))
16057 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16058 (when (org-at-timestamp-p t) ; just to get the match data
16059 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16060 (replace-match "")
16061 (setq org-last-changed-timestamp
16062 (org-insert-time-stamp
16063 time (or org-time-was-given arg)
16064 inactive nil nil (list org-end-time-was-given)))
16065 (when repeater (goto-char (1- (point))) (insert " " repeater)
16066 (setq org-last-changed-timestamp
16067 (concat (substring org-last-inserted-timestamp 0 -1)
16068 " " repeater ">"))))
16069 (message "Timestamp updated"))
16070 ((equal arg '(16))
16071 (org-insert-time-stamp (current-time) t))
16072 (t
16073 (setq time (let ((this-command this-command))
16074 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16075 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16076 nil nil (list org-end-time-was-given))))))
16078 ;; FIXME: can we use this for something else, like computing time differences?
16079 (defun org-get-compact-tod (s)
16080 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16081 (let* ((t1 (match-string 1 s))
16082 (h1 (string-to-number (match-string 2 s)))
16083 (m1 (string-to-number (match-string 3 s)))
16084 (t2 (and (match-end 4) (match-string 5 s)))
16085 (h2 (and t2 (string-to-number (match-string 6 s))))
16086 (m2 (and t2 (string-to-number (match-string 7 s))))
16087 dh dm)
16088 (if (not t2)
16089 t1
16090 (setq dh (- h2 h1) dm (- m2 m1))
16091 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16092 (concat t1 "+" (number-to-string dh)
16093 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
16095 (defun org-time-stamp-inactive (&optional arg)
16096 "Insert an inactive time stamp.
16097 An inactive time stamp is enclosed in square brackets instead of angle
16098 brackets. It is inactive in the sense that it does not trigger agenda entries,
16099 does not link to the calendar and cannot be changed with the S-cursor keys.
16100 So these are more for recording a certain time/date."
16101 (interactive "P")
16102 (org-time-stamp arg 'inactive))
16104 (defvar org-date-ovl (make-overlay 1 1))
16105 (overlay-put org-date-ovl 'face 'org-date-selected)
16106 (org-detach-overlay org-date-ovl)
16108 (defvar org-ans1) ; dynamically scoped parameter
16109 (defvar org-ans2) ; dynamically scoped parameter
16111 (defvar org-plain-time-of-day-regexp) ; defined below
16113 (defvar org-overriding-default-time nil) ; dynamically scoped
16114 (defvar org-read-date-overlay nil)
16115 (defvar org-dcst nil) ; dynamically scoped
16116 (defvar org-read-date-history nil)
16117 (defvar org-read-date-final-answer nil)
16118 (defvar org-read-date-analyze-futurep nil)
16119 (defvar org-read-date-analyze-forced-year nil)
16120 (defvar org-read-date-inactive)
16122 (defvar org-read-date-minibuffer-local-map
16123 (let ((map (make-sparse-keymap)))
16124 (set-keymap-parent map minibuffer-local-map)
16125 (org-defkey map (kbd ".")
16126 (lambda () (interactive)
16127 ;; Are we at the beginning of the prompt?
16128 (if (looking-back "^[^:]+: ")
16129 (org-eval-in-calendar '(calendar-goto-today))
16130 (insert "."))))
16131 (org-defkey map (kbd "C-.")
16132 (lambda () (interactive)
16133 (org-eval-in-calendar '(calendar-goto-today))))
16134 (org-defkey map [(meta shift left)]
16135 (lambda () (interactive)
16136 (org-eval-in-calendar '(calendar-backward-month 1))))
16137 (org-defkey map [(meta shift right)]
16138 (lambda () (interactive)
16139 (org-eval-in-calendar '(calendar-forward-month 1))))
16140 (org-defkey map [(meta shift up)]
16141 (lambda () (interactive)
16142 (org-eval-in-calendar '(calendar-backward-year 1))))
16143 (org-defkey map [(meta shift down)]
16144 (lambda () (interactive)
16145 (org-eval-in-calendar '(calendar-forward-year 1))))
16146 (org-defkey map [?\e (shift left)]
16147 (lambda () (interactive)
16148 (org-eval-in-calendar '(calendar-backward-month 1))))
16149 (org-defkey map [?\e (shift right)]
16150 (lambda () (interactive)
16151 (org-eval-in-calendar '(calendar-forward-month 1))))
16152 (org-defkey map [?\e (shift up)]
16153 (lambda () (interactive)
16154 (org-eval-in-calendar '(calendar-backward-year 1))))
16155 (org-defkey map [?\e (shift down)]
16156 (lambda () (interactive)
16157 (org-eval-in-calendar '(calendar-forward-year 1))))
16158 (org-defkey map [(shift up)]
16159 (lambda () (interactive)
16160 (org-eval-in-calendar '(calendar-backward-week 1))))
16161 (org-defkey map [(shift down)]
16162 (lambda () (interactive)
16163 (org-eval-in-calendar '(calendar-forward-week 1))))
16164 (org-defkey map [(shift left)]
16165 (lambda () (interactive)
16166 (org-eval-in-calendar '(calendar-backward-day 1))))
16167 (org-defkey map [(shift right)]
16168 (lambda () (interactive)
16169 (org-eval-in-calendar '(calendar-forward-day 1))))
16170 (org-defkey map "!"
16171 (lambda () (interactive)
16172 (org-eval-in-calendar '(diary-view-entries))
16173 (message "")))
16174 (org-defkey map ">"
16175 (lambda () (interactive)
16176 (org-eval-in-calendar '(scroll-calendar-left 1))))
16177 (org-defkey map "<"
16178 (lambda () (interactive)
16179 (org-eval-in-calendar '(scroll-calendar-right 1))))
16180 (org-defkey map "\C-v"
16181 (lambda () (interactive)
16182 (org-eval-in-calendar
16183 '(calendar-scroll-left-three-months 1))))
16184 (org-defkey map "\M-v"
16185 (lambda () (interactive)
16186 (org-eval-in-calendar
16187 '(calendar-scroll-right-three-months 1))))
16188 map)
16189 "Keymap for minibuffer commands when using `org-read-date'.")
16191 (defun org-read-date (&optional org-with-time to-time from-string prompt
16192 default-time default-input inactive)
16193 "Read a date, possibly a time, and make things smooth for the user.
16194 The prompt will suggest to enter an ISO date, but you can also enter anything
16195 which will at least partially be understood by `parse-time-string'.
16196 Unrecognized parts of the date will default to the current day, month, year,
16197 hour and minute. If this command is called to replace a timestamp at point,
16198 or to enter the second timestamp of a range, the default time is taken
16199 from the existing stamp. Furthermore, the command prefers the future,
16200 so if you are giving a date where the year is not given, and the day-month
16201 combination is already past in the current year, it will assume you
16202 mean next year. For details, see the manual. A few examples:
16204 3-2-5 --> 2003-02-05
16205 feb 15 --> currentyear-02-15
16206 2/15 --> currentyear-02-15
16207 sep 12 9 --> 2009-09-12
16208 12:45 --> today 12:45
16209 22 sept 0:34 --> currentyear-09-22 0:34
16210 12 --> currentyear-currentmonth-12
16211 Fri --> nearest Friday after today
16212 -Tue --> last Tuesday
16213 etc.
16215 Furthermore you can specify a relative date by giving, as the *first* thing
16216 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16217 change in days weeks, months, years.
16218 With a single plus or minus, the date is relative to today. With a double
16219 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16220 +4d --> four days from today
16221 +4 --> same as above
16222 +2w --> two weeks from today
16223 ++5 --> five days from default date
16225 The function understands only English month and weekday abbreviations.
16227 While prompting, a calendar is popped up - you can also select the
16228 date with the mouse (button 1). The calendar shows a period of three
16229 months. To scroll it to other months, use the keys `>' and `<'.
16230 If you don't like the calendar, turn it off with
16231 \(setq org-read-date-popup-calendar nil)
16233 With optional argument TO-TIME, the date will immediately be converted
16234 to an internal time.
16235 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16236 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16237 still enter a time, and this function will inform the calling routine
16238 about this change. The calling routine may then choose to change the
16239 format used to insert the time stamp into the buffer to include the time.
16240 With optional argument FROM-STRING, read from this string instead from
16241 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16242 the time/date that is used for everything that is not specified by the
16243 user."
16244 (require 'parse-time)
16245 (let* ((org-time-stamp-rounding-minutes
16246 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16247 (org-dcst org-display-custom-times)
16248 (ct (org-current-time))
16249 (org-def (or org-overriding-default-time default-time ct))
16250 (org-defdecode (decode-time org-def))
16251 (dummy (progn
16252 (when (< (nth 2 org-defdecode) org-extend-today-until)
16253 (setcar (nthcdr 2 org-defdecode) -1)
16254 (setcar (nthcdr 1 org-defdecode) 59)
16255 (setq org-def (apply 'encode-time org-defdecode)
16256 org-defdecode (decode-time org-def)))))
16257 (mouse-autoselect-window nil) ; Don't let the mouse jump
16258 (calendar-frame-setup nil)
16259 (calendar-setup nil)
16260 (calendar-move-hook nil)
16261 (calendar-view-diary-initially-flag nil)
16262 (calendar-view-holidays-initially-flag nil)
16263 (timestr (format-time-string
16264 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16265 (prompt (concat (if prompt (concat prompt " ") "")
16266 (format "Date+time [%s]: " timestr)))
16267 ans (org-ans0 "") org-ans1 org-ans2 final)
16269 (cond
16270 (from-string (setq ans from-string))
16271 (org-read-date-popup-calendar
16272 (save-excursion
16273 (save-window-excursion
16274 (calendar)
16275 (org-eval-in-calendar '(setq cursor-type nil) t)
16276 (unwind-protect
16277 (progn
16278 (calendar-forward-day (- (time-to-days org-def)
16279 (calendar-absolute-from-gregorian
16280 (calendar-current-date))))
16281 (org-eval-in-calendar nil t)
16282 (let* ((old-map (current-local-map))
16283 (map (copy-keymap calendar-mode-map))
16284 (minibuffer-local-map
16285 (copy-keymap org-read-date-minibuffer-local-map)))
16286 (org-defkey map (kbd "RET") 'org-calendar-select)
16287 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16288 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16289 (unwind-protect
16290 (progn
16291 (use-local-map map)
16292 (setq org-read-date-inactive inactive)
16293 (add-hook 'post-command-hook 'org-read-date-display)
16294 (setq org-ans0 (read-string prompt default-input
16295 'org-read-date-history nil))
16296 ;; org-ans0: from prompt
16297 ;; org-ans1: from mouse click
16298 ;; org-ans2: from calendar motion
16299 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16300 (remove-hook 'post-command-hook 'org-read-date-display)
16301 (use-local-map old-map)
16302 (when org-read-date-overlay
16303 (delete-overlay org-read-date-overlay)
16304 (setq org-read-date-overlay nil)))))
16305 (bury-buffer "*Calendar*")))))
16307 (t ; Naked prompt only
16308 (unwind-protect
16309 (setq ans (read-string prompt default-input
16310 'org-read-date-history timestr))
16311 (when org-read-date-overlay
16312 (delete-overlay org-read-date-overlay)
16313 (setq org-read-date-overlay nil)))))
16315 (setq final (org-read-date-analyze ans org-def org-defdecode))
16317 (when org-read-date-analyze-forced-year
16318 (message "Year was forced into %s"
16319 (if org-read-date-force-compatible-dates
16320 "compatible range (1970-2037)"
16321 "range representable on this machine"))
16322 (ding))
16324 ;; One round trip to get rid of 34th of August and stuff like that....
16325 (setq final (decode-time (apply 'encode-time final)))
16327 (setq org-read-date-final-answer ans)
16329 (if to-time
16330 (apply 'encode-time final)
16331 (if (and (boundp 'org-time-was-given) org-time-was-given)
16332 (format "%04d-%02d-%02d %02d:%02d"
16333 (nth 5 final) (nth 4 final) (nth 3 final)
16334 (nth 2 final) (nth 1 final))
16335 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16337 (defvar org-def)
16338 (defvar org-defdecode)
16339 (defvar org-with-time)
16340 (defun org-read-date-display ()
16341 "Display the current date prompt interpretation in the minibuffer."
16342 (when org-read-date-display-live
16343 (when org-read-date-overlay
16344 (delete-overlay org-read-date-overlay))
16345 (when (minibufferp (current-buffer))
16346 (save-excursion
16347 (end-of-line 1)
16348 (while (not (equal (buffer-substring
16349 (max (point-min) (- (point) 4)) (point))
16350 " "))
16351 (insert " ")))
16352 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16353 " " (or org-ans1 org-ans2)))
16354 (org-end-time-was-given nil)
16355 (f (org-read-date-analyze ans org-def org-defdecode))
16356 (fmts (if org-dcst
16357 org-time-stamp-custom-formats
16358 org-time-stamp-formats))
16359 (fmt (if (or org-with-time
16360 (and (boundp 'org-time-was-given) org-time-was-given))
16361 (cdr fmts)
16362 (car fmts)))
16363 (txt (format-time-string fmt (apply 'encode-time f)))
16364 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16365 (txt (concat "=> " txt)))
16366 (when (and org-end-time-was-given
16367 (string-match org-plain-time-of-day-regexp txt))
16368 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16369 org-end-time-was-given
16370 (substring txt (match-end 0)))))
16371 (when org-read-date-analyze-futurep
16372 (setq txt (concat txt " (=>F)")))
16373 (setq org-read-date-overlay
16374 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16375 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16377 (defun org-read-date-analyze (ans org-def org-defdecode)
16378 "Analyze the combined answer of the date prompt."
16379 ;; FIXME: cleanup and comment
16380 (let ((nowdecode (decode-time (current-time)))
16381 delta deltan deltaw deltadef year month day
16382 hour minute second wday pm h2 m2 tl wday1
16383 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16384 (setq org-read-date-analyze-futurep nil
16385 org-read-date-analyze-forced-year nil)
16387 (setq ans "+0"))
16389 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16390 (setq ans (replace-match "" t t ans)
16391 deltan (car delta)
16392 deltaw (nth 1 delta)
16393 deltadef (nth 2 delta)))
16395 ;; Check if there is an iso week date in there. If yes, store the
16396 ;; info and postpone interpreting it until the rest of the parsing
16397 ;; is done.
16398 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16399 (setq iso-year (if (match-end 1)
16400 (org-small-year-to-year
16401 (string-to-number (match-string 1 ans))))
16402 iso-weekday (if (match-end 3)
16403 (string-to-number (match-string 3 ans)))
16404 iso-week (string-to-number (match-string 2 ans)))
16405 (setq ans (replace-match "" t t ans)))
16407 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16408 (when (string-match
16410 (setq year (if (match-end 2)
16411 (string-to-number (match-string 2 ans))
16412 (progn (setq kill-year t)
16413 (string-to-number (format-time-string "%Y"))))
16414 month (string-to-number (match-string 3 ans))
16415 day (string-to-number (match-string 4 ans)))
16416 (if (< year 100) (setq year (+ 2000 year)))
16418 t nil ans)))
16420 ;; Help matching dotted european dates
16421 (when (string-match
16422 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16423 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16424 (setq kill-year t)
16425 (string-to-number (format-time-string "%Y")))
16426 day (string-to-number (match-string 1 ans))
16427 month (string-to-number (match-string 2 ans))
16428 ans (replace-match (format "%04d-%02d-%02d" year month day)
16429 t nil ans)))
16431 ;; Help matching american dates, like 5/30 or 5/30/7
16432 (when (string-match
16433 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16434 (setq year (if (match-end 4)
16435 (string-to-number (match-string 4 ans))
16436 (progn (setq kill-year t)
16437 (string-to-number (format-time-string "%Y"))))
16438 month (string-to-number (match-string 1 ans))
16439 day (string-to-number (match-string 2 ans)))
16440 (if (< year 100) (setq year (+ 2000 year)))
16442 t nil ans)))
16443 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16444 ;; If there is a time with am/pm, and *no* time without it, we convert
16445 ;; so that matching will be successful.
16446 (loop for i from 1 to 2 do ; twice, for end time as well
16449 (setq hour (string-to-number (match-string 1 ans))
16450 minute (if (match-end 3)
16451 (string-to-number (match-string 3 ans))
16452 0)
16453 pm (equal ?p
16454 (string-to-char (downcase (match-string 4 ans)))))
16455 (if (and (= hour 12) (not pm))
16456 (setq hour 0)
16457 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16458 (setq ans (replace-match (format "%02d:%02d" hour minute)
16459 t t ans))))
16461 ;; Check if a time range is given as a duration
16462 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16463 (setq hour (string-to-number (match-string 1 ans))
16464 h2 (+ hour (string-to-number (match-string 3 ans)))
16465 minute (string-to-number (match-string 2 ans))
16466 m2 (+ minute (if (match-end 5) (string-to-number
16467 (match-string 5 ans))0)))
16468 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16469 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16470 t t ans)))
16472 ;; Check if there is a time range
16473 (when (boundp 'org-end-time-was-given)
16474 (setq org-time-was-given nil)
16475 (when (and (string-match org-plain-time-of-day-regexp ans)
16476 (match-end 8))
16477 (setq org-end-time-was-given (match-string 8 ans))
16478 (setq ans (concat (substring ans 0 (match-beginning 7))
16479 (substring ans (match-end 7))))))
16481 (setq tl (parse-time-string ans)
16482 day (or (nth 3 tl) (nth 3 org-defdecode))
16483 month (or (nth 4 tl)
16484 (if (and org-read-date-prefer-future
16485 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16486 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16487 (nth 4 org-defdecode)))
16488 year (or (and (not kill-year) (nth 5 tl))
16489 (if (and org-read-date-prefer-future
16490 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16491 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16492 (nth 5 org-defdecode)))
16493 hour (or (nth 2 tl) (nth 2 org-defdecode))
16494 minute (or (nth 1 tl) (nth 1 org-defdecode))
16495 second (or (nth 0 tl) 0)
16496 wday (nth 6 tl))
16498 (when (and (eq org-read-date-prefer-future 'time)
16499 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16500 (equal day (nth 3 nowdecode))
16501 (equal month (nth 4 nowdecode))
16502 (equal year (nth 5 nowdecode))
16503 (nth 2 tl)
16504 (or (< (nth 2 tl) (nth 2 nowdecode))
16505 (and (= (nth 2 tl) (nth 2 nowdecode))
16506 (nth 1 tl)
16507 (< (nth 1 tl) (nth 1 nowdecode)))))
16508 (setq day (1+ day)
16509 futurep t))
16511 ;; Special date definitions below
16512 (cond
16513 (iso-week
16514 ;; There was an iso week
16515 (require 'cal-iso)
16516 (setq futurep nil)
16517 (setq year (or iso-year year)
16518 day (or iso-weekday wday 1)
16519 wday nil ; to make sure that the trigger below does not match
16520 iso-date (calendar-gregorian-from-absolute
16521 (calendar-absolute-from-iso
16522 (list iso-week day year))))
16523 ; FIXME: Should we also push ISO weeks into the future?
16524 ; (when (and org-read-date-prefer-future
16525 ; (not iso-year)
16526 ; (< (calendar-absolute-from-gregorian iso-date)
16527 ; (time-to-days (current-time))))
16528 ; (setq year (1+ year)
16529 ; iso-date (calendar-gregorian-from-absolute
16530 ; (calendar-absolute-from-iso
16531 ; (list iso-week day year)))))
16532 (setq month (car iso-date)
16533 year (nth 2 iso-date)
16534 day (nth 1 iso-date)))
16535 (deltan
16536 (setq futurep nil)
16537 (unless deltadef
16538 (let ((now (decode-time (current-time))))
16539 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16540 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16541 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16542 ((equal deltaw "m") (setq month (+ month deltan)))
16543 ((equal deltaw "y") (setq year (+ year deltan)))))
16544 ((and wday (not (nth 3 tl)))
16545 ;; Weekday was given, but no day, so pick that day in the week
16546 ;; on or after the derived date.
16547 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16548 (unless (equal wday wday1)
16549 (setq day (+ day (% (- wday wday1 -7) 7))))))
16550 (if (and (boundp 'org-time-was-given)
16551 (nth 2 tl))
16552 (setq org-time-was-given t))
16553 (if (< year 100) (setq year (+ 2000 year)))
16554 ;; Check of the date is representable
16555 (if org-read-date-force-compatible-dates
16556 (progn
16557 (if (< year 1970)
16558 (setq year 1970 org-read-date-analyze-forced-year t))
16559 (if (> year 2037)
16560 (setq year 2037 org-read-date-analyze-forced-year t)))
16561 (condition-case nil
16562 (ignore (encode-time second minute hour day month year))
16563 (error
16564 (setq year (nth 5 org-defdecode))
16565 (setq org-read-date-analyze-forced-year t))))
16566 (setq org-read-date-analyze-futurep futurep)
16567 (list second minute hour day month year)))
16569 (defvar parse-time-weekdays)
16570 (defun org-read-date-get-relative (s today default)
16571 "Check string S for special relative date string.
16572 TODAY and DEFAULT are internal times, for today and for a default.
16573 Return shift list (N what def-flag)
16575 N is the number of WHATs to shift.
16576 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16577 the DEFAULT date rather than TODAY."
16578 (require 'parse-time)
16579 (when (and
16580 (string-match
16581 (concat
16586 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16587 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16588 (string-to-char (substring (match-string 1 s) -1))
16589 ?+))
16590 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16591 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16592 (what (if (match-end 3) (match-string 3 s) "d"))
16593 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16594 (date (if rel default today))
16595 (wday (nth 6 (decode-time date)))
16596 delta)
16597 (if wday1
16598 (progn
16599 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16600 (if (= delta 0) (setq delta 7))
16601 (if (= dir ?-)
16602 (progn
16603 (setq delta (- delta 7))
16604 (if (= delta 0) (setq delta -7))))
16605 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16606 (list delta "d" rel))
16607 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16609 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16610 "Turn a user-specified date into the internal representation.
16611 The internal representation needed by the calendar is (month day year).
16612 This is a wrapper to handle the brain-dead convention in calendar that
16613 user function argument order change dependent on argument order."
16614 (if (boundp 'calendar-date-style)
16615 (cond
16616 ((eq calendar-date-style 'american)
16617 (list arg1 arg2 arg3))
16618 ((eq calendar-date-style 'european)
16619 (list arg2 arg1 arg3))
16620 ((eq calendar-date-style 'iso)
16621 (list arg2 arg3 arg1)))
16622 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16623 (if (org-bound-and-true-p european-calendar-style)
16624 (list arg2 arg1 arg3)
16625 (list arg1 arg2 arg3)))))
16627 (defun org-eval-in-calendar (form &optional keepdate)
16628 "Eval FORM in the calendar window and return to current window.
16629 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16630 otherwise stick to the current value of `org-ans2'."
16631 (let ((sf (selected-frame))
16632 (sw (selected-window)))
16633 (select-window (get-buffer-window "*Calendar*" t))
16634 (eval form)
16635 (when (and (not keepdate) (calendar-cursor-to-date))
16636 (let* ((date (calendar-cursor-to-date))
16637 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16638 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16639 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16640 (select-window sw)
16641 (org-select-frame-set-input-focus sf)))
16643 (defun org-calendar-select ()
16644 "Return to `org-read-date' with the date currently selected.
16645 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16646 (interactive)
16647 (when (calendar-cursor-to-date)
16648 (let* ((date (calendar-cursor-to-date))
16649 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16650 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16651 (if (active-minibuffer-window) (exit-minibuffer))))
16653 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16654 "Insert a date stamp for the date given by the internal TIME.
16655 WITH-HM means use the stamp format that includes the time of the day.
16656 INACTIVE means use square brackets instead of angular ones, so that the
16657 stamp will not contribute to the agenda.
16658 PRE and POST are optional strings to be inserted before and after the
16659 stamp.
16660 The command returns the inserted time stamp."
16661 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16662 stamp)
16663 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16664 (insert-before-markers (or pre ""))
16665 (when (listp extra)
16666 (setq extra (car extra))
16667 (if (and (stringp extra)
16669 (setq extra (format "-%02d:%02d"
16670 (string-to-number (match-string 1 extra))
16671 (string-to-number (match-string 2 extra))))
16672 (setq extra nil)))
16673 (when extra
16674 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16675 (insert-before-markers (setq stamp (format-time-string fmt time)))
16676 (insert-before-markers (or post ""))
16677 (setq org-last-inserted-timestamp stamp)))
16679 (defun org-toggle-time-stamp-overlays ()
16680 "Toggle the use of custom time stamp formats."
16681 (interactive)
16682 (setq org-display-custom-times (not org-display-custom-times))
16683 (unless org-display-custom-times
16684 (let ((p (point-min)) (bmp (buffer-modified-p)))
16685 (while (setq p (next-single-property-change p 'display))
16686 (if (and (get-text-property p 'display)
16687 (eq (get-text-property p 'face) 'org-date))
16688 (remove-text-properties
16689 p (setq p (next-single-property-change p 'display))
16690 '(display t))))
16691 (set-buffer-modified-p bmp)))
16692 (if (featurep 'xemacs)
16693 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16694 (org-restart-font-lock)
16695 (setq org-table-may-need-update t)
16696 (if org-display-custom-times
16697 (message "Time stamps are overlaid with custom format")
16698 (message "Time stamp overlays removed")))
16700 (defun org-display-custom-time (beg end)
16701 "Overlay modified time stamp format over timestamp between BEG and END."
16702 (let* ((ts (buffer-substring beg end))
16703 t1 w1 with-hm tf time str w2 (off 0))
16704 (save-match-data
16705 (setq t1 (org-parse-time-string ts t))
16706 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16707 (setq off (- (match-end 0) (match-beginning 0)))))
16708 (setq end (- end off))
16709 (setq w1 (- end beg)
16710 with-hm (and (nth 1 t1) (nth 2 t1))
16711 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16712 time (org-fix-decoded-time t1)
16713 str (org-add-props
16714 (format-time-string
16715 (substring tf 1 -1) (apply 'encode-time time))
16716 nil 'mouse-face 'highlight)
16717 w2 (length str))
16718 (if (not (= w2 w1))
16719 (add-text-properties (1+ beg) (+ 2 beg)
16720 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16721 (if (featurep 'xemacs)
16722 (progn
16723 (put-text-property beg end 'invisible t)
16724 (put-text-property beg end 'end-glyph (make-glyph str)))
16725 (put-text-property beg end 'display str))))
16727 (defun org-translate-time (string)
16728 "Translate all timestamps in STRING to custom format.
16729 But do this only if the variable `org-display-custom-times' is set."
16730 (when org-display-custom-times
16731 (save-match-data
16732 (let* ((start 0)
16733 (re org-ts-regexp-both)
16734 t1 with-hm inactive tf time str beg end)
16735 (while (setq start (string-match re string start))
16736 (setq beg (match-beginning 0)
16737 end (match-end 0)
16738 t1 (save-match-data
16739 (org-parse-time-string (substring string beg end) t))
16740 with-hm (and (nth 1 t1) (nth 2 t1))
16741 inactive (equal (substring string beg (1+ beg)) "[")
16742 tf (funcall (if with-hm 'cdr 'car)
16743 org-time-stamp-custom-formats)
16744 time (org-fix-decoded-time t1)
16745 str (format-time-string
16746 (concat
16747 (if inactive "[" "<") (substring tf 1 -1)
16748 (if inactive "]" ">"))
16749 (apply 'encode-time time))
16750 string (replace-match str t t string)
16751 start (+ start (length str)))))))
16752 string)
16754 (defun org-fix-decoded-time (time)
16755 "Set 0 instead of nil for the first 6 elements of time.
16756 Don't touch the rest."
16757 (let ((n 0))
16758 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16760 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16762 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16763 "Difference between TIMESTAMP-STRING and now in days.
16764 If SECONDS is non-nil, return the difference in seconds."
16765 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16766 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16767 (funcall fdiff (current-time)))))
16769 (defun org-deadline-close (timestamp-string &optional ndays)
16770 "Is the time in TIMESTAMP-STRING close to the current date?"
16771 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16772 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16773 (not (org-entry-is-done-p))))
16775 (defun org-get-wdays (ts &optional delay zero-delay)
16776 "Get the deadline lead time appropriate for timestring TS.
16777 When DELAY is non-nil, get the delay time for scheduled items
16778 instead of the deadline lead time. When ZERO-DELAY is non-nil
16779 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16780 don't try to find the delay cookie in the scheduled timestamp."
16781 (let ((tv (if delay org-scheduled-delay-days
16782 org-deadline-warning-days)))
16783 (cond
16784 ((or (and delay (< tv 0))
16785 (and delay zero-delay (<= tv 0))
16786 (and (not delay) (<= tv 0)))
16787 ;; Enforce this value no matter what
16788 (- tv))
16790 ;; lead time is specified.
16791 (floor (* (string-to-number (match-string 1 ts))
16792 (cdr (assoc (match-string 2 ts)
16793 '(("d" . 1) ("w" . 7)
16794 ("m" . 30.4) ("y" . 365.25)
16795 ("h" . 0.041667)))))))
16796 ;; go for the default.
16797 (t tv))))
16799 (defun org-calendar-select-mouse (ev)
16800 "Return to `org-read-date' with the date currently selected.
16801 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16802 (interactive "e")
16803 (mouse-set-point ev)
16804 (when (calendar-cursor-to-date)
16805 (let* ((date (calendar-cursor-to-date))
16806 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16807 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16808 (if (active-minibuffer-window) (exit-minibuffer))))
16810 (defun org-check-deadlines (ndays)
16811 "Check if there are any deadlines due or past due.
16812 A deadline is considered due if it happens within `org-deadline-warning-days'
16813 days from today's date. If the deadline appears in an entry marked DONE,
16814 it is not shown. The prefix arg NDAYS can be used to test that many
16816 (interactive "P")
16817 (let* ((org-warn-days
16818 (cond
16819 ((equal ndays '(4)) 100000)
16820 (ndays (prefix-numeric-value ndays))
16821 (t (abs org-deadline-warning-days))))
16822 (case-fold-search nil)
16824 (callback
16825 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16827 (message "%d deadlines past-due or due within %d days"
16828 (org-occur regexp nil callback)
16829 org-warn-days)))
16831 (defsubst org-re-timestamp (type)
16832 "Return a regexp for timestamp TYPE.
16833 Allowed values for TYPE are:
16835 all: all timestamps
16836 active: only active timestamps (<...>)
16837 inactive: only inactive timestamps ([...])
16838 scheduled: only scheduled timestamps
16839 deadline: only deadline timestamps
16840 closed: only closed time-stamps
16842 When TYPE is nil, fall back on returning a regexp that matches
16843 both scheduled and deadline timestamps."
16844 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16845 ((eq type 'active) org-ts-regexp)
16849 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16850 ((eq type 'scheduled-or-deadline)
16853 (defun org-check-before-date (date)
16854 "Check if there are deadlines or scheduled entries before DATE."
16855 (interactive (list (org-read-date)))
16856 (let ((case-fold-search nil)
16857 (regexp (org-re-timestamp org-ts-type))
16858 (callback
16859 (lambda () (time-less-p
16860 (org-time-string-to-time (match-string 1))
16861 (org-time-string-to-time date)))))
16862 (message "%d entries before %s"
16863 (org-occur regexp nil callback) date)))
16865 (defun org-check-after-date (date)
16866 "Check if there are deadlines or scheduled entries after DATE."
16867 (interactive (list (org-read-date)))
16868 (let ((case-fold-search nil)
16869 (regexp (org-re-timestamp org-ts-type))
16870 (callback
16871 (lambda () (not
16872 (time-less-p
16873 (org-time-string-to-time (match-string 1))
16874 (org-time-string-to-time date))))))
16875 (message "%d entries after %s"
16876 (org-occur regexp nil callback) date)))
16878 (defun org-check-dates-range (start-date end-date)
16879 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16880 (interactive (list (org-read-date nil nil nil "Range starts")
16881 (org-read-date nil nil nil "Range end")))
16882 (let ((case-fold-search nil)
16883 (regexp (org-re-timestamp org-ts-type))
16884 (callback
16885 (lambda ()
16886 (let ((match (match-string 1)))
16887 (and
16888 (not (time-less-p
16889 (org-time-string-to-time match)
16890 (org-time-string-to-time start-date)))
16891 (time-less-p
16892 (org-time-string-to-time match)
16893 (org-time-string-to-time end-date)))))))
16894 (message "%d entries between %s and %s"
16895 (org-occur regexp nil callback) start-date end-date)))
16897 (defun org-evaluate-time-range (&optional to-buffer)
16898 "Evaluate a time range by computing the difference between start and end.
16899 Normally the result is just printed in the echo area, but with prefix arg
16900 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16901 If the time range is actually in a table, the result is inserted into the
16902 next column.
16903 For time difference computation, a year is assumed to be exactly 365
16904 days in order to avoid rounding problems."
16905 (interactive "P")
16906 (or
16907 (org-clock-update-time-maybe)
16908 (save-excursion
16909 (unless (org-at-date-range-p t)
16910 (goto-char (point-at-bol))
16911 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16912 (if (not (org-at-date-range-p t))
16913 (user-error "Not at a time-stamp range, and none found in current line")))
16914 (let* ((ts1 (match-string 1))
16915 (ts2 (match-string 2))
16916 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16917 (match-end (match-end 0))
16918 (time1 (org-time-string-to-time ts1))
16919 (time2 (org-time-string-to-time ts2))
16920 (t1 (org-float-time time1))
16921 (t2 (org-float-time time2))
16922 (diff (abs (- t2 t1)))
16923 (negative (< (- t2 t1) 0))
16924 ;; (ys (floor (* 365 24 60 60)))
16925 (ds (* 24 60 60))
16926 (hs (* 60 60))
16927 (fy "%dy %dd %02d:%02d")
16928 (fy1 "%dy %dd")
16929 (fd "%dd %02d:%02d")
16930 (fd1 "%dd")
16931 (fh "%02d:%02d")
16932 y d h m align)
16933 (if havetime
16934 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16935 y 0
16936 d (floor (/ diff ds)) diff (mod diff ds)
16937 h (floor (/ diff hs)) diff (mod diff hs)
16938 m (floor (/ diff 60)))
16939 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16940 y 0
16941 d (floor (+ (/ diff ds) 0.5))
16942 h 0 m 0))
16943 (if (not to-buffer)
16944 (message "%s" (org-make-tdiff-string y d h m))
16945 (if (org-at-table-p)
16946 (progn
16947 (goto-char match-end)
16948 (setq align t)
16949 (and (looking-at " *|") (goto-char (match-end 0))))
16950 (goto-char match-end))
16951 (if (looking-at
16953 (replace-match ""))
16954 (if negative (insert " -"))
16955 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16956 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16957 (insert " " (format fh h m))))
16958 (if align (org-table-align))
16959 (message "Time difference inserted")))))
16961 (defun org-make-tdiff-string (y d h m)
16962 (let ((fmt "")
16963 (l nil))
16964 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16965 l (push y l)))
16966 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16967 l (push d l)))
16968 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16969 l (push h l)))
16970 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16971 l (push m l)))
16972 (apply 'format fmt (nreverse l))))
16974 (defun org-time-string-to-time (s &optional buffer pos)
16975 "Convert a timestamp string into internal time."
16976 (condition-case errdata
16977 (apply 'encode-time (org-parse-time-string s))
16979 s (if (not (and buffer pos))
16980 ""
16981 (format " at %d in buffer `%s'" pos buffer))
16982 (cdr errdata)))))
16984 (defun org-time-string-to-seconds (s)
16985 "Convert a timestamp string to a number of seconds."
16986 (org-float-time (org-time-string-to-time s)))
16988 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16989 "Convert a time stamp to an absolute day number.
16990 If there is a specifier for a cyclic time stamp, get the closest
16991 date to DAYNR.
16992 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16993 The variable `date' is bound by the calendar when this is called."
16994 (cond
16996 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16997 daynr
16998 (+ daynr 1000)))
17000 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17001 (time-to-days (current-time))) (match-string 0 s)
17002 prefer show-all))
17003 (t (time-to-days
17004 (condition-case errdata
17005 (apply 'encode-time (org-parse-time-string s))
17007 s (if (not (and buffer pos))
17008 ""
17009 (format " at %d in buffer `%s'" pos buffer))
17010 (cdr errdata))))))))
17012 (defun org-days-to-iso-week (days)
17013 "Return the iso week number."
17014 (require 'cal-iso)
17015 (car (calendar-iso-from-absolute days)))
17017 (defun org-small-year-to-year (year)
17018 "Convert 2-digit years into 4-digit years.
17019 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17020 The year 2000 cannot be abbreviated. Any year larger than 99
17021 is returned unchanged."
17022 (if (< year 38)
17023 (setq year (+ 2000 year))
17024 (if (< year 100)
17025 (setq year (+ 1900 year))))
17026 year)
17028 (defun org-time-from-absolute (d)
17029 "Return the time corresponding to date D.
17030 D may be an absolute day number, or a calendar-type list (month day year)."
17031 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17032 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17034 (defun org-calendar-holiday ()
17035 "List of holidays, for Diary display in Org-mode."
17036 (require 'holidays)
17037 (let ((hl (funcall
17038 (if (fboundp 'calendar-check-holidays)
17039 'calendar-check-holidays 'check-calendar-holidays) date)))
17040 (if hl (mapconcat 'identity hl "; "))))
17042 (defun org-diary-sexp-entry (sexp entry date)
17043 "Process a SEXP diary ENTRY for DATE."
17044 (require 'diary-lib)
17045 (let ((result (if calendar-debug-sexp
17046 (let ((stack-trace-on-error t))
17047 (eval (car (read-from-string sexp))))
17048 (condition-case nil
17049 (eval (car (read-from-string sexp)))
17050 (error
17051 (beep)
17052 (message "Bad sexp at line %d in %s: %s"
17053 (org-current-line)
17054 (buffer-file-name) sexp)
17055 (sleep-for 2))))))
17056 (cond ((stringp result) (split-string result "; "))
17057 ((and (consp result)
17058 (not (consp (cdr result)))
17059 (stringp (cdr result))) (cdr result))
17060 ((and (consp result)
17061 (stringp (car result))) result)
17062 (result entry))))
17064 (defun org-diary-to-ical-string (frombuf)
17065 "Get iCalendar entries from diary entries in buffer FROMBUF.
17066 This uses the icalendar.el library."
17067 (let* ((tmpdir (if (featurep 'xemacs)
17068 (temp-directory)
17069 temporary-file-directory))
17070 (tmpfile (make-temp-name
17071 (expand-file-name "orgics" tmpdir)))
17072 buf rtn b e)
17073 (with-current-buffer frombuf
17074 (icalendar-export-region (point-min) (point-max) tmpfile)
17075 (setq buf (find-buffer-visiting tmpfile))
17076 (set-buffer buf)
17077 (goto-char (point-min))
17078 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17079 (setq b (match-beginning 0)))
17080 (goto-char (point-max))
17081 (if (re-search-backward "^END:VEVENT" nil t)
17082 (setq e (match-end 0)))
17084 (kill-buffer buf)
17085 (delete-file tmpfile)
17086 rtn))
17088 (defun org-closest-date (start current change prefer show-all)
17089 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17090 When PREFER is `past', return a date that is either CURRENT or past.
17091 When PREFER is `future', return a date that is either CURRENT or future.
17092 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17093 ;; Make the proper lists from the dates
17094 (catch 'exit
17095 (let ((a1 '(("h" . hour)
17096 ("d" . day)
17097 ("w" . week)
17098 ("m" . month)
17099 ("y" . year)))
17100 (shour (nth 2 (org-parse-time-string start)))
17101 dn dw sday cday n1 n2 n0
17102 d m y y1 y2 date1 date2 nmonths nm ny m2)
17104 (setq start (org-date-to-gregorian start)
17105 current (org-date-to-gregorian
17106 (if show-all
17107 current
17108 (time-to-days (current-time))))
17109 sday (calendar-absolute-from-gregorian start)
17110 cday (calendar-absolute-from-gregorian current))
17112 (if (<= cday sday) (throw 'exit sday))
17115 (setq dn (string-to-number (match-string 1 change))
17116 dw (cdr (assoc (match-string 2 change) a1)))
17117 (user-error "Invalid change specifier: %s" change))
17118 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17119 (cond
17120 ((eq dw 'hour)
17121 (let ((missing-hours
17122 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17123 dn)))
17124 (setq n1 (if (zerop missing-hours) cday
17125 (- cday (1+ (floor (/ missing-hours 24)))))
17126 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17127 ((eq dw 'day)
17128 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17129 n2 (+ n1 dn)))
17130 ((eq dw 'year)
17131 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17132 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17133 (setq date1 (list m d y1)
17134 n1 (calendar-absolute-from-gregorian date1)
17135 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17136 n2 (calendar-absolute-from-gregorian date2)))
17137 ((eq dw 'month)
17138 ;; approx number of month between the two dates
17139 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17140 ;; How often does dn fit in there?
17141 (setq d (nth 1 start) m (car start) y (nth 2 start)
17142 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17143 m (+ m nm)
17144 ny (floor (/ m 12))
17145 y (+ y ny)
17146 m (- m (* ny 12)))
17147 (while (> m 12) (setq m (- m 12) y (1+ y)))
17148 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17149 (setq m2 (+ m dn) y2 y)
17150 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17151 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17152 (while (<= n2 cday)
17153 (setq n1 n2 m m2 y y2)
17154 (setq m2 (+ m dn) y2 y)
17155 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17156 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17157 ;; Make sure n1 is the earlier date
17158 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17159 (if show-all
17160 (cond
17161 ((eq prefer 'past) (if (= cday n2) n2 n1))
17162 ((eq prefer 'future) (if (= cday n1) n1 n2))
17163 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17164 (cond
17165 ((eq prefer 'past) (if (= cday n2) n2 n1))
17166 ((eq prefer 'future) (if (= cday n1) n1 n2))
17167 (t (if (= cday n1) n1 n2)))))))
17169 (defun org-date-to-gregorian (date)
17170 "Turn any specification of DATE into a Gregorian date for the calendar."
17171 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17172 ((and (listp date) (= (length date) 3)) date)
17173 ((stringp date)
17174 (setq date (org-parse-time-string date))
17175 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17176 ((listp date)
17177 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17179 (defun org-parse-time-string (s &optional nodefault)
17180 "Parse the standard Org-mode time string.
17181 This should be a lot faster than the normal `parse-time-string'.
17182 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17183 hour and minute fields will be nil if not given."
17184 (cond ((string-match org-ts-regexp0 s)
17185 (list 0
17186 (if (or (match-beginning 8) (not nodefault))
17187 (string-to-number (or (match-string 8 s) "0")))
17188 (if (or (match-beginning 7) (not nodefault))
17189 (string-to-number (or (match-string 7 s) "0")))
17190 (string-to-number (match-string 4 s))
17191 (string-to-number (match-string 3 s))
17192 (string-to-number (match-string 2 s))
17193 nil nil nil))
17194 ((string-match "^<[^>]+>$" s)
17195 (decode-time (seconds-to-time (org-matcher-time s))))
17196 (t (error "Not a standard Org-mode time string: %s" s))))
17198 (defun org-timestamp-up (&optional arg)
17199 "Increase the date item at the cursor by one.
17200 If the cursor is on the year, change the year. If it is on the month,
17201 the day or the time, change that.
17202 With prefix ARG, change by that many units."
17203 (interactive "p")
17204 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17206 (defun org-timestamp-down (&optional arg)
17207 "Decrease the date item at the cursor by one.
17208 If the cursor is on the year, change the year. If it is on the month,
17209 the day or the time, change that.
17210 With prefix ARG, change by that many units."
17211 (interactive "p")
17212 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17214 (defun org-timestamp-up-day (&optional arg)
17215 "Increase the date in the time stamp by one day.
17216 With prefix ARG, change that many days."
17217 (interactive "p")
17218 (if (and (not (org-at-timestamp-p t))
17219 (org-at-heading-p))
17220 (org-todo 'up)
17221 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17223 (defun org-timestamp-down-day (&optional arg)
17224 "Decrease the date in the time stamp by one day.
17225 With prefix ARG, change that many days."
17226 (interactive "p")
17227 (if (and (not (org-at-timestamp-p t))
17228 (org-at-heading-p))
17229 (org-todo 'down)
17230 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17232 (defun org-at-timestamp-p (&optional inactive-ok)
17233 "Determine if the cursor is in or at a timestamp."
17234 (interactive)
17235 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17236 (pos (point))
17237 (ans (or (looking-at tsr)
17238 (save-excursion
17240 (if (> (point) (point-min)) (backward-char 1))
17241 (and (looking-at tsr)
17242 (> (- (match-end 0) pos) -1))))))
17243 (and ans
17244 (boundp 'org-ts-what)
17245 (setq org-ts-what
17246 (cond
17247 ((= pos (match-beginning 0)) 'bracket)
17248 ;; Point is considered to be "on the bracket" whether
17249 ;; it's really on it or right after it.
17250 ((= pos (1- (match-end 0))) 'bracket)
17251 ((= pos (match-end 0)) 'after)
17252 ((org-pos-in-match-range pos 2) 'year)
17253 ((org-pos-in-match-range pos 3) 'month)
17254 ((org-pos-in-match-range pos 7) 'hour)
17255 ((org-pos-in-match-range pos 8) 'minute)
17256 ((or (org-pos-in-match-range pos 4)
17257 (org-pos-in-match-range pos 5)) 'day)
17258 ((and (> pos (or (match-end 8) (match-end 5)))
17259 (< pos (match-end 0)))
17260 (- pos (or (match-end 8) (match-end 5))))
17261 (t 'day))))
17262 ans))
17264 (defun org-toggle-timestamp-type ()
17265 "Toggle the type (<active> or [inactive]) of a time stamp."
17266 (interactive)
17267 (when (org-at-timestamp-p t)
17268 (let ((beg (match-beginning 0)) (end (match-end 0))
17269 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17270 (save-excursion
17271 (goto-char beg)
17272 (while (re-search-forward "[][<>]" end t)
17273 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17274 t t)))
17275 (message "Timestamp is now %sactive"
17276 (if (equal (char-after beg) ?<) "" "in")))))
17278 (defun org-at-clock-log-p nil
17279 "Is the cursor on the clock log line?"
17280 (save-excursion
17281 (move-beginning-of-line 1)
17284 (defvar org-clock-history) ; defined in org-clock.el
17285 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17286 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17287 "Change the date in the time stamp at point.
17288 The date will be changed by N times WHAT. WHAT can be `day', `month',
17289 `year', `minute', `second'. If WHAT is not given, the cursor position
17290 in the timestamp determines what will be changed.
17292 (let ((origin (point)) origin-cat
17293 with-hm inactive
17294 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17295 org-ts-what
17296 extra rem
17297 ts time time0 fixnext clrgx)
17298 (if (not (org-at-timestamp-p t))
17299 (user-error "Not at a timestamp"))
17300 (if (and (not what) (eq org-ts-what 'bracket))
17301 (org-toggle-timestamp-type)
17302 ;; Point isn't on brackets. Remember the part of the time-stamp
17303 ;; the point was in. Indeed, size of time-stamps may change,
17304 ;; but point must be kept in the same category nonetheless.
17305 (setq origin-cat org-ts-what)
17306 (if (and (not what) (not (eq org-ts-what 'day))
17307 org-display-custom-times
17308 (get-text-property (point) 'display)
17309 (not (get-text-property (1- (point)) 'display)))
17310 (setq org-ts-what 'day))
17311 (setq org-ts-what (or what org-ts-what)
17312 inactive (= (char-after (match-beginning 0)) ?\[)
17313 ts (match-string 0))
17314 (replace-match "")
17315 (when (string-match
17316 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17317 ts)
17318 (setq extra (match-string 1 ts))
17319 (if suppress-tmp-delay
17320 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17322 (setq with-hm t))
17323 (setq time0 (org-parse-time-string ts))
17324 (when (and updown
17325 (eq org-ts-what 'minute)
17326 (not current-prefix-arg))
17327 ;; This looks like s-up and s-down. Change by one rounding step.
17328 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17329 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17330 (setcar (cdr time0) (+ (nth 1 time0)
17331 (if (> n 0) (- rem) (- dm rem))))))
17332 (setq time
17333 (encode-time (or (car time0) 0)
17334 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17335 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17336 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17337 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17338 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17339 (nthcdr 6 time0)))
17340 (when (and (member org-ts-what '(hour minute))
17341 extra
17343 (setq extra (org-modify-ts-extra
17344 extra
17345 (if (eq org-ts-what 'hour) 2 5)
17346 n dm)))
17347 (when (integerp org-ts-what)
17348 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17349 (if (eq what 'calendar)
17350 (let ((cal-date (org-get-date-from-calendar)))
17351 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17352 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17353 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17354 (setcar time0 (or (car time0) 0))
17355 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17356 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17357 (setq time (apply 'encode-time time0))))
17358 ;; Insert the new time-stamp, and ensure point stays in the same
17359 ;; category as before (i.e. not after the last position in that
17360 ;; category).
17361 (let ((pos (point)))
17362 ;; Stay before inserted string. `save-excursion' is of no use.
17363 (setq org-last-changed-timestamp
17364 (org-insert-time-stamp time with-hm inactive nil nil extra))
17365 (goto-char pos))
17366 (save-match-data
17367 (looking-at org-ts-regexp3)
17368 (goto-char (cond
17369 ;; `day' category ends before `hour' if any, or at
17370 ;; the end of the day name.
17371 ((eq origin-cat 'day)
17372 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17373 ((eq origin-cat 'hour) (min (match-end 7) origin))
17374 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17375 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17376 ;; `year' and `month' have both fixed size: point
17377 ;; couldn't have moved into another part.
17378 (t origin))))
17379 ;; Update clock if on a CLOCK line.
17380 (org-clock-update-time-maybe)
17381 ;; Maybe adjust the closest clock in `org-clock-history'
17382 (when org-clock-adjust-closest
17383 (if (not (and (org-at-clock-log-p)
17384 (< 1 (length (delq nil (mapcar 'marker-position
17385 org-clock-history))))))
17386 (message "No clock to adjust")
17387 (cond ((save-excursion ; fix previous clock?
17388 (re-search-backward org-ts-regexp0 nil t)
17391 ((save-excursion ; fix next clock?
17392 (re-search-backward org-ts-regexp0 nil t)
17395 (save-window-excursion
17396 ;; Find closest clock to point, adjust the previous/next one in history
17397 (let* ((p (save-excursion (org-back-to-heading t)))
17398 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17399 (clfixnth
17400 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17401 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17402 (if (not clfixpos)
17403 (message "No clock to adjust")
17404 (save-excursion
17405 (org-goto-marker-or-bmk clfixpos)
17406 (org-show-subtree)
17407 (when (re-search-forward clrgx nil t)
17408 (goto-char (match-beginning 1))
17409 (let (org-clock-adjust-closest)
17410 (org-timestamp-change n org-ts-what updown))
17411 (message "Clock adjusted in %s for heading: %s"
17412 (file-name-nondirectory (buffer-file-name))
17413 (org-get-heading t t)))))))))
17414 ;; Try to recenter the calendar window, if any.
17415 (if (and org-calendar-follow-timestamp-change
17416 (get-buffer-window "*Calendar*" t)
17417 (memq org-ts-what '(day month year)))
17418 (org-recenter-calendar (time-to-days time))))))
17420 (defun org-modify-ts-extra (s pos n dm)
17421 "Change the different parts of the lead-time and repeat fields in timestamp."
17422 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17423 ng h m new rem)
17424 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17425 (cond
17426 ((or (org-pos-in-match-range pos 2)
17427 (org-pos-in-match-range pos 3))
17428 (setq m (string-to-number (match-string 3 s))
17429 h (string-to-number (match-string 2 s)))
17430 (if (org-pos-in-match-range pos 2)
17431 (setq h (+ h n))
17432 (setq n (* dm (org-no-warnings (signum n))))
17433 (when (not (= 0 (setq rem (% m dm))))
17434 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17435 (setq m (+ m n)))
17436 (if (< m 0) (setq m (+ m 60) h (1- h)))
17437 (if (> m 59) (setq m (- m 60) h (1+ h)))
17438 (setq h (min 24 (max 0 h)))
17439 (setq ng 1 new (format "-%02d:%02d" h m)))
17440 ((org-pos-in-match-range pos 6)
17441 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17442 ((org-pos-in-match-range pos 5)
17443 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17445 ((org-pos-in-match-range pos 9)
17446 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17447 ((org-pos-in-match-range pos 8)
17448 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17450 (when ng
17451 (setq s (concat
17452 (substring s 0 (match-beginning ng))
17453 new
17454 (substring s (match-end ng))))))
17455 s))
17457 (defun org-recenter-calendar (date)
17458 "If the calendar is visible, recenter it to DATE."
17459 (let ((cwin (get-buffer-window "*Calendar*" t)))
17460 (when cwin
17461 (let ((calendar-move-hook nil))
17462 (with-selected-window cwin
17463 (calendar-goto-date (if (listp date) date
17464 (calendar-gregorian-from-absolute date))))))))
17466 (defun org-goto-calendar (&optional arg)
17467 "Go to the Emacs calendar at the current date.
17468 If there is a time stamp in the current line, go to that date.
17469 A prefix ARG can be used to force the current date."
17470 (interactive "P")
17471 (let ((tsr org-ts-regexp) diff
17472 (calendar-move-hook nil)
17473 (calendar-view-holidays-initially-flag nil)
17474 (calendar-view-diary-initially-flag nil))
17475 (if (or (org-at-timestamp-p)
17476 (save-excursion
17477 (beginning-of-line 1)
17478 (looking-at (concat ".*" tsr))))
17479 (let ((d1 (time-to-days (current-time)))
17480 (d2 (time-to-days
17481 (org-time-string-to-time (match-string 1)))))
17482 (setq diff (- d2 d1))))
17483 (calendar)
17484 (calendar-goto-today)
17485 (if (and diff (not arg)) (calendar-forward-day diff))))
17487 (defun org-get-date-from-calendar ()
17488 "Return a list (month day year) of date at point in calendar."
17489 (with-current-buffer "*Calendar*"
17490 (save-match-data
17491 (calendar-cursor-to-date))))
17493 (defun org-date-from-calendar ()
17494 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17495 If there is already a time stamp at the cursor position, update it."
17496 (interactive)
17497 (if (org-at-timestamp-p t)
17498 (org-timestamp-change 0 'calendar)
17499 (let ((cal-date (org-get-date-from-calendar)))
17500 (org-insert-time-stamp
17501 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17503 (defcustom org-effort-durations
17504 `(("h" . 60)
17505 ("d" . ,(* 60 8))
17506 ("w" . ,(* 60 8 5))
17507 ("m" . ,(* 60 8 5 4))
17508 ("y" . ,(* 60 8 5 40)))
17509 "Conversion factor to minutes for an effort modifier.
17511 Each entry has the form (MODIFIER . MINUTES).
17513 In an effort string, a number followed by MODIFIER is multiplied
17514 by the specified number of MINUTES to obtain an effort in
17515 minutes.
17519 :group 'org-agenda
17520 :version "24.1"
17521 :type '(alist :key-type (string :tag "Modifier")
17522 :value-type (number :tag "Minutes")))
17524 (defun org-minutes-to-clocksum-string (m)
17525 "Format number of minutes as a clocksum string.
17526 The format is determined by `org-time-clocksum-format',
17527 `org-time-clocksum-use-fractional' and
17528 `org-time-clocksum-fractional-format' and
17529 `org-time-clocksum-use-effort-durations'."
17530 (let ((clocksum "")
17531 (m (round m)) ; Don't allow fractions of minutes
17532 h d w mo y fmt n)
17533 (setq h (if org-time-clocksum-use-effort-durations
17534 (cdr (assoc "h" org-effort-durations)) 60)
17535 d (if org-time-clocksum-use-effort-durations
17536 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17537 w (if org-time-clocksum-use-effort-durations
17538 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17539 mo (if org-time-clocksum-use-effort-durations
17540 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17541 y (if org-time-clocksum-use-effort-durations
17542 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17543 ;; fractional format
17544 (if org-time-clocksum-use-fractional
17545 (cond
17546 ;; single format string
17547 ((stringp org-time-clocksum-fractional-format)
17548 (format org-time-clocksum-fractional-format (/ m (float h))))
17549 ;; choice of fractional formats for different time units
17550 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17551 (> (/ (truncate m) (* y d h)) 0))
17552 (format fmt (/ m (* y d (float h)))))
17553 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17554 (> (/ (truncate m) (* mo d h)) 0))
17555 (format fmt (/ m (* mo d (float h)))))
17556 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17557 (> (/ (truncate m) (* w d h)) 0))
17558 (format fmt (/ m (* w d (float h)))))
17559 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17560 (> (/ (truncate m) (* d h)) 0))
17561 (format fmt (/ m (* d (float h)))))
17562 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17563 (> (/ (truncate m) h) 0))
17564 (format fmt (/ m (float h))))
17565 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17566 (format fmt m))
17567 ;; fall back to smallest time unit with a format
17568 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17569 (format fmt (/ m (float h))))
17570 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17571 (format fmt (/ m (* d (float h)))))
17572 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17573 (format fmt (/ m (* w d (float h)))))
17574 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17575 (format fmt (/ m (* mo d (float h)))))
17576 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17577 (format fmt (/ m (* y d (float h))))))
17578 ;; standard (non-fractional) format, with single format string
17579 (if (stringp org-time-clocksum-format)
17580 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17581 ;; separate formats components
17582 (and (setq fmt (plist-get org-time-clocksum-format :years))
17583 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17584 (plist-get org-time-clocksum-format :require-years))
17585 (setq clocksum (concat clocksum (format fmt n))
17586 m (- m (* n y d h))))
17587 (and (setq fmt (plist-get org-time-clocksum-format :months))
17588 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17589 (plist-get org-time-clocksum-format :require-months))
17590 (setq clocksum (concat clocksum (format fmt n))
17591 m (- m (* n mo d h))))
17592 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17593 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17594 (plist-get org-time-clocksum-format :require-weeks))
17595 (setq clocksum (concat clocksum (format fmt n))
17596 m (- m (* n w d h))))
17597 (and (setq fmt (plist-get org-time-clocksum-format :days))
17598 (or (> (setq n (/ (truncate m) (* d h))) 0)
17599 (plist-get org-time-clocksum-format :require-days))
17600 (setq clocksum (concat clocksum (format fmt n))
17601 m (- m (* n d h))))
17602 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17603 (or (> (setq n (/ (truncate m) h)) 0)
17604 (plist-get org-time-clocksum-format :require-hours))
17605 (setq clocksum (concat clocksum (format fmt n))
17606 m (- m (* n h))))
17607 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17608 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17609 (setq clocksum (concat clocksum (format fmt m))))
17610 ;; return formatted time duration
17611 clocksum))))
17613 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17614 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17615 "Org mode version 8.0")
17617 (defun org-hours-to-clocksum-string (n)
17618 (org-minutes-to-clocksum-string (* n 60)))
17620 (defun org-hh:mm-string-to-minutes (s)
17621 "Convert a string H:MM to a number of minutes.
17622 If the string is just a number, interpret it as minutes.
17623 In fact, the first hh:mm or number in the string will be taken,
17624 there can be extra stuff in the string.
17625 If no number is found, the return value is 0."
17626 (cond
17627 ((integerp s) s)
17629 (+ (* (string-to-number (match-string 1 s)) 60)
17630 (string-to-number (match-string 2 s))))
17632 (string-to-number (match-string 1 s)))
17633 (t 0)))
17635 (defcustom org-image-actual-width t
17636 "Should we use the actual width of images when inlining them?
17638 When set to `t', always use the image width.
17640 When set to a number, use imagemagick (when available) to set
17641 the image's width to this value.
17643 When set to a number in a list, try to get the width from any
17644 #+ATTR.* keyword if it matches a width specification like
17646 #+ATTR_HTML: :width 300px
17648 and fall back on that number if none is found.
17650 When set to nil, try to get the width from an #+ATTR.* keyword
17651 and fall back on the original width if none is found.
17653 This requires Emacs >= 24.1, build with imagemagick support."
17654 :group 'org-appearance
17655 :version "24.4"
17656 :package-version '(Org . "8.0")
17657 :type '(choice
17658 (const :tag "Use the image width" t)
17659 (integer :tag "Use a number of pixels")
17660 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17661 (const :tag "Use #+ATTR* or don't resize" nil)))
17663 (defcustom org-agenda-inhibit-startup nil
17664 "Inhibit startup when preparing agenda buffers.
17665 When this variable is `t' (the default), the initialization of
17666 the Org agenda buffers is inhibited: e.g. the visibility state
17667 is not set, the tables are not re-aligned, etc."
17668 :type 'boolean
17669 :version "24.3"
17670 :group 'org-agenda)
17672 (defun org-duration-string-to-minutes (s &optional output-to-string)
17673 "Convert a duration string S to minutes.
17675 A bare number is interpreted as minutes, modifiers can be set by
17676 customizing `org-effort-durations' (which see).
17678 Entries containing a colon are interpreted as H:MM by
17679 `org-hh:mm-string-to-minutes'."
17680 (let ((result 0)
17682 (regexp-opt (mapcar 'car org-effort-durations))
17684 (while (string-match re s)
17685 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17686 (string-to-number (match-string 1 s))))
17687 (setq s (replace-match "" nil t s)))
17688 (setq result (floor result))
17689 (incf result (org-hh:mm-string-to-minutes s))
17690 (if output-to-string (number-to-string result) result)))
17692 ;;;; Files
17694 (defun org-save-all-org-buffers ()
17695 "Save all Org-mode buffers without user confirmation."
17696 (interactive)
17697 (message "Saving all Org-mode buffers...")
17698 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17699 (when (featurep 'org-id) (org-id-locations-save))
17700 (message "Saving all Org-mode buffers... done"))
17702 (defun org-revert-all-org-buffers ()
17703 "Revert all Org-mode buffers.
17704 Prompt for confirmation when there are unsaved changes.
17705 Be sure you know what you are doing before letting this function
17706 overwrite your changes.
17708 This function is useful in a setup where one tracks org files
17709 with a version control system, to revert on one machine after pulling
17710 changes from another. I believe the procedure must be like this:
17712 1. M-x org-save-all-org-buffers
17713 2. Pull changes from the other machine, resolve conflicts
17714 3. M-x org-revert-all-org-buffers"
17715 (interactive)
17716 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17717 (user-error "Abort"))
17718 (save-excursion
17719 (save-window-excursion
17720 (mapc
17721 (lambda (b)
17722 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17723 (with-current-buffer b buffer-file-name))
17724 (org-pop-to-buffer-same-window b)
17725 (revert-buffer t 'no-confirm)))
17726 (buffer-list))
17727 (when (and (featurep 'org-id) org-id-track-globally)
17728 (org-id-locations-load)))))
17730 ;;;; Agenda files
17732 ;;;###autoload
17733 (defun org-switchb (&optional arg)
17734 "Switch between Org buffers.
17735 With one prefix argument, restrict available buffers to files.
17736 With two prefix arguments, restrict available buffers to agenda files.
17738 Defaults to `iswitchb' for buffer name completion.
17739 Set `org-completion-use-ido' to make it use ido instead."
17740 (interactive "P")
17741 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17742 ((equal arg '(16)) (org-buffer-list 'agenda))
17743 (t (org-buffer-list))))
17744 (org-completion-use-iswitchb org-completion-use-iswitchb)
17745 (org-completion-use-ido org-completion-use-ido))
17746 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17747 (setq org-completion-use-iswitchb t))
17748 (org-pop-to-buffer-same-window
17749 (org-icompleting-read "Org buffer: "
17750 (mapcar 'list (mapcar 'buffer-name blist))
17751 nil t))))
17753 ;;; Define some older names previously used for this functionality
17754 ;;;###autoload
17755 (defalias 'org-ido-switchb 'org-switchb)
17756 ;;;###autoload
17757 (defalias 'org-iswitchb 'org-switchb)
17759 (defun org-buffer-list (&optional predicate exclude-tmp)
17760 "Return a list of Org buffers.
17761 PREDICATE can be `export', `files' or `agenda'.
17763 export restrict the list to Export buffers.
17764 files restrict the list to buffers visiting Org files.
17765 agenda restrict the list to buffers visiting agenda files.
17767 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17768 (let* ((bfn nil)
17769 (agenda-files (and (eq predicate 'agenda)
17770 (mapcar 'file-truename (org-agenda-files t))))
17771 (filter
17772 (cond
17773 ((eq predicate 'files)
17774 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17775 ((eq predicate 'export)
17776 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17777 ((eq predicate 'agenda)
17778 (lambda (b)
17779 (with-current-buffer b
17780 (and (derived-mode-p 'org-mode)
17781 (setq bfn (buffer-file-name b))
17782 (member (file-truename bfn) agenda-files)))))
17783 (t (lambda (b) (with-current-buffer b
17784 (or (derived-mode-p 'org-mode)
17785 (string-match "\*Org .*Export"
17786 (buffer-name b)))))))))
17787 (delq nil
17788 (mapcar
17789 (lambda(b)
17790 (if (and (funcall filter b)
17791 (or (not exclude-tmp)
17792 (not (string-match "tmp" (buffer-name b)))))
17793 b
17794 nil))
17795 (buffer-list)))))
17797 (defun org-agenda-files (&optional unrestricted archives)
17798 "Get the list of agenda files.
17799 Optional UNRESTRICTED means return the full list even if a restriction
17800 is currently in place.
17801 When ARCHIVES is t, include all archive files that are really being
17802 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17803 `org-agenda-archives-mode' is t."
17804 (let ((files
17805 (cond
17806 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17807 ((stringp org-agenda-files) (org-read-agenda-file-list))
17808 ((listp org-agenda-files) org-agenda-files)
17809 (t (error "Invalid value of `org-agenda-files'")))))
17810 (setq files (apply 'append
17811 (mapcar (lambda (f)
17812 (if (file-directory-p f)
17813 (directory-files
17814 f t org-agenda-file-regexp)
17815 (list f)))
17816 files)))
17817 (when org-agenda-skip-unavailable-files
17818 (setq files (delq nil
17819 (mapcar (function
17820 (lambda (file)
17821 (and (file-readable-p file) file)))
17822 files))))
17823 (when (or (eq archives t)
17824 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17825 (setq files (org-add-archive-files files)))
17826 files))
17828 (defun org-agenda-file-p (&optional file)
17829 "Return non-nil, if FILE is an agenda file.
17830 If FILE is omitted, use the file associated with the current
17831 buffer."
17832 (member (or file (buffer-file-name))
17833 (org-agenda-files t)))
17835 (defun org-edit-agenda-file-list ()
17836 "Edit the list of agenda files.
17837 Depending on setup, this either uses customize to edit the variable
17838 `org-agenda-files', or it visits the file that is holding the list. In the
17839 latter case, the buffer is set up in a way that saving it automatically kills
17840 the buffer and restores the previous window configuration."
17841 (interactive)
17842 (if (stringp org-agenda-files)
17843 (let ((cw (current-window-configuration)))
17844 (find-file org-agenda-files)
17845 (org-set-local 'org-window-configuration cw)
17846 (org-add-hook 'after-save-hook
17847 (lambda ()
17848 (set-window-configuration
17849 (prog1 org-window-configuration
17850 (kill-buffer (current-buffer))))
17851 (org-install-agenda-files-menu)
17852 (message "New agenda file list installed"))
17853 nil 'local)
17854 (message "%s" (substitute-command-keys
17856 (customize-variable 'org-agenda-files)))
17858 (defun org-store-new-agenda-file-list (list)
17859 "Set new value for the agenda file list and save it correctly."
17860 (if (stringp org-agenda-files)
17861 (let ((fe (org-read-agenda-file-list t)) b u)
17862 (while (setq b (find-buffer-visiting org-agenda-files))
17863 (kill-buffer b))
17864 (with-temp-file org-agenda-files
17865 (insert
17866 (mapconcat
17867 (lambda (f) ;; Keep un-expanded entries.
17868 (if (setq u (assoc f fe))
17869 (cdr u)
17870 f))
17873 (let ((org-mode-hook nil) (org-inhibit-startup t)
17874 (org-insert-mode-line-in-empty-file nil))
17875 (setq org-agenda-files list)
17876 (customize-save-variable 'org-agenda-files org-agenda-files))))
17878 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17879 "Read the list of agenda files from a file.
17880 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17881 filenames, used by `org-store-new-agenda-file-list' to write back
17882 un-expanded file names."
17883 (when (file-directory-p org-agenda-files)
17884 (error "`org-agenda-files' cannot be a single directory"))
17885 (when (stringp org-agenda-files)
17886 (with-temp-buffer
17887 (insert-file-contents org-agenda-files)
17888 (mapcar
17889 (lambda (f)
17890 (let ((e (expand-file-name (substitute-in-file-name f)
17891 org-directory)))
17892 (if pair-with-expansion
17893 (cons e f)
17894 e)))
17897 ;;;###autoload
17898 (defun org-cycle-agenda-files ()
17899 "Cycle through the files in `org-agenda-files'.
17900 If the current buffer visits an agenda file, find the next one in the list.
17901 If the current buffer does not, find the first agenda file."
17902 (interactive)
17903 (let* ((fs (org-agenda-files t))
17904 (files (append fs (list (car fs))))
17905 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17906 file)
17907 (unless files (user-error "No agenda files"))
17908 (catch 'exit
17909 (while (setq file (pop files))
17910 (if (equal (file-truename file) tcf)
17911 (when (car files)
17912 (find-file (car files))
17913 (throw 'exit t))))
17914 (find-file (car fs)))
17915 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17917 (defun org-agenda-file-to-front (&optional to-end)
17918 "Move/add the current file to the top of the agenda file list.
17919 If the file is not present in the list, it is added to the front. If it is
17920 present, it is moved there. With optional argument TO-END, add/move to the
17921 end of the list."
17922 (interactive "P")
17923 (let ((org-agenda-skip-unavailable-files nil)
17924 (file-alist (mapcar (lambda (x)
17925 (cons (file-truename x) x))
17926 (org-agenda-files t)))
17927 (ctf (file-truename
17928 (or buffer-file-name
17929 (user-error "Please save the current buffer to a file"))))
17930 x had)
17931 (setq x (assoc ctf file-alist) had x)
17933 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17934 (if to-end
17935 (setq file-alist (append (delq x file-alist) (list x)))
17936 (setq file-alist (cons x (delq x file-alist))))
17937 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17938 (org-install-agenda-files-menu)
17939 (message "File %s to %s of agenda file list"
17940 (if had "moved" "added") (if to-end "end" "front"))))
17942 (defun org-remove-file (&optional file)
17943 "Remove current file from the list of files in variable `org-agenda-files'.
17944 These are the files which are being checked for agenda entries.
17945 Optional argument FILE means use this file instead of the current."
17946 (interactive)
17947 (let* ((org-agenda-skip-unavailable-files nil)
17948 (file (or file buffer-file-name
17949 (user-error "Current buffer does not visit a file")))
17950 (true-file (file-truename file))
17951 (afile (abbreviate-file-name file))
17952 (files (delq nil (mapcar
17953 (lambda (x)
17954 (if (equal true-file
17955 (file-truename x))
17956 nil x))
17957 (org-agenda-files t)))))
17958 (if (not (= (length files) (length (org-agenda-files t))))
17959 (progn
17960 (org-store-new-agenda-file-list files)
17961 (org-install-agenda-files-menu)
17962 (message "Removed file: %s" afile))
17963 (message "File was not in list: %s (not removed)" afile))))
17965 (defun org-file-menu-entry (file)
17966 (vector file (list 'find-file file) t))
17968 (defun org-check-agenda-file (file)
17969 "Make sure FILE exists. If not, ask user what to do."
17970 (when (not (file-exists-p file))
17971 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17972 (abbreviate-file-name file))
17973 (let ((r (downcase (read-char-exclusive))))
17974 (cond
17975 ((equal r ?r)
17976 (org-remove-file file)
17977 (throw 'nextfile t))
17978 (t (error "Abort"))))))
17980 (defun org-get-agenda-file-buffer (file)
17981 "Get a buffer visiting FILE. If the buffer needs to be created, add
17982 it to the list of buffers which might be released later."
17983 (let ((buf (org-find-base-buffer-visiting file)))
17984 (if buf
17985 buf ; just return it
17986 ;; Make a new buffer and remember it
17987 (setq buf (find-file-noselect file))
17988 (if buf (push buf org-agenda-new-buffers))
17989 buf)))
17991 (defun org-release-buffers (blist)
17992 "Release all buffers in list, asking the user for confirmation when needed.
17993 When a buffer is unmodified, it is just killed. When modified, it is saved
17994 \(if the user agrees) and then killed."
17995 (let (buf file)
17996 (while (setq buf (pop blist))
17997 (setq file (buffer-file-name buf))
17998 (when (and (buffer-modified-p buf)
17999 file
18000 (y-or-n-p (format "Save file %s? " file)))
18001 (with-current-buffer buf (save-buffer)))
18002 (kill-buffer buf))))
18004 (defun org-agenda-prepare-buffers (files)
18005 "Create buffers for all agenda files, protect archived trees and comments."
18006 (interactive)
18007 (let ((pa '(:org-archived t))
18008 (pc '(:org-comment t))
18009 (pall '(:org-archived t :org-comment t))
18010 (inhibit-read-only t)
18011 (org-inhibit-startup org-agenda-inhibit-startup)
18012 (rea (concat ":" org-archive-tag ":"))
18013 file re)
18014 (setq org-tag-alist-for-agenda nil
18015 org-tag-groups-alist-for-agenda nil)
18016 (save-excursion
18017 (save-restriction
18018 (while (setq file (pop files))
18019 (catch 'nextfile
18020 (if (bufferp file)
18021 (set-buffer file)
18022 (org-check-agenda-file file)
18023 (set-buffer (org-get-agenda-file-buffer file)))
18024 (widen)
18025 (org-set-regexps-and-options-for-tags)
18026 (goto-char (point-min))
18027 (let ((case-fold-search t))
18028 (when (search-forward "#+setupfile" nil t)
18029 ;; Don't set all regexps and options systematically as
18030 ;; this is only run for setting agenda tags from setup
18031 ;; file
18032 (org-set-regexps-and-options)))
18033 (org-refresh-category-properties)
18034 (org-refresh-properties org-effort-property 'org-effort)
18035 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
18036 (setq org-todo-keywords-for-agenda
18037 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18038 (setq org-done-keywords-for-agenda
18039 (append org-done-keywords-for-agenda org-done-keywords))
18040 (setq org-todo-keyword-alist-for-agenda
18041 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18042 (setq org-drawers-for-agenda
18043 (append org-drawers-for-agenda org-drawers))
18044 (setq org-tag-alist-for-agenda
18045 (org-uniquify
18046 (append org-tag-alist-for-agenda
18047 org-tag-alist
18048 org-tag-persistent-alist)))
18049 (if org-group-tags
18050 (setq org-tag-groups-alist-for-agenda
18051 (org-uniquify-alist
18052 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18053 (org-with-silent-modifications
18054 (save-excursion
18055 (remove-text-properties (point-min) (point-max) pall)
18056 (when org-agenda-skip-archived-trees
18057 (goto-char (point-min))
18058 (while (re-search-forward rea nil t)
18059 (if (org-at-heading-p t)
18060 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18061 (goto-char (point-min))
18062 (setq re (format org-heading-keyword-regexp-format
18063 org-comment-string))
18064 (while (re-search-forward re nil t)
18065 (add-text-properties
18066 (match-beginning 0) (org-end-of-subtree t) pc))))))))
18067 (setq org-todo-keywords-for-agenda
18068 (org-uniquify org-todo-keywords-for-agenda))
18069 (setq org-todo-keyword-alist-for-agenda
18070 (org-uniquify org-todo-keyword-alist-for-agenda))))
18072 \f
18073 ;;;; CDLaTeX minor mode
18075 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18076 "Keymap for the minor `org-cdlatex-mode'.")
18078 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18079 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18080 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18081 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18082 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18084 (defvar org-cdlatex-texmathp-advice-is-done nil
18085 "Flag remembering if we have applied the advice to texmathp already.")
18087 (define-minor-mode org-cdlatex-mode
18088 "Toggle the minor `org-cdlatex-mode'.
18089 This mode supports entering LaTeX environment and math in LaTeX fragments
18090 in Org-mode.
18092 nil " OCDL" nil
18093 (when org-cdlatex-mode
18094 (require 'cdlatex)
18095 (run-hooks 'cdlatex-mode-hook)
18096 (cdlatex-compute-tables))
18097 (unless org-cdlatex-texmathp-advice-is-done
18098 (setq org-cdlatex-texmathp-advice-is-done t)
18099 (defadvice texmathp (around org-math-always-on activate)
18100 "Always return t in org-mode buffers.
18101 This is because we want to insert math symbols without dollars even outside
18102 the LaTeX math segments. If Orgmode thinks that point is actually inside
18103 an embedded LaTeX fragment, let texmathp do its job.
18105 (interactive)
18106 (let (p)
18107 (cond
18108 ((not (derived-mode-p 'org-mode)) ad-do-it)
18109 ((eq this-command 'cdlatex-math-symbol)
18110 (setq ad-return-value t
18111 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18112 (t
18113 (let ((p (org-inside-LaTeX-fragment-p)))
18114 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18115 (setq ad-return-value t
18116 texmathp-why '("Org-mode embedded math" . 0))
18117 (if p ad-do-it)))))))))
18119 (defun turn-on-org-cdlatex ()
18120 "Unconditionally turn on `org-cdlatex-mode'."
18121 (org-cdlatex-mode 1))
18123 (defun org-try-cdlatex-tab ()
18124 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18125 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18126 - inside a LaTeX fragment, or
18127 - after the first word in a line, where an abbreviation expansion could
18128 insert a LaTeX environment."
18129 (when org-cdlatex-mode
18130 (cond
18131 ;; Before any word on the line: No expansion possible.
18133 ;; Just after first word on the line: Expand it. Make sure it
18134 ;; cannot happen on headlines, though.
18135 ((save-excursion
18136 (skip-chars-backward "a-zA-Z0-9*")
18138 (and (bolp) (not (org-at-heading-p))))
18139 (cdlatex-tab) t)
18140 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18142 (defun org-cdlatex-underscore-caret (&optional arg)
18143 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18144 Revert to the normal definition outside of these fragments."
18145 (interactive "P")
18146 (if (org-inside-LaTeX-fragment-p)
18147 (call-interactively 'cdlatex-sub-superscript)
18148 (let (org-cdlatex-mode)
18149 (call-interactively (key-binding (vector last-input-event))))))
18151 (defun org-cdlatex-math-modify (&optional arg)
18152 "Execute `cdlatex-math-modify' in LaTeX fragments.
18153 Revert to the normal definition outside of these fragments."
18154 (interactive "P")
18155 (if (org-inside-LaTeX-fragment-p)
18156 (call-interactively 'cdlatex-math-modify)
18157 (let (org-cdlatex-mode)
18158 (call-interactively (key-binding (vector last-input-event))))))
18161 \f
18162 ;;;; LaTeX fragments
18164 (defvar org-latex-regexps
18166 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18169 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18173 "Regular expressions for matching embedded LaTeX.")
18175 (defun org-inside-LaTeX-fragment-p ()
18176 "Test if point is inside a LaTeX fragment.
18178 sequence appearing also before point.
18179 Even though the matchers for math are configurable, this function assumes
18181 delimiters are skipped when they have been removed by customization.
18182 The return value is nil, or a cons cell with the delimiter and the
18183 position of this delimiter.
18185 This function does a reasonably good job, but can locally be fooled by
18186 for example currency specifications. For example it will assume being in
18188 fragments that are properly closed, but during editing, we have to live
18189 with the uncertainty caused by missing closing delimiters. This function
18190 looks only before point, not after."
18191 (catch 'exit
18192 (let ((pos (point))
18193 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18194 (lim (progn
18196 (point)))
18197 dd-on str (start 0) m re)
18198 (goto-char pos)
18199 (when dodollar
18201 re (nth 1 (assoc "$" org-latex-regexps)))
18202 (while (string-match re str start)
18203 (cond
18204 ((= (match-end 0) (length str))
18205 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18206 ((= (match-end 0) (- (length str) 5))
18207 (throw 'exit nil))
18208 (t (setq start (match-end 0))))))
18209 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18210 (goto-char pos)
18211 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18212 (and (match-beginning 2) (throw 'exit nil))
18213 ;; count $$
18215 (setq dd-on (not dd-on)))
18216 (goto-char pos)
18217 (if dd-on (cons "$$" m))))))
18219 (defun org-inside-latex-macro-p ()
18220 "Is point inside a LaTeX macro or its arguments?"
18221 (save-match-data
18222 (org-in-regexp
18225 (defvar org-latex-fragment-image-overlays nil
18226 "List of overlays carrying the images of latex fragments.")
18227 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18229 (defun org-remove-latex-fragment-image-overlays ()
18230 "Remove all overlays with LaTeX fragment images in current buffer."
18231 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18232 (setq org-latex-fragment-image-overlays nil))
18234 (defun org-preview-latex-fragment (&optional subtree)
18235 "Preview the LaTeX fragment at point, or all locally or globally.
18236 If the cursor is in a LaTeX fragment, create the image and overlay
18237 it over the source code. If there is no fragment at point, display
18238 all fragments in the current text, from one headline to the next. With
18239 prefix SUBTREE, display all fragments in the current subtree. With a
18241 the cursor is before the first headline,
18242 display all fragments in the buffer.
18244 (interactive "P")
18245 (unless buffer-file-name
18246 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18247 (when (display-graphic-p)
18248 (org-remove-latex-fragment-image-overlays)
18249 (save-excursion
18250 (save-restriction
18251 (let (beg end at msg)
18252 (cond
18253 ((or (equal subtree '(16))
18254 (not (save-excursion
18255 (re-search-backward org-outline-regexp-bol nil t))))
18256 (setq beg (point-min) end (point-max)
18257 msg "Creating images for buffer...%s"))
18258 ((equal subtree '(4))
18259 (org-back-to-heading)
18260 (setq beg (point) end (org-end-of-subtree t)
18261 msg "Creating images for subtree...%s"))
18262 (t
18263 (if (setq at (org-inside-LaTeX-fragment-p))
18264 (goto-char (max (point-min) (- (cdr at) 2)))
18265 (org-back-to-heading))
18266 (setq beg (point) end (progn (outline-next-heading) (point))
18267 msg (if at "Creating image...%s"
18268 "Creating images for entry...%s"))))
18269 (message msg "")
18270 (narrow-to-region beg end)
18271 (goto-char beg)
18272 (org-format-latex
18273 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18274 (file-name-nondirectory
18275 buffer-file-name)))
18276 default-directory 'overlays msg at 'forbuffer
18277 org-latex-create-formula-image-program)
18278 (message msg "done. Use `C-c C-c' to remove images."))))))
18280 (defun org-format-latex (prefix &optional dir overlays msg at
18281 forbuffer processing-type)
18282 "Replace LaTeX fragments with links to an image, and produce images.
18283 Some of the options can be changed using the variable
18284 `org-format-latex-options'."
18285 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18286 (let* ((prefixnodir (file-name-nondirectory prefix))
18287 (absprefix (expand-file-name prefix dir))
18288 (todir (file-name-directory absprefix))
18289 (opt org-format-latex-options)
18290 (optnew org-format-latex-options)
18291 (matchers (plist-get opt :matchers))
18292 (re-list org-latex-regexps)
18293 (cnt 0) txt hash link beg end re e checkdir
18294 string
18295 m n block-type block linkfile movefile ov)
18296 ;; Check the different regular expressions
18297 (while (setq e (pop re-list))
18298 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18300 (when (member m matchers)
18301 (goto-char (point-min))
18302 (while (re-search-forward re nil t)
18303 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18304 (or (not overlays)
18305 (not (eq (get-char-property (match-beginning n)
18306 'org-overlay-type)
18307 'org-latex-overlay))))
18308 (cond
18309 ((eq processing-type 'verbatim))
18310 ((eq processing-type 'mathjax)
18311 ;; Prepare for MathJax processing.
18312 (setq string (match-string n))
18313 (when (member m '("$" "$1"))
18314 (save-excursion
18315 (delete-region (match-beginning n) (match-end n))
18316 (goto-char (match-beginning n))
18318 ((or (eq processing-type 'dvipng)
18319 (eq processing-type 'imagemagick))
18320 ;; Process to an image.
18321 (setq txt (match-string n)
18322 beg (match-beginning n) end (match-end n)
18323 cnt (1+ cnt))
18324 (let ((face (face-at-point))
18325 (fg (plist-get opt :foreground))
18326 (bg (plist-get opt :background))
18327 ;; Ensure full list is printed.
18328 print-length print-level)
18329 (when forbuffer
18330 ;; Get the colors from the face at point.
18331 (goto-char beg)
18332 (when (eq fg 'auto)
18333 (setq fg (face-attribute face :foreground nil 'default)))
18334 (when (eq bg 'auto)
18335 (setq bg (face-attribute face :background nil 'default)))
18336 (setq optnew (copy-sequence opt))
18337 (plist-put optnew :foreground fg)
18338 (plist-put optnew :background bg))
18339 (setq hash (sha1 (prin1-to-string
18340 (list org-format-latex-header
18341 org-latex-default-packages-alist
18342 org-latex-packages-alist
18343 org-format-latex-options
18344 forbuffer txt fg bg)))
18345 linkfile (format "%s_%s.png" prefix hash)
18346 movefile (format "%s_%s.png" absprefix hash)))
18347 (setq link (concat block "[[file:" linkfile "]]" block))
18348 (if msg (message msg cnt))
18349 (goto-char beg)
18350 (unless checkdir ; Ensure the directory exists.
18351 (setq checkdir t)
18352 (or (file-directory-p todir) (make-directory todir t)))
18353 (unless (file-exists-p movefile)
18354 (org-create-formula-image
18355 txt movefile optnew forbuffer processing-type))
18356 (if overlays
18357 (progn
18358 (mapc (lambda (o)
18359 (if (eq (overlay-get o 'org-overlay-type)
18360 'org-latex-overlay)
18361 (delete-overlay o)))
18362 (overlays-in beg end))
18363 (setq ov (make-overlay beg end))
18364 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18365 (if (featurep 'xemacs)
18366 (progn
18367 (overlay-put ov 'invisible t)
18368 (overlay-put
18369 ov 'end-glyph
18370 (make-glyph (vector 'png :file movefile))))
18371 (overlay-put
18372 ov 'display
18373 (list 'image :type 'png :file movefile :ascent 'center)))
18374 (push ov org-latex-fragment-image-overlays)
18375 (goto-char end))
18376 (delete-region beg end)
18377 (insert (org-add-props link
18378 (list 'org-latex-src
18379 (replace-regexp-in-string
18381 'org-latex-src-embed-type
18382 (if block-type 'paragraph 'character))))))
18383 ((eq processing-type 'mathml)
18384 ;; Process to MathML
18385 (unless (save-match-data (org-format-latex-mathml-available-p))
18386 (user-error "LaTeX to MathML converter not configured"))
18387 (setq txt (match-string n)
18388 beg (match-beginning n) end (match-end n)
18389 cnt (1+ cnt))
18390 (if msg (message msg cnt))
18391 (goto-char beg)
18392 (delete-region beg end)
18393 (insert (org-format-latex-as-mathml
18394 txt block-type prefix dir)))
18395 (t
18396 (error "Unknown conversion type %s for LaTeX fragments"
18397 processing-type)))))))))
18399 (defun org-create-math-formula (latex-frag &optional mathml-file)
18400 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18401 Use `org-latex-to-mathml-convert-command'. If the conversion is
18403 elements otherwise return nil. When MATHML-FILE is specified,
18404 write the results in to that file. When invoked as an
18405 interactive command, prompt for LATEX-FRAG, with initial value
18406 set to the current active region and echo the results for user
18407 inspection."
18408 (interactive (list (let ((frag (when (org-region-active-p)
18409 (buffer-substring-no-properties
18410 (region-beginning) (region-end)))))
18411 (read-string "LaTeX Fragment: " frag nil frag))))
18412 (unless latex-frag (error "Invalid LaTeX fragment"))
18413 (let* ((tmp-in-file (file-relative-name
18414 (make-temp-name (expand-file-name "ltxmathml-in"))))
18415 (ignore (write-region latex-frag nil tmp-in-file))
18416 (tmp-out-file (file-relative-name
18417 (make-temp-name (expand-file-name "ltxmathml-out"))))
18418 (cmd (format-spec
18419 org-latex-to-mathml-convert-command
18420 `((?j . ,(shell-quote-argument
18421 (expand-file-name org-latex-to-mathml-jar-file)))
18422 (?I . ,(shell-quote-argument tmp-in-file))
18423 (?o . ,(shell-quote-argument tmp-out-file)))))
18424 mathml shell-command-output)
18425 (when (org-called-interactively-p 'any)
18426 (unless (org-format-latex-mathml-available-p)
18427 (user-error "LaTeX to MathML converter not configured")))
18428 (message "Running %s" cmd)
18429 (setq shell-command-output (shell-command-to-string cmd))
18430 (setq mathml
18431 (when (file-readable-p tmp-out-file)
18432 (with-current-buffer (find-file-noselect tmp-out-file t)
18433 (goto-char (point-min))
18434 (when (re-search-forward
18435 (concat
18436 (regexp-quote
18439 (regexp-quote "</math>")) nil t)
18440 (prog1 (match-string 0) (kill-buffer))))))
18441 (cond
18442 (mathml
18443 (setq mathml
18445 (when mathml-file
18446 (write-region mathml nil mathml-file))
18447 (when (org-called-interactively-p 'any)
18448 (message mathml)))
18449 ((message "LaTeX to MathML conversion failed")
18450 (message shell-command-output)))
18451 (delete-file tmp-in-file)
18452 (when (file-exists-p tmp-out-file)
18453 (delete-file tmp-out-file))
18454 mathml))
18456 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18457 prefix &optional dir)
18458 "Use `org-create-math-formula' but check local cache first."
18459 (let* ((absprefix (expand-file-name prefix dir))
18460 (print-length nil) (print-level nil)
18461 (formula-id (concat
18462 "formula-"
18463 (sha1
18464 (prin1-to-string
18465 (list latex-frag
18466 org-latex-to-mathml-convert-command)))))
18467 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18468 (formula-cache-dir (file-name-directory formula-cache)))
18470 (unless (file-directory-p formula-cache-dir)
18471 (make-directory formula-cache-dir t))
18473 (unless (file-exists-p formula-cache)
18474 (org-create-math-formula latex-frag formula-cache))
18476 (if (file-exists-p formula-cache)
18477 ;; Successful conversion. Return the link to MathML file.
18478 (org-add-props
18479 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18481 'org-latex-src-embed-type (if latex-frag-type
18482 'paragraph 'character)))
18483 ;; Failed conversion. Return the LaTeX fragment verbatim
18484 latex-frag)))
18486 (defun org-create-formula-image (string tofile options buffer &optional type)
18487 "Create an image from LaTeX source using dvipng or convert.
18488 This function calls either `org-create-formula-image-with-dvipng'
18489 or `org-create-formula-image-with-imagemagick' depending on the
18490 value of `org-latex-create-formula-image-program' or on the value
18491 of the optional TYPE variable.
18493 Note: ultimately these two function should be combined as they
18494 share a good deal of logic."
18495 (org-check-external-command
18496 "latex" "needed to convert LaTeX fragments to images")
18497 (funcall
18498 (case (or type org-latex-create-formula-image-program)
18499 ('dvipng
18500 (org-check-external-command
18501 "dvipng" "needed to convert LaTeX fragments to images")
18502 #'org-create-formula-image-with-dvipng)
18503 ('imagemagick
18504 (org-check-external-command
18505 "convert" "you need to install imagemagick")
18506 #'org-create-formula-image-with-imagemagick)
18507 (t (error
18508 "Invalid value of `org-latex-create-formula-image-program'")))
18509 string tofile options buffer))
18511 (declare-function org-export-get-backend "ox" (name))
18512 (declare-function org-export--get-global-options "ox" (&optional backend))
18513 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18514 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18515 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18516 (defun org-create-formula--latex-header ()
18517 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18518 (let ((info (org-combine-plists (org-export--get-global-options
18519 (org-export-get-backend 'latex))
18520 (org-export--get-inbuffer-options
18521 (org-export-get-backend 'latex)))))
18522 (org-latex-guess-babel-language
18523 (org-latex-guess-inputenc
18524 (org-splice-latex-header
18525 org-format-latex-header
18526 org-latex-default-packages-alist
18527 org-latex-packages-alist t
18528 (plist-get info :latex-header)))
18529 info)))
18531 ;; This function borrows from Ganesh Swami's latex2png.el
18532 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18533 "This calls dvipng."
18534 (require 'ox-latex)
18535 (let* ((tmpdir (if (featurep 'xemacs)
18536 (temp-directory)
18537 temporary-file-directory))
18538 (texfilebase (make-temp-name
18539 (expand-file-name "orgtex" tmpdir)))
18540 (texfile (concat texfilebase ".tex"))
18541 (dvifile (concat texfilebase ".dvi"))
18542 (pngfile (concat texfilebase ".png"))
18543 (fnh (if (featurep 'xemacs)
18544 (font-height (face-font 'default))
18545 (face-attribute 'default :height nil)))
18546 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18547 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18548 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18549 "Black"))
18550 (bg (or (plist-get options (if buffer :background :html-background))
18551 "Transparent")))
18552 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18553 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18554 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18555 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18556 (let ((latex-header (org-create-formula--latex-header)))
18557 (with-temp-file texfile
18558 (insert latex-header)
18560 (let ((dir default-directory))
18561 (condition-case nil
18562 (progn
18563 (cd tmpdir)
18564 (call-process "latex" nil nil nil texfile))
18565 (error nil))
18566 (cd dir))
18567 (if (not (file-exists-p dvifile))
18568 (progn (message "Failed to create dvi file from %s" texfile) nil)
18569 (condition-case nil
18570 (if (featurep 'xemacs)
18571 (call-process "dvipng" nil nil nil
18572 "-fg" fg "-bg" bg
18573 "-T" "tight"
18574 "-o" pngfile
18575 dvifile)
18576 (call-process "dvipng" nil nil nil
18577 "-fg" fg "-bg" bg
18578 "-D" dpi
18579 ;;"-x" scale "-y" scale
18580 "-T" "tight"
18581 "-o" pngfile
18582 dvifile))
18583 (error nil))
18584 (if (not (file-exists-p pngfile))
18585 (if org-format-latex-signal-error
18586 (error "Failed to create png file from %s" texfile)
18587 (message "Failed to create png file from %s" texfile)
18588 nil)
18589 ;; Use the requested file name and clean up
18590 (copy-file pngfile tofile 'replace)
18591 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18592 (if (file-exists-p (concat texfilebase e))
18593 (delete-file (concat texfilebase e))))
18594 pngfile))))
18596 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18597 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18598 "This calls convert, which is included into imagemagick."
18599 (require 'ox-latex)
18600 (let* ((tmpdir (if (featurep 'xemacs)
18601 (temp-directory)
18602 temporary-file-directory))
18603 (texfilebase (make-temp-name
18604 (expand-file-name "orgtex" tmpdir)))
18605 (texfile (concat texfilebase ".tex"))
18606 (pdffile (concat texfilebase ".pdf"))
18607 (pngfile (concat texfilebase ".png"))
18608 (fnh (if (featurep 'xemacs)
18609 (font-height (face-font 'default))
18610 (face-attribute 'default :height nil)))
18611 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18612 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18613 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18614 "black"))
18615 (bg (or (plist-get options (if buffer :background :html-background))
18616 "white")))
18617 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18618 (setq fg (org-latex-color-format fg)))
18619 (if (eq bg 'default) (setq bg (org-latex-color :background))
18620 (setq bg (org-latex-color-format
18621 (if (string= bg "Transparent") "white" bg))))
18622 (let ((latex-header (org-create-formula--latex-header)))
18623 (with-temp-file texfile
18624 (insert latex-header)
18630 string
18633 (org-latex-compile texfile t)
18634 (if (not (file-exists-p pdffile))
18635 (progn (message "Failed to create pdf file from %s" texfile) nil)
18636 (condition-case nil
18637 (if (featurep 'xemacs)
18638 (call-process "convert" nil nil nil
18639 "-density" "96"
18640 "-trim"
18641 "-antialias"
18642 pdffile
18643 "-quality" "100"
18644 ;; "-sharpen" "0x1.0"
18645 pngfile)
18646 (call-process "convert" nil nil nil
18647 "-density" dpi
18648 "-trim"
18649 "-antialias"
18650 pdffile
18651 "-quality" "100"
18652 ;; "-sharpen" "0x1.0"
18653 pngfile))
18654 (error nil))
18655 (if (not (file-exists-p pngfile))
18656 (if org-format-latex-signal-error
18657 (error "Failed to create png file from %s" texfile)
18658 (message "Failed to create png file from %s" texfile)
18659 nil)
18660 ;; Use the requested file name and clean up
18661 (copy-file pngfile tofile 'replace)
18662 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18663 (if (file-exists-p (concat texfilebase e))
18664 (delete-file (concat texfilebase e))))
18665 pngfile))))
18667 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18668 "Fill a LaTeX header template TPL.
18669 In the template, the following place holders will be recognized:
18672 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18674 [NO-PACKAGES] do not include PKG
18675 [EXTRA] the string EXTRA
18676 [NO-EXTRA] do not include EXTRA
18678 For backward compatibility, if both the positive and the negative place
18680 assumed to be present at the end of the template.
18681 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18682 EXTRA is a string.
18683 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18684 (let (rpl (end ""))
18686 (setq rpl (if (or (match-end 1) (not def-pkg))
18687 "" (org-latex-packages-to-string def-pkg snippets-p t))
18688 tpl (replace-match rpl t t tpl))
18689 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18692 (setq rpl (if (or (match-end 1) (not pkg))
18693 "" (org-latex-packages-to-string pkg snippets-p t))
18694 tpl (replace-match rpl t t tpl))
18695 (if pkg (setq end
18697 (org-latex-packages-to-string pkg snippets-p)))))
18700 (setq rpl (if (or (match-end 1) (not extra))
18702 tpl (replace-match rpl t t tpl))
18708 tpl)))
18710 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18712 (setq pkg (mapconcat (lambda(p)
18713 (cond
18714 ((stringp p) p)
18715 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18716 (format "%% Package %s omitted" (cadr p)))
18717 ((equal "" (car p))
18719 (t
18721 (car p) (cadr p)))))
18722 pkg
18726 (defun org-dvipng-color (attr)
18727 "Return a RGB color specification for dvipng."
18728 (apply 'format "rgb %s %s %s"
18729 (mapcar 'org-normalize-color
18730 (if (featurep 'xemacs)
18731 (color-rgb-components
18732 (face-property 'default
18733 (cond ((eq attr :foreground) 'foreground)
18734 ((eq attr :background) 'background))))
18735 (color-values (face-attribute 'default attr nil))))))
18737 (defun org-dvipng-color-format (color-name)
18738 "Convert COLOR-NAME to a RGB color value for dvipng."
18739 (apply 'format "rgb %s %s %s"
18740 (mapcar 'org-normalize-color
18741 (color-values color-name))))
18743 (defun org-latex-color (attr)
18744 "Return a RGB color for the LaTeX color package."
18745 (apply 'format "%s,%s,%s"
18746 (mapcar 'org-normalize-color
18747 (if (featurep 'xemacs)
18748 (color-rgb-components
18749 (face-property 'default
18750 (cond ((eq attr :foreground) 'foreground)
18751 ((eq attr :background) 'background))))
18752 (color-values (face-attribute 'default attr nil))))))
18754 (defun org-latex-color-format (color-name)
18755 "Convert COLOR-NAME to a RGB color value."
18756 (apply 'format "%s,%s,%s"
18757 (mapcar 'org-normalize-color
18758 (color-values color-name))))
18760 (defun org-normalize-color (value)
18761 "Return string to be used as color value for an RGB component."
18762 (format "%g" (/ value 65535.0)))
18765 \f
18766 ;; Image display
18768 (defvar org-inline-image-overlays nil)
18769 (make-variable-buffer-local 'org-inline-image-overlays)
18771 (defun org-toggle-inline-images (&optional include-linked)
18772 "Toggle the display of inline images.
18773 INCLUDE-LINKED is passed to `org-display-inline-images'."
18774 (interactive "P")
18775 (if org-inline-image-overlays
18776 (progn
18777 (org-remove-inline-images)
18778 (message "Inline image display turned off"))
18779 (org-display-inline-images include-linked)
18780 (if (and (org-called-interactively-p)
18781 org-inline-image-overlays)
18782 (message "%d images displayed inline"
18783 (length org-inline-image-overlays))
18784 (message "No images to display inline"))))
18786 (defun org-redisplay-inline-images ()
18787 "Refresh the display of inline images."
18788 (interactive)
18789 (if (not org-inline-image-overlays)
18790 (org-toggle-inline-images)
18791 (org-toggle-inline-images)
18792 (org-toggle-inline-images)))
18794 (defun org-display-inline-images (&optional include-linked refresh beg end)
18795 "Display inline images.
18796 Normally only links without a description part are inlined, because this
18797 is how it will work for export. When INCLUDE-LINKED is set, also links
18798 with a description part will be inlined. This can be nice for a quick
18799 look at those images, but it does not reflect what exported files will look
18800 like.
18801 When REFRESH is set, refresh existing images between BEG and END.
18802 This will create new image displays only if necessary.
18803 BEG and END default to the buffer boundaries."
18804 (interactive "P")
18805 (when (display-graphic-p)
18806 (unless refresh
18807 (org-remove-inline-images)
18808 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18809 (save-excursion
18810 (save-restriction
18811 (widen)
18812 (setq beg (or beg (point-min)) end (or end (point-max)))
18813 (goto-char beg)
18815 (substring (org-image-file-name-regexp) 0 -2)
18817 (case-fold-search t)
18818 old file ov img type attrwidth width)
18819 (while (re-search-forward re end t)
18820 (setq old (get-char-property-and-overlay (match-beginning 1)
18821 'org-image-overlay)
18822 file (expand-file-name
18823 (concat (or (match-string 3) "") (match-string 4))))
18824 (when (image-type-available-p 'imagemagick)
18825 (setq attrwidth (if (or (listp org-image-actual-width)
18826 (null org-image-actual-width))
18827 (save-excursion
18828 (save-match-data
18829 (when (re-search-backward
18831 (save-excursion
18833 (string-to-number (match-string 1))))))
18834 width (cond ((eq org-image-actual-width t) nil)
18835 ((null org-image-actual-width) attrwidth)
18836 ((numberp org-image-actual-width)
18837 org-image-actual-width)
18838 ((listp org-image-actual-width)
18839 (or attrwidth (car org-image-actual-width))))
18840 type (if width 'imagemagick)))
18841 (when (file-exists-p file)
18842 (if (and (car-safe old) refresh)
18843 (image-refresh (overlay-get (cdr old) 'display))
18844 (setq img (save-match-data (create-image file type nil :width width)))
18845 (when img
18846 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18847 (overlay-put ov 'display img)
18848 (overlay-put ov 'face 'default)
18849 (overlay-put ov 'org-image-overlay t)
18850 (overlay-put ov 'modification-hooks
18851 (list 'org-display-inline-remove-overlay))
18852 (push ov org-inline-image-overlays))))))))))
18854 (define-obsolete-function-alias
18855 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18857 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18858 "Remove inline-display overlay if a corresponding region is modified."
18859 (let ((inhibit-modification-hooks t))
18860 (when (and ov after)
18861 (delete ov org-inline-image-overlays)
18862 (delete-overlay ov))))
18864 (defun org-remove-inline-images ()
18865 "Remove inline display of images."
18866 (interactive)
18867 (mapc 'delete-overlay org-inline-image-overlays)
18868 (setq org-inline-image-overlays nil))
18870 ;;;; Key bindings
18872 ;; Outline functions from `outline-mode-prefix-map'
18873 ;; that can be remapped in Org:
18874 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18875 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18876 (define-key org-mode-map [remap outline-forward-same-level]
18877 'org-forward-heading-same-level)
18878 (define-key org-mode-map [remap outline-backward-same-level]
18879 'org-backward-heading-same-level)
18880 (define-key org-mode-map [remap show-branches]
18881 'org-kill-note-or-show-branches)
18882 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18883 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18884 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18886 ;; Outline functions from `outline-mode-prefix-map' that can not
18887 ;; be remapped in Org:
18888 ;;
18889 ;; - the column "key binding" shows whether the Outline function is still
18890 ;; available in Org mode on the same key that it has been bound to in
18891 ;; Outline mode:
18892 ;; - "overridden": key used for a different functionality in Org mode
18893 ;; - else: key still bound to the same Outline function in Org mode
18894 ;;
18895 ;; | Outline function | key binding | Org replacement |
18896 ;; |------------------------------------+-------------+-----------------------|
18897 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18898 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18899 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18900 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18901 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18902 ;; | `show-entry' | overridden | no replacement |
18903 ;; | `show-children' | `C-c C-i' | visibility cycling |
18904 ;; | `show-branches' | `C-c C-k' | still same function |
18905 ;; | `show-subtree' | overridden | visibility cycling |
18906 ;; | `show-all' | overridden | no replacement |
18907 ;; | `hide-subtree' | overridden | visibility cycling |
18908 ;; | `hide-body' | overridden | no replacement |
18909 ;; | `hide-entry' | overridden | visibility cycling |
18910 ;; | `hide-leaves' | overridden | no replacement |
18911 ;; | `hide-sublevels' | overridden | no replacement |
18912 ;; | `hide-other' | overridden | no replacement |
18914 ;; Make `C-c C-x' a prefix key
18915 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18917 ;; TAB key with modifiers
18918 (org-defkey org-mode-map "\C-i" 'org-cycle)
18919 (org-defkey org-mode-map [(tab)] 'org-cycle)
18920 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18922 ;; The following line is necessary under Suse GNU/Linux
18923 (unless (featurep 'xemacs)
18924 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18925 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18926 (define-key org-mode-map [backtab] 'org-shifttab)
18928 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18929 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18930 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18932 ;; Cursor keys with modifiers
18933 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18934 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18935 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18936 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18938 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18939 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18940 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18941 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18943 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18944 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18945 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18946 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18948 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18949 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18950 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18951 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18953 ;; Babel keys
18954 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18955 (mapc (lambda (pair)
18956 (define-key org-babel-map (car pair) (cdr pair)))
18957 org-babel-key-bindings)
18959 ;;; Extra keys for tty access.
18960 ;; We only set them when really needed because otherwise the
18961 ;; menus don't show the simple keys
18963 (when (or org-use-extra-keys
18964 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18965 (not window-system))
18966 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18967 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18968 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18969 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18970 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18971 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18972 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18973 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18974 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18975 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18976 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18977 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18978 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18979 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18980 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18981 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18982 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18983 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18984 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18985 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18986 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18987 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18988 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18989 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18990 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18991 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18992 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18993 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18995 ;; All the other keys
18997 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18998 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18999 (if (boundp 'narrow-map)
19000 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19001 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19002 (if (boundp 'narrow-map)
19003 (org-defkey narrow-map "b" 'org-narrow-to-block)
19004 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19005 (if (boundp 'narrow-map)
19006 (org-defkey narrow-map "e" 'org-narrow-to-element)
19007 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19008 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19009 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19010 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19011 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19012 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19013 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19014 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19015 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19016 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19017 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19018 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19019 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19020 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19021 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19022 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19023 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19024 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19025 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19026 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19027 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19028 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19029 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19030 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19031 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19032 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19033 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19035 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19036 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19037 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19038 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19039 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19040 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19041 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19042 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19043 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19044 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19045 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19046 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19047 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19048 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19049 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19050 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19051 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19052 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19053 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19054 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19055 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19057 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19058 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19059 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19060 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19061 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19062 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19063 (org-defkey org-mode-map "\C-c^" 'org-sort)
19064 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19065 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19066 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19067 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19068 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-element)
19069 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-element)
19070 (org-defkey org-mode-map "\C-m" 'org-return)
19071 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19072 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19073 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19074 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19075 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19076 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19077 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19078 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19079 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19080 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19081 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19082 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19083 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19084 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19085 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19086 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19087 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19088 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19089 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19090 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19091 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19092 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19093 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19095 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19096 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19097 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19099 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19100 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19101 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19102 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19103 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19104 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19105 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19106 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19107 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19108 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19109 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19110 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19111 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19113 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19114 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19115 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19116 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19117 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19118 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19119 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19120 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19121 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19123 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19124 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19125 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19126 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19127 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19129 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19131 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19133 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19134 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19136 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19139 (when (featurep 'xemacs)
19140 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19143 (defconst org-speed-commands-default
19144 '(
19145 ("Outline Navigation")
19146 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19147 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19148 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19149 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19150 ("F" . org-next-block)
19151 ("B" . org-previous-block)
19152 ("u" . (org-speed-move-safe 'outline-up-heading))
19153 ("j" . org-goto)
19154 ("g" . (org-refile t))
19155 ("Outline Visibility")
19156 ("c" . org-cycle)
19157 ("C" . org-shifttab)
19158 (" " . org-display-outline-path)
19159 ("s" . org-narrow-to-subtree)
19160 ("=" . org-columns)
19161 ("Outline Structure Editing")
19162 ("U" . org-shiftmetaup)
19163 ("D" . org-shiftmetadown)
19164 ("r" . org-metaright)
19165 ("l" . org-metaleft)
19166 ("R" . org-shiftmetaright)
19167 ("L" . org-shiftmetaleft)
19168 ("i" . (progn (forward-char 1) (call-interactively
19169 'org-insert-heading-respect-content)))
19170 ("^" . org-sort)
19171 ("w" . org-refile)
19172 ("a" . org-archive-subtree-default-with-confirmation)
19173 ("@" . org-mark-subtree)
19174 ("#" . org-toggle-comment)
19175 ("Clock Commands")
19176 ("I" . org-clock-in)
19177 ("O" . org-clock-out)
19178 ("Meta Data Editing")
19179 ("t" . org-todo)
19180 ("," . (org-priority))
19181 ("0" . (org-priority ?\ ))
19182 ("1" . (org-priority ?A))
19183 ("2" . (org-priority ?B))
19184 ("3" . (org-priority ?C))
19185 (":" . org-set-tags-command)
19186 ("e" . org-set-effort)
19187 ("E" . org-inc-effort)
19188 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19189 (org-entry-put (point) "APPT_WARNTIME" m)))
19190 ("Agenda Views etc")
19191 ("v" . org-agenda)
19192 ("/" . org-sparse-tree)
19193 ("Misc")
19194 ("o" . org-open-at-point)
19195 ("?" . org-speed-command-help)
19196 ("<" . (org-agenda-set-restriction-lock 'subtree))
19197 (">" . (org-agenda-remove-restriction-lock))
19198 )
19199 "The default speed commands.")
19201 (defun org-print-speed-command (e)
19202 (if (> (length (car e)) 1)
19203 (progn
19205 (princ (car e))
19207 (princ (make-string (length (car e)) ?-))
19209 (princ (car e))
19210 (princ " ")
19211 (if (symbolp (cdr e))
19212 (princ (symbol-name (cdr e)))
19213 (prin1 (cdr e)))
19216 (defun org-speed-command-help ()
19217 "Show the available speed commands."
19218 (interactive)
19219 (if (not org-use-speed-commands)
19220 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19221 (with-output-to-temp-buffer "*Help*"
19223 (mapc 'org-print-speed-command org-speed-commands-user)
19226 (mapc 'org-print-speed-command org-speed-commands-default))
19227 (with-current-buffer "*Help*"
19228 (setq truncate-lines t))))
19230 (defun org-speed-move-safe (cmd)
19231 "Execute CMD, but make sure that the cursor always ends up in a headline.
19232 If not, return to the original position and throw an error."
19233 (interactive)
19234 (let ((pos (point)))
19235 (call-interactively cmd)
19236 (unless (and (bolp) (org-at-heading-p))
19237 (goto-char pos)
19238 (error "Boundary reached while executing %s" cmd))))
19240 (defvar org-self-insert-command-undo-counter 0)
19242 (defvar org-table-auto-blank-field) ; defined in org-table.el
19243 (defvar org-speed-command nil)
19245 (define-obsolete-function-alias
19246 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19248 (defun org-speed-command-activate (keys)
19249 "Hook for activating single-letter speed commands.
19250 `org-speed-commands-default' specifies a minimal command set.
19251 Use `org-speed-commands-user' for further customization."
19252 (when (or (and (bolp) (looking-at org-outline-regexp))
19253 (and (functionp org-use-speed-commands)
19254 (funcall org-use-speed-commands)))
19255 (cdr (assoc keys (append org-speed-commands-user
19256 org-speed-commands-default)))))
19258 (define-obsolete-function-alias
19259 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19261 (defun org-babel-speed-command-activate (keys)
19262 "Hook for activating single-letter code block commands."
19263 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19264 (cdr (assoc keys org-babel-key-bindings))))
19266 (defcustom org-speed-command-hook
19267 '(org-speed-command-default-hook org-babel-speed-command-hook)
19268 "Hook for activating speed commands at strategic locations.
19269 Hook functions are called in sequence until a valid handler is
19270 found.
19272 Each hook takes a single argument, a user-pressed command key
19273 which is also a `self-insert-command' from the global map.
19275 Within the hook, examine the cursor position and the command key
19276 and return nil or a valid handler as appropriate. Handler could
19277 be one of an interactive command, a function, or a form.
19279 Set `org-use-speed-commands' to non-nil value to enable this
19280 hook. The default setting is `org-speed-command-activate'."
19281 :group 'org-structure
19282 :version "24.1"
19283 :type 'hook)
19285 (defun org-self-insert-command (N)
19286 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19287 If the cursor is in a table looking at whitespace, the whitespace is
19288 overwritten, and the table is not marked as requiring realignment."
19289 (interactive "p")
19290 (org-check-before-invisible-edit 'insert)
19291 (cond
19292 ((and org-use-speed-commands
19293 (setq org-speed-command
19294 (run-hook-with-args-until-success
19295 'org-speed-command-hook (this-command-keys))))
19296 (cond
19297 ((commandp org-speed-command)
19298 (setq this-command org-speed-command)
19299 (call-interactively org-speed-command))
19300 ((functionp org-speed-command)
19301 (funcall org-speed-command))
19302 ((and org-speed-command (listp org-speed-command))
19303 (eval org-speed-command))
19304 (t (let (org-use-speed-commands)
19305 (call-interactively 'org-self-insert-command)))))
19306 ((and
19307 (org-table-p)
19308 (progn
19309 ;; check if we blank the field, and if that triggers align
19310 (and (featurep 'org-table) org-table-auto-blank-field
19311 (member last-command
19312 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19314 ;; got extra space, this field does not determine column width
19315 (let (org-table-may-need-update) (org-table-blank-field))
19316 ;; no extra space, this field may determine column width
19317 (org-table-blank-field)))
19318 t)
19319 (eq N 1)
19321 (let (org-table-may-need-update)
19322 (goto-char (1- (match-end 0)))
19323 (backward-delete-char 1)
19324 (goto-char (match-beginning 0))
19325 (self-insert-command N)))
19326 (t
19327 (setq org-table-may-need-update t)
19328 (self-insert-command N)
19329 (org-fix-tags-on-the-fly)
19330 (if org-self-insert-cluster-for-undo
19331 (if (not (eq last-command 'org-self-insert-command))
19332 (setq org-self-insert-command-undo-counter 1)
19333 (if (>= org-self-insert-command-undo-counter 20)
19334 (setq org-self-insert-command-undo-counter 1)
19335 (and (> org-self-insert-command-undo-counter 0)
19336 buffer-undo-list (listp buffer-undo-list)
19337 (not (cadr buffer-undo-list)) ; remove nil entry
19338 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19339 (setq org-self-insert-command-undo-counter
19340 (1+ org-self-insert-command-undo-counter))))))))
19342 (defun org-check-before-invisible-edit (kind)
19343 "Check is editing if kind KIND would be dangerous with invisible text around.
19344 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19345 ;; First, try to get out of here as quickly as possible, to reduce overhead
19346 (if (and org-catch-invisible-edits
19347 (or (not (boundp 'visible-mode)) (not visible-mode))
19348 (or (get-char-property (point) 'invisible)
19349 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19350 ;; OK, we need to take a closer look
19351 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19352 (invisible-before-point (if (bobp) nil (get-char-property
19353 (1- (point)) 'invisible)))
19354 (border-and-ok-direction
19355 (or
19356 ;; Check if we are acting predictably before invisible text
19357 (and invisible-at-point (not invisible-before-point)
19358 (memq kind '(insert delete-backward)))
19359 ;; Check if we are acting predictably after invisible text
19360 ;; This works not well, and I have turned it off. It seems
19361 ;; better to always show and stop after invisible text.
19362 ;; (and (not invisible-at-point) invisible-before-point
19363 ;; (memq kind '(insert delete)))
19364 )))
19365 (when (or (memq invisible-at-point '(outline org-hide-block t))
19366 (memq invisible-before-point '(outline org-hide-block t)))
19367 (if (eq org-catch-invisible-edits 'error)
19368 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19369 (if (and org-custom-properties-overlays
19370 (y-or-n-p "Display invisible properties in this buffer? "))
19371 (org-toggle-custom-properties-visibility)
19372 ;; Make the area visible
19373 (save-excursion
19374 (if invisible-before-point
19375 (goto-char (previous-single-char-property-change
19376 (point) 'invisible)))
19377 (org-cycle))
19378 (cond
19379 ((eq org-catch-invisible-edits 'show)
19380 ;; That's it, we do the edit after showing
19381 (message
19382 "Unfolding invisible region around point before editing")
19383 (sit-for 1))
19384 ((and (eq org-catch-invisible-edits 'smart)
19385 border-and-ok-direction)
19386 (message "Unfolding invisible region around point before editing"))
19387 (t
19388 ;; Don't do the edit, make the user repeat it in full visibility
19389 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19391 (defun org-fix-tags-on-the-fly ()
19392 (when (and (equal (char-after (point-at-bol)) ?*)
19393 (org-at-heading-p))
19394 (org-align-tags-here org-tags-column)))
19396 (defun org-delete-backward-char (N)
19397 "Like `delete-backward-char', insert whitespace at field end in tables.
19398 When deleting backwards, in tables this function will insert whitespace in
19400 still be marked for re-alignment if the field did fill the entire column,
19401 because, in this case the deletion might narrow the column."
19402 (interactive "p")
19403 (save-match-data
19404 (org-check-before-invisible-edit 'delete-backward)
19405 (if (and (org-table-p)
19406 (eq N 1)
19407 (string-match "|" (buffer-substring (point-at-bol) (point)))
19408 (looking-at ".*?|"))
19409 (let ((pos (point))
19411 (c org-table-may-need-update))
19412 (backward-delete-char N)
19413 (if (not overwrite-mode)
19414 (progn
19415 (skip-chars-forward "^|")
19416 (insert " ")
19417 (goto-char (1- pos))))
19418 ;; noalign: if there were two spaces at the end, this field
19419 ;; does not determine the width of the column.
19420 (if noalign (setq org-table-may-need-update c)))
19421 (backward-delete-char N)
19422 (org-fix-tags-on-the-fly))))
19424 (defun org-delete-char (N)
19425 "Like `delete-char', but insert whitespace at field end in tables.
19426 When deleting characters, in tables this function will insert whitespace in
19428 still be marked for re-alignment if the field did fill the entire column,
19429 because, in this case the deletion might narrow the column."
19430 (interactive "p")
19431 (save-match-data
19432 (org-check-before-invisible-edit 'delete)
19433 (if (and (org-table-p)
19434 (not (bolp))
19435 (not (= (char-after) ?|))
19436 (eq N 1))
19437 (if (looking-at ".*?|")
19438 (let ((pos (point))
19440 (c org-table-may-need-update))
19441 (replace-match
19442 (concat (substring (match-string 0) 1 -1) " |") nil t)
19443 (goto-char pos)
19444 ;; noalign: if there were two spaces at the end, this field
19445 ;; does not determine the width of the column.
19446 (if noalign (setq org-table-may-need-update c)))
19447 (delete-char N))
19448 (delete-char N)
19449 (org-fix-tags-on-the-fly))))
19451 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19452 (put 'org-self-insert-command 'delete-selection t)
19453 (put 'orgtbl-self-insert-command 'delete-selection t)
19454 (put 'org-delete-char 'delete-selection 'supersede)
19455 (put 'org-delete-backward-char 'delete-selection 'supersede)
19456 (put 'org-yank 'delete-selection 'yank)
19458 ;; Make `flyspell-mode' delay after some commands
19459 (put 'org-self-insert-command 'flyspell-delayed t)
19460 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19461 (put 'org-delete-char 'flyspell-delayed t)
19462 (put 'org-delete-backward-char 'flyspell-delayed t)
19464 ;; Make pabbrev-mode expand after org-mode commands
19465 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19466 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19468 ;; How to do this: Measure non-white length of current string
19469 ;; If equal to column width, we should realign.
19471 (defun org-remap (map &rest commands)
19472 "In MAP, remap the functions given in COMMANDS.
19473 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19474 (let (new old)
19475 (while commands
19476 (setq old (pop commands) new (pop commands))
19477 (if (fboundp 'command-remapping)
19478 (org-defkey map (vector 'remap old) new)
19479 (substitute-key-definition old new map global-map)))))
19481 (defun org-transpose-words ()
19482 "Transpose words for Org.
19483 This uses the `org-mode-transpose-word-syntax-table' syntax
19484 table, which interprets characters in `org-emphasis-alist' as
19485 word constituants."
19486 (interactive)
19487 (with-syntax-table org-mode-transpose-word-syntax-table
19488 (call-interactively 'transpose-words)))
19489 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19491 (when (eq org-enable-table-editor 'optimized)
19492 ;; If the user wants maximum table support, we need to hijack
19493 ;; some standard editing functions
19494 (org-remap org-mode-map
19495 'self-insert-command 'org-self-insert-command
19496 'delete-char 'org-delete-char
19497 'delete-backward-char 'org-delete-backward-char)
19498 (org-defkey org-mode-map "|" 'org-force-self-insert))
19500 (defvar org-ctrl-c-ctrl-c-hook nil
19501 "Hook for functions attaching themselves to `C-c C-c'.
19503 This can be used to add additional functionality to the C-c C-c
19504 key which executes context-dependent commands. This hook is run
19505 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19506 run after the last test.
19508 Each function will be called with no arguments. The function
19509 must check if the context is appropriate for it to act. If yes,
19510 it should do its thing and then return a non-nil value. If the
19511 context is wrong, just do nothing and return nil.")
19513 (defvar org-ctrl-c-ctrl-c-final-hook nil
19514 "Hook for functions attaching themselves to `C-c C-c'.
19516 This can be used to add additional functionality to the C-c C-c
19517 key which executes context-dependent commands. This hook is run
19518 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19519 before the first test.
19521 Each function will be called with no arguments. The function
19522 must check if the context is appropriate for it to act. If yes,
19523 it should do its thing and then return a non-nil value. If the
19524 context is wrong, just do nothing and return nil.")
19526 (defvar org-tab-first-hook nil
19527 "Hook for functions to attach themselves to TAB.
19528 See `org-ctrl-c-ctrl-c-hook' for more information.
19529 This hook runs as the first action when TAB is pressed, even before
19530 `org-cycle' messes around with the `outline-regexp' to cater for
19531 inline tasks and plain list item folding.
19532 If any function in this hook returns t, any other actions that
19533 would have been caused by TAB (such as table field motion or visibility
19534 cycling) will not occur.")
19536 (defvar org-tab-after-check-for-table-hook nil
19537 "Hook for functions to attach themselves to TAB.
19538 See `org-ctrl-c-ctrl-c-hook' for more information.
19539 This hook runs after it has been established that the cursor is not in a
19540 table, but before checking if the cursor is in a headline or if global cycling
19541 should be done.
19542 If any function in this hook returns t, not other actions like visibility
19543 cycling will be done.")
19545 (defvar org-tab-after-check-for-cycling-hook nil
19546 "Hook for functions to attach themselves to TAB.
19547 See `org-ctrl-c-ctrl-c-hook' for more information.
19548 This hook runs after it has been established that not table field motion and
19549 not visibility should be done because of current context. This is probably
19550 the place where a package like yasnippets can hook in.")
19552 (defvar org-tab-before-tab-emulation-hook nil
19553 "Hook for functions to attach themselves to TAB.
19554 See `org-ctrl-c-ctrl-c-hook' for more information.
19555 This hook runs after every other options for TAB have been exhausted, but
19558 (defvar org-metaleft-hook nil
19559 "Hook for functions attaching themselves to `M-left'.
19560 See `org-ctrl-c-ctrl-c-hook' for more information.")
19561 (defvar org-metaright-hook nil
19562 "Hook for functions attaching themselves to `M-right'.
19563 See `org-ctrl-c-ctrl-c-hook' for more information.")
19564 (defvar org-metaup-hook nil
19565 "Hook for functions attaching themselves to `M-up'.
19566 See `org-ctrl-c-ctrl-c-hook' for more information.")
19567 (defvar org-metadown-hook nil
19568 "Hook for functions attaching themselves to `M-down'.
19569 See `org-ctrl-c-ctrl-c-hook' for more information.")
19570 (defvar org-shiftmetaleft-hook nil
19571 "Hook for functions attaching themselves to `M-S-left'.
19572 See `org-ctrl-c-ctrl-c-hook' for more information.")
19573 (defvar org-shiftmetaright-hook nil
19574 "Hook for functions attaching themselves to `M-S-right'.
19575 See `org-ctrl-c-ctrl-c-hook' for more information.")
19576 (defvar org-shiftmetaup-hook nil
19577 "Hook for functions attaching themselves to `M-S-up'.
19578 See `org-ctrl-c-ctrl-c-hook' for more information.")
19579 (defvar org-shiftmetadown-hook nil
19580 "Hook for functions attaching themselves to `M-S-down'.
19581 See `org-ctrl-c-ctrl-c-hook' for more information.")
19582 (defvar org-metareturn-hook nil
19583 "Hook for functions attaching themselves to `M-RET'.
19584 See `org-ctrl-c-ctrl-c-hook' for more information.")
19585 (defvar org-shiftup-hook nil
19586 "Hook for functions attaching themselves to `S-up'.
19587 See `org-ctrl-c-ctrl-c-hook' for more information.")
19588 (defvar org-shiftup-final-hook nil
19589 "Hook for functions attaching themselves to `S-up'.
19590 This one runs after all other options except shift-select have been excluded.
19591 See `org-ctrl-c-ctrl-c-hook' for more information.")
19592 (defvar org-shiftdown-hook nil
19593 "Hook for functions attaching themselves to `S-down'.
19594 See `org-ctrl-c-ctrl-c-hook' for more information.")
19595 (defvar org-shiftdown-final-hook nil
19596 "Hook for functions attaching themselves to `S-down'.
19597 This one runs after all other options except shift-select have been excluded.
19598 See `org-ctrl-c-ctrl-c-hook' for more information.")
19599 (defvar org-shiftleft-hook nil
19600 "Hook for functions attaching themselves to `S-left'.
19601 See `org-ctrl-c-ctrl-c-hook' for more information.")
19602 (defvar org-shiftleft-final-hook nil
19603 "Hook for functions attaching themselves to `S-left'.
19604 This one runs after all other options except shift-select have been excluded.
19605 See `org-ctrl-c-ctrl-c-hook' for more information.")
19606 (defvar org-shiftright-hook nil
19607 "Hook for functions attaching themselves to `S-right'.
19608 See `org-ctrl-c-ctrl-c-hook' for more information.")
19609 (defvar org-shiftright-final-hook nil
19610 "Hook for functions attaching themselves to `S-right'.
19611 This one runs after all other options except shift-select have been excluded.
19612 See `org-ctrl-c-ctrl-c-hook' for more information.")
19614 (defun org-modifier-cursor-error ()
19615 "Throw an error, a modified cursor command was applied in wrong context."
19616 (user-error "This command is active in special context like tables, headlines or items"))
19618 (defun org-shiftselect-error ()
19619 "Throw an error because Shift-Cursor command was applied in wrong context."
19620 (if (and (boundp 'shift-select-mode) shift-select-mode)
19621 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19622 (user-error "This command works only in special context like headlines or timestamps")))
19624 (defun org-call-for-shift-select (cmd)
19625 (let ((this-command-keys-shift-translated t))
19626 (call-interactively cmd)))
19628 (defun org-shifttab (&optional arg)
19629 "Global visibility cycling or move to previous table field.
19630 Call `org-table-previous-field' within a table.
19631 When ARG is nil, cycle globally through visibility states.
19632 When ARG is a numeric prefix, show contents of this level."
19633 (interactive "P")
19634 (cond
19635 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19636 ((integerp arg)
19637 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19638 (message "Content view to level: %d" arg)
19639 (org-content (prefix-numeric-value arg2))
19640 (org-cycle-show-empty-lines t)
19641 (setq org-cycle-global-status 'overview)))
19642 (t (call-interactively 'org-global-cycle))))
19644 (defun org-shiftmetaleft ()
19645 "Promote subtree or delete table column.
19646 Calls `org-promote-subtree', `org-outdent-item-tree', or
19647 `org-table-delete-column', depending on context. See the
19648 individual commands for more information."
19649 (interactive)
19650 (cond
19651 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19652 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19653 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19654 ((if (not (org-region-active-p)) (org-at-item-p)
19655 (save-excursion (goto-char (region-beginning))
19656 (org-at-item-p)))
19657 (call-interactively 'org-outdent-item-tree))
19658 (t (org-modifier-cursor-error))))
19660 (defun org-shiftmetaright ()
19661 "Demote subtree or insert table column.
19662 Calls `org-demote-subtree', `org-indent-item-tree', or
19663 `org-table-insert-column', depending on context. See the
19664 individual commands for more information."
19665 (interactive)
19666 (cond
19667 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19668 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19669 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19670 ((if (not (org-region-active-p)) (org-at-item-p)
19671 (save-excursion (goto-char (region-beginning))
19672 (org-at-item-p)))
19673 (call-interactively 'org-indent-item-tree))
19674 (t (org-modifier-cursor-error))))
19676 (defun org-shiftmetaup (&optional arg)
19677 "Move subtree up or kill table row.
19678 Calls `org-move-subtree-up' or `org-table-kill-row' or
19679 `org-move-item-up' or `org-timestamp-up', depending on context.
19680 See the individual commands for more information."
19681 (interactive "P")
19682 (cond
19683 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19684 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19685 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19686 ((org-at-item-p) (call-interactively 'org-move-item-up))
19687 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19688 (call-interactively 'org-timestamp-up)))
19689 (t (call-interactively 'org-drag-line-backward))))
19691 (defun org-shiftmetadown (&optional arg)
19692 "Move subtree down or insert table row.
19693 Calls `org-move-subtree-down' or `org-table-insert-row' or
19694 `org-move-item-down' or `org-timestamp-up', depending on context.
19695 See the individual commands for more information."
19696 (interactive "P")
19697 (cond
19698 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19699 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19700 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19701 ((org-at-item-p) (call-interactively 'org-move-item-down))
19702 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19703 (call-interactively 'org-timestamp-down)))
19704 (t (call-interactively 'org-drag-line-forward))))
19706 (defsubst org-hidden-tree-error ()
19707 (user-error
19708 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19710 (defun org-metaleft (&optional arg)
19711 "Promote heading or move table column to left.
19712 Calls `org-do-promote' or `org-table-move-column', depending on context.
19713 With no specific context, calls the Emacs default `backward-word'.
19714 See the individual commands for more information."
19715 (interactive "P")
19716 (cond
19717 ((run-hook-with-args-until-success 'org-metaleft-hook))
19718 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19719 ((org-with-limited-levels
19720 (or (org-at-heading-p)
19721 (and (org-region-active-p)
19722 (save-excursion
19723 (goto-char (region-beginning))
19724 (org-at-heading-p)))))
19725 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19726 (call-interactively 'org-do-promote))
19727 ;; At an inline task.
19728 ((org-at-heading-p)
19729 (call-interactively 'org-inlinetask-promote))
19730 ((or (org-at-item-p)
19731 (and (org-region-active-p)
19732 (save-excursion
19733 (goto-char (region-beginning))
19734 (org-at-item-p))))
19735 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19736 (call-interactively 'org-outdent-item))
19737 (t (call-interactively 'backward-word))))
19739 (defun org-metaright (&optional arg)
19740 "Demote a subtree, a list item or move table column to right.
19741 In front of a drawer or a block keyword, indent it correctly.
19742 With no specific context, calls the Emacs default `forward-word'.
19743 See the individual commands for more information."
19744 (interactive "P")
19745 (cond
19746 ((run-hook-with-args-until-success 'org-metaright-hook))
19747 ((org-at-table-p) (call-interactively 'org-table-move-column))
19748 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19749 ((org-at-block-p) (call-interactively 'org-indent-block))
19750 ((org-with-limited-levels
19751 (or (org-at-heading-p)
19752 (and (org-region-active-p)
19753 (save-excursion
19754 (goto-char (region-beginning))
19755 (org-at-heading-p)))))
19756 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19757 (call-interactively 'org-do-demote))
19758 ;; At an inline task.
19759 ((org-at-heading-p)
19760 (call-interactively 'org-inlinetask-demote))
19761 ((or (org-at-item-p)
19762 (and (org-region-active-p)
19763 (save-excursion
19764 (goto-char (region-beginning))
19765 (org-at-item-p))))
19766 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19767 (call-interactively 'org-indent-item))
19768 (t (call-interactively 'forward-word))))
19770 (defun org-check-for-hidden (what)
19771 "Check if there are hidden headlines/items in the current visual line.
19772 WHAT can be either `headlines' or `items'. If the current line is
19773 an outline or item heading and it has a folded subtree below it,
19774 this function returns t, nil otherwise."
19775 (let ((re (cond
19776 ((eq what 'headlines) org-outline-regexp-bol)
19777 ((eq what 'items) (org-item-beginning-re))
19778 (t (error "This should not happen"))))
19779 beg end)
19780 (save-excursion
19781 (catch 'exit
19782 (unless (org-region-active-p)
19783 (setq beg (point-at-bol))
19784 (beginning-of-line 2)
19785 (while (and (not (eobp)) ;; this is like `next-line'
19786 (get-char-property (1- (point)) 'invisible))
19787 (beginning-of-line 2))
19788 (setq end (point))
19789 (goto-char beg)
19790 (goto-char (point-at-eol))
19791 (setq end (max end (point)))
19792 (while (re-search-forward re end t)
19793 (if (get-char-property (match-beginning 0) 'invisible)
19794 (throw 'exit t))))
19795 nil))))
19797 (defun org-metaup (&optional arg)
19798 "Move subtree up or move table row up.
19799 Calls `org-move-subtree-up' or `org-table-move-row' or
19800 `org-move-item-up', depending on context. See the individual commands
19801 for more information."
19802 (interactive "P")
19803 (cond
19804 ((run-hook-with-args-until-success 'org-metaup-hook))
19805 ((org-region-active-p)
19806 (let* ((a (min (region-beginning) (region-end)))
19807 (b (1- (max (region-beginning) (region-end))))
19808 (c (save-excursion (goto-char a)
19809 (move-beginning-of-line 0)))
19810 (d (save-excursion (goto-char a)
19811 (move-end-of-line 0) (point))))
19812 (transpose-regions a b c d)
19813 (goto-char c)))
19814 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19815 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19816 ((org-at-item-p) (call-interactively 'org-move-item-up))
19817 (t (org-drag-element-backward))))
19819 (defun org-metadown (&optional arg)
19820 "Move subtree down or move table row down.
19821 Calls `org-move-subtree-down' or `org-table-move-row' or
19822 `org-move-item-down', depending on context. See the individual
19823 commands for more information."
19824 (interactive "P")
19825 (cond
19826 ((run-hook-with-args-until-success 'org-metadown-hook))
19827 ((org-region-active-p)
19828 (let* ((a (min (region-beginning) (region-end)))
19829 (b (max (region-beginning) (region-end)))
19830 (c (save-excursion (goto-char b)
19831 (move-beginning-of-line 1)))
19832 (d (save-excursion (goto-char b)
19833 (move-end-of-line 1) (1+ (point)))))
19834 (transpose-regions a b c d)
19835 (goto-char d)))
19836 ((org-at-table-p) (call-interactively 'org-table-move-row))
19837 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19838 ((org-at-item-p) (call-interactively 'org-move-item-down))
19839 (t (org-drag-element-forward))))
19841 (defun org-shiftup (&optional arg)
19842 "Increase item in timestamp or increase priority of current headline.
19843 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19844 depending on context. See the individual commands for more information."
19845 (interactive "P")
19846 (cond
19847 ((run-hook-with-args-until-success 'org-shiftup-hook))
19848 ((and org-support-shift-select (org-region-active-p))
19849 (org-call-for-shift-select 'previous-line))
19850 ((org-at-timestamp-p t)
19851 (call-interactively (if org-edit-timestamp-down-means-later
19852 'org-timestamp-down 'org-timestamp-up)))
19853 ((and (not (eq org-support-shift-select 'always))
19854 org-enable-priority-commands
19855 (org-at-heading-p))
19856 (call-interactively 'org-priority-up))
19857 ((and (not org-support-shift-select) (org-at-item-p))
19858 (call-interactively 'org-previous-item))
19859 ((org-clocktable-try-shift 'up arg))
19860 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19861 (org-support-shift-select
19862 (org-call-for-shift-select 'previous-line))
19863 (t (org-shiftselect-error))))
19865 (defun org-shiftdown (&optional arg)
19866 "Decrease item in timestamp or decrease priority of current headline.
19867 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19868 depending on context. See the individual commands for more information."
19869 (interactive "P")
19870 (cond
19871 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19872 ((and org-support-shift-select (org-region-active-p))
19873 (org-call-for-shift-select 'next-line))
19874 ((org-at-timestamp-p t)
19875 (call-interactively (if org-edit-timestamp-down-means-later
19876 'org-timestamp-up 'org-timestamp-down)))
19877 ((and (not (eq org-support-shift-select 'always))
19878 org-enable-priority-commands
19879 (org-at-heading-p))
19880 (call-interactively 'org-priority-down))
19881 ((and (not org-support-shift-select) (org-at-item-p))
19882 (call-interactively 'org-next-item))
19883 ((org-clocktable-try-shift 'down arg))
19884 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19885 (org-support-shift-select
19886 (org-call-for-shift-select 'next-line))
19887 (t (org-shiftselect-error))))
19889 (defun org-shiftright (&optional arg)
19890 "Cycle the thing at point or in the current line, depending on context.
19891 Depending on context, this does one of the following:
19893 - switch a timestamp at point one day into the future
19894 - on a headline, switch to the next TODO keyword.
19895 - on an item, switch entire list to the next bullet type
19896 - on a property line, switch to the next allowed value
19897 - on a clocktable definition line, move time block into the future"
19898 (interactive "P")
19899 (cond
19900 ((run-hook-with-args-until-success 'org-shiftright-hook))
19901 ((and org-support-shift-select (org-region-active-p))
19902 (org-call-for-shift-select 'forward-char))
19903 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19904 ((and (not (eq org-support-shift-select 'always))
19905 (org-at-heading-p))
19906 (let ((org-inhibit-logging
19907 (not org-treat-S-cursor-todo-selection-as-state-change))
19908 (org-inhibit-blocking
19909 (not org-treat-S-cursor-todo-selection-as-state-change)))
19910 (org-call-with-arg 'org-todo 'right)))
19911 ((or (and org-support-shift-select
19912 (not (eq org-support-shift-select 'always))
19913 (org-at-item-bullet-p))
19914 (and (not org-support-shift-select) (org-at-item-p)))
19915 (org-call-with-arg 'org-cycle-list-bullet nil))
19916 ((and (not (eq org-support-shift-select 'always))
19917 (org-at-property-p))
19918 (call-interactively 'org-property-next-allowed-value))
19919 ((org-clocktable-try-shift 'right arg))
19920 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19921 (org-support-shift-select
19922 (org-call-for-shift-select 'forward-char))
19923 (t (org-shiftselect-error))))
19925 (defun org-shiftleft (&optional arg)
19926 "Cycle the thing at point or in the current line, depending on context.
19927 Depending on context, this does one of the following:
19929 - switch a timestamp at point one day into the past
19930 - on a headline, switch to the previous TODO keyword.
19931 - on an item, switch entire list to the previous bullet type
19932 - on a property line, switch to the previous allowed value
19933 - on a clocktable definition line, move time block into the past"
19934 (interactive "P")
19935 (cond
19936 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19937 ((and org-support-shift-select (org-region-active-p))
19938 (org-call-for-shift-select 'backward-char))
19939 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19940 ((and (not (eq org-support-shift-select 'always))
19941 (org-at-heading-p))
19942 (let ((org-inhibit-logging
19943 (not org-treat-S-cursor-todo-selection-as-state-change))
19944 (org-inhibit-blocking
19945 (not org-treat-S-cursor-todo-selection-as-state-change)))
19946 (org-call-with-arg 'org-todo 'left)))
19947 ((or (and org-support-shift-select
19948 (not (eq org-support-shift-select 'always))
19949 (org-at-item-bullet-p))
19950 (and (not org-support-shift-select) (org-at-item-p)))
19951 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19952 ((and (not (eq org-support-shift-select 'always))
19953 (org-at-property-p))
19954 (call-interactively 'org-property-previous-allowed-value))
19955 ((org-clocktable-try-shift 'left arg))
19956 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19957 (org-support-shift-select
19958 (org-call-for-shift-select 'backward-char))
19959 (t (org-shiftselect-error))))
19961 (defun org-shiftcontrolright ()
19962 "Switch to next TODO set."
19963 (interactive)
19964 (cond
19965 ((and org-support-shift-select (org-region-active-p))
19966 (org-call-for-shift-select 'forward-word))
19967 ((and (not (eq org-support-shift-select 'always))
19968 (org-at-heading-p))
19969 (org-call-with-arg 'org-todo 'nextset))
19970 (org-support-shift-select
19971 (org-call-for-shift-select 'forward-word))
19972 (t (org-shiftselect-error))))
19974 (defun org-shiftcontrolleft ()
19975 "Switch to previous TODO set."
19976 (interactive)
19977 (cond
19978 ((and org-support-shift-select (org-region-active-p))
19979 (org-call-for-shift-select 'backward-word))
19980 ((and (not (eq org-support-shift-select 'always))
19981 (org-at-heading-p))
19982 (org-call-with-arg 'org-todo 'previousset))
19983 (org-support-shift-select
19984 (org-call-for-shift-select 'backward-word))
19985 (t (org-shiftselect-error))))
19987 (defun org-shiftcontrolup (&optional n)
19988 "Change timestamps synchronously up in CLOCK log lines.
19989 Optional argument N tells to change by that many units."
19990 (interactive "P")
19991 (cond ((and (not org-support-shift-select)
19992 (org-at-clock-log-p)
19993 (org-at-timestamp-p t))
19994 (org-clock-timestamps-up n))
19995 (t (org-shiftselect-error))))
19997 (defun org-shiftcontroldown (&optional n)
19998 "Change timestamps synchronously down in CLOCK log lines.
19999 Optional argument N tells to change by that many units."
20000 (interactive "P")
20001 (cond ((and (not org-support-shift-select)
20002 (org-at-clock-log-p)
20003 (org-at-timestamp-p t))
20004 (org-clock-timestamps-down n))
20005 (t (org-shiftselect-error))))
20007 (defun org-ctrl-c-ret ()
20008 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20009 (interactive)
20010 (cond
20011 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20012 (t (call-interactively 'org-insert-heading))))
20014 (defun org-find-visible ()
20015 (let ((s (point)))
20016 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20017 (get-char-property s 'invisible)))
20018 s))
20019 (defun org-find-invisible ()
20020 (let ((s (point)))
20021 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20022 (not (get-char-property s 'invisible))))
20023 s))
20025 (defun org-copy-visible (beg end)
20026 "Copy the visible parts of the region."
20027 (interactive "r")
20028 (let (snippets s)
20029 (save-excursion
20030 (save-restriction
20031 (narrow-to-region beg end)
20032 (setq s (goto-char (point-min)))
20033 (while (not (= (point) (point-max)))
20034 (goto-char (org-find-invisible))
20035 (push (buffer-substring s (point)) snippets)
20036 (setq s (goto-char (org-find-visible))))))
20037 (kill-new (apply 'concat (nreverse snippets)))))
20039 (defun org-copy-special ()
20040 "Copy region in table or copy current subtree.
20041 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20042 See the individual commands for more information."
20043 (interactive)
20044 (call-interactively
20045 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20047 (defun org-cut-special ()
20048 "Cut region in table or cut current subtree.
20049 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20050 See the individual commands for more information."
20051 (interactive)
20052 (call-interactively
20053 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20055 (defun org-paste-special (arg)
20056 "Paste rectangular region into table, or past subtree relative to level.
20057 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20058 See the individual commands for more information."
20059 (interactive "P")
20060 (if (org-at-table-p)
20061 (org-table-paste-rectangle)
20062 (org-paste-subtree arg)))
20064 (defsubst org-in-fixed-width-region-p ()
20065 "Is point in a fixed-width region?"
20066 (save-match-data
20067 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20069 (defun org-edit-special (&optional arg)
20070 "Call a special editor for the element at point.
20071 When at a table, call the formula editor with `org-table-edit-formulas'.
20072 When in a source code block, call `org-edit-src-code'.
20073 When in a fixed-width region, call `org-edit-fixed-width-region'.
20074 When at an #+INCLUDE keyword, visit the included file.
20075 On a link, call `ffap' to visit the link at point.
20076 Otherwise, return a user error."
20077 (interactive "P")
20078 (let ((element (org-element-at-point)))
20079 (assert (not buffer-read-only) nil
20080 "Buffer is read-only: %s" (buffer-name))
20081 (case (org-element-type element)
20082 (src-block
20083 (if (not arg) (org-edit-src-code)
20084 (let* ((info (org-babel-get-src-block-info))
20085 (lang (nth 0 info))
20086 (params (nth 2 info))
20087 (session (cdr (assq :session params))))
20088 (if (not session) (org-edit-src-code)
20089 ;; At a src-block with a session and function called with
20090 ;; an ARG: switch to the buffer related to the inferior
20091 ;; process.
20092 (switch-to-buffer
20093 (funcall (intern (concat "org-babel-prep-session:" lang))
20094 session params))))))
20095 (keyword
20096 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20097 (find-file
20098 (org-remove-double-quotes
20099 (car (org-split-string (org-element-property :value element)))))
20100 (user-error "No special environment to edit here")))
20101 (table
20102 (if (eq (org-element-property :type element) 'table.el)
20103 (org-edit-src-code)
20104 (call-interactively 'org-table-edit-formulas)))
20105 ;; Only Org tables contain `table-row' type elements.
20106 (table-row (call-interactively 'org-table-edit-formulas))
20107 ((example-block export-block) (org-edit-src-code))
20108 (fixed-width (org-edit-fixed-width-region))
20109 (otherwise
20110 ;; No notable element at point. Though, we may be at a link,
20111 ;; which is an object. Thus, scan deeper.
20112 (if (eq (org-element-type (org-element-context element)) 'link)
20113 (call-interactively 'ffap)
20114 (user-error "No special environment to edit here"))))))
20116 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20117 (defun org-ctrl-c-ctrl-c (&optional arg)
20118 "Set tags in headline, or update according to changed information at point.
20120 This command does many different things, depending on context:
20122 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20123 this is what we do.
20125 - If the cursor is on a statistics cookie, update it.
20127 - If the cursor is in a headline, prompt for tags and insert them
20128 into the current line, aligned to `org-tags-column'. When called
20129 with prefix arg, realign all tags in the current buffer.
20131 - If the cursor is in one of the special #+KEYWORD lines, this
20132 triggers scanning the buffer for these lines and updating the
20133 information.
20135 - If the cursor is inside a table, realign the table. This command
20136 works even if the automatic table editor has been turned off.
20138 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20139 the entire table.
20141 - If the cursor is at a footnote reference or definition, jump to
20142 the corresponding definition or references, respectively.
20144 - If the cursor is a the beginning of a dynamic block, update it.
20146 - If the current buffer is a capture buffer, close note and file it.
20148 - If the cursor is on a <<<target>>>, update radio targets and
20149 corresponding links in this buffer.
20151 - If the cursor is on a numbered item in a plain list, renumber the
20152 ordered list.
20154 - If the cursor is on a checkbox, toggle it.
20156 - If the cursor is on a code block, evaluate it. The variable
20157 `org-confirm-babel-evaluate' can be used to control prompting
20158 before code block evaluation, by default every code block
20159 evaluation requires confirmation. Code block evaluation can be
20160 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20161 (interactive "P")
20162 (cond
20163 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20164 org-occur-highlights
20165 org-latex-fragment-image-overlays)
20166 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20167 (org-remove-occur-highlights)
20168 (org-remove-latex-fragment-image-overlays)
20169 (message "Temporary highlights/overlays removed from current buffer"))
20170 ((and (local-variable-p 'org-finish-function (current-buffer))
20171 (fboundp org-finish-function))
20172 (funcall org-finish-function))
20173 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20174 (t
20175 (let* ((context (org-element-context)) (type (org-element-type context)))
20176 ;; Test if point is within a blank line.
20178 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20179 (user-error "C-c C-c can do nothing useful at this location"))
20180 ;; For convenience: at the first line of a paragraph on the
20181 ;; same line as an item, apply function on that item instead.
20182 (when (eq type 'paragraph)
20183 (let ((parent (org-element-property :parent context)))
20184 (when (and (eq (org-element-type parent) 'item)
20185 (= (point-at-bol) (org-element-property :begin parent)))
20186 (setq context parent type 'item))))
20187 ;; Act according to type of element or object at point.
20188 (case type
20189 (clock (org-clock-update-time-maybe))
20190 (dynamic-block
20191 (save-excursion
20192 (goto-char (org-element-property :post-affiliated context))
20193 (org-update-dblock)))
20194 (footnote-definition
20195 (goto-char (org-element-property :post-affiliated context))
20196 (call-interactively 'org-footnote-action))
20197 (footnote-reference (call-interactively 'org-footnote-action))
20198 ((headline inlinetask)
20199 (save-excursion (goto-char (org-element-property :begin context))
20200 (call-interactively 'org-set-tags)))
20201 (item
20202 ;; At an item: a double C-u set checkbox to "[-]"
20203 ;; unconditionally, whereas a single one will toggle its
20204 ;; presence. Without an universal argument, if the item
20205 ;; has a checkbox, toggle it. Otherwise repair the list.
20206 (let* ((box (org-element-property :checkbox context))
20207 (struct (org-element-property :structure context))
20208 (old-struct (copy-tree struct))
20209 (parents (org-list-parents-alist struct))
20210 (prevs (org-list-prevs-alist struct))
20211 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20212 (org-list-set-checkbox
20213 (org-element-property :begin context) struct
20214 (cond ((equal arg '(16)) "[-]")
20215 ((and (not box) (equal arg '(4))) "[ ]")
20216 ((or (not box) (equal arg '(4))) nil)
20217 ((eq box 'on) "[ ]")
20218 (t "[X]")))
20219 ;; Mimic `org-list-write-struct' but with grabbing
20220 ;; a return value from `org-list-struct-fix-box'.
20221 (org-list-struct-fix-ind struct parents 2)
20222 (org-list-struct-fix-item-end struct)
20223 (org-list-struct-fix-bul struct prevs)
20224 (org-list-struct-fix-ind struct parents)
20225 (let ((block-item
20226 (org-list-struct-fix-box struct parents prevs orderedp)))
20227 (if (and box (equal struct old-struct))
20228 (if (equal arg '(16))
20229 (message "Checkboxes already reset")
20230 (user-error "Cannot toggle this checkbox: %s"
20231 (if (eq box 'on)
20232 "all subitems checked"
20233 "unchecked subitems")))
20234 (org-list-struct-apply-struct struct old-struct)
20235 (org-update-checkbox-count-maybe))
20236 (when block-item
20237 (message "Checkboxes were removed due to empty box at line %d"
20238 (org-current-line block-item))))))
20239 (keyword
20240 (let ((org-inhibit-startup-visibility-stuff t)
20241 (org-startup-align-all-tables nil))
20242 (when (boundp 'org-table-coordinate-overlays)
20243 (mapc 'delete-overlay org-table-coordinate-overlays)
20244 (setq org-table-coordinate-overlays nil))
20245 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20246 (message "Local setup has been refreshed"))
20247 (plain-list
20248 ;; At a plain list, with a double C-u argument, set
20249 ;; checkboxes of each item to "[-]", whereas a single one
20250 ;; will toggle their presence according to the state of the
20251 ;; first item in the list. Without an argument, repair the
20252 ;; list.
20253 (let* ((begin (org-element-property :contents-begin context))
20254 (beginm (move-marker (make-marker) begin))
20255 (struct (org-element-property :structure context))
20256 (old-struct (copy-tree struct))
20257 (first-box (save-excursion
20258 (goto-char begin)
20259 (looking-at org-list-full-item-re)
20260 (match-string-no-properties 3)))
20261 (new-box (cond ((equal arg '(16)) "[-]")
20262 ((equal arg '(4)) (unless first-box "[ ]"))
20263 ((equal first-box "[X]") "[ ]")
20264 (t "[X]"))))
20265 (cond
20266 (arg
20267 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20268 (org-list-get-all-items
20269 begin struct (org-list-prevs-alist struct))))
20270 ((and first-box (eq (point) begin))
20271 ;; For convenience, when point is at bol on the first
20272 ;; item of the list and no argument is provided, simply
20273 ;; toggle checkbox of that item, if any.
20274 (org-list-set-checkbox begin struct new-box)))
20275 (org-list-write-struct
20276 struct (org-list-parents-alist struct) old-struct)
20277 (org-update-checkbox-count-maybe)
20278 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20279 ((property-drawer node-property)
20280 (call-interactively 'org-property-action))
20281 ((radio-target target)
20282 (call-interactively 'org-update-radio-target-regexp))
20283 (statistics-cookie
20284 (call-interactively 'org-update-statistics-cookies))
20285 ((table table-cell table-row)
20286 ;; At a table, recalculate every field and align it. Also
20287 ;; send the table if necessary. If the table has
20288 ;; a `table.el' type, just give up. At a table row or
20289 ;; cell, maybe recalculate line but always align table.
20290 (if (eq (org-element-property :type context) 'table.el)
20291 (message "Use C-c ' to edit table.el tables")
20292 (let ((org-enable-table-editor t))
20293 (if (or (eq type 'table)
20294 ;; Check if point is at a TBLFM line.
20295 (and (eq type 'table-row)
20296 (= (point) (org-element-property :end context))))
20297 (save-excursion
20298 (if (org-at-TBLFM-p)
20299 (progn (require 'org-table)
20300 (org-table-calc-current-TBLFM))
20301 (goto-char (org-element-property :contents-begin context))
20302 (org-call-with-arg 'org-table-recalculate (or arg t))
20303 (orgtbl-send-table 'maybe)))
20304 (org-table-maybe-eval-formula)
20305 (cond (arg (call-interactively 'org-table-recalculate))
20306 ((org-table-maybe-recalculate-line))
20307 (t (org-table-align)))))))
20308 (timestamp (org-timestamp-change 0 'day))
20309 (otherwise
20310 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20311 (user-error
20312 "C-c C-c can do nothing useful at this location")))))))))
20314 (defun org-mode-restart ()
20315 "Restart Org-mode, to scan again for special lines.
20316 Also updates the keyword regular expressions."
20317 (interactive)
20318 (org-mode)
20319 (message "Org-mode restarted"))
20321 (defun org-kill-note-or-show-branches ()
20322 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20323 (interactive)
20324 (if (not org-finish-function)
20325 (progn
20326 (hide-subtree)
20327 (call-interactively 'show-branches))
20328 (let ((org-note-abort t))
20329 (funcall org-finish-function))))
20331 (defun org-open-line (n)
20332 "Insert a new row in tables, call `open-line' elsewhere."
20333 (interactive "*p")
20334 (if (org-at-table-p)
20335 (org-table-insert-row)
20336 (open-line n)))
20338 (defun org-return (&optional indent)
20339 "Goto next table row or insert a newline.
20340 Calls `org-table-next-row' or `newline', depending on context.
20341 See the individual commands for more information."
20342 (interactive)
20343 (let (org-ts-what)
20344 (cond
20345 ((or (bobp) (org-in-src-block-p))
20346 (if indent (newline-and-indent) (newline)))
20347 ((org-at-table-p)
20348 (org-table-justify-field-maybe)
20349 (call-interactively 'org-table-next-row))
20350 ;; when `newline-and-indent' is called within a list, make sure
20351 ;; text moved stays inside the item.
20352 ((and (org-in-item-p) indent)
20353 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20354 (progn
20355 (save-match-data (newline))
20356 (org-indent-line-to (length (match-string 0))))
20357 (let ((ind (org-get-indentation)))
20358 (newline)
20359 (if (org-looking-back org-list-end-re)
20360 (org-indent-line)
20361 (org-indent-line-to ind)))))
20362 ((and org-return-follows-link
20363 (org-at-timestamp-p t)
20364 (not (eq org-ts-what 'after)))
20365 (org-follow-timestamp-link))
20366 ((and org-return-follows-link
20367 (let ((tprop (get-text-property (point) 'face)))
20368 (or (eq tprop 'org-link)
20369 (and (listp tprop) (memq 'org-link tprop)))))
20370 (call-interactively 'org-open-at-point))
20371 ((and (org-at-heading-p)
20372 (looking-at
20374 (org-show-entry)
20375 (end-of-line 1)
20376 (newline))
20377 (t (if indent (newline-and-indent) (newline))))))
20379 (defun org-return-indent ()
20380 "Goto next table row or insert a newline and indent.
20381 Calls `org-table-next-row' or `newline-and-indent', depending on
20382 context. See the individual commands for more information."
20383 (interactive)
20384 (org-return t))
20386 (defun org-ctrl-c-star ()
20387 "Compute table, or change heading status of lines.
20388 Calls `org-table-recalculate' or `org-toggle-heading',
20389 depending on context."
20390 (interactive)
20391 (cond
20392 ((org-at-table-p)
20393 (call-interactively 'org-table-recalculate))
20394 (t
20395 ;; Convert all lines in region to list items
20396 (call-interactively 'org-toggle-heading))))
20398 (defun org-ctrl-c-minus ()
20399 "Insert separator line in table or modify bullet status of line.
20400 Also turns a plain line or a region of lines into list items.
20401 Calls `org-table-insert-hline', `org-toggle-item', or
20402 `org-cycle-list-bullet', depending on context."
20403 (interactive)
20404 (cond
20405 ((org-at-table-p)
20406 (call-interactively 'org-table-insert-hline))
20407 ((org-region-active-p)
20408 (call-interactively 'org-toggle-item))
20409 ((org-in-item-p)
20410 (call-interactively 'org-cycle-list-bullet))
20411 (t
20412 (call-interactively 'org-toggle-item))))
20414 (defun org-toggle-item (arg)
20415 "Convert headings or normal lines to items, items to normal lines.
20416 If there is no active region, only the current line is considered.
20418 If the first non blank line in the region is a headline, convert
20419 all headlines to items, shifting text accordingly.
20421 If it is an item, convert all items to normal lines.
20423 If it is normal text, change region into a list of items.
20424 With a prefix argument ARG, change the region in a single item."
20425 (interactive "P")
20426 (let ((shift-text
20427 (function
20428 ;; Shift text in current section to IND, from point to END.
20429 ;; The function leaves point to END line.
20430 (lambda (ind end)
20431 (let ((min-i 1000) (end (copy-marker end)))
20432 ;; First determine the minimum indentation (MIN-I) of
20433 ;; the text.
20434 (save-excursion
20435 (catch 'exit
20436 (while (< (point) end)
20437 (let ((i (org-get-indentation)))
20438 (cond
20439 ;; Skip blank lines and inline tasks.
20441 ((looking-at org-outline-regexp-bol))
20442 ;; We can't find less than 0 indentation.
20443 ((zerop i) (throw 'exit (setq min-i 0)))
20444 ((< i min-i) (setq min-i i))))
20445 (forward-line))))
20446 ;; Then indent each line so that a line indented to
20447 ;; MIN-I becomes indented to IND. Ignore blank lines
20448 ;; and inline tasks in the process.
20449 (let ((delta (- ind min-i)))
20450 (while (< (point) end)
20452 (looking-at org-outline-regexp-bol))
20453 (org-indent-line-to (+ (org-get-indentation) delta)))
20454 (forward-line)))))))
20455 (skip-blanks
20456 (function
20457 ;; Return beginning of first non-blank line, starting from
20458 ;; line at POS.
20459 (lambda (pos)
20460 (save-excursion
20461 (goto-char pos)
20463 (point-at-bol)))))
20464 beg end)
20465 ;; Determine boundaries of changes.
20466 (if (org-region-active-p)
20467 (setq beg (funcall skip-blanks (region-beginning))
20468 end (copy-marker (region-end)))
20469 (setq beg (funcall skip-blanks (point-at-bol))
20470 end (copy-marker (point-at-eol))))
20471 ;; Depending on the starting line, choose an action on the text
20472 ;; between BEG and END.
20473 (org-with-limited-levels
20474 (save-excursion
20475 (goto-char beg)
20476 (cond
20477 ;; Case 1. Start at an item: de-itemize. Note that it only
20478 ;; happens when a region is active: `org-ctrl-c-minus'
20479 ;; would call `org-cycle-list-bullet' otherwise.
20480 ((org-at-item-p)
20481 (while (< (point) end)
20482 (when (org-at-item-p)
20484 (delete-region (point) (match-end 0)))
20485 (forward-line)))
20486 ;; Case 2. Start at an heading: convert to items.
20487 ((org-at-heading-p)
20488 (let* ((bul (org-list-bullet-string "-"))
20489 (bul-len (length bul))
20490 ;; Indentation of the first heading. It should be
20491 ;; relative to the indentation of its parent, if any.
20492 (start-ind (save-excursion
20493 (cond
20494 ((not org-adapt-indentation) 0)
20495 ((not (outline-previous-heading)) 0)
20496 (t (length (match-string 0))))))
20497 ;; Level of first heading. Further headings will be
20498 ;; compared to it to determine hierarchy in the list.
20499 (ref-level (org-reduced-level (org-outline-level))))
20500 (while (< (point) end)
20501 (let* ((level (org-reduced-level (org-outline-level)))
20502 (delta (max 0 (- level ref-level))))
20503 ;; If current headline is less indented than the first
20504 ;; one, set it as reference, in order to preserve
20505 ;; subtrees.
20506 (when (< level ref-level) (setq ref-level level))
20507 (replace-match bul t t)
20508 (org-indent-line-to (+ start-ind (* delta bul-len)))
20509 ;; Ensure all text down to END (or SECTION-END) belongs
20510 ;; to the newly created item.
20511 (let ((section-end (save-excursion
20512 (or (outline-next-heading) (point)))))
20513 (forward-line)
20514 (funcall shift-text
20515 (+ start-ind (* (1+ delta) bul-len))
20516 (min end section-end)))))))
20517 ;; Case 3. Normal line with ARG: make the first line of region
20518 ;; an item, and shift indentation of others lines to
20519 ;; set them as item's body.
20520 (arg (let* ((bul (org-list-bullet-string "-"))
20521 (bul-len (length bul))
20522 (ref-ind (org-get-indentation)))
20524 (insert bul)
20525 (forward-line)
20526 (while (< (point) end)
20527 ;; Ensure that lines less indented than first one
20528 ;; still get included in item body.
20529 (funcall shift-text
20530 (+ ref-ind bul-len)
20531 (min end (save-excursion (or (outline-next-heading)
20532 (point)))))
20533 (forward-line))))
20534 ;; Case 4. Normal line without ARG: turn each non-item line
20535 ;; into an item.
20536 (t
20537 (while (< (point) end)
20538 (unless (or (org-at-heading-p) (org-at-item-p))
20540 (replace-match
20542 (forward-line))))))))
20544 (defun org-toggle-heading (&optional nstars)
20545 "Convert headings to normal text, or items or text to headings.
20546 If there is no active region, only convert the current line.
20549 point into heading.
20551 In a region:
20553 - If the first non blank line is a headline, remove the stars
20554 from all headlines in the region.
20556 - If it is a normal line, turn each and every normal line (i.e.,
20557 not an heading or an item) in the region into headings. If you
20558 want to convert only the first line of this region, use one
20559 universal prefix argument.
20561 - If it is a plain list item, turn all plain list items into headings.
20563 When converting a line into a heading, the number of stars is chosen
20564 such that the lines become children of the current entry. However,
20565 when a numeric prefix argument is given, its value determines the
20566 number of stars to add."
20567 (interactive "P")
20568 (let ((skip-blanks
20569 (function
20570 ;; Return beginning of first non-blank line, starting from
20571 ;; line at POS.
20572 (lambda (pos)
20573 (save-excursion
20574 (goto-char pos)
20575 (while (org-at-comment-p) (forward-line))
20577 (point-at-bol)))))
20578 beg end toggled)
20579 ;; Determine boundaries of changes. If a universal prefix has
20580 ;; been given, put the list in a region. If region ends at a bol,
20581 ;; do not consider the last line to be in the region.
20583 (when (and current-prefix-arg (org-at-item-p))
20584 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20585 (org-mark-element))
20587 (if (org-region-active-p)
20588 (setq beg (funcall skip-blanks (region-beginning))
20589 end (copy-marker (save-excursion
20590 (goto-char (region-end))
20591 (if (bolp) (point) (point-at-eol)))))
20592 (setq beg (funcall skip-blanks (point-at-bol))
20593 end (copy-marker (point-at-eol))))
20594 ;; Ensure inline tasks don't count as headings.
20595 (org-with-limited-levels
20596 (save-excursion
20597 (goto-char beg)
20598 (cond
20599 ;; Case 1. Started at an heading: de-star headings.
20600 ((org-at-heading-p)
20601 (while (< (point) end)
20602 (when (org-at-heading-p t)
20603 (looking-at org-outline-regexp) (replace-match "")
20604 (setq toggled t))
20605 (forward-line)))
20606 ;; Case 2. Started at an item: change items into headlines.
20607 ;; One star will be added by `org-list-to-subtree'.
20608 ((org-at-item-p)
20609 (let* ((stars (make-string
20610 ;; subtract the star that will be added again by
20611 ;; `org-list-to-subtree'
20612 (if (numberp nstars) (1- nstars)
20613 (or (org-current-level) 0))
20614 ?*))
20615 (add-stars
20616 (cond (nstars "") ; stars from prefix only
20617 ((equal stars "") "") ; before first heading
20618 (org-odd-levels-only "*") ; inside heading, odd
20619 (t "")))) ; inside heading, oddeven
20620 (while (< (point) end)
20621 (when (org-at-item-p)
20622 ;; Pay attention to cases when region ends before list.
20623 (let* ((struct (org-list-struct))
20624 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20625 (save-restriction
20626 (narrow-to-region (point) list-end)
20627 (insert
20628 (org-list-to-subtree
20629 (org-list-parse-list t)
20630 '(:istart (concat stars add-stars (funcall get-stars depth))
20631 :icount (concat stars add-stars (funcall get-stars depth)))))))
20632 (setq toggled t))
20633 (forward-line))))
20634 ;; Case 3. Started at normal text: make every line an heading,
20635 ;; skipping headlines and items.
20636 (t (let* ((stars
20637 (make-string
20638 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20639 (add-stars
20640 (cond (nstars "") ; stars from prefix only
20641 ((equal stars "") "*") ; before first heading
20642 (org-odd-levels-only "**") ; inside heading, odd
20643 (t "*"))) ; inside heading, oddeven
20644 (rpl (concat stars add-stars " "))
20645 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20646 (while (< (point) (if (equal nstars '(4)) lend end))
20647 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20649 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20650 (forward-line)))))))
20651 (unless toggled (message "Cannot toggle heading from here"))))
20653 (defun org-meta-return (&optional arg)
20654 "Insert a new heading or wrap a region in a table.
20655 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20656 See the individual commands for more information."
20657 (interactive "P")
20658 (org-check-before-invisible-edit 'insert)
20659 (cond
20660 ((run-hook-with-args-until-success 'org-metareturn-hook))
20661 ((or (org-at-drawer-p) (org-in-drawer-p) (org-at-property-p))
20662 (newline-and-indent))
20663 ((org-at-table-p)
20664 (call-interactively 'org-table-wrap-region))
20665 (t (call-interactively 'org-insert-heading))))
20667 ;;; Menu entries
20669 (defsubst org-in-subtree-not-table-p ()
20670 "Are we in a subtree and not in a table?"
20671 (and (not (org-before-first-heading-p))
20672 (not (org-at-table-p))))
20674 ;; Define the Org-mode menus
20675 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20676 '("Tbl"
20677 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20678 ["Next Field" org-cycle (org-at-table-p)]
20679 ["Previous Field" org-shifttab (org-at-table-p)]
20680 ["Next Row" org-return (org-at-table-p)]
20681 "--"
20682 ["Blank Field" org-table-blank-field (org-at-table-p)]
20683 ["Edit Field" org-table-edit-field (org-at-table-p)]
20684 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20685 "--"
20686 ("Column"
20687 ["Move Column Left" org-metaleft (org-at-table-p)]
20688 ["Move Column Right" org-metaright (org-at-table-p)]
20689 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20690 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20691 ("Row"
20692 ["Move Row Up" org-metaup (org-at-table-p)]
20693 ["Move Row Down" org-metadown (org-at-table-p)]
20694 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20695 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20696 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20697 "--"
20698 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20699 ("Rectangle"
20700 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20701 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20702 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20703 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20704 "--"
20705 ("Calculate"
20706 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20707 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20708 ["Edit Formulas" org-edit-special (org-at-table-p)]
20709 "--"
20710 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20711 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20712 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20713 "--"
20714 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20715 "--"
20716 ["Sum Column/Rectangle" org-table-sum
20717 (or (org-at-table-p) (org-region-active-p))]
20718 ["Which Column?" org-table-current-column (org-at-table-p)])
20719 ["Debug Formulas"
20720 org-table-toggle-formula-debugger
20721 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20722 ["Show Col/Row Numbers"
20723 org-table-toggle-coordinate-overlays
20724 :style toggle
20725 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20726 "--"
20727 ["Create" org-table-create (and (not (org-at-table-p))
20728 org-enable-table-editor)]
20729 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20730 ["Import from File" org-table-import (not (org-at-table-p))]
20731 ["Export to File" org-table-export (org-at-table-p)]
20732 "--"
20733 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20735 (easy-menu-define org-org-menu org-mode-map "Org menu"
20736 '("Org"
20737 ("Show/Hide"
20738 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20739 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20740 ["Sparse Tree..." org-sparse-tree t]
20741 ["Reveal Context" org-reveal t]
20742 ["Show All" show-all t]
20743 "--"
20744 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20745 "--"
20746 ["New Heading" org-insert-heading t]
20747 ("Navigate Headings"
20748 ["Up" outline-up-heading t]
20749 ["Next" outline-next-visible-heading t]
20750 ["Previous" outline-previous-visible-heading t]
20751 ["Next Same Level" outline-forward-same-level t]
20752 ["Previous Same Level" outline-backward-same-level t]
20753 "--"
20754 ["Jump" org-goto t])
20755 ("Edit Structure"
20756 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20757 "--"
20758 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20759 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20760 "--"
20761 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20762 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20763 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20764 "--"
20765 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20766 "--"
20767 ["Copy visible text" org-copy-visible t]
20768 "--"
20769 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20770 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20771 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20772 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20773 "--"
20774 ["Sort Region/Children" org-sort t]
20775 "--"
20776 ["Convert to odd levels" org-convert-to-odd-levels t]
20777 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20778 ("Editing"
20779 ["Emphasis..." org-emphasize t]
20780 ["Edit Source Example" org-edit-special t]
20781 "--"
20782 ["Footnote new/jump" org-footnote-action t]
20783 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20784 ("Archive"
20785 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20786 "--"
20787 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20788 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20789 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20790 )
20791 "--"
20792 ("Hyperlinks"
20793 ["Store Link (Global)" org-store-link t]
20794 ["Find existing link to here" org-occur-link-in-agenda-files t]
20795 ["Insert Link" org-insert-link t]
20796 ["Follow Link" org-open-at-point t]
20797 "--"
20798 ["Next link" org-next-link t]
20799 ["Previous link" org-previous-link t]
20800 "--"
20801 ["Descriptive Links"
20802 org-toggle-link-display
20803 :style radio
20804 :selected org-descriptive-links
20805 ]
20806 ["Literal Links"
20807 org-toggle-link-display
20808 :style radio
20809 :selected (not org-descriptive-links)])
20810 "--"
20811 ("TODO Lists"
20812 ["TODO/DONE/-" org-todo t]
20813 ("Select keyword"
20814 ["Next keyword" org-shiftright (org-at-heading-p)]
20815 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20816 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20817 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20818 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20819 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20820 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20821 "--"
20822 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20823 :selected org-enforce-todo-dependencies :style toggle :active t]
20824 "Settings for tree at point"
20825 ["Do Children sequentially" org-toggle-ordered-property :style radio
20826 :selected (org-entry-get nil "ORDERED")
20827 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20828 ["Do Children parallel" org-toggle-ordered-property :style radio
20829 :selected (not (org-entry-get nil "ORDERED"))
20830 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20831 "--"
20832 ["Set Priority" org-priority t]
20833 ["Priority Up" org-shiftup t]
20834 ["Priority Down" org-shiftdown t]
20835 "--"
20836 ["Get news from all feeds" org-feed-update-all t]
20837 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20838 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20839 ("TAGS and Properties"
20840 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20841 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20842 "--"
20843 ["Set property" org-set-property (not (org-before-first-heading-p))]
20844 ["Column view of properties" org-columns t]
20845 ["Insert Column View DBlock" org-insert-columns-dblock t])
20846 ("Dates and Scheduling"
20847 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20848 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20849 ("Change Date"
20850 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20851 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20852 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20853 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20854 ["Compute Time Range" org-evaluate-time-range t]
20855 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20856 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20857 "--"
20858 ["Custom time format" org-toggle-time-stamp-overlays
20859 :style radio :selected org-display-custom-times]
20860 "--"
20861 ["Goto Calendar" org-goto-calendar t]
20862 ["Date from Calendar" org-date-from-calendar t]
20863 "--"
20864 ["Start/Restart Timer" org-timer-start t]
20865 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20866 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20867 ["Insert Timer String" org-timer t]
20868 ["Insert Timer Item" org-timer-item t])
20869 ("Logging work"
20870 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20871 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20872 ["Clock out" org-clock-out t]
20873 ["Clock cancel" org-clock-cancel t]
20874 "--"
20875 ["Mark as default task" org-clock-mark-default-task t]
20876 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20877 ["Goto running clock" org-clock-goto t]
20878 "--"
20879 ["Display times" org-clock-display t]
20880 ["Create clock table" org-clock-report t]
20881 "--"
20882 ["Record DONE time"
20883 (progn (setq org-log-done (not org-log-done))
20884 (message "Switching to %s will %s record a timestamp"
20885 (car org-done-keywords)
20886 (if org-log-done "automatically" "not")))
20887 :style toggle :selected org-log-done])
20888 "--"
20889 ["Agenda Command..." org-agenda t]
20890 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20891 ("File List for Agenda")
20892 ("Special views current file"
20893 ["TODO Tree" org-show-todo-tree t]
20894 ["Check Deadlines" org-check-deadlines t]
20895 ["Timeline" org-timeline t]
20896 ["Tags/Property tree" org-match-sparse-tree t])
20897 "--"
20898 ["Export/Publish..." org-export-dispatch t]
20899 ("LaTeX"
20900 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20901 :selected org-cdlatex-mode]
20902 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20903 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20904 ["Modify math symbol" org-cdlatex-math-modify
20905 (org-inside-LaTeX-fragment-p)]
20906 ["Insert citation" org-reftex-citation t]
20907 "--"
20908 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20909 "--"
20910 ("MobileOrg"
20911 ["Push Files and Views" org-mobile-push t]
20912 ["Get Captured and Flagged" org-mobile-pull t]
20913 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20914 "--"
20915 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20916 "--"
20917 ("Documentation"
20918 ["Show Version" org-version t]
20919 ["Info Documentation" org-info t])
20920 ("Customize"
20921 ["Browse Org Group" org-customize t]
20922 "--"
20923 ["Expand This Menu" org-create-customize-menu
20924 (fboundp 'customize-menu-create)])
20925 ["Send bug report" org-submit-bug-report t]
20926 "--"
20927 ("Refresh/Reload"
20928 ["Refresh setup current buffer" org-mode-restart t]
20929 ["Reload Org (after update)" org-reload t]
20930 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20931 ))
20933 (defun org-info (&optional node)
20934 "Read documentation for Org-mode in the info system.
20935 With optional NODE, go directly to that node."
20936 (interactive)
20937 (info (format "(org)%s" (or node ""))))
20939 ;;;###autoload
20940 (defun org-submit-bug-report ()
20941 "Submit a bug report on Org-mode via mail.
20943 Don't hesitate to report any problems or inaccurate documentation.
20945 If you don't have setup sending mail from (X)Emacs, please copy the
20946 output buffer into your mail program, as it gives us important
20947 information about your Org-mode version and configuration."
20948 (interactive)
20949 (require 'reporter)
20950 (org-load-modules-maybe)
20951 (org-require-autoloaded-modules)
20952 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20953 (reporter-submit-bug-report
20954 "emacs-orgmode@gnu.org"
20955 (org-version nil 'full)
20956 (let (list)
20957 (save-window-excursion
20958 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20959 (delete-other-windows)
20960 (erase-buffer)
20961 (insert "You are about to submit a bug report to the Org-mode mailing list.
20963 We would like to add your full Org-mode and Outline configuration to the
20964 bug report. This greatly simplifies the work of the maintainer and
20965 other experts on the mailing list.
20967 HOWEVER, some variables you have customized may contain private
20968 information. The names of customers, colleagues, or friends, might
20969 appear in the form of file names, tags, todo states, or search strings.
20970 If you answer yes to the prompt, you might want to check and remove
20971 such private information before sending the email.")
20972 (add-text-properties (point-min) (point-max) '(face org-warning))
20973 (when (yes-or-no-p "Include your Org-mode configuration ")
20974 (mapatoms
20975 (lambda (v)
20976 (and (boundp v)
20978 (or (and (symbol-value v)
20980 (and
20981 (get v 'custom-type) (get v 'standard-value)
20982 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20983 (push v list)))))
20984 (kill-buffer (get-buffer "*Warn about privacy*"))
20985 list))
20986 nil nil
20987 "Remember to cover the basics, that is, what you expected to happen and
20988 what in fact did happen. You don't know how to make a good report? See
20990 http://orgmode.org/manual/Feedback.html#Feedback
20992 Your bug report will be posted to the Org-mode mailing list.
20993 ------------------------------------------------------------------------")
20994 (save-excursion
20999 (defun org-install-agenda-files-menu ()
21000 (let ((bl (buffer-list)))
21001 (save-excursion
21002 (while bl
21003 (set-buffer (pop bl))
21004 (if (derived-mode-p 'org-mode) (setq bl nil)))
21005 (when (derived-mode-p 'org-mode)
21006 (easy-menu-change
21007 '("Org") "File List for Agenda"
21008 (append
21009 (list
21010 ["Edit File List" (org-edit-agenda-file-list) t]
21011 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21012 ["Remove Current File from List" org-remove-file t]
21013 ["Cycle through agenda files" org-cycle-agenda-files t]
21014 ["Occur in all agenda files" org-occur-in-agenda-files t]
21015 "--")
21016 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21018 ;;;; Documentation
21020 (defun org-require-autoloaded-modules ()
21021 (interactive)
21022 (mapc 'require
21023 '(org-agenda org-archive org-attach org-clock org-colview org-id
21024 org-remember org-table org-timer)))
21026 ;;;###autoload
21027 (defun org-reload (&optional uncompiled)
21028 "Reload all org lisp files.
21029 With prefix arg UNCOMPILED, load the uncompiled versions."
21030 (interactive "P")
21031 (require 'loadhist)
21032 (let* ((org-dir (org-find-library-dir "org"))
21033 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21035 (remove-re (mapconcat 'identity
21036 (mapcar (lambda (f) (concat "^" f "$"))
21037 (list (if (featurep 'xemacs)
21038 "org-colview"
21039 "org-colview-xemacs")
21040 "org" "org-loaddefs" "org-version"))
21042 (feats (delete-dups
21043 (mapcar 'file-name-sans-extension
21044 (mapcar 'file-name-nondirectory
21045 (delq nil
21046 (mapcar 'feature-file
21047 features))))))
21048 (lfeat (append
21049 (sort
21050 (setq feats
21051 (delq nil (mapcar
21052 (lambda (f)
21053 (if (and (string-match feature-re f)
21054 (not (string-match remove-re f)))
21055 f nil))
21056 feats)))
21057 'string-lessp)
21058 (list "org-version" "org")))
21059 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21060 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21061 load-uncore load-misses)
21062 (setq load-misses
21063 (delq 't
21064 (mapcar (lambda (f)
21065 (or (org-load-noerror-mustsuffix (concat org-dir f))
21066 (and (string= org-dir contrib-dir)
21067 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21068 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21069 (add-to-list 'load-uncore f 'append)
21070 't)
21071 f))
21072 lfeat)))
21073 (if load-uncore
21075 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21076 (if load-misses
21078 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21081 ;;;###autoload
21082 (defun org-customize ()
21083 "Call the customize function with org as argument."
21084 (interactive)
21085 (org-load-modules-maybe)
21086 (org-require-autoloaded-modules)
21087 (customize-browse 'org))
21089 (defun org-create-customize-menu ()
21090 "Create a full customization menu for Org-mode, insert it into the menu."
21091 (interactive)
21092 (org-load-modules-maybe)
21093 (org-require-autoloaded-modules)
21094 (if (fboundp 'customize-menu-create)
21095 (progn
21096 (easy-menu-change
21097 '("Org") "Customize"
21098 `(["Browse Org group" org-customize t]
21099 "--"
21100 ,(customize-menu-create 'org)
21101 ["Set" Custom-set t]
21102 ["Save" Custom-save t]
21103 ["Reset to Current" Custom-reset-current t]
21104 ["Reset to Saved" Custom-reset-saved t]
21105 ["Reset to Standard Settings" Custom-reset-standard t]))
21107 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21109 ;;;; Miscellaneous stuff
21111 ;;; Generally useful functions
21113 (defun org-get-at-bol (property)
21114 "Get text property PROPERTY at beginning of line."
21115 (get-text-property (point-at-bol) property))
21117 (defun org-find-text-property-in-string (prop s)
21118 "Return the first non-nil value of property PROP in string S."
21119 (or (get-text-property 0 prop s)
21120 (get-text-property (or (next-single-property-change 0 prop s) 0)
21121 prop s)))
21123 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21124 "Display the given MESSAGE as a warning."
21125 (if (fboundp 'display-warning)
21126 (display-warning 'org message
21127 (if (featurep 'xemacs) 'warning :warning))
21128 (let ((buf (get-buffer-create "*Org warnings*")))
21129 (with-current-buffer buf
21130 (goto-char (point-max))
21131 (insert "Warning (Org): " message)
21132 (unless (bolp)
21133 (newline)))
21134 (display-buffer buf)
21135 (sit-for 0))))
21137 (defun org-eval (form)
21138 "Eval FORM and return result."
21139 (condition-case error
21140 (eval form)
21141 (error (format "%%![Error: %s]" error))))
21143 (defun org-in-clocktable-p ()
21144 "Check if the cursor is in a clocktable."
21145 (let ((pos (point)) start)
21146 (save-excursion
21147 (end-of-line 1)
21149 (setq start (match-beginning 0))
21151 (>= (match-end 0) pos)
21152 start))))
21154 (defun org-in-commented-line ()
21155 "Is point in a line starting with `#'?"
21156 (equal (char-after (point-at-bol)) ?#))
21158 (defun org-in-indented-comment-line ()
21159 "Is point in a line starting with `#' after some white space?"
21160 (save-excursion
21161 (save-match-data
21162 (goto-char (point-at-bol))
21165 (defun org-in-verbatim-emphasis ()
21166 (save-match-data
21167 (and (org-in-regexp org-emph-re 2)
21168 (>= (point) (match-beginning 3))
21169 (<= (point) (match-end 4))
21170 (member (match-string 3) '("=" "~")))))
21172 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21173 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21174 (if (and marker (marker-buffer marker)
21175 (buffer-live-p (marker-buffer marker)))
21176 (progn
21177 (org-pop-to-buffer-same-window (marker-buffer marker))
21178 (if (or (> marker (point-max)) (< marker (point-min)))
21179 (widen))
21180 (goto-char marker)
21181 (org-show-context 'org-goto))
21182 (if bookmark
21183 (bookmark-jump bookmark)
21184 (error "Cannot find location"))))
21186 (defun org-quote-csv-field (s)
21187 "Quote field for inclusion in CSV material."
21190 s))
21192 (defun org-force-self-insert (N)
21193 "Needed to enforce self-insert under remapping."
21194 (interactive "p")
21195 (self-insert-command N))
21197 (defun org-string-width (s)
21198 "Compute width of string, ignoring invisible characters.
21199 This ignores character with invisibility property `org-link', and also
21200 characters with property `org-cwidth', because these will become invisible
21201 upon the next fontification round."
21202 (let (b l)
21203 (when (or (eq t buffer-invisibility-spec)
21204 (assq 'org-link buffer-invisibility-spec))
21205 (while (setq b (text-property-any 0 (length s)
21206 'invisible 'org-link s))
21207 (setq s (concat (substring s 0 b)
21208 (substring s (or (next-single-property-change
21209 b 'invisible s) (length s)))))))
21210 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21211 (setq s (concat (substring s 0 b)
21212 (substring s (or (next-single-property-change
21213 b 'org-cwidth s) (length s))))))
21214 (setq l (string-width s) b -1)
21215 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21216 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21217 l))
21219 (defun org-shorten-string (s maxlength)
21220 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21221 If the string is shorter or has length MAXLENGTH, just return the
21222 original string. If it is longer, the functions finds a space in the
21223 string, breaks this string off at that locations and adds three dots
21224 as ellipsis. Including the ellipsis, the string will not be longer
21225 than MAXLENGTH. If finding a good breaking point in the string does
21226 not work, the string is just chopped off in the middle of a word
21227 if necessary."
21228 (if (<= (length s) maxlength)
21229 s
21230 (let* ((n (max (- maxlength 4) 1))
21232 (if (string-match re s)
21233 (concat (match-string 1 s) "...")
21234 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21236 (defun org-get-indentation (&optional line)
21237 "Get the indentation of the current line, interpreting tabs.
21238 When LINE is given, assume it represents a line and compute its indentation."
21239 (if line
21240 (if (string-match "^ *" (org-remove-tabs line))
21241 (match-end 0))
21242 (save-excursion
21243 (beginning-of-line 1)
21245 (current-column))))
21247 (defun org-get-string-indentation (s)
21248 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21249 (let ((n -1) (i 0) (w tab-width) c)
21250 (catch 'exit
21251 (while (< (setq n (1+ n)) (length s))
21252 (setq c (aref s n))
21253 (cond ((= c ?\ ) (setq i (1+ i)))
21255 (t (throw 'exit t)))))
21256 i))
21258 (defun org-remove-tabs (s &optional width)
21259 "Replace tabulators in S with spaces.
21260 Assumes that s is a single line, starting in column 0."
21261 (setq width (or width tab-width))
21263 (setq s (replace-match
21264 (make-string
21265 (- (* width (/ (+ (match-beginning 0) width) width))
21266 (match-beginning 0)) ?\ )
21267 t t s)))
21268 s)
21270 (defun org-fix-indentation (line ind)
21271 "Fix indentation in LINE.
21272 IND is a cons cell with target and minimum indentation.
21273 If the current indentation in LINE is smaller than the minimum,
21274 leave it alone. If it is larger than ind, set it to the target."
21275 (let* ((l (org-remove-tabs line))
21276 (i (org-get-indentation l))
21277 (i1 (car ind)) (i2 (cdr ind)))
21278 (if (>= i i2) (setq l (substring line i2)))
21279 (if (> i1 0)
21280 (concat (make-string i1 ?\ ) l)
21281 l)))
21283 (defun org-remove-indentation (code &optional n)
21284 "Remove the maximum common indentation from the lines in CODE.
21285 N may optionally be the number of spaces to remove."
21286 (with-temp-buffer
21287 (insert code)
21288 (org-do-remove-indentation n)
21289 (buffer-string)))
21291 (defun org-do-remove-indentation (&optional n)
21292 "Remove the maximum common indentation from the buffer."
21293 (untabify (point-min) (point-max))
21294 (let ((min 10000) re)
21295 (if n
21296 (setq min n)
21297 (goto-char (point-min))
21299 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21300 (unless (or (= min 0) (= min 10000))
21302 (goto-char (point-min))
21303 (while (re-search-forward re nil t)
21304 (replace-match "")
21305 (end-of-line 1))
21306 min)))
21308 (defun org-fill-template (template alist)
21309 "Find each %key of ALIST in TEMPLATE and replace it."
21310 (let ((case-fold-search nil)
21311 entry key value)
21312 (setq alist (sort (copy-sequence alist)
21313 (lambda (a b) (< (length (car a)) (length (car b))))))
21314 (while (setq entry (pop alist))
21315 (setq template
21316 (replace-regexp-in-string
21317 (concat "%" (regexp-quote (car entry)))
21318 (or (cdr entry) "") template t t)))
21319 template))
21321 (defun org-base-buffer (buffer)
21322 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21323 (if (not buffer)
21324 buffer
21325 (or (buffer-base-buffer buffer)
21326 buffer)))
21328 (defun org-trim (s)
21329 "Remove whitespace at beginning and end of string."
21332 s)
21334 (defun org-wrap (string &optional width lines)
21335 "Wrap string to either a number of lines, or a width in characters.
21336 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21337 that costs. If there is a word longer than WIDTH, the text is actually
21338 wrapped to the length of that word.
21339 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21340 many lines, whatever width that takes.
21341 The return value is a list of lines, without newlines at the end."
21343 (maxword (apply 'max (mapcar 'org-string-width words)))
21344 w ll)
21345 (cond (width
21346 (org-do-wrap words (max maxword width)))
21347 (lines
21348 (setq w maxword)
21349 (setq ll (org-do-wrap words maxword))
21350 (if (<= (length ll) lines)
21351 ll
21352 (setq ll words)
21353 (while (> (length ll) lines)
21354 (setq w (1+ w))
21355 (setq ll (org-do-wrap words w)))
21356 ll))
21357 (t (error "Cannot wrap this")))))
21359 (defun org-do-wrap (words width)
21360 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21361 (let (lines line)
21362 (while words
21363 (setq line (pop words))
21364 (while (and words (< (+ (length line) (length (car words))) width))
21365 (setq line (concat line " " (pop words))))
21366 (setq lines (push line lines)))
21367 (nreverse lines)))
21369 (defun org-split-string (string &optional separators)
21370 "Splits STRING into substrings at SEPARATORS.
21371 No empty strings are returned if there are matches at the beginning
21372 and end of string."
21374 (start 0)
21375 notfirst
21376 (list nil))
21377 (while (and (string-match rexp string
21378 (if (and notfirst
21379 (= start (match-beginning 0))
21380 (< start (length string)))
21381 (1+ start) start))
21382 (< (match-beginning 0) (length string)))
21383 (setq notfirst t)
21384 (or (eq (match-beginning 0) 0)
21385 (and (eq (match-beginning 0) (match-end 0))
21386 (eq (match-beginning 0) start))
21387 (setq list
21388 (cons (substring string start (match-beginning 0))
21389 list)))
21390 (setq start (match-end 0)))
21391 (or (eq start (length string))
21392 (setq list
21393 (cons (substring string start)
21394 list)))
21395 (nreverse list)))
21397 (defun org-quote-vert (s)
21399 (while (string-match "|" s)
21401 s)
21403 (defun org-uuidgen-p (s)
21404 "Is S an ID created by UUIDGEN?"
21405 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21407 (defun org-in-src-block-p (&optional inside)
21408 "Whether point is in a code source block.
21409 When INSIDE is non-nil, don't consider we are within a src block
21410 when point is at #+BEGIN_SRC or #+END_SRC."
21411 (let ((case-fold-search t) ov)
21412 (or (and (setq ov (overlays-at (point)))
21413 (memq 'org-block-background
21414 (overlay-properties (car ov))))
21415 (and (not inside)
21416 (save-match-data
21417 (save-excursion
21418 (beginning-of-line)
21421 (defun org-context ()
21422 "Return a list of contexts of the current cursor position.
21423 If several contexts apply, all are returned.
21424 Each context entry is a list with a symbol naming the context, and
21425 two positions indicating start and end of the context. Possible
21426 contexts are:
21428 :headline anywhere in a headline
21429 :headline-stars on the leading stars in a headline
21430 :todo-keyword on a TODO keyword (including DONE) in a headline
21431 :tags on the TAGS in a headline
21432 :priority on the priority cookie in a headline
21433 :item on the first line of a plain list item
21434 :item-bullet on the bullet/number of a plain list item
21435 :checkbox on the checkbox in a plain list item
21436 :table in an org-mode table
21437 :table-special on a special filed in a table
21438 :table-table in a table.el table
21439 :clocktable in a clocktable
21440 :src-block in a source block
21441 :link on a hyperlink
21442 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21443 :target on a <<target>>
21444 :radio-target on a <<<radio-target>>>
21445 :latex-fragment on a LaTeX fragment
21446 :latex-preview on a LaTeX fragment with overlaid preview image
21448 This function expects the position to be visible because it uses font-lock
21449 faces as a help to recognize the following contexts: :table-special, :link,
21450 and :keyword."
21451 (let* ((f (get-text-property (point) 'face))
21452 (faces (if (listp f) f (list f)))
21453 (case-fold-search t)
21454 (p (point)) clist o)
21455 ;; First the large context
21456 (cond
21457 ((org-at-heading-p t)
21458 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21459 (when (progn
21460 (beginning-of-line 1)
21461 (looking-at org-todo-line-tags-regexp))
21462 (push (org-point-in-group p 1 :headline-stars) clist)
21463 (push (org-point-in-group p 2 :todo-keyword) clist)
21464 (push (org-point-in-group p 4 :tags) clist))
21465 (goto-char p)
21468 (push (org-point-in-group p 0 :priority) clist)))
21470 ((org-at-item-p)
21471 (push (org-point-in-group p 2 :item-bullet) clist)
21472 (push (list :item (point-at-bol)
21473 (save-excursion (org-end-of-item) (point)))
21474 clist)
21475 (and (org-at-item-checkbox-p)
21476 (push (org-point-in-group p 0 :checkbox) clist)))
21478 ((org-at-table-p)
21479 (push (list :table (org-table-begin) (org-table-end)) clist)
21480 (if (memq 'org-formula faces)
21481 (push (list :table-special
21482 (previous-single-property-change p 'face)
21483 (next-single-property-change p 'face)) clist)))
21484 ((org-at-table-p 'any)
21485 (push (list :table-table) clist)))
21486 (goto-char p)
21488 (let ((case-fold-search t))
21489 ;; New the "medium" contexts: clocktables, source blocks
21490 (cond ((org-in-clocktable-p)
21491 (push (list :clocktable
21493 (search-backward "#+BEGIN: clocktable" nil t))
21494 (match-beginning 0))
21496 (match-end 0))) clist))
21497 ((org-in-src-block-p)
21498 (push (list :src-block
21500 (search-backward "#+BEGIN_SRC" nil t))
21501 (match-beginning 0))
21502 (and (search-forward "#+END_SRC" nil t)
21503 (match-beginning 0))) clist))))
21504 (goto-char p)
21506 ;; Now the small context
21507 (cond
21508 ((org-at-timestamp-p)
21509 (push (org-point-in-group p 0 :timestamp) clist))
21510 ((memq 'org-link faces)
21511 (push (list :link
21512 (previous-single-property-change p 'face)
21513 (next-single-property-change p 'face)) clist))
21514 ((memq 'org-special-keyword faces)
21515 (push (list :keyword
21516 (previous-single-property-change p 'face)
21517 (next-single-property-change p 'face)) clist))
21518 ((org-at-target-p)
21519 (push (org-point-in-group p 0 :target) clist)
21520 (goto-char (1- (match-beginning 0)))
21521 (if (looking-at org-radio-target-regexp)
21522 (push (org-point-in-group p 0 :radio-target) clist))
21523 (goto-char p))
21524 ((setq o (car (delq nil
21525 (mapcar
21526 (lambda (x)
21527 (if (memq x org-latex-fragment-image-overlays) x))
21528 (overlays-at (point))))))
21529 (push (list :latex-fragment
21530 (overlay-start o) (overlay-end o)) clist)
21531 (push (list :latex-preview
21532 (overlay-start o) (overlay-end o)) clist))
21533 ((org-inside-LaTeX-fragment-p)
21534 ;; FIXME: positions wrong.
21535 (push (list :latex-fragment (point) (point)) clist)))
21537 (setq clist (nreverse (delq nil clist)))
21538 clist))
21540 ;; FIXME: Compare with at-regexp-p Do we need both?
21541 (defun org-in-regexp (re &optional nlines visually)
21542 "Check if point is inside a match of regexp.
21543 Normally only the current line is checked, but you can include NLINES extra
21544 lines both before and after point into the search.
21545 If VISUALLY is set, require that the cursor is not after the match but
21546 really on, so that the block visually is on the match."
21547 (catch 'exit
21548 (let ((pos (point))
21549 (eol (point-at-eol (+ 1 (or nlines 0))))
21550 (inc (if visually 1 0)))
21551 (save-excursion
21552 (beginning-of-line (- 1 (or nlines 0)))
21553 (while (re-search-forward re eol t)
21554 (if (and (<= (match-beginning 0) pos)
21555 (>= (+ inc (match-end 0)) pos))
21556 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21558 (defun org-at-regexp-p (regexp)
21559 "Is point inside a match of REGEXP in the current line?"
21560 (catch 'exit
21561 (save-excursion
21562 (let ((pos (point)) (end (point-at-eol)))
21563 (beginning-of-line 1)
21564 (while (re-search-forward regexp end t)
21565 (if (and (<= (match-beginning 0) pos)
21566 (>= (match-end 0) pos))
21567 (throw 'exit t)))
21568 nil))))
21570 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21571 "Non-nil when point is between matches of START-RE and END-RE.
21573 Also return a non-nil value when point is on one of the matches.
21575 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21576 buffer positions. Default values are the positions of headlines
21577 surrounding the point.
21579 The functions returns a cons cell whose car (resp. cdr) is the
21580 position before START-RE (resp. after END-RE)."
21581 (save-match-data
21582 (let ((pos (point))
21583 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21584 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21585 beg end)
21586 (save-excursion
21587 ;; Point is on a block when on START-RE or if START-RE can be
21588 ;; found before it...
21589 (and (or (org-at-regexp-p start-re)
21590 (re-search-backward start-re limit-up t))
21591 (setq beg (match-beginning 0))
21592 ;; ... and END-RE after it...
21593 (goto-char (match-end 0))
21594 (re-search-forward end-re limit-down t)
21595 (> (setq end (match-end 0)) pos)
21596 ;; ... without another START-RE in-between.
21597 (goto-char (match-beginning 0))
21598 (not (re-search-backward start-re (1+ beg) t))
21599 ;; Return value.
21600 (cons beg end))))))
21602 (defun org-in-block-p (names)
21603 "Non-nil when point belongs to a block whose name belongs to NAMES.
21605 NAMES is a list of strings containing names of blocks.
21607 Return first block name matched, or nil. Beware that in case of
21608 nested blocks, the returned name may not belong to the closest
21609 block from point."
21610 (save-match-data
21611 (catch 'exit
21612 (let ((case-fold-search t)
21613 (lim-up (save-excursion (outline-previous-heading)))
21614 (lim-down (save-excursion (outline-next-heading))))
21615 (mapc (lambda (name)
21616 (let ((n (regexp-quote name)))
21617 (when (org-between-regexps-p
21620 lim-up lim-down)
21621 (throw 'exit n))))
21622 names))
21623 nil)))
21625 (defun org-in-drawer-p ()
21626 "Is point within a drawer?"
21627 (save-match-data
21628 (let ((case-fold-search t)
21629 (lim-up (save-excursion (outline-previous-heading)))
21630 (lim-down (save-excursion (outline-next-heading))))
21631 (org-between-regexps-p
21634 lim-up lim-down))))
21636 (defun org-occur-in-agenda-files (regexp &optional nlines)
21637 "Call `multi-occur' with buffers for all agenda files."
21639 (let* ((files (org-agenda-files))
21640 (tnames (mapcar 'file-truename files))
21641 (extra org-agenda-text-search-extra-files)
21642 f)
21643 (when (eq (car extra) 'agenda-archives)
21644 (setq extra (cdr extra))
21645 (setq files (org-add-archive-files files)))
21646 (while (setq f (pop extra))
21647 (unless (member (file-truename f) tnames)
21648 (add-to-list 'files f 'append)
21649 (add-to-list 'tnames (file-truename f) 'append)))
21650 (multi-occur
21651 (mapcar (lambda (x)
21652 (with-current-buffer
21653 (or (get-file-buffer x) (find-file-noselect x))
21654 (widen)
21655 (current-buffer)))
21656 files)
21657 regexp)))
21659 (if (boundp 'occur-mode-find-occurrence-hook)
21660 ;; Emacs 23
21661 (add-hook 'occur-mode-find-occurrence-hook
21662 (lambda ()
21663 (when (derived-mode-p 'org-mode)
21664 (org-reveal))))
21665 ;; Emacs 22
21666 (defadvice occur-mode-goto-occurrence
21667 (after org-occur-reveal activate)
21668 (and (derived-mode-p 'org-mode) (org-reveal)))
21669 (defadvice occur-mode-goto-occurrence-other-window
21670 (after org-occur-reveal activate)
21671 (and (derived-mode-p 'org-mode) (org-reveal)))
21672 (defadvice occur-mode-display-occurrence
21673 (after org-occur-reveal activate)
21674 (when (derived-mode-p 'org-mode)
21675 (let ((pos (occur-mode-find-occurrence)))
21676 (with-current-buffer (marker-buffer pos)
21677 (save-excursion
21678 (goto-char pos)
21679 (org-reveal)))))))
21681 (defun org-occur-link-in-agenda-files ()
21682 "Create a link and search for it in the agendas.
21683 The link is not stored in `org-stored-links', it is just created
21684 for the search purpose."
21685 (interactive)
21686 (let ((link (condition-case nil
21687 (org-store-link nil)
21688 (error "Unable to create a link to here"))))
21689 (org-occur-in-agenda-files (regexp-quote link))))
21691 (defun org-reverse-string (string)
21692 "Return the reverse of STRING."
21693 (apply 'string (reverse (string-to-list string))))
21695 (defsubst org-uniquify (list)
21696 "Non-destructively remove duplicate elements from LIST."
21697 (let ((res (copy-sequence list))) (delete-dups res)))
21699 (defun org-uniquify-alist (alist)
21700 "Merge elements of ALIST with the same key.
21702 For example, in this alist:
21704 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21705 => '((a 1 3) (b 2))
21707 merge (a 1) and (a 3) into (a 1 3).
21709 The function returns the new ALIST."
21710 (let (rtn)
21711 (mapc
21712 (lambda (e)
21713 (let (n)
21714 (if (not (assoc (car e) rtn))
21715 (push e rtn)
21716 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21717 (setq rtn (assq-delete-all (car e) rtn))
21718 (push n rtn))))
21719 alist)
21720 rtn))
21722 (defun org-delete-all (elts list)
21723 "Remove all elements in ELTS from LIST."
21724 (while elts
21725 (setq list (delete (pop elts) list)))
21726 list)
21728 (defun org-count (cl-item cl-seq)
21729 "Count the number of occurrences of ITEM in SEQ.
21730 Taken from `count' in cl-seq.el with all keyword arguments removed."
21731 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21732 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21733 (while (< cl-start cl-end)
21734 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21735 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21736 (setq cl-start (1+ cl-start)))
21737 cl-count))
21739 (defun org-remove-if (predicate seq)
21740 "Remove everything from SEQ that fulfills PREDICATE."
21741 (let (res e)
21742 (while seq
21743 (setq e (pop seq))
21744 (if (not (funcall predicate e)) (push e res)))
21745 (nreverse res)))
21747 (defun org-remove-if-not (predicate seq)
21748 "Remove everything from SEQ that does not fulfill PREDICATE."
21749 (let (res e)
21750 (while seq
21751 (setq e (pop seq))
21752 (if (funcall predicate e) (push e res)))
21753 (nreverse res)))
21755 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21756 "Reduce two-argument FUNCTION across SEQ.
21757 Taken from `reduce' in cl-seq.el with all keyword arguments but
21759 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21760 (cadr (memq :initial-value cl-keys)))
21761 (cl-seq (pop cl-seq))
21762 (t (funcall cl-func)))))
21763 (while cl-seq
21764 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21765 cl-accum))
21767 (defun org-every (pred seq)
21768 "Return true if PREDICATE is true of every element of SEQ.
21769 Adapted from `every' in cl.el."
21770 (catch 'org-every
21771 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21772 t))
21774 (defun org-some (pred seq)
21775 "Return true if PREDICATE is true of any element of SEQ.
21776 Adapted from `some' in cl.el."
21777 (catch 'org-some
21778 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21779 nil))
21781 (defun org-back-over-empty-lines ()
21782 "Move backwards over whitespace, to the beginning of the first empty line.
21783 Returns the number of empty lines passed."
21784 (let ((pos (point)))
21785 (if (cdr (assoc 'heading org-blank-before-new-entry))
21787 (unless (eobp)
21788 (forward-line -1)))
21789 (beginning-of-line 2)
21790 (goto-char (min (point) pos))
21791 (count-lines (point) pos)))
21793 (defun org-skip-whitespace ()
21796 (defun org-point-in-group (point group &optional context)
21797 "Check if POINT is in match-group GROUP.
21798 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21799 match. If the match group does not exist or point is not inside it,
21800 return nil."
21801 (and (match-beginning group)
21802 (>= point (match-beginning group))
21803 (<= point (match-end group))
21804 (if context
21805 (list context (match-beginning group) (match-end group))
21806 t)))
21808 (defun org-switch-to-buffer-other-window (&rest args)
21809 "Switch to buffer in a second window on the current frame.
21810 In particular, do not allow pop-up frames.
21811 Returns the newly created buffer."
21812 (org-no-popups
21813 (apply 'switch-to-buffer-other-window args)))
21815 (defun org-combine-plists (&rest plists)
21816 "Create a single property list from all plists in PLISTS.
21817 The process starts by copying the first list, and then setting properties
21818 from the other lists. Settings in the last list are the most significant
21819 ones and overrule settings in the other lists."
21820 (let ((rtn (copy-sequence (pop plists)))
21821 p v ls)
21822 (while plists
21823 (setq ls (pop plists))
21824 (while ls
21825 (setq p (pop ls) v (pop ls))
21826 (setq rtn (plist-put rtn p v))))
21827 rtn))
21829 (defun org-replace-escapes (string table)
21830 "Replace %-escapes in STRING with values in TABLE.
21832 The sequences in STRING may contain normal field width and padding information,
21834 so values can contain further %-escapes if they are define later in TABLE."
21835 (let ((tbl (copy-alist table))
21836 (case-fold-search nil)
21837 (pchg 0)
21838 e re rpl)
21839 (while (setq e (pop tbl))
21840 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21841 (when (and (cdr e) (string-match re (cdr e)))
21842 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21843 (safe "SREF"))
21844 (add-text-properties 0 3 (list 'sref sref) safe)
21845 (setcdr e (replace-match safe t t (cdr e)))))
21846 (while (string-match re string)
21847 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21848 (cdr e)))
21849 (setq string (replace-match rpl t t string))))
21850 (while (setq pchg (next-property-change pchg string))
21851 (let ((sref (get-text-property pchg 'sref string)))
21852 (when (and sref (string-match "SREF" string pchg))
21853 (setq string (replace-match sref t t string)))))
21854 string))
21856 (defun org-sublist (list start end)
21857 "Return a section of LIST, from START to END.
21858 Counting starts at 1."
21859 (let (rtn (c start))
21860 (setq list (nthcdr (1- start) list))
21861 (while (and list (<= c end))
21862 (push (pop list) rtn)
21863 (setq c (1+ c)))
21864 (nreverse rtn)))
21866 (defun org-find-base-buffer-visiting (file)
21867 "Like `find-buffer-visiting' but always return the base buffer and
21868 not an indirect buffer."
21869 (let ((buf (or (get-file-buffer file)
21870 (find-buffer-visiting file))))
21871 (if buf
21872 (or (buffer-base-buffer buf) buf)
21873 nil)))
21875 (defun org-image-file-name-regexp (&optional extensions)
21876 "Return regexp matching the file names of images.
21877 If EXTENSIONS is given, only match these."
21878 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21879 (image-file-name-regexp)
21880 (let ((image-file-name-extensions
21881 (or extensions
21882 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21883 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21885 (regexp-opt (nconc (mapcar 'upcase
21886 image-file-name-extensions)
21887 image-file-name-extensions)
21888 t)
21891 (defun org-file-image-p (file &optional extensions)
21892 "Return non-nil if FILE is an image."
21893 (save-match-data
21894 (string-match (org-image-file-name-regexp extensions) file)))
21896 (defun org-get-cursor-date (&optional with-time)
21897 "Return the date at cursor in as a time.
21898 This works in the calendar and in the agenda, anywhere else it just
21899 returns the current time.
21900 If WITH-TIME is non-nil, returns the time of the event at point (in
21901 the agenda) or the current time of the day."
21902 (let (date day defd tp tm hod mod)
21903 (when with-time
21904 (setq tp (get-text-property (point) 'time))
21906 (setq hod (string-to-number (match-string 1 tp))
21907 mod (string-to-number (match-string 2 tp))))
21908 (or tp (setq hod (nth 2 (decode-time (current-time)))
21909 mod (nth 1 (decode-time (current-time))))))
21910 (cond
21911 ((eq major-mode 'calendar-mode)
21912 (setq date (calendar-cursor-to-date)
21913 defd (encode-time 0 (or mod 0) (or hod 0)
21914 (nth 1 date) (nth 0 date) (nth 2 date))))
21915 ((eq major-mode 'org-agenda-mode)
21916 (setq day (get-text-property (point) 'day))
21917 (if day
21918 (setq date (calendar-gregorian-from-absolute day)
21919 defd (encode-time 0 (or mod 0) (or hod 0)
21920 (nth 1 date) (nth 0 date) (nth 2 date))))))
21921 (or defd (current-time))))
21923 (defun org-mark-subtree (&optional up)
21924 "Mark the current subtree.
21925 This puts point at the start of the current subtree, and mark at
21926 the end. If a numeric prefix UP is given, move up into the
21927 hierarchy of headlines by UP levels before marking the subtree."
21928 (interactive "P")
21929 (org-with-limited-levels
21930 (cond ((org-at-heading-p) (beginning-of-line))
21931 ((org-before-first-heading-p) (user-error "Not in a subtree"))
21932 (t (outline-previous-visible-heading 1))))
21933 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21934 (if (org-called-interactively-p 'any)
21935 (call-interactively 'org-mark-element)
21936 (org-mark-element)))
21939 ;;; Indentation
21941 (defun org-indent-line ()
21942 "Indent line depending on context."
21943 (interactive)
21944 (let* ((pos (point))
21945 (itemp (org-at-item-p))
21946 (case-fold-search t)
21948 (inline-task-p (and (featurep 'org-inlinetask)
21949 (org-inlinetask-in-task-p)))
21950 (inline-re (and inline-task-p
21951 (org-inlinetask-outline-regexp)))
21952 column)
21953 (if (and orgstruct-is-++ (eq pos (point)))
21954 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21955 (indent-according-to-mode))
21956 (beginning-of-line 1)
21957 (cond
21958 ;; Headings
21959 ((looking-at org-outline-regexp) (setq column 0))
21960 ;; Footnote definition
21961 ((looking-at org-footnote-definition-re) (setq column 0))
21962 ;; Literal examples
21964 (setq column (org-get-indentation))) ; do nothing
21965 ;; Lists
21966 ((ignore-errors (goto-char (org-in-item-p)))
21967 (setq column (if itemp
21968 (org-get-indentation)
21969 (org-list-item-body-column (point))))
21970 (goto-char pos))
21971 ;; Drawers
21973 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21974 (save-excursion
21975 (goto-char (1- (match-beginning 1)))
21976 (setq column (current-column))))
21977 ;; Special blocks
21979 (save-excursion
21980 (re-search-backward
21982 (setq column (org-get-indentation (match-string 0))))
21985 (save-excursion
21987 (setq column
21988 (cond ((equal (downcase (match-string 1)) "src")
21989 ;; src blocks: let `org-edit-src-exit' handle them
21990 (org-get-indentation))
21991 ((equal (downcase (match-string 1)) "example")
21992 (max (org-get-indentation)
21993 (org-get-indentation (match-string 0))))
21994 (t
21995 (org-get-indentation (match-string 0))))))
21996 ;; This line has nothing special, look at the previous relevant
21997 ;; line to compute indentation
21998 (t
21999 (beginning-of-line 0)
22000 (while (and (not (bobp))
22001 (not (looking-at org-table-line-regexp))
22002 (not (looking-at org-drawer-regexp))
22003 ;; When point started in an inline task, do not move
22004 ;; above task starting line.
22005 (not (and inline-task-p (looking-at inline-re)))
22006 ;; Skip drawers, blocks, empty lines, verbatim,
22007 ;; comments, tables, footnotes definitions, lists,
22008 ;; inline tasks.
22010 (re-search-backward org-drawer-regexp nil t))
22014 (looking-at org-footnote-definition-re)
22015 (and (not inline-task-p)
22016 (featurep 'org-inlinetask)
22017 (org-inlinetask-in-task-p)
22018 (or (org-inlinetask-goto-beginning) t))))
22019 (beginning-of-line 0))
22020 (cond
22021 ;; There was a list item above.
22022 ((ignore-errors (goto-char (org-in-item-p)))
22023 (goto-char (org-list-get-top-point (org-list-struct)))
22024 (setq column (org-get-indentation)))
22025 ;; There was an heading above.
22027 (if (not org-adapt-indentation)
22028 (setq column 0)
22029 (goto-char (match-end 0))
22030 (setq column (current-column))))
22031 ;; A drawer had started and is unfinished
22032 ((looking-at org-drawer-regexp)
22033 (goto-char (1- (match-beginning 1)))
22034 (setq column (current-column)))
22035 ;; Else, nothing noticeable found: get indentation and go on.
22036 (t (setq column (org-get-indentation))))))
22037 ;; Now apply indentation and move cursor accordingly
22038 (goto-char pos)
22039 (if (<= (current-column) (current-indentation))
22040 (org-indent-line-to column)
22041 (save-excursion (org-indent-line-to column)))
22042 ;; Special polishing for properties, see `org-property-format'
22043 (setq column (current-column))
22044 (beginning-of-line 1)
22045 (if (looking-at org-property-re)
22046 (replace-match (concat (match-string 4)
22047 (format org-property-format
22048 (match-string 1) (match-string 3)))
22049 t t))
22050 (org-move-to-column column))))
22052 (defun org-indent-drawer ()
22053 "Indent the drawer at point."
22054 (interactive)
22055 (let ((p (point))
22056 (e (and (save-excursion (re-search-forward ":END:" nil t))
22057 (match-end 0)))
22058 (folded
22059 (save-excursion
22060 (end-of-line)
22061 (when (overlays-at (point))
22062 (member 'invisible (overlay-properties
22063 (car (overlays-at (point)))))))))
22064 (when folded (org-cycle))
22065 (indent-for-tab-command)
22066 (while (and (move-beginning-of-line 2) (< (point) e))
22067 (indent-for-tab-command))
22068 (goto-char p)
22069 (when folded (org-cycle)))
22070 (message "Drawer at point indented"))
22072 (defun org-indent-block ()
22073 "Indent the block at point."
22074 (interactive)
22075 (let ((p (point))
22076 (case-fold-search t)
22078 (match-end 0)))
22079 (folded
22080 (save-excursion
22081 (end-of-line)
22082 (when (overlays-at (point))
22083 (member 'invisible (overlay-properties
22084 (car (overlays-at (point)))))))))
22085 (when folded (org-cycle))
22086 (indent-for-tab-command)
22087 (while (and (move-beginning-of-line 2) (< (point) e))
22088 (indent-for-tab-command))
22089 (goto-char p)
22090 (when folded (org-cycle)))
22091 (message "Block at point indented"))
22093 (defun org-indent-region (start end)
22094 "Indent region."
22095 (interactive "r")
22096 (save-excursion
22097 (let ((line-end (org-current-line end)))
22098 (goto-char start)
22099 (while (< (org-current-line) line-end)
22100 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
22101 (t (call-interactively 'org-indent-line)))
22102 (move-beginning-of-line 2)))))
22105 ;;; Filling
22107 ;; We use our own fill-paragraph and auto-fill functions.
22109 ;; `org-fill-paragraph' relies on adaptive filling and context
22110 ;; checking. Appropriate `fill-prefix' is computed with
22111 ;; `org-adaptive-fill-function'.
22113 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22114 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22115 ;; `org-adaptive-fill-function' value. Internally,
22116 ;; `org-comment-line-break-function' breaks the line.
22118 ;; `org-setup-filling' installs filling and auto-filling related
22119 ;; variables during `org-mode' initialization.
22121 (defvar org-element-paragraph-separate) ; org-element.el
22122 (defun org-setup-filling ()
22123 (require 'org-element)
22124 ;; Prevent auto-fill from inserting unwanted new items.
22125 (when (boundp 'fill-nobreak-predicate)
22126 (org-set-local
22127 'fill-nobreak-predicate
22128 (org-uniquify
22129 (append fill-nobreak-predicate
22130 '(org-fill-line-break-nobreak-p
22131 org-fill-paragraph-with-timestamp-nobreak-p)))))
22132 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22133 (org-set-local 'paragraph-start paragraph-ending)
22134 (org-set-local 'paragraph-separate paragraph-ending))
22135 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22136 (org-set-local 'auto-fill-inhibit-regexp nil)
22137 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22138 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22139 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22141 (defun org-fill-line-break-nobreak-p ()
22142 "Non-nil when a new line at point would create an Org line break."
22143 (save-excursion
22148 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22149 "Non-nil when a new line at point would split a timestamp."
22150 (and (org-at-timestamp-p t)
22151 (not (looking-at org-ts-regexp-both))))
22153 (declare-function message-in-body-p "message" ())
22154 (defvar orgtbl-line-start-regexp) ; From org-table.el
22155 (defun org-adaptive-fill-function ()
22156 "Compute a fill prefix for the current line.
22157 Return fill prefix, as a string, or nil if current line isn't
22158 meant to be filled. For convenience, if `adaptive-fill-regexp'
22159 matches in paragraphs or comments, use it."
22160 (let (prefix)
22161 (catch 'exit
22162 (when (derived-mode-p 'message-mode)
22163 (save-excursion
22164 (beginning-of-line)
22165 (cond ((or (not (message-in-body-p))
22166 (looking-at orgtbl-line-start-regexp))
22167 (throw 'exit nil))
22168 ((looking-at message-cite-prefix-regexp)
22169 (throw 'exit (match-string-no-properties 0)))
22170 ((looking-at org-outline-regexp)
22171 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22172 (org-with-wide-buffer
22173 (let* ((p (line-beginning-position))
22174 (element (save-excursion
22175 (beginning-of-line)
22176 (or (ignore-errors (org-element-at-point))
22177 (user-error "An element cannot be parsed line %d"
22178 (line-number-at-pos (point))))))
22179 (type (org-element-type element))
22180 (post-affiliated (org-element-property :post-affiliated element)))
22181 (unless (and post-affiliated (< p post-affiliated))
22182 (case type
22183 (comment
22184 (save-excursion
22185 (beginning-of-line)
22187 (goto-char (match-end 0))
22188 (let ((comment-prefix (match-string 0)))
22189 (if (looking-at adaptive-fill-regexp)
22190 (concat comment-prefix (match-string 0))
22191 comment-prefix))))
22192 (footnote-definition "")
22193 ((item plain-list)
22194 (make-string (org-list-item-body-column
22195 (or post-affiliated
22196 (org-element-property :begin element)))
22197 ? ))
22198 (paragraph
22199 ;; Fill prefix is usually the same as the current line,
22200 ;; unless the paragraph is at the beginning of an item.
22201 (let ((parent (org-element-property :parent element)))
22202 (save-excursion
22203 (beginning-of-line)
22204 (cond ((eq (org-element-type parent) 'item)
22205 (make-string (org-list-item-body-column
22206 (org-element-property :begin parent))
22207 ? ))
22208 ((looking-at adaptive-fill-regexp) (match-string 0))
22210 (t "")))))
22211 (comment-block
22212 ;; Only fill contents if P is within block boundaries.
22213 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22214 (forward-line)
22215 (point)))
22216 (cend (save-excursion
22217 (goto-char (org-element-property :end element))
22219 (line-beginning-position))))
22220 (when (and (>= p cbeg) (< p cend))
22222 (match-string 0)
22223 "")))))))))))
22225 (declare-function message-goto-body "message" ())
22226 (defvar message-cite-prefix-regexp) ; From message.el
22227 (defun org-fill-paragraph (&optional justify)
22228 "Fill element at point, when applicable.
22230 This function only applies to comment blocks, comments, example
22231 blocks and paragraphs. Also, as a special case, re-align table
22232 when point is at one.
22234 If JUSTIFY is non-nil (interactively, with prefix argument),
22235 justify as well. If `sentence-end-double-space' is non-nil, then
22236 period followed by one space does not end a sentence, so don't
22237 break a line there. The variable `fill-column' controls the
22238 width for filling.
22240 For convenience, when point is at a plain list, an item or
22241 a footnote definition, try to fill the first paragraph within."
22242 (interactive)
22243 (if (and (derived-mode-p 'message-mode)
22244 (or (not (message-in-body-p))
22245 (save-excursion (move-beginning-of-line 1)
22246 (looking-at message-cite-prefix-regexp))))
22247 ;; First ensure filling is correct in message-mode.
22248 (let ((fill-paragraph-function
22249 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22250 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22251 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22252 (paragraph-separate
22253 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22254 (fill-paragraph nil))
22255 (with-syntax-table org-mode-transpose-word-syntax-table
22256 ;; Move to end of line in order to get the first paragraph
22257 ;; within a plain list or a footnote definition.
22258 (let ((element (save-excursion
22259 (end-of-line)
22260 (or (ignore-errors (org-element-at-point))
22261 (user-error "An element cannot be parsed line %d"
22262 (line-number-at-pos (point)))))))
22263 ;; First check if point is in a blank line at the beginning of
22264 ;; the buffer. In that case, ignore filling.
22265 (case (org-element-type element)
22266 ;; Use major mode filling function is src blocks.
22267 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22268 ;; Align Org tables, leave table.el tables as-is.
22269 (table-row (org-table-align) t)
22270 (table
22271 (when (eq (org-element-property :type element) 'org)
22272 (save-excursion
22273 (goto-char (org-element-property :post-affiliated element))
22274 (org-table-align)))
22275 t)
22276 (paragraph
22277 ;; Paragraphs may contain `line-break' type objects.
22278 (let ((beg (max (point-min)
22279 (org-element-property :contents-begin element)))
22280 (end (min (point-max)
22281 (org-element-property :contents-end element))))
22282 ;; Do nothing if point is at an affiliated keyword.
22283 (if (< (line-end-position) beg) t
22284 (when (derived-mode-p 'message-mode)
22285 ;; In `message-mode', do not fill following citation
22286 ;; in current paragraph nor text before message body.
22287 (let ((body-start (save-excursion (message-goto-body))))
22288 (when body-start (setq beg (max body-start beg))))
22289 (when (save-excursion
22290 (re-search-forward
22291 (concat "^" message-cite-prefix-regexp) end t))
22292 (setq end (match-beginning 0))))
22293 ;; Fill paragraph, taking line breaks into account.
22294 ;; For that, slice the paragraph using line breaks as
22295 ;; separators, and fill the parts in reverse order to
22296 ;; avoid messing with markers.
22297 (save-excursion
22298 (goto-char end)
22299 (mapc
22300 (lambda (pos)
22301 (fill-region-as-paragraph pos (point) justify)
22302 (goto-char pos))
22303 ;; Find the list of ending positions for line breaks
22304 ;; in the current paragraph. Add paragraph
22305 ;; beginning to include first slice.
22306 (nreverse
22307 (cons beg
22308 (org-element-map
22309 (org-element--parse-objects
22310 beg end nil (org-element-restriction 'paragraph))
22311 'line-break
22312 (lambda (lb) (org-element-property :end lb)))))))
22313 t)))
22314 ;; Contents of `comment-block' type elements should be
22315 ;; filled as plain text, but only if point is within block
22316 ;; markers.
22317 (comment-block
22318 (let* ((case-fold-search t)
22319 (beg (save-excursion
22320 (goto-char (org-element-property :begin element))
22322 (forward-line)
22323 (point)))
22324 (end (save-excursion
22325 (goto-char (org-element-property :end element))
22327 (line-beginning-position))))
22328 (if (or (< (point) beg) (> (point) end)) t
22329 (fill-region-as-paragraph
22330 (save-excursion (end-of-line)
22332 (line-beginning-position))
22333 (save-excursion (beginning-of-line)
22335 (line-beginning-position))
22336 justify))))
22337 ;; Fill comments.
22338 (comment
22339 (let ((begin (org-element-property :post-affiliated element))
22340 (end (org-element-property :end element)))
22341 (when (and (>= (point) begin) (<= (point) end))
22342 (let ((begin (save-excursion
22343 (end-of-line)
22345 (progn (forward-line) (point))
22346 begin)))
22347 (end (save-excursion
22348 (end-of-line)
22350 (1- (line-beginning-position))
22352 (line-end-position)))))
22353 ;; Do not fill comments when at a blank line.
22354 (when (> end begin)
22355 (let ((fill-prefix
22356 (save-excursion
22357 (beginning-of-line)
22359 (let ((comment-prefix (match-string 0)))
22360 (goto-char (match-end 0))
22361 (if (looking-at adaptive-fill-regexp)
22362 (concat comment-prefix (match-string 0))
22363 (concat comment-prefix " "))))))
22364 (save-excursion
22365 (fill-region-as-paragraph begin end justify))))))
22366 t))
22367 ;; Ignore every other element.
22368 (otherwise t))))))
22370 (defun org-auto-fill-function ()
22371 "Auto-fill function."
22372 ;; Check if auto-filling is meaningful.
22373 (let ((fc (current-fill-column)))
22374 (when (and fc (> (current-column) fc))
22375 (let* ((fill-prefix (org-adaptive-fill-function))
22376 ;; Enforce empty fill prefix, if required. Otherwise, it
22377 ;; will be computed again.
22378 (adaptive-fill-mode (not (equal fill-prefix ""))))
22379 (when fill-prefix (do-auto-fill))))))
22381 (defun org-comment-line-break-function (&optional soft)
22382 "Break line at point and indent, continuing comment if within one.
22383 The inserted newline is marked hard if variable
22384 `use-hard-newlines' is true, unless optional argument SOFT is
22385 non-nil."
22387 (save-excursion (forward-char -1) (delete-horizontal-space))
22388 (delete-horizontal-space)
22389 (indent-to-left-margin)
22390 (insert-before-markers-and-inherit fill-prefix))
22393 ;;; Comments
22395 ;; Org comments syntax is quite complex. It requires the entire line
22396 ;; to be just a comment. Also, even with the right syntax at the
22397 ;; beginning of line, some some elements (i.e. verse-block or
22398 ;; example-block) don't accept comments. Usual Emacs comment commands
22399 ;; cannot cope with those requirements. Therefore, Org replaces them.
22401 ;; Org still relies on `comment-dwim', but cannot trust
22402 ;; `comment-only-p'. So, `comment-region-function' and
22403 ;; `uncomment-region-function' both point
22404 ;; to`org-comment-or-uncomment-region'. Eventually,
22405 ;; `org-insert-comment' takes care of insertion of comments at the
22406 ;; beginning of line.
22408 ;; `org-setup-comments-handling' install comments related variables
22409 ;; during `org-mode' initialization.
22411 (defun org-setup-comments-handling ()
22412 (interactive)
22413 (org-set-local 'comment-use-syntax nil)
22414 (org-set-local 'comment-start "# ")
22416 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22417 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22418 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22420 (defun org-insert-comment ()
22421 "Insert an empty comment above current line.
22422 If the line is empty, insert comment at its beginning."
22423 (beginning-of-line)
22425 (org-indent-line)
22426 (insert "# "))
22428 (defvar comment-empty-lines) ; From newcomment.el.
22429 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22430 "Comment or uncomment each non-blank line in the region.
22431 Uncomment each non-blank line between BEG and END if it only
22432 contains commented lines. Otherwise, comment them."
22433 (save-restriction
22434 ;; Restrict region
22435 (narrow-to-region (save-excursion (goto-char beg)
22437 (line-beginning-position))
22438 (save-excursion (goto-char end)
22440 (line-end-position)))
22441 (let ((uncommentp
22442 ;; UNCOMMENTP is non-nil when every non blank line between
22443 ;; BEG and END is a comment.
22444 (save-excursion
22445 (goto-char (point-min))
22446 (while (and (not (eobp))
22447 (let ((element (org-element-at-point)))
22448 (and (eq (org-element-type element) 'comment)
22449 (goto-char (min (point-max)
22450 (org-element-property
22451 :end element)))))))
22452 (eobp))))
22453 (if uncommentp
22454 ;; Only blank lines and comments in region: uncomment it.
22455 (save-excursion
22456 (goto-char (point-min))
22457 (while (not (eobp))
22459 (replace-match "" nil nil nil 1))
22460 (forward-line)))
22461 ;; Comment each line in region.
22462 (let ((min-indent (point-max)))
22463 ;; First find the minimum indentation across all lines.
22464 (save-excursion
22465 (goto-char (point-min))
22466 (while (and (not (eobp)) (not (zerop min-indent)))
22468 (setq min-indent (min min-indent (current-indentation))))
22469 (forward-line)))
22470 ;; Then loop over all lines.
22471 (save-excursion
22472 (goto-char (point-min))
22473 (while (not (eobp))
22475 ;; Don't get fooled by invisible text (e.g. link path)
22476 ;; when moving to column MIN-INDENT.
22477 (let ((buffer-invisibility-spec nil))
22478 (org-move-to-column min-indent t))
22479 (insert comment-start))
22480 (forward-line))))))))
22483 ;;; Planning
22485 ;; This section contains tools to operate on timestamp objects, as
22486 ;; returned by, e.g. `org-element-context'.
22488 (defun org-timestamp-has-time-p (timestamp)
22489 "Non-nil when TIMESTAMP has a time specified."
22490 (org-element-property :hour-start timestamp))
22492 (defun org-timestamp-format (timestamp format &optional end utc)
22493 "Format a TIMESTAMP element into a string.
22495 FORMAT is a format specifier to be passed to
22496 `format-time-string'.
22498 When optional argument END is non-nil, use end of date-range or
22499 time-range, if possible.
22501 When optional argument UTC is non-nil, time will be expressed as
22502 Universal Time."
22503 (format-time-string
22504 format
22505 (apply 'encode-time
22506 (cons 0
22507 (mapcar
22508 (lambda (prop) (or (org-element-property prop timestamp) 0))
22509 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22510 '(:minute-start :hour-start :day-start :month-start
22511 :year-start)))))
22512 utc))
22514 (defun org-timestamp-split-range (timestamp &optional end)
22515 "Extract a timestamp object from a date or time range.
22517 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22518 the end of the range. Otherwise, extract its start.
22520 Return a new timestamp object sharing the same parent as
22521 TIMESTAMP."
22522 (let ((type (org-element-property :type timestamp)))
22523 (if (memq type '(active inactive diary)) timestamp
22524 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22525 ;; Set new type.
22526 (org-element-put-property
22527 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22528 ;; Copy start properties over end properties if END is
22529 ;; non-nil. Otherwise, copy end properties over `start' ones.
22530 (let ((p-alist '((:minute-start . :minute-end)
22531 (:hour-start . :hour-end)
22532 (:day-start . :day-end)
22533 (:month-start . :month-end)
22534 (:year-start . :year-end))))
22535 (dolist (p-cell p-alist)
22536 (org-element-put-property
22537 split-ts
22538 (funcall (if end 'car 'cdr) p-cell)
22539 (org-element-property
22540 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22541 ;; Eventually refresh `:raw-value'.
22542 (org-element-put-property split-ts :raw-value nil)
22543 (org-element-put-property
22544 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22546 (defun org-timestamp-translate (timestamp &optional boundary)
22547 "Apply `org-translate-time' on a TIMESTAMP object.
22548 When optional argument BOUNDARY is non-nil, it is either the
22549 symbol `start' or `end'. In this case, only translate the
22550 starting or ending part of TIMESTAMP if it is a date or time
22551 range. Otherwise, translate both parts."
22552 (if (and (not boundary)
22553 (memq (org-element-property :type timestamp)
22554 '(active-range inactive-range)))
22555 (concat
22556 (org-translate-time
22557 (org-element-property :raw-value
22558 (org-timestamp-split-range timestamp)))
22559 "--"
22560 (org-translate-time
22561 (org-element-property :raw-value
22562 (org-timestamp-split-range timestamp t))))
22563 (org-translate-time
22564 (org-element-property
22565 :raw-value
22566 (if (not boundary) timestamp
22567 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22571 ;;; Other stuff.
22573 (defun org-toggle-fixed-width-section (arg)
22574 "Toggle the fixed-width export.
22575 If there is no active region, the QUOTE keyword at the current headline is
22576 inserted or removed. When present, it causes the text between this headline
22577 and the next to be exported as fixed-width text, and unmodified.
22578 If there is an active region, this command adds or removes a colon as the
22579 first character of this line. If the first character of a line is a colon,
22580 this line is also exported in fixed-width font."
22581 (interactive "P")
22582 (let* ((cc 0)
22583 (regionp (org-region-active-p))
22584 (beg (if regionp (region-beginning) (point)))
22585 (end (if regionp (region-end)))
22586 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22587 (case-fold-search nil)
22589 off)
22590 (if regionp
22591 (save-excursion
22592 (goto-char beg)
22593 (setq cc (current-column))
22594 (beginning-of-line 1)
22595 (setq off (looking-at re))
22596 (while (> nlines 0)
22597 (setq nlines (1- nlines))
22598 (beginning-of-line 1)
22599 (cond
22600 (arg
22601 (org-move-to-column cc t)
22603 (forward-line -1))
22604 ((and off (looking-at re))
22605 (replace-match "" t t nil 1))
22606 ((not off) (org-move-to-column cc t) (insert ": ")))
22607 (forward-line 1)))
22608 (save-excursion
22609 (org-back-to-heading)
22610 (cond
22611 ((looking-at (format org-heading-keyword-regexp-format
22612 org-quote-string))
22613 (goto-char (match-end 1))
22614 (looking-at (concat " +" org-quote-string))
22615 (replace-match "" t t)
22616 (when (eolp) (insert " ")))
22617 ((looking-at org-outline-regexp)
22618 (goto-char (match-end 0))
22619 (insert org-quote-string " ")))))))
22621 (defun org-reftex-citation ()
22622 "Use reftex-citation to insert a citation into the buffer.
22623 This looks for a line like
22625 #+BIBLIOGRAPHY: foo plain option:-d
22627 and derives from it that foo.bib is the bibliography file relevant
22628 for this document. It then installs the necessary environment for RefTeX
22629 to work in this buffer and calls `reftex-citation' to insert a citation
22630 into the buffer.
22632 Export of such citations to both LaTeX and HTML is handled by the contributed
22633 package ox-bibtex by Taru Karttunen."
22634 (interactive)
22635 (let ((reftex-docstruct-symbol 'rds)
22637 rds bib)
22638 (save-excursion
22639 (save-restriction
22640 (widen)
22641 (let ((case-fold-search t)
22643 (if (not (save-excursion
22644 (or (re-search-forward re nil t)
22645 (re-search-backward re nil t))))
22646 (error "No bibliography defined in file")
22647 (setq bib (concat (match-string 1) ".bib")
22648 rds (list (list 'bib bib)))))))
22649 (call-interactively 'reftex-citation)))
22651 ;;;; Functions extending outline functionality
22653 (defun org-beginning-of-line (&optional arg)
22654 "Go to the beginning of the current line. If that is invisible, continue
22655 to a visible line beginning. This makes the function of C-a more intuitive.
22656 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22657 first attempt, and only move to after the tags when the cursor is already
22658 beyond the end of the headline."
22659 (interactive "P")
22660 (let ((pos (point))
22661 (special (if (consp org-special-ctrl-a/e)
22662 (car org-special-ctrl-a/e)
22663 org-special-ctrl-a/e))
22664 refpos)
22665 (if (org-bound-and-true-p visual-line-mode)
22666 (beginning-of-visual-line 1)
22667 (beginning-of-line 1))
22668 (if (and arg (fboundp 'move-beginning-of-line))
22669 (call-interactively 'move-beginning-of-line)
22670 (if (bobp)
22671 nil
22672 (backward-char 1)
22673 (if (org-truely-invisible-p)
22674 (while (and (not (bobp)) (org-truely-invisible-p))
22675 (backward-char 1)
22676 (beginning-of-line 1))
22677 (forward-char 1))))
22678 (when special
22679 (cond
22680 ((and (looking-at org-complex-heading-regexp)
22681 (= (char-after (match-end 1)) ?\ ))
22682 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22683 (point-at-eol)))
22684 (goto-char
22685 (if (eq special t)
22686 (cond ((> pos refpos) refpos)
22687 ((= pos (point)) refpos)
22688 (t (point)))
22689 (cond ((> pos (point)) (point))
22690 ((not (eq last-command this-command)) (point))
22691 (t refpos)))))
22692 ((org-at-item-p)
22693 ;; Being at an item and not looking at an the item means point
22694 ;; was previously moved to beginning of a visual line, which
22695 ;; doesn't contain the item. Therefore, do nothing special,
22696 ;; just stay here.
22697 (when (looking-at org-list-full-item-re)
22698 ;; Set special position at first white space character after
22699 ;; bullet, and check-box, if any.
22700 (let ((after-bullet
22701 (let ((box (match-end 3)))
22702 (if (not box) (match-end 1)
22703 (let ((after (char-after box)))
22704 (if (and after (= after ? )) (1+ box) box))))))
22705 ;; Special case: Move point to special position when
22706 ;; currently after it or at beginning of line.
22707 (if (eq special t)
22708 (when (or (> pos after-bullet) (= (point) pos))
22709 (goto-char after-bullet))
22710 ;; Reversed case: Move point to special position when
22711 ;; point was already at beginning of line and command is
22712 ;; repeated.
22713 (when (and (= (point) pos) (eq last-command this-command))
22714 (goto-char after-bullet))))))))
22715 (org-no-warnings
22716 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22717 (setq disable-point-adjustment
22718 (or (not (invisible-p (point)))
22719 (not (invisible-p (max (point-min) (1- (point))))))))
22721 (defun org-end-of-line (&optional arg)
22722 "Go to the end of the line.
22723 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22724 tags on the first attempt, and only move to after the tags when
22725 the cursor is already beyond the end of the headline."
22726 (interactive "P")
22727 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22728 org-special-ctrl-a/e))
22729 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22730 'end-of-visual-line)
22731 ((fboundp 'move-end-of-line) 'move-end-of-line)
22732 (t 'end-of-line))))
22733 (if (or (not special) arg) (call-interactively move-fun)
22734 (let* ((element (save-excursion (beginning-of-line)
22735 (org-element-at-point)))
22736 (type (org-element-type element)))
22737 (cond
22738 ((memq type '(headline inlinetask))
22739 (let ((pos (point)))
22740 (beginning-of-line 1)
22742 (if (eq special t)
22743 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22744 (goto-char (match-beginning 1))
22745 (goto-char (match-end 0)))
22746 (if (or (< pos (match-end 0))
22747 (not (eq this-command last-command)))
22748 (goto-char (match-end 0))
22749 (goto-char (match-beginning 1))))
22750 (call-interactively move-fun))))
22751 ((org-element-property :hiddenp element)
22752 ;; If element is hidden, `move-end-of-line' would put point
22753 ;; after it. Use `end-of-line' to stay on current line.
22754 (call-interactively 'end-of-line))
22755 (t (call-interactively move-fun)))))
22756 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22757 (setq disable-point-adjustment
22758 (or (not (invisible-p (point)))
22759 (not (invisible-p (max (point-min) (1- (point))))))))
22761 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22762 (define-key org-mode-map "\C-e" 'org-end-of-line)
22764 (defun org-backward-sentence (&optional arg)
22765 "Go to beginning of sentence, or beginning of table field.
22766 This will call `backward-sentence' or `org-table-beginning-of-field',
22767 depending on context."
22768 (interactive "P")
22769 (cond
22770 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22771 (t (call-interactively 'backward-sentence))))
22773 (defun org-forward-sentence (&optional arg)
22774 "Go to end of sentence, or end of table field.
22775 This will call `forward-sentence' or `org-table-end-of-field',
22776 depending on context."
22777 (interactive "P")
22778 (cond
22779 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22780 (t (call-interactively 'forward-sentence))))
22782 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22783 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22785 (defun org-kill-line (&optional arg)
22786 "Kill line, to tags or end of line."
22787 (interactive "P")
22788 (cond
22789 ((or (not org-special-ctrl-k)
22790 (bolp)
22791 (not (org-at-heading-p)))
22792 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22793 org-ctrl-k-protect-subtree)
22794 (if (or (eq org-ctrl-k-protect-subtree 'error)
22795 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22796 (user-error "C-k aborted as it would kill a hidden subtree")))
22797 (call-interactively
22798 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22800 (kill-region (point) (match-beginning 1))
22801 (org-set-tags nil t))
22802 (t (kill-region (point) (point-at-eol)))))
22804 (define-key org-mode-map "\C-k" 'org-kill-line)
22806 (defun org-yank (&optional arg)
22807 "Yank. If the kill is a subtree, treat it specially.
22808 This command will look at the current kill and check if is a single
22809 subtree, or a series of subtrees[1]. If it passes the test, and if the
22810 cursor is at the beginning of a line or after the stars of a currently
22811 empty headline, then the yank is handled specially. How exactly depends
22812 on the value of the following variables, both set by default.
22814 org-yank-folded-subtrees
22815 When set, the subtree(s) will be folded after insertion, but only
22816 if doing so would now swallow text after the yanked text.
22818 org-yank-adjusted-subtrees
22819 When set, the subtree will be promoted or demoted in order to
22820 fit into the local outline tree structure, which means that the level
22821 will be adjusted so that it becomes the smaller one of the two
22822 *visible* surrounding headings.
22824 Any prefix to this command will cause `yank' to be called directly with
22826 will just
22827 plainly yank the text as it is.
22829 \[1] The test checks if the first non-white line is a heading
22830 and if there are no other headings with fewer stars."
22831 (interactive "P")
22832 (org-yank-generic 'yank arg))
22834 (defun org-yank-generic (command arg)
22835 "Perform some yank-like command.
22837 This function implements the behavior described in the `org-yank'
22838 documentation. However, it has been generalized to work for any
22839 interactive command with similar behavior."
22841 ;; pretend to be command COMMAND
22842 (setq this-command command)
22844 (if arg
22845 (call-interactively command)
22847 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22848 (and (org-kill-is-subtree-p)
22849 (or (bolp)
22851 (string-match
22853 (buffer-substring (point-at-bol) (point)))))))
22854 swallowp)
22855 (cond
22856 ((and subtreep org-yank-folded-subtrees)
22857 (let ((beg (point))
22858 end)
22859 (if (and subtreep org-yank-adjusted-subtrees)
22860 (org-paste-subtree nil nil 'for-yank)
22861 (call-interactively command))
22863 (setq end (point))
22864 (goto-char beg)
22865 (when (and (bolp) subtreep
22866 (not (setq swallowp
22867 (org-yank-folding-would-swallow-text beg end))))
22868 (org-with-limited-levels
22869 (or (looking-at org-outline-regexp)
22870 (re-search-forward org-outline-regexp-bol end t))
22871 (while (and (< (point) end) (looking-at org-outline-regexp))
22872 (hide-subtree)
22873 (org-cycle-show-empty-lines 'folded)
22874 (condition-case nil
22875 (outline-forward-same-level 1)
22876 (error (goto-char end))))))
22877 (when swallowp
22878 (message
22879 "Inserted text not folded because that would swallow text"))
22881 (goto-char end)
22883 (beginning-of-line 1)
22884 (push-mark beg 'nomsg)))
22885 ((and subtreep org-yank-adjusted-subtrees)
22886 (let ((beg (point-at-bol)))
22887 (org-paste-subtree nil nil 'for-yank)
22888 (push-mark beg 'nomsg)))
22889 (t
22890 (call-interactively command))))))
22892 (defun org-yank-folding-would-swallow-text (beg end)
22893 "Would hide-subtree at BEG swallow any text after END?"
22894 (let (level)
22895 (org-with-limited-levels
22896 (save-excursion
22897 (goto-char beg)
22898 (when (or (looking-at org-outline-regexp)
22899 (re-search-forward org-outline-regexp-bol end t))
22900 (setq level (org-outline-level)))
22901 (goto-char end)
22903 (if (or (eobp)
22904 (and (bolp) (looking-at org-outline-regexp)
22905 (<= (org-outline-level) level)))
22906 nil ; Nothing would be swallowed
22907 t))))) ; something would swallow
22909 (define-key org-mode-map "\C-y" 'org-yank)
22911 (defun org-truely-invisible-p ()
22912 "Check if point is at a character currently not visible.
22913 This version does not only check the character property, but also
22914 `visible-mode'."
22915 ;; Early versions of noutline don't have `outline-invisible-p'.
22916 (if (org-bound-and-true-p visible-mode)
22917 nil
22918 (outline-invisible-p)))
22920 (defun org-invisible-p2 ()
22921 "Check if point is at a character currently not visible."
22922 (save-excursion
22923 (if (and (eolp) (not (bobp))) (backward-char 1))
22924 ;; Early versions of noutline don't have `outline-invisible-p'.
22925 (outline-invisible-p)))
22927 (defun org-back-to-heading (&optional invisible-ok)
22928 "Call `outline-back-to-heading', but provide a better error message."
22929 (condition-case nil
22930 (outline-back-to-heading invisible-ok)
22931 (error (error "Before first headline at position %d in buffer %s"
22932 (point) (current-buffer)))))
22934 (defun org-before-first-heading-p ()
22935 "Before first heading?"
22936 (save-excursion
22937 (end-of-line)
22938 (null (re-search-backward org-outline-regexp-bol nil t))))
22940 (defun org-at-heading-p (&optional ignored)
22941 (outline-on-heading-p t))
22942 ;; Compatibility alias with Org versions < 7.8.03
22943 (defalias 'org-on-heading-p 'org-at-heading-p)
22945 (defun org-at-comment-p nil
22946 "Is cursor in a line starting with a # character?"
22947 (save-excursion
22948 (beginning-of-line)
22949 (looking-at "^#")))
22951 (defun org-at-drawer-p nil
22952 "Is cursor at a drawer keyword?"
22953 (save-excursion
22954 (move-beginning-of-line 1)
22955 (looking-at org-drawer-regexp)))
22957 (defun org-at-block-p nil
22958 "Is cursor at a block keyword?"
22959 (save-excursion
22960 (move-beginning-of-line 1)
22961 (looking-at org-block-regexp)))
22963 (defun org-point-at-end-of-empty-headline ()
22964 "If point is at the end of an empty headline, return t, else nil.
22965 If the heading only contains a TODO keyword, it is still still considered
22966 empty."
22968 (when org-todo-line-regexp
22969 (save-excursion
22970 (beginning-of-line 1)
22971 (let ((case-fold-search nil))
22972 (looking-at org-todo-line-regexp)
22973 (string= (match-string 3) ""))))))
22975 (defun org-at-heading-or-item-p ()
22976 (or (org-at-heading-p) (org-at-item-p)))
22978 (defun org-at-target-p ()
22979 (or (org-in-regexp org-radio-target-regexp)
22980 (org-in-regexp org-target-regexp)))
22981 ;; Compatibility alias with Org versions < 7.8.03
22982 (defalias 'org-on-target-p 'org-at-target-p)
22984 (defun org-up-heading-all (arg)
22985 "Move to the heading line of which the present line is a subheading.
22986 This function considers both visible and invisible heading lines.
22987 With argument, move up ARG levels."
22988 (if (fboundp 'outline-up-heading-all)
22989 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22990 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22992 (defun org-up-heading-safe ()
22993 "Move to the heading line of which the present line is a subheading.
22994 This version will not throw an error. It will return the level of the
22995 headline found, or nil if no higher level is found.
22997 Also, this function will be a lot faster than `outline-up-heading',
22998 because it relies on stars being the outline starters. This can really
22999 make a significant difference in outlines with very many siblings."
23000 (let (start-level re)
23001 (org-back-to-heading t)
23002 (setq start-level (funcall outline-level))
23003 (if (equal start-level 1)
23004 nil
23006 (if (re-search-backward re nil t)
23007 (funcall outline-level)))))
23009 (defun org-first-sibling-p ()
23010 "Is this heading the first child of its parents?"
23011 (interactive)
23012 (let ((re org-outline-regexp-bol)
23013 level l)
23014 (unless (org-at-heading-p t)
23015 (user-error "Not at a heading"))
23016 (setq level (funcall outline-level))
23017 (save-excursion
23018 (if (not (re-search-backward re nil t))
23019 t
23020 (setq l (funcall outline-level))
23021 (< l level)))))
23023 (defun org-goto-sibling (&optional previous)
23024 "Goto the next sibling, even if it is invisible.
23025 When PREVIOUS is set, go to the previous sibling instead. Returns t
23026 when a sibling was found. When none is found, return nil and don't
23027 move point."
23028 (let ((fun (if previous 're-search-backward 're-search-forward))
23029 (pos (point))
23030 (re org-outline-regexp-bol)
23031 level l)
23032 (when (condition-case nil (org-back-to-heading t) (error nil))
23033 (setq level (funcall outline-level))
23034 (catch 'exit
23035 (or previous (forward-char 1))
23036 (while (funcall fun re nil t)
23037 (setq l (funcall outline-level))
23038 (when (< l level) (goto-char pos) (throw 'exit nil))
23039 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23040 (goto-char pos)
23041 nil))))
23043 (defun org-show-siblings ()
23044 "Show all siblings of the current headline."
23045 (save-excursion
23046 (while (org-goto-sibling) (org-flag-heading nil)))
23047 (save-excursion
23048 (while (org-goto-sibling 'previous)
23049 (org-flag-heading nil))))
23051 (defun org-goto-first-child ()
23052 "Goto the first child, even if it is invisible.
23053 Return t when a child was found. Otherwise don't move point and
23054 return nil."
23055 (let (level (pos (point)) (re org-outline-regexp-bol))
23056 (when (condition-case nil (org-back-to-heading t) (error nil))
23057 (setq level (outline-level))
23058 (forward-char 1)
23059 (if (and (re-search-forward re nil t) (> (outline-level) level))
23060 (progn (goto-char (match-beginning 0)) t)
23061 (goto-char pos) nil))))
23063 (defun org-show-hidden-entry ()
23064 "Show an entry where even the heading is hidden."
23065 (save-excursion
23066 (org-show-entry)))
23068 (defun org-flag-heading (flag &optional entry)
23069 "Flag the current heading. FLAG non-nil means make invisible.
23070 When ENTRY is non-nil, show the entire entry."
23071 (save-excursion
23072 (org-back-to-heading t)
23073 ;; Check if we should show the entire entry
23074 (if entry
23075 (progn
23076 (org-show-entry)
23077 (save-excursion
23078 (and (outline-next-heading)
23079 (org-flag-heading nil))))
23080 (outline-flag-region (max (point-min) (1- (point)))
23081 (save-excursion (outline-end-of-heading) (point))
23082 flag))))
23084 (defun org-get-next-sibling ()
23085 "Move to next heading of the same level, and return point.
23086 If there is no such heading, return nil.
23087 This is like outline-next-sibling, but invisible headings are ok."
23088 (let ((level (funcall outline-level)))
23089 (outline-next-heading)
23090 (while (and (not (eobp)) (> (funcall outline-level) level))
23091 (outline-next-heading))
23092 (if (or (eobp) (< (funcall outline-level) level))
23093 nil
23094 (point))))
23096 (defun org-get-last-sibling ()
23097 "Move to previous heading of the same level, and return point.
23098 If there is no such heading, return nil."
23099 (let ((opoint (point))
23100 (level (funcall outline-level)))
23101 (outline-previous-heading)
23102 (when (and (/= (point) opoint) (outline-on-heading-p t))
23103 (while (and (> (funcall outline-level) level)
23104 (not (bobp)))
23105 (outline-previous-heading))
23106 (if (< (funcall outline-level) level)
23107 nil
23108 (point)))))
23110 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23111 "Goto to the end of a subtree."
23112 ;; This contains an exact copy of the original function, but it uses
23113 ;; `org-back-to-heading', to make it work also in invisible
23114 ;; trees. And is uses an invisible-ok argument.
23115 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23116 ;; Furthermore, when used inside Org, finding the end of a large subtree
23117 ;; with many children and grandchildren etc, this can be much faster
23118 ;; than the outline version.
23119 (org-back-to-heading invisible-ok)
23120 (let ((first t)
23121 (level (funcall outline-level)))
23122 (if (and (derived-mode-p 'org-mode) (< level 1000))
23123 ;; A true heading (not a plain list item), in Org-mode
23124 ;; This means we can easily find the end by looking
23125 ;; only for the right number of stars. Using a regexp to do
23126 ;; this is so much faster than using a Lisp loop.
23128 (forward-char 1)
23129 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23130 ;; something else, do it the slow way
23131 (while (and (not (eobp))
23132 (or first (> (funcall outline-level) level)))
23133 (setq first nil)
23134 (outline-next-heading)))
23135 (unless to-heading
23137 (progn
23138 ;; Go to end of line before heading
23139 (forward-char -1)
23141 ;; leave blank line before heading
23142 (forward-char -1))))))
23143 (point))
23145 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23146 "Use Org version in org-mode, for dramatic speed-up."
23147 (if (derived-mode-p 'org-mode)
23148 (progn
23149 (org-end-of-subtree nil t)
23150 (unless (eobp) (backward-char 1)))
23151 ad-do-it))
23153 (defun org-end-of-meta-data-and-drawers ()
23154 "Jump to the first text after meta data and drawers in the current entry.
23155 This will move over empty lines, lines with planning time stamps,
23156 clocking lines, and drawers."
23157 (org-back-to-heading t)
23158 (let ((end (save-excursion (outline-next-heading) (point)))
23161 (forward-line 1)
23162 (while (re-search-forward re end t)
23163 (if (not (match-end 1))
23164 ;; empty or planning line
23165 (forward-line 1)
23166 ;; a drawer, find the end
23168 (forward-line 1)))
23170 (point)))
23172 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23173 "Move forward to the ARG'th subheading at same level as this one.
23174 Stop at the first and last subheadings of a superior heading.
23175 Normally this only looks at visible headings, but when INVISIBLE-OK is
23176 non-nil it will also look at invisible ones."
23177 (interactive "p")
23178 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23179 (if (and arg (< arg 0))
23180 (goto-char (point-min))
23181 (outline-next-heading))
23182 (org-at-heading-p)
23183 (let ((level (- (match-end 0) (match-beginning 0) 1))
23184 (f (if (and arg (< arg 0))
23185 're-search-backward
23186 're-search-forward))
23187 (count (if arg (abs arg) 1))
23188 (result (point)))
23189 (while (and (prog1 (> count 0)
23190 (forward-char (if (and arg (< arg 0)) -1 1)))
23191 (funcall f org-outline-regexp-bol nil 'move))
23192 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23193 (cond ((< l level) (setq count 0))
23194 ((and (= l level)
23195 (or invisible-ok
23196 (progn
23197 (goto-char (line-beginning-position))
23198 (not (outline-invisible-p)))))
23199 (setq count (1- count))
23200 (when (eq l level)
23201 (setq result (point)))))))
23202 (goto-char result))
23203 (beginning-of-line 1)))
23205 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23206 "Move backward to the ARG'th subheading at same level as this one.
23207 Stop at the first and last subheadings of a superior heading."
23208 (interactive "p")
23209 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23211 (defun org-next-block (arg &optional backward block-regexp)
23212 "Jump to the next block.
23213 With a prefix argument ARG, jump forward ARG many source blocks.
23214 When BACKWARD is non-nil, jump to the previous block.
23215 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23216 (interactive "p")
23217 (let ((re (or block-regexp org-block-regexp))
23218 (re-search-fn (or (and backward 're-search-backward)
23219 're-search-forward)))
23220 (if (looking-at re) (forward-char 1))
23221 (condition-case nil
23222 (funcall re-search-fn re nil nil arg)
23223 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23224 (goto-char (match-beginning 0)) (org-show-context)))
23226 (defun org-previous-block (arg &optional block-regexp)
23227 "Jump to the previous block.
23228 With a prefix argument ARG, jump backward ARG many source blocks.
23229 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23230 (interactive "p")
23231 (org-next-block arg t block-regexp))
23233 (defun org-forward-element ()
23234 "Move forward by one element.
23235 Move to the next element at the same level, when possible."
23236 (interactive)
23237 (cond ((eobp) (user-error "Cannot move further down"))
23238 ((org-with-limited-levels (org-at-heading-p))
23239 (let ((origin (point)))
23240 (goto-char (org-end-of-subtree nil t))
23241 (unless (org-with-limited-levels (org-at-heading-p))
23242 (goto-char origin)
23243 (user-error "Cannot move further down"))))
23244 (t
23245 (let* ((elem (org-element-at-point))
23246 (end (org-element-property :end elem))
23247 (parent (org-element-property :parent elem)))
23248 (cond ((and parent (= (org-element-property :contents-end parent) end))
23249 (goto-char (org-element-property :end parent)))
23250 ((integer-or-marker-p end) (goto-char end))
23251 (t (message "No element at point")))))))
23253 (defun org-backward-element ()
23254 "Move backward by one element.
23255 Move to the previous element at the same level, when possible."
23256 (interactive)
23257 (cond ((bobp) (user-error "Cannot move further up"))
23258 ((org-with-limited-levels (org-at-heading-p))
23259 ;; At a headline, move to the previous one, if any, or stay
23260 ;; here.
23261 (let ((origin (point)))
23262 (org-with-limited-levels (org-backward-heading-same-level 1))
23263 ;; When current headline has no sibling above, move to its
23264 ;; parent.
23265 (when (= (point) origin)
23266 (or (org-with-limited-levels (org-up-heading-safe))
23267 (progn (goto-char origin)
23268 (user-error "Cannot move further up"))))))
23269 (t
23270 (let* ((trail (org-element-at-point 'keep-trail))
23271 (elem (car trail))
23272 (prev-elem (nth 1 trail))
23273 (beg (org-element-property :begin elem)))
23274 (cond
23275 ;; Move to beginning of current element if point isn't
23276 ;; there already.
23277 ((null beg) (message "No element at point"))
23278 ((/= (point) beg) (goto-char beg))
23279 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23280 ((org-before-first-heading-p) (goto-char (point-min)))
23281 (t (org-back-to-heading)))))))
23283 (defun org-up-element ()
23284 "Move to upper element."
23285 (interactive)
23286 (if (org-with-limited-levels (org-at-heading-p))
23287 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23288 (let* ((elem (org-element-at-point))
23289 (parent (org-element-property :parent elem)))
23290 (if parent (goto-char (org-element-property :begin parent))
23291 (if (org-with-limited-levels (org-before-first-heading-p))
23292 (user-error "No surrounding element")
23293 (org-with-limited-levels (org-back-to-heading)))))))
23295 (defvar org-element-greater-elements)
23296 (defun org-down-element ()
23297 "Move to inner element."
23298 (interactive)
23299 (let ((element (org-element-at-point)))
23300 (cond
23301 ((memq (org-element-type element) '(plain-list table))
23302 (goto-char (org-element-property :contents-begin element))
23303 (forward-char))
23304 ((memq (org-element-type element) org-element-greater-elements)
23305 ;; If contents are hidden, first disclose them.
23306 (when (org-element-property :hiddenp element) (org-cycle))
23307 (goto-char (or (org-element-property :contents-begin element)
23308 (user-error "No content for this element"))))
23309 (t (user-error "No inner element")))))
23311 (defun org-drag-element-backward ()
23312 "Move backward element at point."
23313 (interactive)
23314 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23315 (let* ((trail (org-element-at-point 'keep-trail))
23316 (elem (car trail))
23317 (prev-elem (nth 1 trail)))
23318 ;; Error out if no previous element or previous element is
23319 ;; a parent of the current one.
23320 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23321 (user-error "Cannot drag element backward")
23322 (let ((pos (point)))
23323 (org-element-swap-A-B prev-elem elem)
23324 (goto-char (+ (org-element-property :begin prev-elem)
23325 (- pos (org-element-property :begin elem)))))))))
23327 (defun org-drag-element-forward ()
23328 "Move forward element at point."
23329 (interactive)
23330 (let* ((pos (point))
23331 (elem (org-element-at-point)))
23332 (when (= (point-max) (org-element-property :end elem))
23333 (user-error "Cannot drag element forward"))
23334 (goto-char (org-element-property :end elem))
23335 (let ((next-elem (org-element-at-point)))
23336 (when (or (org-element-nested-p elem next-elem)
23337 (and (eq (org-element-type next-elem) 'headline)
23338 (not (eq (org-element-type elem) 'headline))))
23339 (goto-char pos)
23340 (user-error "Cannot drag element forward"))
23341 ;; Compute new position of point: it's shifted by NEXT-ELEM
23342 ;; body's length (without final blanks) and by the length of
23343 ;; blanks between ELEM and NEXT-ELEM.
23344 (let ((size-next (- (save-excursion
23345 (goto-char (org-element-property :end next-elem))
23347 (forward-line)
23348 ;; Small correction if buffer doesn't end
23349 ;; with a newline character.
23350 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23351 (org-element-property :begin next-elem)))
23352 (size-blank (- (org-element-property :end elem)
23353 (save-excursion
23354 (goto-char (org-element-property :end elem))
23356 (forward-line)
23357 (point)))))
23358 (org-element-swap-A-B elem next-elem)
23359 (goto-char (+ pos size-next size-blank))))))
23361 (defun org-drag-line-forward (arg)
23362 "Drag the line at point ARG lines forward."
23363 (interactive "p")
23364 (dotimes (n (abs arg))
23365 (let ((c (current-column)))
23366 (if (< 0 arg)
23367 (progn
23368 (beginning-of-line 2)
23369 (transpose-lines 1)
23370 (beginning-of-line 0))
23371 (transpose-lines 1)
23372 (beginning-of-line -1))
23373 (org-move-to-column c))))
23375 (defun org-drag-line-backward (arg)
23376 "Drag the line at point ARG lines backward."
23377 (interactive "p")
23378 (org-drag-line-forward (- arg)))
23380 (defun org-mark-element ()
23381 "Put point at beginning of this element, mark at end.
23383 Interactively, if this command is repeated or (in Transient Mark
23384 mode) if the mark is active, it marks the next element after the
23385 ones already marked."
23386 (interactive)
23387 (let (deactivate-mark)
23388 (if (and (org-called-interactively-p 'any)
23389 (or (and (eq last-command this-command) (mark t))
23390 (and transient-mark-mode mark-active)))
23391 (set-mark
23392 (save-excursion
23393 (goto-char (mark))
23394 (goto-char (org-element-property :end (org-element-at-point)))))
23395 (let ((element (org-element-at-point)))
23396 (end-of-line)
23397 (push-mark (org-element-property :end element) t t)
23398 (goto-char (org-element-property :begin element))))))
23400 (defun org-narrow-to-element ()
23401 "Narrow buffer to current element."
23402 (interactive)
23403 (let ((elem (org-element-at-point)))
23404 (cond
23405 ((eq (car elem) 'headline)
23406 (narrow-to-region
23407 (org-element-property :begin elem)
23408 (org-element-property :end elem)))
23409 ((memq (car elem) org-element-greater-elements)
23410 (narrow-to-region
23411 (org-element-property :contents-begin elem)
23412 (org-element-property :contents-end elem)))
23413 (t
23414 (narrow-to-region
23415 (org-element-property :begin elem)
23416 (org-element-property :end elem))))))
23418 (defun org-transpose-element ()
23419 "Transpose current and previous elements, keeping blank lines between.
23420 Point is moved after both elements."
23421 (interactive)
23422 (org-skip-whitespace)
23423 (let ((end (org-element-property :end (org-element-at-point))))
23424 (org-drag-element-backward)
23425 (goto-char end)))
23427 (defun org-unindent-buffer ()
23428 "Un-indent the visible part of the buffer.
23429 Relative indentation (between items, inside blocks, etc.) isn't
23430 modified."
23431 (interactive)
23432 (unless (eq major-mode 'org-mode)
23433 (user-error "Cannot un-indent a buffer not in Org mode"))
23434 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23435 unindent-tree ; For byte-compiler.
23436 (unindent-tree
23437 (function
23438 (lambda (contents)
23439 (mapc
23440 (lambda (element)
23441 (if (memq (org-element-type element) '(headline section))
23442 (funcall unindent-tree (org-element-contents element))
23443 (save-excursion
23444 (save-restriction
23445 (narrow-to-region
23446 (org-element-property :begin element)
23447 (org-element-property :end element))
23448 (org-do-remove-indentation)))))
23449 (reverse contents))))))
23450 (funcall unindent-tree (org-element-contents parse-tree))))
23452 (defun org-show-subtree ()
23453 "Show everything after this heading at deeper levels."
23454 (interactive)
23455 (outline-flag-region
23456 (point)
23457 (save-excursion
23458 (org-end-of-subtree t t))
23459 nil))
23461 (defun org-show-entry ()
23462 "Show the body directly following this heading.
23463 Show the heading too, if it is currently invisible."
23464 (interactive)
23465 (save-excursion
23466 (condition-case nil
23467 (progn
23468 (org-back-to-heading t)
23469 (outline-flag-region
23470 (max (point-min) (1- (point)))
23471 (save-excursion
23472 (if (re-search-forward
23474 (match-beginning 1)
23475 (point-max)))
23476 nil)
23477 (org-cycle-hide-drawers 'children))
23478 (error nil))))
23480 (defun org-make-options-regexp (kwds &optional extra)
23481 "Make a regular expression for keyword lines."
23482 (concat
23488 ;; Make isearch reveal the necessary context
23489 (defun org-isearch-end ()
23490 "Reveal context after isearch exits."
23491 (when isearch-success ; only if search was successful
23492 (if (featurep 'xemacs)
23493 ;; Under XEmacs, the hook is run in the correct place,
23494 ;; we directly show the context.
23495 (org-show-context 'isearch)
23496 ;; In Emacs the hook runs *before* restoring the overlays.
23497 ;; So we have to use a one-time post-command-hook to do this.
23498 ;; (Emacs 22 has a special variable, see function `org-mode')
23499 (unless (and (boundp 'isearch-mode-end-hook-quit)
23500 isearch-mode-end-hook-quit)
23501 ;; Only when the isearch was not quitted.
23502 (org-add-hook 'post-command-hook 'org-isearch-post-command
23503 'append 'local)))
23504 (org-fix-ellipsis-at-bol)))
23506 (defun org-isearch-post-command ()
23507 "Remove self from hook, and show context."
23508 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23509 (org-show-context 'isearch))
23512 ;;;; Integration with and fixes for other packages
23514 ;;; Imenu support
23516 (defvar org-imenu-markers nil
23517 "All markers currently used by Imenu.")
23518 (make-variable-buffer-local 'org-imenu-markers)
23520 (defun org-imenu-new-marker (&optional pos)
23521 "Return a new marker for use by Imenu, and remember the marker."
23522 (let ((m (make-marker)))
23523 (move-marker m (or pos (point)))
23524 (push m org-imenu-markers)
23525 m))
23527 (defun org-imenu-get-tree ()
23528 "Produce the index for Imenu."
23529 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23530 (setq org-imenu-markers nil)
23531 (let* ((n org-imenu-depth)
23532 (re (concat "^" (org-get-limited-outline-regexp)))
23533 (subs (make-vector (1+ n) nil))
23534 (last-level 0)
23535 m level head0 head)
23536 (save-excursion
23537 (save-restriction
23538 (widen)
23539 (goto-char (point-max))
23540 (while (re-search-backward re nil t)
23541 (setq level (org-reduced-level (funcall outline-level)))
23542 (when (and (<= level n)
23543 (looking-at org-complex-heading-regexp)
23544 (setq head0 (org-match-string-no-properties 4)))
23545 (setq head (org-link-display-format head0)
23546 m (org-imenu-new-marker))
23547 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23548 (if (>= level last-level)
23549 (push (cons head m) (aref subs level))
23550 (push (cons head (aref subs (1+ level))) (aref subs level))
23551 (loop for i from (1+ level) to n do (aset subs i nil)))
23552 (setq last-level level)))))
23553 (aref subs 1)))
23555 (eval-after-load "imenu"
23556 '(progn
23557 (add-hook 'imenu-after-jump-hook
23558 (lambda ()
23559 (if (derived-mode-p 'org-mode)
23560 (org-show-context 'org-goto))))))
23562 (defun org-link-display-format (link)
23563 "Replace a link with its the description.
23564 If there is no description, use the link target."
23565 (save-match-data
23566 (if (string-match org-bracket-link-analytic-regexp link)
23567 (replace-match (if (match-end 5)
23568 (match-string 5 link)
23569 (concat (match-string 1 link)
23570 (match-string 3 link)))
23571 nil t link)
23572 link)))
23574 (defun org-toggle-link-display ()
23575 "Toggle the literal or descriptive display of links."
23576 (interactive)
23577 (if org-descriptive-links
23578 (progn (org-remove-from-invisibility-spec '(org-link))
23579 (org-restart-font-lock)
23580 (setq org-descriptive-links nil))
23581 (progn (add-to-invisibility-spec '(org-link))
23582 (org-restart-font-lock)
23583 (setq org-descriptive-links t))))
23585 ;; Speedbar support
23587 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23588 "Overlay marking the agenda restriction line in speedbar.")
23589 (overlay-put org-speedbar-restriction-lock-overlay
23590 'face 'org-agenda-restriction-lock)
23591 (overlay-put org-speedbar-restriction-lock-overlay
23592 'help-echo "Agendas are currently limited to this item.")
23593 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23595 (defun org-speedbar-set-agenda-restriction ()
23596 "Restrict future agenda commands to the location at point in speedbar.
23598 (interactive)
23599 (require 'org-agenda)
23600 (let (p m tp np dir txt)
23601 (cond
23602 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23603 'org-imenu t))
23604 (setq m (get-text-property p 'org-imenu-marker))
23605 (with-current-buffer (marker-buffer m)
23606 (goto-char m)
23607 (org-agenda-set-restriction-lock 'subtree)))
23608 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23609 'speedbar-function 'speedbar-find-file))
23610 (setq tp (previous-single-property-change
23611 (1+ p) 'speedbar-function)
23612 np (next-single-property-change
23613 tp 'speedbar-function)
23614 dir (speedbar-line-directory)
23615 txt (buffer-substring-no-properties (or tp (point-min))
23616 (or np (point-max))))
23617 (with-current-buffer (find-file-noselect
23618 (let ((default-directory dir))
23619 (expand-file-name txt)))
23620 (unless (derived-mode-p 'org-mode)
23621 (user-error "Cannot restrict to non-Org-mode file"))
23622 (org-agenda-set-restriction-lock 'file)))
23623 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23624 (move-overlay org-speedbar-restriction-lock-overlay
23625 (point-at-bol) (point-at-eol))
23626 (setq current-prefix-arg nil)
23627 (org-agenda-maybe-redo)))
23629 (defvar speedbar-file-key-map)
23630 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23631 (eval-after-load "speedbar"
23632 '(progn
23633 (speedbar-add-supported-extension ".org")
23634 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23635 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23636 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23637 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23638 (add-hook 'speedbar-visiting-tag-hook
23639 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23641 ;;; Fixes and Hacks for problems with other packages
23643 ;; Make flyspell not check words in links, to not mess up our keymap
23644 (defvar org-element-affiliated-keywords) ; From org-element.el
23645 (defvar org-element-block-name-alist) ; From org-element.el
23646 (defun org-mode-flyspell-verify ()
23647 "Don't let flyspell put overlays at active buttons, or on
23648 {todo,all-time,additional-option-like}-keywords."
23649 (require 'org-element) ; For `org-element-affiliated-keywords'
23650 (let ((pos (max (1- (point)) (point-min)))
23651 (word (thing-at-point 'word)))
23652 (and (not (get-text-property pos 'keymap))
23653 (not (get-text-property pos 'org-no-flyspell))
23654 (not (member word org-todo-keywords-1))
23655 (not (member word org-all-time-keywords))
23656 (not (member word org-options-keywords))
23657 (not (member word (mapcar 'car org-startup-options)))
23658 (not (member-ignore-case word org-element-affiliated-keywords))
23659 (not (member-ignore-case word (org-get-export-keywords)))
23660 (not (member-ignore-case
23661 word (mapcar 'car org-element-block-name-alist)))
23662 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23663 (not (org-in-src-block-p)))))
23665 (defun org-remove-flyspell-overlays-in (beg end)
23666 "Remove flyspell overlays in region."
23667 (and (org-bound-and-true-p flyspell-mode)
23668 (fboundp 'flyspell-delete-region-overlays)
23669 (flyspell-delete-region-overlays beg end))
23670 (add-text-properties beg end '(org-no-flyspell t)))
23672 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23673 (eval-after-load "bookmark"
23674 '(if (boundp 'bookmark-after-jump-hook)
23675 ;; We can use the hook
23676 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23677 ;; Hook not available, use advice
23678 (defadvice bookmark-jump (after org-make-visible activate)
23679 "Make the position visible."
23680 (org-bookmark-jump-unhide))))
23682 ;; Make sure saveplace shows the location if it was hidden
23683 (eval-after-load "saveplace"
23684 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23685 "Make the position visible."
23686 (org-bookmark-jump-unhide)))
23688 ;; Make sure ecb shows the location if it was hidden
23689 (eval-after-load "ecb"
23690 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23691 "Make hierarchy visible when jumping into location from ECB tree buffer."
23692 (if (derived-mode-p 'org-mode)
23693 (org-show-context))))
23695 (defun org-bookmark-jump-unhide ()
23696 "Unhide the current position, to show the bookmark location."
23697 (and (derived-mode-p 'org-mode)
23698 (or (outline-invisible-p)
23699 (save-excursion (goto-char (max (point-min) (1- (point))))
23700 (outline-invisible-p)))
23701 (org-show-context 'bookmark-jump)))
23703 ;; Make session.el ignore our circular variable
23704 (defvar session-globals-exclude)
23705 (eval-after-load "session"
23706 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23708 ;;;; Finish up
23710 (provide 'org)
23712 (run-hooks 'org-load-hook)
23714 ;;; org.el ends here