| blob | 8e23ec9f87f69b7d70fff62e0b52b54806d6de00 |
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-bound 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
208 exported-file)))
211 "Languages which can be evaluated in Org-mode buffers.
212 This list can be used to load support for any of the languages
213 below, note that each language will depend on a different set of
214 system executables and/or Emacs modes. When a language is
216 with `org-babel-execute-src-block' bound by default to C-c
217 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
218 be set to remove code block evaluation from the C-c C-c
219 keybinding. By default only Emacs Lisp (which has no
220 requirements) is loaded."
225 :key-type
269 ;;;; Customization variables
271 "Remove ID property of clones of a subtree.
272 When non-nil, clones of a subtree don't inherit the ID property.
273 Otherwise they inherit the ID property with a new unique
274 identifier."
279 ;;; Version
282 ;;;###autoload
284 "Show the org-mode version in the echo area.
285 With prefix argument HERE, insert it at point.
286 When FULL is non-nil, use a verbose version string.
287 When MESSAGE is non-nil, display a message with the version."
300 org-version
301 git-version
304 org-install-dir
313 version1)))
317 ;;; Compatibility constants
319 ;;; The custom variables
322 "Outline-based notes management and organizer."
328 "Mode hook for Org-mode, run after the mode was turned on."
333 "Hook that is run after org.el has been loaded."
338 "Hook that is run after an Org log buffer is created."
348 "Load all extensions listed in `org-modules'."
353 org-modules)
357 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
362 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
363 "Modules that should always be loaded together with org.el.
365 If a description starts with <C>, the file is not part of Emacs
366 and loading it will require that you have downloaded and properly
367 installed the Org mode distribution.
369 You can also use this system to load external packages (i.e. neither Org
370 core modules, nor modules from the CONTRIB directory). Just add symbols
371 to the end of the list. If the package is called org-xyz.el, then you need
372 to add the symbol `xyz', and the package must have a call to:
374 \(provide 'org-xyz)
376 For export specific modules, see also `org-export-backends'."
381 :type
406 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
415 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
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."
1039 "Names for bookmarks automatically set by some Org commands.
1040 This can provide strings as names for a number of bookmakrs Org sets
1041 automatically. The following keys are currently implemented:
1042 :last-capture
1043 :last-capture-marker
1044 :last-refile
1045 When a key does not show up in the property list, the corresponding bookmark
1046 is not set."
1051 "Options concerning visibility cycling in Org-mode."
1056 "Non-nil means skip CHILDREN state in entries that don't have any."
1061 "Maximum level which should still be subject to visibility cycling.
1062 Levels higher than this will, for cycling, be treated as text, not a headline.
1063 When `org-odd-levels-only' is set, a value of N in this variable actually
1064 means 2N-1 stars as the limiting headline.
1065 When nil, cycle all levels.
1066 Note that the limiting level of cycling is also influenced by
1067 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1068 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1069 than its value."
1076 "Names of drawers. Drawers are not opened by cycling on the headline above.
1077 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1078 this:
1079 :DRAWERNAME:
1080 .....
1081 :END:
1083 the property API.
1085 Drawers can be defined on the per-file basis with a line like:
1087 #+DRAWERS: HIDDEN STATE PROPERTIES"
1093 "Non-nil means entering Org-mode will fold all blocks.
1094 This can also be set in on a per-file basis with
1096 #+STARTUP: hideblocks
1097 #+STARTUP: showblocks"
1103 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1104 This makes it possible to do global cycling without having to use S-TAB or
1106 of the buffer must not be a headline -- it may be empty or some other text.
1107 When used in this way, `org-cycle-hook' is disabled temporarily to make
1108 sure the cursor stays at the beginning of the buffer. When this option is
1109 nil, don't do anything special at the beginning of the buffer."
1114 "Non-nil means cycle entry level or item indentation in new empty entries.
1116 When the cursor is at the end of an empty headline, i.e., with only stars
1117 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1118 and then all possible ancestor states, before returning to the original state.
1119 This makes data entry extremely fast: M-RET to create a new headline,
1120 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1122 When the cursor is at the end of an empty plain list item, one TAB will
1123 make it a subitem, two or more tabs will back up to make this an item
1124 higher up in the item hierarchy."
1129 "Where should `org-cycle' emulate TAB.
1130 nil Never
1131 white Only in completely white lines
1132 whitestart Only at the beginning of lines, before the first non-white char
1133 t Everywhere except in headlines
1134 exc-hl-bol Everywhere except at the start of a headline
1135 If TAB is used in a place where it does not emulate TAB, the current subtree
1136 visibility is cycled."
1145 "Number of empty lines needed to keep an empty line between collapsed trees.
1146 If you leave an empty line between the end of a subtree and the following
1147 headline, this empty line is hidden when the subtree is folded.
1148 Org-mode will leave (exactly) one empty line visible if the number of
1149 empty lines is equal or larger to the number given in this variable.
1150 So the default 2 means at least 2 empty lines after the end of a subtree
1151 are needed to produce free space between a collapsed subtree and the
1152 following headline.
1154 If the number is negative, and the number of empty lines is at least -N,
1155 all empty lines are shown.
1157 Special case: when 0, never leave empty lines in collapsed view."
1163 "Hook that is run before visibility cycling is happening.
1164 The function(s) in this hook must accept a single argument which indicates
1165 the new state that will be set right after running this hook. The
1166 argument is a symbol. Before a global state change, it can have the values
1167 `overview', `content', or `all'. Before a local state change, it can have
1168 the values `folded', `children', or `subtree'."
1173 org-cycle-hide-drawers
1174 org-cycle-hide-inline-tasks
1175 org-cycle-show-empty-lines
1176 org-optimize-window-after-visibility-change)
1177 "Hook that is run after `org-cycle' has changed the buffer visibility.
1178 The function(s) in this hook must accept a single argument which indicates
1179 the new state that was set by the most recent `org-cycle' command. The
1180 argument is a symbol. After a global state change, it can have the values
1181 `overview', `contents', or `all'. After a local state change, it can have
1182 the values `folded', `children', or `subtree'."
1187 "Options concerning structure editing in Org-mode."
1192 "Non-nil means skip even levels and only use odd levels for the outline.
1193 This has the effect that two stars are being added/taken away in
1194 promotion/demotion commands. It also influences how levels are
1195 handled by the exporters.
1196 Changing it requires restart of `font-lock-mode' to become effective
1197 for fontification also in regions already fontified.
1198 You may also set this on a per-file basis by adding one of the following
1199 lines to the buffer:
1201 #+STARTUP: odd
1202 #+STARTUP: oddeven"
1208 "Non-nil means adapt indentation to outline node level.
1210 When this variable is set, Org assumes that you write outlines by
1211 indenting text in each node to align with the headline (after the stars).
1212 The following issues are influenced by this variable:
1214 - When this is set and the *entire* text in an entry is indented, the
1215 indentation is increased by one space in a demotion command, and
1216 decreased by one in a promotion command. If any line in the entry
1217 body starts with text at column 0, indentation is not changed at all.
1219 - Property drawers and planning information is inserted indented when
1220 this variable s set. When nil, they will not be indented.
1222 - TAB indents a line relative to context. The lines below a headline
1223 will be indented when this variable is set.
1225 Note that this is all about true indentation, by adding and removing
1226 space characters. See also `org-indent.el' which does level-dependent
1227 indentation in a virtual way, i.e. at display time in Emacs."
1232 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1234 When t, `C-a' will bring back the cursor to the beginning of the
1235 headline text, i.e. after the stars and after a possible TODO
1236 keyword. In an item, this will be the position after bullet and
1237 check-box, if any. When the cursor is already at that position,
1238 another `C-a' will bring it to the beginning of the line.
1240 `C-e' will jump to the end of the headline, ignoring the presence
1241 of tags in the headline. A second `C-e' will then jump to the
1242 true end of the line, after any tags. This also means that, when
1243 this variable is non-nil, `C-e' also will never jump beyond the
1244 end of the heading of a folded section, i.e. not after the
1245 ellipses.
1247 When set to the symbol `reversed', the first `C-a' or `C-e' works
1248 normally, going to the true line boundary first. Only a directly
1249 following, identical keypress will bring the cursor to the
1250 special positions.
1252 This may also be a cons cell where the behavior for `C-a' and
1253 `C-e' is set separately."
1271 "Non-nil means `C-k' will behave specially in headlines.
1272 When nil, `C-k' will call the default `kill-line' command.
1273 When t, the following will happen while the cursor is in the headline:
1275 - When the cursor is at the beginning of a headline, kill the entire
1276 line and possible the folded subtree below the line.
1277 - When in the middle of the headline text, kill the headline up to the tags.
1278 - When after the headline text, kill the tags."
1283 "Non-nil means, do not delete a hidden subtree with C-k.
1284 When set to the symbol `error', simply throw an error when C-k is
1285 used to kill (part-of) a headline that has hidden text behind it.
1286 Any other non-nil value will result in a query to the user, if it is
1287 OK to kill that hidden subtree. When nil, kill without remorse."
1296 "Non-nil means, make `C-o' insert a row in tables."
1301 "Check if in invisible region before inserting or deleting a character.
1302 Valid values are:
1304 nil Do not check, so just do invisible edits.
1305 error Throw an error and do nothing.
1306 show Make point visible, and do the requested edit.
1307 show-and-error Make point visible, then throw an error and abort the edit.
1308 smart Make point visible, and do insertion/deletion if it is
1309 adjacent to visible text and the change feels predictable.
1310 Never delete a previously invisible character or add in the
1311 middle or right after an invisible region. Basically, this
1312 allows insertion and backward-delete right before ellipses.
1313 FIXME: maybe in this case we should not even show?"
1324 "Non-nil means when yanking subtrees, fold them.
1325 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1326 it starts with a heading and all other headings in it are either children
1327 or siblings, then fold all the subtrees. However, do this only if no
1328 text after the yank would be swallowed into a folded tree by this action."
1333 "Non-nil means when yanking subtrees, adjust the level.
1334 With this setting, `org-paste-subtree' is used to insert the subtree, see
1335 this function for details."
1340 "Non-nil means M-RET will split the line at the cursor position.
1341 When nil, it will go to the end of the line before making a
1342 new line.
1343 You may also set this option in a different way for different
1344 contexts. Valid contexts are:
1346 headline when creating a new headline
1347 item when creating a new item
1348 table in a table field
1349 default the value to be used for all contexts not explicitly
1350 customized"
1367 "Non-nil means insert new headings after the current subtree.
1368 When nil, the new heading is created directly after the current line.
1369 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1370 this variable on for the duration of the command."
1376 "Should `org-insert-heading' leave a blank line before new heading/item?
1377 The value is an alist, with `heading' and `plain-list-item' as CAR,
1378 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1379 which case Org will look at the surrounding headings/items and try to
1380 make an intelligent decision whether to insert a blank line or not.
1382 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1383 the setting here is ignored and no empty line is inserted to avoid breaking
1384 the list structure."
1397 "Hook being run after inserting a new heading."
1403 This currently only means they are never auto-wrapped.
1404 When nil, such lines will be treated like ordinary lines.
1405 See also the QUOTE keyword."
1410 "Non-nil means typing characters in `org-goto' starts incremental search.
1411 When nil, you can use these keybindings to navigate the buffer:
1413 q Quit the org-goto interface
1414 n Go to the next visible heading
1415 p Go to the previous visible heading
1416 f Go one heading forward on same level
1417 b Go one heading backward on same level
1418 u Go one heading up"
1423 "Options concerning sparse trees in Org-mode."
1428 "Non-nil means highlight all matches that define a sparse tree.
1429 The highlights will automatically disappear the next time the buffer is
1430 changed by an edit command."
1435 "Non-nil means any change to the buffer will remove temporary highlights.
1436 Such highlights are created by `org-occur' and `org-clock-display'.
1437 When nil, `C-c C-c needs to be used to get rid of the highlights.
1438 The highlights created by `org-preview-latex-fragment' always need
1439 `C-c C-c' to be removed."
1446 "Hook that is run after `org-occur' has constructed a sparse tree.
1447 This can be used to recenter the window to show as much of the structure
1448 as possible."
1453 "Options concerning imenu and speedbar in Org-mode."
1458 "The maximum level for Imenu access to Org-mode headlines.
1459 This also applied for speedbar access."
1464 "Options concerning tables in Org-mode."
1470 When nil, such lines will be treated like ordinary lines.
1472 When equal to the symbol `optimized', the table editor will be optimized to
1473 do the following:
1474 - Automatic overwrite mode in front of whitespace in table fields.
1475 This makes the structure of the table stay in tact as long as the edited
1476 field does not exceed the column width.
1477 - Minimize the number of realigns. Normally, the table is aligned each time
1478 TAB or RET are pressed to move to another field. With optimization this
1479 happens only if changes to a field might have changed the column width.
1480 Optimization requires replacing the functions `self-insert-command',
1481 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1482 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1483 very good at guessing when a re-align will be necessary, but you can always
1486 If you would like to use the optimized version in Org-mode, but the
1487 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1489 This variable can be used to turn on and off the table editor during a session,
1490 but in order to toggle optimization, a restart is required.
1492 See also the variable `org-table-auto-blank-field'."
1501 "Non-nil means cluster self-insert commands for undo when possible.
1502 If this is set, then, like in the Emacs command loop, 20 consecutive
1503 characters will be undone together.
1504 This is configurable, because there is some impact on typing performance."
1509 "Non-nil means TAB will automatically notice a table.el table.
1510 When it sees such a table, it moves point into it and - if necessary -
1511 calls `table-recognize-table'."
1516 "Options concerning links in Org-mode."
1521 "Buffer-local version of `org-link-abbrev-alist', which see.
1526 "Alist of link abbreviations.
1527 The car of each element is a string, to be replaced at the start of a link.
1529 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1531 [[linkkey:tag][description]]
1533 The 'linkkey' must be a word word, starting with a letter, followed
1534 by letters, numbers, '-' or '_'.
1536 If REPLACE is a string, the tag will simply be appended to create the link.
1539 at that point (see the function `url-hexify-string'). If the string contains
1541 be invoked: this function takes the tag as its only argument and must return
1542 a string.
1544 REPLACE may also be a function that will be called with the tag as the
1545 only argument to create the link, which should be returned as a string.
1547 See the manual for examples."
1557 "Non-nil means Org will display descriptive links.
1558 E.g. [[http://orgmode.org][Org website]] will be displayed as
1560 description. When set to `nil', Org will display the full links
1561 literally.
1563 You can interactively set the value of this variable by calling
1564 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1569 "How the path name in file links should be stored.
1570 Valid values are:
1572 relative Relative to the current directory, i.e. the directory of the file
1573 into which the link is being inserted.
1574 absolute Absolute path, if possible with ~ for home directory.
1575 noabbrev Absolute path, no abbreviation of home directory.
1576 adaptive Use relative path for files in the current directory and sub-
1577 directories of it. For other files, use an absolute path."
1586 "Types of links that should be activated in Org-mode files.
1587 This is a list of symbols, each leading to the activation of a certain link
1588 type. In principle, it does not hurt to turn on most link types - there may
1589 be a small gain when turning off unused link types. The types are:
1591 bracket The recommended [[link][description]] or [[link]] links with hiding.
1592 angle Links in angular brackets that may contain whitespace like
1593 <bbdb:Carsten Dominik>.
1594 plain Plain links in normal text, no whitespace, like http://google.com.
1595 radio Text that is matched by a radio target, see manual for details.
1596 tag Tag settings in a headline (link to tag search).
1597 date Time stamps (link to calendar).
1598 footnote Footnote labels.
1600 Changing this variable requires a restart of Emacs to become effective."
1612 "Function to use for generating link descriptions from links.
1613 When nil, the link location will be used. This function must take
1614 two parameters: the first one is the link, the second one is the
1615 description generated by `org-insert-link'. The function should
1616 return the description to use."
1621 "Options concerning storing links in Org-mode."
1626 "When non-nil, hexify URL when creating a link."
1632 "Format of the description part of a link to an email or usenet message.
1633 The following %-escapes will be replaced by corresponding information:
1641 %s subject
1642 %d date
1643 %m message-id.
1645 You may use normal field width specification between the % and the letter.
1646 This is for example useful to limit the length of the subject.
1660 It should match if the message is from the user him/herself."
1665 "Non-nil means file links from `org-store-link' contain context.
1666 A search string will be added to the file name with :: as separator and
1667 used to find the context when the link is activated by the command
1668 `org-open-at-point'. When this option is t, the entire active region
1669 will be placed in the search string of the file link. If set to a
1670 positive integer, only the first n lines of context will be stored.
1673 negates this setting for the duration of the command."
1678 "Non-nil means keep link in list for entire session.
1680 The command `org-store-link' adds a link pointing to the current
1681 location to an internal list. These links accumulate during a session.
1682 The command `org-insert-link' can be used to insert links into any
1683 Org-mode file (offering completion for all stored links). When this
1685 will be removed from the list, to make completing the unused links
1686 more efficient."
1691 "Options concerning following links in Org-mode."
1696 "Function to translate links with different syntax to Org syntax.
1697 This can be used to translate links created for example by the Planner
1698 or emacs-wiki packages to Org syntax.
1699 The function must accept two parameters, a TYPE containing the link
1701 which is everything after the link protocol. It should return a cons
1702 with possibly modified values of type and path.
1703 Org contains a function for this, so if you set this variable to
1704 `org-translate-link-from-planner', you should be able follow many
1705 links created by planner."
1710 "Hook that is run after a link has been followed."
1715 "Non-nil means on links TAB will follow the link.
1716 Needs to be set before org.el is loaded.
1717 This really should not be used, it does not make sense, and the
1718 implementation is bad."
1723 "Non-nil means on links RET will follow the link.
1724 In tables, the special behavior of RET has precedence."
1730 "Non-nil means mouse-1 on a link will follow the link.
1731 A longer mouse click will still set point. Does not work on XEmacs.
1732 Needs to be set before org.el is loaded."
1737 "Number of different positions to be recorded in the ring.
1738 Changing this requires a restart of Emacs to work correctly."
1743 "Non-nil means internal links in Org files must exactly match a headline.
1744 When nil, the link search tries to match a phrase with all words
1745 in the search text."
1752 query-to-create)))
1760 "Setup the frame configuration for following links.
1761 When following a link with Emacs, it may often be useful to display
1762 this link in another window or frame. This variable can be used to
1763 set this up for the different types of links.
1764 For VM, use any of
1765 `vm-visit-folder'
1766 `vm-visit-folder-other-window'
1767 `vm-visit-folder-other-frame'
1768 For Gnus, use any of
1769 `gnus'
1770 `gnus-other-frame'
1771 `org-gnus-no-new-news'
1772 For FILE, use any of
1773 `find-file'
1774 `find-file-other-window'
1775 `find-file-other-frame'
1776 For Wanderlust use any of
1777 `wl'
1778 `wl-other-frame'
1779 For the calendar, use the variable `calendar-setup'.
1780 For BBDB, it is currently only possible to display the matches in
1781 another window."
1810 "Non-nil means use indirect buffer to display infile links.
1811 Activating internal links (from one location in a file to another location
1812 in the same file) normally just jumps to the location. When the link is
1814 is displayed in
1815 another window. When this option is set, the other window actually displays
1816 an indirect buffer clone of the current buffer, to avoid any visibility
1817 changes to the current buffer."
1822 "Non-nil means `org-open-file' will open non-existing files.
1823 When nil, an error will be generated.
1824 This variable applies only to external applications because they
1825 might choke on non-existing files. If the link is to a file that
1826 will be opened in Emacs, the variable is ignored."
1831 "Non-nil means a link to a directory really means to index.org.
1832 When nil, following a directory link will run dired or open a finder/explorer
1833 window on that directory."
1838 "Function and arguments to call for following mailto links.
1839 This is a list with the first element being a Lisp function, and the
1840 remaining elements being arguments to the function. In string arguments,
1841 %a will be replaced by the address, and %s will be replaced by the subject
1842 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1851 "Non-nil means ask for confirmation before executing shell links.
1852 Shell links can be dangerous: just think about a link
1854 [[shell:rm -rf ~/*][Google Search]]
1857 but really it would remove your entire home directory.
1858 Therefore we advise against setting this variable to nil.
1859 Just change it to `y-or-n-p' if you want to confirm with a
1867 'safe-local-variable
1871 "A regexp to skip confirmation for shell links."
1877 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1878 Elisp links can be dangerous: just think about a link
1883 but really it would remove your entire home directory.
1884 Therefore we advise against setting this variable to nil.
1885 Just change it to `y-or-n-p' if you want to confirm with a
1893 'safe-local-variable
1897 "A regexp to skip confirmation for Elisp links."
1906 "Default file applications on a UNIX or GNU/Linux system.
1917 "Default file applications on a MacOS X system.
1919 for some files for which the OS does not have a good default.
1927 'mswindows-shell-execute
1932 'mswindows-shell-execute
1935 "Default file applications on a Windows NT system.
1944 "External applications for opening `file:path' items in a document.
1945 Org-mode uses system defaults for different file types, but
1946 you can use this variable to set the application for a given file
1947 extension. The entries in this list are cons cells where the car identifies
1948 files and the cdr the corresponding command. Possible values for the
1949 file identifier are
1951 ways, depending on its contents:
1953 - Alphanumeric characters only:
1954 Match links with this file extension.
1956 to open PDFs with evince.
1958 - Regular expression: Match links where the
1959 filename matches the regexp. If you want to
1960 use groups here, use shy groups.
1964 to open *.html and *.xhtml with firefox.
1966 - Regular expression which contains (non-shy) groups:
1968 anything after that, matches the regexp.
1969 In a custom command string, %1, %2, etc. are replaced with
1970 the parts of the link that were matched by the groups.
1971 For backwards compatibility, if a command string is given
1972 that does not use any of the group matches, this case is
1973 handled identically to the second one (i.e. match against
1974 file name only).
1975 In a custom lisp form, you can access the group matches with
1976 (match-string n link).
1979 to open [[file:document.pdf::5]] with evince at page 5.
1981 `directory' Matches a directory
1982 `remote' Matches a remote file, accessible through tramp or efs.
1983 Remote files most likely should be visited through Emacs
1984 because external applications cannot handle such paths.
1985 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1986 so all files Emacs knows how to handle. Using this with
1987 command `emacs' will open most files in Emacs. Beware that this
1988 will also open html files inside Emacs, unless you add
1990 t Default for files not matched by any of the other options.
1991 `system' The system command to open files, like `open' on Windows
1992 and Mac OS X, and mailcap under GNU/Linux. This is the command
1993 that will be selected if you call `C-c C-o' with a double
1996 Possible values for the command are:
1997 `emacs' The file will be visited by the current Emacs process.
1998 `default' Use the default application for this file type, which is the
1999 association for t in the list, most likely in the system-specific
2000 part.
2001 This can be used to overrule an unwanted setting in the
2002 system-specific variable.
2004 This command is specified by the entry whose car is `system'.
2005 Most likely, the system-specific version of this variable
2006 does define this command, but you can overrule/replace it
2007 here.
2008 string A command to be executed by a shell; %s will be replaced
2009 by the path to the file.
2010 sexp A Lisp form which will be evaluated. The file path will
2011 be available in the Lisp variable `file'.
2012 For more examples, see the system specific constants
2013 `org-file-apps-defaults-macosx'
2014 `org-file-apps-defaults-windowsnt'
2015 `org-file-apps-defaults-gnu'."
2025 auto-mode))
2034 "The URL of the DOI server."
2040 "Options concerning refiling entries in Org-mode."
2045 "Directory with org files.
2046 This is just a default location to look for Org files. There is no need
2047 at all to put your files into this directory. It is only used in the
2048 following situations:
2050 1. When a capture template specifies a target file that is not an
2051 absolute path. The path will then be interpreted relative to
2052 `org-directory'
2053 2. When a capture note is filed away in an interactive way (when exiting the
2054 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2055 with `org-directory' as the default path."
2061 "Default target for storing notes.
2062 Used as a fall back file for org-capture.el, for templates that
2063 do not specify a target file."
2068 file))
2071 "The default interface to be used for `org-goto'.
2072 Allowed values are:
2073 outline The interface shows an outline of the relevant file
2074 and the correct heading is found by moving through
2075 the outline or by searching with incremental search.
2076 outline-path-completion Headlines in the current buffer are offered via
2077 completion. This is the interface also used by
2078 the refile command."
2085 "Maximum target level when running `org-goto' with refile interface."
2090 "Non-nil means store new notes at the beginning of a file or entry.
2091 When nil, new notes will be filed to the end of a file or entry.
2092 This can also be a list with cons cells of regular expressions that
2093 are matched against file names, and values."
2103 "Information to record when a task is refiled.
2105 Possible values are:
2107 nil Don't add anything
2108 time Add a time stamp to the task
2109 note Prompt for a note and add it with template `org-log-note-headings'
2111 This option can also be set with on a per-file-basis with
2113 #+STARTUP: nologrefile
2114 #+STARTUP: logrefile
2115 #+STARTUP: lognoterefile
2117 You can have local logging settings for a subtree by setting the LOGGING
2118 property to one or more of these keywords.
2120 When bulk-refiling from the agenda, the value `note' is forbidden and
2121 will temporarily be changed to `time'."
2132 This is a list of cons cells. Each cell contains:
2133 - a specification of the files to be considered, either a list of files,
2134 or a symbol whose function or variable value will be used to retrieve
2135 a file name or a list of file names. If you use `org-agenda-files' for
2136 that, all agenda files will be scanned for targets. Nil means consider
2137 headings in the current buffer.
2138 - A specification of how to find candidate refile targets. This may be
2139 any of:
2141 This tag has to be present in all target headlines, inheritance will
2142 not be considered.
2144 todo keyword.
2146 headlines that are refiling targets.
2147 - a cons cell (:level . N). Any headline of level N is considered a target.
2148 Note that, when `org-odd-levels-only' is set, level corresponds to
2149 order in hierarchy, not to the number of stars.
2150 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2151 Note that, when `org-odd-levels-only' is set, level corresponds to
2152 order in hierarchy, not to the number of stars.
2154 Each element of this list generates a set of possible targets.
2155 The union of these sets is presented (with completion) to
2156 the user by `org-refile'.
2158 You can set the variable `org-refile-target-verify-function' to a function
2159 to verify each headline found by the simple criteria above.
2161 When this variable is nil, all top-level headlines in the current buffer
2162 are used, equivalent to the value `((nil . (:level . 1))'."
2178 "Function to verify if the headline at point should be a refile target.
2179 The function will be called without arguments, with point at the
2180 beginning of the headline. It should return t and leave point
2181 where it is if the headline is a valid target for refiling.
2183 If the target should not be selected, the function must return nil.
2184 In addition to this, it may move point to a place from where the search
2185 should be continued. For example, the function may decide that the entire
2186 subtree of the current entry should be excluded and move point to the end
2187 of the subtree."
2194 "Non-nil means cache refile targets to speed up the process.
2195 The cache for a particular file will be updated automatically when
2196 the buffer has been killed, or when any of the marker used for flagging
2197 refile targets no longer points at a live buffer.
2198 If you have added new entries to a buffer that might themselves be targets,
2199 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2200 find that easier, `C-u C-u C-u C-c C-w'."
2206 "Non-nil means provide refile targets as paths.
2207 So a level 3 headline will be available as level1/level2/level3.
2209 When the value is `file', also include the file name (without directory)
2210 into the path. In this case, you can also stop the completion after
2211 the file name, to get entries inserted as top level in the file.
2213 When `full-file-path', include the full file path."
2222 "Non-nil means complete the outline path in hierarchical steps.
2223 When Org-mode uses the refile interface to select an outline path
2224 \(see variable `org-refile-use-outline-path'), the completion of
2225 the path can be done is a single go, or if can be done in steps down
2226 the headline hierarchy. Going in steps is probably the best if you
2227 do not use a special completion package like `ido' or `icicles'.
2228 However, when using these packages, going in one step can be very
2229 fast, while still showing the whole path to the entry."
2234 "Non-nil means allow to create new nodes as refile targets.
2236 of an existing node. When the value of this variable is `confirm',
2237 new node creation must be confirmed by the user (recommended)
2238 When nil, the completion must match an existing entry.
2240 Note that, if the new heading is not seen by the criteria
2241 listed in `org-refile-targets', multiple instances of the same
2242 heading would be created by trying again to file under the new
2243 heading."
2251 "Non-nil means also refile active region within a subtree.
2253 By default `org-refile' doesn't allow refiling regions if they
2254 don't contain a set of subtrees, but it might be convenient to
2255 do so sometimes: in that case, the first line of the region is
2256 converted to a headline before refiling."
2262 "Options concerning TODO items in Org-mode."
2267 "Options concerning Progress logging in Org-mode."
2274 "The available interpretation symbols for customizing `org-todo-keywords'.
2278 "List of TODO entry keyword sequences and their interpretation.
2281 Each sequence starts with a symbol, either `sequence' or `type',
2282 indicating if the keywords should be interpreted as a sequence of
2283 action steps, or as different types of TODO items. The first
2284 keywords are states requiring action - these states will select a headline
2285 for inclusion into the global TODO list Org-mode produces. If one of
2288 the last keyword is treated as the only DONE state of the sequence.
2291 additional state where no keyword is present. For details about this
2292 cycling, see the manual.
2294 TODO keywords and interpretation can also be set on a per-file basis with
2295 the special #+SEQ_TODO and #+TYP_TODO lines.
2297 Each keyword can optionally specify a character for fast state selection
2298 \(in combination with the variable `org-use-fast-todo-selection')
2299 and specifiers for state change logging, using the same syntax that
2302 indicates to record a time stamp each time this state is selected.
2304 Each keyword may also specify if a timestamp or a note should be
2305 recorded when entering or leaving the state, by adding additional
2306 characters in the parenthesis after the keyword. This looks like this:
2308 record only the time of the state change. With X and Y being either
2310 Y when leaving the state if and only if the *target* state does not
2311 define X. You may omit any of the fast-selection key or X or /Y,
2312 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2314 For backward compatibility, this variable may also be just a list
2315 of keywords. In this case the interpretation (sequence or type) will be
2316 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2326 ;;Quick and dirty way to see
2327 ;;`org-todo-interpretations'. This takes the
2328 ;;place of item arguments
2329 :convert-widget
2336 org-todo-interpretation-widgets))
2337 widget))
2373 "Controls how TODO keywords are interpreted.
2374 This variable is in principle obsolete and is only used for
2375 backward compatibility, if the interpretation of todo keywords is
2376 not given already in `org-todo-keywords'. See that variable for
2377 more information."
2384 "Non-nil means use the fast todo selection scheme with C-c C-t.
2385 This variable describes if and under what circumstances the cycling
2386 mechanism for TODO keywords will be replaced by a single-key, direct
2387 selection scheme.
2389 When nil, fast selection is never used.
2391 When the symbol `prefix', it will be used when `org-todo' is called
2392 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2393 `C-u t' in an agenda buffer.
2395 When t, fast selection is used by default. In this case, the prefix
2396 argument forces cycling instead.
2398 In all cases, the special interface is only used if access keys have
2399 actually been assigned by the user, i.e. if keywords in the configuration
2400 are followed by a letter in parenthesis, like TODO(t)."
2408 "Non-nil means update todo statistics after insert and toggle.
2409 ALL-HEADLINES means update todo statistics by including headlines
2410 with no TODO keyword as well, counting them as not done.
2411 A list of TODO keywords means the same, but skip keywords that are
2412 not in this list.
2414 When this is set, todo statistics is updated in the parent of the
2415 current entry each time a todo state is changed."
2425 "Non-nil means TODO statistics covers just direct children.
2426 When nil, all entries in the subtree are considered.
2427 This has only an effect if `org-provide-todo-statistics' is set.
2428 To set this to nil for only a single subtree, use a COOKIE_DATA
2434 "Hook which is run after the state of a TODO item was changed.
2435 The new state (a string with a TODO keyword, or nil) is available in the
2436 Lisp variable `org-state'."
2441 "Hook for functions that are allowed to block a state change.
2443 Functions in this hook should not modify the buffer.
2444 Each function gets as its single argument a property list,
2445 see `org-trigger-hook' for more information about this list.
2447 If any of the functions in this hook returns nil, the state change
2451 "Hook for functions that are triggered by a state change.
2453 Each function gets as its single argument a property list with at
2454 least the following elements:
2456 (:type type-of-change :position pos-at-entry-start
2457 :from old-state :to new-state)
2459 Depending on the type, more properties may be present.
2461 This mechanism is currently implemented for:
2463 TODO state changes
2464 ------------------
2465 :type todo-state-change
2466 :from previous state (keyword as a string), or nil, or a symbol
2467 'todo' or 'done', to indicate the general type of state.
2471 "Non-nil means undone TODO entries will block switching the parent to DONE.
2472 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2473 be blocked if any prior sibling is not yet done.
2474 Finally, if the parent is blocked because of ordered siblings of its own,
2475 the child will also be blocked."
2487 "Non-nil means unchecked boxes will block switching the parent to DONE.
2488 When this is nil, checkboxes have no influence on switching TODO states.
2489 When non-nil, you first need to check off all check boxes before the TODO
2490 entry can be switched to DONE.
2491 This variable needs to be set before org.el is loaded, and you need to
2492 restart Emacs after a change to make the change effective. The only way
2493 to change is while Emacs is running is through the customize interface."
2505 "Non-nil means inserting a TODO heading is treated as state change.
2507 logging will apply if appropriate. When nil, the new TODO item will
2508 be inserted directly, and no logging will take place."
2513 "Non-nil means switching TODO states with S-cursor counts as state change.
2514 This is the default behavior. However, setting this to nil allows a
2515 convenient way to select a TODO state and bypass any logging associated
2516 with that."
2521 "Tag changes that should be triggered by TODO state changes.
2522 This is a list. Each entry is
2524 (state-change (tag . flag) .......)
2526 State-change can be a string with a state, and empty string to indicate the
2527 state that has no TODO keyword, or it can be one of the symbols `todo'
2528 or `done', meaning any not-done or done state, respectively."
2542 "Information to record when a task moves to the DONE state.
2544 Possible values are:
2546 nil Don't add anything, just change the keyword
2547 time Add a time stamp to the task
2548 note Prompt for a note and add it with template `org-log-note-headings'
2550 This option can also be set with on a per-file-basis with
2552 #+STARTUP: nologdone
2553 #+STARTUP: logdone
2554 #+STARTUP: lognotedone
2556 You can have local logging settings for a subtree by setting the LOGGING
2557 property to one or more of these keywords."
2565 ;; Normalize old uses of org-log-done.
2572 "Information to record when the scheduling date of a tasks is modified.
2574 Possible values are:
2576 nil Don't add anything, just change the date
2577 time Add a time stamp to the task
2578 note Prompt for a note and add it with template `org-log-note-headings'
2580 This option can also be set with on a per-file-basis with
2582 #+STARTUP: nologreschedule
2583 #+STARTUP: logreschedule
2584 #+STARTUP: lognotereschedule"
2593 "Information to record when the deadline date of a tasks is modified.
2595 Possible values are:
2597 nil Don't add anything, just change the date
2598 time Add a time stamp to the task
2599 note Prompt for a note and add it with template `org-log-note-headings'
2601 This option can also be set with on a per-file-basis with
2603 #+STARTUP: nologredeadline
2604 #+STARTUP: logredeadline
2605 #+STARTUP: lognoteredeadline
2607 You can have local logging settings for a subtree by setting the LOGGING
2608 property to one or more of these keywords."
2617 "Non-nil means record a note when clocking out of an item.
2618 This can also be configured on a per-file basis by adding one of
2619 the following lines anywhere in the buffer:
2621 #+STARTUP: lognoteclock-out
2622 #+STARTUP: nolognoteclock-out"
2628 "Non-nil means the CLOSED time stamp will contain date and time.
2629 When nil, only the date will be recorded."
2643 "Headings for notes added to entries.
2644 The value is an alist, with the car being a symbol indicating the note
2645 context, and the cdr is the heading to be used. The heading may also be the
2646 empty string.
2647 %t in the heading will be replaced by a time stamp.
2648 %T will be an active time stamp instead the default inactive one
2649 %d will be replaced by a short-format time stamp.
2650 %D will be replaced by an active short-format time stamp.
2651 %s will be replaced by the new TODO state, in double quotes.
2652 %S will be replaced by the old TODO state, in double quotes.
2653 %u will be replaced by the user name.
2654 %U will be replaced by the full user name.
2656 In fact, it is not a good idea to change the `state' entry, because
2657 agenda log mode depends on the format of these entries."
2663 "Heading when changing todo state (todo sequence only)"
2677 "Non-nil means insert state change notes and time stamps into a drawer.
2678 When nil, state changes notes will be inserted after the headline and
2679 any scheduling and clock lines, but not inside a drawer.
2681 The value of this variable should be the name of the drawer to use.
2682 LOGBOOK is proposed as the default drawer for this purpose, you can
2683 also set this to a string to define the drawer of your choice.
2687 A value of t or nil can also be set with on a per-file-basis with
2689 #+STARTUP: logdrawer
2690 #+STARTUP: nologdrawer
2692 If this variable is set, `org-log-state-notes-insert-after-drawers'
2693 will be ignored.
2695 You can set the property LOG_INTO_DRAWER to overrule this setting for
2696 a subtree."
2707 "Return the value of `org-log-into-drawer', but let properties overrule.
2708 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2709 used instead of the default value."
2718 "Non-nil means insert state change notes after any drawers in entry.
2719 Only the drawers that *immediately* follow the headline and the
2720 deadline/scheduled line are skipped.
2721 When nil, insert notes right after the heading and perhaps the line
2722 with deadline/scheduling if present.
2724 This variable will have no effect if `org-log-into-drawer' is
2725 set."
2731 "Non-nil means the latest state note will be directly after heading.
2732 When nil, the state change notes will be ordered according to time.
2734 This option can also be set with on a per-file-basis with
2736 #+STARTUP: logstatesreversed
2737 #+STARTUP: nologstatesreversed"
2743 "The TODO state to which a repeater should return the repeating task.
2744 By default this is the first task in a TODO sequence, or the previous state
2745 in a TODO_TYP set. But you can specify another task here.
2746 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2753 "Non-nil means record moving through the DONE state when triggering repeat.
2754 An auto-repeating task is immediately switched back to TODO when
2757 record a closing note, there will be no record of the task moving
2758 through DONE. This variable forces taking a note anyway.
2760 nil Don't force a record
2761 time Record a time stamp
2762 note Prompt for a note and add it with template `org-log-note-headings'
2764 This option can also be set with on a per-file-basis with
2766 #+STARTUP: nologrepeat
2767 #+STARTUP: logrepeat
2768 #+STARTUP: lognoterepeat
2770 You can have local logging settings for a subtree by setting the LOGGING
2771 property to one or more of these keywords."
2781 "Priorities in Org-mode."
2786 "Non-nil means priority commands are active.
2787 When nil, these commands will be disabled, so that you never accidentally
2788 set a priority."
2793 "The highest priority of TODO items. A character like ?A, ?B etc.
2794 Must have a smaller ASCII number than `org-lowest-priority'."
2799 "The lowest priority of TODO items. A character like ?A, ?B etc.
2800 Must have a larger ASCII number than `org-highest-priority'."
2805 "The default priority of TODO items.
2806 This is the priority an item gets if no explicit priority is given.
2807 When starting to cycle on an empty priority the first step in the cycle
2808 depends on `org-priority-start-cycle-with-default'. The resulting first
2809 step priority must not exceed the range from `org-highest-priority' to
2810 `org-lowest-priority' which means that `org-default-priority' has to be
2811 in this range exclusive or inclusive the range boundaries. Else the
2812 first step refuses to set the default and the second will fall back
2813 to (depending on the command used) the highest or lowest priority."
2818 "Non-nil means start with default priority when starting to cycle.
2819 When this is nil, the first step in the cycle will be (depending on the
2820 command used) one higher or lower than the default priority.
2821 See also `org-default-priority'."
2826 "Function to extract the priority from a string.
2827 The string is normally the headline. If this is nil Org computes the
2828 priority from the priority cookie like [#A] in the headline. It returns
2829 an integer, increasing by 1000 for each priority level.
2830 The user can set a different function here, which should take a string
2831 as an argument and return the numeric priority."
2839 "Options concerning time stamps and deadlines in Org-mode."
2844 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2845 When nil, these labeled time stamps are forces into the second line of an
2846 entry, just after the headline. When scheduling from the global TODO list,
2847 the time stamp will always be forced into the second line."
2852 "Formats for `format-time-string' which are used for time stamps.
2856 "Number of minutes to round time stamps to.
2857 These are two values, the first applies when first creating a time stamp.
2858 The second applies when changing it with the commands `S-up' and `S-down'.
2859 When changing the time stamp, this means that it will change in steps
2860 of N minutes, as given by the second value.
2862 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2863 numbers should be factors of 60, so for example 5, 10, 15.
2865 When this is larger than 1, you can still force an exact time stamp by using
2866 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2867 and by using a prefix arg to `S-up/down' to specify the exact number
2868 of minutes to shift."
2878 ;; Normalize old customizations of this variable.
2882 org-time-stamp-rounding-minutes)))
2885 "Non-nil means overlay custom formats over all time stamps.
2886 The formats are defined through the variable `org-time-stamp-custom-formats'.
2887 To turn this on on a per-file basis, insert anywhere in the file:
2888 #+STARTUP: customtime"
2896 "Custom formats for time stamps. See `format-time-string' for the syntax.
2897 These are overlaid over the default ISO format if the variable
2898 `org-display-custom-times' is set. Time like %H:%M should be at the
2899 end of the second format. The custom formats are also honored by export
2900 commands, if custom time display is turned on at the time of export."
2905 "Get the right format for a time string."
2910 f)))
2914 "The format string used when creating CLOCKSUM lines.
2915 This is also used when Org mode generates a time duration.
2917 The value can be a single format string containing two
2918 %-sequences, which will be filled with the number of hours and
2919 minutes in that order.
2921 Alternatively, the value can be a plist associating any of the
2922 keys :years, :months, :weeks, :days, :hours or :minutes with
2923 format strings. The time duration is formatted using only the
2924 time components that are needed and concatenating the results.
2925 If a time unit in absent, it falls back to the next smallest
2926 unit.
2928 The keys :require-years, :require-months, :require-days,
2929 :require-weeks, :require-hours, :require-minutes are also
2930 meaningful. A non-nil value for these keys indicates that the
2931 corresponding time component should always be included, even if
2932 its value is 0.
2935 For example,
2938 :require-minutes t)
2940 means durations longer than a day will be expressed in days,
2941 hours and minutes, and durations less than a day will always be
2942 expressed in hours and minutes (even for durations less than an
2943 hour).
2945 The value
2949 means durations longer than a day will be expressed in days and
2950 minutes, and durations less than a day will be expressed entirely
2951 in minutes (even for durations longer than an hour)."
2991 See `org-time-clocksum-format' for more on time clock formats."
2999 E.g. by default, one day is considered to be a 8 hours effort,
3000 so a task that has been clocked for 16 hours will be displayed
3001 as during 2 days in the clock display or in the clocktable.
3003 See `org-effort-durations' on how to set effort durations
3004 and `org-time-clocksum-format' for more on time clock formats."
3012 "The format string used when creating CLOCKSUM lines,
3013 or when Org mode generates a time duration, if
3014 `org-time-clocksum-use-fractional' is enabled.
3016 The value can be a single format string containing one
3017 %-sequence, which will be filled with the number of hours as
3018 a float.
3020 Alternatively, the value can be a plist associating any of the
3021 keys :years, :months, :weeks, :days, :hours or :minutes with
3022 a format string. The time duration is formatted using the
3023 largest time unit which gives a non-zero integer part. If all
3024 specified formats have zero integer part, the smallest time unit
3025 is used."
3042 "Number of days before expiration during which a deadline becomes active.
3043 This variable governs the display in sparse trees and in the agenda.
3044 When 0 or negative, it means use this number (the absolute value of it)
3045 even if a deadline has a different individual lead time specified.
3047 Custom commands can set this variable in the options section."
3053 "Number of days before a scheduled item becomes active.
3054 This variable governs the display in sparse trees and in the agenda.
3055 The default value (i.e. 0) means: don't delay scheduled item.
3056 When negative, it means use this number (the absolute value of it)
3057 even if a scheduled item has a different individual delay time
3058 specified.
3060 Custom commands can set this variable in the options section."
3068 "Non-nil means assume future for incomplete date input from user.
3069 This affects the following situations:
3070 1. The user gives a month but not a year.
3073 2. The user gives a day, but no month.
3076 it will be considered as *this* month.
3078 If you set this variable to the symbol `time', then also the following
3079 will work:
3081 3. If the user gives a time.
3082 If the time is before now, it will be interpreted as tomorrow.
3084 Currently none of this works for ISO week specifications.
3086 When this option is nil, the current day, month and year will always be
3087 used as defaults.
3089 See also `org-agenda-jump-prefer-future'."
3097 "Should the agenda jump command prefer the future for incomplete dates?
3098 The default is to do the same as configured in `org-read-date-prefer-future'.
3099 But you can also set a deviating value here.
3100 This may t or nil, or the symbol `org-read-date-prefer-future'."
3106 org-read-date-prefer-future)
3111 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3113 Depending on the system Emacs is running on, certain dates cannot
3114 be represented with the type used internally to represent time.
3115 Dates between 1970-1-1 and 2038-1-1 can always be represented
3116 correctly. Some systems allow for earlier dates, some for later,
3117 some for both. One way to find out it to insert any date into an
3118 Org buffer, putting the cursor on the year and hitting S-up and
3119 S-down to test the range.
3121 When this variable is set to t, the date/time prompt will not let
3122 you specify dates outside the 1970-2037 range, so it is certain that
3123 these dates will work in whatever version of Emacs you are
3124 running, and also that you can move a file from one Emacs implementation
3125 to another. WHenever Org is forcing the year for you, it will display
3126 a message and beep.
3128 When this variable is nil, Org will check if the date is
3129 representable in the specific Emacs implementation you are using.
3130 If not, it will force a year, usually the current year, and beep
3131 to remind you. Currently this setting is not recommended because
3132 the likelihood that you will open your Org files in an Emacs that
3133 has limited date range is not negligible.
3135 A workaround for this problem is to use diary sexp dates for time
3136 stamps outside of this range."
3142 "Non-nil means display current interpretation of date prompt live.
3143 This display will be in an overlay, in the minibuffer."
3148 "Non-nil means pop up a calendar when prompting for a date.
3149 In the calendar, the date can be selected with mouse-1. However, the
3150 minibuffer will also be active, and you can simply enter the date as well.
3151 When nil, only the minibuffer will be available."
3158 'org-read-date-minibuffer-setup-hook
3161 "Hook to be used to set up keys for the date/time interface.
3162 Add key definitions to `minibuffer-local-map', which will be a
3163 temporary copy.
3165 WARNING: This option is obsolete, you should use
3166 `org-read-date-minibuffer-local-map' to set up keys."
3171 "The hour when your day really ends. Must be an integer.
3172 This has influence for the following applications:
3174 the time given here, the day recognized as TODAY is actually yesterday.
3175 - When a date is read from the user and it is still before the time given
3176 here, the current date and time will be assumed to be yesterday, 23:59.
3177 Also, timestamps inserted in capture templates follow this rule.
3179 IMPORTANT: This is a feature whose implementation is and likely will
3180 remain incomplete. Really, it is only here because past midnight seems to
3181 be the favorite working time of John Wiegley :-)"
3186 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3187 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3189 23:59 of the previous day."
3195 "When non-nil, use the last clock out time for `org-todo'.
3196 Note that this option has precedence over the combined use of
3197 `org-use-effective-time' and `org-extend-today-until'."
3204 "Non-nil means S-down will increase the time in a time stamp.
3205 When nil, S-up will increase."
3210 "Non-nil means make the calendar window follow timestamp changes.
3211 When a timestamp is modified and the calendar window is visible, it will be
3212 moved to the new date."
3217 "Options concerning tags in Org-mode."
3222 "List of tags allowed in Org-mode files.
3223 When this list is nil, Org-mode will base TAG input on what is already in the
3224 buffer.
3225 The value of this variable is an alist, the car of each entry must be a
3226 keyword as a string, the cdr may be a character that is used to select
3227 that tag through the fast-tag-selection interface.
3228 See the manual for details."
3245 "List of tags that will always appear in all Org-mode files.
3246 This is in addition to any in buffer settings or customizations
3247 of `org-tag-alist'.
3248 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3249 The value of this variable is an alist, the car of each entry must be a
3250 keyword as a string, the cdr may be a character that is used to select
3251 that tag through the fast-tag-selection interface.
3252 See the manual for details.
3253 To disable these tags on a per-file basis, insert anywhere in the file:
3254 #+STARTUP: noptag"
3266 "If non-nil, always offer completion for all tags of all agenda files.
3267 Instead of customizing this variable directly, you might want to
3268 set it locally for capture buffers, because there no list of
3269 tags in that file can be created dynamically (there are none).
3271 (add-hook 'org-capture-mode-hook
3272 (lambda ()
3273 (set (make-local-variable
3274 'org-complete-tags-always-offer-all-agenda-tags)
3275 t)))"
3281 "List of tags that can be inherited by all entries in the file.
3282 The tags will be inherited if the variable `org-use-tag-inheritance'
3283 says they should be.
3287 "Non-nil means use fast tag selection scheme.
3288 This is a special interface to select and deselect tags with single keys.
3289 When nil, fast selection is never used.
3290 When the symbol `auto', fast selection is used if and only if selection
3291 characters for tags have been configured, either through the variable
3292 `org-tag-alist' or through a #+TAGS line in the buffer.
3293 When t, fast selection is always used and selection keys are assigned
3294 automatically if necessary."
3302 "Non-nil means fast tag selection exits after first change.
3303 When nil, you have to press RET to exit it.
3304 During fast tag selection, you can toggle this flag with `C-c'.
3305 This variable can also have the value `expert'. In this case, the window
3306 displaying the tags menu is not even shown, until you press C-c again."
3314 "Non-nil means fast tags selection interface will also offer TODO states.
3318 "The column to which tags should be indented in a headline.
3319 If this number is positive, it specifies the column. If it is negative,
3320 it means that the tags should be flushright to that column. For example,
3321 -80 works well for a normal 80 character screen.
3322 When 0, place tags directly after headline text, with only one space in
3323 between."
3328 "Non-nil keeps tags aligned when modifying headlines.
3329 Some operations (i.e. demoting) change the length of a headline and
3330 therefore shift the tags around. With this option turned on, after
3331 each such operation the tags are again aligned to `org-tags-column'."
3336 "Non-nil means tags in levels apply also for sublevels.
3337 When nil, only the tags directly given in a specific line apply there.
3338 This may also be a list of tags that should be inherited, or a regexp that
3339 matches tags that should be inherited. Additional control is possible
3340 with the variable `org-tags-exclude-from-inheritance' which gives an
3341 explicit list of tags to be excluded from inheritance, even if the value of
3342 `org-use-tag-inheritance' would select it for inheritance.
3344 If this option is t, a match early-on in a tree can lead to a large
3345 number of matches in the subtree when constructing the agenda or creating
3346 a sparse tree. If you only want to see the first match in a tree during
3347 a search, check out the variable `org-tags-match-list-sublevels'."
3356 "List of tags that should never be inherited.
3357 This is a way to exclude a few tags from inheritance. For way to do
3358 the opposite, to actively allow inheritance for selected tags,
3359 see the variable `org-use-tag-inheritance'."
3364 "Check if TAG is one that should be inherited."
3376 "Non-nil means list also sublevels of headlines matching a search.
3377 This variable applies to tags/property searches, and also to stuck
3378 projects because this search is based on a tags match as well.
3380 When set to the symbol `indented', sublevels are indented with
3381 leading dots.
3383 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3384 the sublevels of a headline matching a tag search often also match
3385 the same search. Listing all of them can create very long lists.
3386 Setting this variable to nil causes subtrees of a match to be skipped.
3388 This variable is semi-obsolete and probably should always be true. It
3389 is better to limit inheritance to certain tags using the variables
3390 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3398 "When set, tags are sorted using this function as a comparator."
3414 "Options concerning properties in Org-mode."
3419 "How property key/value pairs should be formatted by `indent-line'.
3420 When `indent-line' hits a property definition, it will format the line
3421 according to this format, mainly to make sure that the values are
3422 lined-up with respect to each other."
3427 "Alist of properties and functions to adjust inserted values.
3428 Elements of this alist must be of the form
3430 ([string] [function])
3432 where [string] must be a property name and [function] must be a
3433 lambda expression: this lambda expression must take one argument,
3434 the value to adjust, and return the new value as a string.
3438 and the clock summary:
3441 (let ((clocksum (org-clock-sum-current-item))
3442 (effort (org-duration-string-to-minutes
3444 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3451 "Non-nil means properties apply also for sublevels.
3453 This setting is chiefly used during property searches. Turning it on can
3454 cause significant overhead when doing a search, which is why it is not
3455 on by default.
3457 When nil, only the properties directly given in the current entry count.
3458 When t, every property is inherited. The value may also be a list of
3459 properties that should have inheritance, or a regular expression matching
3460 properties that should be inherited.
3462 However, note that some special properties use inheritance under special
3463 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3465 for valid values of a property.
3467 Note for programmers:
3468 When querying an entry with `org-entry-get', you can control if inheritance
3469 should be used. By default, `org-entry-get' looks only at the local
3470 properties. You can request inheritance by setting the inherit argument
3471 to t (to force inheritance) or to `selective' (to respect the setting
3472 in this variable)."
3481 "Check if PROPERTY is one that should be inherited."
3492 "The default column format, if no other format has been defined.
3493 This variable can be set on the per-file basis by inserting a line
3495 #+COLUMNS: %25ITEM ....."
3500 "The ellipses to be used when a field in column view is truncated.
3501 When this is the empty string, as many characters as possible are shown,
3502 but then there will be no visual indication that the field has been truncated.
3503 When this is a string of length N, the last N characters of a truncated
3504 field are replaced by this string. If the column is narrower than the
3505 ellipses string, only part of the ellipses string will be shown."
3510 "Function that modifies values for display in column view.
3511 For example, it can be used to cut out a certain part from a time stamp.
3512 The function must take 2 arguments:
3514 column-title The title of the column (*not* the property name)
3515 value The value that should be modified.
3517 The function should return the value that should be displayed,
3518 or nil if the normal value should be used."
3523 "The property that is being used to keep track of effort estimates.
3524 Effort estimates given in this property need to have the format H:MM."
3532 "List of property/value pairs that can be inherited by any entry.
3534 These are fixed values, for the preset properties. The user variable
3535 that can be used to add to this list is `org-global-properties'.
3537 The entries in this list are cons cells where the car is a property
3538 name and cdr is a string with the value. If the value represents
3543 "List of property/value pairs that can be inherited by any entry.
3545 This list will be combined with the constant `org-global-properties-fixed'.
3547 The entries in this list are cons cells where the car is a property
3548 name and cdr is a string with the value.
3550 You can set buffer-local values for the same purpose in the variable
3551 `org-file-properties' this by adding lines like
3553 #+PROPERTY: NAME VALUE"
3560 "List of property/value pairs that can be inherited by any entry.
3561 Valid for the current buffer.
3566 "Options concerning agenda views in Org-mode."
3571 "Variable used by org files to set a category for agenda display.
3572 Such files should use a file variable to set it, for example
3576 or contain a special line
3578 #+CATEGORY: ELisp
3580 If the file does not specify a category, then file's base name
3586 "The files to be used for agenda display.
3590 If an entry is a directory, all files in that directory that are matched by
3591 `org-agenda-file-regexp' will be part of the file list.
3593 If the value of the variable is not a list but a single file name, then
3594 the list of agenda files is actually stored and maintained in that file, one
3595 agenda file per line. In this file paths can be given relative to
3596 `org-directory'. Tilde expansion and environment variable substitution
3597 are also made."
3604 "Regular expression to match files for `org-agenda-files'.
3605 If any element in the list in that variable contains a directory instead
3606 of a normal file, all files in that directory that are matched by this
3607 regular expression will be included."
3612 "List of extra files to be searched by text search commands.
3613 These files will be searched in addition to the agenda files by the
3614 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3615 Note that these files will only be searched for text search commands,
3616 not for the other agenda views like todo lists, tag searches or the weekly
3617 agenda. This variable is intended to list notes and possibly archive files
3618 that should also be searched by these two commands.
3619 In fact, if the first element in the list is the symbol `agenda-archives',
3620 then all archive files of all agenda files will be added to the search
3621 scope."
3631 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3632 A nil value means to remove them, after a query, from the list."
3637 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3638 The command `org-calendar-goto-agenda' will be bound to this key. The
3639 default is the character `c' because then `c' can be used to switch back and
3640 forth between agenda and calendar."
3645 "The key to be installed in `calendar-mode-map' for adding diary entries.
3646 This option is irrelevant until `org-agenda-diary-file' has been configured
3647 to point to an Org-mode file. When that is the case, the command
3648 `org-agenda-diary-entry' will be bound to the key given here, by default
3649 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3650 if you want to continue doing this, you need to change this to a different
3651 key."
3656 "File to which to add new entries with the `i' key in agenda and calendar.
3657 When this is the symbol `diary-file', the functionality in the Emacs
3658 calendar will be used to add entries to the `diary-file'. But when this
3659 points to a file, `org-agenda-diary-entry' will be used instead."
3673 org-calendar-insert-diary-entry-key
3677 "Options for embedding LaTeX code into Org-mode."
3685 "Options for creating images from LaTeX fragments.
3686 This is a property list with the following properties:
3688 `default' means use the foreground of the default face.
3689 `auto' means use the foreground from the text face.
3691 `default' means use the background of the default face.
3692 `auto' means use the background from the text face.
3693 :scale a scaling factor for the size of the images, to get more pixels
3694 :html-foreground, :html-background, :html-scale
3695 the same numbers for HTML export.
3696 :matchers a list indicating which matchers should be used to
3697 find LaTeX fragments. Valid members of this list are:
3708 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3709 When nil, just push out a message."
3716 Use this to specify additional executable file say a jar file.
3718 When using MathToWeb as the converter, specify the full-path to
3719 your mathtoweb.jar file."
3727 "Command to convert LaTeX fragments to MathML.
3728 Replace format-specifiers in the command as noted below and use
3729 `shell-command' to convert LaTeX to MathML.
3730 %j: Executable file in fully expanded form as specified by
3731 `org-latex-to-mathml-jar-file'.
3732 %I: Input LaTeX file in fully expanded form
3733 %o: Output MathML file
3734 This command is used by `org-create-math-formula'.
3736 When using MathToWeb as the converter, set this to
3745 "Program to convert LaTeX fragments with.
3747 dvipng Process the LaTeX fragments to dvi file, then convert
3748 dvi files to png files using dvipng.
3749 This will also include processing of non-math environments.
3750 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3751 to convert pdf files to png files"
3759 "Path to store latex preview images.
3760 A relative path here creates many directories relative to the
3761 processed org files paths. An absolute path puts all preview
3762 images at the same place."
3768 "Return t if `org-latex-to-mathml-convert-command' is usable."
3771 org-latex-to-mathml-convert-command)
3773 org-latex-to-mathml-convert-command))))
3778 t))))))
3782 \[PACKAGES]
3783 \[DEFAULT-PACKAGES]
3785 % The settings below are copied from fullpage.sty
3798 "The document header used for processing LaTeX fragments.
3799 It is imperative that this header make sure that no page number
3800 appears on the page. The package defined in the variables
3801 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3803 header, or they will be appended."
3808 "Set the packages alist and make sure it has 3 elements per entry."
3812 x))
3813 val)))
3816 "Get the packages alist and make sure it has 3 elements per entry."
3820 x))
3840 "Alist of default packages to be inserted in the header.
3842 Change this only if one of the packages here causes an
3843 incompatibility with another package you are using.
3845 The packages in this list are needed by one part or another of
3846 Org mode to function properly:
3848 - inputenc, fontenc: for basic font and character selection
3849 - fixltx2e: Important patches of LaTeX itself
3850 - graphicx: for including images
3851 - longtable: For multipage tables
3852 - float, wrapfig: for figure placement
3853 - rotating: for sideways figures and tables
3854 - ulem: for underline and strike-through
3855 - amsmath: for subscript and superscript and math environments
3856 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
3857 for interpreting the entities in `org-entities'. You can skip
3858 some of these packages if you don't use any of their symbols.
3859 - hyperref: for cross references
3861 Therefore you should not modify this variable unless you know
3862 what you are doing. The one reason to change it anyway is that
3863 you might be loading some other package that conflicts with one
3864 of the default packages. Each cell is of the format
3866 the package also needs to be included when compiling LaTeX
3867 snippets into images for inclusion into non-LaTeX output."
3882 "Alist of packages to be inserted in every LaTeX header.
3884 These will be inserted after `org-latex-default-packages-alist'.
3885 Each cell is of the format:
3889 SNIPPET-FLAG, when t, indicates that this package is also needed
3890 when turning LaTeX snippets into images for inclusion into
3891 non-LaTeX output.
3893 Make sure that you only list packages here which:
3895 - you want in every file
3896 - do not conflict with the setup in `org-format-latex-header'.
3897 - do not conflict with the default packages in
3898 `org-latex-default-packages-alist'."
3912 "Settings for Org-mode appearance."
3917 "Non-nil means fontify only the stars in each headline.
3918 When nil, the entire headline is fontified.
3919 Changing it requires restart of `font-lock-mode' to become effective
3920 also in regions already fontified."
3925 "Non-nil means hide the first N-1 stars in a headline.
3926 This works by using the face `org-hide' for these stars. This
3927 face is white for a light background, and black for a dark
3928 background. You may have to customize the face `org-hide' to
3929 make this work.
3930 Changing it requires restart of `font-lock-mode' to become effective
3931 also in regions already fontified.
3932 You may also set this on a per-file basis by adding one of the following
3933 lines to the buffer:
3935 #+STARTUP: hidestars
3936 #+STARTUP: showstars"
3941 "List of symbols corresponding to keywords to be hidden the org buffer.
3942 For example, a value '(title) for this list will make the document's title
3943 appear in the buffer without the initial #+TITLE: keyword."
3952 "List of properties (as strings) with a special meaning.
3953 The default use of these custom properties is to let the user
3954 hide them with `org-toggle-custom-properties-visibility'."
3961 "Non-nil means change the face of a headline if it is marked DONE.
3962 Normally, only the TODO/DONE keyword indicates the state of a headline.
3963 When this is non-nil, the headline after the keyword is set to the
3964 `org-headline-done' as an additional indication."
3969 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3970 Changing this variable requires a restart of Emacs to take effect."
3975 "Non-nil means fontify the whole line for headings.
3976 This is useful when setting a background color for the
3977 org-level-* faces."
3982 "Non-nil means highlight LaTeX related syntax in the buffer.
3983 When non nil, the value should be a list containing any of the
3984 following symbols:
3985 `latex' Highlight LaTeX snippets and environments.
3986 `script' Highlight subscript and superscript.
3987 `entities' Highlight entities."
3999 "Non-nil mean font-lock should hide the emphasis marker characters."
4004 "Non-nil means show entities as UTF8 characters.
4011 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4017 "Regular expression for matching emphasis.
4018 After a match, the match groups contain these elements:
4019 0 The match of the full regular expression, including the characters
4020 before and after the proper match
4021 1 The character before the proper match, or empty at beginning of line
4022 2 The proper match, including the leading and trailing markers
4023 3 The leading marker like * or /, indicating the type of highlighting
4024 4 The text between the emphasis markers, not including the markers
4031 "Set variable and compute the emphasis regular expression."
4035 org-emphasis-alist org-emphasis-regexp-components)
4047 ;; make sure special characters appear at the right position in the class
4059 ;; Make the regexp
4067 body1
4079 body1
4085 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4086 ;; set this option proved cumbersome. See this message/thread:
4087 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4090 "Components used to build the regular expression for emphasis.
4091 This is a list with five entries. Terminology: In an emphasis string
4095 specify what is allowed/forbidden in each part:
4097 pre Chars allowed as prematch. Beginning of line will be allowed too.
4098 post Chars allowed as postmatch. End of line will be allowed too.
4099 border The chars *forbidden* as border characters.
4101 non-shy groups here, and don't allow newline here.
4102 newline The maximum number of newlines allowed in an emphasis exp.
4113 "Alist of characters and faces to emphasize text.
4114 Text starting and ending with a special character will be emphasized,
4115 for example *bold*, _underlined_ and /italic/. This variable sets the
4116 marker characters and the face to be used by font-lock for highlighting
4117 in Org-mode Emacs buffers.
4119 You need to reload Org or to restart Emacs after customizing this."
4134 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4137 ;;; Miscellaneous options
4140 "Completion in Org-mode."
4145 "Non-nil means use ido completion wherever possible.
4146 Note that `ido-mode' must be active for this variable to be relevant.
4147 If you decide to turn this variable on, you might well want to turn off
4148 `org-outline-path-complete-in-steps'.
4149 See also `org-completion-use-iswitchb'."
4154 "Non-nil means use iswitchb completion wherever possible.
4155 Note that `iswitchb-mode' must be active for this variable to be relevant.
4156 If you decide to turn this variable on, you might well want to turn off
4157 `org-outline-path-complete-in-steps'.
4158 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4164 Normal means, no org-mode-specific context."
4168 ;;; Functions and variables from their packages
4169 ;; Declared here to avoid compiler warnings
4171 ;; XEmacs only
4177 ;; Emacs only
4180 ;; Various packages
4199 org-agenda-format-item "org-agenda"
4226 ;;; Autoload and prepare some org modules
4228 ;; Some table stuff that needs to be defined here, because it is used
4229 ;; by the functions setting up org-mode or checking for table context.
4242 "Detect the first line outside a table when searching from within it.
4245 ;; Autoload the functions in org-table.el that are needed by functions here.
4254 ;;;###autoload
4256 "Unconditionally turn on `orgtbl-mode'."
4261 "Return t if the cursor is inside an org-type table.
4262 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4267 org-table-line-regexp)))
4268 nil))
4272 "Return t if and only if we are at a table.el table."
4279 "If there is a table.el table nearby, recognize it and move into it."
4285 nil
4295 t
4300 t)
4301 nil)
4302 nil))
4305 "Return t if the cursor is inside a hline in a table."
4310 nil))
4313 "Apply FUNCTION to the start of all tables in the buffer."
4323 ;; Exclude tables in src/example/verbatim/clocktable blocks
4331 ;; Declare and autoload functions from org-agenda.el
4343 "Return t when point (or POS) is in #+TBLFM line."
4358 "Return the buffer where the clock is currently running.
4359 Return nil if no clock is running."
4364 org-clock-update-time-maybe
4365 org-clocktable-shift)))
4368 "Check if the current buffer contains the running clock.
4369 If yes, offer to stop it and to save the buffer with the changes."
4378 "Check if this line starts a clock table, if yes, shift the time block."
4382 ;;;###autoload
4384 "Set up hooks for clock persistence."
4389 ;; Define the variable already here, to make sure we have it.
4391 "Non-nil if Org-Indent mode is enabled.
4394 ;; Autoload archiving code
4395 ;; The stuff that is needed for cycling and tags has to be defined here.
4398 "Options concerning archiving in Org-mode."
4403 "The location where subtrees should be archived.
4405 The value of this variable is a string, consisting of two parts,
4406 separated by a double-colon. The first part is a filename and
4407 the second part is a headline.
4409 When the filename is omitted, archiving happens in the same file.
4410 %s in the filename will be replaced by the current file
4411 name (without the directory part). Archiving to a different file
4412 is useful to keep archived entries from contributing to the
4413 Org-mode Agenda.
4415 The archived entries will be filed as subtrees of the specified
4416 headline. When the headline is omitted, the subtrees are simply
4417 filed away at the end of the file, as top-level entries. Also in
4418 the heading you can use %s to represent the file name, this can be
4419 useful when using the same archive for a number of different files.
4421 Here are a few examples:
4423 If the current file is Projects.org, archive in file
4424 Projects.org_archive, as top-level trees. This is the default.
4427 Archive in the current file, under the top-level headline
4431 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4434 Archive in file ~/org/archive.org (absolute path), under headlines
4439 items to the datetree. Items are placed in either the CLOSED
4440 date of the item, or the current date if there is no CLOSED date.
4441 The heading will be a subentry to the current date. There doesn't
4442 need to be a heading, but there always needs to be a slash after
4443 datetree. For example, to store archived items directly in the
4447 Archive in file ./basement (relative path), as level 3 trees
4450 You may set this option on a per-file basis by adding to the buffer a
4451 line like
4453 #+ARCHIVE: basement::** Finished Tasks
4455 You may also define it locally for a subtree by setting an ARCHIVE property
4456 in the entry. If such a property is found in an entry, or anywhere up
4457 the hierarchy, it will be used."
4462 "The tag that marks a subtree as archived.
4463 An archived subtree does not open during visibility cycling, and does
4464 not contribute to the agenda listings.
4465 After changing this, font-lock must be restarted in the relevant buffers to
4466 get the proper fontification."
4472 "Non-nil means the agenda will skip any items located in archived trees.
4473 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4474 variable is no longer recommended, you should leave it at the value t.
4475 Instead, use the key `v' to cycle the archives-mode in the agenda."
4481 "Non-nil means ignore archived trees when creating column view."
4487 "Non-nil means `org-cycle' will open archived trees.
4488 An archived tree is a tree marked with the tag ARCHIVE.
4489 When nil, archived trees will stay folded. You can still open them with
4490 normal outline commands like `show-all', but not with the cycling commands."
4496 "Non-nil means sparse tree construction shows matches in archived trees.
4497 When nil, matches in these trees are highlighted, but the trees are kept in
4498 collapsed state."
4504 "The default date type when building a sparse tree.
4505 When this is nil, a date is a scheduled or a deadline timestamp.
4506 Otherwise, these types are allowed:
4508 all: all timestamps
4509 active: only active timestamps (<...>)
4510 inactive: only inactive timestamps (<...)
4511 scheduled: only scheduled timestamps
4512 deadline: only deadline timestamps"
4524 "Re-hide all archived subtrees after a visibility state change."
4535 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4538 "Cycle subtree even if it is archived."
4545 "Re-hide all archived subtrees after a visibility state change."
4562 flag)))
4570 ;; Autoload Column View Code
4578 org-columns-get-format-and-top-level
4579 org-columns-compute
4580 org-columns-remove-overlays))
4582 ;; Autoload ID code
4590 org-id-copy
4591 org-id-get-with-outline-path-completion
4592 org-id-get-with-outline-drilling))
4594 ;;; Variables for pre-computed regular expressions, all buffer local
4612 "Matches a headline and puts everything into groups:
4613 group 1: the stars
4614 group 2: The todo keyword, maybe
4615 group 3: Priority cookie
4616 group 4: True headline
4620 "Printf format to make regexp to match an exact headline.
4621 This regexp will match the headline of any node which has the
4622 exact headline text that is put into the format, but may have any
4626 "Matches a headline and puts TODO state into group 2 if present.
4678 "Regular expression to match a plain time or time range.
4679 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4680 groups carry important information:
4681 0 the full match
4682 1 the first time, range or not
4690 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4691 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4692 groups carry important information:
4693 0 the full match
4694 7 hours of duration
4703 "Regular expression to match a timestamp time or time range.
4704 After a match, the following groups carry important information:
4705 0 the full match
4706 1 date plus weekday, for back referencing to make sure both times are on the same day
4707 2 the first time, range or not
4768 "Variable associated with STARTUP options for org-mode.
4769 Each element is a list of three items: the startup options (as written
4770 in the #+STARTUP line), the corresponding variable, and the value to set
4771 this variable to if the option is found. An optional forth element PUSH
4775 "Update PROPS with KEY and VAL."
4789 "Printf format for a regexp matching a headline with some keyword.
4790 This regexp will match the headline of any node which has the
4791 exact keyword that is put into the format. The keyword isn't in
4795 "Printf format for a regexp matching a headline, possibly with some keyword.
4796 This regexp can match any headline with the specified keyword, or
4797 without a keyword. The keyword isn't in any group by default,
4801 "When non-nil (the default), use group tags.
4802 This can be turned on/off through `org-toggle-tags-groups'."
4810 "Toggle support for group tags.
4811 Support for group tags is controlled by the option
4812 `org-group-tags', which is non-nil by default."
4816 org-group-tags)
4824 "Precompute variables used for tags."
4830 tags ftags key value)
4847 ftags
4851 ;; Process the file tags.
4855 ;; Process the tags.
4866 org-tag-alist)))
4875 org-tag-groups-alist)
4898 ;; Return a list with tag variables
4903 "Precompute regular expressions used in the current buffer."
4921 kwds kws0 kwsa key log value cat arch const links hw dws
4922 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4930 ext-setup-or-nil
4938 ;; Append setupfile tags to existing tags
4942 org-tag-alist
4944 org-tag-groups-alist
4962 ;; general TODO-like setup
4971 links)))
4978 props))))
4985 l var val)
5003 ;; Prevent checking in Gnus messages
5015 ;; search for property blocks
5024 props)))))))
5039 ;; Process the TODO keywords
5041 ;; Use the global values as if they had been given locally.
5053 kws)))
5056 kwsa nil
5059 ;; 1 2
5067 kw)
5069 kws0)
5086 ;; Compute the regular expressions and other local variables.
5087 ;; Using `org-outline-regexp-bol' would complicate them much,
5088 ;; because of the fixed white space at the end of that string.
5096 org-drawer-regexp
5100 org-not-done-keywords
5102 org-todo-regexp
5106 org-not-done-regexp
5110 org-not-done-heading-regexp
5112 org-todo-line-regexp
5114 org-complex-heading-regexp
5121 org-complex-heading-regexp-format
5126 ;; Stats cookies can be stuck to body.
5133 org-todo-line-tags-regexp
5140 org-deadline-time-regexp
5142 org-deadline-time-hour-regexp
5145 org-deadline-line-regexp
5147 org-scheduled-regexp
5149 org-scheduled-time-regexp
5151 org-scheduled-time-hour-regexp
5154 org-closed-time-regexp
5156 org-keyword-time-regexp
5162 org-keyword-time-not-clock-regexp
5168 org-maybe-keyword-time-regexp
5174 org-all-time-keywords
5177 org-clock-string org-closed-string)))
5182 "Return the contents of FILE, as a string."
5193 "Extract the log state setting from a TODO keyword string.
5207 "Remove a pair of parenthesis at the end of each string in LIST."
5211 x))
5212 list))
5215 "Assign fast keys to a keyword-key alist.
5216 Respect keys that are already there."
5234 ;;; Some variables used in various places
5241 "Function to be called when `C-c C-c' is used.
5245 ;; FIXME: Occasionally check by commenting these, to make sure
5246 ;; no other functions uses these, forgetting to let-bind them.
5251 ;; Defined somewhere in this file, but used before definition.
5257 ;;;; Define the Org-mode
5259 ;; We use a before-change function to check if a table might need
5260 ;; an update.
5262 "Indicates that a table might need an update.
5263 This variable is set by `org-before-change-function'.
5266 "Every change indicates that a table might need an update."
5280 (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"))
5283 ;; Other stuff we need.
5289 ;; (require 'org-macs) moved higher up in the file before it is first used
5291 ;; (require 'org-compat) moved higher up in the file before it is first used
5299 ;; babel
5302 ;;;###autoload
5304 "Outline-based notes management and organizer, alias
5307 Org-mode develops organizational tasks around a NOTES file which
5308 contains information about projects as plain text. Org-mode is
5309 implemented on top of outline-mode, which is ideal to keep the content
5310 of large files well structured. It supports ToDo items, deadlines and
5311 time stamps, which magically appear in the diary listing of the Emacs
5312 calendar. Tables are easily created with a built-in table editor.
5313 Plain text URL-like links connect to websites, emails (VM), Usenet
5314 messages (Gnus), BBDB entries, and any files related to the project.
5315 For printing and sharing of notes, an Org-mode file (or a part of it)
5316 can be exported as a structured ASCII or HTML file.
5318 The following commands are available:
5322 ;; Get rid of Outline menus, they are not needed
5323 ;; Need to do this here because define-derived-mode sets up
5324 ;; the keymap so late. Still, it is a waste to call this each time
5325 ;; we switch another buffer into org-mode.
5328 ;; Assume this is Greg's port, it uses easymenu
5354 org-display-table 4
5357 org-ellipsis)))
5364 ;; tag faces set outside customize.... force initialization.
5366 ;; Calc embedded
5368 ;; Modify a few syntax entries
5375 ;; Activate before-change-function
5379 ;; Check for running clock before killing a buffer
5381 ;; Initialize macros templates.
5383 ;; Initialize radio targets.
5385 ;; Indentation.
5388 ;; Filling and auto-filling.
5390 ;; Comments.
5392 ;; Beginning/end of defun
5395 ;; Next error for sparse trees
5397 ;; Make sure dependence stuff works reliably, even for users who set it
5398 ;; too late :-(
5410 ;; Align options lines
5412 'align-mode-rules-list
5417 ;; Imenu
5421 ;; Make isearch reveal context
5424 ;; Emacs 21 and XEmacs make use of the hook
5426 ;; Emacs 22 deals with this through a special variable
5431 ;; Setup the pcomplete hooks
5444 ;; If empty file that did not turn on org-mode automatically, make it to.
5460 ;; Try to set org-hide correctly
5463 ;; Update `customize-package-emacs-version-alist'
5473 org-emphasis-alist)
5474 st))
5487 "unspecified-bg"
5500 "Current time, possibly rounded to ROUNDING-MINUTES.
5501 When ROUNDING-MINUTES is not an integer, fall back on the car of
5502 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5503 the rounding returns a past time."
5515 res))))
5518 "Return today date, considering `org-extend-today-until'."
5523 ;;;; Font-Lock stuff, including the activators
5554 "Regular expression used to analyze links.
5555 Here is what the match groups contain after a match:
5556 1: http:
5557 2: http
5558 3: path
5559 4: [desc]
5570 "Create a regular expression which will match a balanced sexp.
5571 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5572 as single character strings.
5573 The regexp returned will match the entire expression including the
5574 delimiters. It will also define a single group which contains the
5575 match except for the outermost delimiters. The maximum depth of
5576 stacked delimiters is N. Escaping delimiters is not possible."
5605 "Update the link regular expressions.
5606 This should be called after the variable `org-link-types' has changed."
5610 org-link-re-with-space
5616 org-link-re-with-space2
5622 org-link-re-with-space3
5627 org-angle-link-re
5633 org-plain-link-re
5637 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5638 org-bracket-link-regexp
5640 org-bracket-link-analytic-regexp
5648 org-bracket-link-analytic-regexp++
5656 org-any-link-re
5665 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5668 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5669 "Regular expression matching time strings for analysis.
5670 This one does not require the space after the date, so it can be used
5672 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5689 "Regular expression matching a time stamp or time stamp range.
5695 "Run through the buffer and add overlays to emphasized strings."
5704 'face
5717 rtn))
5720 "Insert or change an emphasis, i.e. a font like bold or italic.
5721 If there is an active region, change that region to a new emphasis.
5722 If there is no region, just insert the marker characters and position
5723 the cursor between them.
5724 CHAR should be the marker character. If it is a space, it means to
5725 remove the emphasis of the selected region.
5726 If CHAR is not given (for example in an interactive call) it will be
5727 prompted for."
5770 "Run through the buffer and add overlays to links."
5779 nil
5786 t)))
5794 t)))
5797 "When non-nil, fontify code in code blocks."
5804 "When non-nil, allow promoting a top level subtree.
5805 The leading star of the top level headline will be replaced
5806 by a #."
5817 "Fontify #+ lines and blocks."
5820 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5821 limit t)
5829 end end1 quoting block-type ovl)
5832 ;; a single line of backend-specific content
5840 ; for backend-specific code
5841 t)
5843 ;; Truly a block
5856 beg end
5864 ;; remove old background overlays
5869 ;; add a background overlay
5884 t))
5904 t)
5910 ;; just any other in-buffer setting, but not indented
5914 t)
5918 "Run through the buffer and add overlays to links."
5927 t)))
5930 "Run through the buffer and add overlays to footnotes."
5937 'keymap org-mouse-map
5938 'help-echo
5940 "Footnote definition"
5942 'font-lock-fontified t
5943 'font-lock-multiline t
5947 "Run through the buffer and add overlays to bracketed links."
5960 ;; We need to remove the invisible property here. Table narrowing
5961 ;; may have made some of this invisible.
5979 t)))
5982 "Run through the buffer and add overlays to dates."
5995 t)))
6004 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
6008 "Run through the buffer and add overlays to target matches."
6016 'keymap org-mouse-map
6020 t)))))
6023 "Find all radio targets in this file and update the regular expression."
6038 t)))
6046 "Compute regular expression for LaTeX, entities and sub/superscript.
6047 Result depends on variable `org-highlight-latex-and-related'."
6049 'org-latex-and-related-regexp
6061 org-latex-regexps)))))
6068 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6069 LIMIT bounds the search for syntax to highlight. Stop at first
6070 highlighted object, if any. Return t if some highlighting was
6071 done, nil otherwise."
6080 1
6088 nil)))
6091 "Restart `font-lock-mode', to force refontification."
6097 "Return a list of all targets in this file.
6098 When optional argument RADIO is non-nil, only find radio
6099 targets."
6104 ;; Make sure point is really within the object.
6109 rtn)))
6112 "Make regular expression matching all strings in TARGETS.
6113 The regular expression finds the targets also if there is a line break
6114 between words."
6123 x)
6124 targets
6136 t)))
6139 "Compute the outline level of the heading at point.
6140 If this is called at a normal headline, the level is the number of stars.
6141 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6146 0
6153 "Return a regexp matching a PROPERTY line.
6154 Match group 3 will be set to the value if it exists."
6161 "Regular expression matching a property line.
6162 There are four matching groups:
6163 1: :PROPKEY: including the leading and trailing colon,
6164 2: PROPKEY without the leading and trailing colon,
6165 3: PROPVAL without leading or trailing spaces,
6166 4: the indentation of the current line,
6173 "Functions that can manipulate `org-font-lock-extra-keywords'.
6174 This is called after `org-font-lock-extra-keywords' is defined, but before
6175 it is installed to be used by font lock. This can be useful if something
6179 "Run `org-font-lock-hook' within LIMIT."
6183 "Set font lock defaults for the current buffer."
6188 ;; Call the hook
6190 ;; Headlines
6197 ;; Table lines
6200 ;; Table internals
6205 ;; Drawers
6208 ;; Properties
6212 ;; Links
6220 ;; Targets.
6222 ;; Diary sexps.
6224 ;; Macro
6227 ;; TODO keyword
6229 org-todo-regexp)
6231 ;; DONE
6239 nil)
6240 ;; Priorities
6242 ;; Tags
6244 ;; Tags groups
6250 ;; Special keywords
6255 ;; Emphasis
6260 ;; Checkboxes
6261 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6266 ;; Description list items
6269 ;; ARCHIVEd headings
6271 org-outline-regexp-bol
6274 ;; Specials
6278 ;; Code
6280 ;; COMMENT
6286 ;; Blocks and meta lines
6290 ;; Now set the full font-lock-keywords
6297 "Toggle the composition display of entities as UTF8 characters."
6313 "Display or hide properties in `org-custom-properties'."
6330 org-custom-properties)))))))
6333 "Find an entity to fontify."
6339 limit t)
6354 nil))))
6357 "Fontify string S like in Org-mode."
6369 "Get the right face for match N in font-lock matching of headlines."
6382 "Get the right face for a TODO keyword KWD.
6383 If KWD is a number, get the corresponding match group."
6391 "Create a face list that inherits INHERIT, but sets the foreground color.
6392 When FACE-OR-COLOR is not a string, just return it."
6396 face-or-color)
6397 face-or-color))
6400 "Add the special tag faces."
6409 "Add the special priority faces."
6417 org-priority-faces)))
6422 "Get the right face for a TODO keyword KWD.
6423 If KWD is a number, get the corresponding match group."
6430 "Remove fontification and activation overlays from links."
6435 deactivate-mark buffer-file-name buffer-file-truename)
6439 invisible t intangible t
6440 org-no-flyspell t org-emphasis t))
6450 "Remove specific display properties that have been added by font lock.
6451 The will remove the raise properties that are used to show superscripts
6452 and subscripts."
6462 "Add raise properties to sub/superscripts."
6466 org-match-substring-regexp
6467 org-match-substring-with-braces-regexp)
6468 limit t)
6478 ;; Handle a_b^c
6481 t
6483 'display
6499 t)))))
6501 ;;;; Visibility cycling, including org-goto and indirect buffer
6503 ;;; Cycling
6515 "Display a message, but avoid logging it in the *Messages* buffer."
6519 ;;;###autoload
6521 "TAB-action and visibility cycling for Org-mode.
6523 This is the command invoked in Org-mode by the TAB key. Its main purpose
6524 is outline visibility cycling, but it also invokes other actions
6525 in special contexts.
6527 - When this function is called with a prefix argument, rotate the entire
6528 buffer through 3 states (global cycling)
6529 1. OVERVIEW: Show only top-level headlines.
6530 2. CONTENTS: Show all headlines of all levels, but no body text.
6531 3. SHOW ALL: Show everything.
6532 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6533 determined by the variable `org-startup-folded', and by any VISIBILITY
6534 properties in the buffer.
6535 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6536 including any drawers.
6538 - When inside a table, re-align the table and move to the next field.
6540 - When point is at the beginning of a headline, rotate the subtree started
6541 by this line through 3 different states (local cycling)
6542 1. FOLDED: Only the main headline is shown.
6543 2. CHILDREN: The main headline and the direct children are shown.
6544 From this state, you can move to one of the children
6545 and zoom in further.
6546 3. SUBTREE: Show the entire subtree, including body text.
6547 If there is no subtree, switch directly from CHILDREN to FOLDED.
6549 - When point is at the beginning of an empty headline and the variable
6550 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6551 of the headline by demoting and promoting it to likely levels. This
6552 speeds up creation document structure by pressing TAB once or several
6553 times right after creating a new headline.
6555 - When there is a numeric prefix, go up to a heading with level ARG, do
6556 a `show-subtree' and return to the previous cursor position. If ARG
6557 is negative, go up that many levels.
6559 - When point is not at the beginning of a headline, execute the global
6560 binding for TAB, which is re-indenting the line. See the option
6561 `org-cycle-emulate-tab' for details.
6563 - Special case: if point is at the beginning of the buffer and there is
6564 no headline in line 1, this function will act as if called with prefix arg
6565 (C-u TAB, same as S-TAB) also when called without prefix arg.
6566 But only if also the variable `org-cycle-global-at-bob' is t."
6576 org-inlinetask-min-level
6581 limit-level)))
6584 outline-regexp
6592 org-cycle-hook))
6596 ;; special case: use global cycling
6610 ;; Table: enter it or move to the next field.
6621 ;; Global cycling: delegate to `org-cycle-internal-global'.
6624 ;; Drawers: delegate to `org-flag-drawer'.
6632 ;; Show-subtree, ARG levels up from here.
6640 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6648 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6655 ;; From there: TAB emulation and template completion.
6677 t
6686 "Do the global cycling action."
6687 ;; Hack to avoid display of messages for .org attachments in Gnus
6692 ;; We just created the overview - now do table of contents
6693 ;; This can be slow in very large buffers, so indicate action
6703 ;; We just showed the table of contents - now show everything
6711 ;; Default action: go to overview
6721 "Do the local cycling action."
6723 ;; First, determine end of headline (EOH), end of subtree or item
6724 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6744 ;; Determine end invisible part of buffer (EOL)
6746 ;; XEmacs doesn't have `next-single-char-property-change'
6756 ;; Find out what to do next and set `this-command'
6759 ;; Nothing is hidden behind this heading
6772 org-cycle-skip-children-state-if-no-children))))
6773 ;; Entire subtree is hidden in one line: children view
6780 ;; FIXME: This slows down the func way too much.
6781 ;; How keep drawers hidden in subtree anyway?
6782 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6783 ;; (org-cycle-hide-drawers 'subtree))
6785 ;; Fold every list in subtree to top-level items.
6808 ;; We just showed the children, or no children are there,
6809 ;; now show everything.
6819 ;; Default action: hide the subtree.
6827 ;;;###autoload
6829 "Cycle the global visibility. For details see `org-cycle'.
6831 With a numeric prefix, show all headlines up to that level."
6847 "Set the visibility required by startup options and properties."
6862 "Switch subtree visibilities according to :VISIBILITY: property."
6869 nil t)
6893 ;; This function uses outline-regexp instead of the more fundamental
6894 ;; org-outline-regexp so that org-cycle-global works outside of Org
6895 ;; buffers, where outline-regexp is needed.
6897 "Switch to overview mode, showing only top-level headlines.
6898 Really, this shows all headlines with level equal or greater than the level
6899 of the first headline in the buffer. This is important, because if the
6900 first headline is not level one, then (hide-sublevels 1) gives confusing
6901 results."
6915 "Show all headlines in the buffer, like a table of contents.
6916 With numerical argument N, show content up to level N."
6919 ;; Visit all headings and show their offspring
6926 t)
6935 "Adjust the window after a change in outline visibility.
6936 This function is the default value of the hook `org-cycle-hook'."
6946 "Remove outline overlays that do not contain non-white stuff."
6956 "Fix visibility issues after moving a subtree."
6957 ;; First, find a reasonable region to look at:
6958 ;; Start two siblings above, end three below
6976 ;; Properly fold already folded siblings
6987 "Show empty lines above all visible headlines.
6988 The region to be covered depends on STATE when called through
6989 `org-cycle-hook'. Lisp program can use t for STATE to get the
6990 entire buffer covered. Note that an empty line is only shown if there
6991 are at least `org-cycle-separator-lines' empty lines before the headline."
7001 beg end b e)
7025 ;; Never hide empty lines at the end of the file.
7035 "Move to the parent and re-show empty lines before visible headlines."
7041 "Return `org-agenda-files' list, plus all open org-mode files.
7042 This is useful for operations that need to scan all of a user's
7043 open and agenda-wise Org files."
7051 files))
7054 "Return the beginning position of the current entry."
7058 "Return the end position of the current entry."
7062 "Re-hide all drawers after a visibility state change."
7077 "Re-hide inline tasks when switching to 'contents or 'children
7078 visibility state."
7092 "When FLAG is non-nil, hide the drawer we are within.
7093 Otherwise make it visible."
7105 "Is the end of the current subtree visible?"
7110 "Move cursor to the first headline and recenter the headline.
7111 Optional argument N means put the headline into the Nth line of the window."
7117 ;;; Saving and restoring visibility
7120 "Return a list of the locations of all outline overlays.
7121 These are overlays with the `invisible' property value `outline'.
7122 The return value is a list of cons cells, with start and stop
7123 positions for each overlay.
7124 If USE-MARKERS is set, return the positions as markers."
7142 "Create visibility overlays for all positions in DATA.
7143 DATA should have been made by `org-outline-overlay-data'."
7151 data)))))
7153 ;;; Folding of blocks
7160 "Call FUNCTION at the head of all source blocks in the current buffer.
7161 Optional arguments START and END can be used to limit the range."
7173 "Toggle the visibility of all blocks in the current buffer."
7177 "Fold all blocks in the current buffer."
7183 "Unfold all blocks in the current buffer."
7189 "Toggle visibility of block at point."
7200 "Toggle the visibility of the current block."
7207 ov)
7223 ;; make the block accessible to isearch
7225 ov 'isearch-open-invisible
7236 ;; org-tab-after-check-for-cycling-hook
7238 ;; Remove overlays when changing major mode
7243 ;;; Org-goto
7249 "Set the keymap `org-goto'."
7253 mouse-drag-region universal-argument org-occur))
7254 cmd)
7270 nil)
7271 (org-defkey map "q" 'org-goto-quit)
7272 (org-defkey map "n" 'outline-next-visible-heading)
7273 (org-defkey map "p" 'outline-previous-visible-heading)
7274 (org-defkey map "f" 'outline-forward-same-level)
7275 (org-defkey map "b" 'outline-backward-same-level)
7276 (org-defkey map "u" 'outline-up-heading))
7277 (org-defkey map "/" 'org-occur)
7278 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7279 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7280 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7281 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7282 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7283 map)))
7285 (defconst org-goto-help
7286 "Browse buffer copy, to find location or copy text.%s
7287 RET=jump to location C-g=quit and return to previous location
7288 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7290 (defvar org-goto-start-pos) ; dynamically scoped parameter
7292 (defun org-goto (&optional alternative-interface)
7293 "Look up a different location in the current file, keeping current visibility.
7295 When you want look-up or go to a different location in a
7296 document, the fastest way is often to fold the entire buffer and
7297 then dive into the tree. This method has the disadvantage, that
7298 the previous location will be folded, which may not be what you
7299 want.
7301 This command works around this by showing a copy of the current
7302 buffer in an indirect buffer, in overview mode. You can dive
7303 into the tree in that copy, use org-occur and incremental search
7304 to find a location. When pressing RET or `Q', the command
7305 returns to the original buffer in which the visibility is still
7306 unchanged. After RET it will also jump to the location selected
7307 in the indirect buffer and expose the headline hierarchy above.
7309 With a prefix argument, use the alternative interface: e.g. if
7310 `org-goto-interface' is 'outline use 'outline-path-completion."
7311 (interactive "P")
7312 (org-goto-map)
7313 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7314 (org-refile-use-outline-path t)
7315 (org-refile-target-verify-function nil)
7316 (interface
7317 (if (not alternative-interface)
7318 org-goto-interface
7319 (if (eq org-goto-interface 'outline)
7320 'outline-path-completion
7321 'outline)))
7322 (org-goto-start-pos (point))
7323 (selected-point
7324 (if (eq interface 'outline)
7325 (car (org-get-location (current-buffer) org-goto-help))
7326 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7327 (org-refile-check-position pa)
7328 (nth 3 pa)))))
7329 (if selected-point
7330 (progn
7331 (org-mark-ring-push org-goto-start-pos)
7332 (goto-char selected-point)
7333 (if (or (outline-invisible-p) (org-invisible-p2))
7334 (org-show-context 'org-goto)))
7335 (message "Quit"))))
7337 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7338 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7339 (defvar org-goto-local-auto-isearch-map) ; defined below
7341 (defun org-get-location (buf help)
7342 "Let the user select a location in the Org-mode buffer BUF.
7343 This function uses a recursive edit. It returns the selected position
7344 or nil."
7345 (org-no-popups
7346 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7347 (isearch-hide-immediately nil)
7348 (isearch-search-fun-function
7349 (lambda () 'org-goto-local-search-headings))
7350 (org-goto-selected-point org-goto-exit-command))
7351 (save-excursion
7352 (save-window-excursion
7353 (delete-other-windows)
7354 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7355 (org-pop-to-buffer-same-window
7356 (condition-case nil
7357 (make-indirect-buffer (current-buffer) "*org-goto*")
7358 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7359 (with-output-to-temp-buffer "*Org Help*"
7360 (princ (format help (if org-goto-auto-isearch
7361 " Just type for auto-isearch."
7362 " n/p/f/b/u to navigate, q to quit."))))
7363 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7364 (setq buffer-read-only nil)
7365 (let ((org-startup-truncated t)
7366 (org-startup-folded nil)
7367 (org-startup-align-all-tables nil))
7368 (org-mode)
7369 (org-overview))
7370 (setq buffer-read-only t)
7371 (if (and (boundp 'org-goto-start-pos)
7372 (integer-or-marker-p org-goto-start-pos))
7373 (let ((org-show-hierarchy-above t)
7374 (org-show-siblings t)
7375 (org-show-following-heading t))
7376 (goto-char org-goto-start-pos)
7377 (and (outline-invisible-p) (org-show-context)))
7378 (goto-char (point-min)))
7379 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7380 (message "Select location and press RET")
7381 (use-local-map org-goto-map)
7382 (recursive-edit)))
7383 (kill-buffer "*org-goto*")
7384 (cons org-goto-selected-point org-goto-exit-command))))
7386 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7387 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7388 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7389 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7391 (defun org-goto-local-search-headings (string bound noerror)
7392 "Search and make sure that any matches are in headlines."
7393 (catch 'return
7394 (while (if isearch-forward
7395 (search-forward string bound noerror)
7396 (search-backward string bound noerror))
7397 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7398 (and (member :headline context)
7399 (not (member :tags context))))
7400 (throw 'return (point))))))
7402 (defun org-goto-local-auto-isearch ()
7403 "Start isearch."
7404 (interactive)
7405 (goto-char (point-min))
7406 (let ((keys (this-command-keys)))
7407 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7408 (isearch-mode t)
7409 (isearch-process-search-char (string-to-char keys)))))
7411 (defun org-goto-ret (&optional arg)
7412 "Finish `org-goto' by going to the new location."
7413 (interactive "P")
7414 (setq org-goto-selected-point (point)
7415 org-goto-exit-command 'return)
7416 (throw 'exit nil))
7418 (defun org-goto-left ()
7419 "Finish `org-goto' by going to the new location."
7420 (interactive)
7421 (if (org-at-heading-p)
7422 (progn
7423 (beginning-of-line 1)
7424 (setq org-goto-selected-point (point)
7425 org-goto-exit-command 'left)
7426 (throw 'exit nil))
7427 (user-error "Not on a heading")))
7429 (defun org-goto-right ()
7430 "Finish `org-goto' by going to the new location."
7431 (interactive)
7432 (if (org-at-heading-p)
7433 (progn
7434 (setq org-goto-selected-point (point)
7435 org-goto-exit-command 'right)
7436 (throw 'exit nil))
7437 (user-error "Not on a heading")))
7439 (defun org-goto-quit ()
7440 "Finish `org-goto' without cursor motion."
7441 (interactive)
7442 (setq org-goto-selected-point nil)
7443 (setq org-goto-exit-command 'quit)
7444 (throw 'exit nil))
7446 ;;; Indirect buffer display of subtrees
7448 (defvar org-indirect-dedicated-frame nil
7449 "This is the frame being used for indirect tree display.")
7450 (defvar org-last-indirect-buffer nil)
7452 (defun org-tree-to-indirect-buffer (&optional arg)
7453 "Create indirect buffer and narrow it to current subtree.
7454 With a numerical prefix ARG, go up to this level and then take that tree.
7455 If ARG is negative, go up that many levels.
7457 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7458 indirect buffer previously made with this command, to avoid proliferation of
7459 indirect buffers. However, when you call the command with a \
7461 when `org-indirect-buffer-display' is `new-frame', the last buffer
7462 is kept so that you can work with several indirect buffers at the same time.
7463 If `org-indirect-buffer-display' is `dedicated-frame', the \
7465 requests that a new frame be made for the new buffer, so that the dedicated
7466 frame is not changed."
7467 (interactive "P")
7468 (let ((cbuf (current-buffer))
7469 (cwin (selected-window))
7470 (pos (point))
7471 beg end level heading ibuf)
7472 (save-excursion
7473 (org-back-to-heading t)
7474 (when (numberp arg)
7475 (setq level (org-outline-level))
7476 (if (< arg 0) (setq arg (+ level arg)))
7477 (while (> (setq level (org-outline-level)) arg)
7478 (org-up-heading-safe)))
7479 (setq beg (point)
7480 heading (org-get-heading))
7481 (org-end-of-subtree t t)
7482 (if (org-at-heading-p) (backward-char 1))
7483 (setq end (point)))
7484 (if (and (buffer-live-p org-last-indirect-buffer)
7485 (not (eq org-indirect-buffer-display 'new-frame))
7486 (not arg))
7487 (kill-buffer org-last-indirect-buffer))
7488 (setq ibuf (org-get-indirect-buffer cbuf)
7489 org-last-indirect-buffer ibuf)
7490 (cond
7491 ((or (eq org-indirect-buffer-display 'new-frame)
7492 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7493 (select-frame (make-frame))
7494 (delete-other-windows)
7495 (org-pop-to-buffer-same-window ibuf)
7496 (org-set-frame-title heading))
7497 ((eq org-indirect-buffer-display 'dedicated-frame)
7498 (raise-frame
7499 (select-frame (or (and org-indirect-dedicated-frame
7500 (frame-live-p org-indirect-dedicated-frame)
7501 org-indirect-dedicated-frame)
7502 (setq org-indirect-dedicated-frame (make-frame)))))
7503 (delete-other-windows)
7504 (org-pop-to-buffer-same-window ibuf)
7505 (org-set-frame-title (concat "Indirect: " heading)))
7506 ((eq org-indirect-buffer-display 'current-window)
7507 (org-pop-to-buffer-same-window ibuf))
7508 ((eq org-indirect-buffer-display 'other-window)
7509 (pop-to-buffer ibuf))
7510 (t (error "Invalid value")))
7511 (if (featurep 'xemacs)
7512 (save-excursion (org-mode) (turn-on-font-lock)))
7513 (narrow-to-region beg end)
7514 (show-all)
7515 (goto-char pos)
7516 (run-hook-with-args 'org-cycle-hook 'all)
7517 (and (window-live-p cwin) (select-window cwin))))
7519 (defun org-get-indirect-buffer (&optional buffer)
7520 (setq buffer (or buffer (current-buffer)))
7521 (let ((n 1) (base (buffer-name buffer)) bname)
7522 (while (buffer-live-p
7523 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7524 (setq n (1+ n)))
7525 (condition-case nil
7526 (make-indirect-buffer buffer bname 'clone)
7527 (error (make-indirect-buffer buffer bname)))))
7529 (defun org-set-frame-title (title)
7530 "Set the title of the current frame to the string TITLE."
7531 ;; FIXME: how to name a single frame in XEmacs???
7532 (unless (featurep 'xemacs)
7533 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7535 ;;;; Structure editing
7537 ;;; Inserting headlines
7539 (defun org-previous-line-empty-p (&optional next)
7540 "Is the previous line a blank line?
7541 When NEXT is non-nil, check the next line instead."
7542 (save-excursion
7543 (and (not (bobp))
7544 (or (beginning-of-line (if next 2 0)) t)
7545 (save-match-data
7548 (defun org-insert-heading (&optional arg invisible-ok)
7549 "Insert a new heading or item with same depth at point.
7550 If point is in a plain list and ARG is nil, create a new list item.
7551 With one universal prefix argument, insert a heading even in lists.
7552 With two universal prefix arguments, insert the heading at the end
7553 of the parent subtree.
7555 If point is at the beginning of a headline, insert a sibling before
7556 the current headline. If point is not at the beginning, split the line
7557 and create a new headline with the text in the current line after point
7558 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7560 If point is at the beginning of a normal line, turn this line into
7561 a heading.
7563 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7564 This is important for non-interactive uses of the command."
7565 (interactive "P")
7566 (if (org-called-interactively-p 'any) (org-reveal))
7567 (let ((itemp (org-in-item-p))
7568 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7569 (respect-content (or org-insert-heading-respect-content
7570 (equal arg '(16))))
7571 (initial-content "")
7572 (adjust-empty-lines t))
7574 (cond
7576 ((or (= (buffer-size) 0)
7577 (and (not (save-excursion
7578 (and (ignore-errors (org-back-to-heading invisible-ok))
7579 (org-at-heading-p))))
7580 (or arg (not itemp))))
7581 ;; At beginning of buffer or so high up that only a heading
7582 ;; makes sense.
7583 (insert
7585 (if (org-in-src-block-p) ",* " "* "))
7586 (run-hooks 'org-insert-heading-hook))
7588 ((and itemp (not (equal arg '(4))))
7589 ;; Insert an item
7590 (org-insert-item))
7592 (t
7593 ;; Insert a heading
7594 (save-restriction
7595 (widen)
7596 (let* ((level nil)
7597 (on-heading (org-at-heading-p))
7598 (empty-line-p (if on-heading
7599 (org-previous-line-empty-p)
7600 ;; We will decide later
7601 nil))
7602 ;; Get a level string to fall back on
7603 (fix-level
7604 (save-excursion
7605 (org-back-to-heading t)
7606 (if (org-previous-line-empty-p) (setq empty-line-p t))
7607 (looking-at org-outline-regexp)
7608 (make-string (1- (length (match-string 0))) ?*)))
7609 (stars
7610 (save-excursion
7611 (condition-case nil
7612 (progn
7613 (org-back-to-heading invisible-ok)
7614 (when (and (not on-heading)
7615 (featurep 'org-inlinetask)
7616 (integerp org-inlinetask-min-level)
7617 (>= (length (match-string 0))
7618 org-inlinetask-min-level))
7619 ;; Find a heading level before the inline task
7620 (while (and (setq level (org-up-heading-safe))
7621 (>= level org-inlinetask-min-level)))
7622 (if (org-at-heading-p)
7623 (org-back-to-heading invisible-ok)
7624 (error "This should not happen")))
7625 (unless (and (save-excursion
7626 (save-match-data
7627 (org-backward-heading-same-level
7628 1 invisible-ok))
7629 (= (point) (match-beginning 0)))
7630 (not (org-previous-line-empty-p t)))
7631 (setq empty-line-p (or empty-line-p
7632 (org-previous-line-empty-p))))
7633 (match-string 0))
7634 (error (or fix-level "* ")))))
7635 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7636 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7637 pos hide-previous previous-pos)
7639 ;; If we insert after content, move there and clean up whitespace
7640 (when respect-content
7641 (org-end-of-subtree nil t)
7644 (unless (eobp) (forward-char 1))
7646 (unless (bobp) (backward-char 1))
7649 ;; If we are splitting, grab the text that should be moved to the new headline
7650 (when may-split
7651 (if (org-on-heading-p)
7652 ;; This is a heading, we split intelligently (keeping tags)
7653 (let ((pos (point)))
7654 (goto-char (point-at-bol))
7655 (unless (looking-at org-complex-heading-regexp)
7656 (error "This should not happen"))
7657 (when (and (match-beginning 4)
7658 (> pos (match-beginning 4))
7659 (< pos (match-end 4)))
7660 (setq initial-content (buffer-substring pos (match-end 4)))
7661 (goto-char pos)
7662 (delete-region (point) (match-end 4))
7664 (replace-match "")
7665 (insert (make-string (length initial-content) ?\ )))
7666 (setq initial-content (org-trim initial-content)))
7667 (goto-char pos))
7668 ;; a normal line
7669 (unless (bolp)
7670 (setq initial-content (buffer-substring (point) (point-at-eol)))
7671 (delete-region (point) (point-at-eol))
7672 (setq initial-content (org-trim initial-content)))))
7674 ;; If we are at the beginning of the line, insert before it. Else after
7675 (cond
7678 (open-line 1))
7679 (t
7680 (goto-char (point-at-eol))
7683 ;; Insert the new heading
7684 (insert stars)
7685 (just-one-space)
7686 (insert initial-content)
7687 (when adjust-empty-lines
7688 (if (or (not blank)
7689 (and blank (not (org-previous-line-empty-p))))
7690 (org-N-empty-lines-before-current (if blank 1 0))))
7691 (run-hooks 'org-insert-heading-hook)))))))
7693 (defun org-N-empty-lines-before-current (N)
7694 "Make the number of empty lines before current exactly N.
7695 So this will delete or add empty lines."
7696 (save-excursion
7697 (goto-char (point-at-bol))
7699 (replace-match ""))
7701 (while (> N 0)
7703 (setq N (1- N)))))
7705 (defun org-get-heading (&optional no-tags no-todo)
7706 "Return the heading of the current entry, without the stars.
7707 When NO-TAGS is non-nil, don't include tags.
7708 When NO-TODO is non-nil, don't include TODO keywords."
7709 (save-excursion
7710 (org-back-to-heading t)
7711 (cond
7712 ((and no-tags no-todo)
7713 (looking-at org-complex-heading-regexp)
7714 (match-string 4))
7715 (no-tags
7716 (looking-at (concat org-outline-regexp
7719 (match-string 1))
7720 (no-todo
7721 (looking-at org-todo-line-regexp)
7722 (match-string 3))
7723 (t (looking-at org-heading-regexp)
7724 (match-string 2)))))
7726 (defvar orgstruct-mode) ; defined below
7728 (defun org-heading-components ()
7729 "Return the components of the current heading.
7730 This is a list with the following elements:
7731 - the level as an integer
7732 - the reduced level, different if `org-odd-levels-only' is set.
7733 - the TODO keyword, or nil
7734 - the priority character, like ?A, or nil if no priority is given
7735 - the headline text itself, or the tags string if no headline text
7736 - the tags string, or nil."
7737 (save-excursion
7738 (org-back-to-heading t)
7739 (if (let (case-fold-search)
7740 (looking-at
7741 (if orgstruct-mode
7742 org-heading-regexp
7743 org-complex-heading-regexp)))
7744 (if orgstruct-mode
7745 (list (length (match-string 1))
7746 (org-reduced-level (length (match-string 1)))
7747 nil
7748 nil
7749 (match-string 2)
7750 nil)
7751 (list (length (match-string 1))
7752 (org-reduced-level (length (match-string 1)))
7753 (org-match-string-no-properties 2)
7754 (and (match-end 3) (aref (match-string 3) 2))
7755 (org-match-string-no-properties 4)
7756 (org-match-string-no-properties 5))))))
7758 (defun org-get-entry ()
7759 "Get the entry text, after heading, entire subtree."
7760 (save-excursion
7761 (org-back-to-heading t)
7762 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7764 (defun org-insert-heading-after-current ()
7765 "Insert a new heading with same level as current, after current subtree."
7766 (interactive)
7767 (org-back-to-heading)
7768 (org-insert-heading)
7769 (org-move-subtree-down)
7770 (end-of-line 1))
7772 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7773 "Insert heading with `org-insert-heading-respect-content' set to t."
7774 (interactive "P")
7775 (let ((org-insert-heading-respect-content t))
7776 (org-insert-heading '(4) invisible-ok)))
7778 (defun org-insert-todo-heading-respect-content (&optional force-state)
7779 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7780 (interactive "P")
7781 (let ((org-insert-heading-respect-content t))
7782 (org-insert-todo-heading force-state '(4))))
7784 (defun org-insert-todo-heading (arg &optional force-heading)
7785 "Insert a new heading with the same level and TODO state as current heading.
7786 If the heading has no TODO state, or if the state is DONE, use the first
7787 state (TODO by default). Also one prefix arg, force first state. With two
7788 prefix args, force inserting at the end of the parent subtree."
7789 (interactive "P")
7790 (when (or force-heading (not (org-insert-item 'checkbox)))
7791 (org-insert-heading (or (and (equal arg '(16)) '(16))
7792 force-heading))
7793 (save-excursion
7794 (org-back-to-heading)
7795 (outline-previous-heading)
7796 (looking-at org-todo-line-regexp))
7797 (let*
7798 ((new-mark-x
7799 (if (or arg
7800 (not (match-beginning 2))
7801 (member (match-string 2) org-done-keywords))
7802 (car org-todo-keywords-1)
7803 (match-string 2)))
7804 (new-mark
7805 (or
7806 (run-hook-with-args-until-success
7807 'org-todo-get-default-hook new-mark-x nil)
7808 new-mark-x)))
7809 (beginning-of-line 1)
7810 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7811 (if org-treat-insert-todo-heading-as-state-change
7812 (org-todo new-mark)
7813 (insert new-mark " "))))
7814 (when org-provide-todo-statistics
7815 (org-update-parent-todo-statistics))))
7817 (defun org-insert-subheading (arg)
7818 "Insert a new subheading and demote it.
7819 Works for outline headings and for plain lists alike."
7820 (interactive "P")
7821 (org-insert-heading arg)
7822 (cond
7823 ((org-at-heading-p) (org-do-demote))
7824 ((org-at-item-p) (org-indent-item))))
7826 (defun org-insert-todo-subheading (arg)
7827 "Insert a new subheading with TODO keyword or checkbox and demote it.
7828 Works for outline headings and for plain lists alike."
7829 (interactive "P")
7830 (org-insert-todo-heading arg)
7831 (cond
7832 ((org-at-heading-p) (org-do-demote))
7833 ((org-at-item-p) (org-indent-item))))
7835 ;;; Promotion and Demotion
7837 (defvar org-after-demote-entry-hook nil
7838 "Hook run after an entry has been demoted.
7839 The cursor will be at the beginning of the entry.
7840 When a subtree is being demoted, the hook will be called for each node.")
7842 (defvar org-after-promote-entry-hook nil
7843 "Hook run after an entry has been promoted.
7844 The cursor will be at the beginning of the entry.
7845 When a subtree is being promoted, the hook will be called for each node.")
7847 (defun org-promote-subtree ()
7848 "Promote the entire subtree.
7849 See also `org-promote'."
7850 (interactive)
7851 (save-excursion
7852 (org-with-limited-levels (org-map-tree 'org-promote)))
7853 (org-fix-position-after-promote))
7855 (defun org-demote-subtree ()
7856 "Demote the entire subtree. See `org-demote'.
7857 See also `org-promote'."
7858 (interactive)
7859 (save-excursion
7860 (org-with-limited-levels (org-map-tree 'org-demote)))
7861 (org-fix-position-after-promote))
7864 (defun org-do-promote ()
7865 "Promote the current heading higher up the tree.
7866 If the region is active in `transient-mark-mode', promote all headings
7867 in the region."
7868 (interactive)
7869 (save-excursion
7870 (if (org-region-active-p)
7871 (org-map-region 'org-promote (region-beginning) (region-end))
7872 (org-promote)))
7873 (org-fix-position-after-promote))
7875 (defun org-do-demote ()
7876 "Demote the current heading lower down the tree.
7877 If the region is active in `transient-mark-mode', demote all headings
7878 in the region."
7879 (interactive)
7880 (save-excursion
7881 (if (org-region-active-p)
7882 (org-map-region 'org-demote (region-beginning) (region-end))
7883 (org-demote)))
7884 (org-fix-position-after-promote))
7886 (defun org-fix-position-after-promote ()
7887 "Make sure that after pro/demotion cursor position is right."
7888 (let ((pos (point)))
7889 (when (save-excursion
7890 (beginning-of-line 1)
7891 (looking-at org-todo-line-regexp)
7892 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7893 (cond ((eobp) (insert " "))
7894 ((eolp) (insert " "))
7895 ((equal (char-after) ?\ ) (forward-char 1))))))
7897 (defun org-current-level ()
7898 "Return the level of the current entry, or nil if before the first headline.
7899 The level is the number of stars at the beginning of the headline."
7900 (save-excursion
7901 (org-with-limited-levels
7902 (if (ignore-errors (org-back-to-heading t))
7903 (funcall outline-level)))))
7905 (defun org-get-previous-line-level ()
7906 "Return the outline depth of the last headline before the current line.
7907 Returns 0 for the first headline in the buffer, and nil if before the
7908 first headline."
7909 (let ((current-level (org-current-level))
7910 (prev-level (when (> (line-number-at-pos) 1)
7911 (save-excursion
7912 (beginning-of-line 0)
7913 (org-current-level)))))
7914 (cond ((null current-level) nil) ; Before first headline
7915 ((null prev-level) 0) ; At first headline
7916 (prev-level))))
7918 (defun org-reduced-level (l)
7919 "Compute the effective level of a heading.
7920 This takes into account the setting of `org-odd-levels-only'."
7921 (cond
7922 ((zerop l) 0)
7923 (org-odd-levels-only (1+ (floor (/ l 2))))
7924 (t l)))
7926 (defun org-level-increment ()
7927 "Return the number of stars that will be added or removed at a
7928 time to headlines when structure editing, based on the value of
7929 `org-odd-levels-only'."
7930 (if org-odd-levels-only 2 1))
7932 (defun org-get-valid-level (level &optional change)
7933 "Rectify a level change under the influence of `org-odd-levels-only'
7934 LEVEL is a current level, CHANGE is by how much the level should be
7935 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7936 even level numbers will become the next higher odd number."
7937 (if org-odd-levels-only
7938 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7939 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7940 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7941 (max 1 (+ level (or change 0)))))
7943 (if (boundp 'define-obsolete-function-alias)
7944 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7945 (define-obsolete-function-alias 'org-get-legal-level
7946 'org-get-valid-level)
7947 (define-obsolete-function-alias 'org-get-legal-level
7948 'org-get-valid-level "23.1")))
7950 (defun org-promote ()
7951 "Promote the current heading higher up the tree.
7952 If the region is active in `transient-mark-mode', promote all headings
7953 in the region."
7954 (org-back-to-heading t)
7955 (let* ((level (save-match-data (funcall outline-level)))
7956 (after-change-functions (remove 'flyspell-after-change-function
7957 after-change-functions))
7958 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7959 (diff (abs (- level (length up-head) -1))))
7960 (cond ((and (= level 1) org-called-with-limited-levels
7961 org-allow-promoting-top-level-subtree)
7962 (replace-match "# " nil t))
7963 ((= level 1)
7964 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7965 (t (replace-match up-head nil t)))
7966 ;; Fixup tag positioning
7967 (unless (= level 1)
7968 (and org-auto-align-tags (org-set-tags nil t))
7969 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7970 (run-hooks 'org-after-promote-entry-hook)))
7972 (defun org-demote ()
7973 "Demote the current heading lower down the tree.
7974 If the region is active in `transient-mark-mode', demote all headings
7975 in the region."
7976 (org-back-to-heading t)
7977 (let* ((level (save-match-data (funcall outline-level)))
7978 (after-change-functions (remove 'flyspell-after-change-function
7979 after-change-functions))
7980 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7981 (diff (abs (- level (length down-head) -1))))
7982 (replace-match down-head nil t)
7983 ;; Fixup tag positioning
7984 (and org-auto-align-tags (org-set-tags nil t))
7985 (if org-adapt-indentation (org-fixup-indentation diff))
7986 (run-hooks 'org-after-demote-entry-hook)))
7988 (defun org-cycle-level ()
7989 "Cycle the level of an empty headline through possible states.
7990 This goes first to child, then to parent, level, then up the hierarchy.
7991 After top level, it switches back to sibling level."
7992 (interactive)
7993 (let ((org-adapt-indentation nil))
7994 (when (org-point-at-end-of-empty-headline)
7995 (setq this-command 'org-cycle-level) ; Only needed for caching
7996 (let ((cur-level (org-current-level))
7997 (prev-level (org-get-previous-line-level)))
7998 (cond
7999 ;; If first headline in file, promote to top-level.
8000 ((= prev-level 0)
8001 (loop repeat (/ (- cur-level 1) (org-level-increment))
8002 do (org-do-promote)))
8003 ;; If same level as prev, demote one.
8004 ((= prev-level cur-level)
8005 (org-do-demote))
8006 ;; If parent is top-level, promote to top level if not already.
8007 ((= prev-level 1)
8008 (loop repeat (/ (- cur-level 1) (org-level-increment))
8009 do (org-do-promote)))
8010 ;; If top-level, return to prev-level.
8011 ((= cur-level 1)
8012 (loop repeat (/ (- prev-level 1) (org-level-increment))
8013 do (org-do-demote)))
8014 ;; If less than prev-level, promote one.
8015 ((< cur-level prev-level)
8016 (org-do-promote))
8017 ;; If deeper than prev-level, promote until higher than
8018 ;; prev-level.
8019 ((> cur-level prev-level)
8020 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8021 do (org-do-promote))))
8022 t))))
8024 (defun org-map-tree (fun)
8025 "Call FUN for every heading underneath the current one."
8026 (org-back-to-heading)
8027 (let ((level (funcall outline-level)))
8028 (save-excursion
8029 (funcall fun)
8030 (while (and (progn
8031 (outline-next-heading)
8032 (> (funcall outline-level) level))
8033 (not (eobp)))
8034 (funcall fun)))))
8036 (defun org-map-region (fun beg end)
8037 "Call FUN for every heading between BEG and END."
8038 (let ((org-ignore-region t))
8039 (save-excursion
8040 (setq end (copy-marker end))
8041 (goto-char beg)
8042 (if (and (re-search-forward org-outline-regexp-bol nil t)
8043 (< (point) end))
8044 (funcall fun))
8045 (while (and (progn
8046 (outline-next-heading)
8047 (< (point) end))
8048 (not (eobp)))
8049 (funcall fun)))))
8051 (defvar org-property-end-re) ; silence byte-compiler
8052 (defun org-fixup-indentation (diff)
8053 "Change the indentation in the current entry by DIFF.
8054 However, if any line in the current entry has no indentation, or if it
8055 would end up with no indentation after the change, nothing at all is done."
8056 (save-excursion
8057 (let ((end (save-excursion (outline-next-heading)
8058 (point-marker)))
8059 (prohibit (if (> diff 0)
8062 col)
8063 (unless (save-excursion (end-of-line 1)
8064 (re-search-forward prohibit end t))
8065 (while (and (< (point) end)
8067 (goto-char (match-end 0))
8068 (setq col (current-column))
8069 (if (< diff 0) (replace-match ""))
8070 (org-indent-to-column (+ diff col))))
8071 (move-marker end nil))))
8073 (defun org-convert-to-odd-levels ()
8074 "Convert an org-mode file with all levels allowed to one with odd levels.
8075 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8076 level 5 etc."
8077 (interactive)
8078 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8079 (let ((outline-level 'org-outline-level)
8080 (org-odd-levels-only nil) n)
8081 (save-excursion
8082 (goto-char (point-min))
8084 (setq n (- (length (match-string 0)) 2))
8085 (while (>= (setq n (1- n)) 0)
8086 (org-demote))
8087 (end-of-line 1))))))
8089 (defun org-convert-to-oddeven-levels ()
8090 "Convert an org-mode file with only odd levels to one with odd/even levels.
8091 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8092 file contains a section with an even level, conversion would
8093 destroy the structure of the file. An error is signaled in this
8094 case."
8095 (interactive)
8096 (goto-char (point-min))
8097 ;; First check if there are no even levels
8099 (org-show-context t)
8100 (error "Not all levels are odd in this file. Conversion not possible"))
8101 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8102 (let ((outline-regexp org-outline-regexp)
8103 (outline-level 'org-outline-level)
8104 (org-odd-levels-only nil) n)
8105 (save-excursion
8106 (goto-char (point-min))
8108 (setq n (/ (1- (length (match-string 0))) 2))
8109 (while (>= (setq n (1- n)) 0)
8110 (org-promote))
8111 (end-of-line 1))))))
8113 (defun org-tr-level (n)
8114 "Make N odd if required."
8115 (if org-odd-levels-only (1+ (/ n 2)) n))
8117 ;;; Vertical tree motion, cutting and pasting of subtrees
8119 (defun org-move-subtree-up (&optional arg)
8120 "Move the current subtree up past ARG headlines of the same level."
8121 (interactive "p")
8122 (org-move-subtree-down (- (prefix-numeric-value arg))))
8124 (defun org-move-subtree-down (&optional arg)
8125 "Move the current subtree down past ARG headlines of the same level."
8126 (interactive "p")
8127 (setq arg (prefix-numeric-value arg))
8128 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8129 'org-get-last-sibling))
8130 (ins-point (make-marker))
8131 (cnt (abs arg))
8132 (col (current-column))
8133 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8134 ;; Select the tree
8135 (org-back-to-heading)
8136 (setq beg0 (point))
8137 (save-excursion
8138 (setq ne-beg (org-back-over-empty-lines))
8139 (setq beg (point)))
8140 (save-match-data
8141 (save-excursion (outline-end-of-heading)
8142 (setq folded (outline-invisible-p)))
8143 (outline-end-of-subtree))
8144 (outline-next-heading)
8145 (setq ne-end (org-back-over-empty-lines))
8146 (setq end (point))
8147 (goto-char beg0)
8148 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8149 ;; include less whitespace
8150 (save-excursion
8151 (goto-char beg)
8152 (forward-line (- ne-beg ne-end))
8153 (setq beg (point))))
8154 ;; Find insertion point, with error handling
8155 (while (> cnt 0)
8156 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8157 (progn (goto-char beg0)
8158 (user-error "Cannot move past superior level or buffer limit")))
8159 (setq cnt (1- cnt)))
8160 (if (> arg 0)
8161 ;; Moving forward - still need to move over subtree
8162 (progn (org-end-of-subtree t t)
8163 (save-excursion
8164 (org-back-over-empty-lines)
8165 (or (bolp) (newline)))))
8166 (setq ne-ins (org-back-over-empty-lines))
8167 (move-marker ins-point (point))
8168 (setq txt (buffer-substring beg end))
8169 (org-save-markers-in-region beg end)
8170 (delete-region beg end)
8171 (org-remove-empty-overlays-at beg)
8172 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8173 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8175 (let ((bbb (point)))
8176 (insert-before-markers txt)
8177 (org-reinstall-markers-in-region bbb)
8178 (move-marker ins-point bbb))
8180 (setq ins-end (point))
8181 (goto-char ins-point)
8182 (org-skip-whitespace)
8183 (when (and (< arg 0)
8184 (org-first-sibling-p)
8185 (> ne-ins ne-beg))
8186 ;; Move whitespace back to beginning
8187 (save-excursion
8188 (goto-char ins-end)
8189 (let ((kill-whole-line t))
8190 (kill-line (- ne-ins ne-beg)) (point)))
8192 (move-marker ins-point nil)
8193 (if folded
8194 (hide-subtree)
8195 (org-show-entry)
8196 (show-children)
8197 (org-cycle-hide-drawers 'children))
8198 (org-clean-visibility-after-subtree-move)
8199 ;; move back to the initial column we were at
8200 (move-to-column col)))
8202 (defvar org-subtree-clip ""
8203 "Clipboard for cut and paste of subtrees.
8204 This is actually only a copy of the kill, because we use the normal kill
8205 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8207 (defvar org-subtree-clip-folded nil
8208 "Was the last copied subtree folded?
8209 This is used to fold the tree back after pasting.")
8211 (defun org-cut-subtree (&optional n)
8212 "Cut the current subtree into the clipboard.
8213 With prefix arg N, cut this many sequential subtrees.
8214 This is a short-hand for marking the subtree and then cutting it."
8215 (interactive "p")
8216 (org-copy-subtree n 'cut))
8218 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8219 "Copy the current subtree it in the clipboard.
8220 With prefix arg N, copy this many sequential subtrees.
8221 This is a short-hand for marking the subtree and then copying it.
8222 If CUT is non-nil, actually cut the subtree.
8223 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8224 of some markers in the region, even if CUT is non-nil. This is
8225 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8226 (interactive "p")
8227 (let (beg end folded (beg0 (point)))
8228 (if (org-called-interactively-p 'any)
8229 (org-back-to-heading nil) ; take what looks like a subtree
8230 (org-back-to-heading t)) ; take what is really there
8231 (setq beg (point))
8233 (save-match-data
8234 (if nosubtrees
8235 (outline-next-heading)
8236 (save-excursion (outline-end-of-heading)
8237 (setq folded (outline-invisible-p)))
8238 (condition-case nil
8239 (org-forward-heading-same-level (1- n) t)
8240 (error nil))
8241 (org-end-of-subtree t t)))
8242 (setq end (point))
8243 (goto-char beg0)
8244 (when (> end beg)
8245 (setq org-subtree-clip-folded folded)
8246 (when (or cut force-store-markers)
8247 (org-save-markers-in-region beg end))
8248 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8249 (setq org-subtree-clip (current-kill 0))
8250 (message "%s: Subtree(s) with %d characters"
8251 (if cut "Cut" "Copied")
8252 (length org-subtree-clip)))))
8254 (defun org-paste-subtree (&optional level tree for-yank)
8255 "Paste the clipboard as a subtree, with modification of headline level.
8256 The entire subtree is promoted or demoted in order to match a new headline
8257 level.
8259 If the cursor is at the beginning of a headline, the same level as
8260 that headline is used to paste the tree.
8262 If not, the new level is derived from the *visible* headings
8263 before and after the insertion point, and taken to be the inferior headline
8264 level of the two. So if the previous visible heading is level 3 and the
8265 next is level 4 (or vice versa), level 4 will be used for insertion.
8266 This makes sure that the subtree remains an independent subtree and does
8267 not swallow low level entries.
8269 You can also force a different level, either by using a numeric prefix
8270 argument, or by inserting the heading marker by hand. For example, if the
8273 If optional TREE is given, use this text instead of the kill ring.
8275 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8276 move back over whitespace before inserting, and move point to the end of
8277 the inserted text when done."
8278 (interactive "P")
8279 (setq tree (or tree (and kill-ring (current-kill 0))))
8280 (unless (org-kill-is-subtree-p tree)
8281 (user-error "%s"
8282 (substitute-command-keys
8284 (org-with-limited-levels
8285 (let* ((visp (not (outline-invisible-p)))
8286 (txt tree)
8288 (old-level (if (string-match org-outline-regexp-bol txt)
8289 (- (match-end 0) (match-beginning 0) 1)
8290 -1))
8291 (force-level (cond (level (prefix-numeric-value level))
8293 (string-match
8295 (point-at-bol) (point))))
8296 (- (match-end 1) (match-beginning 1)))
8297 ((and (bolp)
8298 (looking-at org-outline-regexp))
8299 (- (match-end 0) (point) 1))))
8300 (previous-level (save-excursion
8301 (condition-case nil
8302 (progn
8303 (outline-previous-visible-heading 1)
8304 (if (looking-at ^re_)
8305 (- (match-end 0) (match-beginning 0) 1)
8306 1))
8307 (error 1))))
8308 (next-level (save-excursion
8309 (condition-case nil
8310 (progn
8311 (or (looking-at org-outline-regexp)
8312 (outline-next-visible-heading 1))
8313 (if (looking-at ^re_)
8314 (- (match-end 0) (match-beginning 0) 1)
8315 1))
8316 (error 1))))
8317 (new-level (or force-level (max previous-level next-level)))
8318 (shift (if (or (= old-level -1)
8319 (= new-level -1)
8320 (= old-level new-level))
8321 0
8322 (- new-level old-level)))
8323 (delta (if (> shift 0) -1 1))
8324 (func (if (> shift 0) 'org-demote 'org-promote))
8325 (org-odd-levels-only nil)
8326 beg end newend)
8327 ;; Remove the forced level indicator
8328 (if force-level
8329 (delete-region (point-at-bol) (point)))
8330 ;; Paste
8331 (beginning-of-line (if (bolp) 1 2))
8332 (setq beg (point))
8333 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8334 (insert-before-markers txt)
8336 (setq newend (point))
8337 (org-reinstall-markers-in-region beg)
8338 (setq end (point))
8339 (goto-char beg)
8341 (setq beg (point))
8342 (if (and (outline-invisible-p) visp)
8343 (save-excursion (outline-show-heading)))
8344 ;; Shift if necessary
8345 (unless (= shift 0)
8346 (save-restriction
8347 (narrow-to-region beg end)
8348 (while (not (= shift 0))
8349 (org-map-region func (point-min) (point-max))
8350 (setq shift (+ delta shift)))
8351 (goto-char (point-min))
8352 (setq newend (point-max))))
8353 (when (or (org-called-interactively-p 'interactive) for-yank)
8354 (message "Clipboard pasted as level %d subtree" new-level))
8355 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8356 kill-ring
8357 (eq org-subtree-clip (current-kill 0))
8358 org-subtree-clip-folded)
8359 ;; The tree was folded before it was killed/copied
8360 (hide-subtree))
8361 (and for-yank (goto-char newend)))))
8363 (defun org-kill-is-subtree-p (&optional txt)
8364 "Check if the current kill is an outline subtree, or a set of trees.
8365 Returns nil if kill does not start with a headline, or if the first
8366 headline level is not the largest headline level in the tree.
8367 So this will actually accept several entries of equal levels as well,
8368 which is OK for `org-paste-subtree'.
8369 If optional TXT is given, check this string instead of the current kill."
8370 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8371 (re (org-get-limited-outline-regexp))
8372 (^re (concat "^" re))
8373 (start-level (and kill
8374 (string-match
8376 kill)
8377 (- (match-end 2) (match-beginning 2) 1)))
8378 (start (1+ (or (match-beginning 2) -1))))
8379 (if (not start-level)
8380 (progn
8381 nil) ;; does not even start with a heading
8382 (catch 'exit
8383 (while (setq start (string-match ^re kill (1+ start)))
8384 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8385 (throw 'exit nil)))
8386 t))))
8388 (defvar org-markers-to-move nil
8389 "Markers that should be moved with a cut-and-paste operation.
8390 Those markers are stored together with their positions relative to
8391 the start of the region.")
8393 (defun org-save-markers-in-region (beg end)
8394 "Check markers in region.
8395 If these markers are between BEG and END, record their position relative
8396 to BEG, so that after moving the block of text, we can put the markers back
8397 into place.
8398 This function gets called just before an entry or tree gets cut from the
8399 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8400 called immediately, to move the markers with the entries."
8401 (setq org-markers-to-move nil)
8402 (when (featurep 'org-clock)
8403 (org-clock-save-markers-for-cut-and-paste beg end))
8404 (when (featurep 'org-agenda)
8405 (org-agenda-save-markers-for-cut-and-paste beg end)))
8407 (defun org-check-and-save-marker (marker beg end)
8408 "Check if MARKER is between BEG and END.
8409 If yes, remember the marker and the distance to BEG."
8410 (when (and (marker-buffer marker)
8411 (equal (marker-buffer marker) (current-buffer)))
8412 (if (and (>= marker beg) (< marker end))
8413 (push (cons marker (- marker beg)) org-markers-to-move))))
8415 (defun org-reinstall-markers-in-region (beg)
8416 "Move all remembered markers to their position relative to BEG."
8417 (mapc (lambda (x)
8418 (move-marker (car x) (+ beg (cdr x))))
8419 org-markers-to-move)
8420 (setq org-markers-to-move nil))
8422 (defun org-narrow-to-subtree ()
8423 "Narrow buffer to the current subtree."
8424 (interactive)
8425 (save-excursion
8426 (save-match-data
8427 (org-with-limited-levels
8428 (narrow-to-region
8429 (progn (org-back-to-heading t) (point))
8430 (progn (org-end-of-subtree t t)
8431 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8432 (point)))))))
8434 (defun org-narrow-to-block ()
8435 "Narrow buffer to the current block."
8436 (interactive)
8437 (let* ((case-fold-search t)
8440 (if blockp
8441 (narrow-to-region (car blockp) (cdr blockp))
8442 (user-error "Not in a block"))))
8444 (eval-when-compile
8445 (defvar org-property-drawer-re))
8447 (defvar org-property-start-re) ;; defined below
8448 (defun org-clone-subtree-with-time-shift (n &optional shift)
8449 "Clone the task (subtree) at point N times.
8450 The clones will be inserted as siblings.
8452 In interactive use, the user will be prompted for the number of
8453 clones to be produced. If the entry has a timestamp, the user
8454 will also be prompted for a time shift, which may be a repeater
8455 as used in time stamps, for example `+3d'. To disable this,
8456 you can call the function with a universal prefix argument.
8458 When a valid repeater is given and the entry contains any time
8459 stamps, the clones will become a sequence in time, with time
8460 stamps in the subtree shifted for each clone produced. If SHIFT
8461 is nil or the empty string, time stamps will be left alone. The
8462 ID property of the original subtree is removed.
8464 If the original subtree did contain time stamps with a repeater,
8465 the following will happen:
8466 - the repeater will be removed in each clone
8467 - an additional clone will be produced, with the current, unshifted
8468 date(s) in the entry.
8469 - the original entry will be placed *after* all the clones, with
8470 repeater intact.
8471 - the start days in the repeater in the original entry will be shifted
8472 to past the last clone.
8473 In this way you can spell out a number of instances of a repeating task,
8474 and still retain the repeater to cover future instances of the task."
8475 (interactive "nNumber of clones to produce: ")
8476 (let ((shift
8477 (or shift
8478 (if (and (not (equal current-prefix-arg '(4)))
8479 (save-excursion
8480 (re-search-forward org-ts-regexp-both
8481 (save-excursion
8482 (org-end-of-subtree t)
8483 (point)) t)))
8484 (read-from-minibuffer
8485 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8486 ""))) ;; No time shift
8487 (n-no-remove -1)
8488 (drawer-re org-drawer-regexp)
8489 beg end template task idprop
8490 shift-n shift-what doshift nmin nmax)
8491 (if (not (and (integerp n) (> n 0)))
8492 (error "Invalid number of replications %s" n))
8495 shift)))
8496 (error "Invalid shift specification %s" shift))
8497 (when doshift
8498 (setq shift-n (string-to-number (match-string 1 shift))
8499 shift-what (cdr (assoc (match-string 2 shift)
8500 '(("d" . day) ("w" . week)
8501 ("m" . month) ("y" . year))))))
8502 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8503 (setq nmin 1 nmax n)
8504 (org-back-to-heading t)
8505 (setq beg (point))
8506 (setq idprop (org-entry-get nil "ID"))
8507 (org-end-of-subtree t t)
8509 (setq end (point))
8510 (setq template (buffer-substring beg end))
8511 (when (and doshift
8513 (delete-region beg end)
8514 (setq end beg)
8515 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8516 (goto-char end)
8517 (loop for n from nmin to nmax do
8518 ;; prepare clone
8519 (with-temp-buffer
8520 (insert template)
8521 (org-mode)
8522 (goto-char (point-min))
8523 (org-show-subtree)
8524 (and idprop (if org-clone-delete-id
8525 (org-entry-delete nil "ID")
8526 (org-id-get-create t)))
8527 (unless (= n 0)
8529 (kill-whole-line))
8530 (goto-char (point-min))
8531 (while (re-search-forward drawer-re nil t)
8532 (mapc (lambda (d)
8533 (org-remove-empty-drawer-at d (point))) org-drawers)))
8534 (goto-char (point-min))
8535 (when doshift
8536 (while (re-search-forward org-ts-regexp-both nil t)
8537 (org-timestamp-change (* n shift-n) shift-what))
8538 (unless (= n n-no-remove)
8539 (goto-char (point-min))
8540 (while (re-search-forward org-ts-regexp nil t)
8541 (save-excursion
8542 (goto-char (match-beginning 0))
8544 (delete-region (match-beginning 1) (match-end 1)))))))
8545 (setq task (buffer-string)))
8546 (insert task))
8547 (goto-char beg)))
8549 ;;; Outline Sorting
8551 (defun org-sort (with-case)
8552 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8553 Optional argument WITH-CASE means sort case-sensitively."
8554 (interactive "P")
8555 (cond
8556 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8557 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8558 (t
8559 (org-call-with-arg 'org-sort-entries with-case))))
8561 (defun org-sort-remove-invisible (s)
8562 "Remove invisible links from string S."
8563 (remove-text-properties 0 (length s) org-rm-props s)
8564 (while (string-match org-bracket-link-regexp s)
8565 (setq s (replace-match (if (match-end 2)
8566 (match-string 3 s)
8567 (match-string 1 s)) t t s)))
8568 (let ((st (format " %s " s)))
8569 (while (string-match org-emph-re st)
8570 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8571 (setq s (substring st 1 -1)))
8572 s)
8574 (defvar org-priority-regexp) ; defined later in the file
8576 (defvar org-after-sorting-entries-or-items-hook nil
8577 "Hook that is run after a bunch of entries or items have been sorted.
8578 When children are sorted, the cursor is in the parent line when this
8579 hook gets called. When a region or a plain list is sorted, the cursor
8580 will be in the first entry of the sorted region/list.")
8582 (defun org-sort-entries
8583 (&optional with-case sorting-type getkey-func compare-func property)
8584 "Sort entries on a certain level of an outline tree.
8585 If there is an active region, the entries in the region are sorted.
8586 Else, if the cursor is before the first entry, sort the top-level items.
8587 Else, the children of the entry at point are sorted.
8589 Sorting can be alphabetically, numerically, by date/time as given by
8590 a time stamp, by a property, by priority order, or by a custom function.
8592 The command prompts for the sorting type unless it has been given to the
8593 function through the SORTING-TYPE argument, which needs to be a character,
8594 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8595 precise meaning of each character:
8597 n Numerically, by converting the beginning of the entry/item to a number.
8598 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8599 o By order of TODO keywords.
8600 t By date/time, either the first active time stamp in the entry, or, if
8601 none exist, by the first inactive one.
8602 s By the scheduled date/time.
8603 d By deadline date/time.
8604 c By creation time, which is assumed to be the first inactive time stamp
8605 at the beginning of a line.
8606 p By priority according to the cookie.
8607 r By the value of a property.
8609 Capital letters will reverse the sort order.
8611 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8612 called with point at the beginning of the record. It must return either
8613 a string or a number that should serve as the sorting key for that record.
8615 Comparing entries ignores case by default. However, with an optional argument
8616 WITH-CASE, the sorting considers case as well.
8618 Sorting is done against the visible part of the headlines, it ignores hidden
8619 links."
8620 (interactive "P")
8621 (let ((case-func (if with-case 'identity 'downcase))
8622 (cmstr
8623 ;; The clock marker is lost when using `sort-subr', let's
8624 ;; store the clocking string.
8625 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8626 (save-excursion
8627 (goto-char org-clock-marker)
8628 (looking-back "^.*") (match-string-no-properties 0))))
8629 start beg end stars re re2
8630 txt what tmp)
8631 ;; Find beginning and end of region to sort
8632 (cond
8633 ((org-region-active-p)
8634 ;; we will sort the region
8635 (setq end (region-end)
8636 what "region")
8637 (goto-char (region-beginning))
8638 (if (not (org-at-heading-p)) (outline-next-heading))
8639 (setq start (point)))
8640 ((or (org-at-heading-p)
8641 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8642 ;; we will sort the children of the current headline
8643 (org-back-to-heading)
8644 (setq start (point)
8645 end (progn (org-end-of-subtree t t)
8647 (org-back-over-empty-lines)
8648 (point))
8649 what "children")
8650 (goto-char start)
8651 (show-subtree)
8652 (outline-next-heading))
8653 (t
8654 ;; we will sort the top-level entries in this file
8655 (goto-char (point-min))
8656 (or (org-at-heading-p) (outline-next-heading))
8657 (setq start (point))
8658 (goto-char (point-max))
8659 (beginning-of-line 1)
8661 ;; File ends in a non-white line
8662 (end-of-line 1)
8664 (setq end (point-max))
8665 (setq what "top-level")
8666 (goto-char start)
8667 (show-all)))
8669 (setq beg (point))
8670 (if (>= beg end) (user-error "Nothing to sort"))
8673 (setq stars (match-string 1)
8674 re (concat "^" (regexp-quote stars) " +")
8676 txt (buffer-substring beg end))
8678 (if (and (not (equal stars "*")) (string-match re2 txt))
8679 (user-error "Region to sort contains a level above the first entry"))
8681 (unless sorting-type
8682 (message
8683 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8685 A/N/P/R/O/F/T/S/D/C means reversed:"
8686 what)
8687 (setq sorting-type (read-char-exclusive))
8689 (unless getkey-func
8690 (and (= (downcase sorting-type) ?f)
8691 (setq getkey-func
8692 (org-icompleting-read "Sort using function: "
8693 obarray 'fboundp t nil nil))
8694 (setq getkey-func (intern getkey-func))))
8696 (and (= (downcase sorting-type) ?r)
8697 (not property)
8698 (setq property
8699 (org-icompleting-read "Property: "
8700 (mapcar 'list (org-buffer-property-keys t))
8701 nil t))))
8703 (message "Sorting entries...")
8705 (save-restriction
8706 (narrow-to-region start end)
8707 (let ((dcst (downcase sorting-type))
8708 (case-fold-search nil)
8709 (now (current-time)))
8710 (sort-subr
8711 (/= dcst sorting-type)
8712 ;; This function moves to the beginning character of the "record" to
8713 ;; be sorted.
8714 (lambda nil
8715 (if (re-search-forward re nil t)
8716 (goto-char (match-beginning 0))
8717 (goto-char (point-max))))
8718 ;; This function moves to the last character of the "record" being
8719 ;; sorted.
8720 (lambda nil
8721 (save-match-data
8722 (condition-case nil
8723 (outline-forward-same-level 1)
8724 (error
8725 (goto-char (point-max))))))
8726 ;; This function returns the value that gets sorted against.
8727 (lambda nil
8728 (cond
8729 ((= dcst ?n)
8730 (if (looking-at org-complex-heading-regexp)
8731 (string-to-number (org-sort-remove-invisible (match-string 4)))
8732 nil))
8733 ((= dcst ?a)
8734 (if (looking-at org-complex-heading-regexp)
8735 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8736 nil))
8737 ((= dcst ?t)
8738 (let ((end (save-excursion (outline-next-heading) (point))))
8739 (if (or (re-search-forward org-ts-regexp end t)
8740 (re-search-forward org-ts-regexp-both end t))
8741 (org-time-string-to-seconds (match-string 0))
8742 (org-float-time now))))
8743 ((= dcst ?c)
8744 (let ((end (save-excursion (outline-next-heading) (point))))
8745 (if (re-search-forward
8747 end t)
8748 (org-time-string-to-seconds (match-string 0))
8749 (org-float-time now))))
8750 ((= dcst ?s)
8751 (let ((end (save-excursion (outline-next-heading) (point))))
8752 (if (re-search-forward org-scheduled-time-regexp end t)
8753 (org-time-string-to-seconds (match-string 1))
8754 (org-float-time now))))
8755 ((= dcst ?d)
8756 (let ((end (save-excursion (outline-next-heading) (point))))
8757 (if (re-search-forward org-deadline-time-regexp end t)
8758 (org-time-string-to-seconds (match-string 1))
8759 (org-float-time now))))
8760 ((= dcst ?p)
8761 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8762 (string-to-char (match-string 2))
8763 org-default-priority))
8764 ((= dcst ?r)
8765 (or (org-entry-get nil property) ""))
8766 ((= dcst ?o)
8767 (if (looking-at org-complex-heading-regexp)
8768 (- 9999 (length (member (match-string 2)
8769 org-todo-keywords-1)))))
8770 ((= dcst ?f)
8771 (if getkey-func
8772 (progn
8773 (setq tmp (funcall getkey-func))
8774 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8775 tmp)
8776 (error "Invalid key function `%s'" getkey-func)))
8777 (t (error "Invalid sorting type `%c'" sorting-type))))
8778 nil
8779 (cond
8780 ((= dcst ?a) 'string<)
8781 ((= dcst ?f) compare-func)
8782 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8783 (run-hooks 'org-after-sorting-entries-or-items-hook)
8784 ;; Reset the clock marker if needed
8785 (when cmstr
8786 (save-excursion
8787 (goto-char start)
8788 (search-forward cmstr nil t)
8789 (move-marker org-clock-marker (point))))
8790 (message "Sorting entries...done")))
8792 (defun org-do-sort (table what &optional with-case sorting-type)
8793 "Sort TABLE of WHAT according to SORTING-TYPE.
8794 The user will be prompted for the SORTING-TYPE if the call to this
8795 function does not specify it. WHAT is only for the prompt, to indicate
8796 what is being sorted. The sorting key will be extracted from
8797 the car of the elements of the table.
8798 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8799 (unless sorting-type
8800 (message
8801 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8802 what)
8803 (setq sorting-type (read-char-exclusive)))
8804 (let ((dcst (downcase sorting-type))
8805 extractfun comparefun)
8806 ;; Define the appropriate functions
8807 (cond
8808 ((= dcst ?n)
8809 (setq extractfun 'string-to-number
8810 comparefun (if (= dcst sorting-type) '< '>)))
8811 ((= dcst ?a)
8812 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8813 (lambda(x) (downcase (org-sort-remove-invisible x))))
8814 comparefun (if (= dcst sorting-type)
8815 'string<
8816 (lambda (a b) (and (not (string< a b))
8817 (not (string= a b)))))))
8818 ((= dcst ?t)
8819 (setq extractfun
8820 (lambda (x)
8821 (if (or (string-match org-ts-regexp x)
8822 (string-match org-ts-regexp-both x))
8823 (org-float-time
8824 (org-time-string-to-time (match-string 0 x)))
8825 0))
8826 comparefun (if (= dcst sorting-type) '< '>)))
8827 (t (error "Invalid sorting type `%c'" sorting-type)))
8829 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8830 table)
8831 (lambda (a b) (funcall comparefun (car a) (car b))))))
8834 ;;; The orgstruct minor mode
8836 ;; Define a minor mode which can be used in other modes in order to
8837 ;; integrate the org-mode structure editing commands.
8839 ;; This is really a hack, because the org-mode structure commands use
8840 ;; keys which normally belong to the major mode. Here is how it
8841 ;; works: The minor mode defines all the keys necessary to operate the
8842 ;; structure commands, but wraps the commands into a function which
8843 ;; tests if the cursor is currently at a headline or a plain list
8844 ;; item. If that is the case, the structure command is used,
8845 ;; temporarily setting many Org-mode variables like regular
8846 ;; expressions for filling etc. However, when any of those keys is
8847 ;; used at a different location, function uses `key-binding' to look
8848 ;; up if the key has an associated command in another currently active
8849 ;; keymap (minor modes, major mode, global), and executes that
8850 ;; command. There might be problems if any of the keys is otherwise
8851 ;; used as a prefix key.
8853 (defcustom orgstruct-heading-prefix-regexp nil
8854 "Regexp that matches the custom prefix of Org headlines in
8855 orgstruct(++)-mode."
8856 :group 'org
8857 :version "24.4"
8858 :package-version '(Org . "8.0")
8859 :type 'string)
8860 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8862 (defcustom orgstruct-setup-hook nil
8863 "Hook run after orgstruct-mode-map is filled."
8864 :group 'org
8865 :version "24.4"
8866 :package-version '(Org . "8.0")
8867 :type 'hook)
8869 (defvar orgstruct-initialized nil)
8871 (defvar org-local-vars nil
8872 "List of local variables, for use by `orgstruct-mode'.")
8874 ;;;###autoload
8875 (define-minor-mode orgstruct-mode
8876 "Toggle the minor mode `orgstruct-mode'.
8877 This mode is for using Org-mode structure commands in other
8878 modes. The following keys behave as if Org-mode were active, if
8879 the cursor is on a headline, or on a plain list item (both as
8880 defined by Org-mode)."
8881 nil " OrgStruct" (make-sparse-keymap)
8882 (funcall (if orgstruct-mode
8883 'add-to-invisibility-spec
8884 'remove-from-invisibility-spec)
8885 '(outline . t))
8886 (when orgstruct-mode
8887 (org-load-modules-maybe)
8888 (unless orgstruct-initialized
8889 (orgstruct-setup)
8890 (setq orgstruct-initialized t))))
8892 ;;;###autoload
8893 (defun turn-on-orgstruct ()
8894 "Unconditionally turn on `orgstruct-mode'."
8895 (orgstruct-mode 1))
8897 (defvar org-fb-vars nil)
8898 (make-variable-buffer-local 'org-fb-vars)
8899 (defun orgstruct++-mode (&optional arg)
8900 "Toggle `orgstruct-mode', the enhanced version of it.
8901 In addition to setting orgstruct-mode, this also exports all
8902 indentation and autofilling variables from org-mode into the
8903 buffer. It will also recognize item context in multiline items."
8904 (interactive "P")
8905 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8906 (if (< arg 1)
8907 (progn (orgstruct-mode -1)
8908 (mapc (lambda(v)
8909 (org-set-local (car v)
8910 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8911 org-fb-vars))
8912 (orgstruct-mode 1)
8913 (setq org-fb-vars nil)
8914 (unless org-local-vars
8915 (setq org-local-vars (org-get-local-variables)))
8916 (let (var val)
8917 (mapc
8918 (lambda (x)
8919 (when (string-match
8921 (symbol-name (car x)))
8922 (setq var (car x) val (nth 1 x))
8923 (push (list var `(quote ,(eval var))) org-fb-vars)
8924 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8925 org-local-vars)
8926 (org-set-local 'orgstruct-is-++ t))))
8928 (defvar orgstruct-is-++ nil
8929 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8930 (make-variable-buffer-local 'orgstruct-is-++)
8932 ;;;###autoload
8933 (defun turn-on-orgstruct++ ()
8934 "Unconditionally turn on `orgstruct++-mode'."
8935 (orgstruct++-mode 1))
8937 (defun orgstruct-error ()
8938 "Error when there is no default binding for a structure key."
8939 (interactive)
8940 (funcall (if (fboundp 'user-error)
8941 'user-error
8942 'error)
8943 "This key has no function outside structure elements"))
8945 (defun orgstruct-setup ()
8946 "Setup orgstruct keymap."
8947 (dolist (cell '((org-demote . t)
8948 (org-metaleft . t)
8949 (org-metaright . t)
8950 (org-promote . t)
8951 (org-shiftmetaleft . t)
8952 (org-shiftmetaright . t)
8953 org-backward-element
8954 org-backward-heading-same-level
8955 org-ctrl-c-ret
8956 org-ctrl-c-minus
8957 org-ctrl-c-star
8958 org-cycle
8959 org-forward-heading-same-level
8960 org-insert-heading
8961 org-insert-heading-respect-content
8962 org-kill-note-or-show-branches
8963 org-mark-subtree
8964 org-meta-return
8965 org-metadown
8966 org-metaup
8967 org-narrow-to-subtree
8968 org-promote-subtree
8969 org-reveal
8970 org-shiftdown
8971 org-shiftleft
8972 org-shiftmetadown
8973 org-shiftmetaup
8974 org-shiftright
8975 org-shifttab
8976 org-shifttab
8977 org-shiftup
8978 org-show-subtree
8979 org-sort
8980 org-up-element
8981 outline-demote
8982 outline-next-visible-heading
8983 outline-previous-visible-heading
8984 outline-promote
8985 outline-up-heading
8986 show-children))
8987 (let ((f (or (car-safe cell) cell))
8988 (disable-when-heading-prefix (cdr-safe cell)))
8989 (when (fboundp f)
8990 (let ((new-bindings))
8991 (dolist (binding (nconc (where-is-internal f org-mode-map)
8992 (where-is-internal f outline-mode-map)))
8993 (push binding new-bindings)
8994 ;; TODO use local-function-key-map
8995 (dolist (rep '(("<tab>" . "TAB")
8996 ("<return>" . "RET")
8997 ("<escape>" . "ESC")
8998 ("<delete>" . "DEL")))
8999 (setq binding (read-kbd-macro
9000 (let ((case-fold-search))
9001 (replace-regexp-in-string
9002 (regexp-quote (cdr rep))
9003 (car rep)
9004 (key-description binding)))))
9005 (pushnew binding new-bindings :test 'equal)))
9006 (dolist (binding new-bindings)
9007 (let ((key (lookup-key orgstruct-mode-map binding)))
9008 (when (or (not key) (numberp key))
9009 (condition-case nil
9010 (org-defkey orgstruct-mode-map
9011 binding
9012 (orgstruct-make-binding f binding disable-when-heading-prefix))
9013 (error nil)))))))))
9014 (run-hooks 'orgstruct-setup-hook))
9016 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9017 "Create a function for binding in the structure minor mode.
9018 FUN is the command to call inside a table. KEY is the key that
9019 should be checked in for a command to execute outside of tables.
9020 Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
9021 if `orgstruct-heading-prefix-regexp' is non-nil."
9022 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9023 (let ((nname name)
9024 (i 0))
9025 (while (fboundp (intern nname))
9026 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9027 (setq name (intern nname)))
9028 (eval
9029 (let ((bindings '((org-heading-regexp
9030 (concat "^"
9031 orgstruct-heading-prefix-regexp
9033 (org-outline-regexp
9035 (org-outline-regexp-bol
9036 (concat "^" org-outline-regexp))
9037 (outline-regexp org-outline-regexp)
9039 (outline-level 'org-outline-level)
9040 (outline-heading-alist))))
9041 `(defun ,name (arg)
9043 "Outside of structure, run the binding of `"
9044 (key-description key) "'."
9045 (when disable-when-heading-prefix
9046 (concat
9049 "`" (symbol-name fun) "'.")))
9050 (interactive "p")
9051 (let* ((disable
9052 ,(when disable-when-heading-prefix
9053 '(and orgstruct-heading-prefix-regexp
9054 (not (string= orgstruct-heading-prefix-regexp "")))))
9055 (fallback
9056 (or disable
9057 (not
9058 (let* ,bindings
9059 (org-context-p 'headline 'item
9060 ,(when (memq fun
9061 '(org-insert-heading
9062 org-insert-heading-respect-content
9063 org-meta-return))
9064 '(when orgstruct-is-++
9065 'item-body))))))))
9066 (if fallback
9067 (let* ((orgstruct-mode)
9068 (binding
9069 (loop with key = ,key
9070 for rep in
9071 '(nil
9076 do
9077 (when rep
9078 (setq key (read-kbd-macro
9079 (let ((case-fold-search))
9080 (replace-regexp-in-string
9081 (car rep)
9082 (cdr rep)
9083 (key-description key))))))
9084 thereis (key-binding key))))
9085 (if (keymapp binding)
9086 (set-temporary-overlay-map binding)
9087 (let ((func (or binding
9088 (unless disable
9089 'orgstruct-error))))
9090 (when func
9091 (call-interactively func)))))
9092 (org-run-like-in-org-mode
9093 (lambda ()
9094 (interactive)
9095 (let* ,bindings
9096 (call-interactively ',fun)))))))))
9097 name))
9099 (defun org-contextualize-keys (alist contexts)
9100 "Return valid elements in ALIST depending on CONTEXTS.
9102 `org-agenda-custom-commands' or `org-capture-templates' are the
9103 values used for ALIST, and `org-agenda-custom-commands-contexts'
9104 or `org-capture-templates-contexts' are the associated contexts
9105 definitions."
9106 (let ((contexts
9107 ;; normalize contexts
9108 (mapcar
9109 (lambda(c) (cond ((listp (cadr c))
9110 (list (car c) (car c) (cadr c)))
9111 ((string= "" (cadr c))
9112 (list (car c) (car c) (caddr c)))
9113 (t c))) contexts))
9114 (a alist) c r s)
9115 ;; loop over all commands or templates
9116 (while (setq c (pop a))
9117 (let (vrules repl)
9118 (cond
9119 ((not (assoc (car c) contexts))
9120 (push c r))
9121 ((and (assoc (car c) contexts)
9122 (setq vrules (org-contextualize-validate-key
9123 (car c) contexts)))
9124 (mapc (lambda (vr)
9125 (when (not (equal (car vr) (cadr vr)))
9126 (setq repl vr))) vrules)
9127 (if (not repl) (push c r)
9128 (push (cadr repl) s)
9129 (push
9130 (cons (car c)
9131 (cdr (or (assoc (cadr repl) alist)
9132 (error "Undefined key `%s' as contextual replacement for `%s'"
9133 (cadr repl) (car c)))))
9134 r))))))
9135 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9136 (delq
9137 nil
9138 (delete-dups
9139 (mapcar (lambda (x)
9140 (let ((tpl (car x)))
9141 (when (not (delq
9142 nil
9143 (mapcar (lambda(y)
9144 (equal y tpl)) s))) x)))
9145 (reverse r))))))
9147 (defun org-contextualize-validate-key (key contexts)
9148 "Check CONTEXTS for agenda or capture KEY."
9149 (let (r rr res)
9150 (while (setq r (pop contexts))
9151 (mapc
9152 (lambda (rr)
9153 (when
9154 (and (equal key (car r))
9155 (if (functionp rr) (funcall rr)
9156 (or (and (eq (car rr) 'in-file)
9157 (buffer-file-name)
9158 (string-match (cdr rr) (buffer-file-name)))
9159 (and (eq (car rr) 'in-mode)
9160 (string-match (cdr rr) (symbol-name major-mode)))
9161 (and (eq (car rr) 'in-buffer)
9162 (string-match (cdr rr) (buffer-name)))
9163 (when (and (eq (car rr) 'not-in-file)
9164 (buffer-file-name))
9165 (not (string-match (cdr rr) (buffer-file-name))))
9166 (when (eq (car rr) 'not-in-mode)
9167 (not (string-match (cdr rr) (symbol-name major-mode))))
9168 (when (eq (car rr) 'not-in-buffer)
9169 (not (string-match (cdr rr) (buffer-name)))))))
9170 (push r res)))
9171 (car (last r))))
9172 (delete-dups (delq nil res))))
9174 (defun org-context-p (&rest contexts)
9175 "Check if local context is any of CONTEXTS.
9176 Possible values in the list of contexts are `table', `headline', and `item'."
9177 (let ((pos (point)))
9178 (goto-char (point-at-bol))
9179 (prog1 (or (and (memq 'table contexts)
9181 (and (memq 'headline contexts)
9182 (looking-at org-outline-regexp))
9183 (and (memq 'item contexts)
9185 (and (memq 'item-body contexts)
9186 (org-in-item-p)))
9187 (goto-char pos))))
9189 (defun org-get-local-variables ()
9190 "Return a list of all local variables in an Org mode buffer."
9191 (let (varlist)
9192 (with-current-buffer (get-buffer-create "*Org tmp*")
9193 (erase-buffer)
9194 (org-mode)
9195 (setq varlist (buffer-local-variables)))
9196 (kill-buffer "*Org tmp*")
9197 (delq nil
9198 (mapcar
9199 (lambda (x)
9200 (setq x
9201 (if (symbolp x)
9202 (list x)
9203 (list (car x) (cdr x))))
9204 (if (and (not (get (car x) 'org-state))
9205 (string-match
9206 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9207 (symbol-name (car x))))
9208 x nil))
9209 varlist))))
9211 (defun org-clone-local-variables (from-buffer &optional regexp)
9212 "Clone local variables from FROM-BUFFER.
9213 Optional argument REGEXP selects variables to clone."
9214 (mapc
9215 (lambda (pair)
9216 (and (symbolp (car pair))
9217 (or (null regexp)
9218 (string-match regexp (symbol-name (car pair))))
9219 (set (make-local-variable (car pair))
9220 (cdr pair))))
9221 (buffer-local-variables from-buffer)))
9223 ;;;###autoload
9224 (defun org-run-like-in-org-mode (cmd)
9225 "Run a command, pretending that the current buffer is in Org-mode.
9226 This will temporarily bind local variables that are typically bound in
9227 Org-mode to the values they have in Org-mode, and then interactively
9228 call CMD."
9229 (org-load-modules-maybe)
9230 (unless org-local-vars
9231 (setq org-local-vars (org-get-local-variables)))
9232 (let (binds)
9233 (dolist (var org-local-vars)
9234 (when (or (not (boundp (car var)))
9235 (eq (symbol-value (car var))
9236 (default-value (car var))))
9237 (push (list (car var) `(quote ,(cadr var))) binds)))
9238 (eval `(let ,binds
9239 (call-interactively (quote ,cmd))))))
9241 ;;;; Archiving
9243 (defun org-get-category (&optional pos force-refresh)
9244 "Get the category applying to position POS."
9245 (save-match-data
9246 (if force-refresh (org-refresh-category-properties))
9247 (let ((pos (or pos (point))))
9248 (or (get-text-property pos 'org-category)
9249 (progn (org-refresh-category-properties)
9250 (get-text-property pos 'org-category))))))
9252 (defun org-refresh-category-properties ()
9253 "Refresh category text properties in the buffer."
9254 (let ((case-fold-search t)
9255 (inhibit-read-only t)
9256 (def-cat (cond
9257 ((null org-category)
9258 (if buffer-file-name
9259 (file-name-sans-extension
9260 (file-name-nondirectory buffer-file-name))
9261 "???"))
9262 ((symbolp org-category) (symbol-name org-category))
9263 (t org-category)))
9264 beg end cat pos optionp)
9265 (org-with-silent-modifications
9266 (save-excursion
9267 (save-restriction
9268 (widen)
9269 (goto-char (point-min))
9270 (put-text-property (point) (point-max) 'org-category def-cat)
9271 (while (re-search-forward
9273 (setq pos (match-end 0)
9274 optionp (equal (char-after (match-beginning 0)) ?#)
9275 cat (org-trim (match-string 2)))
9276 (if optionp
9277 (setq beg (point-at-bol) end (point-max))
9278 (org-back-to-heading t)
9279 (setq beg (point) end (org-end-of-subtree t t)))
9280 (put-text-property beg end 'org-category cat)
9281 (put-text-property beg end 'org-category-position beg)
9282 (goto-char pos)))))))
9284 (defun org-refresh-properties (dprop tprop)
9285 "Refresh buffer text properties.
9286 DPROP is the drawer property and TPROP is the corresponding text
9287 property to set."
9288 (let ((case-fold-search t)
9289 (inhibit-read-only t) p)
9290 (org-with-silent-modifications
9291 (save-excursion
9292 (save-restriction
9293 (widen)
9294 (goto-char (point-min))
9296 (setq p (org-match-string-no-properties 1))
9297 (save-excursion
9298 (org-back-to-heading t)
9299 (put-text-property
9300 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9303 ;;;; Link Stuff
9305 ;;; Link abbreviations
9307 (defun org-link-expand-abbrev (link)
9308 "Apply replacements as defined in `org-link-abbrev-alist'."
9310 (let* ((key (match-string 1 link))
9311 (as (or (assoc key org-link-abbrev-alist-local)
9312 (assoc key org-link-abbrev-alist)))
9313 (tag (and (match-end 2) (match-string 3 link)))
9314 rpl)
9315 (if (not as)
9316 link
9317 (setq rpl (cdr as))
9318 (cond
9319 ((symbolp rpl) (funcall rpl tag))
9321 (replace-match
9322 (save-match-data
9323 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9324 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9325 ((string-match "%h" rpl)
9326 (replace-match (url-hexify-string (or tag "")) t t rpl))
9327 (t (concat rpl tag)))))
9328 link))
9330 ;;; Storing and inserting links
9332 (defvar org-insert-link-history nil
9333 "Minibuffer history for links inserted with `org-insert-link'.")
9335 (defvar org-stored-links nil
9336 "Contains the links stored with `org-store-link'.")
9338 (defvar org-store-link-plist nil
9339 "Plist with info about the most recently link created with `org-store-link'.")
9341 (defvar org-link-protocols nil
9342 "Link protocols added to Org-mode using `org-add-link-type'.")
9344 (defvar org-store-link-functions nil
9345 "List of functions that are called to create and store a link.
9346 Each function will be called in turn until one returns a non-nil
9347 value. Each function should check if it is responsible for creating
9348 this link (for example by looking at the major mode).
9349 If not, it must exit and return nil.
9350 If yes, it should return a non-nil value after a calling
9351 `org-store-link-props' with a list of properties and values.
9352 Special properties are:
9356 This is obligatory as well.
9357 :description Optional default description for the second pair
9358 of brackets in an Org-mode link. The user can still change
9359 this when inserting this link into an Org-mode buffer.
9361 In addition to these, any additional properties can be specified
9362 and then used in capture templates.")
9364 (defun org-add-link-type (type &optional follow export)
9365 "Add TYPE to the list of `org-link-types'.
9366 Re-compute all regular expressions depending on `org-link-types'
9368 FOLLOW and EXPORT are two functions.
9370 FOLLOW should take the link path as the single argument and do whatever
9371 is necessary to follow the link, for example find a file or display
9372 a mail message.
9374 EXPORT should format the link path for export to one of the export formats.
9375 It should be a function accepting three arguments:
9378 desc the description of the link, if any, or a description added by
9379 org-export-normalize-links if there is none
9380 format the export format, a symbol like `html' or `latex' or `ascii'..
9382 The function may use the FORMAT information to return different values
9383 depending on the format. The return value will be put literally into
9384 the exported file. If the return value is nil, this means Org should
9385 do what it normally does with links which do not have EXPORT defined.
9387 Org-mode has a built-in default for exporting links. If you are happy with
9388 this default, there is no need to define an export function for the link
9389 type. For a simple example of an export function, see `org-bbdb.el'."
9390 (add-to-list 'org-link-types type t)
9391 (org-make-link-regexps)
9392 (if (assoc type org-link-protocols)
9393 (setcdr (assoc type org-link-protocols) (list follow export))
9394 (push (list type follow export) org-link-protocols)))
9396 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9397 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9399 ;;;###autoload
9400 (defun org-store-link (arg)
9402 This link is added to `org-stored-links' and can later be inserted
9405 For some link types, a prefix arg is interpreted.
9406 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9407 For file links, arg negates `org-context-in-file-links'.
9409 A double prefix arg force skipping storing functions that are not
9410 part of Org's core.
9412 A triple prefix arg force storing a link for each line in the
9413 active region."
9414 (interactive "P")
9415 (org-load-modules-maybe)
9416 (if (and (equal arg '(64)) (org-region-active-p))
9417 (save-excursion
9418 (let ((end (region-end)))
9419 (goto-char (region-beginning))
9420 (set-mark (point))
9421 (while (< (point-at-eol) end)
9422 (move-end-of-line 1) (activate-mark)
9423 (let (current-prefix-arg)
9424 (call-interactively 'org-store-link))
9425 (move-beginning-of-line 2)
9426 (set-mark (point)))))
9427 (org-with-limited-levels
9428 (setq org-store-link-plist nil)
9429 (let (link cpltxt desc description search
9430 txt custom-id agenda-link sfuns sfunsn)
9431 (cond
9433 ;; Store a link using an external link type
9434 ((and (not (equal arg '(16)))
9435 (setq sfuns
9436 (delq
9437 nil (mapcar (lambda (f)
9438 (let (fs) (if (funcall f) (push f fs))))
9439 org-store-link-functions))
9440 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9441 (or (and (cdr sfuns)
9442 (funcall (intern
9443 (completing-read
9444 "Which function for creating the link? "
9445 sfunsn t (car sfunsn)))))
9446 (funcall (caar sfuns)))
9447 (setq link (plist-get org-store-link-plist :link)
9448 desc (or (plist-get org-store-link-plist
9449 :description) link))))
9451 ;; Store a link from a source code buffer
9452 ((org-src-edit-buffer-p)
9453 (let (label gc)
9454 (while (or (not label)
9455 (save-excursion
9456 (save-restriction
9457 (widen)
9458 (goto-char (point-min))
9459 (re-search-forward
9460 (regexp-quote (format org-coderef-label-format label))
9461 nil t))))
9462 (when label (message "Label exists already") (sit-for 2))
9463 (setq label (read-string "Code line label: " label)))
9464 (end-of-line 1)
9465 (setq link (format org-coderef-label-format label))
9466 (setq gc (- 79 (length link)))
9467 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9468 (insert link)
9469 (setq link (concat "(" label ")") desc nil)))
9471 ;; We are in the agenda, link to referenced location
9472 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9473 (let ((m (or (get-text-property (point) 'org-hd-marker)
9474 (get-text-property (point) 'org-marker))))
9475 (when m
9476 (org-with-point-at m
9477 (setq agenda-link
9478 (if (org-called-interactively-p 'any)
9479 (call-interactively 'org-store-link)
9480 (org-store-link nil)))))))
9482 ((eq major-mode 'calendar-mode)
9483 (let ((cd (calendar-cursor-to-date)))
9484 (setq link
9485 (format-time-string
9486 (car org-time-stamp-formats)
9487 (apply 'encode-time
9488 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9489 nil nil nil))))
9490 (org-store-link-props :type "calendar" :date cd)))
9492 ((eq major-mode 'help-mode)
9493 (setq link (concat "help:" (save-excursion
9494 (goto-char (point-min))
9495 (looking-at "^[^ ]+")
9496 (match-string 0))))
9497 (org-store-link-props :type "help"))
9499 ((eq major-mode 'w3-mode)
9500 (setq cpltxt (if (and (buffer-name)
9501 (not (string-match "Untitled" (buffer-name))))
9502 (buffer-name)
9503 (url-view-url t))
9504 link (url-view-url t))
9505 (org-store-link-props :type "w3" :url (url-view-url t)))
9507 ((eq major-mode 'image-mode)
9508 (setq cpltxt (concat "file:"
9509 (abbreviate-file-name buffer-file-name))
9510 link cpltxt)
9511 (org-store-link-props :type "image" :file buffer-file-name))
9513 ;; In dired, store a link to the file of the current line
9514 ((eq major-mode 'dired-mode)
9515 (let ((file (dired-get-filename nil t)))
9516 (setq file (if file
9517 (abbreviate-file-name
9518 (expand-file-name (dired-get-filename nil t)))
9519 ;; otherwise, no file so use current directory.
9520 default-directory))
9521 (setq cpltxt (concat "file:" file)
9522 link cpltxt)))
9524 ((setq search (run-hook-with-args-until-success
9525 'org-create-file-search-functions))
9526 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9527 "::" search))
9528 (setq cpltxt (or description link)))
9530 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9531 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9532 (cond
9533 ;; Store a link using the target at point
9535 (setq cpltxt
9536 (concat "file:"
9537 (abbreviate-file-name
9538 (buffer-file-name (buffer-base-buffer)))
9539 "::" (match-string 1))
9540 link cpltxt))
9541 ((and (featurep 'org-id)
9542 (or (eq org-id-link-to-org-use-id t)
9543 (and (org-called-interactively-p 'any)
9544 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9545 (and (eq org-id-link-to-org-use-id
9546 'create-if-interactive-and-no-custom-id)
9547 (not custom-id))))
9548 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9549 ;; Store a link using the ID at point
9550 (setq link (condition-case nil
9551 (prog1 (org-id-store-link)
9552 (setq desc (plist-get org-store-link-plist
9553 :description)))
9554 (error
9555 ;; Probably before first headline, link only to file
9556 (concat "file:"
9557 (abbreviate-file-name
9558 (buffer-file-name (buffer-base-buffer))))))))
9559 (t
9560 ;; Just link to current headline
9561 (setq cpltxt (concat "file:"
9562 (abbreviate-file-name
9563 (buffer-file-name (buffer-base-buffer)))))
9564 ;; Add a context search string
9565 (when (org-xor org-context-in-file-links arg)
9566 (let* ((ee (org-element-at-point))
9567 (et (org-element-type ee))
9568 (ev (plist-get (cadr ee) :value))
9569 (ek (plist-get (cadr ee) :key))
9570 (eok (and (stringp ek) (string-match "name" ek))))
9571 (setq txt (cond
9572 ((org-at-heading-p) nil)
9573 ((and (eq et 'keyword) eok) ev)
9574 ((org-region-active-p)
9575 (buffer-substring (region-beginning) (region-end)))))
9577 (setq cpltxt
9578 (concat cpltxt "::"
9579 (condition-case nil
9580 (org-make-org-heading-search-string txt)
9581 (error "")))
9582 desc (or (and (eq et 'keyword) eok ev)
9583 (nth 4 (ignore-errors (org-heading-components)))
9584 "NONE")))))
9586 (setq cpltxt (substring cpltxt 0 -2)))
9587 (setq link cpltxt))))
9589 ((buffer-file-name (buffer-base-buffer))
9590 ;; Just link to this file here.
9591 (setq cpltxt (concat "file:"
9592 (abbreviate-file-name
9593 (buffer-file-name (buffer-base-buffer)))))
9594 ;; Add a context string.
9595 (when (org-xor org-context-in-file-links arg)
9596 (setq txt (if (org-region-active-p)
9597 (buffer-substring (region-beginning) (region-end))
9598 (buffer-substring (point-at-bol) (point-at-eol))))
9599 ;; Only use search option if there is some text.
9601 (setq cpltxt
9602 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9603 desc "NONE")))
9604 (setq link cpltxt))
9606 ((org-called-interactively-p 'interactive)
9607 (user-error "No method for storing a link from this buffer"))
9609 (t (setq link nil)))
9611 ;; We're done setting link and desc, clean up
9612 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9613 (setq link (or link cpltxt)
9614 desc (or desc cpltxt))
9615 (cond ((equal desc "NONE") (setq desc nil))
9616 ((string-match org-bracket-link-analytic-regexp desc)
9617 (let ((d0 (match-string 3 desc))
9618 (p0 (match-string 5 desc)))
9619 (setq desc
9620 (replace-regexp-in-string
9621 org-bracket-link-regexp
9622 (concat (or p0 d0)
9623 (if (equal (length (match-string 0 desc))
9624 (length desc)) "*" "")) desc)))))
9626 ;; Return the link
9627 (if (not (and (or (org-called-interactively-p 'any)
9628 executing-kbd-macro) link))
9629 (or agenda-link (and link (org-make-link-string link desc)))
9630 (push (list link desc) org-stored-links)
9631 (message "Stored: %s" (or desc link))
9632 (when custom-id
9633 (setq link (concat "file:" (abbreviate-file-name
9634 (buffer-file-name)) "::#" custom-id))
9635 (push (list link desc) org-stored-links)))))))
9637 (defun org-store-link-props (&rest plist)
9638 "Store link properties, extract names and addresses."
9639 (let (x adr)
9640 (when (setq x (plist-get plist :from))
9641 (setq adr (mail-extract-address-components x))
9642 (setq plist (plist-put plist :fromname (car adr)))
9643 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9644 (when (setq x (plist-get plist :to))
9645 (setq adr (mail-extract-address-components x))
9646 (setq plist (plist-put plist :toname (car adr)))
9647 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9648 (let ((from (plist-get plist :from))
9649 (to (plist-get plist :to)))
9650 (when (and from to org-from-is-user-regexp)
9651 (setq plist
9652 (plist-put plist :fromto
9653 (if (string-match org-from-is-user-regexp from)
9654 (concat "to %t")
9655 (concat "from %f"))))))
9656 (setq org-store-link-plist plist))
9658 (defun org-add-link-props (&rest plist)
9659 "Add these properties to the link property list."
9660 (let (key value)
9661 (while plist
9662 (setq key (pop plist) value (pop plist))
9663 (setq org-store-link-plist
9664 (plist-put org-store-link-plist key value)))))
9666 (defun org-email-link-description (&optional fmt)
9667 "Return the description part of an email link.
9668 This takes information from `org-store-link-plist' and formats it
9669 according to FMT (default from `org-email-link-description-format')."
9670 (setq fmt (or fmt org-email-link-description-format))
9671 (let* ((p org-store-link-plist)
9672 (to (plist-get p :toaddress))
9673 (from (plist-get p :fromaddress))
9674 (table
9675 (list
9676 (cons "%c" (plist-get p :fromto))
9677 (cons "%F" (plist-get p :from))
9678 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9679 (cons "%T" (plist-get p :to))
9680 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9681 (cons "%s" (plist-get p :subject))
9682 (cons "%d" (plist-get p :date))
9683 (cons "%m" (plist-get p :message-id)))))
9684 (when (string-match "%c" fmt)
9685 ;; Check if the user wrote this message
9686 (if (and org-from-is-user-regexp from to
9687 (save-match-data (string-match org-from-is-user-regexp from)))
9688 (setq fmt (replace-match "to %t" t t fmt))
9689 (setq fmt (replace-match "from %f" t t fmt))))
9690 (org-replace-escapes fmt table)))
9692 (defun org-make-org-heading-search-string (&optional string)
9693 "Make search string for the current headline or STRING."
9694 (let ((s (or string
9695 (and (derived-mode-p 'org-mode)
9696 (save-excursion
9697 (org-back-to-heading t)
9698 (org-element-property :raw-value (org-element-at-point))))))
9699 (lines org-context-in-file-links))
9700 (or string (setq s (concat "*" s))) ; Add * for headlines
9702 (when (and string (integerp lines) (> lines 0))
9704 (when (< lines (length slines))
9705 (setq s (mapconcat
9706 'identity
9707 (reverse (nthcdr (- (length slines) lines)
9711 (defun org-make-link-string (link &optional description)
9712 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9714 (error "Empty link"))
9715 (when (and description
9716 (stringp description)
9718 (setq description nil))
9719 (when (stringp description)
9720 ;; Remove brackets from the description, they are fatal.
9722 (setq description (replace-match "{" t t description)))
9724 (setq description (replace-match "}" t t description))))
9725 (when (equal link description)
9726 ;; No description needed, it is identical
9727 (setq description nil))
9728 (when (and (not description)
9729 (not (string-match (org-image-file-name-regexp) link))
9730 (not (equal link (org-link-escape link))))
9731 (setq description (org-extract-attributes link)))
9732 (setq link
9733 (cond ((string-match (org-image-file-name-regexp) link) link)
9734 ((string-match org-link-types-re link)
9735 (concat (match-string 1 link)
9736 (org-link-escape (substring link (match-end 1)))))
9737 (t (org-link-escape link))))
9738 (concat "[[" link "]"
9739 (if description (concat "[" description "]") "")
9740 "]"))
9742 (defconst org-link-escape-chars
9743 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9744 "List of characters that should be escaped in link.
9745 This is the list that is used for internal purposes.")
9747 (defconst org-link-escape-chars-browser
9749 "List of escapes for characters that are problematic in links.
9750 This is the list that is used before handing over to the browser.")
9752 (defun org-link-escape (text &optional table merge)
9753 "Return percent escaped representation of TEXT.
9754 TEXT is a string with the text to escape.
9755 Optional argument TABLE is a list with characters that should be
9756 escaped. When nil, `org-link-escape-chars' is used.
9757 If optional argument MERGE is set, merge TABLE into
9758 `org-link-escape-chars'."
9759 (cond
9760 ((and table merge)
9761 (mapc (lambda (defchr)
9762 (unless (member defchr table)
9763 (setq table (cons defchr table)))) org-link-escape-chars))
9764 ((null table)
9765 (setq table org-link-escape-chars)))
9766 (mapconcat
9767 (lambda (char)
9768 (if (or (member char table)
9769 (and (or (< char 32) (= char 37) (> char 126))
9770 org-url-hexify-p))
9771 (mapconcat (lambda (sequence-element)
9772 (format "%%%.2X" sequence-element))
9773 (or (encode-coding-char char 'utf-8)
9774 (error "Unable to percent escape character: %s"
9775 (char-to-string char))) "")
9776 (char-to-string char))) text ""))
9778 (defun org-link-unescape (str)
9779 "Unhex hexified Unicode strings as returned from the JavaScript function
9780 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9781 (unless (and (null str) (string= "" str))
9782 (let ((pos 0) (case-fold-search t) unhexed)
9784 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9785 (setq str (replace-match unhexed t t str))
9786 (setq pos (+ pos (length unhexed))))))
9787 str)
9789 (defun org-link-unescape-compound (hex)
9790 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9791 Note: this function also decodes single byte encodings like
9792 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9793 (save-match-data
9794 (let* ((bytes (cdr (split-string hex "%")))
9795 (ret "")
9796 (eat 0)
9797 (sum 0))
9798 (while bytes
9799 (let* ((val (string-to-number (pop bytes) 16))
9800 (shift-xor
9801 (if (= 0 eat)
9802 (cond
9803 ((>= val 252) (cons 6 252))
9804 ((>= val 248) (cons 5 248))
9805 ((>= val 240) (cons 4 240))
9806 ((>= val 224) (cons 3 224))
9807 ((>= val 192) (cons 2 192))
9808 (t (cons 0 0)))
9809 (cons 6 128))))
9810 (if (>= val 192) (setq eat (car shift-xor)))
9811 (setq val (logxor val (cdr shift-xor)))
9812 (setq sum (+ (lsh sum (car shift-xor)) val))
9813 (if (> eat 0) (setq eat (- eat 1)))
9814 (cond
9815 ((= 0 eat) ;multi byte
9816 (setq ret (concat ret (org-char-to-string sum)))
9817 (setq sum 0))
9818 ((not bytes) ; single byte(s)
9819 (setq ret (org-link-unescape-single-byte-sequence hex))))
9820 )) ;; end (while bytes
9821 ret )))
9823 (defun org-link-unescape-single-byte-sequence (hex)
9824 "Unhexify hex-encoded single byte character sequences."
9825 (mapconcat (lambda (byte)
9826 (char-to-string (string-to-number byte 16)))
9827 (cdr (split-string hex "%")) ""))
9829 (defun org-xor (a b)
9830 "Exclusive or."
9831 (if a (not b) b))
9833 (defun org-fixup-message-id-for-http (s)
9834 "Replace special characters in a message id, so it can be used in an http query."
9835 (when (string-match "%" s)
9836 (setq s (mapconcat (lambda (c)
9837 (if (eq c ?%)
9838 "%25"
9839 (char-to-string c)))
9840 s "")))
9841 (while (string-match "<" s)
9842 (setq s (replace-match "%3C" t t s)))
9843 (while (string-match ">" s)
9844 (setq s (replace-match "%3E" t t s)))
9845 (while (string-match "@" s)
9846 (setq s (replace-match "%40" t t s)))
9847 s)
9849 (defun org-link-prettify (link)
9850 "Return a human-readable representation of LINK.
9851 The car of LINK must be a raw link the cdr of LINK must be either
9852 a link description or nil."
9853 (let ((desc (or (cadr link) "<no description>")))
9854 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9855 "<" (car link) ">")))
9857 ;;;###autoload
9858 (defun org-insert-link-global ()
9859 "Insert a link like Org-mode does.
9860 This command can be called in any mode to insert a link in Org-mode syntax."
9861 (interactive)
9862 (org-load-modules-maybe)
9863 (org-run-like-in-org-mode 'org-insert-link))
9865 (defun org-insert-all-links (&optional keep)
9866 "Insert all links in `org-stored-links'."
9867 (interactive "P")
9868 (let ((links (copy-sequence org-stored-links)) l)
9869 (while (setq l (if keep (pop links) (pop org-stored-links)))
9870 (insert "- ")
9871 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9874 (defun org-link-fontify-links-to-this-file ()
9875 "Fontify links to the current file in `org-stored-links'."
9876 (let ((f (buffer-file-name)) a b)
9877 (setq a (mapcar (lambda(l)
9878 (let ((ll (car l)))
9880 (equal f (expand-file-name (match-string 1 ll))))
9881 ll)))
9882 org-stored-links))
9883 (when (featurep 'org-id)
9884 (setq b (mapcar (lambda(l)
9885 (let ((ll (car l)))
9887 (equal f (expand-file-name
9888 (or (org-id-find-id-file
9889 (match-string 1 ll)) ""))))
9890 ll)))
9891 org-stored-links)))
9892 (mapcar (lambda(l)
9893 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9894 (delq nil (append a b)))))
9896 (defvar org-link-links-in-this-file nil)
9897 (defun org-insert-link (&optional complete-file link-location default-description)
9898 "Insert a link. At the prompt, enter the link.
9900 Completion can be used to insert any of the link protocol prefixes like
9901 http or ftp in use.
9903 The history can be used to select a link previously stored with
9904 `org-store-link'. When the empty string is entered (i.e. if you just
9905 press RET at the prompt), the link defaults to the most recently
9906 stored link. As SPC triggers completion in the minibuffer, you need to
9907 use M-SPC or C-q SPC to force the insertion of a space character.
9909 You will also be prompted for a description, and if one is given, it will
9910 be displayed in the buffer instead of the link.
9912 If there is already a link at point, this command will allow you to edit link
9913 and description parts.
9916 be selected using completion. The path to the file will be relative to the
9917 current directory if the file is in the current directory or a subdirectory.
9918 Otherwise, the link will be the absolute path as completed in the minibuffer
9919 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9920 option `org-link-file-path-type'.
9923 the current directory or below.
9926 `org-keep-stored-link-after-insertion'.
9928 If `org-make-link-description-function' is non-nil, this function will be
9929 called with the link target, and the result will be the default
9930 link description.
9932 If the LINK-LOCATION parameter is non-nil, this value will be
9933 used as the link location instead of reading one interactively.
9935 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9936 be used as the default description."
9937 (interactive "P")
9938 (let* ((wcf (current-window-configuration))
9939 (origbuf (current-buffer))
9940 (region (if (org-region-active-p)
9941 (buffer-substring (region-beginning) (region-end))))
9942 (remove (and region (list (region-beginning) (region-end))))
9943 (desc region)
9944 tmphist ; byte-compile incorrectly complains about this
9945 (link link-location)
9946 (abbrevs org-link-abbrev-alist-local)
9947 entry file all-prefixes auto-desc)
9948 (cond
9949 (link-location) ; specified by arg, just use it.
9950 ((org-in-regexp org-bracket-link-regexp 1)
9951 ;; We do have a link at point, and we are going to edit it.
9952 (setq remove (list (match-beginning 0) (match-end 0)))
9953 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9954 (setq link (read-string "Link: "
9955 (org-link-unescape
9956 (org-match-string-no-properties 1)))))
9957 ((or (org-in-regexp org-angle-link-re)
9958 (org-in-regexp org-plain-link-re))
9959 ;; Convert to bracket link
9960 (setq remove (list (match-beginning 0) (match-end 0))
9961 link (read-string "Link: "
9962 (org-remove-angle-brackets (match-string 0)))))
9963 ((member complete-file '((4) (16)))
9964 ;; Completing read for file names.
9965 (setq link (org-file-complete-link complete-file)))
9966 (t
9967 ;; Read link, with completion for stored links.
9968 (org-link-fontify-links-to-this-file)
9969 (org-switch-to-buffer-other-window "*Org Links*")
9970 (with-current-buffer "*Org Links*"
9971 (erase-buffer)
9972 (insert "Insert a link.
9974 (when org-stored-links
9976 (insert (mapconcat 'org-link-prettify
9978 (goto-char (point-min)))
9979 (let ((cw (selected-window)))
9980 (select-window (get-buffer-window "*Org Links*" 'visible))
9981 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9982 (unless (pos-visible-in-window-p (point-max))
9983 (org-fit-window-to-buffer))
9984 (and (window-live-p cw) (select-window cw)))
9985 ;; Fake a link history, containing the stored links.
9986 (setq tmphist (append (mapcar 'car org-stored-links)
9987 org-insert-link-history))
9988 (setq all-prefixes (append (mapcar 'car abbrevs)
9989 (mapcar 'car org-link-abbrev-alist)
9990 org-link-types))
9991 (unwind-protect
9992 (progn
9993 (setq link
9994 (org-completing-read
9995 "Link: "
9996 (append
9997 (mapcar (lambda (x) (concat x ":"))
9998 all-prefixes)
9999 (mapcar 'car org-stored-links))
10000 nil nil nil
10001 'tmphist
10002 (caar org-stored-links)))
10004 (user-error "No link selected"))
10005 (mapc (lambda(l)
10006 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10007 org-stored-links)
10008 (if (or (member link all-prefixes)
10009 (and (equal ":" (substring link -1))
10010 (member (substring link 0 -1) all-prefixes)
10011 (setq link (substring link 0 -1))))
10012 (setq link (with-current-buffer origbuf
10013 (org-link-try-special-completion link)))))
10014 (set-window-configuration wcf)
10015 (kill-buffer "*Org Links*"))
10016 (setq entry (assoc link org-stored-links))
10017 (or entry (push link org-insert-link-history))
10018 (setq desc (or desc (nth 1 entry)))))
10020 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10021 (not org-keep-stored-link-after-insertion))
10022 (setq org-stored-links (delq (assoc link org-stored-links)
10023 org-stored-links)))
10025 (if (and (string-match org-plain-link-re link)
10026 (not (string-match org-ts-regexp link)))
10027 ;; URL-like link, normalize the use of angular brackets.
10028 (setq link (org-remove-angle-brackets link)))
10030 ;; Check if we are linking to the current file with a search
10031 ;; option If yes, simplify the link by using only the search
10032 ;; option.
10033 (when (and buffer-file-name
10035 (let* ((path (match-string 1 link))
10036 (case-fold-search nil)
10037 (search (match-string 2 link)))
10038 (save-match-data
10039 (if (equal (file-truename buffer-file-name) (file-truename path))
10040 ;; We are linking to this same file, with a search option
10041 (setq link search)))))
10043 ;; Check if we can/should use a relative path. If yes, simplify the link
10045 (let* ((type (match-string 1 link))
10046 (path (match-string 2 link))
10047 (origpath path)
10048 (case-fold-search nil))
10049 (cond
10050 ((or (eq org-link-file-path-type 'absolute)
10051 (equal complete-file '(16)))
10052 (setq path (abbreviate-file-name (expand-file-name path))))
10053 ((eq org-link-file-path-type 'noabbrev)
10054 (setq path (expand-file-name path)))
10055 ((eq org-link-file-path-type 'relative)
10056 (setq path (file-relative-name path)))
10057 (t
10058 (save-match-data
10059 (if (string-match (concat "^" (regexp-quote
10060 (expand-file-name
10061 (file-name-as-directory
10062 default-directory))))
10063 (expand-file-name path))
10064 ;; We are linking a file with relative path name.
10065 (setq path (substring (expand-file-name path)
10066 (match-end 0)))
10067 (setq path (abbreviate-file-name (expand-file-name path)))))))
10068 (setq link (concat type path))
10069 (if (equal desc origpath)
10070 (setq desc path))))
10072 (if org-make-link-description-function
10073 (setq desc
10074 (or (condition-case nil
10075 (funcall org-make-link-description-function link desc)
10076 (error (progn (message "Can't get link description from `%s'"
10077 (symbol-name org-make-link-description-function))
10078 (sit-for 2) nil)))
10079 (read-string "Description: " default-description)))
10080 (if default-description (setq desc default-description)
10081 (setq desc (or (and auto-desc desc)
10082 (read-string "Description: " desc)))))
10085 (if remove (apply 'delete-region remove))
10086 (insert (org-make-link-string link desc))))
10088 (defun org-link-try-special-completion (type)
10089 "If there is completion support for link type TYPE, offer it."
10090 (let ((fun (intern (concat "org-" type "-complete-link"))))
10091 (if (functionp fun)
10092 (funcall fun)
10093 (read-string "Link (no completion support): " (concat type ":")))))
10095 (defun org-file-complete-link (&optional arg)
10096 "Create a file link using completion."
10097 (let (file link)
10098 (setq file (org-iread-file-name "File: "))
10099 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10100 (pwd1 (file-name-as-directory (abbreviate-file-name
10101 (expand-file-name ".")))))
10102 (cond
10103 ((equal arg '(16))
10104 (setq link (concat
10105 "file:"
10106 (abbreviate-file-name (expand-file-name file)))))
10108 (setq link (concat "file:" (match-string 1 file))))
10110 (expand-file-name file))
10111 (setq link (concat
10112 "file:" (match-string 1 (expand-file-name file)))))
10113 (t (setq link (concat "file:" file)))))
10114 link))
10116 (defun org-iread-file-name (&rest args)
10117 "Read-file-name using `ido-mode' speedup if available.
10118 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10119 See `read-file-name' for a description of parameters."
10120 (org-without-partial-completion
10121 (if (and org-completion-use-ido
10122 (fboundp 'ido-read-file-name)
10123 (boundp 'ido-mode) ido-mode
10124 (listp (second args)))
10125 (let ((ido-enter-matching-directory nil))
10126 (apply 'ido-read-file-name args))
10127 (apply 'read-file-name args))))
10129 (defun org-completing-read (&rest args)
10130 "Completing-read with SPACE being a normal character."
10131 (let ((enable-recursive-minibuffers t)
10132 (minibuffer-local-completion-map
10133 (copy-keymap minibuffer-local-completion-map)))
10134 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10135 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10136 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10137 (apply 'org-icompleting-read args)))
10139 (defun org-completing-read-no-i (&rest args)
10140 (let (org-completion-use-ido org-completion-use-iswitchb)
10141 (apply 'org-completing-read args)))
10143 (defun org-iswitchb-completing-read (prompt choices &rest args)
10144 "Use iswitch as a completing-read replacement to choose from choices.
10145 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10146 from."
10147 (let* ((iswitchb-use-virtual-buffers nil)
10148 (iswitchb-make-buflist-hook
10149 (lambda ()
10150 (setq iswitchb-temp-buflist choices))))
10151 (iswitchb-read-buffer prompt)))
10153 (defun org-icompleting-read (&rest args)
10154 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10155 (org-without-partial-completion
10156 (if (and org-completion-use-ido
10157 (fboundp 'ido-completing-read)
10158 (boundp 'ido-mode) ido-mode
10159 (listp (second args)))
10160 (let ((ido-enter-matching-directory nil))
10161 (apply 'ido-completing-read (concat (car args))
10162 (if (consp (car (nth 1 args)))
10163 (mapcar 'car (nth 1 args))
10164 (nth 1 args))
10165 (cddr args)))
10166 (if (and org-completion-use-iswitchb
10167 (boundp 'iswitchb-mode) iswitchb-mode
10168 (listp (second args)))
10169 (apply 'org-iswitchb-completing-read (concat (car args))
10170 (if (consp (car (nth 1 args)))
10171 (mapcar 'car (nth 1 args))
10172 (nth 1 args))
10173 (cddr args))
10174 (apply 'completing-read args)))))
10176 (defun org-extract-attributes (s)
10177 "Extract the attributes cookie from a string and set as text property."
10178 (let (a attr (start 0) key value)
10179 (save-match-data
10181 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10183 (setq key (match-string 1 a) value (match-string 2 a)
10184 start (match-end 0)
10185 attr (plist-put attr (intern key) value))))
10186 (org-add-props s nil 'org-attr attr))
10187 s))
10189 ;;; Opening/following a link
10191 (defvar org-link-search-failed nil)
10193 (defvar org-open-link-functions nil
10194 "Hook for functions finding a plain text link.
10195 These functions must take a single argument, the link content.
10196 They will be called for links that look like [[link text][description]]
10200 These functions will be called *before* Org attempts to resolve the
10201 link by doing text searches in the current buffer - so if you want a
10203 handle this as a special case.
10205 When the function does handle the link, it must return a non-nil value.
10206 If it decides that it is not responsible for this link, it must return
10207 nil to indicate that that Org-mode can continue with other options
10208 like exact and fuzzy text search.")
10210 (defun org-next-link (&optional search-backward)
10211 "Move forward to the next link.
10212 If the link is in hidden text, expose it."
10213 (interactive "P")
10214 (when (and org-link-search-failed (eq this-command last-command))
10215 (goto-char (point-min))
10216 (message "Link search wrapped back to beginning of buffer"))
10217 (setq org-link-search-failed nil)
10218 (let* ((pos (point))
10219 (ct (org-context))
10220 (a (assoc :link ct))
10221 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10222 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10223 ((looking-at org-any-link-re)
10224 ;; Don't stay stuck at link without an org-link face
10225 (forward-char (if search-backward -1 1))))
10226 (if (funcall srch-fun org-any-link-re nil t)
10227 (progn
10228 (goto-char (match-beginning 0))
10229 (if (outline-invisible-p) (org-show-context)))
10230 (goto-char pos)
10231 (setq org-link-search-failed t)
10232 (message "No further link found"))))
10234 (defun org-previous-link ()
10235 "Move backward to the previous link.
10236 If the link is in hidden text, expose it."
10237 (interactive)
10238 (funcall 'org-next-link t))
10240 (defun org-translate-link (s)
10241 "Translate a link string if a translation function has been defined."
10242 (if (and org-link-translation-function
10243 (fboundp org-link-translation-function)
10245 (progn
10246 (setq s (funcall org-link-translation-function
10247 (match-string 1 s) (match-string 2 s)))
10248 (concat (car s) ":" (cdr s)))
10249 s))
10251 (defun org-translate-link-from-planner (type path)
10252 "Translate a link from Emacs Planner syntax so that Org can follow it.
10253 This is still an experimental function, your mileage may vary."
10254 (cond
10255 ((member type '("http" "https" "news" "ftp"))
10256 ;; standard Internet links are the same.
10257 nil)
10258 ((and (equal type "irc") (string-match "^//" path))
10259 ;; Planner has two / at the beginning of an irc link, we have 1.
10260 ;; We should have zero, actually....
10261 (setq path (substring path 1)))
10262 ((and (equal type "lisp") (string-match "^/" path))
10263 ;; Planner has a slash, we do not.
10264 (setq type "elisp" path (substring path 1)))
10266 ;; A typical message link. Planner has the id after the final slash,
10267 ;; we separate it with a hash mark
10268 (setq path (concat (match-string 1 path) "#"
10269 (org-remove-angle-brackets (match-string 2 path))))))
10270 (cons type path))
10272 (defun org-find-file-at-mouse (ev)
10273 "Open file link or URL at mouse."
10274 (interactive "e")
10275 (mouse-set-point ev)
10276 (org-open-at-point 'in-emacs))
10278 (defun org-open-at-mouse (ev)
10279 "Open file link or URL at mouse.
10280 See the docstring of `org-open-file' for details."
10281 (interactive "e")
10282 (mouse-set-point ev)
10283 (if (eq major-mode 'org-agenda-mode)
10284 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10285 (org-open-at-point))
10287 (defvar org-window-config-before-follow-link nil
10288 "The window configuration before following a link.
10289 This is saved in case the need arises to restore it.")
10291 (defvar org-open-link-marker (make-marker)
10292 "Marker pointing to the location where `org-open-at-point; was called.")
10294 ;;;###autoload
10295 (defun org-open-at-point-global ()
10296 "Follow a link like Org-mode does.
10297 This command can be called in any mode to follow a link that has
10298 Org-mode syntax."
10299 (interactive)
10300 (org-run-like-in-org-mode 'org-open-at-point))
10302 ;;;###autoload
10303 (defun org-open-link-from-string (s &optional arg reference-buffer)
10304 "Open a link in the string S, as if it was in Org-mode."
10306 (let ((reference-buffer (or reference-buffer (current-buffer))))
10307 (with-temp-buffer
10308 (let ((org-inhibit-startup (not reference-buffer)))
10309 (org-mode)
10310 (insert s)
10311 (goto-char (point-min))
10312 (when reference-buffer
10313 (setq org-link-abbrev-alist-local
10314 (with-current-buffer reference-buffer
10315 org-link-abbrev-alist-local)))
10316 (org-open-at-point arg reference-buffer)))))
10318 (defvar org-open-at-point-functions nil
10319 "Hook that is run when following a link at point.
10321 Functions in this hook must return t if they identify and follow
10322 a link at point. If they don't find anything interesting at point,
10323 they must return nil.")
10325 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10326 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10327 (defun org-open-at-point (&optional arg reference-buffer)
10328 "Open link at or after point.
10329 If there is no link at point, this function will search forward up to
10330 the end of the current line.
10331 Normally, files will be opened by an appropriate application. If the
10332 optional prefix argument ARG is non-nil, Emacs will visit the file.
10333 With a double prefix argument, try to open outside of Emacs, in the
10334 application the system uses for this file type."
10335 (interactive "P")
10336 ;; if in a code block, then open the block's results
10337 (unless (call-interactively #'org-babel-open-src-block-result)
10338 (org-load-modules-maybe)
10339 (move-marker org-open-link-marker (point))
10340 (setq org-window-config-before-follow-link (current-window-configuration))
10341 (org-remove-occur-highlights nil nil t)
10342 (cond
10343 ((and (org-at-heading-p)
10344 (not (org-at-timestamp-p t))
10345 (not (org-in-regexp
10350 (not (get-text-property (point) 'org-linked-text)))
10351 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10352 (lk0 (car lkall))
10353 (lk (if (stringp lk0) (list lk0) lk0))
10354 (lkend (cdr lkall)))
10355 (mapcar (lambda(l)
10356 (search-forward l nil lkend)
10357 (goto-char (match-beginning 0))
10358 (org-open-at-point))
10359 lk))
10360 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10361 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10362 ((and (org-at-timestamp-p t)
10363 (not (org-in-regexp org-bracket-link-regexp)))
10364 (org-follow-timestamp-link))
10365 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10366 (not (org-in-regexp org-any-link-re)))
10367 (org-footnote-action))
10368 (t
10369 (let (type path link line search (pos (point)))
10370 (catch 'match
10371 (save-excursion
10373 (when (org-in-regexp org-bracket-link-regexp 1)
10374 (setq link (org-extract-attributes
10375 (org-link-unescape (org-match-string-no-properties 1))))
10377 (setq link (replace-match " " t t link)))
10378 (setq link (org-link-expand-abbrev link))
10379 (cond
10380 ((or (file-name-absolute-p link)
10382 (setq type "file" path link))
10383 ((string-match org-link-re-with-space3 link)
10384 (setq type (match-string 1 link) path (match-string 2 link)))
10386 (setq type "help" path (match-string 1 link)))
10387 (t (setq type "thisfile" path link)))
10388 (throw 'match t)))
10390 (when (get-text-property (point) 'org-linked-text)
10391 (setq type "thisfile"
10392 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10393 (1+ (point)) (point))
10394 path (buffer-substring
10395 (or (previous-single-property-change pos 'org-linked-text)
10396 (point-min))
10397 (or (next-single-property-change pos 'org-linked-text)
10398 (point-max)))
10399 ;; Ensure we will search for a <<<radio>>> link, not
10400 ;; a simple reference like <<ref>>
10401 path (concat "<" path))
10402 (throw 'match t))
10404 (save-excursion
10405 (when (or (org-in-regexp org-angle-link-re)
10406 (let ((match (org-in-regexp org-plain-link-re)))
10407 ;; Check a plain link is not within a bracket link
10408 (and match
10409 (save-excursion
10410 (progn
10411 (goto-char (car match))
10412 (not (org-in-regexp org-bracket-link-regexp))))))
10413 (let ((line_ending (save-excursion (end-of-line) (point))))
10414 ;; We are in a line before a plain or bracket link
10415 (or (re-search-forward org-plain-link-re line_ending t)
10416 (re-search-forward org-bracket-link-regexp line_ending t))))
10417 (setq type (match-string 1)
10418 path (org-link-unescape (match-string 2)))
10419 (throw 'match t)))
10420 (save-excursion
10422 (setq type "tags"
10423 path (match-string 1))
10424 (while (string-match ":" path)
10425 (setq path (replace-match "+" t t path)))
10426 (throw 'match t)))
10428 (setq type "tree-match"
10429 path (match-string 1))
10430 (throw 'match t)))
10431 (unless path
10432 (user-error "No link found"))
10434 ;; switch back to reference buffer
10435 ;; needed when if called in a temporary buffer through
10436 ;; org-open-link-from-string
10437 (with-current-buffer (or reference-buffer (current-buffer))
10439 ;; Remove any trailing spaces in path
10441 (setq path (replace-match "" t t path)))
10442 (if (and org-link-translation-function
10443 (fboundp org-link-translation-function))
10444 ;; Check if we need to translate the link
10445 (let ((tmp (funcall org-link-translation-function type path)))
10446 (setq type (car tmp) path (cdr tmp))))
10448 (cond
10450 ((assoc type org-link-protocols)
10451 (funcall (nth 1 (assoc type org-link-protocols)) path))
10453 ((equal type "help")
10454 (let ((f-or-v (intern path)))
10455 (cond ((fboundp f-or-v)
10456 (describe-function f-or-v))
10457 ((boundp f-or-v)
10458 (describe-variable f-or-v))
10459 (t (error "Not a known function or variable")))))
10461 ((equal type "mailto")
10462 (let ((cmd (car org-link-mailto-program))
10463 (args (cdr org-link-mailto-program)) args1
10464 (address path) (subject "") a)
10466 (setq address (match-string 1 path)
10467 subject (org-link-escape (match-string 2 path))))
10468 (while args
10469 (cond
10470 ((not (stringp (car args))) (push (pop args) args1))
10471 (t (setq a (pop args))
10472 (if (string-match "%a" a)
10473 (setq a (replace-match address t t a)))
10474 (if (string-match "%s" a)
10475 (setq a (replace-match subject t t a)))
10476 (push a args1))))
10477 (apply cmd (nreverse args1))))
10479 ((member type '("http" "https" "ftp" "news"))
10480 (browse-url
10481 (concat type ":"
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 ((string= type "doi")
10490 (browse-url
10491 (concat org-doi-server-url
10492 (if (org-string-match-p
10493 (concat "[[:nonascii:]"
10494 org-link-escape-chars-browser "]")
10495 path)
10496 (org-link-escape path org-link-escape-chars-browser)
10497 path))))
10499 ((member type '("message"))
10500 (browse-url (concat type ":" path)))
10502 ((string= type "tags")
10503 (org-tags-view arg path))
10505 ((string= type "tree-match")
10508 ((string= type "file")
10510 (setq line (string-to-number (match-string 1 path))
10511 path (substring path 0 (match-beginning 0)))
10513 (setq search (match-string 1 path)
10514 path (substring path 0 (match-beginning 0)))))
10515 (if (string-match "[*?{]" (file-name-nondirectory path))
10516 (dired path)
10517 (org-open-file path arg line search)))
10519 ((string= type "shell")
10520 (let ((buf (generate-new-buffer "*Org Shell Output"))
10521 (cmd path))
10522 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10523 (string-match org-confirm-shell-link-not-regexp cmd))
10524 (not org-confirm-shell-link-function)
10525 (funcall org-confirm-shell-link-function
10527 (org-add-props cmd nil
10528 'face 'org-warning))))
10529 (progn
10530 (message "Executing %s" cmd)
10531 (shell-command cmd buf)
10532 (if (featurep 'midnight)
10533 (setq clean-buffer-list-kill-buffer-names
10534 (cons buf clean-buffer-list-kill-buffer-names))))
10535 (error "Abort"))))
10537 ((string= type "elisp")
10538 (let ((cmd path))
10539 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10540 (string-match org-confirm-elisp-link-not-regexp cmd))
10541 (not org-confirm-elisp-link-function)
10542 (funcall org-confirm-elisp-link-function
10544 (org-add-props cmd nil
10545 'face 'org-warning))))
10546 (message "%s => %s" cmd
10547 (if (equal (string-to-char cmd) ?\()
10548 (eval (read cmd))
10549 (call-interactively (read cmd))))
10550 (error "Abort"))))
10552 ((and (string= type "thisfile")
10553 (or (run-hook-with-args-until-success
10554 'org-open-link-functions path)
10555 (and link
10556 (string-match "^id:" link)
10557 (or (featurep 'org-id) (require 'org-id))
10558 (progn
10559 (funcall (nth 1 (assoc "id" org-link-protocols))
10560 (substring path 3))
10561 t)))))
10563 ((string= type "thisfile")
10564 (if arg
10565 (switch-to-buffer-other-window
10566 (org-get-buffer-for-internal-link (current-buffer)))
10567 (org-mark-ring-push))
10568 (let ((cmd `(org-link-search
10569 ,path
10570 ,(cond ((equal arg '(4)) ''occur)
10571 ((equal arg '(16)) ''org-occur))
10572 ,pos)))
10573 (condition-case nil (let ((org-link-search-inhibit-query t))
10574 (eval cmd))
10575 (error (progn (widen) (eval cmd))))))
10577 (t (browse-url-at-point)))))))
10578 (move-marker org-open-link-marker nil)
10579 (run-hook-with-args 'org-follow-link-hook)))
10581 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10582 "Offer links in the current entry and return the selected link.
10583 If there is only one link, return it.
10584 If NTH is an integer, return the NTH link found.
10585 If ZERO is a string, check also this string for a link, and if
10586 there is one, return it."
10587 (with-current-buffer buffer
10588 (save-excursion
10589 (save-restriction
10590 (widen)
10591 (goto-char marker)
10595 (cnt ?0)
10596 (in-emacs (if (integerp nth) nil nth))
10597 have-zero end links link c)
10598 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10599 (push (match-string 0 zero) links)
10600 (setq cnt (1- cnt) have-zero t))
10601 (save-excursion
10602 (org-back-to-heading t)
10603 (setq end (save-excursion (outline-next-heading) (point)))
10604 (while (re-search-forward re end t)
10605 (push (match-string 0) links))
10606 (setq links (org-uniquify (reverse links))))
10607 (cond
10608 ((null links)
10609 (message "No links"))
10610 ((equal (length links) 1)
10611 (setq link (car links)))
10612 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10613 (setq link (nth (if have-zero nth (1- nth)) links)))
10614 (t ; we have to select a link
10615 (save-excursion
10616 (save-window-excursion
10617 (delete-other-windows)
10618 (with-output-to-temp-buffer "*Select Link*"
10619 (mapc (lambda (l)
10620 (if (not (string-match org-bracket-link-regexp l))
10622 (org-remove-angle-brackets l)))
10623 (if (match-end 3)
10625 (match-string 3 l) (match-string 1 l)))
10627 (match-string 1 l))))))
10628 links))
10629 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10630 (message "Select link to open, RET to open all:")
10631 (setq c (read-char-exclusive))
10632 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10633 (when (equal c ?q) (error "Abort"))
10634 (if (equal c ?\C-m)
10635 (setq link links)
10636 (setq nth (- c ?0))
10637 (if have-zero (setq nth (1+ nth)))
10638 (unless (and (integerp nth) (>= (length links) nth))
10639 (user-error "Invalid link selection"))
10640 (setq link (nth (1- nth) links)))))
10641 (cons link end))))))
10643 ;; Add special file links that specify the way of opening
10645 (org-add-link-type "file+sys" 'org-open-file-with-system)
10646 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10647 (defun org-open-file-with-system (path)
10648 "Open file at PATH using the system way of opening it."
10649 (org-open-file path 'system))
10650 (defun org-open-file-with-emacs (path)
10651 "Open file at PATH in Emacs."
10652 (org-open-file path 'emacs))
10655 ;;; File search
10657 (defvar org-create-file-search-functions nil
10658 "List of functions to construct the right search string for a file link.
10659 These functions are called in turn with point at the location to
10660 which the link should point.
10662 A function in the hook should first test if it would like to
10663 handle this file type, for example by checking the `major-mode'
10664 or the file extension. If it decides not to handle this file, it
10665 should just return nil to give other functions a chance. If it
10666 does handle the file, it must return the search string to be used
10667 when following the link. The search string will be part of the
10668 file link, given after a double colon, and `org-open-at-point'
10669 will automatically search for it. If special measures must be
10670 taken to make the search successful, another function should be
10671 added to the companion hook `org-execute-file-search-functions',
10672 which see.
10674 A function in this hook may also use `setq' to set the variable
10675 `description' to provide a suggestion for the descriptive text to
10676 be used for this link when it gets inserted into an Org-mode
10679 (defvar org-execute-file-search-functions nil
10680 "List of functions to execute a file search triggered by a link.
10682 Functions added to this hook must accept a single argument, the
10683 search string that was part of the file link, the part after the
10684 double colon. The function must first check if it would like to
10685 handle this search, for example by checking the `major-mode' or
10686 the file extension. If it decides not to handle this search, it
10687 should just return nil to give other functions a chance. If it
10688 does handle the search, it must return a non-nil value to keep
10689 other functions from trying.
10691 Each function can access the current prefix argument through the
10692 variable `current-prefix-arg'. Note that a single prefix is used
10693 to force opening a link in Emacs, so it may be good to only use a
10694 numeric or double prefix to guide the search function.
10696 In case this is needed, a function in this hook can also restore
10697 the window configuration before `org-open-at-point' was called using:
10699 (set-window-configuration org-window-config-before-follow-link)")
10701 (defun org-link-search (s &optional type avoid-pos stealth)
10702 "Search for a link search option.
10703 If S is surrounded by forward slashes, it is interpreted as a
10704 regular expression. In org-mode files, this will create an `org-occur'
10705 sparse tree. In ordinary files, `occur' will be used to list matches.
10706 If the current buffer is in `dired-mode', grep will be used to search
10707 in all files. If AVOID-POS is given, ignore matches near that position.
10709 When optional argument STEALTH is non-nil, do not modify
10710 visibility around point, thus ignoring
10711 `org-show-hierarchy-above', `org-show-following-heading' and
10712 `org-show-siblings' variables."
10713 (let ((case-fold-search t)
10717 org-emphasis-alist)
10719 (pos (point))
10720 (pre nil) (post nil)
10721 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10722 (cond
10723 ;; First check if there are any special search functions
10724 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10725 ;; Now try the builtin stuff
10726 ((and (equal (string-to-char s0) ?#)
10727 (> (length s0) 1)
10728 (save-excursion
10729 (goto-char (point-min))
10730 (and
10731 (re-search-forward
10734 (setq type 'dedicated
10735 pos (match-beginning 0))))
10736 ;; There is an exact target for this
10737 (goto-char pos)
10738 (org-back-to-heading t)))
10739 ((save-excursion
10740 (goto-char (point-min))
10741 (and
10742 (re-search-forward
10743 (concat "<<" (regexp-quote s0) ">>") nil t)
10744 (setq type 'dedicated
10745 pos (match-beginning 0))))
10746 ;; There is an exact target for this
10747 (goto-char pos))
10748 ((save-excursion
10749 (goto-char (point-min))
10750 (and
10751 (re-search-forward
10753 (setq type 'dedicated pos (match-beginning 0))))
10754 ;; Found an element with a matching #+name affiliated keyword.
10755 (goto-char pos))
10757 (save-excursion
10758 (goto-char (point-min))
10759 (and
10760 (re-search-forward
10761 (concat "[^[]" (regexp-quote
10762 (format org-coderef-label-format
10763 (match-string 1 s0))))
10764 nil t)
10765 (setq type 'dedicated
10766 pos (1+ (match-beginning 0))))))
10767 ;; There is a coderef target for this
10768 (goto-char pos))
10770 ;; A regular expression
10771 (cond
10772 ((derived-mode-p 'org-mode)
10773 (org-occur (match-string 1 s)))
10774 (t (org-do-occur (match-string 1 s)))))
10775 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10776 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10777 (goto-char (point-min))
10778 (cond
10779 ((let (case-fold-search)
10780 (re-search-forward (format org-complex-heading-regexp-format
10781 (regexp-quote s))
10782 nil t))
10783 ;; OK, found a match
10784 (setq type 'dedicated)
10785 (goto-char (match-beginning 0)))
10786 ((and (not org-link-search-inhibit-query)
10787 (eq org-link-search-must-match-exact-headline 'query-to-create)
10788 (y-or-n-p "No match - create this as a new heading? "))
10789 (goto-char (point-max))
10790 (or (bolp) (newline))
10792 (beginning-of-line 0))
10793 (t
10794 (goto-char pos)
10795 (error "No match"))))
10796 (t
10797 ;; A normal search string
10798 (when (equal (string-to-char s) ?*)
10799 ;; Anchor on headlines, post may include tags.
10802 s (substring s 1)))
10803 (remove-text-properties
10804 0 (length s)
10805 '(face nil mouse-face nil keymap nil fontified nil) s)
10806 ;; Make a series of regular expressions to find a match
10817 re4 (concat "[^a-zA-Z_]" re4_)
10819 re1 (concat pre re2 post)
10820 re3 (concat pre (if pre re4_ re4) post)
10821 re5 (concat pre ".*" re4)
10822 re2 (concat pre re2)
10823 re2a (concat pre (if pre re2a_ re2a))
10824 re4 (concat pre (if pre re4_ re4))
10828 (cond
10829 ((eq type 'org-occur) (org-occur reall))
10830 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10831 (t (goto-char (point-min))
10832 (setq type 'fuzzy)
10833 (if (or (and (org-search-not-self 1 re0 nil t)
10834 (setq type 'dedicated))
10835 (org-search-not-self 1 re1 nil t)
10836 (org-search-not-self 1 re2 nil t)
10837 (org-search-not-self 1 re2a nil t)
10838 (org-search-not-self 1 re3 nil t)
10839 (org-search-not-self 1 re4 nil t)
10840 (org-search-not-self 1 re5 nil t))
10841 (goto-char (match-beginning 1))
10842 (goto-char pos)
10843 (error "No match"))))))
10844 (and (derived-mode-p 'org-mode)
10845 (not stealth)
10846 (org-show-context 'link-search))
10847 type))
10849 (defun org-search-not-self (group &rest args)
10850 "Execute `re-search-forward', but only accept matches that do not
10851 enclose the position of `org-open-link-marker'."
10852 (let ((m org-open-link-marker))
10853 (catch 'exit
10854 (while (apply 're-search-forward args)
10855 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10856 (goto-char (match-end group))
10857 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10858 (> (match-beginning 0) (marker-position m))
10859 (< (match-end 0) (marker-position m)))
10860 (save-match-data
10861 (or (not (org-in-regexp
10862 org-bracket-link-analytic-regexp 1))
10863 (not (match-end 4)) ; no description
10864 (and (<= (match-beginning 4) (point))
10865 (>= (match-end 4) (point))))))
10866 (throw 'exit (point))))))))
10868 (defun org-get-buffer-for-internal-link (buffer)
10869 "Return a buffer to be used for displaying the link target of internal links."
10870 (cond
10871 ((not org-display-internal-link-with-indirect-buffer)
10872 buffer)
10873 ((string-match "(Clone)$" (buffer-name buffer))
10874 (message "Buffer is already a clone, not making another one")
10875 ;; we also do not modify visibility in this case
10876 buffer)
10877 (t ; make a new indirect buffer for displaying the link
10878 (let* ((bn (buffer-name buffer))
10879 (ibn (concat bn "(Clone)"))
10880 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10881 (with-current-buffer ib (org-overview))
10882 ib))))
10884 (defun org-do-occur (regexp &optional cleanup)
10885 "Call the Emacs command `occur'.
10886 If CLEANUP is non-nil, remove the printout of the regular expression
10887 in the *Occur* buffer. This is useful if the regex is long and not useful
10888 to read."
10889 (occur regexp)
10890 (when cleanup
10891 (let ((cwin (selected-window)) win beg end)
10892 (when (setq win (get-buffer-window "*Occur*"))
10893 (select-window win))
10894 (goto-char (point-min))
10895 (when (re-search-forward "match[a-z]+" nil t)
10896 (setq beg (match-end 0))
10898 (setq end (1- (match-beginning 0)))))
10899 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10900 (goto-char (point-min))
10901 (select-window cwin))))
10903 ;;; The mark ring for links jumps
10905 (defvar org-mark-ring nil
10906 "Mark ring for positions before jumps in Org-mode.")
10907 (defvar org-mark-ring-last-goto nil
10908 "Last position in the mark ring used to go back.")
10909 ;; Fill and close the ring
10910 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10911 (loop for i from 1 to org-mark-ring-length do
10912 (push (make-marker) org-mark-ring))
10913 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10914 org-mark-ring)
10916 (defun org-mark-ring-push (&optional pos buffer)
10917 "Put the current position or POS into the mark ring and rotate it."
10918 (interactive)
10919 (setq pos (or pos (point)))
10920 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10921 (move-marker (car org-mark-ring)
10922 (or pos (point))
10923 (or buffer (current-buffer)))
10924 (message "%s"
10925 (substitute-command-keys
10928 (defun org-mark-ring-goto (&optional n)
10929 "Jump to the previous position in the mark ring.
10930 With prefix arg N, jump back that many stored positions. When
10931 called several times in succession, walk through the entire ring.
10932 Org-mode commands jumping to a different position in the current file,
10933 or to another Org-mode file, automatically push the old position
10934 onto the ring."
10935 (interactive "p")
10936 (let (p m)
10937 (if (eq last-command this-command)
10938 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10939 (setq p org-mark-ring))
10940 (setq org-mark-ring-last-goto p)
10941 (setq m (car p))
10942 (org-pop-to-buffer-same-window (marker-buffer m))
10943 (goto-char m)
10944 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10946 (defun org-remove-angle-brackets (s)
10947 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10948 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10949 s)
10950 (defun org-add-angle-brackets (s)
10951 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10952 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10953 s)
10954 (defun org-remove-double-quotes (s)
10957 s)
10959 ;;; Following specific links
10961 (defun org-follow-timestamp-link ()
10962 "Open an agenda view for the time-stamp date/range at point."
10963 (cond
10964 ((org-at-date-range-p t)
10965 (let ((org-agenda-start-on-weekday)
10966 (t1 (match-string 1))
10967 (t2 (match-string 2)) tt1 tt2)
10968 (setq tt1 (time-to-days (org-time-string-to-time t1))
10969 tt2 (time-to-days (org-time-string-to-time t2)))
10970 (let ((org-agenda-buffer-tmp-name
10971 (format "*Org Agenda(a:%s)"
10972 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10973 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10974 ((org-at-timestamp-p t)
10975 (let ((org-agenda-buffer-tmp-name
10976 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10977 (org-agenda-list nil (time-to-days (org-time-string-to-time
10978 (substring (match-string 1) 0 10)))
10979 1)))
10980 (t (error "This should not happen"))))
10983 ;;; Following file links
10984 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10985 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10986 (declare-function mailcap-mime-info
10987 "mailcap" (string &optional request no-decode))
10988 (defvar org-wait nil)
10989 (defun org-open-file (path &optional in-emacs line search)
10990 "Open the file at PATH.
10991 First, this expands any special file name abbreviations. Then the
10992 configuration variable `org-file-apps' is checked if it contains an
10993 entry for this file type, and if yes, the corresponding command is launched.
10995 If no application is found, Emacs simply visits the file.
10997 With optional prefix argument IN-EMACS, Emacs will visit the file.
10999 prefix arg, Org tries to avoid opening in Emacs
11000 and to use an external application to visit the file.
11002 Optional LINE specifies a line to go to, optional SEARCH a string
11003 to search for. If LINE or SEARCH is given, the file will be
11004 opened in Emacs, unless an entry from org-file-apps that makes
11005 use of groups in a regexp matches.
11007 If you want to change the way frames are used when following a
11008 link, please customize `org-link-frame-setup'.
11010 If the file does not exist, an error is thrown."
11011 (let* ((file (if (equal path "")
11012 buffer-file-name
11013 (substitute-in-file-name (expand-file-name path))))
11014 (file-apps (append org-file-apps (org-default-apps)))
11015 (apps (org-remove-if
11016 'org-file-apps-entry-match-against-dlink-p file-apps))
11017 (apps-dlink (org-remove-if-not
11018 'org-file-apps-entry-match-against-dlink-p file-apps))
11019 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11020 (dirp (if remp nil (file-directory-p file)))
11021 (file (if (and dirp org-open-directory-means-index-dot-org)
11022 (concat (file-name-as-directory file) "index.org")
11023 file))
11024 (a-m-a-p (assq 'auto-mode apps))
11025 (dfile (downcase file))
11026 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11027 (link (cond ((and (eq line nil)
11028 (eq search nil))
11029 file)
11030 (line
11031 (concat file "::" (number-to-string line)))
11032 (search
11033 (concat file "::" search))))
11034 (dlink (downcase link))
11035 (old-buffer (current-buffer))
11036 (old-pos (point))
11037 (old-mode major-mode)
11038 ext cmd link-match-data)
11040 (setq ext (match-string 1 dfile))
11042 (setq ext (match-string 1 dfile))))
11043 (cond
11044 ((member in-emacs '((16) system))
11045 (setq cmd (cdr (assoc 'system apps))))
11046 (in-emacs (setq cmd 'emacs))
11047 (t
11048 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11049 (and dirp (cdr (assoc 'directory apps)))
11050 ; first, try matching against apps-dlink
11051 ; if we get a match here, store the match data for later
11052 (let ((match (assoc-default dlink apps-dlink
11053 'string-match)))
11054 (if match
11055 (progn (setq link-match-data (match-data))
11056 match)
11057 (progn (setq in-emacs (or in-emacs line search))
11058 nil))) ; if we have no match in apps-dlink,
11059 ; always open the file in emacs if line or search
11060 ; is given (for backwards compatibility)
11061 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11062 'string-match)
11063 (cdr (assoc ext apps))
11064 (cdr (assoc t apps))))))
11065 (when (eq cmd 'system)
11066 (setq cmd (cdr (assoc 'system apps))))
11067 (when (eq cmd 'default)
11068 (setq cmd (cdr (assoc t apps))))
11069 (when (eq cmd 'mailcap)
11070 (require 'mailcap)
11071 (mailcap-parse-mailcaps)
11072 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11073 (command (mailcap-mime-info mime-type)))
11074 (if (stringp command)
11075 (setq cmd command)
11076 (setq cmd 'emacs))))
11077 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11078 (not (file-exists-p file))
11079 (not org-open-non-existing-files))
11080 (user-error "No such file: %s" file))
11081 (cond
11083 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11085 (setq cmd (replace-match "%s" t t cmd)))
11086 (while (string-match "%s" cmd)
11087 (setq cmd (replace-match
11088 (save-match-data
11089 (shell-quote-argument
11090 (convert-standard-filename file)))
11091 t t cmd)))
11093 ;; Replace "%1", "%2" etc. in command with group matches from regex
11094 (save-match-data
11095 (let ((match-index 1)
11096 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11097 (set-match-data link-match-data)
11098 (while (<= match-index number-of-groups)
11099 (let ((regex (concat "%" (number-to-string match-index)))
11100 (replace-with (match-string match-index dlink)))
11101 (while (string-match regex cmd)
11102 (setq cmd (replace-match replace-with t t cmd))))
11103 (setq match-index (+ match-index 1)))))
11105 (save-window-excursion
11106 (message "Running %s...done" cmd)
11107 (start-process-shell-command cmd nil cmd)
11108 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11109 ((or (stringp cmd)
11110 (eq cmd 'emacs))
11111 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11112 (widen)
11113 (if line (org-goto-line line)
11114 (if search (org-link-search search))))
11115 ((consp cmd)
11116 (let ((file (convert-standard-filename file)))
11117 (save-match-data
11118 (set-match-data link-match-data)
11119 (eval cmd))))
11120 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11121 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11122 (or (not (equal old-buffer (current-buffer)))
11123 (not (equal old-pos (point))))
11124 (org-mark-ring-push old-pos old-buffer))))
11126 (defun org-file-apps-entry-match-against-dlink-p (entry)
11127 "This function returns non-nil if `entry' uses a regular
11128 expression which should be matched against the whole link by
11129 org-open-file.
11131 It assumes that is the case when the entry uses a regular
11132 expression which has at least one grouping construct and the
11133 action is either a lisp form or a command string containing
11134 '%1', i.e. using at least one subexpression match as a
11135 parameter."
11136 (let ((selector (car entry))
11137 (action (cdr entry)))
11138 (if (stringp selector)
11139 (and (> (regexp-opt-depth selector) 0)
11140 (or (and (stringp action)
11141 (string-match "%[0-9]" action))
11142 (consp action)))
11143 nil)))
11145 (defun org-default-apps ()
11146 "Return the default applications for this operating system."
11147 (cond
11148 ((eq system-type 'darwin)
11149 org-file-apps-defaults-macosx)
11150 ((eq system-type 'windows-nt)
11151 org-file-apps-defaults-windowsnt)
11152 (t org-file-apps-defaults-gnu)))
11154 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11155 "Convert extensions to regular expressions in the cars of LIST.
11156 Also, weed out any non-string entries, because the return value is used
11157 only for regexp matching.
11158 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11159 point to the symbol `emacs', indicating that the file should
11160 be opened in Emacs."
11161 (append
11162 (delq nil
11163 (mapcar (lambda (x)
11164 (if (not (stringp (car x)))
11165 nil
11167 x
11169 list))
11170 (if add-auto-mode
11171 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11173 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11174 (defun org-file-remote-p (file)
11175 "Test whether FILE specifies a location on a remote system.
11176 Return non-nil if the location is indeed remote.
11180 (cond ((fboundp 'file-remote-p)
11181 (file-remote-p file))
11182 ((fboundp 'tramp-handle-file-remote-p)
11183 (tramp-handle-file-remote-p file))
11184 ((and (boundp 'ange-ftp-name-format)
11185 (string-match (car ange-ftp-name-format) file))
11186 t)))
11189 ;;;; Refiling
11191 (defun org-get-org-file ()
11192 "Read a filename, with default directory `org-directory'."
11193 (let ((default (or org-default-notes-file remember-data-file)))
11194 (read-file-name (format "File name [%s]: " default)
11195 (file-name-as-directory org-directory)
11196 default)))
11198 (defun org-notes-order-reversed-p ()
11199 "Check if the current file should receive notes in reversed order."
11200 (cond
11201 ((not org-reverse-note-order) nil)
11202 ((eq t org-reverse-note-order) t)
11203 ((not (listp org-reverse-note-order)) nil)
11204 (t (catch 'exit
11205 (let ((all org-reverse-note-order)
11206 entry)
11207 (while (setq entry (pop all))
11208 (if (string-match (car entry) buffer-file-name)
11209 (throw 'exit (cdr entry))))
11210 nil)))))
11212 (defvar org-refile-target-table nil
11213 "The list of refile targets, created by `org-refile'.")
11215 (defvar org-agenda-new-buffers nil
11216 "Buffers created to visit agenda files.")
11218 (defvar org-refile-cache nil
11219 "Cache for refile targets.")
11221 (defvar org-refile-markers nil
11222 "All the markers used for caching refile locations.")
11224 (defun org-refile-marker (pos)
11225 "Get a new refile marker, but only if caching is in use."
11226 (if (not org-refile-use-cache)
11227 pos
11228 (let ((m (make-marker)))
11229 (move-marker m pos)
11230 (push m org-refile-markers)
11231 m)))
11233 (defun org-refile-cache-clear ()
11234 "Clear the refile cache and disable all the markers."
11235 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11236 (setq org-refile-markers nil)
11237 (setq org-refile-cache nil)
11238 (message "Refile cache has been cleared"))
11240 (defun org-refile-cache-check-set (set)
11241 "Check if all the markers in the cache still have live buffers."
11242 (let (marker)
11243 (catch 'exit
11244 (while (and set (setq marker (nth 3 (pop set))))
11245 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11246 (when (and marker (null (marker-buffer marker)))
11247 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11248 (sit-for 3)
11249 (throw 'exit nil)))
11250 t)))
11252 (defun org-refile-cache-put (set &rest identifiers)
11253 "Push the refile targets SET into the cache, under IDENTIFIERS."
11254 (let* ((key (sha1 (prin1-to-string identifiers)))
11255 (entry (assoc key org-refile-cache)))
11256 (if entry
11257 (setcdr entry set)
11258 (push (cons key set) org-refile-cache))))
11260 (defun org-refile-cache-get (&rest identifiers)
11261 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11262 (cond
11263 ((not org-refile-cache) nil)
11264 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11265 (t
11266 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11267 org-refile-cache))))
11268 (and set (org-refile-cache-check-set set) set)))))
11270 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11271 "Produce a table with refile targets."
11272 (let ((case-fold-search nil)
11273 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11274 (entries (or org-refile-targets '((nil . (:level . 1)))))
11275 targets tgs txt re files f desc descre fast-path-p level pos0)
11276 (message "Getting targets...")
11277 (with-current-buffer (or default-buffer (current-buffer))
11278 (while (setq entry (pop entries))
11279 (setq files (car entry) desc (cdr entry))
11280 (setq fast-path-p nil)
11281 (cond
11282 ((null files) (setq files (list (current-buffer))))
11283 ((eq files 'org-agenda-files)
11284 (setq files (org-agenda-files 'unrestricted)))
11285 ((and (symbolp files) (fboundp files))
11286 (setq files (funcall files)))
11287 ((and (symbolp files) (boundp files))
11288 (setq files (symbol-value files))))
11289 (if (stringp files) (setq files (list files)))
11290 (cond
11291 ((eq (car desc) :tag)
11293 ((eq (car desc) :todo)
11295 ((eq (car desc) :regexp)
11296 (setq descre (cdr desc)))
11297 ((eq (car desc) :level)
11299 (if org-odd-levels-only
11300 (1- (* 2 (cdr desc)))
11301 (cdr desc)))
11303 ((eq (car desc) :maxlevel)
11304 (setq fast-path-p t)
11306 (if org-odd-levels-only
11307 (1- (* 2 (cdr desc)))
11308 (cdr desc)))
11310 (t (error "Bad refiling target description %s" desc)))
11311 (while (setq f (pop files))
11312 (with-current-buffer
11313 (if (bufferp f) f (org-get-agenda-file-buffer f))
11314 (or
11315 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11316 (progn
11317 (if (bufferp f) (setq f (buffer-file-name
11318 (buffer-base-buffer f))))
11319 (setq f (and f (expand-file-name f)))
11320 (if (eq org-refile-use-outline-path 'file)
11321 (push (list (file-name-nondirectory f) f nil nil) tgs))
11322 (save-excursion
11323 (save-restriction
11324 (widen)
11325 (goto-char (point-min))
11326 (while (re-search-forward descre nil t)
11327 (goto-char (setq pos0 (point-at-bol)))
11328 (catch 'next
11329 (when org-refile-target-verify-function
11330 (save-match-data
11331 (or (funcall org-refile-target-verify-function)
11332 (throw 'next t))))
11333 (when (and (looking-at org-complex-heading-regexp)
11334 (not (member (match-string 4) excluded-entries))
11335 (match-string 4))
11336 (setq level (org-reduced-level
11337 (- (match-end 1) (match-beginning 1)))
11338 txt (org-link-display-format (match-string 4))
11340 re (format org-complex-heading-regexp-format
11341 (regexp-quote (match-string 4))))
11342 (when org-refile-use-outline-path
11343 (setq txt (mapconcat
11344 'org-protect-slash
11345 (append
11346 (if (eq org-refile-use-outline-path
11347 'file)
11348 (list (file-name-nondirectory
11349 (buffer-file-name
11350 (buffer-base-buffer))))
11351 (if (eq org-refile-use-outline-path
11352 'full-file-path)
11353 (list (buffer-file-name
11354 (buffer-base-buffer)))))
11355 (org-get-outline-path fast-path-p
11356 level txt)
11357 (list txt))
11358 "/")))
11359 (push (list txt f re (org-refile-marker (point)))
11360 tgs)))
11361 (when (= (point) pos0)
11362 ;; verification function has not moved point
11363 (goto-char (point-at-eol))))))))
11364 (when org-refile-use-cache
11365 (org-refile-cache-put tgs (buffer-file-name) descre))
11366 (setq targets (append tgs targets))))))
11367 (message "Getting targets...done")
11368 (nreverse targets)))
11370 (defun org-protect-slash (s)
11371 (while (string-match "/" s)
11373 s)
11375 (defvar org-olpa (make-vector 20 nil))
11377 (defun org-get-outline-path (&optional fastp level heading)
11378 "Return the outline path to the current entry, as a list.
11380 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11381 routine which makes outline path derivations for an entire file,
11382 avoiding backtracing. Refile target collection makes use of that."
11383 (if fastp
11384 (progn
11385 (if (> level 19)
11386 (error "Outline path failure, more than 19 levels"))
11387 (loop for i from level upto 19 do
11388 (aset org-olpa i nil))
11389 (prog1
11390 (delq nil (append org-olpa nil))
11391 (aset org-olpa level heading)))
11392 (let (rtn case-fold-search)
11393 (save-excursion
11394 (save-restriction
11395 (widen)
11396 (while (org-up-heading-safe)
11397 (when (looking-at org-complex-heading-regexp)
11398 (push (org-trim
11399 (replace-regexp-in-string
11400 ;; Remove statistical/checkboxes cookies
11402 (org-match-string-no-properties 4)))
11403 rtn)))
11404 rtn)))))
11406 (defun org-format-outline-path (path &optional width prefix separator)
11407 "Format the outline path PATH for display.
11408 WIDTH is the maximum number of characters that is available.
11409 PREFIX is a prefix to be included in the returned string,
11410 such as the file name.
11411 SEPARATOR is inserted between the different parts of the path,
11413 (setq width (or width 79))
11414 (if prefix (setq width (- width (length prefix))))
11415 (if (not path)
11416 (or prefix "")
11417 (let* ((nsteps (length path))
11418 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11419 (maxwidth (if (<= total-width width)
11420 10000 ;; everything fits
11421 ;; we need to shorten the level headings
11422 (/ (- width nsteps) nsteps)))
11423 (org-odd-levels-only nil)
11424 (n 0)
11425 (total (1+ (length prefix))))
11426 (setq maxwidth (max maxwidth 10))
11427 (concat prefix
11428 (if prefix (or separator "/"))
11429 (mapconcat
11430 (lambda (h)
11431 (setq n (1+ n))
11432 (if (and (= n nsteps) (< maxwidth 10000))
11433 (setq maxwidth (- total-width total)))
11434 (if (< (length h) maxwidth)
11435 (progn (setq total (+ total (length h) 1)) h)
11436 (setq h (substring h 0 (- maxwidth 2))
11437 total (+ total maxwidth 1))
11439 (setq h (substring h 0 (match-beginning 0))))
11440 (setq h (concat h "..")))
11441 (org-add-props h nil 'face
11442 (nth (% (1- n) org-n-level-faces)
11443 org-level-faces))
11444 h)
11445 path (or separator "/"))))))
11447 (defun org-display-outline-path (&optional file current separator just-return-string)
11448 "Display the current outline path in the echo area.
11450 If FILE is non-nil, prepend the output with the file name.
11451 If CURRENT is non-nil, append the current heading to the output.
11452 SEPARATOR is passed through to `org-format-outline-path'. It separates
11454 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11455 (interactive "P")
11456 (let* (case-fold-search
11457 (bfn (buffer-file-name (buffer-base-buffer)))
11458 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11459 res)
11460 (if current (setq path (append path
11461 (save-excursion
11462 (org-back-to-heading t)
11463 (if (looking-at org-complex-heading-regexp)
11464 (list (match-string 4)))))))
11465 (setq res
11466 (org-format-outline-path
11467 path
11468 (1- (frame-width))
11469 (and file bfn (concat (file-name-nondirectory bfn) separator))
11470 separator))
11471 (if just-return-string
11472 (org-no-properties res)
11473 (org-unlogged-message "%s" res))))
11475 (defvar org-refile-history nil
11476 "History for refiling operations.")
11478 (defvar org-after-refile-insert-hook nil
11479 "Hook run after `org-refile' has inserted its stuff at the new location.
11480 Note that this is still *before* the stuff will be removed from
11481 the *old* location.")
11483 (defvar org-capture-last-stored-marker)
11484 (defvar org-refile-keep nil
11485 "Non-nil means `org-refile' will copy instead of refile.")
11487 (defun org-copy ()
11488 "Like `org-refile', but copy."
11489 (interactive)
11490 (let ((org-refile-keep t))
11491 (funcall 'org-refile nil nil nil "Copy")))
11493 (defun org-refile (&optional goto default-buffer rfloc msg)
11494 "Move the entry or entries at point to another heading.
11495 The list of target headings is compiled using the information in
11496 `org-refile-targets', which see.
11498 At the target location, the entry is filed as a subitem of the target
11499 heading. Depending on `org-reverse-note-order', the new subitem will
11500 either be the first or the last subitem.
11502 If there is an active region, all entries in that region will be moved.
11503 However, the region must fulfill the requirement that the first heading
11504 is the first one sets the top-level of the moved text - at most siblings
11505 below it are allowed.
11507 With prefix arg GOTO, the command will only visit the target location
11508 and not actually move anything.
11511 go to the location where the last refiling operation has put the subtree.
11513 With a numeric prefix argument of `2', refile to the running clock.
11515 With a numeric prefix argument of `3', emulate `org-refile-keep'
11516 being set to `t' and copy to the target location, don't move it.
11517 Beware that keeping refiled entries may result in duplicated ID
11518 properties.
11520 RFLOC can be a refile location obtained in a different way.
11525 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11527 If you are using target caching (see `org-refile-use-cache'),
11528 you have to clear the target cache in order to find new targets.
11529 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11530 prefix argument (`C-u C-u C-u C-c C-w')."
11532 (interactive "P")
11533 (if (member goto '(0 (64)))
11534 (org-refile-cache-clear)
11535 (let* ((actionmsg (or msg "Refile"))
11536 (cbuf (current-buffer))
11537 (regionp (org-region-active-p))
11538 (region-start (and regionp (region-beginning)))
11539 (region-end (and regionp (region-end)))
11540 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11541 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11542 pos it nbuf file re level reversed)
11543 (setq last-command nil)
11544 (when regionp
11545 (goto-char region-start)
11546 (or (bolp) (goto-char (point-at-bol)))
11547 (setq region-start (point))
11548 (unless (or (org-kill-is-subtree-p
11549 (buffer-substring region-start region-end))
11550 (prog1 org-refile-active-region-within-subtree
11551 (let ((s (point-at-eol)))
11552 (org-toggle-heading)
11553 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11554 (user-error "The region is not a (sequence of) subtree(s)")))
11555 (if (equal goto '(16))
11556 (org-refile-goto-last-stored)
11557 (when (or
11558 (and (equal goto 2)
11559 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11560 (prog1
11561 (setq it (list (or org-clock-heading "running clock")
11562 (buffer-file-name
11563 (marker-buffer org-clock-hd-marker))
11564 ""
11565 (marker-position org-clock-hd-marker)))
11566 (setq goto nil)))
11567 (setq it (or rfloc
11568 (let (heading-text)
11569 (save-excursion
11570 (unless goto
11571 (org-back-to-heading t)
11572 (setq heading-text
11573 (nth 4 (org-heading-components))))
11575 (org-refile-get-location
11576 (cond (goto "Goto")
11577 (regionp (concat actionmsg " region to"))
11580 default-buffer
11581 (and (not (equal '(4) goto))
11582 org-refile-allow-creating-parent-nodes)
11583 goto))))))
11584 (setq file (nth 1 it)
11585 re (nth 2 it)
11586 pos (nth 3 it))
11587 (if (and (not goto)
11588 pos
11589 (equal (buffer-file-name) file)
11590 (if regionp
11591 (and (>= pos region-start)
11592 (<= pos region-end))
11593 (and (>= pos (point))
11594 (< pos (save-excursion
11595 (org-end-of-subtree t t))))))
11596 (error "Cannot refile to position inside the tree or region"))
11598 (setq nbuf (or (find-buffer-visiting file)
11599 (find-file-noselect file)))
11600 (if (and goto (not (equal goto 3)))
11601 (progn
11602 (org-pop-to-buffer-same-window nbuf)
11603 (goto-char pos)
11604 (org-show-context 'org-goto))
11605 (if regionp
11606 (progn
11607 (org-kill-new (buffer-substring region-start region-end))
11608 (org-save-markers-in-region region-start region-end))
11609 (org-copy-subtree 1 nil t))
11610 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11611 (find-file-noselect file)))
11612 (setq reversed (org-notes-order-reversed-p))
11613 (save-excursion
11614 (save-restriction
11615 (widen)
11616 (if pos
11617 (progn
11618 (goto-char pos)
11619 (looking-at org-outline-regexp)
11620 (setq level (org-get-valid-level (funcall outline-level) 1))
11621 (goto-char
11622 (if reversed
11623 (or (outline-next-heading) (point-max))
11624 (or (save-excursion (org-get-next-sibling))
11625 (org-end-of-subtree t t)
11626 (point-max)))))
11627 (setq level 1)
11628 (if (not reversed)
11629 (goto-char (point-max))
11630 (goto-char (point-min))
11631 (or (outline-next-heading) (goto-char (point-max)))))
11632 (if (not (bolp)) (newline))
11633 (org-paste-subtree level)
11634 (when org-log-refile
11635 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11636 (unless (eq org-log-refile 'note)
11637 (save-excursion (org-add-log-note))))
11638 (and org-auto-align-tags
11639 (let ((org-loop-over-headlines-in-active-region nil))
11640 (org-set-tags nil t)))
11641 (let ((bookmark-name (plist-get org-bookmark-names-plist
11642 :last-refile)))
11643 (when bookmark-name
11644 (with-demoted-errors
11645 (bookmark-set bookmark-name))))
11646 ;; If we are refiling for capture, make sure that the
11647 ;; last-capture pointers point here
11648 (when (org-bound-and-true-p org-refile-for-capture)
11649 (let ((bookmark-name (plist-get org-bookmark-names-plist
11650 :last-capture-marker)))
11651 (when bookmark-name
11652 (with-demoted-errors
11653 (bookmark-set bookmark-name))))
11654 (move-marker org-capture-last-stored-marker (point)))
11655 (if (fboundp 'deactivate-mark) (deactivate-mark))
11656 (run-hooks 'org-after-refile-insert-hook))))
11657 (unless org-refile-keep
11658 (if regionp
11659 (delete-region (point) (+ (point) (- region-end region-start)))
11660 (delete-region
11661 (and (org-back-to-heading t) (point))
11662 (min (buffer-size) (org-end-of-subtree t t) (point)))))
11663 (when (featurep 'org-inlinetask)
11664 (org-inlinetask-remove-END-maybe))
11665 (setq org-markers-to-move nil)
11668 (defun org-refile-goto-last-stored ()
11669 "Go to the location where the last refile was stored."
11670 (interactive)
11671 (bookmark-jump "org-refile-last-stored")
11672 (message "This is the location of the last refile"))
11674 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11675 no-exclude)
11676 "Prompt the user for a refile location, using PROMPT.
11677 PROMPT should not be suffixed with a colon and a space, because
11678 this function appends the default value from
11679 `org-refile-history' automatically, if that is not empty.
11680 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11681 this is used for the GOTO interface."
11682 (let ((org-refile-targets org-refile-targets)
11683 (org-refile-use-outline-path org-refile-use-outline-path)
11684 excluded-entries)
11685 (when (and (derived-mode-p 'org-mode)
11686 (not org-refile-use-cache)
11687 (not no-exclude))
11688 (org-map-tree
11689 (lambda()
11690 (setq excluded-entries
11691 (append excluded-entries (list (org-get-heading t t)))))))
11692 (setq org-refile-target-table
11693 (org-refile-get-targets default-buffer excluded-entries)))
11694 (unless org-refile-target-table
11695 (user-error "No refile targets"))
11696 (let* ((cbuf (current-buffer))
11697 (partial-completion-mode nil)
11698 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11699 (cfunc (if (and org-refile-use-outline-path
11700 org-outline-path-complete-in-steps)
11701 'org-olpath-completing-read
11702 'org-icompleting-read))
11703 (extra (if org-refile-use-outline-path "/" ""))
11704 (cbnex (concat (buffer-name) extra))
11705 (filename (and cfn (expand-file-name cfn)))
11706 (tbl (mapcar
11707 (lambda (x)
11708 (if (and (not (member org-refile-use-outline-path
11709 '(file full-file-path)))
11710 (not (equal filename (nth 1 x))))
11711 (cons (concat (car x) extra " ("
11712 (file-name-nondirectory (nth 1 x)) ")")
11713 (cdr x))
11714 (cons (concat (car x) extra) (cdr x))))
11715 org-refile-target-table))
11716 (completion-ignore-case t)
11717 cdef
11718 (prompt (concat prompt
11719 (or (and (car org-refile-history)
11720 (concat " (default " (car org-refile-history) ")"))
11721 (and (assoc cbnex tbl) (setq cdef cbnex)
11722 (concat " (default " cbnex ")"))) ": "))
11723 pa answ parent-target child parent old-hist)
11724 (setq old-hist org-refile-history)
11725 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11726 nil 'org-refile-history (or cdef (car org-refile-history))))
11727 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11728 (org-refile-check-position pa)
11729 (if pa
11730 (progn
11731 (when (or (not org-refile-history)
11732 (not (eq old-hist org-refile-history))
11733 (not (equal (car pa) (car org-refile-history))))
11734 (setq org-refile-history
11735 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11736 org-refile-history
11737 (cdr org-refile-history))))
11738 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11739 (pop org-refile-history)))
11740 pa)
11742 (progn
11743 (setq parent (match-string 1 answ)
11744 child (match-string 2 answ))
11745 (setq parent-target (or (assoc parent tbl)
11746 (assoc (concat parent "/") tbl)))
11747 (when (and parent-target
11748 (or (eq new-nodes t)
11749 (and (eq new-nodes 'confirm)
11751 child)))))
11752 (org-refile-new-child parent-target child)))
11753 (user-error "Invalid target location")))))
11755 (declare-function org-string-nw-p "org-macs" (s))
11756 (defun org-refile-check-position (refile-pointer)
11757 "Check if the refile pointer matches the headline to which it points."
11758 (let* ((file (nth 1 refile-pointer))
11759 (re (nth 2 refile-pointer))
11760 (pos (nth 3 refile-pointer))
11761 buffer)
11762 (if (and (not (markerp pos)) (not file))
11763 (user-error "Please save the buffer to a file before refiling")
11764 (when (org-string-nw-p re)
11765 (setq buffer (if (markerp pos)
11766 (marker-buffer pos)
11767 (or (find-buffer-visiting file)
11768 (find-file-noselect file))))
11769 (with-current-buffer buffer
11770 (save-excursion
11771 (save-restriction
11772 (widen)
11773 (goto-char pos)
11774 (beginning-of-line 1)
11775 (unless (org-looking-at-p re)
11776 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11778 (defun org-refile-new-child (parent-target child)
11779 "Use refile target PARENT-TARGET to add new CHILD below it."
11780 (unless parent-target
11781 (error "Cannot find parent for new node"))
11782 (let ((file (nth 1 parent-target))
11783 (pos (nth 3 parent-target))
11784 level)
11785 (with-current-buffer (or (find-buffer-visiting file)
11786 (find-file-noselect file))
11787 (save-excursion
11788 (save-restriction
11789 (widen)
11790 (if pos
11791 (goto-char pos)
11792 (goto-char (point-max))
11793 (if (not (bolp)) (newline)))
11794 (when (looking-at org-outline-regexp)
11795 (setq level (funcall outline-level))
11796 (org-end-of-subtree t t))
11797 (org-back-over-empty-lines)
11799 (if pos (org-get-valid-level level 1) 1) ?*)
11801 (beginning-of-line 0)
11802 (list (concat (car parent-target) "/" child) file "" (point)))))))
11804 (defun org-olpath-completing-read (prompt collection &rest args)
11805 "Read an outline path like a file name."
11806 (let ((thetable collection)
11807 (org-completion-use-ido nil) ; does not work with ido.
11808 (org-completion-use-iswitchb nil)) ; or iswitchb
11809 (apply
11810 'org-icompleting-read prompt
11811 (lambda (string predicate &optional flag)
11812 (let (rtn r f (l (length string)))
11813 (cond
11814 ((eq flag nil)
11815 ;; try completion
11816 (try-completion string thetable))
11817 ((eq flag t)
11818 ;; all-completions
11819 (setq rtn (all-completions string thetable predicate))
11820 (mapcar
11821 (lambda (x)
11822 (setq r (substring x l))
11823 (if (string-match " ([^)]*)$" x)
11824 (setq f (match-string 0 x))
11825 (setq f ""))
11826 (if (string-match "/" r)
11827 (concat string (substring r 0 (match-end 0)) f)
11828 x))
11829 rtn))
11830 ((eq flag 'lambda)
11831 ;; exact match?
11832 (assoc string thetable)))))
11833 args)))
11835 ;;;; Dynamic blocks
11837 (defun org-find-dblock (name)
11838 "Find the first dynamic block with name NAME in the buffer.
11839 If not found, stay at current position and return nil."
11840 (let ((case-fold-search t) pos)
11841 (save-excursion
11842 (goto-char (point-min))
11843 (setq pos (and (re-search-forward
11845 (match-beginning 0))))
11846 (if pos (goto-char pos))
11847 pos))
11849 (defconst org-dblock-start-re
11851 "Matches the start line of a dynamic block, with parameters.")
11854 "Matches the end of a dynamic block.")
11856 (defun org-create-dblock (plist)
11857 "Create a dynamic block section, with parameters taken from PLIST.
11858 PLIST must contain a :name entry which is used as name of the block."
11860 (end-of-line 1)
11861 (newline))
11862 (let ((col (current-column))
11863 (name (plist-get plist :name)))
11864 (insert "#+BEGIN: " name)
11865 (while plist
11866 (if (eq (car plist) :name)
11867 (setq plist (cddr plist))
11868 (insert " " (prin1-to-string (pop plist)))))
11870 (beginning-of-line -2)))
11872 (defun org-prepare-dblock ()
11873 "Prepare dynamic block for refresh.
11874 This empties the block, puts the cursor at the insert position and returns
11875 the property list including an extra property :name with the block name."
11876 (unless (looking-at org-dblock-start-re)
11877 (user-error "Not at a dynamic block"))
11878 (let* ((begdel (1+ (match-end 0)))
11879 (name (org-no-properties (match-string 1)))
11880 (params (append (list :name name)
11881 (read (concat "(" (match-string 3) ")")))))
11882 (save-excursion
11883 (beginning-of-line 1)
11885 (setq params (plist-put params :indentation-column (current-column))))
11886 (unless (re-search-forward org-dblock-end-re nil t)
11887 (error "Dynamic block not terminated"))
11888 (setq params
11889 (append params
11890 (list :content (buffer-substring
11891 begdel (match-beginning 0)))))
11892 (delete-region begdel (match-beginning 0))
11893 (goto-char begdel)
11894 (open-line 1)
11895 params))
11897 (defun org-map-dblocks (&optional command)
11898 "Apply COMMAND to all dynamic blocks in the current buffer.
11899 If COMMAND is not given, use `org-update-dblock'."
11900 (let ((cmd (or command 'org-update-dblock)))
11901 (save-excursion
11902 (goto-char (point-min))
11903 (while (re-search-forward org-dblock-start-re nil t)
11904 (goto-char (match-beginning 0))
11905 (save-excursion
11906 (condition-case nil
11907 (funcall cmd)
11908 (error (message "Error during update of dynamic block"))))
11909 (unless (re-search-forward org-dblock-end-re nil t)
11910 (error "Dynamic block not terminated"))))))
11912 (defun org-dblock-update (&optional arg)
11913 "User command for updating dynamic blocks.
11914 Update the dynamic block at point. With prefix ARG, update all dynamic
11915 blocks in the buffer."
11916 (interactive "P")
11917 (if arg
11918 (org-update-all-dblocks)
11919 (or (looking-at org-dblock-start-re)
11920 (org-beginning-of-dblock))
11921 (org-update-dblock)))
11923 (defun org-update-dblock ()
11924 "Update the dynamic block at point.
11925 This means to empty the block, parse for parameters and then call
11926 the correct writing function."
11927 (interactive)
11928 (save-window-excursion
11929 (let* ((pos (point))
11930 (line (org-current-line))
11931 (params (org-prepare-dblock))
11932 (name (plist-get params :name))
11933 (indent (plist-get params :indentation-column))
11934 (cmd (intern (concat "org-dblock-write:" name))))
11935 (message "Updating dynamic block `%s' at line %d..." name line)
11936 (funcall cmd params)
11937 (message "Updating dynamic block `%s' at line %d...done" name line)
11938 (goto-char pos)
11939 (when (and indent (> indent 0))
11940 (setq indent (make-string indent ?\ ))
11941 (save-excursion
11942 (org-beginning-of-dblock)
11943 (forward-line 1)
11944 (while (not (looking-at org-dblock-end-re))
11945 (insert indent)
11946 (beginning-of-line 2))
11947 (when (looking-at org-dblock-end-re)
11949 (replace-match ""))
11950 (insert indent)))))))
11952 (defun org-beginning-of-dblock ()
11953 "Find the beginning of the dynamic block at point.
11954 Error if there is no such block at point."
11955 (let ((pos (point))
11956 beg)
11957 (end-of-line 1)
11958 (if (and (re-search-backward org-dblock-start-re nil t)
11959 (setq beg (match-beginning 0))
11960 (re-search-forward org-dblock-end-re nil t)
11961 (> (match-end 0) pos))
11962 (goto-char beg)
11963 (goto-char pos)
11964 (error "Not in a dynamic block"))))
11966 (defun org-update-all-dblocks ()
11967 "Update all dynamic blocks in the buffer.
11968 This function can be used in a hook."
11969 (interactive)
11970 (when (derived-mode-p 'org-mode)
11971 (org-map-dblocks 'org-update-dblock)))
11974 ;;;; Completion
11976 (declare-function org-export-backend-name "org-export" (cl-x))
11977 (declare-function org-export-backend-options "org-export" (cl-x))
11978 (defun org-get-export-keywords ()
11979 "Return a list of all currently understood export keywords.
11980 Export keywords include options, block names, attributes and
11981 keywords relative to each registered export back-end."
11982 (let (keywords)
11983 (dolist (backend
11984 (org-bound-and-true-p org-export--registered-backends)
11985 (delq nil keywords))
11986 ;; Back-end name (for keywords, like #+LATEX:)
11987 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
11988 (dolist (option-entry (org-export-backend-options backend))
11989 ;; Back-end options.
11990 (push (nth 1 option-entry) keywords)))))
11992 (defconst org-options-keywords
11993 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11994 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11995 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11996 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11997 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11999 (defcustom org-structure-template-alist
12013 ("A" "#+ASCII: " "")
12014 ("i" "#+INDEX: ?" "#+INDEX: ?")
12015 ("I" "#+INCLUDE: %file ?"
12017 "Structure completion elements.
12018 This is a list of abbreviation keys and values. The value gets inserted
12019 if you type `<' followed by the key and then press the completion key,
12020 usually `M-TAB'. %file will be replaced by a file name after prompting
12021 for the file using completion. The cursor will be placed at the position
12022 of the `?` in the template.
12023 There are two templates for each key, the first uses the original Org syntax,
12024 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12025 the default when the /org-mtags.el/ module has been loaded. See also the
12026 variable `org-mtags-prefer-muse-templates'."
12027 :group 'org-completion
12028 :type '(repeat
12029 (list
12030 (string :tag "Key")
12031 (string :tag "Template")
12032 (string :tag "Muse Template"))))
12034 (defun org-try-structure-completion ()
12035 "Try to complete a structure template before point.
12037 expands them."
12038 (let ((l (buffer-substring (point-at-bol) (point)))
12039 a)
12042 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12043 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12044 (match-beginning 1)) a)
12045 t)))
12047 (defun org-complete-expand-structure-template (start cell)
12048 "Expand a structure template."
12049 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12050 (rpl (nth (if musep 2 1) cell))
12051 (ind ""))
12052 (delete-region start (point))
12054 (cond
12055 ((bolp))
12057 (setq ind (buffer-substring (point-at-bol) (point))))
12058 (t (newline))))
12059 (setq start (point))
12060 (if (string-match "%file" rpl)
12061 (setq rpl (replace-match
12062 (concat
12064 (save-match-data
12065 (abbreviate-file-name (read-file-name "Include file: ")))
12067 t t rpl)))
12070 (insert rpl)
12073 ;;;; TODO, DEADLINE, Comments
12075 (defun org-toggle-comment ()
12076 "Change the COMMENT state of an entry."
12077 (interactive)
12078 (save-excursion
12079 (org-back-to-heading)
12080 (let (case-fold-search)
12081 (cond
12082 ((looking-at (format org-heading-keyword-regexp-format
12083 org-comment-string))
12084 (goto-char (match-end 1))
12085 (looking-at (concat " +" org-comment-string))
12086 (replace-match "" t t)
12087 (when (eolp) (insert " ")))
12088 ((looking-at org-outline-regexp)
12089 (goto-char (match-end 0))
12090 (insert org-comment-string " "))))))
12092 (defvar org-last-todo-state-is-todo nil
12093 "This is non-nil when the last TODO state change led to a TODO state.
12094 If the last change removed the TODO tag or switched to DONE, then
12095 this is nil.")
12097 (defvar org-setting-tags nil) ; dynamically skipped
12099 (defvar org-todo-setup-filter-hook nil
12100 "Hook for functions that pre-filter todo specs.
12101 Each function takes a todo spec and returns either nil or the spec
12102 transformed into canonical form." )
12104 (defvar org-todo-get-default-hook nil
12105 "Hook for functions that get a default item for todo.
12106 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12107 nil or a string to be used for the todo mark." )
12109 (defvar org-agenda-headline-snapshot-before-repeat)
12111 (defun org-current-effective-time ()
12112 "Return current time adjusted for `org-extend-today-until' variable."
12113 (let* ((ct (org-current-time))
12114 (dct (decode-time ct))
12115 (ct1
12116 (cond
12117 (org-use-last-clock-out-time-as-effective-time
12118 (or (org-clock-get-last-clock-out-time) ct))
12119 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12120 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12121 (t ct))))
12122 ct1))
12124 (defun org-todo-yesterday (&optional arg)
12125 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12126 (interactive "P")
12127 (if (eq major-mode 'org-agenda-mode)
12128 (apply 'org-agenda-todo-yesterday arg)
12129 (let* ((hour (third (decode-time
12130 (org-current-time))))
12131 (org-extend-today-until (1+ hour)))
12132 (org-todo arg))))
12134 (defvar org-block-entry-blocking ""
12135 "First entry preventing the TODO state change.")
12137 (defun org-todo (&optional arg)
12138 "Change the TODO state of an item.
12139 The state of an item is given by a keyword at the start of the heading,
12140 like
12141 *** TODO Write paper
12142 *** DONE Call mom
12144 The different keywords are specified in the variable `org-todo-keywords'.
12146 So for this example: when the item starts with TODO, it is changed to DONE.
12147 When it starts with DONE, the DONE is removed. And when neither TODO nor
12148 DONE are present, add TODO at the beginning of the heading.
12151 state.
12152 With numeric prefix arg, switch to that state.
12154 keywords (nextset).
12156 With a numeric prefix arg of 0, inhibit note taking for the change.
12158 For calling through lisp, arg is also interpreted in the following way:
12159 'none -> empty state
12161 'done -> switch to DONE
12162 'nextset -> switch to the next set of keywords
12163 'previousset -> switch to the previous set of keywords
12165 really is a member of `org-todo-keywords'."
12166 (interactive "P")
12167 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12168 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12169 'region-start-level 'region))
12170 org-loop-over-headlines-in-active-region)
12171 (org-map-entries
12172 `(org-todo ,arg)
12173 org-loop-over-headlines-in-active-region
12174 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12175 (if (equal arg '(16)) (setq arg 'nextset))
12176 (let ((org-blocker-hook org-blocker-hook)
12177 commentp
12178 case-fold-search)
12179 (when (equal arg '(64))
12180 (setq arg nil org-blocker-hook nil))
12181 (when (and org-blocker-hook
12182 (or org-inhibit-blocking
12183 (org-entry-get nil "NOBLOCKING")))
12184 (setq org-blocker-hook nil))
12185 (save-excursion
12186 (catch 'exit
12187 (org-back-to-heading t)
12189 (org-toggle-comment)
12190 (setq commentp t))
12191 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12194 (let* ((match-data (match-data))
12195 (startpos (point-at-bol))
12196 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12197 (org-log-done org-log-done)
12198 (org-log-repeat org-log-repeat)
12199 (org-todo-log-states org-todo-log-states)
12200 (org-inhibit-logging
12201 (if (equal arg 0)
12202 (progn (setq arg nil) 'note) org-inhibit-logging))
12203 (this (match-string 1))
12204 (hl-pos (match-beginning 0))
12205 (head (org-get-todo-sequence-head this))
12206 (ass (assoc head org-todo-kwd-alist))
12207 (interpret (nth 1 ass))
12208 (done-word (nth 3 ass))
12209 (final-done-word (nth 4 ass))
12210 (org-last-state (or this ""))
12211 (completion-ignore-case t)
12212 (member (member this org-todo-keywords-1))
12213 (tail (cdr member))
12214 (org-state (cond
12215 ((and org-todo-key-trigger
12216 (or (and (equal arg '(4))
12217 (eq org-use-fast-todo-selection 'prefix))
12218 (and (not arg) org-use-fast-todo-selection
12219 (not (eq org-use-fast-todo-selection
12220 'prefix)))))
12221 ;; Use fast selection
12222 (org-fast-todo-selection))
12223 ((and (equal arg '(4))
12224 (or (not org-use-fast-todo-selection)
12225 (not org-todo-key-trigger)))
12226 ;; Read a state with completion
12227 (org-icompleting-read
12228 "State: " (mapcar 'list org-todo-keywords-1)
12229 nil t))
12230 ((eq arg 'right)
12231 (if this
12232 (if tail (car tail) nil)
12233 (car org-todo-keywords-1)))
12234 ((eq arg 'left)
12235 (if (equal member org-todo-keywords-1)
12236 nil
12237 (if this
12238 (nth (- (length org-todo-keywords-1)
12239 (length tail) 2)
12240 org-todo-keywords-1)
12241 (org-last org-todo-keywords-1))))
12242 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12243 (setq arg nil))) ; hack to fall back to cycling
12244 (arg
12245 ;; user or caller requests a specific state
12246 (cond
12247 ((equal arg "") nil)
12248 ((eq arg 'none) nil)
12249 ((eq arg 'done) (or done-word (car org-done-keywords)))
12250 ((eq arg 'nextset)
12251 (or (car (cdr (member head org-todo-heads)))
12252 (car org-todo-heads)))
12253 ((eq arg 'previousset)
12254 (let ((org-todo-heads (reverse org-todo-heads)))
12255 (or (car (cdr (member head org-todo-heads)))
12256 (car org-todo-heads))))
12257 ((car (member arg org-todo-keywords-1)))
12258 ((stringp arg)
12259 (user-error "State `%s' not valid in this file" arg))
12260 ((nth (1- (prefix-numeric-value arg))
12261 org-todo-keywords-1))))
12262 ((null member) (or head (car org-todo-keywords-1)))
12263 ((equal this final-done-word) nil) ;; -> make empty
12264 ((null tail) nil) ;; -> first entry
12265 ((memq interpret '(type priority))
12266 (if (eq this-command last-command)
12267 (car tail)
12268 (if (> (length tail) 0)
12269 (or done-word (car org-done-keywords))
12270 nil)))
12271 (t
12272 (car tail))))
12273 (org-state (or
12274 (run-hook-with-args-until-success
12275 'org-todo-get-default-hook org-state org-last-state)
12276 org-state))
12277 (next (if org-state (concat " " org-state " ") " "))
12278 (change-plist (list :type 'todo-state-change :from this :to org-state
12279 :position startpos))
12280 dolog now-done-p)
12281 (when org-blocker-hook
12282 (setq org-last-todo-state-is-todo
12283 (not (member this org-done-keywords)))
12284 (unless (save-excursion
12285 (save-match-data
12286 (org-with-wide-buffer
12287 (run-hook-with-args-until-failure
12288 'org-blocker-hook change-plist))))
12289 (if (org-called-interactively-p 'interactive)
12291 this org-state org-block-entry-blocking)
12292 ;; fail silently
12294 this org-state org-block-entry-blocking)
12295 (throw 'exit nil))))
12296 (store-match-data match-data)
12297 (replace-match next t t)
12298 (unless (pos-visible-in-window-p hl-pos)
12299 (message "TODO state changed to %s" (org-trim next)))
12300 (unless head
12301 (setq head (org-get-todo-sequence-head org-state)
12302 ass (assoc head org-todo-kwd-alist)
12303 interpret (nth 1 ass)
12304 done-word (nth 3 ass)
12305 final-done-word (nth 4 ass)))
12306 (when (memq arg '(nextset previousset))
12307 (message "Keyword-Set %d/%d: %s"
12308 (- (length org-todo-sets) -1
12309 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12310 (length org-todo-sets)
12311 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12312 (setq org-last-todo-state-is-todo
12313 (not (member org-state org-done-keywords)))
12314 (setq now-done-p (and (member org-state org-done-keywords)
12315 (not (member this org-done-keywords))))
12316 (and logging (org-local-logging logging))
12317 (when (and (or org-todo-log-states org-log-done)
12318 (not (eq org-inhibit-logging t))
12319 (not (memq arg '(nextset previousset))))
12320 ;; we need to look at recording a time and note
12321 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12322 (nth 2 (assoc this org-todo-log-states))))
12323 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12324 (setq dolog 'time))
12325 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12326 (and org-state
12327 (member org-state org-not-done-keywords)
12328 (not (member this org-not-done-keywords))))
12329 ;; This is now a todo state and was not one before
12330 ;; If there was a CLOSED time stamp, get rid of it.
12331 (org-add-planning-info nil nil 'closed))
12332 (when (and now-done-p org-log-done)
12333 ;; It is now done, and it was not done before
12334 (org-add-planning-info 'closed (org-current-effective-time))
12335 (if (and (not dolog) (eq 'note org-log-done))
12336 (org-add-log-setup 'done org-state this 'findpos 'note)))
12337 (when (and org-state dolog)
12338 ;; This is a non-nil state, and we need to log it
12339 (org-add-log-setup 'state org-state this 'findpos dolog)))
12340 ;; Fixup tag positioning
12341 (org-todo-trigger-tag-changes org-state)
12342 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12343 (when org-provide-todo-statistics
12344 (org-update-parent-todo-statistics))
12345 (run-hooks 'org-after-todo-state-change-hook)
12346 (if (and arg (not (member org-state org-done-keywords)))
12347 (setq head (org-get-todo-sequence-head org-state)))
12348 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12349 ;; Do we need to trigger a repeat?
12350 (when now-done-p
12351 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12352 ;; This is for the agenda, take a snapshot of the headline.
12353 (save-match-data
12354 (setq org-agenda-headline-snapshot-before-repeat
12355 (org-get-heading))))
12356 (org-auto-repeat-maybe org-state))
12357 ;; Fixup cursor location if close to the keyword
12358 (if (and (outline-on-heading-p)
12359 (not (bolp))
12360 (save-excursion (beginning-of-line 1)
12361 (looking-at org-todo-line-regexp))
12362 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12363 (progn
12364 (goto-char (or (match-end 2) (match-end 1)))
12365 (and (looking-at " ") (just-one-space))))
12366 (when org-trigger-hook
12367 (save-excursion
12368 (run-hook-with-args 'org-trigger-hook change-plist)))
12369 (when commentp (org-toggle-comment))))))))
12371 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12372 "Block turning an entry into a TODO, using the hierarchy.
12373 This checks whether the current task should be blocked from state
12374 changes. Such blocking occurs when:
12376 1. The task has children which are not all in a completed state.
12378 2. A task has a parent with the property :ORDERED:, and there
12379 are siblings prior to the current task with incomplete
12380 status.
12382 3. The parent of the task is blocked because it has siblings that should
12383 be done first, or is child of a block grandparent TODO entry."
12385 (if (not org-enforce-todo-dependencies)
12386 t ; if locally turned off don't block
12387 (catch 'dont-block
12388 ;; If this is not a todo state change, or if this entry is already DONE,
12389 ;; do not block
12390 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12391 (member (plist-get change-plist :from)
12392 (cons 'done org-done-keywords))
12393 (member (plist-get change-plist :to)
12394 (cons 'todo org-not-done-keywords))
12395 (not (plist-get change-plist :to)))
12396 (throw 'dont-block t))
12397 ;; If this task has children, and any are undone, it's blocked
12398 (save-excursion
12399 (org-back-to-heading t)
12400 (let ((this-level (funcall outline-level)))
12401 (outline-next-heading)
12402 (let ((child-level (funcall outline-level)))
12403 (while (and (not (eobp))
12404 (> child-level this-level))
12405 ;; this todo has children, check whether they are all
12406 ;; completed
12407 (if (and (not (org-entry-is-done-p))
12408 (org-entry-is-todo-p))
12409 (progn (setq org-block-entry-blocking (org-get-heading))
12410 (throw 'dont-block nil)))
12411 (outline-next-heading)
12412 (setq child-level (funcall outline-level))))))
12413 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12414 ;; any previous siblings are undone, it's blocked
12415 (save-excursion
12416 (org-back-to-heading t)
12417 (let* ((pos (point))
12418 (parent-pos (and (org-up-heading-safe) (point))))
12419 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12420 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12421 (forward-line 1)
12422 (re-search-forward org-not-done-heading-regexp pos t))
12423 (setq org-block-entry-blocking (match-string 0))
12424 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12425 ;; Search further up the hierarchy, to see if an ancestor is blocked
12426 (while t
12427 (goto-char parent-pos)
12428 (if (not (looking-at org-not-done-heading-regexp))
12429 (throw 'dont-block t)) ; do not block, parent is not a TODO
12430 (setq pos (point))
12431 (setq parent-pos (and (org-up-heading-safe) (point)))
12432 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12433 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12434 (forward-line 1)
12435 (re-search-forward org-not-done-heading-regexp pos t)
12436 (setq org-block-entry-blocking (org-get-heading)))
12437 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12439 (defcustom org-track-ordered-property-with-tag nil
12440 "Should the ORDERED property also be shown as a tag?
12441 The ORDERED property decides if an entry should require subtasks to be
12442 completed in sequence. Since a property is not very visible, setting
12443 this option means that toggling the ORDERED property with the command
12444 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12445 not relevant for the behavior, but it makes things more visible.
12447 Note that toggling the tag with tags commands will not change the property
12448 and therefore not influence behavior!
12450 This can be t, meaning the tag ORDERED should be used, It can also be a
12451 string to select a different tag for this task."
12452 :group 'org-todo
12453 :type '(choice
12454 (const :tag "No tracking" nil)
12455 (const :tag "Track with ORDERED tag" t)
12456 (string :tag "Use other tag")))
12458 (defun org-toggle-ordered-property ()
12459 "Toggle the ORDERED property of the current entry.
12460 For better visibility, you can track the value of this property with a tag.
12461 See variable `org-track-ordered-property-with-tag'."
12462 (interactive)
12463 (let* ((t1 org-track-ordered-property-with-tag)
12464 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12465 (save-excursion
12466 (org-back-to-heading)
12467 (if (org-entry-get nil "ORDERED")
12468 (progn
12469 (org-delete-property "ORDERED" "PROPERTIES")
12470 (and tag (org-toggle-tag tag 'off))
12471 (message "Subtasks can be completed in arbitrary order"))
12472 (org-entry-put nil "ORDERED" "t")
12473 (and tag (org-toggle-tag tag 'on))
12474 (message "Subtasks must be completed in sequence")))))
12476 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12477 (defun org-block-todo-from-checkboxes (change-plist)
12478 "Block turning an entry into a TODO, using checkboxes.
12479 This checks whether the current task should be blocked from state
12480 changes because there are unchecked boxes in this entry."
12481 (if (not org-enforce-todo-checkbox-dependencies)
12482 t ; if locally turned off don't block
12483 (catch 'dont-block
12484 ;; If this is not a todo state change, or if this entry is already DONE,
12485 ;; do not block
12486 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12487 (member (plist-get change-plist :from)
12488 (cons 'done org-done-keywords))
12489 (member (plist-get change-plist :to)
12490 (cons 'todo org-not-done-keywords))
12491 (not (plist-get change-plist :to)))
12492 (throw 'dont-block t))
12493 ;; If this task has checkboxes that are not checked, it's blocked
12494 (save-excursion
12495 (org-back-to-heading t)
12496 (let ((beg (point)) end)
12497 (outline-next-heading)
12498 (setq end (point))
12499 (goto-char beg)
12500 (if (org-list-search-forward
12501 (concat (org-item-beginning-re)
12504 end t)
12505 (progn
12506 (if (boundp 'org-blocked-by-checkboxes)
12507 (setq org-blocked-by-checkboxes t))
12508 (throw 'dont-block nil)))))
12509 t))) ; do not block
12511 (defun org-entry-blocked-p ()
12512 "Is the current entry blocked?"
12513 (org-with-silent-modifications
12514 (if (org-entry-get nil "NOBLOCKING")
12515 nil ;; Never block this entry
12516 (not (run-hook-with-args-until-failure
12517 'org-blocker-hook
12518 (list :type 'todo-state-change
12519 :position (point)
12520 :from 'todo
12521 :to 'done))))))
12523 (defun org-update-statistics-cookies (all)
12524 "Update the statistics cookie, either from TODO or from checkboxes.
12525 This should be called with the cursor in a line with a statistics cookie."
12526 (interactive "P")
12527 (if all
12528 (progn
12529 (org-update-checkbox-count 'all)
12530 (org-map-entries 'org-update-parent-todo-statistics))
12531 (if (not (org-at-heading-p))
12532 (org-update-checkbox-count)
12533 (let ((pos (point-marker))
12534 end l1 l2)
12535 (ignore-errors (org-back-to-heading t))
12536 (if (not (org-at-heading-p))
12537 (org-update-checkbox-count)
12538 (setq l1 (org-outline-level))
12539 (setq end (save-excursion
12540 (outline-next-heading)
12541 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12542 (point)))
12543 (if (and (save-excursion
12544 (re-search-forward
12546 (not (save-excursion (re-search-forward
12548 (org-update-checkbox-count)
12549 (if (and l2 (> l2 l1))
12550 (progn
12551 (goto-char end)
12552 (org-update-parent-todo-statistics))
12553 (goto-char pos)
12554 (beginning-of-line 1)
12555 (while (re-search-forward
12557 (point-at-eol) t)
12558 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12559 (goto-char pos)
12560 (move-marker pos nil)))))
12562 (defvar org-entry-property-inherited-from) ;; defined below
12563 (defun org-update-parent-todo-statistics ()
12564 "Update any statistics cookie in the parent of the current headline.
12565 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12566 the entire subtree and this will travel up the hierarchy and update
12567 statistics everywhere."
12568 (let* ((prop (save-excursion (org-up-heading-safe)
12569 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12570 (recursive (or (not org-hierarchical-todo-statistics)
12572 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12573 0))
12574 (first t)
12576 level ltoggle l1 new ndel
12577 (cnt-all 0) (cnt-done 0) is-percent kwd
12578 checkbox-beg ov ovs ove cookie-present)
12579 (catch 'exit
12580 (save-excursion
12581 (beginning-of-line 1)
12582 (setq ltoggle (funcall outline-level))
12583 ;; Three situations are to consider:
12585 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12586 ;; to the top-level ancestor on the headline;
12588 ;; 2. If parent has "recursive" property, repeat up to the
12589 ;; headline setting that property, taking inheritance into
12590 ;; account;
12592 ;; 3. Else, move up to direct parent and proceed only once.
12593 (while (and (setq level (org-up-heading-safe))
12594 (or recursive first)
12595 (>= (point) lim))
12596 (setq first nil cookie-present nil)
12597 (unless (and level
12598 (not (string-match
12600 (downcase (or (org-entry-get nil "COOKIE_DATA")
12601 "")))))
12602 (throw 'exit nil))
12603 (while (re-search-forward box-re (point-at-eol) t)
12604 (setq cnt-all 0 cnt-done 0 cookie-present t)
12605 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12606 (save-match-data
12607 (unless (outline-next-heading) (throw 'exit nil))
12608 (while (and (looking-at org-complex-heading-regexp)
12609 (> (setq l1 (length (match-string 1))) level))
12610 (setq kwd (and (or recursive (= l1 ltoggle))
12611 (match-string 2)))
12612 (if (or (eq org-provide-todo-statistics 'all-headlines)
12613 (and (listp org-provide-todo-statistics)
12614 (or (member kwd org-provide-todo-statistics)
12615 (member kwd org-done-keywords))))
12616 (setq cnt-all (1+ cnt-all))
12617 (if (eq org-provide-todo-statistics t)
12618 (and kwd (setq cnt-all (1+ cnt-all)))))
12619 (and (member kwd org-done-keywords)
12620 (setq cnt-done (1+ cnt-done)))
12621 (outline-next-heading)))
12622 (setq new
12623 (if is-percent
12624 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12625 (format "[%d/%d]" cnt-done cnt-all))
12626 ndel (- (match-end 0) checkbox-beg))
12627 ;; handle overlays when updating cookie from column view
12628 (when (setq ov (car (overlays-at checkbox-beg)))
12629 (setq ovs (overlay-start ov) ove (overlay-end ov))
12630 (delete-overlay ov))
12631 (goto-char checkbox-beg)
12632 (insert new)
12633 (delete-region (point) (+ (point) ndel))
12634 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12635 (when ov (move-overlay ov ovs ove)))
12636 (when cookie-present
12637 (run-hook-with-args 'org-after-todo-statistics-hook
12638 cnt-done (- cnt-all cnt-done))))))
12639 (run-hooks 'org-todo-statistics-hook)))
12641 (defvar org-after-todo-statistics-hook nil
12642 "Hook that is called after a TODO statistics cookie has been updated.
12643 Each function is called with two arguments: the number of not-done entries
12644 and the number of done entries.
12646 For example, the following function, when added to this hook, will switch
12647 an entry to DONE when all children are done, and back to TODO when new
12648 entries are set to a TODO status. Note that this hook is only called
12649 when there is a statistics cookie in the headline!
12651 (defun org-summary-todo (n-done n-not-done)
12653 (let (org-log-done org-log-states) ; turn off logging
12655 ")
12657 (defvar org-todo-statistics-hook nil
12658 "Hook that is run whenever Org thinks TODO statistics should be updated.
12659 This hook runs even if there is no statistics cookie present, in which case
12660 `org-after-todo-statistics-hook' would not run.")
12662 (defun org-todo-trigger-tag-changes (state)
12663 "Apply the changes defined in `org-todo-state-tags-triggers'."
12664 (let ((l org-todo-state-tags-triggers)
12665 changes)
12666 (when (or (not state) (equal state ""))
12667 (setq changes (append changes (cdr (assoc "" l)))))
12668 (when (and (stringp state) (> (length state) 0))
12669 (setq changes (append changes (cdr (assoc state l)))))
12670 (when (member state org-not-done-keywords)
12671 (setq changes (append changes (cdr (assoc 'todo l)))))
12672 (when (member state org-done-keywords)
12673 (setq changes (append changes (cdr (assoc 'done l)))))
12674 (dolist (c changes)
12675 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12677 (defun org-local-logging (value)
12678 "Get logging settings from a property VALUE."
12679 (let* (words w a)
12680 ;; directly set the variables, they are already local.
12681 (setq org-log-done nil
12682 org-log-repeat nil
12683 org-todo-log-states nil)
12684 (setq words (org-split-string value))
12685 (while (setq w (pop words))
12686 (cond
12687 ((setq a (assoc w org-startup-options))
12688 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12689 (set (nth 1 a) (nth 2 a))))
12690 ((setq a (org-extract-log-state-settings w))
12691 (and (member (car a) org-todo-keywords-1)
12692 (push a org-todo-log-states)))))))
12694 (defun org-get-todo-sequence-head (kwd)
12695 "Return the head of the TODO sequence to which KWD belongs.
12696 If KWD is not set, check if there is a text property remembering the
12697 right sequence."
12698 (let (p)
12699 (cond
12700 ((not kwd)
12701 (or (get-text-property (point-at-bol) 'org-todo-head)
12702 (progn
12703 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12704 nil (point-at-eol)))
12705 (get-text-property p 'org-todo-head))))
12706 ((not (member kwd org-todo-keywords-1))
12707 (car org-todo-keywords-1))
12708 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12710 (defun org-fast-todo-selection ()
12711 "Fast TODO keyword selection with single keys.
12712 Returns the new TODO keyword, or nil if no state change should occur."
12713 (let* ((fulltable org-todo-key-alist)
12714 (done-keywords org-done-keywords) ;; needed for the faces.
12715 (maxlen (apply 'max (mapcar
12716 (lambda (x)
12717 (if (stringp (car x)) (string-width (car x)) 0))
12718 fulltable)))
12719 (expert nil)
12720 (fwidth (+ maxlen 3 1 3))
12721 (ncol (/ (- (window-width) 4) fwidth))
12722 tg cnt e c tbl
12723 groups ingroup)
12724 (save-excursion
12725 (save-window-excursion
12726 (if expert
12727 (set-buffer (get-buffer-create " *Org todo*"))
12728 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12729 (erase-buffer)
12730 (org-set-local 'org-done-keywords done-keywords)
12731 (setq tbl fulltable cnt 0)
12732 (while (setq e (pop tbl))
12733 (cond
12734 ((equal e '(:startgroup))
12735 (push '() groups) (setq ingroup t)
12736 (when (not (= cnt 0))
12737 (setq cnt 0)
12739 (insert "{ "))
12740 ((equal e '(:endgroup))
12741 (setq ingroup nil cnt 0)
12743 ((equal e '(:newline))
12744 (when (not (= cnt 0))
12745 (setq cnt 0)
12747 (setq e (car tbl))
12748 (while (equal (car tbl) '(:newline))
12750 (setq tbl (cdr tbl)))))
12751 (t
12752 (setq tg (car e) c (cdr e))
12753 (if ingroup (push tg (car groups)))
12754 (setq tg (org-add-props tg nil 'face
12755 (org-get-todo-face tg)))
12756 (if (and (= cnt 0) (not ingroup)) (insert " "))
12757 (insert "[" c "] " tg (make-string
12758 (- fwidth 4 (length tg)) ?\ ))
12759 (when (= (setq cnt (1+ cnt)) ncol)
12761 (if ingroup (insert " "))
12762 (setq cnt 0)))))
12764 (goto-char (point-min))
12765 (if (not expert) (org-fit-window-to-buffer))
12766 (message "[a-z..]:Set [SPC]:clear")
12767 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12768 (cond
12769 ((or (= c ?\C-g)
12770 (and (= c ?q) (not (rassoc c fulltable))))
12771 (setq quit-flag t))
12772 ((= c ?\ ) nil)
12773 ((setq e (rassoc c fulltable) tg (car e))
12774 tg)
12775 (t (setq quit-flag t)))))))
12777 (defun org-entry-is-todo-p ()
12778 (member (org-get-todo-state) org-not-done-keywords))
12780 (defun org-entry-is-done-p ()
12781 (member (org-get-todo-state) org-done-keywords))
12783 (defun org-get-todo-state ()
12784 "Return the TODO keyword of the current subtree."
12785 (save-excursion
12786 (org-back-to-heading t)
12787 (and (looking-at org-todo-line-regexp)
12788 (match-end 2)
12789 (match-string 2))))
12791 (defun org-at-date-range-p (&optional inactive-ok)
12792 "Is the cursor inside a date range?"
12793 (interactive)
12794 (save-excursion
12795 (catch 'exit
12796 (let ((pos (point)))
12798 (skip-chars-backward "<[")
12799 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12800 (>= (match-end 0) pos)
12801 (throw 'exit t))
12803 (skip-chars-backward "<[")
12804 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12805 (>= (match-end 0) pos)
12806 (throw 'exit t)))
12807 nil)))
12809 (defun org-get-repeat (&optional tagline)
12810 "Check if there is a deadline/schedule with repeater in this entry."
12811 (save-match-data
12812 (save-excursion
12813 (org-back-to-heading t)
12814 (and (re-search-forward (if tagline
12816 org-repeat-re)
12817 (org-entry-end-position) t)
12818 (match-string-no-properties 1)))))
12820 (defvar org-last-changed-timestamp)
12821 (defvar org-last-inserted-timestamp)
12822 (defvar org-log-post-message)
12823 (defvar org-log-note-purpose)
12824 (defvar org-log-note-how)
12825 (defvar org-log-note-extra)
12826 (defun org-auto-repeat-maybe (done-word)
12827 "Check if the current headline contains a repeated deadline/schedule.
12828 If yes, set TODO state back to what it was and change the base date
12829 of repeating deadline/scheduled time stamps to new date.
12830 This function is run automatically after each state change to a DONE state."
12831 ;; last-state is dynamically scoped into this function
12832 (let* ((repeat (org-get-repeat))
12833 (aa (assoc org-last-state org-todo-kwd-alist))
12834 (interpret (nth 1 aa))
12835 (head (nth 2 aa))
12836 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12837 (msg "Entry repeats: ")
12838 (org-log-done nil)
12839 (org-todo-log-states nil)
12840 re type n what ts time to-state)
12841 (when repeat
12842 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12843 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12844 org-todo-repeat-to-state))
12845 (unless (and to-state (member to-state org-todo-keywords-1))
12846 (setq to-state (if (eq interpret 'type) org-last-state head)))
12847 (org-todo to-state)
12848 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12849 (org-entry-put nil "LAST_REPEAT" (format-time-string
12850 (org-time-stamp-format t t))))
12851 (when org-log-repeat
12852 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12853 (memq 'org-add-log-note post-command-hook))
12854 ;; OK, we are already setup for some record
12855 (if (eq org-log-repeat 'note)
12856 ;; make sure we take a note, not only a time stamp
12857 (setq org-log-note-how 'note))
12858 ;; Set up for taking a record
12859 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12860 org-last-state
12861 'findpos org-log-repeat)))
12862 (org-back-to-heading t)
12863 (org-add-planning-info nil nil 'closed)
12867 (while (re-search-forward
12868 re (save-excursion (outline-next-heading) (point)) t)
12869 (setq type (if (match-end 1) org-scheduled-string
12870 (if (match-end 3) org-deadline-string "Plain:"))
12871 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12873 (setq n (string-to-number (match-string 2 ts))
12874 what (match-string 3 ts))
12875 (if (equal what "w") (setq n (* n 7) what "d"))
12877 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12878 ;; Preparation, see if we need to modify the start date for the change
12879 (when (match-end 1)
12880 (setq time (save-match-data (org-time-string-to-time ts)))
12881 (cond
12882 ((equal (match-string 1 ts) ".")
12883 ;; Shift starting date to today
12884 (org-timestamp-change
12885 (- (org-today) (time-to-days time))
12886 'day))
12887 ((equal (match-string 1 ts) "+")
12888 (let ((nshiftmax 10) (nshift 0))
12889 (while (or (= nshift 0)
12890 (<= (time-to-days time)
12891 (time-to-days (current-time))))
12892 (when (= (incf nshift) nshiftmax)
12893 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12894 (error "Abort")))
12895 (org-timestamp-change n (cdr (assoc what whata)))
12896 (org-at-timestamp-p t)
12897 (setq ts (match-string 1))
12898 (setq time (save-match-data (org-time-string-to-time ts)))))
12899 (org-timestamp-change (- n) (cdr (assoc what whata)))
12900 ;; rematch, so that we have everything in place for the real shift
12901 (org-at-timestamp-p t)
12902 (setq ts (match-string 1))
12904 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12905 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12906 (setq org-log-post-message msg)
12907 (message "%s" msg))))
12909 (defun org-show-todo-tree (arg)
12910 "Make a compact tree which shows all headlines marked with TODO.
12911 The tree will show the lines where the regexp matches, and all higher
12912 headlines above the match.
12914 With a numeric prefix N, construct a sparse tree for the Nth element
12915 of `org-todo-keywords-1'."
12916 (interactive "P")
12917 (let ((case-fold-search nil)
12918 (kwd-re
12919 (cond ((null arg) org-not-done-regexp)
12920 ((equal arg '(4))
12921 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12922 (mapcar 'list org-todo-keywords-1))))
12926 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12927 (regexp-quote (nth (1- (prefix-numeric-value arg))
12928 org-todo-keywords-1)))
12929 (t (user-error "Invalid prefix argument: %s" arg)))))
12930 (message "%d TODO entries found"
12931 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12933 (defun org-deadline (arg &optional time)
12935 With one universal prefix argument, remove any deadline from the item.
12936 With two universal prefix arguments, prompt for a warning delay.
12937 With argument TIME, set the deadline at the corresponding date. TIME
12939 (interactive "P")
12940 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12941 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12942 'region-start-level 'region))
12943 org-loop-over-headlines-in-active-region)
12944 (org-map-entries
12945 `(org-deadline ',arg ,time)
12946 org-loop-over-headlines-in-active-region
12947 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12948 (let* ((old-date (org-entry-get nil "DEADLINE"))
12949 (old-date-time (if old-date (org-time-string-to-time old-date)))
12950 (repeater (and old-date
12951 (string-match
12953 old-date)
12954 (match-string 1 old-date))))
12955 (cond
12956 ((equal arg '(4))
12957 (when (and old-date org-log-redeadline)
12958 (org-add-log-setup 'deldeadline nil old-date 'findpos
12959 org-log-redeadline))
12960 (org-remove-timestamp-with-keyword org-deadline-string)
12961 (message "Item no longer has a deadline."))
12962 ((equal arg '(16))
12963 (save-excursion
12964 (org-back-to-heading t)
12965 (if (re-search-forward
12966 org-deadline-time-regexp
12967 (save-excursion (outline-next-heading) (point)) t)
12968 (let* ((rpl0 (match-string 1))
12969 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12970 (replace-match
12971 (concat org-deadline-string
12972 " <" rpl
12973 (format " -%dd"
12974 (abs
12975 (- (time-to-days
12976 (save-match-data
12977 (org-read-date nil t nil "Warn starting from" old-date-time)))
12978 (time-to-days old-date-time))))
12979 ">") t t))
12980 (user-error "No deadline information to update"))))
12981 (t
12982 (org-add-planning-info 'deadline time 'closed)
12983 (when (and old-date org-log-redeadline
12984 (not (equal old-date
12985 (substring org-last-inserted-timestamp 1 -1))))
12986 (org-add-log-setup 'redeadline nil old-date 'findpos
12987 org-log-redeadline))
12988 (when repeater
12989 (save-excursion
12990 (org-back-to-heading t)
12991 (when (re-search-forward (concat org-deadline-string " "
12992 org-last-inserted-timestamp)
12993 (save-excursion
12994 (outline-next-heading) (point)) t)
12995 (goto-char (1- (match-end 0)))
12996 (insert " " repeater)
12997 (setq org-last-inserted-timestamp
12998 (concat (substring org-last-inserted-timestamp 0 -1)
12999 " " repeater
13000 (substring org-last-inserted-timestamp -1))))))
13001 (message "Deadline on %s" org-last-inserted-timestamp))))))
13003 (defun org-schedule (arg &optional time)
13004 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13005 With one universal prefix argument, remove any scheduling date from the item.
13006 With two universal prefix arguments, prompt for a delay cookie.
13007 With argument TIME, scheduled at the corresponding date. TIME can
13009 (interactive "P")
13010 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13011 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13012 'region-start-level 'region))
13013 org-loop-over-headlines-in-active-region)
13014 (org-map-entries
13015 `(org-schedule ',arg ,time)
13016 org-loop-over-headlines-in-active-region
13017 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13018 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13019 (old-date-time (if old-date (org-time-string-to-time old-date)))
13020 (repeater (and old-date
13021 (string-match
13023 old-date)
13024 (match-string 1 old-date))))
13025 (cond
13026 ((equal arg '(4))
13027 (progn
13028 (when (and old-date org-log-reschedule)
13029 (org-add-log-setup 'delschedule nil old-date 'findpos
13030 org-log-reschedule))
13031 (org-remove-timestamp-with-keyword org-scheduled-string)
13032 (message "Item is no longer scheduled.")))
13033 ((equal arg '(16))
13034 (save-excursion
13035 (org-back-to-heading t)
13036 (if (re-search-forward
13037 org-scheduled-time-regexp
13038 (save-excursion (outline-next-heading) (point)) t)
13039 (let* ((rpl0 (match-string 1))
13040 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13041 (replace-match
13042 (concat org-scheduled-string
13043 " <" rpl
13044 (format " -%dd"
13045 (abs
13046 (- (time-to-days
13047 (save-match-data
13048 (org-read-date nil t nil "Delay until" old-date-time)))
13049 (time-to-days old-date-time))))
13050 ">") t t))
13051 (user-error "No scheduled information to update"))))
13052 (t
13053 (org-add-planning-info 'scheduled time 'closed)
13054 (when (and old-date org-log-reschedule
13055 (not (equal old-date
13056 (substring org-last-inserted-timestamp 1 -1))))
13057 (org-add-log-setup 'reschedule nil old-date 'findpos
13058 org-log-reschedule))
13059 (when repeater
13060 (save-excursion
13061 (org-back-to-heading t)
13062 (when (re-search-forward (concat org-scheduled-string " "
13063 org-last-inserted-timestamp)
13064 (save-excursion
13065 (outline-next-heading) (point)) t)
13066 (goto-char (1- (match-end 0)))
13067 (insert " " repeater)
13068 (setq org-last-inserted-timestamp
13069 (concat (substring org-last-inserted-timestamp 0 -1)
13070 " " repeater
13071 (substring org-last-inserted-timestamp -1))))))
13072 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13074 (defun org-get-scheduled-time (pom &optional inherit)
13075 "Get the scheduled time as a time tuple, of a format suitable
13076 for calling org-schedule with, or if there is no scheduling,
13077 returns nil."
13078 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13079 (when time
13080 (apply 'encode-time (org-parse-time-string time)))))
13082 (defun org-get-deadline-time (pom &optional inherit)
13083 "Get the deadline as a time tuple, of a format suitable for
13084 calling org-deadline with, or if there is no scheduling, returns
13085 nil."
13086 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13087 (when time
13088 (apply 'encode-time (org-parse-time-string time)))))
13090 (defun org-remove-timestamp-with-keyword (keyword)
13091 "Remove all time stamps with KEYWORD in the current entry."
13093 beg)
13094 (save-excursion
13095 (org-back-to-heading t)
13096 (setq beg (point))
13097 (outline-next-heading)
13098 (while (re-search-backward re beg t)
13099 (replace-match "")
13101 (equal (char-before) ?\ ))
13102 (backward-delete-char 1)
13104 (point-at-bol) (point-at-eol)))
13105 (delete-region (point-at-bol)
13106 (min (point-max) (1+ (point-at-eol))))))))))
13108 (defvar org-time-was-given) ; dynamically scoped parameter
13109 (defvar org-end-time-was-given) ; dynamically scoped parameter
13111 (defun org-add-planning-info (what &optional time &rest remove)
13112 "Insert new timestamp with keyword in the line directly after the headline.
13113 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13114 If non is given, the user is prompted for a date.
13115 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13116 be removed."
13117 (interactive)
13118 (let (org-time-was-given org-end-time-was-given ts
13119 end default-time default-input)
13121 (catch 'exit
13122 (when (and (memq what '(scheduled deadline))
13123 (or (not time)
13124 (and (stringp time)
13125 (string-match "^[-+]+[0-9]" time))))
13126 ;; Try to get a default date/time from existing timestamp
13127 (save-excursion
13128 (org-back-to-heading t)
13129 (setq end (save-excursion (outline-next-heading) (point)))
13130 (when (re-search-forward (if (eq what 'scheduled)
13131 org-scheduled-time-regexp
13132 org-deadline-time-regexp)
13133 end t)
13134 (setq ts (match-string 1)
13135 default-time
13136 (apply 'encode-time (org-parse-time-string ts))
13137 default-input (and ts (org-get-compact-tod ts))))))
13138 (when what
13139 (setq time
13140 (if (stringp time)
13141 ;; This is a string (relative or absolute), set proper date
13142 (apply 'encode-time
13143 (org-read-date-analyze
13144 time default-time (decode-time default-time)))
13145 ;; If necessary, get the time from the user
13146 (or time (org-read-date nil 'to-time nil nil
13147 default-time default-input)))))
13149 (when (and org-insert-labeled-timestamps-at-point
13150 (member what '(scheduled deadline)))
13151 (insert
13152 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13153 (org-insert-time-stamp time org-time-was-given
13154 nil nil nil (list org-end-time-was-given))
13155 (setq what nil))
13156 (save-excursion
13157 (save-restriction
13158 (let (col list elt ts buffer-invisibility-spec)
13159 (org-back-to-heading t)
13161 (goto-char (match-end 1))
13162 (setq col (current-column))
13163 (goto-char (match-end 0))
13165 (when (and (not what)
13166 (not (looking-at
13168 org-keyword-time-not-clock-regexp))))
13169 ;; Nothing to add, nothing to remove...... :-)
13170 (throw 'exit nil))
13171 (if (and (not (looking-at org-outline-regexp))
13174 (not (equal (match-string 1) org-clock-string)))
13175 (narrow-to-region (match-beginning 0) (match-end 0))
13177 (backward-char 1)
13178 (narrow-to-region (point) (point))
13179 (and org-adapt-indentation (org-indent-to-column col)))
13180 ;; Check if we have to remove something.
13181 (setq list (cons what remove))
13182 (while list
13183 (setq elt (pop list))
13184 (when (or (and (eq elt 'scheduled)
13185 (re-search-forward org-scheduled-time-regexp nil t))
13186 (and (eq elt 'deadline)
13187 (re-search-forward org-deadline-time-regexp nil t))
13188 (and (eq elt 'closed)
13189 (re-search-forward org-closed-time-regexp nil t)))
13190 (replace-match "")
13191 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13193 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13194 (when what
13195 (insert
13196 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13197 (cond ((eq what 'scheduled) org-scheduled-string)
13198 ((eq what 'deadline) org-deadline-string)
13199 ((eq what 'closed) org-closed-string))
13200 " ")
13201 (setq ts (org-insert-time-stamp
13202 time
13203 (or org-time-was-given
13204 (and (eq what 'closed) org-log-done-with-time))
13205 (eq what 'closed)
13206 nil nil (list org-end-time-was-given)))
13207 (insert
13208 (if (not (or (bolp) (eq (char-before) ?\ )
13209 (memq (char-after) '(32 10))
13210 (eobp))) " " ""))
13211 (end-of-line 1))
13212 (goto-char (point-min))
13213 (widen)
13216 (delete-region (1- (point)) (point-at-eol)))
13217 ts))))))
13219 (defvar org-log-note-marker (make-marker))
13220 (defvar org-log-note-purpose nil)
13221 (defvar org-log-note-state nil)
13222 (defvar org-log-note-previous-state nil)
13223 (defvar org-log-note-how nil)
13224 (defvar org-log-note-extra nil)
13225 (defvar org-log-note-window-configuration nil)
13226 (defvar org-log-note-return-to (make-marker))
13227 (defvar org-log-note-effective-time nil
13228 "Remembered current time so that dynamically scoped
13229 `org-extend-today-until' affects tha timestamps in state change
13230 log")
13232 (defvar org-log-post-message nil
13233 "Message to be displayed after a log note has been stored.
13234 The auto-repeater uses this.")
13236 (defun org-add-note ()
13237 "Add a note to the current entry.
13238 This is done in the same way as adding a state change note."
13239 (interactive)
13240 (org-add-log-setup 'note nil nil 'findpos nil))
13242 (defvar org-property-end-re)
13243 (defun org-add-log-setup (&optional purpose state prev-state
13244 findpos how extra)
13245 "Set up the post command hook to take a note.
13246 If this is about to TODO state change, the new state is expected in STATE.
13247 When FINDPOS is non-nil, find the correct position for the note in
13248 the current entry. If not, assume that it can be inserted at point.
13249 HOW is an indicator what kind of note should be created.
13250 EXTRA is additional text that will be inserted into the notes buffer."
13251 (let* ((org-log-into-drawer (org-log-into-drawer))
13252 (drawer (cond ((stringp org-log-into-drawer)
13253 org-log-into-drawer)
13254 (org-log-into-drawer "LOGBOOK"))))
13255 (save-restriction
13256 (save-excursion
13257 (when findpos
13258 (org-back-to-heading t)
13259 (narrow-to-region (point) (save-excursion
13260 (outline-next-heading) (point)))
13264 (goto-char (match-end 0))
13265 (cond
13266 (drawer
13268 nil t)
13269 (progn
13270 (goto-char (match-end 0))
13271 (or org-log-states-order-reversed
13272 (and (re-search-forward org-property-end-re nil t)
13273 (goto-char (1- (match-beginning 0))))))
13275 (beginning-of-line 0)
13276 (org-indent-line)
13277 (beginning-of-line 2)
13278 (org-indent-line)
13279 (end-of-line 0)))
13280 ((and org-log-state-notes-insert-after-drawers
13281 (save-excursion
13282 (forward-line) (looking-at org-drawer-regexp)))
13283 (forward-line)
13284 (while (looking-at org-drawer-regexp)
13285 (goto-char (match-end 0))
13286 (re-search-forward org-property-end-re (point-max) t)
13287 (forward-line))
13288 (forward-line -1)))
13289 (unless org-log-states-order-reversed
13291 (org-skip-over-state-notes)
13293 (move-marker org-log-note-marker (point))
13294 (setq org-log-note-purpose purpose
13295 org-log-note-state state
13296 org-log-note-previous-state prev-state
13297 org-log-note-how how
13298 org-log-note-extra extra
13299 org-log-note-effective-time (org-current-effective-time))
13300 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13302 (defun org-skip-over-state-notes ()
13303 "Skip past the list of State notes in an entry."
13305 (when (ignore-errors (goto-char (org-in-item-p)))
13306 (let* ((struct (org-list-struct))
13307 (prevs (org-list-prevs-alist struct)))
13309 (goto-char (or (org-list-get-next-item (point) struct prevs)
13310 (org-list-get-item-end (point) struct)))))))
13312 (defun org-add-log-note (&optional purpose)
13313 "Pop up a window for taking a note, and add this note later at point."
13314 (remove-hook 'post-command-hook 'org-add-log-note)
13315 (setq org-log-note-window-configuration (current-window-configuration))
13316 (delete-other-windows)
13317 (move-marker org-log-note-return-to (point))
13318 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13319 (goto-char org-log-note-marker)
13320 (org-switch-to-buffer-other-window "*Org Note*")
13321 (erase-buffer)
13322 (if (memq org-log-note-how '(time state))
13323 (let (current-prefix-arg) (org-store-log-note))
13324 (let ((org-inhibit-startup t)) (org-mode))
13325 (insert (format "# Insert note for %s.
13327 (cond
13328 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13329 ((eq org-log-note-purpose 'done) "closed todo item")
13330 ((eq org-log-note-purpose 'state)
13332 (or org-log-note-previous-state "")
13333 (or org-log-note-state "")))
13334 ((eq org-log-note-purpose 'reschedule)
13335 "rescheduling")
13336 ((eq org-log-note-purpose 'delschedule)
13337 "no longer scheduled")
13338 ((eq org-log-note-purpose 'redeadline)
13339 "changing deadline")
13340 ((eq org-log-note-purpose 'deldeadline)
13341 "removing deadline")
13342 ((eq org-log-note-purpose 'refile)
13343 "refiling")
13344 ((eq org-log-note-purpose 'note)
13345 "this entry")
13346 (t (error "This should not happen")))))
13347 (if org-log-note-extra (insert org-log-note-extra))
13348 (org-set-local 'org-finish-function 'org-store-log-note)
13349 (run-hooks 'org-log-buffer-setup-hook)))
13351 (defvar org-note-abort nil) ; dynamically scoped
13352 (defun org-store-log-note ()
13353 "Finish taking a log note, and insert it to where it belongs."
13354 (let ((txt (buffer-string)))
13355 (kill-buffer (current-buffer))
13356 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13357 lines ind bul)
13359 (setq txt (replace-match "" t t txt)))
13361 (setq txt (replace-match "" t t txt)))
13364 (setq note
13365 (org-replace-escapes
13366 note
13367 (list (cons "%u" (user-login-name))
13368 (cons "%U" user-full-name)
13369 (cons "%t" (format-time-string
13370 (org-time-stamp-format 'long 'inactive)
13371 org-log-note-effective-time))
13372 (cons "%T" (format-time-string
13373 (org-time-stamp-format 'long nil)
13374 org-log-note-effective-time))
13375 (cons "%d" (format-time-string
13376 (org-time-stamp-format nil 'inactive)
13377 org-log-note-effective-time))
13378 (cons "%D" (format-time-string
13379 (org-time-stamp-format nil nil)
13380 org-log-note-effective-time))
13381 (cons "%s" (if org-log-note-state
13383 ""))
13384 (cons "%S" (if org-log-note-previous-state
13388 (push note lines))
13389 (when (or current-prefix-arg org-note-abort)
13390 (when org-log-into-drawer
13391 (org-remove-empty-drawer-at
13392 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13393 org-log-note-marker))
13394 (setq lines nil))
13395 (when lines
13396 (with-current-buffer (marker-buffer org-log-note-marker)
13397 (save-excursion
13398 (goto-char org-log-note-marker)
13399 (move-marker org-log-note-marker nil)
13400 (end-of-line 1)
13402 (setq ind (save-excursion
13403 (if (ignore-errors (goto-char (org-in-item-p)))
13404 (let ((struct (org-list-struct)))
13405 (org-list-get-ind
13406 (org-list-get-top-point struct) struct))
13408 (cond
13409 ((and (org-at-heading-p)
13410 org-adapt-indentation)
13411 (1+ (org-current-level)))
13412 ((org-at-heading-p) 0)
13413 (t (org-get-indentation))))))
13414 (setq bul (org-list-bullet-string "-"))
13415 (org-indent-line-to ind)
13416 (insert bul (pop lines))
13417 (let ((ind-body (+ (length bul) ind)))
13418 (while lines
13420 (org-indent-line-to ind-body)
13421 (insert (pop lines))))
13422 (message "Note stored")
13423 (org-back-to-heading t)
13424 (org-cycle-hide-drawers 'children))
13425 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13426 ;; from within `org-add-log-note' because `buffer-undo-list'
13427 ;; is then modified outside of `org-with-remote-undo'.
13428 (when (eq this-command 'org-agenda-todo)
13429 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13430 ;; Don't add undo information when called from `org-agenda-todo'
13431 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13432 (set-window-configuration org-log-note-window-configuration)
13433 (with-current-buffer (marker-buffer org-log-note-return-to)
13434 (goto-char org-log-note-return-to))
13435 (move-marker org-log-note-return-to nil)
13436 (and org-log-post-message (message "%s" org-log-post-message))))
13438 (defun org-remove-empty-drawer-at (drawer pos)
13439 "Remove an empty drawer DRAWER at position POS.
13440 POS may also be a marker."
13441 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13442 (save-excursion
13443 (save-restriction
13444 (widen)
13445 (goto-char pos)
13446 (if (org-in-regexp
13448 (replace-match ""))))))
13450 (defvar org-ts-type nil)
13451 (defun org-sparse-tree (&optional arg type)
13452 "Create a sparse tree, prompt for the details.
13453 This command can create sparse trees. You first need to select the type
13454 of match used to create the tree:
13456 t Show all TODO entries.
13457 T Show entries with a specific TODO keyword.
13458 m Show entries selected by a tags/property match.
13459 p Enter a property name and its value (both with completion on existing
13460 names/values) and show entries with that property.
13461 r Show entries matching a regular expression (`/' can be used as well).
13462 b Show deadlines and scheduled items before a date.
13463 a Show deadlines and scheduled items after a date.
13464 d Show deadlines due within `org-deadline-warning-days'.
13465 D Show deadlines and scheduled items between a date range."
13466 (interactive "P")
13467 (let (ans kwd value ts-type)
13468 (setq type (or type org-sparse-tree-default-date-type))
13469 (setq org-ts-type type)
13470 (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"
13471 (cond ((eq type 'all) "all timestamps")
13472 ((eq type 'scheduled) "only scheduled")
13473 ((eq type 'deadline) "only deadline")
13474 ((eq type 'active) "only active timestamps")
13475 ((eq type 'inactive) "only inactive timestamps")
13476 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13477 ((eq type 'closed) "with a closed time-stamp")
13478 (t "scheduled/deadline")))
13479 (setq ans (read-char-exclusive))
13480 (cond
13481 ((equal ans ?c)
13482 (org-sparse-tree
13483 arg (cadr (member type '(scheduled-or-deadline
13484 all scheduled deadline active inactive closed)))))
13485 ((equal ans ?d)
13486 (call-interactively 'org-check-deadlines))
13487 ((equal ans ?b)
13488 (call-interactively 'org-check-before-date))
13489 ((equal ans ?a)
13490 (call-interactively 'org-check-after-date))
13491 ((equal ans ?D)
13492 (call-interactively 'org-check-dates-range))
13493 ((equal ans ?t)
13494 (call-interactively 'org-show-todo-tree))
13495 ((equal ans ?T)
13496 (org-show-todo-tree '(4)))
13497 ((member ans '(?T ?m))
13498 (call-interactively 'org-match-sparse-tree))
13499 ((member ans '(?p ?P))
13500 (setq kwd (org-icompleting-read "Property: "
13501 (mapcar 'list (org-buffer-property-keys))))
13502 (setq value (org-icompleting-read "Value: "
13503 (mapcar 'list (org-property-values kwd))))
13506 (org-match-sparse-tree arg (concat kwd "=" value)))
13507 ((member ans '(?r ?R ?/))
13508 (call-interactively 'org-occur))
13511 (defvar org-occur-highlights nil
13512 "List of overlays used for occur matches.")
13513 (make-variable-buffer-local 'org-occur-highlights)
13514 (defvar org-occur-parameters nil
13515 "Parameters of the active org-occur calls.
13516 This is a list, each call to org-occur pushes as cons cell,
13517 containing the regular expression and the callback, onto the list.
13518 The list can contain several entries if `org-occur' has been called
13519 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13520 will only contain one set of parameters. When the highlights are
13521 removed (for example with `C-c C-c', or with the next edit (depending
13522 on `org-remove-highlights-with-change'), this variable is emptied
13523 as well.")
13524 (make-variable-buffer-local 'org-occur-parameters)
13526 (defun org-occur (regexp &optional keep-previous callback)
13527 "Make a compact tree which shows all matches of REGEXP.
13528 The tree will show the lines where the regexp matches, and all higher
13529 headlines above the match. It will also show the heading after the match,
13530 to make sure editing the matching entry is easy.
13531 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13532 call to `org-occur' will be kept, to allow stacking of calls to this
13533 command.
13534 If CALLBACK is non-nil, it is a function which is called to confirm
13535 that the match should indeed be shown."
13537 (when (equal regexp "")
13538 (user-error "Regexp cannot be empty"))
13539 (unless keep-previous
13540 (org-remove-occur-highlights nil nil t))
13541 (push (cons regexp callback) org-occur-parameters)
13542 (let ((cnt 0))
13543 (save-excursion
13544 (goto-char (point-min))
13545 (if (or (not keep-previous) ; do not want to keep
13546 (not org-occur-highlights)) ; no previous matches
13547 ;; hide everything
13548 (org-overview))
13549 (while (re-search-forward regexp nil t)
13550 (when (or (not callback)
13551 (save-match-data (funcall callback)))
13552 (setq cnt (1+ cnt))
13553 (when org-highlight-sparse-tree-matches
13554 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13555 (org-show-context 'occur-tree))))
13556 (when org-remove-highlights-with-change
13557 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13558 nil 'local))
13559 (unless org-sparse-tree-open-archived-trees
13560 (org-hide-archived-subtrees (point-min) (point-max)))
13561 (run-hooks 'org-occur-hook)
13562 (if (org-called-interactively-p 'interactive)
13563 (message "%d match(es) for regexp %s" cnt regexp))
13564 cnt))
13566 (defun org-occur-next-match (&optional n reset)
13567 "Function for `next-error-function' to find sparse tree matches.
13568 N is the number of matches to move, when negative move backwards.
13569 RESET is entirely ignored - this function always goes back to the
13570 starting point when no match is found."
13571 (let* ((limit (if (< n 0) (point-min) (point-max)))
13572 (search-func (if (< n 0)
13573 'previous-single-char-property-change
13574 'next-single-char-property-change))
13575 (n (abs n))
13576 (pos (point))
13577 p1)
13578 (catch 'exit
13579 (while (setq p1 (funcall search-func (point) 'org-type))
13580 (when (equal p1 limit)
13581 (goto-char pos)
13582 (error "No more matches"))
13583 (when (equal (get-char-property p1 'org-type) 'org-occur)
13584 (setq n (1- n))
13585 (when (= n 0)
13586 (goto-char p1)
13587 (throw 'exit (point))))
13588 (goto-char p1))
13589 (goto-char p1)
13590 (error "No more matches"))))
13592 (defun org-show-context (&optional key)
13593 "Make sure point and context are visible.
13594 How much context is shown depends upon the variables
13595 `org-show-hierarchy-above', `org-show-following-heading',
13596 `org-show-entry-below' and `org-show-siblings'."
13597 (let ((heading-p (org-at-heading-p t))
13598 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13599 (following-p (org-get-alist-option org-show-following-heading key))
13600 (entry-p (org-get-alist-option org-show-entry-below key))
13601 (siblings-p (org-get-alist-option org-show-siblings key)))
13602 ;; Show heading or entry text
13603 (if (and heading-p (not entry-p))
13604 (org-flag-heading nil) ; only show the heading
13605 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13606 (org-show-hidden-entry))) ; show entire entry
13607 (when following-p
13608 ;; Show next sibling, or heading below text
13609 (save-excursion
13610 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13611 (org-flag-heading nil))))
13612 (when siblings-p (org-show-siblings))
13613 (when hierarchy-p
13614 ;; show all higher headings, possibly with siblings
13615 (save-excursion
13616 (while (and (condition-case nil
13617 (progn (org-up-heading-all 1) t)
13618 (error nil))
13619 (not (bobp)))
13620 (org-flag-heading nil)
13621 (when siblings-p (org-show-siblings)))))
13622 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13624 (defvar org-reveal-start-hook nil
13625 "Hook run before revealing a location.")
13627 (defun org-reveal (&optional siblings)
13628 "Show current entry, hierarchy above it, and the following headline.
13629 This can be used to show a consistent set of context around locations
13630 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13631 not t for the search context.
13633 With optional argument SIBLINGS, on each level of the hierarchy all
13634 siblings are shown. This repairs the tree structure to what it would
13635 look like when opened with hierarchical calls to `org-cycle'.
13637 go to the parent and show the
13638 entire tree."
13639 (interactive "P")
13640 (run-hooks 'org-reveal-start-hook)
13641 (let ((org-show-hierarchy-above t)
13642 (org-show-following-heading t)
13643 (org-show-siblings (if siblings t org-show-siblings)))
13644 (org-show-context nil))
13645 (when (equal siblings '(16))
13646 (save-excursion
13647 (when (org-up-heading-safe)
13648 (org-show-subtree)
13649 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13651 (defun org-highlight-new-match (beg end)
13652 "Highlight from BEG to END and mark the highlight is an occur headline."
13653 (let ((ov (make-overlay beg end)))
13654 (overlay-put ov 'face 'secondary-selection)
13655 (overlay-put ov 'org-type 'org-occur)
13656 (push ov org-occur-highlights)))
13658 (defun org-remove-occur-highlights (&optional beg end noremove)
13659 "Remove the occur highlights from the buffer.
13660 BEG and END are ignored. If NOREMOVE is nil, remove this function
13661 from the `before-change-functions' in the current buffer."
13662 (interactive)
13663 (unless org-inhibit-highlight-removal
13664 (mapc 'delete-overlay org-occur-highlights)
13665 (setq org-occur-highlights nil)
13666 (setq org-occur-parameters nil)
13667 (unless noremove
13668 (remove-hook 'before-change-functions
13669 'org-remove-occur-highlights 'local))))
13671 ;;;; Priorities
13674 "Regular expression matching the priority indicator.")
13676 (defvar org-remove-priority-next-time nil)
13678 (defun org-priority-up ()
13679 "Increase the priority of the current item."
13680 (interactive)
13681 (org-priority 'up))
13683 (defun org-priority-down ()
13684 "Decrease the priority of the current item."
13685 (interactive)
13686 (org-priority 'down))
13688 (defun org-priority (&optional action show)
13689 "Change the priority of an item.
13690 ACTION can be `set', `up', `down', or a character."
13691 (interactive "P")
13692 (if (equal action '(4))
13693 (org-show-priority)
13694 (unless org-enable-priority-commands
13695 (user-error "Priority commands are disabled"))
13696 (setq action (or action 'set))
13697 (let (current new news have remove)
13698 (save-excursion
13699 (org-back-to-heading t)
13700 (if (looking-at org-priority-regexp)
13701 (setq current (string-to-char (match-string 2))
13702 have t))
13703 (cond
13704 ((eq action 'remove)
13705 (setq remove t new ?\ ))
13706 ((or (eq action 'set)
13707 (if (featurep 'xemacs) (characterp action) (integerp action)))
13708 (if (not (eq action 'set))
13709 (setq new action)
13710 (message "Priority %c-%c, SPC to remove: "
13711 org-highest-priority org-lowest-priority)
13712 (save-match-data
13713 (setq new (read-char-exclusive))))
13714 (if (and (= (upcase org-highest-priority) org-highest-priority)
13715 (= (upcase org-lowest-priority) org-lowest-priority))
13716 (setq new (upcase new)))
13717 (cond ((equal new ?\ ) (setq remove t))
13718 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13719 (user-error "Priority must be between `%c' and `%c'"
13720 org-highest-priority org-lowest-priority))))
13721 ((eq action 'up)
13722 (setq new (if have
13723 (1- current) ; normal cycling
13724 ;; last priority was empty
13725 (if (eq last-command this-command)
13726 org-lowest-priority ; wrap around empty to lowest
13727 ;; default
13728 (if org-priority-start-cycle-with-default
13729 org-default-priority
13730 (1- org-default-priority))))))
13731 ((eq action 'down)
13732 (setq new (if have
13733 (1+ current) ; normal cycling
13734 ;; last priority was empty
13735 (if (eq last-command this-command)
13736 org-highest-priority ; wrap around empty to highest
13737 ;; default
13738 (if org-priority-start-cycle-with-default
13739 org-default-priority
13740 (1+ org-default-priority))))))
13741 (t (user-error "Invalid action")))
13742 (if (or (< (upcase new) org-highest-priority)
13743 (> (upcase new) org-lowest-priority))
13744 (if (and (memq action '(up down))
13745 (not have) (not (eq last-command this-command)))
13746 ;; `new' is from default priority
13747 (error
13748 "The default can not be set, see `org-default-priority' why")
13749 ;; normal cycling: `new' is beyond highest/lowest priority
13750 ;; and is wrapped around to the empty priority
13751 (setq remove t)))
13752 (setq news (format "%c" new))
13753 (if have
13754 (if remove
13755 (replace-match "" t t nil 1)
13756 (replace-match news t t nil 2))
13757 (if remove
13758 (user-error "No priority cookie found in line")
13759 (let ((case-fold-search nil))
13760 (looking-at org-todo-line-regexp))
13761 (if (match-end 2)
13762 (progn
13763 (goto-char (match-end 2))
13764 (insert " [#" news "]"))
13765 (goto-char (match-beginning 3))
13766 (insert "[#" news "] "))))
13767 (org-preserve-lc (org-set-tags nil 'align)))
13768 (if remove
13769 (message "Priority removed")
13770 (message "Priority of current item set to %s" news)))))
13772 (defun org-show-priority ()
13773 "Show the priority of the current item.
13774 This priority is composed of the main priority given with the [#A] cookies,
13775 and by additional input from the age of a schedules or deadline entry."
13776 (interactive)
13777 (let ((pri (if (eq major-mode 'org-agenda-mode)
13778 (org-get-at-bol 'priority)
13779 (save-excursion
13780 (save-match-data
13781 (beginning-of-line)
13782 (and (looking-at org-heading-regexp)
13783 (org-get-priority (match-string 0))))))))
13784 (message "Priority is %d" (if pri pri -1000))))
13786 (defun org-get-priority (s)
13787 "Find priority cookie and return priority."
13788 (save-match-data
13789 (if (functionp org-get-priority-function)
13790 (funcall org-get-priority-function)
13791 (if (not (string-match org-priority-regexp s))
13792 (* 1000 (- org-lowest-priority org-default-priority))
13793 (* 1000 (- org-lowest-priority
13794 (string-to-char (match-string 2 s))))))))
13796 ;;;; Tags
13798 (defvar org-agenda-archives-mode)
13799 (defvar org-map-continue-from nil
13800 "Position from where mapping should continue.
13801 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13803 (defvar org-scanner-tags nil
13804 "The current tag list while the tags scanner is running.")
13805 (defvar org-trust-scanner-tags nil
13806 "Should `org-get-tags-at' use the tags for the scanner.
13807 This is for internal dynamical scoping only.
13808 When this is non-nil, the function `org-get-tags-at' will return the value
13809 of `org-scanner-tags' instead of building the list by itself. This
13810 can lead to large speed-ups when the tags scanner is used in a file with
13811 many entries, and when the list of tags is retrieved, for example to
13812 obtain a list of properties. Building the tags list for each entry in such
13813 a file becomes an N^2 operation - but with this variable set, it scales
13814 as N.")
13816 (defun org-scan-tags (action matcher todo-only &optional start-level)
13817 "Sca headline tags with inheritance and produce output ACTION.
13819 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13820 or `agenda' to produce an entry list for an agenda view. It can also be
13821 a Lisp form or a function that should be called at each matched headline, in
13822 this case the return value is a list of all return values from these calls.
13824 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13825 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13826 only lines with a not-done TODO keyword are included in the output.
13827 This should be the same variable that was scoped into
13828 and set by `org-make-tags-matcher' when it constructed MATCHER.
13830 START-LEVEL can be a string with asterisks, reducing the scope to
13831 headlines matching this string."
13832 (require 'org-agenda)
13833 (let* ((re (concat "^"
13834 (if start-level
13835 ;; Get the correct level to match
13837 org-outline-regexp)
13841 (props (list 'face 'default
13842 'done-face 'org-agenda-done
13843 'undone-face 'default
13844 'mouse-face 'highlight
13845 'org-not-done-regexp org-not-done-regexp
13846 'org-todo-regexp org-todo-regexp
13847 'org-complex-heading-regexp org-complex-heading-regexp
13848 'help-echo
13849 (format "mouse-2 or RET jump to org file %s"
13850 (abbreviate-file-name
13851 (or (buffer-file-name (buffer-base-buffer))
13852 (buffer-name (buffer-base-buffer)))))))
13853 (org-map-continue-from nil)
13854 lspos tags tags-list
13855 (tags-alist (list (cons 0 org-file-tags)))
13856 (llast 0) rtn rtn1 level category i txt
13857 todo marker entry priority)
13858 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13859 (setq action (list 'lambda nil action)))
13860 (save-excursion
13861 (goto-char (point-min))
13862 (when (eq action 'sparse-tree)
13863 (org-overview)
13864 (org-remove-occur-highlights))
13865 (while (let (case-fold-search)
13866 (re-search-forward re nil t))
13867 (setq org-map-continue-from nil)
13868 (catch :skip
13869 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13870 tags (if (match-end 4) (org-match-string-no-properties 4)))
13871 (goto-char (setq lspos (match-beginning 0)))
13872 (setq level (org-reduced-level (org-outline-level))
13873 category (org-get-category))
13874 (setq i llast llast level)
13875 ;; remove tag lists from same and sublevels
13876 (while (>= i level)
13877 (when (setq entry (assoc i tags-alist))
13878 (setq tags-alist (delete entry tags-alist)))
13879 (setq i (1- i)))
13880 ;; add the next tags
13881 (when tags
13882 (setq tags (org-split-string tags ":")
13883 tags-alist
13884 (cons (cons level tags) tags-alist)))
13885 ;; compile tags for current headline
13886 (setq tags-list
13887 (if org-use-tag-inheritance
13888 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13889 tags)
13890 org-scanner-tags tags-list)
13891 (when org-use-tag-inheritance
13892 (setcdr (car tags-alist)
13893 (mapcar (lambda (x)
13894 (setq x (copy-sequence x))
13895 (org-add-prop-inherited x))
13896 (cdar tags-alist))))
13897 (when (and tags org-use-tag-inheritance
13898 (or (not (eq t org-use-tag-inheritance))
13899 org-tags-exclude-from-inheritance))
13900 ;; selective inheritance, remove uninherited ones
13901 (setcdr (car tags-alist)
13902 (org-remove-uninherited-tags (cdar tags-alist))))
13903 (when (and
13905 ;; eval matcher only when the todo condition is OK
13906 (and (or (not todo-only) (member todo org-not-done-keywords))
13907 (let ((case-fold-search t) (org-trust-scanner-tags t))
13908 (eval matcher)))
13910 ;; Call the skipper, but return t if it does not skip,
13911 ;; so that the `and' form continues evaluating
13912 (progn
13913 (unless (eq action 'sparse-tree) (org-agenda-skip))
13914 t)
13916 ;; Check if timestamps are deselecting this entry
13917 (or (not todo-only)
13918 (and (member todo org-not-done-keywords)
13919 (or (not org-agenda-tags-todo-honor-ignore-options)
13920 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13922 ;; select this headline
13923 (cond
13924 ((eq action 'sparse-tree)
13925 (and org-highlight-sparse-tree-matches
13926 (org-get-heading) (match-end 0)
13927 (org-highlight-new-match
13928 (match-beginning 1) (match-end 1)))
13929 (org-show-context 'tags-tree))
13930 ((eq action 'agenda)
13931 (setq txt (org-agenda-format-item
13932 ""
13933 (concat
13934 (if (eq org-tags-match-list-sublevels 'indented)
13935 (make-string (1- level) ?.) "")
13936 (org-get-heading))
13937 level category
13938 tags-list)
13939 priority (org-get-priority txt))
13940 (goto-char lspos)
13941 (setq marker (org-agenda-new-marker))
13942 (org-add-props txt props
13943 'org-marker marker 'org-hd-marker marker 'org-category category
13944 'todo-state todo
13945 'priority priority 'type "tagsmatch")
13946 (push txt rtn))
13947 ((functionp action)
13948 (setq org-map-continue-from nil)
13949 (save-excursion
13950 (setq rtn1 (funcall action))
13951 (push rtn1 rtn)))
13952 (t (user-error "Invalid action")))
13954 ;; if we are to skip sublevels, jump to end of subtree
13955 (unless org-tags-match-list-sublevels
13956 (org-end-of-subtree t)
13957 (backward-char 1))))
13958 ;; Get the correct position from where to continue
13959 (if org-map-continue-from
13960 (goto-char org-map-continue-from)
13961 (and (= (point) lspos) (end-of-line 1)))))
13962 (when (and (eq action 'sparse-tree)
13963 (not org-sparse-tree-open-archived-trees))
13964 (org-hide-archived-subtrees (point-min) (point-max)))
13965 (nreverse rtn)))
13967 (defun org-remove-uninherited-tags (tags)
13968 "Remove all tags that are not inherited from the list TAGS."
13969 (cond
13970 ((eq org-use-tag-inheritance t)
13971 (if org-tags-exclude-from-inheritance
13972 (org-delete-all org-tags-exclude-from-inheritance tags)
13973 tags))
13974 ((not org-use-tag-inheritance) nil)
13975 ((stringp org-use-tag-inheritance)
13976 (delq nil (mapcar
13977 (lambda (x)
13978 (if (and (string-match org-use-tag-inheritance x)
13979 (not (member x org-tags-exclude-from-inheritance)))
13980 x nil))
13981 tags)))
13982 ((listp org-use-tag-inheritance)
13983 (delq nil (mapcar
13984 (lambda (x)
13985 (if (member x org-use-tag-inheritance) x nil))
13986 tags)))))
13988 (defun org-match-sparse-tree (&optional todo-only match)
13989 "Create a sparse tree according to tags string MATCH.
13990 MATCH can contain positive and negative selection of tags, like
13992 If optional argument TODO-ONLY is non-nil, only select lines that are
13993 also TODO lines."
13994 (interactive "P")
13995 (org-agenda-prepare-buffers (list (current-buffer)))
13996 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13998 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14000 (defvar org-cached-props nil)
14001 (defun org-cached-entry-get (pom property)
14002 (if (or (eq t org-use-property-inheritance)
14003 (and (stringp org-use-property-inheritance)
14004 (string-match org-use-property-inheritance property))
14005 (and (listp org-use-property-inheritance)
14006 (member property org-use-property-inheritance)))
14007 ;; Caching is not possible, check it directly
14008 (org-entry-get pom property 'inherit)
14009 ;; Get all properties, so that we can do complicated checks easily
14010 (cdr (assoc property (or org-cached-props
14011 (setq org-cached-props
14012 (org-entry-properties pom)))))))
14014 (defun org-global-tags-completion-table (&optional files)
14015 "Return the list of all tags in all agenda buffer/files.
14016 Optional FILES argument is a list of files which can be used
14017 instead of the agenda files."
14018 (save-excursion
14019 (org-uniquify
14020 (delq nil
14021 (apply 'append
14022 (mapcar
14023 (lambda (file)
14024 (set-buffer (find-file-noselect file))
14025 (append (org-get-buffer-tags)
14026 (mapcar (lambda (x) (if (stringp (car-safe x))
14027 (list (car-safe x)) nil))
14028 org-tag-alist)))
14029 (if (and files (car files))
14030 files
14031 (org-agenda-files))))))))
14033 (defun org-make-tags-matcher (match)
14034 "Create the TAGS/TODO matcher form for the selection string MATCH.
14036 The variable `todo-only' is scoped dynamically into this function.
14037 It will be set to t if the matcher restricts matching to TODO entries,
14038 otherwise will not be touched.
14040 Returns a cons of the selection string MATCH and the constructed
14041 lisp form implementing the matcher. The matcher is to be evaluated
14042 at an Org entry, with point on the headline, and returns t if the
14043 entry matches the selection string MATCH. The returned lisp form
14044 references two variables with information about the entry, which
14045 must be bound around the form's evaluation: todo, the TODO keyword
14046 at the entry (or nil of none); and tags-list, the list of all tags
14047 at the entry including inherited ones. Additionally, the category
14048 of the entry (if any) must be specified as the text property
14049 'org-category on the headline.
14051 See also `org-scan-tags'.
14052 "
14053 (declare (special todo-only))
14054 (unless (boundp 'todo-only)
14055 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14056 (unless match
14057 ;; Get a new match request, with completion against the global
14058 ;; tags table and the local tags in current buffer
14059 (let ((org-last-tags-completion-table
14060 (org-uniquify
14061 (delq nil (append (org-get-buffer-tags)
14062 (org-global-tags-completion-table))))))
14063 (setq match (org-completing-read-no-i
14064 "Match: " 'org-tags-completion-function nil nil nil
14065 'org-tags-history))))
14067 ;; Parse the string and create a lisp form
14068 (let ((match0 match)
14069 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14070 minus tag mm
14071 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14072 orterms term orlist re-p str-p level-p level-op time-p
14073 prop-p pn pv po gv rest (start 0) (ss 0))
14074 ;; Expand group tags
14075 (setq match (org-tags-expand match))
14077 ;; Check if there is a TODO part of this match, which would be the
14078 ;; part after a "/". TO make sure that this slash is not part of
14079 ;; a property value to be matched against, we also check that there
14080 ;; is no " after that slash.
14081 ;; First, find the last slash
14082 (while (string-match "/+" match ss)
14083 (setq start (match-beginning 0) ss (match-end 0)))
14084 (if (and (string-match "/+" match start)
14086 ;; match contains also a todo-matching request
14087 (progn
14088 (setq tagsmatch (substring match 0 (match-beginning 0))
14089 todomatch (substring match (match-end 0)))
14090 (if (string-match "^!" todomatch)
14091 (setq todo-only t todomatch (substring todomatch 1)))
14093 (setq todomatch nil)))
14094 ;; only matching tags
14095 (setq tagsmatch match todomatch nil))
14097 ;; Make the tags matcher
14099 (setq tagsmatcher t)
14100 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14101 (while (setq term (pop orterms))
14103 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14104 (while (string-match re term)
14105 (setq rest (substring term (match-end 0))
14106 minus (and (match-end 1)
14107 (equal (match-string 1 term) "-"))
14108 tag (save-match-data (replace-regexp-in-string
14110 (match-string 2 term)))
14111 re-p (equal (string-to-char tag) ?{)
14112 level-p (match-end 4)
14113 prop-p (match-end 5)
14114 mm (cond
14115 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14116 (level-p
14117 (setq level-op (org-op-to-function (match-string 3 term)))
14118 `(,level-op level ,(string-to-number
14119 (match-string 4 term))))
14120 (prop-p
14121 (setq pn (match-string 5 term)
14122 po (match-string 6 term)
14123 pv (match-string 7 term)
14124 re-p (equal (string-to-char pv) ?{)
14126 time-p (save-match-data
14128 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14129 (if time-p (setq pv (org-matcher-time pv)))
14130 (setq po (org-op-to-function po (if time-p 'time str-p)))
14131 (cond
14132 ((equal pn "CATEGORY")
14133 (setq gv '(get-text-property (point) 'org-category)))
14134 ((equal pn "TODO")
14135 (setq gv 'todo))
14136 (t
14137 (setq gv `(org-cached-entry-get nil ,pn))))
14138 (if re-p
14139 (if (eq po 'org<>)
14140 `(not (string-match ,pv (or ,gv "")))
14141 `(string-match ,pv (or ,gv "")))
14142 (if str-p
14143 `(,po (or ,gv "") ,pv)
14144 `(,po (string-to-number (or ,gv ""))
14145 ,(string-to-number pv) ))))
14146 (t `(member ,tag tags-list)))
14147 mm (if minus (list 'not mm) mm)
14148 term rest)
14149 (push mm tagsmatcher))
14150 (push (if (> (length tagsmatcher) 1)
14151 (cons 'and tagsmatcher)
14152 (car tagsmatcher))
14153 orlist)
14154 (setq tagsmatcher nil))
14155 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14156 (setq tagsmatcher
14157 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14158 ;; Make the todo matcher
14160 (setq todomatcher t)
14161 (setq orterms (org-split-string todomatch "|") orlist nil)
14162 (while (setq term (pop orterms))
14163 (while (string-match re term)
14164 (setq minus (and (match-end 1)
14165 (equal (match-string 1 term) "-"))
14166 kwd (match-string 2 term)
14167 re-p (equal (string-to-char kwd) ?{)
14168 term (substring term (match-end 0))
14169 mm (if re-p
14170 `(string-match ,(substring kwd 1 -1) todo)
14171 (list 'equal 'todo kwd))
14172 mm (if minus (list 'not mm) mm))
14173 (push mm todomatcher))
14174 (push (if (> (length todomatcher) 1)
14175 (cons 'and todomatcher)
14176 (car todomatcher))
14177 orlist)
14178 (setq todomatcher nil))
14179 (setq todomatcher (if (> (length orlist) 1)
14180 (cons 'or orlist) (car orlist))))
14182 ;; Return the string and lisp forms of the matcher
14183 (setq matcher (if todomatcher
14184 (list 'and tagsmatcher todomatcher)
14185 tagsmatcher))
14186 (when todo-only
14187 (setq matcher (list 'and '(member todo org-not-done-keywords)
14188 matcher)))
14189 (cons match0 matcher)))
14191 (defun org-tags-expand (match &optional single-as-list downcased)
14192 "Expand group tags in MATCH.
14194 This replaces every group tag in MATCH with a regexp tag search.
14196 will be replaced like this:
14202 Replacing by a regexp preserves the structure of the match.
14203 E.g., this expansion
14210 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14211 assumed to be a single group tag, and the function will return
14212 the list of tags in this group.
14214 When DOWNCASE is non-nil, expand downcased TAGS."
14215 (if org-group-tags
14216 (let* ((case-fold-search t)
14217 (stable org-mode-syntax-table)
14218 (tal (or org-tag-groups-alist-for-agenda
14219 org-tag-groups-alist))
14220 (tal (if downcased
14221 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14222 (tml (mapcar 'car tal))
14223 (rtnmatch match) rpl)
14224 ;; @ and _ are allowed as word-components in tags
14225 (modify-syntax-entry ?@ "w" stable)
14226 (modify-syntax-entry ?_ "w" stable)
14227 (while (and tml
14228 (with-syntax-table stable
14229 (string-match
14232 (let* ((dir (match-string 1 rtnmatch))
14233 (tag (match-string 2 rtnmatch))
14234 (tag (if downcased (downcase tag) tag)))
14235 (setq tml (delete tag tml))
14236 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14237 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14239 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14240 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14241 (if single-as-list
14242 (or (reverse rpl) (list rtnmatch))
14243 rtnmatch))
14244 (if single-as-list (list (if downcased (downcase match) match))
14245 match)))
14247 (defun org-op-to-function (op &optional stringp)
14248 "Turn an operator into the appropriate function."
14249 (setq op
14250 (cond
14251 ((equal op "<" ) '(< string< org-time<))
14252 ((equal op ">" ) '(> org-string> org-time>))
14253 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14254 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14255 ((member op '("=" "==")) '(= string= org-time=))
14256 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14257 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14259 (defun org<> (a b) (not (= a b)))
14260 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14261 (defun org-string>= (a b) (not (string< a b)))
14262 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14263 (defun org-string<> (a b) (not (string= a b)))
14264 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14265 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14266 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14267 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14268 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14269 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14270 (defun org-2ft (s)
14271 "Convert S to a floating point time.
14272 If S is already a number, just return it. If it is a string, parse
14273 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14274 (cond
14275 ((numberp s) s)
14276 ((stringp s)
14277 (condition-case nil
14278 (float-time (apply 'encode-time (org-parse-time-string s)))
14279 (error 0.)))
14280 (t 0.)))
14282 (defun org-time-today ()
14283 "Time in seconds today at 0:00.
14284 Returns the float number of seconds since the beginning of the
14285 epoch to the beginning of today (00:00)."
14286 (float-time (apply 'encode-time
14287 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14289 (defun org-matcher-time (s)
14290 "Interpret a time comparison value."
14291 (save-match-data
14292 (cond
14293 ((string= s "<now>") (float-time))
14294 ((string= s "<today>") (org-time-today))
14295 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14296 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14298 (+ (org-time-today)
14299 (* (string-to-number (match-string 1 s))
14300 (cdr (assoc (match-string 2 s)
14301 '(("d" . 86400.0) ("w" . 604800.0)
14302 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14303 (t (org-2ft s)))))
14305 (defun org-match-any-p (re list)
14306 "Does re match any element of list?"
14307 (setq list (mapcar (lambda (x) (string-match re x)) list))
14308 (delq nil list))
14310 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14311 (defvar org-tags-overlay (make-overlay 1 1))
14312 (org-detach-overlay org-tags-overlay)
14314 (defun org-get-local-tags-at (&optional pos)
14315 "Get a list of tags defined in the current headline."
14316 (org-get-tags-at pos 'local))
14318 (defun org-get-local-tags ()
14319 "Get a list of tags defined in the current headline."
14320 (org-get-tags-at nil 'local))
14322 (defun org-get-tags-at (&optional pos local)
14323 "Get a list of all headline tags applicable at POS.
14324 POS defaults to point. If tags are inherited, the list contains
14325 the targets in the same sequence as the headlines appear, i.e.
14326 the tags of the current headline come last.
14327 When LOCAL is non-nil, only return tags from the current headline,
14328 ignore inherited ones."
14329 (interactive)
14330 (if (and org-trust-scanner-tags
14331 (or (not pos) (equal pos (point)))
14332 (not local))
14333 org-scanner-tags
14334 (let (tags ltags lastpos parent)
14335 (save-excursion
14336 (save-restriction
14337 (widen)
14338 (goto-char (or pos (point)))
14339 (save-match-data
14340 (catch 'done
14341 (condition-case nil
14342 (progn
14343 (org-back-to-heading t)
14344 (while (not (equal lastpos (point)))
14345 (setq lastpos (point))
14346 (when (looking-at
14348 (setq ltags (org-split-string
14349 (org-match-string-no-properties 1) ":"))
14350 (when parent
14351 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14352 (setq tags (append
14353 (if parent
14354 (org-remove-uninherited-tags ltags)
14355 ltags)
14356 tags)))
14357 (or org-use-tag-inheritance (throw 'done t))
14358 (if local (throw 'done t))
14359 (or (org-up-heading-safe) (error nil))
14360 (setq parent t)))
14361 (error nil)))))
14362 (if local
14363 tags
14364 (reverse (delete-dups
14365 (reverse (append
14366 (org-remove-uninherited-tags
14367 org-file-tags) tags)))))))))
14369 (defun org-add-prop-inherited (s)
14370 (add-text-properties 0 (length s) '(inherited t) s)
14371 s)
14373 (defun org-toggle-tag (tag &optional onoff)
14374 "Toggle the tag TAG for the current line.
14375 If ONOFF is `on' or `off', don't toggle but set to this state."
14376 (let (res current)
14377 (save-excursion
14378 (org-back-to-heading t)
14380 (point-at-eol) t)
14381 (progn
14382 (setq current (match-string 1))
14383 (replace-match ""))
14384 (setq current ""))
14385 (setq current (nreverse (org-split-string current ":")))
14386 (cond
14387 ((eq onoff 'on)
14388 (setq res t)
14389 (or (member tag current) (push tag current)))
14390 ((eq onoff 'off)
14391 (or (not (member tag current)) (setq current (delete tag current))))
14392 (t (if (member tag current)
14393 (setq current (delete tag current))
14394 (setq res t)
14395 (push tag current))))
14396 (end-of-line 1)
14397 (if current
14398 (progn
14399 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14400 (org-set-tags nil t))
14401 (delete-horizontal-space))
14402 (run-hooks 'org-after-tags-change-hook))
14403 res))
14405 (defun org-align-tags-here (to-col)
14406 ;; Assumes that this is a headline
14407 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14408 (beginning-of-line 1)
14410 (< pos (match-beginning 2)))
14411 (progn
14412 (setq tags-l (- (match-end 2) (match-beginning 2)))
14413 (goto-char (match-beginning 1))
14414 (insert " ")
14415 (delete-region (point) (1+ (match-beginning 2)))
14416 (setq ncol (max (current-column)
14417 (1+ col)
14418 (if (> to-col 0)
14419 to-col
14420 (- (abs to-col) tags-l))))
14421 (setq p (point))
14422 (insert (make-string (- ncol (current-column)) ?\ ))
14423 (setq ncol (current-column))
14424 (when indent-tabs-mode (tabify p (point-at-eol)))
14425 (org-move-to-column (min ncol col) t nil t))
14426 (goto-char pos))))
14428 (defun org-set-tags-command (&optional arg just-align)
14429 "Call the set-tags command for the current entry."
14430 (interactive "P")
14431 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14432 (org-set-tags arg just-align)
14433 (save-excursion
14434 (unless (and (org-region-active-p)
14435 org-loop-over-headlines-in-active-region)
14436 (org-back-to-heading t))
14437 (org-set-tags arg just-align))))
14439 (defun org-set-tags-to (data)
14440 "Set the tags of the current entry to DATA, replacing the current tags.
14441 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14442 If DATA is nil or the empty string, any tags will be removed."
14443 (interactive "sTags: ")
14444 (setq data
14445 (cond
14446 ((eq data nil) "")
14447 ((equal data "") "")
14448 ((stringp data)
14449 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14450 ":"))
14451 ((listp data)
14452 (concat ":" (mapconcat 'identity data ":") ":"))))
14453 (when data
14454 (save-excursion
14455 (org-back-to-heading t)
14456 (when (looking-at org-complex-heading-regexp)
14457 (if (match-end 5)
14458 (progn
14459 (goto-char (match-beginning 5))
14460 (insert data)
14461 (delete-region (point) (point-at-eol))
14462 (org-set-tags nil 'align))
14463 (goto-char (point-at-eol))
14464 (insert " " data)
14465 (org-set-tags nil 'align)))
14466 (beginning-of-line 1)
14468 (delete-region (match-beginning 1) (match-end 1))))))
14470 (defun org-align-all-tags ()
14471 "Align the tags i all headings."
14472 (interactive)
14473 (save-excursion
14474 (or (ignore-errors (org-back-to-heading t))
14475 (outline-next-heading))
14476 (if (org-at-heading-p)
14477 (org-set-tags t)
14478 (message "No headings"))))
14480 (defvar org-indent-indentation-per-level)
14481 (defun org-set-tags (&optional arg just-align)
14482 "Set the tags for the current headline.
14483 With prefix ARG, realign all tags in headings in the current buffer."
14484 (interactive "P")
14485 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14486 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14487 'region-start-level 'region))
14488 org-loop-over-headlines-in-active-region)
14489 (org-map-entries
14490 ;; We don't use ARG and JUST-ALIGN here these args are not
14491 ;; useful when looping over headlines
14492 `(org-set-tags)
14493 org-loop-over-headlines-in-active-region
14494 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14495 (let* ((re org-outline-regexp-bol)
14496 (current (unless arg (org-get-tags-string)))
14497 (col (current-column))
14498 (org-setting-tags t)
14499 table current-tags inherited-tags ; computed below when needed
14500 tags p0 c0 c1 rpl di tc level)
14501 (if arg
14502 (save-excursion
14503 (goto-char (point-min))
14504 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14505 (while (re-search-forward re nil t)
14506 (org-set-tags nil t)
14507 (end-of-line 1)))
14508 (message "All tags realigned to column %d" org-tags-column))
14509 (if just-align
14510 (setq tags current)
14511 ;; Get a new set of tags from the user
14512 (save-excursion
14513 (setq table (append org-tag-persistent-alist
14514 (or org-tag-alist (org-get-buffer-tags))
14515 (and
14516 org-complete-tags-always-offer-all-agenda-tags
14517 (org-global-tags-completion-table
14518 (org-agenda-files))))
14519 org-last-tags-completion-table table
14520 current-tags (org-split-string current ":")
14521 inherited-tags (nreverse
14522 (nthcdr (length current-tags)
14523 (nreverse (org-get-tags-at))))
14524 tags
14525 (if (or (eq t org-use-fast-tag-selection)
14526 (and org-use-fast-tag-selection
14527 (delq nil (mapcar 'cdr table))))
14528 (org-fast-tag-selection
14529 current-tags inherited-tags table
14530 (if org-fast-tag-selection-include-todo
14531 org-todo-key-alist))
14532 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14533 (org-trim
14534 (org-icompleting-read "Tags: "
14535 'org-tags-completion-function
14536 nil nil current 'org-tags-history))))))
14537 (while (string-match "[-+&]+" tags)
14538 ;; No boolean logic, just a list
14539 (setq tags (replace-match ":" t t tags))))
14541 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14543 (if org-tags-sort-function
14544 (setq tags (mapconcat 'identity
14545 (sort (org-split-string
14546 tags (org-re "[^[:alnum:]_@#%]+"))
14547 org-tags-sort-function) ":")))
14550 (setq tags "")
14551 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14552 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14554 ;; Insert new tags at the correct column
14555 (beginning-of-line 1)
14556 (setq level (or (and (looking-at org-outline-regexp)
14557 (- (match-end 0) (point) 1))
14558 1))
14559 (cond
14560 ((and (equal current "") (equal tags "")))
14561 ((re-search-forward
14563 (point-at-eol) t)
14564 (if (equal tags "")
14565 (setq rpl "")
14566 (goto-char (match-beginning 0))
14567 (setq c0 (current-column)
14568 ;; compute offset for the case of org-indent-mode active
14569 di (if org-indent-mode
14570 (* (1- org-indent-indentation-per-level) (1- level))
14571 0)
14572 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14573 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14574 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14575 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14576 (replace-match rpl t t)
14577 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14578 tags)
14579 (t (error "Tags alignment failed")))
14580 (org-move-to-column col)
14581 (unless just-align
14582 (run-hooks 'org-after-tags-change-hook))))))
14584 (defun org-change-tag-in-region (beg end tag off)
14585 "Add or remove TAG for each entry in the region.
14586 This works in the agenda, and also in an org-mode buffer."
14587 (interactive
14588 (list (region-beginning) (region-end)
14589 (let ((org-last-tags-completion-table
14590 (if (derived-mode-p 'org-mode)
14591 (org-uniquify
14592 (delq nil (append (org-get-buffer-tags)
14593 (org-global-tags-completion-table))))
14594 (org-global-tags-completion-table))))
14595 (org-icompleting-read
14596 "Tag: " 'org-tags-completion-function nil nil nil
14597 'org-tags-history))
14598 (progn
14600 (equal (read-char-exclusive) ?r))))
14601 (if (fboundp 'deactivate-mark) (deactivate-mark))
14602 (let ((agendap (equal major-mode 'org-agenda-mode))
14603 l1 l2 m buf pos newhead (cnt 0))
14604 (goto-char end)
14605 (setq l2 (1- (org-current-line)))
14606 (goto-char beg)
14607 (setq l1 (org-current-line))
14608 (loop for l from l1 to l2 do
14609 (org-goto-line l)
14610 (setq m (get-text-property (point) 'org-hd-marker))
14611 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14612 (and agendap m))
14613 (setq buf (if agendap (marker-buffer m) (current-buffer))
14614 pos (if agendap m (point)))
14615 (with-current-buffer buf
14616 (save-excursion
14617 (save-restriction
14618 (goto-char pos)
14619 (setq cnt (1+ cnt))
14620 (org-toggle-tag tag (if off 'off 'on))
14621 (setq newhead (org-get-heading)))))
14622 (and agendap (org-agenda-change-all-lines newhead m))))
14623 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14625 (defun org-tags-completion-function (string predicate &optional flag)
14626 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14627 (confirm (lambda (x) (stringp (car x)))))
14629 (setq s1 (match-string 1 string)
14630 s2 (match-string 2 string))
14631 (setq s1 "" s2 string))
14632 (cond
14633 ((eq flag nil)
14634 ;; try completion
14635 (setq rtn (try-completion s2 ctable confirm))
14636 (if (stringp rtn)
14637 (setq rtn
14638 (concat s1 s2 (substring rtn (length s2))
14639 (if (and org-add-colon-after-tag-completion
14640 (assoc rtn ctable))
14641 ":" ""))))
14642 rtn)
14643 ((eq flag t)
14644 ;; all-completions
14645 (all-completions s2 ctable confirm))
14646 ((eq flag 'lambda)
14647 ;; exact match?
14648 (assoc s2 ctable)))))
14650 (defun org-fast-tag-insert (kwd tags face &optional end)
14651 "Insert KDW, and the TAGS, the latter with face FACE.
14652 Also insert END."
14653 (insert (format "%-12s" (concat kwd ":"))
14654 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14655 (or end "")))
14657 (defun org-fast-tag-show-exit (flag)
14658 (save-excursion
14659 (org-goto-line 3)
14661 (replace-match ""))
14662 (when flag
14663 (end-of-line 1)
14664 (org-move-to-column (- (window-width) 19) t)
14665 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14667 (defun org-set-current-tags-overlay (current prefix)
14668 "Add an overlay to CURRENT tag with PREFIX."
14669 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14670 (if (featurep 'xemacs)
14671 (org-overlay-display org-tags-overlay (concat prefix s)
14672 'secondary-selection)
14673 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14674 (org-overlay-display org-tags-overlay (concat prefix s)))))
14676 (defvar org-last-tag-selection-key nil)
14677 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14678 "Fast tag selection with single keys.
14679 CURRENT is the current list of tags in the headline, INHERITED is the
14680 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14681 possibly with grouping information. TODO-TABLE is a similar table with
14682 TODO keywords, should these have keys assigned to them.
14683 If the keys are nil, a-z are automatically assigned.
14684 Returns the new tags string, or nil to not change the current settings."
14685 (let* ((fulltable (append table todo-table))
14686 (maxlen (apply 'max (mapcar
14687 (lambda (x)
14688 (if (stringp (car x)) (string-width (car x)) 0))
14689 fulltable)))
14690 (buf (current-buffer))
14691 (expert (eq org-fast-tag-selection-single-key 'expert))
14692 (buffer-tags nil)
14693 (fwidth (+ maxlen 3 1 3))
14694 (ncol (/ (- (window-width) 4) fwidth))
14695 (i-face 'org-done)
14696 (c-face 'org-todo)
14697 tg cnt e c char c1 c2 ntable tbl rtn
14698 ov-start ov-end ov-prefix
14699 (exit-after-next org-fast-tag-selection-single-key)
14700 (done-keywords org-done-keywords)
14701 groups ingroup)
14702 (save-excursion
14703 (beginning-of-line 1)
14704 (if (looking-at
14706 (setq ov-start (match-beginning 1)
14707 ov-end (match-end 1)
14708 ov-prefix "")
14709 (setq ov-start (1- (point-at-eol))
14710 ov-end (1+ ov-start))
14712 (setq ov-prefix
14713 (concat
14714 (buffer-substring (1- (point)) (point))
14715 (if (> (current-column) org-tags-column)
14716 " "
14717 (make-string (- org-tags-column (current-column)) ?\ ))))))
14718 (move-overlay org-tags-overlay ov-start ov-end)
14719 (save-window-excursion
14720 (if expert
14721 (set-buffer (get-buffer-create " *Org tags*"))
14722 (delete-other-windows)
14723 (split-window-vertically)
14724 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14725 (erase-buffer)
14726 (org-set-local 'org-done-keywords done-keywords)
14729 (org-fast-tag-show-exit exit-after-next)
14730 (org-set-current-tags-overlay current ov-prefix)
14731 (setq tbl fulltable char ?a cnt 0)
14732 (while (setq e (pop tbl))
14733 (cond
14734 ((equal (car e) :startgroup)
14735 (push '() groups) (setq ingroup t)
14736 (when (not (= cnt 0))
14737 (setq cnt 0)
14739 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14740 ((equal (car e) :endgroup)
14741 (setq ingroup nil cnt 0)
14743 ((equal e '(:newline))
14744 (when (not (= cnt 0))
14745 (setq cnt 0)
14747 (setq e (car tbl))
14748 (while (equal (car tbl) '(:newline))
14750 (setq tbl (cdr tbl)))))
14751 ((equal e '(:grouptags)) nil)
14752 (t
14753 (setq tg (copy-sequence (car e)) c2 nil)
14754 (if (cdr e)
14755 (setq c (cdr e))
14756 ;; automatically assign a character.
14757 (setq c1 (string-to-char
14758 (downcase (substring
14759 tg (if (= (string-to-char tg) ?@) 1 0)))))
14760 (if (or (rassoc c1 ntable) (rassoc c1 table))
14761 (while (or (rassoc char ntable) (rassoc char table))
14762 (setq char (1+ char)))
14763 (setq c2 c1))
14764 (setq c (or c2 char)))
14765 (if ingroup (push tg (car groups)))
14766 (setq tg (org-add-props tg nil 'face
14767 (cond
14768 ((not (assoc tg table))
14769 (org-get-todo-face tg))
14770 ((member tg current) c-face)
14771 ((member tg inherited) i-face))))
14772 (if (equal (caar tbl) :grouptags)
14773 (org-add-props tg nil 'face 'org-tag-group))
14774 (if (and (= cnt 0) (not ingroup)) (insert " "))
14775 (insert "[" c "] " tg (make-string
14776 (- fwidth 4 (length tg)) ?\ ))
14777 (push (cons tg c) ntable)
14778 (when (= (setq cnt (1+ cnt)) ncol)
14780 (if ingroup (insert " "))
14781 (setq cnt 0)))))
14782 (setq ntable (nreverse ntable))
14784 (goto-char (point-min))
14785 (if (not expert) (org-fit-window-to-buffer))
14786 (setq rtn
14787 (catch 'exit
14788 (while t
14789 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14790 (if (not groups) "no " "")
14791 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14792 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14793 (setq org-last-tag-selection-key c)
14794 (cond
14796 ((= c ?!)
14797 (setq groups (not groups))
14798 (goto-char (point-min))
14799 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14800 ((= c ?\C-c)
14801 (if (not expert)
14802 (org-fast-tag-show-exit
14803 (setq exit-after-next (not exit-after-next)))
14804 (setq expert nil)
14805 (delete-other-windows)
14806 (set-window-buffer (split-window-vertically) " *Org tags*")
14807 (org-switch-to-buffer-other-window " *Org tags*")
14808 (org-fit-window-to-buffer)))
14809 ((or (= c ?\C-g)
14810 (and (= c ?q) (not (rassoc c ntable))))
14811 (org-detach-overlay org-tags-overlay)
14812 (setq quit-flag t))
14813 ((= c ?\ )
14814 (setq current nil)
14815 (if exit-after-next (setq exit-after-next 'now)))
14817 (condition-case nil
14818 (setq tg (org-icompleting-read
14819 "Tag: "
14820 (or buffer-tags
14821 (with-current-buffer buf
14822 (org-get-buffer-tags)))))
14823 (quit (setq tg "")))
14825 (add-to-list 'buffer-tags (list tg))
14826 (if (member tg current)
14827 (setq current (delete tg current))
14828 (push tg current)))
14829 (if exit-after-next (setq exit-after-next 'now)))
14830 ((setq e (rassoc c todo-table) tg (car e))
14831 (with-current-buffer buf
14832 (save-excursion (org-todo tg)))
14833 (if exit-after-next (setq exit-after-next 'now)))
14834 ((setq e (rassoc c ntable) tg (car e))
14835 (if (member tg current)
14836 (setq current (delete tg current))
14837 (loop for g in groups do
14838 (if (member tg g)
14839 (mapc (lambda (x)
14840 (setq current (delete x current)))
14841 g)))
14842 (push tg current))
14843 (if exit-after-next (setq exit-after-next 'now))))
14845 ;; Create a sorted list
14846 (setq current
14847 (sort current
14848 (lambda (a b)
14849 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14850 (if (eq exit-after-next 'now) (throw 'exit t))
14851 (goto-char (point-min))
14852 (beginning-of-line 2)
14853 (delete-region (point) (point-at-eol))
14854 (org-fast-tag-insert "Current" current c-face)
14855 (org-set-current-tags-overlay current ov-prefix)
14856 (while (re-search-forward
14858 (setq tg (match-string 1))
14859 (add-text-properties
14860 (match-beginning 1) (match-end 1)
14861 (list 'face
14862 (cond
14863 ((member tg current) c-face)
14864 ((member tg inherited) i-face)
14865 (t (get-text-property (match-beginning 1) 'face))))))
14866 (goto-char (point-min)))))
14867 (org-detach-overlay org-tags-overlay)
14868 (if rtn
14869 (mapconcat 'identity current ":")
14870 nil))))
14872 (defun org-get-tags-string ()
14873 "Get the TAGS string in the current headline."
14874 (unless (org-at-heading-p t)
14875 (user-error "Not on a heading"))
14876 (save-excursion
14877 (beginning-of-line 1)
14879 (org-match-string-no-properties 1)
14880 "")))
14882 (defun org-get-tags ()
14883 "Get the list of tags specified in the current headline."
14884 (org-split-string (org-get-tags-string) ":"))
14886 (defun org-get-buffer-tags ()
14887 "Get a table of all tags used in the buffer, for completion."
14888 (let (tags)
14889 (save-excursion
14890 (goto-char (point-min))
14891 (while (re-search-forward
14893 (when (equal (char-after (point-at-bol 0)) ?*)
14894 (mapc (lambda (x) (add-to-list 'tags x))
14895 (org-split-string (org-match-string-no-properties 1) ":")))))
14896 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14897 (mapcar 'list tags)))
14899 ;;;; The mapping API
14901 (defun org-map-entries (func &optional match scope &rest skip)
14902 "Call FUNC at each headline selected by MATCH in SCOPE.
14904 FUNC is a function or a lisp form. The function will be called without
14905 arguments, with the cursor positioned at the beginning of the headline.
14906 The return values of all calls to the function will be collected and
14907 returned as a list.
14909 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14910 does not need to preserve point. After evaluation, the cursor will be
14911 moved to the end of the line (presumably of the headline of the
14912 processed entry) and search continues from there. Under some
14913 circumstances, this may not produce the wanted results. For example,
14914 if you have removed (e.g. archived) the current (sub)tree it could
14915 mean that the next entry will be skipped entirely. In such cases, you
14916 can specify the position from where search should continue by making
14917 FUNC set the variable `org-map-continue-from' to the desired buffer
14918 position.
14920 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14921 Only headlines that are matched by this query will be considered during
14922 the iteration. When MATCH is nil or t, all headlines will be
14923 visited by the iteration.
14925 SCOPE determines the scope of this command. It can be any of:
14927 nil The current buffer, respecting the restriction if any
14928 tree The subtree started with the entry at point
14929 region The entries within the active region, if any
14930 region-start-level
14931 The entries within the active region, but only those at
14932 the same level than the first one.
14933 file The current buffer, without restriction
14934 file-with-archives
14935 The current buffer, and any archives associated with it
14936 agenda All agenda files
14937 agenda-with-archives
14938 All agenda files with any archive files associated with them
14939 \(file1 file2 ...)
14940 If this is a list, all files in the list will be scanned
14942 The remaining args are treated as settings for the skipping facilities of
14943 the scanner. The following items can be given here:
14945 archive skip trees with the archive tag
14946 comment skip trees with the COMMENT keyword
14947 function or Emacs Lisp form:
14948 will be used as value for `org-agenda-skip-function', so
14949 whenever the function returns a position, FUNC will not be
14950 called for that entry and search will continue from the
14951 position returned
14953 If your function needs to retrieve the tags including inherited tags
14954 at the *current* entry, you can use the value of the variable
14955 `org-scanner-tags' which will be much faster than getting the value
14956 with `org-get-tags-at'. If your function gets properties with
14957 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14958 to t around the call to `org-entry-properties' to get the same speedup.
14959 Note that if your function moves around to retrieve tags and properties at
14960 a *different* entry, you cannot use these techniques."
14961 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14962 (not (org-region-active-p)))
14963 (let* ((org-agenda-archives-mode nil) ; just to make sure
14964 (org-agenda-skip-archived-trees (memq 'archive skip))
14965 (org-agenda-skip-comment-trees (memq 'comment skip))
14966 (org-agenda-skip-function
14967 (car (org-delete-all '(comment archive) skip)))
14968 (org-tags-match-list-sublevels t)
14969 (start-level (eq scope 'region-start-level))
14970 matcher file res
14971 org-todo-keywords-for-agenda
14972 org-done-keywords-for-agenda
14973 org-todo-keyword-alist-for-agenda
14974 org-drawers-for-agenda
14975 org-tag-alist-for-agenda
14976 todo-only)
14978 (cond
14979 ((eq match t) (setq matcher t))
14980 ((eq match nil) (setq matcher t))
14981 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14983 (save-window-excursion
14984 (save-restriction
14985 (cond ((eq scope 'tree)
14986 (org-back-to-heading t)
14987 (org-narrow-to-subtree)
14988 (setq scope nil))
14989 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14990 (org-region-active-p))
14991 ;; If needed, set start-level to a string like "2"
14992 (when start-level
14993 (save-excursion
14994 (goto-char (region-beginning))
14995 (unless (org-at-heading-p) (outline-next-heading))
14996 (setq start-level (org-current-level))))
14997 (narrow-to-region (region-beginning)
14998 (save-excursion
14999 (goto-char (region-end))
15000 (unless (and (bolp) (org-at-heading-p))
15001 (outline-next-heading))
15002 (point)))
15003 (setq scope nil)))
15005 (if (not scope)
15006 (progn
15007 (org-agenda-prepare-buffers
15008 (list (buffer-file-name (current-buffer))))
15009 (setq res (org-scan-tags func matcher todo-only start-level)))
15010 ;; Get the right scope
15011 (cond
15012 ((and scope (listp scope) (symbolp (car scope)))
15013 (setq scope (eval scope)))
15014 ((eq scope 'agenda)
15015 (setq scope (org-agenda-files t)))
15016 ((eq scope 'agenda-with-archives)
15017 (setq scope (org-agenda-files t))
15018 (setq scope (org-add-archive-files scope)))
15019 ((eq scope 'file)
15020 (setq scope (list (buffer-file-name))))
15021 ((eq scope 'file-with-archives)
15022 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15023 (org-agenda-prepare-buffers scope)
15024 (while (setq file (pop scope))
15025 (with-current-buffer (org-find-base-buffer-visiting file)
15026 (save-excursion
15027 (save-restriction
15028 (widen)
15029 (goto-char (point-min))
15030 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15031 res)))
15033 ;;;; Properties
15035 ;;; Setting and retrieving properties
15037 (defconst org-special-properties
15038 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15039 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15040 "The special properties valid in Org-mode.
15042 These are properties that are not defined in the property drawer,
15043 but in some other way.")
15045 (defconst org-default-properties
15046 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15047 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15048 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15049 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15050 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15051 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15052 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15053 "Some properties that are used by Org-mode for various purposes.
15054 Being in this list makes sure that they are offered for completion.")
15057 "Regular expression matching the first line of a property drawer.")
15060 "Regular expression matching the last line of a property drawer.")
15063 "Regular expression matching the first line of a property drawer.")
15066 "Regular expression matching the first line of a property drawer.")
15068 (defconst org-property-drawer-re
15071 "Matches an entire property drawer.")
15073 (defconst org-clock-drawer-re
15076 "Matches an entire clock drawer.")
15078 (defun org-property-action ()
15079 "Do an action on properties."
15080 (interactive)
15081 (let (c)
15082 (org-at-property-p)
15083 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15084 (setq c (read-char-exclusive))
15085 (cond
15086 ((equal c ?s)
15087 (call-interactively 'org-set-property))
15088 ((equal c ?d)
15089 (call-interactively 'org-delete-property))
15090 ((equal c ?D)
15091 (call-interactively 'org-delete-property-globally))
15092 ((equal c ?c)
15093 (call-interactively 'org-compute-property-at-point))
15094 (t (user-error "No such property action %c" c)))))
15096 (defun org-inc-effort ()
15097 "Increment the value of the effort property in the current entry."
15098 (interactive)
15099 (org-set-effort nil t))
15101 (defvar org-clock-effort) ;; Defined in org-clock.el
15102 (defvar org-clock-current-task) ;; Defined in org-clock.el
15103 (defun org-set-effort (&optional value increment)
15104 "Set the effort property of the current entry.
15105 With numerical prefix arg, use the nth allowed value, 0 stands for the
15106 10th allowed value.
15108 When INCREMENT is non-nil, set the property to the next allowed value."
15109 (interactive "P")
15110 (if (equal value 0) (setq value 10))
15111 (let* ((completion-ignore-case t)
15112 (prop org-effort-property)
15113 (cur (org-entry-get nil prop))
15114 (allowed (org-property-get-allowed-values nil prop 'table))
15115 (existing (mapcar 'list (org-property-values prop)))
15116 (heading (nth 4 (org-heading-components)))
15117 rpl
15118 (val (cond
15119 ((stringp value) value)
15120 ((and allowed (integerp value))
15121 (or (car (nth (1- value) allowed))
15122 (car (org-last allowed))))
15123 ((and allowed increment)
15124 (or (caadr (member (list cur) allowed))
15125 (user-error "Allowed effort values are not set")))
15126 (allowed
15127 (message "Select 1-9,0, [RET%s]: %s"
15128 (if cur (concat "=" cur) "")
15129 (mapconcat 'car allowed " "))
15130 (setq rpl (read-char-exclusive))
15132 cur
15133 (setq rpl (- rpl ?0))
15134 (if (equal rpl 0) (setq rpl 10))
15135 (if (and (> rpl 0) (<= rpl (length allowed)))
15136 (car (nth (1- rpl) allowed))
15137 (org-completing-read "Effort: " allowed nil))))
15138 (t
15139 (let (org-completion-use-ido org-completion-use-iswitchb)
15140 (org-completing-read
15142 (concat "[" cur "]") "")
15143 ": ")
15144 existing nil nil "" nil cur))))))
15145 (unless (equal (org-entry-get nil prop) val)
15146 (org-entry-put nil prop val))
15147 (save-excursion
15148 (org-back-to-heading t)
15149 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15150 (when (string= heading org-clock-current-task)
15151 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15152 (org-clock-update-mode-line))
15153 (message "%s is now %s" prop val)))
15155 (defun org-at-property-p ()
15156 "Is cursor inside a property drawer?"
15157 (save-excursion
15158 (when (equal 'node-property (car (org-element-at-point)))
15159 (beginning-of-line 1)
15160 (looking-at org-property-re))))
15162 (defun org-get-property-block (&optional beg end force)
15163 "Return the (beg . end) range of the body of the property drawer.
15164 BEG and END are the beginning and end of the current subtree, or of
15165 the part before the first headline. If they are not given, they will
15166 be found. If the drawer does not exist and FORCE is non-nil, create
15167 the drawer."
15168 (catch 'exit
15169 (save-excursion
15170 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15171 (progn (org-back-to-heading t) (point))))
15172 (end (or end (and (not (outline-next-heading)) (point-max))
15173 (point))))
15174 (goto-char beg)
15175 (if (re-search-forward org-property-start-re end t)
15176 (setq beg (1+ (match-end 0)))
15177 (if force
15178 (save-excursion
15179 (org-insert-property-drawer)
15180 (setq end (progn (outline-next-heading) (point))))
15181 (throw 'exit nil))
15182 (goto-char beg)
15183 (if (re-search-forward org-property-start-re end t)
15184 (setq beg (1+ (match-end 0)))))
15185 (if (re-search-forward org-property-end-re end t)
15186 (setq end (match-beginning 0))
15187 (or force (throw 'exit nil))
15188 (goto-char beg)
15189 (setq end beg)
15190 (org-indent-line)
15192 (cons beg end)))))
15194 (defun org-entry-properties (&optional pom which specific)
15195 "Get all properties of the entry at point-or-marker POM.
15196 This includes the TODO keyword, the tags, time strings for deadline,
15197 scheduled, and clocking, and any additional properties defined in the
15198 entry. The return value is an alist, keys may occur multiple times
15199 if the property key was used several times.
15200 POM may also be nil, in which case the current entry is used.
15201 If WHICH is nil or `all', get all properties. If WHICH is
15202 `special' or `standard', only get that subclass. If WHICH
15203 is a string only get exactly this property. SPECIFIC can be a string, the
15204 specific property we are interested in. Specifying it can speed
15205 things up because then unnecessary parsing is avoided."
15206 (setq which (or which 'all))
15207 (org-with-point-at pom
15208 (let ((clockstr (substring org-clock-string 0 -1))
15209 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15210 (case-fold-search nil)
15211 beg end range props sum-props key key1 value string clocksum clocksumt)
15212 (save-excursion
15213 (when (condition-case nil
15214 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15215 (error nil))
15216 (setq beg (point))
15217 (setq sum-props (get-text-property (point) 'org-summaries))
15218 (setq clocksum (get-text-property (point) :org-clock-minutes)
15219 clocksumt (get-text-property (point) :org-clock-minutes-today))
15220 (outline-next-heading)
15221 (setq end (point))
15222 (when (memq which '(all special))
15223 ;; Get the special properties, like TODO and tags
15224 (goto-char beg)
15225 (when (and (or (not specific) (string= specific "TODO"))
15226 (looking-at org-todo-line-regexp) (match-end 2))
15227 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15228 (when (and (or (not specific) (string= specific "PRIORITY"))
15229 (looking-at org-priority-regexp))
15230 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15231 (when (or (not specific) (string= specific "FILE"))
15232 (push (cons "FILE" buffer-file-name) props))
15233 (when (and (or (not specific) (string= specific "TAGS"))
15234 (setq value (org-get-tags-string))
15236 (push (cons "TAGS" value) props))
15237 (when (and (or (not specific) (string= specific "ALLTAGS"))
15238 (setq value (org-get-tags-at)))
15239 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15240 ":"))
15241 props))
15242 (when (or (not specific) (string= specific "BLOCKED"))
15243 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15244 (when (or (not specific)
15245 (member specific
15246 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15247 "TIMESTAMP" "TIMESTAMP_IA")))
15248 (catch 'match
15249 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15250 (setq key (if (match-end 1)
15251 (substring (org-match-string-no-properties 1)
15252 0 -1))
15253 string (if (equal key clockstr)
15254 (org-trim
15255 (buffer-substring-no-properties
15256 (match-beginning 3) (goto-char
15257 (point-at-eol))))
15258 (substring (org-match-string-no-properties 3)
15259 1 -1)))
15260 ;; Get the correct property name from the key. This is
15261 ;; necessary if the user has configured time keywords.
15262 (setq key1 (concat key ":"))
15263 (cond
15264 ((not key)
15265 (setq key
15266 (if (= (char-after (match-beginning 3)) ?\[)
15267 "TIMESTAMP_IA" "TIMESTAMP")))
15268 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15269 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15270 ((equal key1 org-closed-string) (setq key "CLOSED"))
15271 ((equal key1 org-clock-string) (setq key "CLOCK")))
15272 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15273 (progn
15274 (push (cons key string) props)
15275 ;; no need to search further if match is found
15276 (throw 'match t))
15277 (when (or (equal key "CLOCK") (not (assoc key props)))
15278 (push (cons key string) props)))))))
15280 (when (memq which '(all standard))
15281 ;; Get the standard properties, like :PROP: ...
15282 (setq range (org-get-property-block beg end))
15283 (when range
15284 (goto-char (car range))
15285 (while (re-search-forward org-property-re
15286 (cdr range) t)
15287 (setq key (org-match-string-no-properties 2)
15288 value (org-trim (or (org-match-string-no-properties 3) "")))
15289 (unless (member key excluded)
15290 (push (cons key (or value "")) props)))))
15291 (if clocksum
15292 (push (cons "CLOCKSUM"
15293 (org-columns-number-to-string (/ (float clocksum) 60.)
15294 'add_times))
15295 props))
15296 (if clocksumt
15297 (push (cons "CLOCKSUM_T"
15298 (org-columns-number-to-string (/ (float clocksumt) 60.)
15299 'add_times))
15300 props))
15301 (unless (assoc "CATEGORY" props)
15302 (push (cons "CATEGORY" (org-get-category)) props))
15303 (append sum-props (nreverse props)))))))
15305 (defun org-entry-get (pom property &optional inherit literal-nil)
15306 "Get value of PROPERTY for entry or content at point-or-marker POM.
15307 If INHERIT is non-nil and the entry does not have the property,
15308 then also check higher levels of the hierarchy.
15309 If INHERIT is the symbol `selective', use inheritance only if the setting
15310 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15311 If the property is present but empty, the return value is the empty string.
15312 If the property is not present at all, nil is returned.
15315 do not interpret it as the list atom nil. This is used for inheritance
15317 (org-with-point-at pom
15318 (if (and inherit (if (eq inherit 'selective)
15319 (org-property-inherit-p property)
15320 t))
15321 (org-entry-get-with-inheritance property literal-nil)
15322 (if (member property org-special-properties)
15323 ;; We need a special property. Use `org-entry-properties' to
15324 ;; retrieve it, but specify the wanted property
15325 (cdr (assoc property (org-entry-properties nil 'special property)))
15326 (let ((range (org-get-property-block)))
15327 (when (and range (not (eq (car range) (cdr range))))
15328 (let* ((props (list (or (assoc property org-file-properties)
15329 (assoc property org-global-properties)
15330 (assoc property org-global-properties-fixed))))
15331 (ap (lambda (key)
15332 (when (re-search-forward
15333 (org-re-property key) (cdr range) t)
15334 (setq props
15335 (org-update-property-plist
15336 key
15337 (if (match-end 3)
15338 (org-match-string-no-properties 3) "")
15339 props)))))
15340 val)
15341 (goto-char (car range))
15342 (funcall ap property)
15343 (goto-char (car range))
15344 (while (funcall ap (concat property "+")))
15345 (setq val (cdr (assoc property props)))
15346 (when val (if literal-nil val (org-not-nil val))))))))))
15348 (defun org-property-or-variable-value (var &optional inherit)
15349 "Check if there is a property fixing the value of VAR.
15350 If yes, return this value. If not, return the current value of the variable."
15351 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15353 (read prop)
15354 (symbol-value var))))
15356 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15357 "Delete the property PROPERTY from entry at point-or-marker POM.
15358 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15359 an empty drawer to delete."
15360 (org-with-point-at pom
15361 (if (member property org-special-properties)
15362 nil ; cannot delete these properties.
15363 (let ((range (org-get-property-block)))
15364 (if (and range
15365 (goto-char (car range))
15366 (re-search-forward
15367 (org-re-property property)
15368 (cdr range) t))
15369 (progn
15370 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15371 (and delete-empty-drawer
15372 (org-remove-empty-drawer-at
15373 delete-empty-drawer (car range)))
15374 t)
15375 nil)))))
15377 ;; Multi-values properties are properties that contain multiple values
15378 ;; These values are assumed to be single words, separated by whitespace.
15379 (defun org-entry-add-to-multivalued-property (pom property value)
15380 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15381 (let* ((old (org-entry-get pom property))
15383 (setq value (org-entry-protect-space value))
15384 (unless (member value values)
15385 (setq values (append values (list value)))
15386 (org-entry-put pom property
15387 (mapconcat 'identity values " ")))))
15389 (defun org-entry-remove-from-multivalued-property (pom property value)
15390 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15391 (let* ((old (org-entry-get pom property))
15393 (setq value (org-entry-protect-space value))
15394 (when (member value values)
15395 (setq values (delete value values))
15396 (org-entry-put pom property
15397 (mapconcat 'identity values " ")))))
15399 (defun org-entry-member-in-multivalued-property (pom property value)
15400 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15401 (let* ((old (org-entry-get pom property))
15403 (setq value (org-entry-protect-space value))
15404 (member value values)))
15406 (defun org-entry-get-multivalued-property (pom property)
15407 "Return a list of values in a multivalued property."
15408 (let* ((value (org-entry-get pom property))
15410 (mapcar 'org-entry-restore-space values)))
15412 (defun org-entry-put-multivalued-property (pom property &rest values)
15413 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15414 VALUES should be a list of strings. Spaces will be protected."
15415 (org-entry-put pom property
15416 (mapconcat 'org-entry-protect-space values " "))
15417 (let* ((value (org-entry-get pom property))
15419 (mapcar 'org-entry-restore-space values)))
15421 (defun org-entry-protect-space (s)
15422 "Protect spaces and newline in string S."
15423 (while (string-match " " s)
15424 (setq s (replace-match "%20" t t s)))
15426 (setq s (replace-match "%0A" t t s)))
15427 s)
15429 (defun org-entry-restore-space (s)
15430 "Restore spaces and newline in string S."
15431 (while (string-match "%20" s)
15432 (setq s (replace-match " " t t s)))
15433 (while (string-match "%0A" s)
15435 s)
15437 (defvar org-entry-property-inherited-from (make-marker)
15438 "Marker pointing to the entry from where a property was inherited.
15439 Each call to `org-entry-get-with-inheritance' will set this marker to the
15440 location of the entry where the inheritance search matched. If there was
15441 no match, the marker will point nowhere.
15442 Note that also `org-entry-get' calls this function, if the INHERIT flag
15443 is set.")
15445 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15446 "Get PROPERTY of entry or content at point, search higher levels if needed.
15447 The search will stop at the first ancestor which has the property defined.
15449 should be considered as undefined (this is the meaning of nil here).
15451 (move-marker org-entry-property-inherited-from nil)
15452 (let (tmp)
15453 (save-excursion
15454 (save-restriction
15455 (widen)
15456 (catch 'ex
15457 (while t
15458 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15459 (or (ignore-errors (org-back-to-heading t))
15460 (goto-char (point-min)))
15461 (move-marker org-entry-property-inherited-from (point))
15462 (throw 'ex tmp))
15463 (or (ignore-errors (org-up-heading-safe))
15464 (throw 'ex nil))))))
15465 (setq tmp (or tmp
15466 (cdr (assoc property org-file-properties))
15467 (cdr (assoc property org-global-properties))
15468 (cdr (assoc property org-global-properties-fixed))))
15469 (if literal-nil tmp (org-not-nil tmp))))
15471 (defvar org-property-changed-functions nil
15472 "Hook called when the value of a property has changed.
15473 Each hook function should accept two arguments, the name of the property
15474 and the new value.")
15476 (defun org-entry-put (pom property value)
15477 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15478 (org-with-point-at pom
15479 (org-back-to-heading t)
15480 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15481 range)
15482 (cond
15483 ((equal property "TODO")
15485 (not (member value org-todo-keywords-1)))
15487 (if (or (not value)
15489 (setq value 'none))
15490 (org-todo value)
15491 (org-set-tags nil 'align))
15492 ((equal property "PRIORITY")
15494 (string-to-char value) ?\ ))
15495 (org-set-tags nil 'align))
15496 ((equal property "CLOCKSUM")
15497 (if (not (re-search-forward
15499 (error "Cannot find a clock log")
15500 (goto-char (- (match-end 1) 2))
15501 (cond
15502 ((eq value 'earlier) (org-timestamp-down))
15503 ((eq value 'later) (org-timestamp-up)))
15504 (org-clock-sum-current-item)))
15505 ((equal property "SCHEDULED")
15506 (if (re-search-forward org-scheduled-time-regexp end t)
15507 (cond
15508 ((eq value 'earlier) (org-timestamp-change -1 'day))
15509 ((eq value 'later) (org-timestamp-change 1 'day))
15510 (t (call-interactively 'org-schedule)))
15511 (call-interactively 'org-schedule)))
15512 ((equal property "DEADLINE")
15513 (if (re-search-forward org-deadline-time-regexp end t)
15514 (cond
15515 ((eq value 'earlier) (org-timestamp-change -1 'day))
15516 ((eq value 'later) (org-timestamp-change 1 'day))
15517 (t (call-interactively 'org-deadline)))
15518 (call-interactively 'org-deadline)))
15519 ((member property org-special-properties)
15520 (error "The %s property can not yet be set with `org-entry-put'"
15521 property))
15522 (t ; a non-special property
15523 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15524 (setq range (org-get-property-block beg end 'force))
15525 (goto-char (car range))
15526 (if (re-search-forward
15527 (org-re-property property) (cdr range) t)
15528 (progn
15529 (delete-region (match-beginning 0) (match-end 0))
15530 (goto-char (match-beginning 0)))
15531 (goto-char (cdr range))
15533 (backward-char 1)
15534 (org-indent-line))
15535 (insert ":" property ":")
15536 (and value (insert " " value))
15537 (org-indent-line)))))
15538 (run-hook-with-args 'org-property-changed-functions property value)))
15540 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15541 "Get all property keys in the current buffer.
15542 With INCLUDE-SPECIALS, also list the special properties that reflect things
15543 like tags and TODO state.
15544 With INCLUDE-DEFAULTS, also include properties that has special meaning
15545 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15546 and others.
15547 With INCLUDE-COLUMNS, also include property names given in COLUMN
15548 formats in the current buffer."
15549 (let (rtn range cfmt s p)
15550 (save-excursion
15551 (save-restriction
15552 (widen)
15553 (goto-char (point-min))
15554 (while (re-search-forward org-property-start-re nil t)
15555 (setq range (org-get-property-block))
15556 (goto-char (car range))
15557 (while (re-search-forward org-property-re
15558 (cdr range) t)
15559 (add-to-list 'rtn (org-match-string-no-properties 2)))
15560 (outline-next-heading))))
15562 (when include-specials
15563 (setq rtn (append org-special-properties rtn)))
15565 (when include-defaults
15566 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15567 (add-to-list 'rtn org-effort-property))
15569 (when include-columns
15570 (save-excursion
15571 (save-restriction
15572 (widen)
15573 (goto-char (point-min))
15574 (while (re-search-forward
15576 nil t)
15577 (setq cfmt (match-string 2) s 0)
15579 cfmt s)
15580 (setq s (match-end 0)
15581 p (match-string 1 cfmt))
15582 (unless (or (equal p "ITEM")
15583 (member p org-special-properties))
15584 (add-to-list 'rtn (match-string 1 cfmt))))))))
15586 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15588 (defun org-property-values (key)
15589 "Return a list of all values of property KEY in the current buffer."
15590 (save-excursion
15591 (save-restriction
15592 (widen)
15593 (goto-char (point-min))
15594 (let ((re (org-re-property key))
15595 values)
15596 (while (re-search-forward re nil t)
15597 (add-to-list 'values (org-trim (match-string 3))))
15598 (delete "" values)))))
15600 (defun org-insert-property-drawer ()
15601 "Insert a property drawer into the current entry."
15602 (org-back-to-heading t)
15603 (looking-at org-outline-regexp)
15604 (let ((indent (if org-adapt-indentation
15605 (- (match-end 0) (match-beginning 0))
15606 0))
15607 (beg (point))
15609 end hiddenp)
15610 (outline-next-heading)
15611 (setq end (point))
15612 (goto-char beg)
15613 (while (re-search-forward re end t))
15614 (setq hiddenp (outline-invisible-p))
15615 (end-of-line 1)
15618 (if (member (match-string 1) '("CLOCK:" ":END:"))
15619 ;; just skip this line
15620 (beginning-of-line 2)
15621 ;; Drawer start, find the end
15623 (beginning-of-line 1)))
15624 (org-skip-over-state-notes)
15627 (forward-char 1))
15628 (goto-char (point-at-eol))
15630 (beginning-of-line 0)
15631 (org-indent-to-column indent)
15632 (beginning-of-line 2)
15633 (org-indent-to-column indent)
15634 (beginning-of-line 0)
15635 (if hiddenp
15636 (save-excursion
15637 (org-back-to-heading t)
15638 (hide-entry))
15639 (org-flag-drawer t))))
15641 (defun org-insert-drawer (&optional arg drawer)
15642 "Insert a drawer at point.
15644 Optional argument DRAWER, when non-nil, is a string representing
15645 drawer's name. Otherwise, the user is prompted for a name.
15647 If a region is active, insert the drawer around that region
15648 instead.
15650 Point is left between drawer's boundaries."
15651 (interactive "P")
15652 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15653 "LOGBOOK"))
15654 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15655 ;; internally by Org. They are meant to be inserted
15656 ;; automatically.
15657 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15658 ;; Remove system drawers from list. Note: For some reason,
15659 ;; `org-completing-read' ignores the predicate while
15660 ;; `completing-read' handles it fine.
15661 (drawer (if arg "PROPERTIES"
15662 (or drawer
15663 (completing-read
15664 "Drawer: " org-drawers
15665 (lambda (d) (not (member d system-drawers))))))))
15666 (cond
15667 ;; With C-u, fall back on `org-insert-property-drawer'
15668 (arg (org-insert-property-drawer))
15669 ;; With an active region, insert a drawer at point.
15670 ((not (org-region-active-p))
15671 (progn
15674 (forward-line -2)))
15675 ;; Otherwise, insert the drawer at point
15676 (t
15677 (let ((rbeg (region-beginning))
15678 (rend (copy-marker (region-end))))
15679 (unwind-protect
15680 (progn
15681 (goto-char rbeg)
15682 (beginning-of-line)
15683 (when (save-excursion
15684 (re-search-forward org-outline-regexp-bol rend t))
15685 (user-error "Drawers cannot contain headlines"))
15686 ;; Position point at the beginning of the first
15687 ;; non-blank line in region. Insert drawer's opening
15688 ;; there, then indent it.
15689 (org-skip-whitespace)
15690 (beginning-of-line)
15692 (forward-line -1)
15693 (indent-for-tab-command)
15694 ;; Move point to the beginning of the first blank line
15695 ;; after the last non-blank line in region. Insert
15696 ;; drawer's closing, then indent it.
15697 (goto-char rend)
15700 (deactivate-mark t)
15701 (indent-for-tab-command)
15703 ;; Clear marker, whatever the outcome of insertion is.
15704 (set-marker rend nil)))))))
15706 (defvar org-property-set-functions-alist nil
15707 "Property set function alist.
15708 Each entry should have the following format:
15710 (PROPERTY . READ-FUNCTION)
15712 The read function will be called with the same argument as
15713 `org-completing-read'.")
15715 (defun org-set-property-function (property)
15716 "Get the function that should be used to set PROPERTY.
15717 This is computed according to `org-property-set-functions-alist'."
15718 (or (cdr (assoc property org-property-set-functions-alist))
15719 'org-completing-read))
15721 (defun org-read-property-value (property)
15722 "Read PROPERTY value from user."
15723 (let* ((completion-ignore-case t)
15724 (allowed (org-property-get-allowed-values nil property 'table))
15725 (cur (org-entry-get nil property))
15726 (prompt (concat property " value"
15728 (concat " [" cur "]") "") ": "))
15729 (set-function (org-set-property-function property))
15730 (val (if allowed
15731 (funcall set-function prompt allowed nil
15732 (not (get-text-property 0 'org-unrestricted
15733 (caar allowed))))
15734 (let (org-completion-use-ido org-completion-use-iswitchb)
15735 (funcall set-function prompt
15736 (mapcar 'list (org-property-values property))
15737 nil nil "" nil cur)))))
15738 (if (equal val "")
15739 cur
15740 val)))
15742 (defvar org-last-set-property nil)
15743 (defvar org-last-set-property-value nil)
15744 (defun org-read-property-name ()
15745 "Read a property name."
15746 (let* ((completion-ignore-case t)
15747 (keys (org-buffer-property-keys nil t t))
15748 (default-prop (or (save-excursion
15749 (save-match-data
15750 (beginning-of-line)
15752 (null (string= (match-string 1) "END"))
15753 (match-string 1))))
15754 org-last-set-property))
15755 (property (org-icompleting-read
15756 (concat "Property"
15757 (if default-prop (concat " [" default-prop "]") "")
15758 ": ")
15759 (mapcar 'list keys)
15760 nil nil nil nil
15761 default-prop)))
15762 (if (member property keys)
15763 property
15764 (or (cdr (assoc (downcase property)
15765 (mapcar (lambda (x) (cons (downcase x) x))
15766 keys)))
15767 property))))
15769 (defun org-set-property-and-value (use-last)
15770 "Allow to set [PROPERTY]: [value] direction from prompt.
15771 When use-default, don't even ask, just use the last
15773 (interactive "P")
15774 (let* ((completion-ignore-case t)
15775 (pv (or (and use-last org-last-set-property-value)
15776 (org-completing-read
15778 nil nil nil nil nil
15779 org-last-set-property-value)))
15780 prop val)
15782 (setq prop (match-string 1 pv)
15783 val (match-string 2 pv))
15784 (org-set-property prop val))))
15786 (defun org-set-property (property value)
15787 "In the current entry, set PROPERTY to VALUE.
15788 When called interactively, this will prompt for a property name, offering
15789 completion on existing and default properties. And then it will prompt
15790 for a value, offering completion either on allowed values (via an inherited
15791 xxx_ALL property) or on existing values in other instances of this property
15792 in the current file."
15793 (interactive (list nil nil))
15794 (let* ((property (or property (org-read-property-name)))
15795 (value (or value (org-read-property-value property)))
15796 (fn (cdr (assoc property org-properties-postprocess-alist))))
15797 (setq org-last-set-property property)
15798 (setq org-last-set-property-value (concat property ": " value))
15799 ;; Possibly postprocess the inserted value:
15800 (when fn (setq value (funcall fn value)))
15801 (unless (equal (org-entry-get nil property) value)
15802 (org-entry-put nil property value))))
15804 (defun org-delete-property (property &optional delete-empty-drawer)
15805 "In the current entry, delete PROPERTY.
15806 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15807 an empty drawer to delete."
15808 (interactive
15809 (let* ((completion-ignore-case t)
15810 (prop (org-icompleting-read "Property: "
15811 (org-entry-properties nil 'standard))))
15812 (list prop)))
15813 (message "Property %s %s" property
15814 (if (org-entry-delete nil property delete-empty-drawer)
15815 "deleted"
15816 "was not present in the entry")))
15818 (defun org-delete-property-globally (property)
15819 "Remove PROPERTY globally, from all entries."
15820 (interactive
15821 (let* ((completion-ignore-case t)
15822 (prop (org-icompleting-read
15823 "Globally remove property: "
15824 (mapcar 'list (org-buffer-property-keys)))))
15825 (list prop)))
15826 (save-excursion
15827 (save-restriction
15828 (widen)
15829 (goto-char (point-min))
15830 (let ((cnt 0))
15831 (while (re-search-forward
15832 (org-re-property property)
15833 nil t)
15834 (setq cnt (1+ cnt))
15835 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15838 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15840 (defun org-compute-property-at-point ()
15841 "Compute the property at point.
15842 This looks for an enclosing column format, extracts the operator and
15843 then applies it to the property in the column format's scope."
15844 (interactive)
15845 (unless (org-at-property-p)
15846 (user-error "Not at a property"))
15847 (let ((prop (org-match-string-no-properties 2)))
15848 (org-columns-get-format-and-top-level)
15849 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15850 (user-error "No operator defined for property %s" prop))
15851 (org-columns-compute prop)))
15853 (defvar org-property-allowed-value-functions nil
15854 "Hook for functions supplying allowed values for a specific property.
15855 The functions must take a single argument, the name of the property, and
15857 the values, this means that these values are intended as defaults for
15858 completion, but that other values should be allowed too.
15859 The functions must return nil if they are not responsible for this
15860 property.")
15862 (defun org-property-get-allowed-values (pom property &optional table)
15863 "Get allowed values for the property PROPERTY.
15864 When TABLE is non-nil, return an alist that can directly be used for
15865 completion."
15866 (let (vals)
15867 (cond
15868 ((equal property "TODO")
15869 (setq vals (org-with-point-at pom
15870 (append org-todo-keywords-1 '("")))))
15871 ((equal property "PRIORITY")
15872 (let ((n org-lowest-priority))
15873 (while (>= n org-highest-priority)
15874 (push (char-to-string n) vals)
15875 (setq n (1- n)))))
15876 ((member property org-special-properties))
15877 ((setq vals (run-hook-with-args-until-success
15878 'org-property-allowed-value-functions property)))
15879 (t
15880 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15882 (setq vals (car (read-from-string (concat "(" vals ")"))))
15883 (setq vals (mapcar (lambda (x)
15884 (cond ((stringp x) x)
15885 ((numberp x) (number-to-string x))
15886 ((symbolp x) (symbol-name x))
15887 (t "???")))
15888 vals)))))
15889 (when (member ":ETC" vals)
15890 (setq vals (remove ":ETC" vals))
15891 (org-add-props (car vals) '(org-unrestricted t)))
15892 (if table (mapcar 'list vals) vals)))
15894 (defun org-property-previous-allowed-value (&optional previous)
15895 "Switch to the next allowed value for this property."
15896 (interactive)
15897 (org-property-next-allowed-value t))
15899 (defun org-property-next-allowed-value (&optional previous)
15900 "Switch to the next allowed value for this property."
15901 (interactive)
15902 (unless (org-at-property-p)
15903 (user-error "Not at a property"))
15904 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15905 (key (match-string 2))
15906 (value (match-string 3))
15907 (allowed (or (org-property-get-allowed-values (point) key)
15908 (and (member value '("[ ]" "[-]" "[X]"))
15909 '("[ ]" "[X]"))))
15910 (heading (save-match-data (nth 4 (org-heading-components))))
15911 nval)
15912 (unless allowed
15913 (user-error "Allowed values for this property have not been defined"))
15914 (if previous (setq allowed (reverse allowed)))
15915 (if (member value allowed)
15916 (setq nval (car (cdr (member value allowed)))))
15917 (setq nval (or nval (car allowed)))
15918 (if (equal nval value)
15919 (user-error "Only one allowed value for this property"))
15920 (org-at-property-p)
15921 (replace-match (concat " :" key ": " nval) t t)
15922 (org-indent-line)
15923 (beginning-of-line 1)
15925 (when (equal prop org-effort-property)
15926 (save-excursion
15927 (org-back-to-heading t)
15928 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15929 (when (string= org-clock-current-task heading)
15930 (setq org-clock-effort nval)
15931 (org-clock-update-mode-line)))
15932 (run-hook-with-args 'org-property-changed-functions key nval)))
15934 (defun org-find-olp (path &optional this-buffer)
15935 "Return a marker pointing to the entry at outline path OLP.
15936 If anything goes wrong, throw an error.
15937 You can wrap this call to catch the error like this:
15939 (condition-case msg
15940 (org-mobile-locate-entry (match-string 4))
15941 (error (nth 1 msg)))
15943 The return value will then be either a string with the error message,
15944 or a marker if everything is OK.
15946 If THIS-BUFFER is set, the outline path does not contain a file,
15947 only headings."
15948 (let* ((file (if this-buffer buffer-file-name (pop path)))
15949 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15950 (level 1)
15951 (lmin 1)
15952 (lmax 1)
15953 limit re end found pos heading cnt flevel)
15954 (unless buffer (error "File not found :%s" file))
15955 (with-current-buffer buffer
15956 (save-excursion
15957 (save-restriction
15958 (widen)
15959 (setq limit (point-max))
15960 (goto-char (point-min))
15961 (while (setq heading (pop path))
15962 (setq re (format org-complex-heading-regexp-format
15963 (regexp-quote heading)))
15964 (setq cnt 0 pos (point))
15965 (while (re-search-forward re end t)
15966 (setq level (- (match-end 1) (match-beginning 1)))
15967 (if (and (>= level lmin) (<= level lmax))
15968 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15969 (when (= cnt 0) (error "Heading not found on level %d: %s"
15970 lmax heading))
15971 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15972 lmax heading))
15973 (goto-char found)
15974 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15975 (setq end (save-excursion (org-end-of-subtree t t))))
15976 (when (org-at-heading-p)
15977 (point-marker)))))))
15979 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15980 "Find node HEADING in BUFFER.
15981 Return a marker to the heading if it was found, or nil if not.
15982 If POS-ONLY is set, return just the position instead of a marker.
15984 The heading text must match exact, but it may have a TODO keyword,
15985 a priority cookie and tags in the standard locations."
15986 (with-current-buffer (or buffer (current-buffer))
15987 (save-excursion
15988 (save-restriction
15989 (widen)
15990 (goto-char (point-min))
15991 (let (case-fold-search)
15992 (if (re-search-forward
15993 (format org-complex-heading-regexp-format
15994 (regexp-quote heading)) nil t)
15995 (if pos-only
15996 (match-beginning 0)
15997 (move-marker (make-marker) (match-beginning 0)))))))))
15999 (defun org-find-exact-heading-in-directory (heading &optional dir)
16000 "Find Org node headline HEADING in all .org files in directory DIR.
16001 When the target headline is found, return a marker to this location."
16002 (let ((files (directory-files (or dir default-directory)
16004 file visiting m buffer)
16005 (catch 'found
16006 (while (setq file (pop files))
16007 (message "trying %s" file)
16008 (setq visiting (org-find-base-buffer-visiting file))
16009 (setq buffer (or visiting (find-file-noselect file)))
16010 (setq m (org-find-exact-headline-in-buffer
16011 heading buffer))
16012 (when (and (not m) (not visiting)) (kill-buffer buffer))
16013 (and m (throw 'found m))))))
16015 (defun org-find-entry-with-id (ident)
16016 "Locate the entry that contains the ID property with exact value IDENT.
16017 IDENT can be a string, a symbol or a number, this function will search for
16018 the string representation of it.
16019 Return the position where this entry starts, or nil if there is no such entry."
16020 (interactive "sID: ")
16021 (let ((id (cond
16022 ((stringp ident) ident)
16023 ((symbol-name ident) (symbol-name ident))
16024 ((numberp ident) (number-to-string ident))
16025 (t (error "IDENT %s must be a string, symbol or number" ident))))
16026 (case-fold-search nil))
16027 (save-excursion
16028 (save-restriction
16029 (widen)
16030 (goto-char (point-min))
16031 (when (re-search-forward
16033 nil t)
16034 (org-back-to-heading t)
16035 (point))))))
16037 ;;;; Timestamps
16039 (defvar org-last-changed-timestamp nil)
16040 (defvar org-last-inserted-timestamp nil
16041 "The last time stamp inserted with `org-insert-time-stamp'.")
16042 (defvar org-ts-what) ; dynamically scoped parameter
16044 (defun org-time-stamp (arg &optional inactive)
16045 "Prompt for a date/time and insert a time stamp.
16046 If the user specifies a time like HH:MM or if this command is
16047 called with at least one prefix argument, the time stamp contains
16048 the date and the time. Otherwise, only the date is be included.
16050 All parts of a date not specified by the user is filled in from
16051 the current date/time. So if you just press return without
16052 typing anything, the time stamp will represent the current
16053 date/time.
16055 If there is already a timestamp at the cursor, it will be
16056 modified.
16058 With two universal prefix arguments, insert an active timestamp
16059 with the current time without prompting the user.
16061 When called from lisp, the timestamp is inactive if INACTIVE is
16062 non-nil."
16063 (interactive "P")
16064 (let* ((ts nil)
16065 (default-time
16066 ;; Default time is either today, or, when entering a range,
16067 ;; the range start.
16068 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16069 (save-excursion
16070 (re-search-backward
16072 (- (point) 20) t)))
16073 (apply 'encode-time (org-parse-time-string (match-string 1)))
16074 (current-time)))
16075 (default-input (and ts (org-get-compact-tod ts)))
16076 (repeater (save-excursion
16077 (save-match-data
16078 (beginning-of-line)
16079 (when (re-search-forward
16081 (save-excursion (progn (end-of-line) (point))) t)
16082 (match-string 0)))))
16083 org-time-was-given org-end-time-was-given time)
16084 (cond
16085 ((and (org-at-timestamp-p t)
16086 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16087 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16088 (insert "--")
16089 (setq time (let ((this-command this-command))
16090 (org-read-date arg 'totime nil nil
16091 default-time default-input inactive)))
16092 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16093 ((org-at-timestamp-p t)
16094 (setq time (let ((this-command this-command))
16095 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16096 (when (org-at-timestamp-p t) ; just to get the match data
16097 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16098 (replace-match "")
16099 (setq org-last-changed-timestamp
16100 (org-insert-time-stamp
16101 time (or org-time-was-given arg)
16102 inactive nil nil (list org-end-time-was-given)))
16103 (when repeater (goto-char (1- (point))) (insert " " repeater)
16104 (setq org-last-changed-timestamp
16105 (concat (substring org-last-inserted-timestamp 0 -1)
16106 " " repeater ">"))))
16107 (message "Timestamp updated"))
16108 ((equal arg '(16))
16109 (org-insert-time-stamp (current-time) t inactive))
16110 (t
16111 (setq time (let ((this-command this-command))
16112 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16113 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16114 nil nil (list org-end-time-was-given))))))
16116 ;; FIXME: can we use this for something else, like computing time differences?
16117 (defun org-get-compact-tod (s)
16118 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16119 (let* ((t1 (match-string 1 s))
16120 (h1 (string-to-number (match-string 2 s)))
16121 (m1 (string-to-number (match-string 3 s)))
16122 (t2 (and (match-end 4) (match-string 5 s)))
16123 (h2 (and t2 (string-to-number (match-string 6 s))))
16124 (m2 (and t2 (string-to-number (match-string 7 s))))
16125 dh dm)
16126 (if (not t2)
16127 t1
16128 (setq dh (- h2 h1) dm (- m2 m1))
16129 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16130 (concat t1 "+" (number-to-string dh)
16131 (and (/= 0 dm) (format ":%02d" dm)))))))
16133 (defun org-time-stamp-inactive (&optional arg)
16134 "Insert an inactive time stamp.
16135 An inactive time stamp is enclosed in square brackets instead of angle
16136 brackets. It is inactive in the sense that it does not trigger agenda entries,
16137 does not link to the calendar and cannot be changed with the S-cursor keys.
16138 So these are more for recording a certain time/date."
16139 (interactive "P")
16140 (org-time-stamp arg 'inactive))
16142 (defvar org-date-ovl (make-overlay 1 1))
16143 (overlay-put org-date-ovl 'face 'org-date-selected)
16144 (org-detach-overlay org-date-ovl)
16146 (defvar org-ans1) ; dynamically scoped parameter
16147 (defvar org-ans2) ; dynamically scoped parameter
16149 (defvar org-plain-time-of-day-regexp) ; defined below
16151 (defvar org-overriding-default-time nil) ; dynamically scoped
16152 (defvar org-read-date-overlay nil)
16153 (defvar org-dcst nil) ; dynamically scoped
16154 (defvar org-read-date-history nil)
16155 (defvar org-read-date-final-answer nil)
16156 (defvar org-read-date-analyze-futurep nil)
16157 (defvar org-read-date-analyze-forced-year nil)
16158 (defvar org-read-date-inactive)
16160 (defvar org-read-date-minibuffer-local-map
16161 (let* ((org-replace-disputed-keys nil)
16162 (map (make-sparse-keymap)))
16163 (set-keymap-parent map minibuffer-local-map)
16164 (org-defkey map (kbd ".")
16165 (lambda () (interactive)
16166 ;; Are we at the beginning of the prompt?
16167 (if (looking-back "^[^:]+: ")
16168 (org-eval-in-calendar '(calendar-goto-today))
16169 (insert "."))))
16170 (org-defkey map (kbd "C-.")
16171 (lambda () (interactive)
16172 (org-eval-in-calendar '(calendar-goto-today))))
16173 (org-defkey map [(meta shift left)]
16174 (lambda () (interactive)
16175 (org-eval-in-calendar '(calendar-backward-month 1))))
16176 (org-defkey map [(meta shift right)]
16177 (lambda () (interactive)
16178 (org-eval-in-calendar '(calendar-forward-month 1))))
16179 (org-defkey map [(meta shift up)]
16180 (lambda () (interactive)
16181 (org-eval-in-calendar '(calendar-backward-year 1))))
16182 (org-defkey map [(meta shift down)]
16183 (lambda () (interactive)
16184 (org-eval-in-calendar '(calendar-forward-year 1))))
16185 (org-defkey map [?\e (shift left)]
16186 (lambda () (interactive)
16187 (org-eval-in-calendar '(calendar-backward-month 1))))
16188 (org-defkey map [?\e (shift right)]
16189 (lambda () (interactive)
16190 (org-eval-in-calendar '(calendar-forward-month 1))))
16191 (org-defkey map [?\e (shift up)]
16192 (lambda () (interactive)
16193 (org-eval-in-calendar '(calendar-backward-year 1))))
16194 (org-defkey map [?\e (shift down)]
16195 (lambda () (interactive)
16196 (org-eval-in-calendar '(calendar-forward-year 1))))
16197 (org-defkey map [(shift up)]
16198 (lambda () (interactive)
16199 (org-eval-in-calendar '(calendar-backward-week 1))))
16200 (org-defkey map [(shift down)]
16201 (lambda () (interactive)
16202 (org-eval-in-calendar '(calendar-forward-week 1))))
16203 (org-defkey map [(shift left)]
16204 (lambda () (interactive)
16205 (org-eval-in-calendar '(calendar-backward-day 1))))
16206 (org-defkey map [(shift right)]
16207 (lambda () (interactive)
16208 (org-eval-in-calendar '(calendar-forward-day 1))))
16209 (org-defkey map "!"
16210 (lambda () (interactive)
16211 (org-eval-in-calendar '(diary-view-entries))
16212 (message "")))
16213 (org-defkey map ">"
16214 (lambda () (interactive)
16215 (org-eval-in-calendar '(scroll-calendar-left 1))))
16216 (org-defkey map "<"
16217 (lambda () (interactive)
16218 (org-eval-in-calendar '(scroll-calendar-right 1))))
16219 (org-defkey map "\C-v"
16220 (lambda () (interactive)
16221 (org-eval-in-calendar
16222 '(calendar-scroll-left-three-months 1))))
16223 (org-defkey map "\M-v"
16224 (lambda () (interactive)
16225 (org-eval-in-calendar
16226 '(calendar-scroll-right-three-months 1))))
16227 map)
16228 "Keymap for minibuffer commands when using `org-read-date'.")
16230 (defvar org-def)
16231 (defvar org-defdecode)
16232 (defvar org-with-time)
16234 (defun org-read-date (&optional org-with-time to-time from-string prompt
16235 default-time default-input inactive)
16236 "Read a date, possibly a time, and make things smooth for the user.
16237 The prompt will suggest to enter an ISO date, but you can also enter anything
16238 which will at least partially be understood by `parse-time-string'.
16239 Unrecognized parts of the date will default to the current day, month, year,
16240 hour and minute. If this command is called to replace a timestamp at point,
16241 or to enter the second timestamp of a range, the default time is taken
16242 from the existing stamp. Furthermore, the command prefers the future,
16243 so if you are giving a date where the year is not given, and the day-month
16244 combination is already past in the current year, it will assume you
16245 mean next year. For details, see the manual. A few examples:
16247 3-2-5 --> 2003-02-05
16248 feb 15 --> currentyear-02-15
16249 2/15 --> currentyear-02-15
16250 sep 12 9 --> 2009-09-12
16251 12:45 --> today 12:45
16252 22 sept 0:34 --> currentyear-09-22 0:34
16253 12 --> currentyear-currentmonth-12
16254 Fri --> nearest Friday after today
16255 -Tue --> last Tuesday
16256 etc.
16258 Furthermore you can specify a relative date by giving, as the *first* thing
16259 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16260 change in days weeks, months, years.
16261 With a single plus or minus, the date is relative to today. With a double
16262 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16263 +4d --> four days from today
16264 +4 --> same as above
16265 +2w --> two weeks from today
16266 ++5 --> five days from default date
16268 The function understands only English month and weekday abbreviations.
16270 While prompting, a calendar is popped up - you can also select the
16271 date with the mouse (button 1). The calendar shows a period of three
16272 months. To scroll it to other months, use the keys `>' and `<'.
16273 If you don't like the calendar, turn it off with
16274 \(setq org-read-date-popup-calendar nil)
16276 With optional argument TO-TIME, the date will immediately be converted
16277 to an internal time.
16278 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16279 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16280 still enter a time, and this function will inform the calling routine
16281 about this change. The calling routine may then choose to change the
16282 format used to insert the time stamp into the buffer to include the time.
16283 With optional argument FROM-STRING, read from this string instead from
16284 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16285 the time/date that is used for everything that is not specified by the
16286 user."
16287 (require 'parse-time)
16288 (let* ((org-time-stamp-rounding-minutes
16289 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16290 (org-dcst org-display-custom-times)
16291 (ct (org-current-time))
16292 (org-def (or org-overriding-default-time default-time ct))
16293 (org-defdecode (decode-time org-def))
16294 (dummy (progn
16295 (when (< (nth 2 org-defdecode) org-extend-today-until)
16296 (setcar (nthcdr 2 org-defdecode) -1)
16297 (setcar (nthcdr 1 org-defdecode) 59)
16298 (setq org-def (apply 'encode-time org-defdecode)
16299 org-defdecode (decode-time org-def)))))
16300 (mouse-autoselect-window nil) ; Don't let the mouse jump
16301 (calendar-frame-setup nil)
16302 (calendar-setup nil)
16303 (calendar-move-hook nil)
16304 (calendar-view-diary-initially-flag nil)
16305 (calendar-view-holidays-initially-flag nil)
16306 (timestr (format-time-string
16307 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16308 (prompt (concat (if prompt (concat prompt " ") "")
16309 (format "Date+time [%s]: " timestr)))
16310 ans (org-ans0 "") org-ans1 org-ans2 final)
16312 (cond
16313 (from-string (setq ans from-string))
16314 (org-read-date-popup-calendar
16315 (save-excursion
16316 (save-window-excursion
16317 (calendar)
16318 (org-eval-in-calendar '(setq cursor-type nil) t)
16319 (unwind-protect
16320 (progn
16321 (calendar-forward-day (- (time-to-days org-def)
16322 (calendar-absolute-from-gregorian
16323 (calendar-current-date))))
16324 (org-eval-in-calendar nil t)
16325 (let* ((old-map (current-local-map))
16326 (map (copy-keymap calendar-mode-map))
16327 (minibuffer-local-map
16328 (copy-keymap org-read-date-minibuffer-local-map)))
16329 (org-defkey map (kbd "RET") 'org-calendar-select)
16330 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16331 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16332 (unwind-protect
16333 (progn
16334 (use-local-map map)
16335 (setq org-read-date-inactive inactive)
16336 (add-hook 'post-command-hook 'org-read-date-display)
16337 (setq org-ans0 (read-string prompt default-input
16338 'org-read-date-history nil))
16339 ;; org-ans0: from prompt
16340 ;; org-ans1: from mouse click
16341 ;; org-ans2: from calendar motion
16342 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16343 (remove-hook 'post-command-hook 'org-read-date-display)
16344 (use-local-map old-map)
16345 (when org-read-date-overlay
16346 (delete-overlay org-read-date-overlay)
16347 (setq org-read-date-overlay nil)))))
16348 (bury-buffer "*Calendar*")))))
16350 (t ; Naked prompt only
16351 (unwind-protect
16352 (setq ans (read-string prompt default-input
16353 'org-read-date-history timestr))
16354 (when org-read-date-overlay
16355 (delete-overlay org-read-date-overlay)
16356 (setq org-read-date-overlay nil)))))
16358 (setq final (org-read-date-analyze ans org-def org-defdecode))
16360 (when org-read-date-analyze-forced-year
16361 (message "Year was forced into %s"
16362 (if org-read-date-force-compatible-dates
16363 "compatible range (1970-2037)"
16364 "range representable on this machine"))
16365 (ding))
16367 ;; One round trip to get rid of 34th of August and stuff like that....
16368 (setq final (decode-time (apply 'encode-time final)))
16370 (setq org-read-date-final-answer ans)
16372 (if to-time
16373 (apply 'encode-time final)
16374 (if (and (boundp 'org-time-was-given) org-time-was-given)
16375 (format "%04d-%02d-%02d %02d:%02d"
16376 (nth 5 final) (nth 4 final) (nth 3 final)
16377 (nth 2 final) (nth 1 final))
16378 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16380 (defun org-read-date-display ()
16381 "Display the current date prompt interpretation in the minibuffer."
16382 (when org-read-date-display-live
16383 (when org-read-date-overlay
16384 (delete-overlay org-read-date-overlay))
16385 (when (minibufferp (current-buffer))
16386 (save-excursion
16387 (end-of-line 1)
16388 (while (not (equal (buffer-substring
16389 (max (point-min) (- (point) 4)) (point))
16390 " "))
16391 (insert " ")))
16392 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16393 " " (or org-ans1 org-ans2)))
16394 (org-end-time-was-given nil)
16395 (f (org-read-date-analyze ans org-def org-defdecode))
16396 (fmts (if org-dcst
16397 org-time-stamp-custom-formats
16398 org-time-stamp-formats))
16399 (fmt (if (or org-with-time
16400 (and (boundp 'org-time-was-given) org-time-was-given))
16401 (cdr fmts)
16402 (car fmts)))
16403 (txt (format-time-string fmt (apply 'encode-time f)))
16404 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16405 (txt (concat "=> " txt)))
16406 (when (and org-end-time-was-given
16407 (string-match org-plain-time-of-day-regexp txt))
16408 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16409 org-end-time-was-given
16410 (substring txt (match-end 0)))))
16411 (when org-read-date-analyze-futurep
16412 (setq txt (concat txt " (=>F)")))
16413 (setq org-read-date-overlay
16414 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16415 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16417 (defun org-read-date-analyze (ans org-def org-defdecode)
16418 "Analyze the combined answer of the date prompt."
16419 ;; FIXME: cleanup and comment
16420 (let ((nowdecode (decode-time (current-time)))
16421 delta deltan deltaw deltadef year month day
16422 hour minute second wday pm h2 m2 tl wday1
16423 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16424 (setq org-read-date-analyze-futurep nil
16425 org-read-date-analyze-forced-year nil)
16427 (setq ans "+0"))
16429 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16430 (setq ans (replace-match "" t t ans)
16431 deltan (car delta)
16432 deltaw (nth 1 delta)
16433 deltadef (nth 2 delta)))
16435 ;; Check if there is an iso week date in there. If yes, store the
16436 ;; info and postpone interpreting it until the rest of the parsing
16437 ;; is done.
16438 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16439 (setq iso-year (if (match-end 1)
16440 (org-small-year-to-year
16441 (string-to-number (match-string 1 ans))))
16442 iso-weekday (if (match-end 3)
16443 (string-to-number (match-string 3 ans)))
16444 iso-week (string-to-number (match-string 2 ans)))
16445 (setq ans (replace-match "" t t ans)))
16447 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16448 (when (string-match
16450 (setq year (if (match-end 2)
16451 (string-to-number (match-string 2 ans))
16452 (progn (setq kill-year t)
16453 (string-to-number (format-time-string "%Y"))))
16454 month (string-to-number (match-string 3 ans))
16455 day (string-to-number (match-string 4 ans)))
16456 (if (< year 100) (setq year (+ 2000 year)))
16458 t nil ans)))
16460 ;; Help matching dotted european dates
16461 (when (string-match
16462 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16463 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16464 (setq kill-year t)
16465 (string-to-number (format-time-string "%Y")))
16466 day (string-to-number (match-string 1 ans))
16467 month (string-to-number (match-string 2 ans))
16468 ans (replace-match (format "%04d-%02d-%02d" year month day)
16469 t nil ans)))
16471 ;; Help matching american dates, like 5/30 or 5/30/7
16472 (when (string-match
16473 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16474 (setq year (if (match-end 4)
16475 (string-to-number (match-string 4 ans))
16476 (progn (setq kill-year t)
16477 (string-to-number (format-time-string "%Y"))))
16478 month (string-to-number (match-string 1 ans))
16479 day (string-to-number (match-string 2 ans)))
16480 (if (< year 100) (setq year (+ 2000 year)))
16482 t nil ans)))
16483 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16484 ;; If there is a time with am/pm, and *no* time without it, we convert
16485 ;; so that matching will be successful.
16486 (loop for i from 1 to 2 do ; twice, for end time as well
16489 (setq hour (string-to-number (match-string 1 ans))
16490 minute (if (match-end 3)
16491 (string-to-number (match-string 3 ans))
16492 0)
16493 pm (equal ?p
16494 (string-to-char (downcase (match-string 4 ans)))))
16495 (if (and (= hour 12) (not pm))
16496 (setq hour 0)
16497 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16498 (setq ans (replace-match (format "%02d:%02d" hour minute)
16499 t t ans))))
16501 ;; Check if a time range is given as a duration
16502 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16503 (setq hour (string-to-number (match-string 1 ans))
16504 h2 (+ hour (string-to-number (match-string 3 ans)))
16505 minute (string-to-number (match-string 2 ans))
16506 m2 (+ minute (if (match-end 5) (string-to-number
16507 (match-string 5 ans))0)))
16508 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16509 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16510 t t ans)))
16512 ;; Check if there is a time range
16513 (when (boundp 'org-end-time-was-given)
16514 (setq org-time-was-given nil)
16515 (when (and (string-match org-plain-time-of-day-regexp ans)
16516 (match-end 8))
16517 (setq org-end-time-was-given (match-string 8 ans))
16518 (setq ans (concat (substring ans 0 (match-beginning 7))
16519 (substring ans (match-end 7))))))
16521 (setq tl (parse-time-string ans)
16522 day (or (nth 3 tl) (nth 3 org-defdecode))
16523 month (or (nth 4 tl)
16524 (if (and org-read-date-prefer-future
16525 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16526 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16527 (nth 4 org-defdecode)))
16528 year (or (and (not kill-year) (nth 5 tl))
16529 (if (and org-read-date-prefer-future
16530 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16531 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16532 (nth 5 org-defdecode)))
16533 hour (or (nth 2 tl) (nth 2 org-defdecode))
16534 minute (or (nth 1 tl) (nth 1 org-defdecode))
16535 second (or (nth 0 tl) 0)
16536 wday (nth 6 tl))
16538 (when (and (eq org-read-date-prefer-future 'time)
16539 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16540 (equal day (nth 3 nowdecode))
16541 (equal month (nth 4 nowdecode))
16542 (equal year (nth 5 nowdecode))
16543 (nth 2 tl)
16544 (or (< (nth 2 tl) (nth 2 nowdecode))
16545 (and (= (nth 2 tl) (nth 2 nowdecode))
16546 (nth 1 tl)
16547 (< (nth 1 tl) (nth 1 nowdecode)))))
16548 (setq day (1+ day)
16549 futurep t))
16551 ;; Special date definitions below
16552 (cond
16553 (iso-week
16554 ;; There was an iso week
16555 (require 'cal-iso)
16556 (setq futurep nil)
16557 (setq year (or iso-year year)
16558 day (or iso-weekday wday 1)
16559 wday nil ; to make sure that the trigger below does not match
16560 iso-date (calendar-gregorian-from-absolute
16561 (calendar-absolute-from-iso
16562 (list iso-week day year))))
16563 ; FIXME: Should we also push ISO weeks into the future?
16564 ; (when (and org-read-date-prefer-future
16565 ; (not iso-year)
16566 ; (< (calendar-absolute-from-gregorian iso-date)
16567 ; (time-to-days (current-time))))
16568 ; (setq year (1+ year)
16569 ; iso-date (calendar-gregorian-from-absolute
16570 ; (calendar-absolute-from-iso
16571 ; (list iso-week day year)))))
16572 (setq month (car iso-date)
16573 year (nth 2 iso-date)
16574 day (nth 1 iso-date)))
16575 (deltan
16576 (setq futurep nil)
16577 (unless deltadef
16578 (let ((now (decode-time (current-time))))
16579 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16580 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16581 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16582 ((equal deltaw "m") (setq month (+ month deltan)))
16583 ((equal deltaw "y") (setq year (+ year deltan)))))
16584 ((and wday (not (nth 3 tl)))
16585 ;; Weekday was given, but no day, so pick that day in the week
16586 ;; on or after the derived date.
16587 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16588 (unless (equal wday wday1)
16589 (setq day (+ day (% (- wday wday1 -7) 7))))))
16590 (if (and (boundp 'org-time-was-given)
16591 (nth 2 tl))
16592 (setq org-time-was-given t))
16593 (if (< year 100) (setq year (+ 2000 year)))
16594 ;; Check of the date is representable
16595 (if org-read-date-force-compatible-dates
16596 (progn
16597 (if (< year 1970)
16598 (setq year 1970 org-read-date-analyze-forced-year t))
16599 (if (> year 2037)
16600 (setq year 2037 org-read-date-analyze-forced-year t)))
16601 (condition-case nil
16602 (ignore (encode-time second minute hour day month year))
16603 (error
16604 (setq year (nth 5 org-defdecode))
16605 (setq org-read-date-analyze-forced-year t))))
16606 (setq org-read-date-analyze-futurep futurep)
16607 (list second minute hour day month year)))
16609 (defvar parse-time-weekdays)
16610 (defun org-read-date-get-relative (s today default)
16611 "Check string S for special relative date string.
16612 TODAY and DEFAULT are internal times, for today and for a default.
16613 Return shift list (N what def-flag)
16615 N is the number of WHATs to shift.
16616 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16617 the DEFAULT date rather than TODAY."
16618 (require 'parse-time)
16619 (when (and
16620 (string-match
16621 (concat
16626 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16627 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16628 (string-to-char (substring (match-string 1 s) -1))
16629 ?+))
16630 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16631 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16632 (what (if (match-end 3) (match-string 3 s) "d"))
16633 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16634 (date (if rel default today))
16635 (wday (nth 6 (decode-time date)))
16636 delta)
16637 (if wday1
16638 (progn
16639 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16640 (if (= delta 0) (setq delta 7))
16641 (if (= dir ?-)
16642 (progn
16643 (setq delta (- delta 7))
16644 (if (= delta 0) (setq delta -7))))
16645 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16646 (list delta "d" rel))
16647 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16649 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16650 "Turn a user-specified date into the internal representation.
16651 The internal representation needed by the calendar is (month day year).
16652 This is a wrapper to handle the brain-dead convention in calendar that
16653 user function argument order change dependent on argument order."
16654 (if (boundp 'calendar-date-style)
16655 (cond
16656 ((eq calendar-date-style 'american)
16657 (list arg1 arg2 arg3))
16658 ((eq calendar-date-style 'european)
16659 (list arg2 arg1 arg3))
16660 ((eq calendar-date-style 'iso)
16661 (list arg2 arg3 arg1)))
16662 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16663 (if (org-bound-and-true-p european-calendar-style)
16664 (list arg2 arg1 arg3)
16665 (list arg1 arg2 arg3)))))
16667 (defun org-eval-in-calendar (form &optional keepdate)
16668 "Eval FORM in the calendar window and return to current window.
16669 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16670 otherwise stick to the current value of `org-ans2'."
16671 (let ((sf (selected-frame))
16672 (sw (selected-window)))
16673 (select-window (get-buffer-window "*Calendar*" t))
16674 (eval form)
16675 (when (and (not keepdate) (calendar-cursor-to-date))
16676 (let* ((date (calendar-cursor-to-date))
16677 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16678 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16679 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16680 (select-window sw)
16681 (org-select-frame-set-input-focus sf)))
16683 (defun org-calendar-select ()
16684 "Return to `org-read-date' with the date currently selected.
16685 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16686 (interactive)
16687 (when (calendar-cursor-to-date)
16688 (let* ((date (calendar-cursor-to-date))
16689 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16690 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16691 (if (active-minibuffer-window) (exit-minibuffer))))
16693 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16694 "Insert a date stamp for the date given by the internal TIME.
16695 WITH-HM means use the stamp format that includes the time of the day.
16696 INACTIVE means use square brackets instead of angular ones, so that the
16697 stamp will not contribute to the agenda.
16698 PRE and POST are optional strings to be inserted before and after the
16699 stamp.
16700 The command returns the inserted time stamp."
16701 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16702 stamp)
16703 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16704 (insert-before-markers (or pre ""))
16705 (when (listp extra)
16706 (setq extra (car extra))
16707 (if (and (stringp extra)
16709 (setq extra (format "-%02d:%02d"
16710 (string-to-number (match-string 1 extra))
16711 (string-to-number (match-string 2 extra))))
16712 (setq extra nil)))
16713 (when extra
16714 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16715 (insert-before-markers (setq stamp (format-time-string fmt time)))
16716 (insert-before-markers (or post ""))
16717 (setq org-last-inserted-timestamp stamp)))
16719 (defun org-toggle-time-stamp-overlays ()
16720 "Toggle the use of custom time stamp formats."
16721 (interactive)
16722 (setq org-display-custom-times (not org-display-custom-times))
16723 (unless org-display-custom-times
16724 (let ((p (point-min)) (bmp (buffer-modified-p)))
16725 (while (setq p (next-single-property-change p 'display))
16726 (if (and (get-text-property p 'display)
16727 (eq (get-text-property p 'face) 'org-date))
16728 (remove-text-properties
16729 p (setq p (next-single-property-change p 'display))
16730 '(display t))))
16731 (set-buffer-modified-p bmp)))
16732 (if (featurep 'xemacs)
16733 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16734 (org-restart-font-lock)
16735 (setq org-table-may-need-update t)
16736 (if org-display-custom-times
16737 (message "Time stamps are overlaid with custom format")
16738 (message "Time stamp overlays removed")))
16740 (defun org-display-custom-time (beg end)
16741 "Overlay modified time stamp format over timestamp between BEG and END."
16742 (let* ((ts (buffer-substring beg end))
16743 t1 w1 with-hm tf time str w2 (off 0))
16744 (save-match-data
16745 (setq t1 (org-parse-time-string ts t))
16746 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16747 (setq off (- (match-end 0) (match-beginning 0)))))
16748 (setq end (- end off))
16749 (setq w1 (- end beg)
16750 with-hm (and (nth 1 t1) (nth 2 t1))
16751 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16752 time (org-fix-decoded-time t1)
16753 str (org-add-props
16754 (format-time-string
16755 (substring tf 1 -1) (apply 'encode-time time))
16756 nil 'mouse-face 'highlight)
16757 w2 (length str))
16758 (if (not (= w2 w1))
16759 (add-text-properties (1+ beg) (+ 2 beg)
16760 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16761 (if (featurep 'xemacs)
16762 (progn
16763 (put-text-property beg end 'invisible t)
16764 (put-text-property beg end 'end-glyph (make-glyph str)))
16765 (put-text-property beg end 'display str))))
16767 (defun org-translate-time (string)
16768 "Translate all timestamps in STRING to custom format.
16769 But do this only if the variable `org-display-custom-times' is set."
16770 (when org-display-custom-times
16771 (save-match-data
16772 (let* ((start 0)
16773 (re org-ts-regexp-both)
16774 t1 with-hm inactive tf time str beg end)
16775 (while (setq start (string-match re string start))
16776 (setq beg (match-beginning 0)
16777 end (match-end 0)
16778 t1 (save-match-data
16779 (org-parse-time-string (substring string beg end) t))
16780 with-hm (and (nth 1 t1) (nth 2 t1))
16781 inactive (equal (substring string beg (1+ beg)) "[")
16782 tf (funcall (if with-hm 'cdr 'car)
16783 org-time-stamp-custom-formats)
16784 time (org-fix-decoded-time t1)
16785 str (format-time-string
16786 (concat
16787 (if inactive "[" "<") (substring tf 1 -1)
16788 (if inactive "]" ">"))
16789 (apply 'encode-time time))
16790 string (replace-match str t t string)
16791 start (+ start (length str)))))))
16792 string)
16794 (defun org-fix-decoded-time (time)
16795 "Set 0 instead of nil for the first 6 elements of time.
16796 Don't touch the rest."
16797 (let ((n 0))
16798 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16800 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16802 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16803 "Difference between TIMESTAMP-STRING and now in days.
16804 If SECONDS is non-nil, return the difference in seconds."
16805 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16806 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16807 (funcall fdiff (current-time)))))
16809 (defun org-deadline-close (timestamp-string &optional ndays)
16810 "Is the time in TIMESTAMP-STRING close to the current date?"
16811 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16812 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16813 (not (org-entry-is-done-p))))
16815 (defun org-get-wdays (ts &optional delay zero-delay)
16816 "Get the deadline lead time appropriate for timestring TS.
16817 When DELAY is non-nil, get the delay time for scheduled items
16818 instead of the deadline lead time. When ZERO-DELAY is non-nil
16819 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16820 don't try to find the delay cookie in the scheduled timestamp."
16821 (let ((tv (if delay org-scheduled-delay-days
16822 org-deadline-warning-days)))
16823 (cond
16824 ((or (and delay (< tv 0))
16825 (and delay zero-delay (<= tv 0))
16826 (and (not delay) (<= tv 0)))
16827 ;; Enforce this value no matter what
16828 (- tv))
16830 ;; lead time is specified.
16831 (floor (* (string-to-number (match-string 1 ts))
16832 (cdr (assoc (match-string 2 ts)
16833 '(("d" . 1) ("w" . 7)
16834 ("m" . 30.4) ("y" . 365.25)
16835 ("h" . 0.041667)))))))
16836 ;; go for the default.
16837 (t tv))))
16839 (defun org-calendar-select-mouse (ev)
16840 "Return to `org-read-date' with the date currently selected.
16841 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16842 (interactive "e")
16843 (mouse-set-point ev)
16844 (when (calendar-cursor-to-date)
16845 (let* ((date (calendar-cursor-to-date))
16846 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16847 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16848 (if (active-minibuffer-window) (exit-minibuffer))))
16850 (defun org-check-deadlines (ndays)
16851 "Check if there are any deadlines due or past due.
16852 A deadline is considered due if it happens within `org-deadline-warning-days'
16853 days from today's date. If the deadline appears in an entry marked DONE,
16854 it is not shown. The prefix arg NDAYS can be used to test that many
16856 (interactive "P")
16857 (let* ((org-warn-days
16858 (cond
16859 ((equal ndays '(4)) 100000)
16860 (ndays (prefix-numeric-value ndays))
16861 (t (abs org-deadline-warning-days))))
16862 (case-fold-search nil)
16864 (callback
16865 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16867 (message "%d deadlines past-due or due within %d days"
16868 (org-occur regexp nil callback)
16869 org-warn-days)))
16871 (defsubst org-re-timestamp (type)
16872 "Return a regexp for timestamp TYPE.
16873 Allowed values for TYPE are:
16875 all: all timestamps
16876 active: only active timestamps (<...>)
16877 inactive: only inactive timestamps ([...])
16878 scheduled: only scheduled timestamps
16879 deadline: only deadline timestamps
16880 closed: only closed time-stamps
16882 When TYPE is nil, fall back on returning a regexp that matches
16883 both scheduled and deadline timestamps."
16884 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16885 ((eq type 'active) org-ts-regexp)
16889 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16890 ((eq type 'scheduled-or-deadline)
16893 (defun org-check-before-date (date)
16894 "Check if there are deadlines or scheduled entries before DATE."
16895 (interactive (list (org-read-date)))
16896 (let ((case-fold-search nil)
16897 (regexp (org-re-timestamp org-ts-type))
16898 (callback
16899 (lambda () (time-less-p
16900 (org-time-string-to-time (match-string 1))
16901 (org-time-string-to-time date)))))
16902 (message "%d entries before %s"
16903 (org-occur regexp nil callback) date)))
16905 (defun org-check-after-date (date)
16906 "Check if there are deadlines or scheduled entries after DATE."
16907 (interactive (list (org-read-date)))
16908 (let ((case-fold-search nil)
16909 (regexp (org-re-timestamp org-ts-type))
16910 (callback
16911 (lambda () (not
16912 (time-less-p
16913 (org-time-string-to-time (match-string 1))
16914 (org-time-string-to-time date))))))
16915 (message "%d entries after %s"
16916 (org-occur regexp nil callback) date)))
16918 (defun org-check-dates-range (start-date end-date)
16919 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16920 (interactive (list (org-read-date nil nil nil "Range starts")
16921 (org-read-date nil nil nil "Range end")))
16922 (let ((case-fold-search nil)
16923 (regexp (org-re-timestamp org-ts-type))
16924 (callback
16925 (lambda ()
16926 (let ((match (match-string 1)))
16927 (and
16928 (not (time-less-p
16929 (org-time-string-to-time match)
16930 (org-time-string-to-time start-date)))
16931 (time-less-p
16932 (org-time-string-to-time match)
16933 (org-time-string-to-time end-date)))))))
16934 (message "%d entries between %s and %s"
16935 (org-occur regexp nil callback) start-date end-date)))
16937 (defun org-evaluate-time-range (&optional to-buffer)
16938 "Evaluate a time range by computing the difference between start and end.
16939 Normally the result is just printed in the echo area, but with prefix arg
16940 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16941 If the time range is actually in a table, the result is inserted into the
16942 next column.
16943 For time difference computation, a year is assumed to be exactly 365
16944 days in order to avoid rounding problems."
16945 (interactive "P")
16946 (or
16947 (org-clock-update-time-maybe)
16948 (save-excursion
16949 (unless (org-at-date-range-p t)
16950 (goto-char (point-at-bol))
16951 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16952 (if (not (org-at-date-range-p t))
16953 (user-error "Not at a time-stamp range, and none found in current line")))
16954 (let* ((ts1 (match-string 1))
16955 (ts2 (match-string 2))
16956 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16957 (match-end (match-end 0))
16958 (time1 (org-time-string-to-time ts1))
16959 (time2 (org-time-string-to-time ts2))
16960 (t1 (org-float-time time1))
16961 (t2 (org-float-time time2))
16962 (diff (abs (- t2 t1)))
16963 (negative (< (- t2 t1) 0))
16964 ;; (ys (floor (* 365 24 60 60)))
16965 (ds (* 24 60 60))
16966 (hs (* 60 60))
16967 (fy "%dy %dd %02d:%02d")
16968 (fy1 "%dy %dd")
16969 (fd "%dd %02d:%02d")
16970 (fd1 "%dd")
16971 (fh "%02d:%02d")
16972 y d h m align)
16973 (if havetime
16974 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16975 y 0
16976 d (floor (/ diff ds)) diff (mod diff ds)
16977 h (floor (/ diff hs)) diff (mod diff hs)
16978 m (floor (/ diff 60)))
16979 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16980 y 0
16981 d (floor (+ (/ diff ds) 0.5))
16982 h 0 m 0))
16983 (if (not to-buffer)
16984 (message "%s" (org-make-tdiff-string y d h m))
16985 (if (org-at-table-p)
16986 (progn
16987 (goto-char match-end)
16988 (setq align t)
16989 (and (looking-at " *|") (goto-char (match-end 0))))
16990 (goto-char match-end))
16991 (if (looking-at
16993 (replace-match ""))
16994 (if negative (insert " -"))
16995 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16996 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16997 (insert " " (format fh h m))))
16998 (if align (org-table-align))
16999 (message "Time difference inserted")))))
17001 (defun org-make-tdiff-string (y d h m)
17002 (let ((fmt "")
17003 (l nil))
17004 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17005 l (push y l)))
17006 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17007 l (push d l)))
17008 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17009 l (push h l)))
17010 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17011 l (push m l)))
17012 (apply 'format fmt (nreverse l))))
17014 (defun org-time-string-to-time (s &optional buffer pos)
17015 "Convert a timestamp string into internal time."
17016 (condition-case errdata
17017 (apply 'encode-time (org-parse-time-string s))
17019 s (if (not (and buffer pos))
17020 ""
17021 (format " at %d in buffer `%s'" pos buffer))
17022 (cdr errdata)))))
17024 (defun org-time-string-to-seconds (s)
17025 "Convert a timestamp string to a number of seconds."
17026 (org-float-time (org-time-string-to-time s)))
17028 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17029 "Convert a time stamp to an absolute day number.
17030 If there is a specifier for a cyclic time stamp, get the closest
17031 date to DAYNR.
17032 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17033 The variable `date' is bound by the calendar when this is called."
17034 (cond
17036 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17037 daynr
17038 (+ daynr 1000)))
17040 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17041 (time-to-days (current-time))) (match-string 0 s)
17042 prefer show-all))
17043 (t (time-to-days
17044 (condition-case errdata
17045 (apply 'encode-time (org-parse-time-string s))
17047 s (if (not (and buffer pos))
17048 ""
17049 (format " at %d in buffer `%s'" pos buffer))
17050 (cdr errdata))))))))
17052 (defun org-days-to-iso-week (days)
17053 "Return the iso week number."
17054 (require 'cal-iso)
17055 (car (calendar-iso-from-absolute days)))
17057 (defun org-small-year-to-year (year)
17058 "Convert 2-digit years into 4-digit years.
17059 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17060 The year 2000 cannot be abbreviated. Any year larger than 99
17061 is returned unchanged."
17062 (if (< year 38)
17063 (setq year (+ 2000 year))
17064 (if (< year 100)
17065 (setq year (+ 1900 year))))
17066 year)
17068 (defun org-time-from-absolute (d)
17069 "Return the time corresponding to date D.
17070 D may be an absolute day number, or a calendar-type list (month day year)."
17071 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17072 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17074 (defun org-calendar-holiday ()
17075 "List of holidays, for Diary display in Org-mode."
17076 (require 'holidays)
17077 (let ((hl (funcall
17078 (if (fboundp 'calendar-check-holidays)
17079 'calendar-check-holidays 'check-calendar-holidays) date)))
17080 (if hl (mapconcat 'identity hl "; "))))
17082 (defun org-diary-sexp-entry (sexp entry date)
17083 "Process a SEXP diary ENTRY for DATE."
17084 (require 'diary-lib)
17085 (let ((result (if calendar-debug-sexp
17086 (let ((stack-trace-on-error t))
17087 (eval (car (read-from-string sexp))))
17088 (condition-case nil
17089 (eval (car (read-from-string sexp)))
17090 (error
17091 (beep)
17092 (message "Bad sexp at line %d in %s: %s"
17093 (org-current-line)
17094 (buffer-file-name) sexp)
17095 (sleep-for 2))))))
17096 (cond ((stringp result) (split-string result "; "))
17097 ((and (consp result)
17098 (not (consp (cdr result)))
17099 (stringp (cdr result))) (cdr result))
17100 ((and (consp result)
17101 (stringp (car result))) result)
17102 (result entry))))
17104 (defun org-diary-to-ical-string (frombuf)
17105 "Get iCalendar entries from diary entries in buffer FROMBUF.
17106 This uses the icalendar.el library."
17107 (let* ((tmpdir (if (featurep 'xemacs)
17108 (temp-directory)
17109 temporary-file-directory))
17110 (tmpfile (make-temp-name
17111 (expand-file-name "orgics" tmpdir)))
17112 buf rtn b e)
17113 (with-current-buffer frombuf
17114 (icalendar-export-region (point-min) (point-max) tmpfile)
17115 (setq buf (find-buffer-visiting tmpfile))
17116 (set-buffer buf)
17117 (goto-char (point-min))
17118 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17119 (setq b (match-beginning 0)))
17120 (goto-char (point-max))
17121 (if (re-search-backward "^END:VEVENT" nil t)
17122 (setq e (match-end 0)))
17124 (kill-buffer buf)
17125 (delete-file tmpfile)
17126 rtn))
17128 (defun org-closest-date (start current change prefer show-all)
17129 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17130 When PREFER is `past', return a date that is either CURRENT or past.
17131 When PREFER is `future', return a date that is either CURRENT or future.
17132 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17133 ;; Make the proper lists from the dates
17134 (catch 'exit
17135 (let ((a1 '(("h" . hour)
17136 ("d" . day)
17137 ("w" . week)
17138 ("m" . month)
17139 ("y" . year)))
17140 (shour (nth 2 (org-parse-time-string start)))
17141 dn dw sday cday n1 n2 n0
17142 d m y y1 y2 date1 date2 nmonths nm ny m2)
17144 (setq start (org-date-to-gregorian start)
17145 current (org-date-to-gregorian
17146 (if show-all
17147 current
17148 (time-to-days (current-time))))
17149 sday (calendar-absolute-from-gregorian start)
17150 cday (calendar-absolute-from-gregorian current))
17152 (if (<= cday sday) (throw 'exit sday))
17155 (setq dn (string-to-number (match-string 1 change))
17156 dw (cdr (assoc (match-string 2 change) a1)))
17157 (user-error "Invalid change specifier: %s" change))
17158 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17159 (cond
17160 ((eq dw 'hour)
17161 (let ((missing-hours
17162 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17163 dn)))
17164 (setq n1 (if (zerop missing-hours) cday
17165 (- cday (1+ (floor (/ missing-hours 24)))))
17166 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17167 ((eq dw 'day)
17168 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17169 n2 (+ n1 dn)))
17170 ((eq dw 'year)
17171 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17172 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17173 (setq date1 (list m d y1)
17174 n1 (calendar-absolute-from-gregorian date1)
17175 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17176 n2 (calendar-absolute-from-gregorian date2)))
17177 ((eq dw 'month)
17178 ;; approx number of month between the two dates
17179 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17180 ;; How often does dn fit in there?
17181 (setq d (nth 1 start) m (car start) y (nth 2 start)
17182 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17183 m (+ m nm)
17184 ny (floor (/ m 12))
17185 y (+ y ny)
17186 m (- m (* ny 12)))
17187 (while (> m 12) (setq m (- m 12) y (1+ y)))
17188 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17189 (setq m2 (+ m dn) y2 y)
17190 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17191 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17192 (while (<= n2 cday)
17193 (setq n1 n2 m m2 y y2)
17194 (setq m2 (+ m dn) y2 y)
17195 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17196 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17197 ;; Make sure n1 is the earlier date
17198 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17199 (if show-all
17200 (cond
17201 ((eq prefer 'past) (if (= cday n2) n2 n1))
17202 ((eq prefer 'future) (if (= cday n1) n1 n2))
17203 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17204 (cond
17205 ((eq prefer 'past) (if (= cday n2) n2 n1))
17206 ((eq prefer 'future) (if (= cday n1) n1 n2))
17207 (t (if (= cday n1) n1 n2)))))))
17209 (defun org-date-to-gregorian (date)
17210 "Turn any specification of DATE into a Gregorian date for the calendar."
17211 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17212 ((and (listp date) (= (length date) 3)) date)
17213 ((stringp date)
17214 (setq date (org-parse-time-string date))
17215 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17216 ((listp date)
17217 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17219 (defun org-parse-time-string (s &optional nodefault)
17220 "Parse the standard Org-mode time string.
17221 This should be a lot faster than the normal `parse-time-string'.
17222 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17223 hour and minute fields will be nil if not given."
17224 (cond ((string-match org-ts-regexp0 s)
17225 (list 0
17226 (if (or (match-beginning 8) (not nodefault))
17227 (string-to-number (or (match-string 8 s) "0")))
17228 (if (or (match-beginning 7) (not nodefault))
17229 (string-to-number (or (match-string 7 s) "0")))
17230 (string-to-number (match-string 4 s))
17231 (string-to-number (match-string 3 s))
17232 (string-to-number (match-string 2 s))
17233 nil nil nil))
17234 ((string-match "^<[^>]+>$" s)
17235 (decode-time (seconds-to-time (org-matcher-time s))))
17236 (t (error "Not a standard Org-mode time string: %s" s))))
17238 (defun org-timestamp-up (&optional arg)
17239 "Increase the date item at the cursor by one.
17240 If the cursor is on the year, change the year. If it is on the month,
17241 the day or the time, change that.
17242 With prefix ARG, change by that many units."
17243 (interactive "p")
17244 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17246 (defun org-timestamp-down (&optional arg)
17247 "Decrease the date item at the cursor by one.
17248 If the cursor is on the year, change the year. If it is on the month,
17249 the day or the time, change that.
17250 With prefix ARG, change by that many units."
17251 (interactive "p")
17252 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17254 (defun org-timestamp-up-day (&optional arg)
17255 "Increase the date in the time stamp by one day.
17256 With prefix ARG, change that many days."
17257 (interactive "p")
17258 (if (and (not (org-at-timestamp-p t))
17259 (org-at-heading-p))
17260 (org-todo 'up)
17261 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17263 (defun org-timestamp-down-day (&optional arg)
17264 "Decrease the date in the time stamp by one day.
17265 With prefix ARG, change that many days."
17266 (interactive "p")
17267 (if (and (not (org-at-timestamp-p t))
17268 (org-at-heading-p))
17269 (org-todo 'down)
17270 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17272 (defun org-at-timestamp-p (&optional inactive-ok)
17273 "Determine if the cursor is in or at a timestamp."
17274 (interactive)
17275 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17276 (pos (point))
17277 (ans (or (looking-at tsr)
17278 (save-excursion
17280 (if (> (point) (point-min)) (backward-char 1))
17281 (and (looking-at tsr)
17282 (> (- (match-end 0) pos) -1))))))
17283 (and ans
17284 (boundp 'org-ts-what)
17285 (setq org-ts-what
17286 (cond
17287 ((= pos (match-beginning 0)) 'bracket)
17288 ;; Point is considered to be "on the bracket" whether
17289 ;; it's really on it or right after it.
17290 ((= pos (1- (match-end 0))) 'bracket)
17291 ((= pos (match-end 0)) 'after)
17292 ((org-pos-in-match-range pos 2) 'year)
17293 ((org-pos-in-match-range pos 3) 'month)
17294 ((org-pos-in-match-range pos 7) 'hour)
17295 ((org-pos-in-match-range pos 8) 'minute)
17296 ((or (org-pos-in-match-range pos 4)
17297 (org-pos-in-match-range pos 5)) 'day)
17298 ((and (> pos (or (match-end 8) (match-end 5)))
17299 (< pos (match-end 0)))
17300 (- pos (or (match-end 8) (match-end 5))))
17301 (t 'day))))
17302 ans))
17304 (defun org-toggle-timestamp-type ()
17305 "Toggle the type (<active> or [inactive]) of a time stamp."
17306 (interactive)
17307 (when (org-at-timestamp-p t)
17308 (let ((beg (match-beginning 0)) (end (match-end 0))
17309 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17310 (save-excursion
17311 (goto-char beg)
17312 (while (re-search-forward "[][<>]" end t)
17313 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17314 t t)))
17315 (message "Timestamp is now %sactive"
17316 (if (equal (char-after beg) ?<) "" "in")))))
17318 (defun org-at-clock-log-p nil
17319 "Is the cursor on the clock log line?"
17320 (save-excursion
17321 (move-beginning-of-line 1)
17324 (defvar org-clock-history) ; defined in org-clock.el
17325 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17326 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17327 "Change the date in the time stamp at point.
17328 The date will be changed by N times WHAT. WHAT can be `day', `month',
17329 `year', `minute', `second'. If WHAT is not given, the cursor position
17330 in the timestamp determines what will be changed.
17332 (let ((origin (point)) origin-cat
17333 with-hm inactive
17334 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17335 org-ts-what
17336 extra rem
17337 ts time time0 fixnext clrgx)
17338 (if (not (org-at-timestamp-p t))
17339 (user-error "Not at a timestamp"))
17340 (if (and (not what) (eq org-ts-what 'bracket))
17341 (org-toggle-timestamp-type)
17342 ;; Point isn't on brackets. Remember the part of the time-stamp
17343 ;; the point was in. Indeed, size of time-stamps may change,
17344 ;; but point must be kept in the same category nonetheless.
17345 (setq origin-cat org-ts-what)
17346 (if (and (not what) (not (eq org-ts-what 'day))
17347 org-display-custom-times
17348 (get-text-property (point) 'display)
17349 (not (get-text-property (1- (point)) 'display)))
17350 (setq org-ts-what 'day))
17351 (setq org-ts-what (or what org-ts-what)
17352 inactive (= (char-after (match-beginning 0)) ?\[)
17353 ts (match-string 0))
17354 (replace-match "")
17355 (when (string-match
17356 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17357 ts)
17358 (setq extra (match-string 1 ts))
17359 (if suppress-tmp-delay
17360 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17362 (setq with-hm t))
17363 (setq time0 (org-parse-time-string ts))
17364 (when (and updown
17365 (eq org-ts-what 'minute)
17366 (not current-prefix-arg))
17367 ;; This looks like s-up and s-down. Change by one rounding step.
17368 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17369 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17370 (setcar (cdr time0) (+ (nth 1 time0)
17371 (if (> n 0) (- rem) (- dm rem))))))
17372 (setq time
17373 (encode-time (or (car time0) 0)
17374 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17375 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17376 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17377 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17378 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17379 (nthcdr 6 time0)))
17380 (when (and (member org-ts-what '(hour minute))
17381 extra
17383 (setq extra (org-modify-ts-extra
17384 extra
17385 (if (eq org-ts-what 'hour) 2 5)
17386 n dm)))
17387 (when (integerp org-ts-what)
17388 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17389 (if (eq what 'calendar)
17390 (let ((cal-date (org-get-date-from-calendar)))
17391 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17392 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17393 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17394 (setcar time0 (or (car time0) 0))
17395 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17396 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17397 (setq time (apply 'encode-time time0))))
17398 ;; Insert the new time-stamp, and ensure point stays in the same
17399 ;; category as before (i.e. not after the last position in that
17400 ;; category).
17401 (let ((pos (point)))
17402 ;; Stay before inserted string. `save-excursion' is of no use.
17403 (setq org-last-changed-timestamp
17404 (org-insert-time-stamp time with-hm inactive nil nil extra))
17405 (goto-char pos))
17406 (save-match-data
17407 (looking-at org-ts-regexp3)
17408 (goto-char (cond
17409 ;; `day' category ends before `hour' if any, or at
17410 ;; the end of the day name.
17411 ((eq origin-cat 'day)
17412 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17413 ((eq origin-cat 'hour) (min (match-end 7) origin))
17414 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17415 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17416 ;; `year' and `month' have both fixed size: point
17417 ;; couldn't have moved into another part.
17418 (t origin))))
17419 ;; Update clock if on a CLOCK line.
17420 (org-clock-update-time-maybe)
17421 ;; Maybe adjust the closest clock in `org-clock-history'
17422 (when org-clock-adjust-closest
17423 (if (not (and (org-at-clock-log-p)
17424 (< 1 (length (delq nil (mapcar 'marker-position
17425 org-clock-history))))))
17426 (message "No clock to adjust")
17427 (cond ((save-excursion ; fix previous clock?
17428 (re-search-backward org-ts-regexp0 nil t)
17431 ((save-excursion ; fix next clock?
17432 (re-search-backward org-ts-regexp0 nil t)
17435 (save-window-excursion
17436 ;; Find closest clock to point, adjust the previous/next one in history
17437 (let* ((p (save-excursion (org-back-to-heading t)))
17438 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17439 (clfixnth
17440 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17441 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17442 (if (not clfixpos)
17443 (message "No clock to adjust")
17444 (save-excursion
17445 (org-goto-marker-or-bmk clfixpos)
17446 (org-show-subtree)
17447 (when (re-search-forward clrgx nil t)
17448 (goto-char (match-beginning 1))
17449 (let (org-clock-adjust-closest)
17450 (org-timestamp-change n org-ts-what updown))
17451 (message "Clock adjusted in %s for heading: %s"
17452 (file-name-nondirectory (buffer-file-name))
17453 (org-get-heading t t)))))))))
17454 ;; Try to recenter the calendar window, if any.
17455 (if (and org-calendar-follow-timestamp-change
17456 (get-buffer-window "*Calendar*" t)
17457 (memq org-ts-what '(day month year)))
17458 (org-recenter-calendar (time-to-days time))))))
17460 (defun org-modify-ts-extra (s pos n dm)
17461 "Change the different parts of the lead-time and repeat fields in timestamp."
17462 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17463 ng h m new rem)
17464 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17465 (cond
17466 ((or (org-pos-in-match-range pos 2)
17467 (org-pos-in-match-range pos 3))
17468 (setq m (string-to-number (match-string 3 s))
17469 h (string-to-number (match-string 2 s)))
17470 (if (org-pos-in-match-range pos 2)
17471 (setq h (+ h n))
17472 (setq n (* dm (org-no-warnings (signum n))))
17473 (when (not (= 0 (setq rem (% m dm))))
17474 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17475 (setq m (+ m n)))
17476 (if (< m 0) (setq m (+ m 60) h (1- h)))
17477 (if (> m 59) (setq m (- m 60) h (1+ h)))
17478 (setq h (min 24 (max 0 h)))
17479 (setq ng 1 new (format "-%02d:%02d" h m)))
17480 ((org-pos-in-match-range pos 6)
17481 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17482 ((org-pos-in-match-range pos 5)
17483 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17485 ((org-pos-in-match-range pos 9)
17486 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17487 ((org-pos-in-match-range pos 8)
17488 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17490 (when ng
17491 (setq s (concat
17492 (substring s 0 (match-beginning ng))
17493 new
17494 (substring s (match-end ng))))))
17495 s))
17497 (defun org-recenter-calendar (date)
17498 "If the calendar is visible, recenter it to DATE."
17499 (let ((cwin (get-buffer-window "*Calendar*" t)))
17500 (when cwin
17501 (let ((calendar-move-hook nil))
17502 (with-selected-window cwin
17503 (calendar-goto-date (if (listp date) date
17504 (calendar-gregorian-from-absolute date))))))))
17506 (defun org-goto-calendar (&optional arg)
17507 "Go to the Emacs calendar at the current date.
17508 If there is a time stamp in the current line, go to that date.
17509 A prefix ARG can be used to force the current date."
17510 (interactive "P")
17511 (let ((tsr org-ts-regexp) diff
17512 (calendar-move-hook nil)
17513 (calendar-view-holidays-initially-flag nil)
17514 (calendar-view-diary-initially-flag nil))
17515 (if (or (org-at-timestamp-p)
17516 (save-excursion
17517 (beginning-of-line 1)
17518 (looking-at (concat ".*" tsr))))
17519 (let ((d1 (time-to-days (current-time)))
17520 (d2 (time-to-days
17521 (org-time-string-to-time (match-string 1)))))
17522 (setq diff (- d2 d1))))
17523 (calendar)
17524 (calendar-goto-today)
17525 (if (and diff (not arg)) (calendar-forward-day diff))))
17527 (defun org-get-date-from-calendar ()
17528 "Return a list (month day year) of date at point in calendar."
17529 (with-current-buffer "*Calendar*"
17530 (save-match-data
17531 (calendar-cursor-to-date))))
17533 (defun org-date-from-calendar ()
17534 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17535 If there is already a time stamp at the cursor position, update it."
17536 (interactive)
17537 (if (org-at-timestamp-p t)
17538 (org-timestamp-change 0 'calendar)
17539 (let ((cal-date (org-get-date-from-calendar)))
17540 (org-insert-time-stamp
17541 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17543 (defcustom org-effort-durations
17544 `(("h" . 60)
17545 ("d" . ,(* 60 8))
17546 ("w" . ,(* 60 8 5))
17547 ("m" . ,(* 60 8 5 4))
17548 ("y" . ,(* 60 8 5 40)))
17549 "Conversion factor to minutes for an effort modifier.
17551 Each entry has the form (MODIFIER . MINUTES).
17553 In an effort string, a number followed by MODIFIER is multiplied
17554 by the specified number of MINUTES to obtain an effort in
17555 minutes.
17559 :group 'org-agenda
17560 :version "24.1"
17561 :type '(alist :key-type (string :tag "Modifier")
17562 :value-type (number :tag "Minutes")))
17564 (defun org-minutes-to-clocksum-string (m)
17565 "Format number of minutes as a clocksum string.
17566 The format is determined by `org-time-clocksum-format',
17567 `org-time-clocksum-use-fractional' and
17568 `org-time-clocksum-fractional-format' and
17569 `org-time-clocksum-use-effort-durations'."
17570 (let ((clocksum "")
17571 (m (round m)) ; Don't allow fractions of minutes
17572 h d w mo y fmt n)
17573 (setq h (if org-time-clocksum-use-effort-durations
17574 (cdr (assoc "h" org-effort-durations)) 60)
17575 d (if org-time-clocksum-use-effort-durations
17576 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17577 w (if org-time-clocksum-use-effort-durations
17578 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17579 mo (if org-time-clocksum-use-effort-durations
17580 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17581 y (if org-time-clocksum-use-effort-durations
17582 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17583 ;; fractional format
17584 (if org-time-clocksum-use-fractional
17585 (cond
17586 ;; single format string
17587 ((stringp org-time-clocksum-fractional-format)
17588 (format org-time-clocksum-fractional-format (/ m (float h))))
17589 ;; choice of fractional formats for different time units
17590 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17591 (> (/ (truncate m) (* y d h)) 0))
17592 (format fmt (/ m (* y d (float h)))))
17593 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17594 (> (/ (truncate m) (* mo d h)) 0))
17595 (format fmt (/ m (* mo d (float h)))))
17596 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17597 (> (/ (truncate m) (* w d h)) 0))
17598 (format fmt (/ m (* w d (float h)))))
17599 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17600 (> (/ (truncate m) (* d h)) 0))
17601 (format fmt (/ m (* d (float h)))))
17602 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17603 (> (/ (truncate m) h) 0))
17604 (format fmt (/ m (float h))))
17605 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17606 (format fmt m))
17607 ;; fall back to smallest time unit with a format
17608 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17609 (format fmt (/ m (float h))))
17610 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17611 (format fmt (/ m (* d (float h)))))
17612 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17613 (format fmt (/ m (* w d (float h)))))
17614 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17615 (format fmt (/ m (* mo d (float h)))))
17616 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17617 (format fmt (/ m (* y d (float h))))))
17618 ;; standard (non-fractional) format, with single format string
17619 (if (stringp org-time-clocksum-format)
17620 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17621 ;; separate formats components
17622 (and (setq fmt (plist-get org-time-clocksum-format :years))
17623 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17624 (plist-get org-time-clocksum-format :require-years))
17625 (setq clocksum (concat clocksum (format fmt n))
17626 m (- m (* n y d h))))
17627 (and (setq fmt (plist-get org-time-clocksum-format :months))
17628 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17629 (plist-get org-time-clocksum-format :require-months))
17630 (setq clocksum (concat clocksum (format fmt n))
17631 m (- m (* n mo d h))))
17632 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17633 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17634 (plist-get org-time-clocksum-format :require-weeks))
17635 (setq clocksum (concat clocksum (format fmt n))
17636 m (- m (* n w d h))))
17637 (and (setq fmt (plist-get org-time-clocksum-format :days))
17638 (or (> (setq n (/ (truncate m) (* d h))) 0)
17639 (plist-get org-time-clocksum-format :require-days))
17640 (setq clocksum (concat clocksum (format fmt n))
17641 m (- m (* n d h))))
17642 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17643 (or (> (setq n (/ (truncate m) h)) 0)
17644 (plist-get org-time-clocksum-format :require-hours))
17645 (setq clocksum (concat clocksum (format fmt n))
17646 m (- m (* n h))))
17647 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17648 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17649 (setq clocksum (concat clocksum (format fmt m))))
17650 ;; return formatted time duration
17651 clocksum))))
17653 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17654 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17655 "Org mode version 8.0")
17657 (defun org-hours-to-clocksum-string (n)
17658 (org-minutes-to-clocksum-string (* n 60)))
17660 (defun org-hh:mm-string-to-minutes (s)
17661 "Convert a string H:MM to a number of minutes.
17662 If the string is just a number, interpret it as minutes.
17663 In fact, the first hh:mm or number in the string will be taken,
17664 there can be extra stuff in the string.
17665 If no number is found, the return value is 0."
17666 (cond
17667 ((integerp s) s)
17669 (+ (* (string-to-number (match-string 1 s)) 60)
17670 (string-to-number (match-string 2 s))))
17672 (string-to-number (match-string 1 s)))
17673 (t 0)))
17675 (defcustom org-image-actual-width t
17676 "Should we use the actual width of images when inlining them?
17678 When set to `t', always use the image width.
17680 When set to a number, use imagemagick (when available) to set
17681 the image's width to this value.
17683 When set to a number in a list, try to get the width from any
17684 #+ATTR.* keyword if it matches a width specification like
17686 #+ATTR_HTML: :width 300px
17688 and fall back on that number if none is found.
17690 When set to nil, try to get the width from an #+ATTR.* keyword
17691 and fall back on the original width if none is found.
17693 This requires Emacs >= 24.1, build with imagemagick support."
17694 :group 'org-appearance
17695 :version "24.4"
17696 :package-version '(Org . "8.0")
17697 :type '(choice
17698 (const :tag "Use the image width" t)
17699 (integer :tag "Use a number of pixels")
17700 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17701 (const :tag "Use #+ATTR* or don't resize" nil)))
17703 (defcustom org-agenda-inhibit-startup nil
17704 "Inhibit startup when preparing agenda buffers.
17705 When this variable is `t' (the default), the initialization of
17706 the Org agenda buffers is inhibited: e.g. the visibility state
17707 is not set, the tables are not re-aligned, etc."
17708 :type 'boolean
17709 :version "24.3"
17710 :group 'org-agenda)
17712 (defcustom org-agenda-ignore-drawer-properties nil
17713 "Avoid updating text properties when building the agenda.
17714 Properties are used to prepare buffers for effort estimates, appointments,
17715 and subtree-local categories.
17716 If you don't use these in the agenda, you can add them to this list and
17717 agenda building will be a bit faster.
17718 The value is a list, with zero or more of the symbols `effort', `appt',
17719 or `category'."
17720 :type '(set :greedy t
17721 (const effort)
17722 (const appt)
17723 (const category))
17724 :version "24.3"
17725 :group 'org-agenda)
17727 (defun org-duration-string-to-minutes (s &optional output-to-string)
17728 "Convert a duration string S to minutes.
17730 A bare number is interpreted as minutes, modifiers can be set by
17731 customizing `org-effort-durations' (which see).
17733 Entries containing a colon are interpreted as H:MM by
17734 `org-hh:mm-string-to-minutes'."
17735 (let ((result 0)
17737 (regexp-opt (mapcar 'car org-effort-durations))
17739 (while (string-match re s)
17740 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17741 (string-to-number (match-string 1 s))))
17742 (setq s (replace-match "" nil t s)))
17743 (setq result (floor result))
17744 (incf result (org-hh:mm-string-to-minutes s))
17745 (if output-to-string (number-to-string result) result)))
17747 ;;;; Files
17749 (defun org-save-all-org-buffers ()
17750 "Save all Org-mode buffers without user confirmation."
17751 (interactive)
17752 (message "Saving all Org-mode buffers...")
17753 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17754 (when (featurep 'org-id) (org-id-locations-save))
17755 (message "Saving all Org-mode buffers... done"))
17757 (defun org-revert-all-org-buffers ()
17758 "Revert all Org-mode buffers.
17759 Prompt for confirmation when there are unsaved changes.
17760 Be sure you know what you are doing before letting this function
17761 overwrite your changes.
17763 This function is useful in a setup where one tracks org files
17764 with a version control system, to revert on one machine after pulling
17765 changes from another. I believe the procedure must be like this:
17767 1. M-x org-save-all-org-buffers
17768 2. Pull changes from the other machine, resolve conflicts
17769 3. M-x org-revert-all-org-buffers"
17770 (interactive)
17771 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17772 (user-error "Abort"))
17773 (save-excursion
17774 (save-window-excursion
17775 (mapc
17776 (lambda (b)
17777 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17778 (with-current-buffer b buffer-file-name))
17779 (org-pop-to-buffer-same-window b)
17780 (revert-buffer t 'no-confirm)))
17781 (buffer-list))
17782 (when (and (featurep 'org-id) org-id-track-globally)
17783 (org-id-locations-load)))))
17785 ;;;; Agenda files
17787 ;;;###autoload
17788 (defun org-switchb (&optional arg)
17789 "Switch between Org buffers.
17790 With one prefix argument, restrict available buffers to files.
17791 With two prefix arguments, restrict available buffers to agenda files.
17793 Defaults to `iswitchb' for buffer name completion.
17794 Set `org-completion-use-ido' to make it use ido instead."
17795 (interactive "P")
17796 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17797 ((equal arg '(16)) (org-buffer-list 'agenda))
17798 (t (org-buffer-list))))
17799 (org-completion-use-iswitchb org-completion-use-iswitchb)
17800 (org-completion-use-ido org-completion-use-ido))
17801 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17802 (setq org-completion-use-iswitchb t))
17803 (org-pop-to-buffer-same-window
17804 (org-icompleting-read "Org buffer: "
17805 (mapcar 'list (mapcar 'buffer-name blist))
17806 nil t))))
17808 ;;; Define some older names previously used for this functionality
17809 ;;;###autoload
17810 (defalias 'org-ido-switchb 'org-switchb)
17811 ;;;###autoload
17812 (defalias 'org-iswitchb 'org-switchb)
17814 (defun org-buffer-list (&optional predicate exclude-tmp)
17815 "Return a list of Org buffers.
17816 PREDICATE can be `export', `files' or `agenda'.
17818 export restrict the list to Export buffers.
17819 files restrict the list to buffers visiting Org files.
17820 agenda restrict the list to buffers visiting agenda files.
17822 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17823 (let* ((bfn nil)
17824 (agenda-files (and (eq predicate 'agenda)
17825 (mapcar 'file-truename (org-agenda-files t))))
17826 (filter
17827 (cond
17828 ((eq predicate 'files)
17829 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17830 ((eq predicate 'export)
17831 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17832 ((eq predicate 'agenda)
17833 (lambda (b)
17834 (with-current-buffer b
17835 (and (derived-mode-p 'org-mode)
17836 (setq bfn (buffer-file-name b))
17837 (member (file-truename bfn) agenda-files)))))
17838 (t (lambda (b) (with-current-buffer b
17839 (or (derived-mode-p 'org-mode)
17840 (string-match "\*Org .*Export"
17841 (buffer-name b)))))))))
17842 (delq nil
17843 (mapcar
17844 (lambda(b)
17845 (if (and (funcall filter b)
17846 (or (not exclude-tmp)
17847 (not (string-match "tmp" (buffer-name b)))))
17848 b
17849 nil))
17850 (buffer-list)))))
17852 (defun org-agenda-files (&optional unrestricted archives)
17853 "Get the list of agenda files.
17854 Optional UNRESTRICTED means return the full list even if a restriction
17855 is currently in place.
17856 When ARCHIVES is t, include all archive files that are really being
17857 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17858 `org-agenda-archives-mode' is t."
17859 (let ((files
17860 (cond
17861 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17862 ((stringp org-agenda-files) (org-read-agenda-file-list))
17863 ((listp org-agenda-files) org-agenda-files)
17864 (t (error "Invalid value of `org-agenda-files'")))))
17865 (setq files (apply 'append
17866 (mapcar (lambda (f)
17867 (if (file-directory-p f)
17868 (directory-files
17869 f t org-agenda-file-regexp)
17870 (list f)))
17871 files)))
17872 (when org-agenda-skip-unavailable-files
17873 (setq files (delq nil
17874 (mapcar (function
17875 (lambda (file)
17876 (and (file-readable-p file) file)))
17877 files))))
17878 (when (or (eq archives t)
17879 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17880 (setq files (org-add-archive-files files)))
17881 files))
17883 (defun org-agenda-file-p (&optional file)
17884 "Return non-nil, if FILE is an agenda file.
17885 If FILE is omitted, use the file associated with the current
17886 buffer."
17887 (member (or file (buffer-file-name))
17888 (org-agenda-files t)))
17890 (defun org-edit-agenda-file-list ()
17891 "Edit the list of agenda files.
17892 Depending on setup, this either uses customize to edit the variable
17893 `org-agenda-files', or it visits the file that is holding the list. In the
17894 latter case, the buffer is set up in a way that saving it automatically kills
17895 the buffer and restores the previous window configuration."
17896 (interactive)
17897 (if (stringp org-agenda-files)
17898 (let ((cw (current-window-configuration)))
17899 (find-file org-agenda-files)
17900 (org-set-local 'org-window-configuration cw)
17901 (org-add-hook 'after-save-hook
17902 (lambda ()
17903 (set-window-configuration
17904 (prog1 org-window-configuration
17905 (kill-buffer (current-buffer))))
17906 (org-install-agenda-files-menu)
17907 (message "New agenda file list installed"))
17908 nil 'local)
17909 (message "%s" (substitute-command-keys
17911 (customize-variable 'org-agenda-files)))
17913 (defun org-store-new-agenda-file-list (list)
17914 "Set new value for the agenda file list and save it correctly."
17915 (if (stringp org-agenda-files)
17916 (let ((fe (org-read-agenda-file-list t)) b u)
17917 (while (setq b (find-buffer-visiting org-agenda-files))
17918 (kill-buffer b))
17919 (with-temp-file org-agenda-files
17920 (insert
17921 (mapconcat
17922 (lambda (f) ;; Keep un-expanded entries.
17923 (if (setq u (assoc f fe))
17924 (cdr u)
17925 f))
17928 (let ((org-mode-hook nil) (org-inhibit-startup t)
17929 (org-insert-mode-line-in-empty-file nil))
17930 (setq org-agenda-files list)
17931 (customize-save-variable 'org-agenda-files org-agenda-files))))
17933 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17934 "Read the list of agenda files from a file.
17935 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17936 filenames, used by `org-store-new-agenda-file-list' to write back
17937 un-expanded file names."
17938 (when (file-directory-p org-agenda-files)
17939 (error "`org-agenda-files' cannot be a single directory"))
17940 (when (stringp org-agenda-files)
17941 (with-temp-buffer
17942 (insert-file-contents org-agenda-files)
17943 (mapcar
17944 (lambda (f)
17945 (let ((e (expand-file-name (substitute-in-file-name f)
17946 org-directory)))
17947 (if pair-with-expansion
17948 (cons e f)
17949 e)))
17952 ;;;###autoload
17953 (defun org-cycle-agenda-files ()
17954 "Cycle through the files in `org-agenda-files'.
17955 If the current buffer visits an agenda file, find the next one in the list.
17956 If the current buffer does not, find the first agenda file."
17957 (interactive)
17958 (let* ((fs (org-agenda-files t))
17959 (files (append fs (list (car fs))))
17960 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17961 file)
17962 (unless files (user-error "No agenda files"))
17963 (catch 'exit
17964 (while (setq file (pop files))
17965 (if (equal (file-truename file) tcf)
17966 (when (car files)
17967 (find-file (car files))
17968 (throw 'exit t))))
17969 (find-file (car fs)))
17970 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17972 (defun org-agenda-file-to-front (&optional to-end)
17973 "Move/add the current file to the top of the agenda file list.
17974 If the file is not present in the list, it is added to the front. If it is
17975 present, it is moved there. With optional argument TO-END, add/move to the
17976 end of the list."
17977 (interactive "P")
17978 (let ((org-agenda-skip-unavailable-files nil)
17979 (file-alist (mapcar (lambda (x)
17980 (cons (file-truename x) x))
17981 (org-agenda-files t)))
17982 (ctf (file-truename
17983 (or buffer-file-name
17984 (user-error "Please save the current buffer to a file"))))
17985 x had)
17986 (setq x (assoc ctf file-alist) had x)
17988 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17989 (if to-end
17990 (setq file-alist (append (delq x file-alist) (list x)))
17991 (setq file-alist (cons x (delq x file-alist))))
17992 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17993 (org-install-agenda-files-menu)
17994 (message "File %s to %s of agenda file list"
17995 (if had "moved" "added") (if to-end "end" "front"))))
17997 (defun org-remove-file (&optional file)
17998 "Remove current file from the list of files in variable `org-agenda-files'.
17999 These are the files which are being checked for agenda entries.
18000 Optional argument FILE means use this file instead of the current."
18001 (interactive)
18002 (let* ((org-agenda-skip-unavailable-files nil)
18003 (file (or file buffer-file-name
18004 (user-error "Current buffer does not visit a file")))
18005 (true-file (file-truename file))
18006 (afile (abbreviate-file-name file))
18007 (files (delq nil (mapcar
18008 (lambda (x)
18009 (if (equal true-file
18010 (file-truename x))
18011 nil x))
18012 (org-agenda-files t)))))
18013 (if (not (= (length files) (length (org-agenda-files t))))
18014 (progn
18015 (org-store-new-agenda-file-list files)
18016 (org-install-agenda-files-menu)
18017 (message "Removed file: %s" afile))
18018 (message "File was not in list: %s (not removed)" afile))))
18020 (defun org-file-menu-entry (file)
18021 (vector file (list 'find-file file) t))
18023 (defun org-check-agenda-file (file)
18024 "Make sure FILE exists. If not, ask user what to do."
18025 (when (not (file-exists-p file))
18026 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18027 (abbreviate-file-name file))
18028 (let ((r (downcase (read-char-exclusive))))
18029 (cond
18030 ((equal r ?r)
18031 (org-remove-file file)
18032 (throw 'nextfile t))
18033 (t (error "Abort"))))))
18035 (defun org-get-agenda-file-buffer (file)
18036 "Get a buffer visiting FILE. If the buffer needs to be created, add
18037 it to the list of buffers which might be released later."
18038 (let ((buf (org-find-base-buffer-visiting file)))
18039 (if buf
18040 buf ; just return it
18041 ;; Make a new buffer and remember it
18042 (setq buf (find-file-noselect file))
18043 (if buf (push buf org-agenda-new-buffers))
18044 buf)))
18046 (defun org-release-buffers (blist)
18047 "Release all buffers in list, asking the user for confirmation when needed.
18048 When a buffer is unmodified, it is just killed. When modified, it is saved
18049 \(if the user agrees) and then killed."
18050 (let (buf file)
18051 (while (setq buf (pop blist))
18052 (setq file (buffer-file-name buf))
18053 (when (and (buffer-modified-p buf)
18054 file
18055 (y-or-n-p (format "Save file %s? " file)))
18056 (with-current-buffer buf (save-buffer)))
18057 (kill-buffer buf))))
18059 (defun org-agenda-prepare-buffers (files)
18060 "Create buffers for all agenda files, protect archived trees and comments."
18061 (interactive)
18062 (let ((pa '(:org-archived t))
18063 (pc '(:org-comment t))
18064 (pall '(:org-archived t :org-comment t))
18065 (inhibit-read-only t)
18066 (org-inhibit-startup org-agenda-inhibit-startup)
18067 (rea (concat ":" org-archive-tag ":"))
18068 file re pos)
18069 (setq org-tag-alist-for-agenda nil
18070 org-tag-groups-alist-for-agenda nil)
18071 (save-window-excursion
18072 (save-restriction
18073 (while (setq file (pop files))
18074 (catch 'nextfile
18075 (if (bufferp file)
18076 (set-buffer file)
18077 (org-check-agenda-file file)
18078 (set-buffer (org-get-agenda-file-buffer file)))
18079 (widen)
18080 (org-set-regexps-and-options-for-tags)
18081 (setq pos (point))
18082 (goto-char (point-min))
18083 (let ((case-fold-search t))
18084 (when (search-forward "#+setupfile" nil t)
18085 ;; Don't set all regexps and options systematically as
18086 ;; this is only run for setting agenda tags from setup
18087 ;; file
18088 (org-set-regexps-and-options)))
18089 (or (memq 'category org-agenda-ignore-drawer-properties)
18090 (org-refresh-category-properties))
18091 (or (memq 'effort org-agenda-ignore-drawer-properties)
18092 (org-refresh-properties org-effort-property 'org-effort))
18093 (or (memq 'appt org-agenda-ignore-drawer-properties)
18094 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18095 (setq org-todo-keywords-for-agenda
18096 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18097 (setq org-done-keywords-for-agenda
18098 (append org-done-keywords-for-agenda org-done-keywords))
18099 (setq org-todo-keyword-alist-for-agenda
18100 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18101 (setq org-drawers-for-agenda
18102 (append org-drawers-for-agenda org-drawers))
18103 (setq org-tag-alist-for-agenda
18104 (org-uniquify
18105 (append org-tag-alist-for-agenda
18106 org-tag-alist
18107 org-tag-persistent-alist)))
18108 (if org-group-tags
18109 (setq org-tag-groups-alist-for-agenda
18110 (org-uniquify-alist
18111 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18112 (org-with-silent-modifications
18113 (save-excursion
18114 (remove-text-properties (point-min) (point-max) pall)
18115 (when org-agenda-skip-archived-trees
18116 (goto-char (point-min))
18117 (while (re-search-forward rea nil t)
18118 (if (org-at-heading-p t)
18119 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18120 (goto-char (point-min))
18121 (setq re (format org-heading-keyword-regexp-format
18122 org-comment-string))
18123 (while (re-search-forward re nil t)
18124 (add-text-properties
18125 (match-beginning 0) (org-end-of-subtree t) pc))))
18126 (goto-char pos)))))
18127 (setq org-todo-keywords-for-agenda
18128 (org-uniquify org-todo-keywords-for-agenda))
18129 (setq org-todo-keyword-alist-for-agenda
18130 (org-uniquify org-todo-keyword-alist-for-agenda))))
18132 \f
18133 ;;;; CDLaTeX minor mode
18135 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18136 "Keymap for the minor `org-cdlatex-mode'.")
18138 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18139 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18140 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18141 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18142 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18144 (defvar org-cdlatex-texmathp-advice-is-done nil
18145 "Flag remembering if we have applied the advice to texmathp already.")
18147 (define-minor-mode org-cdlatex-mode
18148 "Toggle the minor `org-cdlatex-mode'.
18149 This mode supports entering LaTeX environment and math in LaTeX fragments
18150 in Org-mode.
18152 nil " OCDL" nil
18153 (when org-cdlatex-mode
18154 (require 'cdlatex)
18155 (run-hooks 'cdlatex-mode-hook)
18156 (cdlatex-compute-tables))
18157 (unless org-cdlatex-texmathp-advice-is-done
18158 (setq org-cdlatex-texmathp-advice-is-done t)
18159 (defadvice texmathp (around org-math-always-on activate)
18160 "Always return t in org-mode buffers.
18161 This is because we want to insert math symbols without dollars even outside
18162 the LaTeX math segments. If Orgmode thinks that point is actually inside
18163 an embedded LaTeX fragment, let texmathp do its job.
18165 (interactive)
18166 (let (p)
18167 (cond
18168 ((not (derived-mode-p 'org-mode)) ad-do-it)
18169 ((eq this-command 'cdlatex-math-symbol)
18170 (setq ad-return-value t
18171 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18172 (t
18173 (let ((p (org-inside-LaTeX-fragment-p)))
18174 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18175 (setq ad-return-value t
18176 texmathp-why '("Org-mode embedded math" . 0))
18177 (if p ad-do-it)))))))))
18179 (defun turn-on-org-cdlatex ()
18180 "Unconditionally turn on `org-cdlatex-mode'."
18181 (org-cdlatex-mode 1))
18183 (defun org-try-cdlatex-tab ()
18184 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18185 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18186 - inside a LaTeX fragment, or
18187 - after the first word in a line, where an abbreviation expansion could
18188 insert a LaTeX environment."
18189 (when org-cdlatex-mode
18190 (cond
18191 ;; Before any word on the line: No expansion possible.
18193 ;; Just after first word on the line: Expand it. Make sure it
18194 ;; cannot happen on headlines, though.
18195 ((save-excursion
18196 (skip-chars-backward "a-zA-Z0-9*")
18198 (and (bolp) (not (org-at-heading-p))))
18199 (cdlatex-tab) t)
18200 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18202 (defun org-cdlatex-underscore-caret (&optional arg)
18203 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18204 Revert to the normal definition outside of these fragments."
18205 (interactive "P")
18206 (if (org-inside-LaTeX-fragment-p)
18207 (call-interactively 'cdlatex-sub-superscript)
18208 (let (org-cdlatex-mode)
18209 (call-interactively (key-binding (vector last-input-event))))))
18211 (defun org-cdlatex-math-modify (&optional arg)
18212 "Execute `cdlatex-math-modify' in LaTeX fragments.
18213 Revert to the normal definition outside of these fragments."
18214 (interactive "P")
18215 (if (org-inside-LaTeX-fragment-p)
18216 (call-interactively 'cdlatex-math-modify)
18217 (let (org-cdlatex-mode)
18218 (call-interactively (key-binding (vector last-input-event))))))
18221 \f
18222 ;;;; LaTeX fragments
18224 (defvar org-latex-regexps
18226 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18229 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18233 "Regular expressions for matching embedded LaTeX.")
18235 (defun org-inside-LaTeX-fragment-p ()
18236 "Test if point is inside a LaTeX fragment.
18238 sequence appearing also before point.
18239 Even though the matchers for math are configurable, this function assumes
18241 delimiters are skipped when they have been removed by customization.
18242 The return value is nil, or a cons cell with the delimiter and the
18243 position of this delimiter.
18245 This function does a reasonably good job, but can locally be fooled by
18246 for example currency specifications. For example it will assume being in
18248 fragments that are properly closed, but during editing, we have to live
18249 with the uncertainty caused by missing closing delimiters. This function
18250 looks only before point, not after."
18251 (catch 'exit
18252 (let ((pos (point))
18253 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18254 (lim (progn
18256 (point)))
18257 dd-on str (start 0) m re)
18258 (goto-char pos)
18259 (when dodollar
18261 re (nth 1 (assoc "$" org-latex-regexps)))
18262 (while (string-match re str start)
18263 (cond
18264 ((= (match-end 0) (length str))
18265 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18266 ((= (match-end 0) (- (length str) 5))
18267 (throw 'exit nil))
18268 (t (setq start (match-end 0))))))
18269 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18270 (goto-char pos)
18271 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18272 (and (match-beginning 2) (throw 'exit nil))
18273 ;; count $$
18275 (setq dd-on (not dd-on)))
18276 (goto-char pos)
18277 (if dd-on (cons "$$" m))))))
18279 (defun org-inside-latex-macro-p ()
18280 "Is point inside a LaTeX macro or its arguments?"
18281 (save-match-data
18282 (org-in-regexp
18285 (defvar org-latex-fragment-image-overlays nil
18286 "List of overlays carrying the images of latex fragments.")
18287 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18289 (defun org-remove-latex-fragment-image-overlays ()
18290 "Remove all overlays with LaTeX fragment images in current buffer."
18291 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18292 (setq org-latex-fragment-image-overlays nil))
18294 (defun org-preview-latex-fragment (&optional subtree)
18295 "Preview the LaTeX fragment at point, or all locally or globally.
18296 If the cursor is in a LaTeX fragment, create the image and overlay
18297 it over the source code. If there is no fragment at point, display
18298 all fragments in the current text, from one headline to the next. With
18299 prefix SUBTREE, display all fragments in the current subtree. With a
18301 the cursor is before the first headline,
18302 display all fragments in the buffer.
18304 (interactive "P")
18305 (unless buffer-file-name
18306 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18307 (when (display-graphic-p)
18308 (org-remove-latex-fragment-image-overlays)
18309 (save-excursion
18310 (save-restriction
18311 (let (beg end at msg)
18312 (cond
18313 ((or (equal subtree '(16))
18314 (not (save-excursion
18315 (re-search-backward org-outline-regexp-bol nil t))))
18316 (setq beg (point-min) end (point-max)
18317 msg "Creating images for buffer...%s"))
18318 ((equal subtree '(4))
18319 (org-back-to-heading)
18320 (setq beg (point) end (org-end-of-subtree t)
18321 msg "Creating images for subtree...%s"))
18322 (t
18323 (if (setq at (org-inside-LaTeX-fragment-p))
18324 (goto-char (max (point-min) (- (cdr at) 2)))
18325 (org-back-to-heading))
18326 (setq beg (point) end (progn (outline-next-heading) (point))
18327 msg (if at "Creating image...%s"
18328 "Creating images for entry...%s"))))
18329 (message msg "")
18330 (narrow-to-region beg end)
18331 (goto-char beg)
18332 (org-format-latex
18333 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18334 (file-name-nondirectory
18335 buffer-file-name)))
18336 default-directory 'overlays msg at 'forbuffer
18337 org-latex-create-formula-image-program)
18338 (message msg "done. Use `C-c C-c' to remove images."))))))
18340 (defun org-format-latex (prefix &optional dir overlays msg at
18341 forbuffer processing-type)
18342 "Replace LaTeX fragments with links to an image, and produce images.
18343 Some of the options can be changed using the variable
18344 `org-format-latex-options'."
18345 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18346 (let* ((prefixnodir (file-name-nondirectory prefix))
18347 (absprefix (expand-file-name prefix dir))
18348 (todir (file-name-directory absprefix))
18349 (opt org-format-latex-options)
18350 (optnew org-format-latex-options)
18351 (matchers (plist-get opt :matchers))
18352 (re-list org-latex-regexps)
18353 (cnt 0) txt hash link beg end re e checkdir
18354 string
18355 m n block-type block linkfile movefile ov)
18356 ;; Check the different regular expressions
18357 (while (setq e (pop re-list))
18358 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18360 (when (member m matchers)
18361 (goto-char (point-min))
18362 (while (re-search-forward re nil t)
18363 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18364 (or (not overlays)
18365 (not (eq (get-char-property (match-beginning n)
18366 'org-overlay-type)
18367 'org-latex-overlay))))
18368 (cond
18369 ((eq processing-type 'verbatim))
18370 ((eq processing-type 'mathjax)
18371 ;; Prepare for MathJax processing.
18372 (setq string (match-string n))
18373 (when (member m '("$" "$1"))
18374 (save-excursion
18375 (delete-region (match-beginning n) (match-end n))
18376 (goto-char (match-beginning n))
18378 ((or (eq processing-type 'dvipng)
18379 (eq processing-type 'imagemagick))
18380 ;; Process to an image.
18381 (setq txt (match-string n)
18382 beg (match-beginning n) end (match-end n)
18383 cnt (1+ cnt))
18384 (let ((face (face-at-point))
18385 (fg (plist-get opt :foreground))
18386 (bg (plist-get opt :background))
18387 ;; Ensure full list is printed.
18388 print-length print-level)
18389 (when forbuffer
18390 ;; Get the colors from the face at point.
18391 (goto-char beg)
18392 (when (eq fg 'auto)
18393 (setq fg (face-attribute face :foreground nil 'default)))
18394 (when (eq bg 'auto)
18395 (setq bg (face-attribute face :background nil 'default)))
18396 (setq optnew (copy-sequence opt))
18397 (plist-put optnew :foreground fg)
18398 (plist-put optnew :background bg))
18399 (setq hash (sha1 (prin1-to-string
18400 (list org-format-latex-header
18401 org-latex-default-packages-alist
18402 org-latex-packages-alist
18403 org-format-latex-options
18404 forbuffer txt fg bg)))
18405 linkfile (format "%s_%s.png" prefix hash)
18406 movefile (format "%s_%s.png" absprefix hash)))
18407 (setq link (concat block "[[file:" linkfile "]]" block))
18408 (if msg (message msg cnt))
18409 (goto-char beg)
18410 (unless checkdir ; Ensure the directory exists.
18411 (setq checkdir t)
18412 (or (file-directory-p todir) (make-directory todir t)))
18413 (unless (file-exists-p movefile)
18414 (org-create-formula-image
18415 txt movefile optnew forbuffer processing-type))
18416 (if overlays
18417 (progn
18418 (mapc (lambda (o)
18419 (if (eq (overlay-get o 'org-overlay-type)
18420 'org-latex-overlay)
18421 (delete-overlay o)))
18422 (overlays-in beg end))
18423 (setq ov (make-overlay beg end))
18424 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18425 (if (featurep 'xemacs)
18426 (progn
18427 (overlay-put ov 'invisible t)
18428 (overlay-put
18429 ov 'end-glyph
18430 (make-glyph (vector 'png :file movefile))))
18431 (overlay-put
18432 ov 'display
18433 (list 'image :type 'png :file movefile :ascent 'center)))
18434 (push ov org-latex-fragment-image-overlays)
18435 (goto-char end))
18436 (delete-region beg end)
18437 (insert (org-add-props link
18438 (list 'org-latex-src
18439 (replace-regexp-in-string
18441 'org-latex-src-embed-type
18442 (if block-type 'paragraph 'character))))))
18443 ((eq processing-type 'mathml)
18444 ;; Process to MathML
18445 (unless (save-match-data (org-format-latex-mathml-available-p))
18446 (user-error "LaTeX to MathML converter not configured"))
18447 (setq txt (match-string n)
18448 beg (match-beginning n) end (match-end n)
18449 cnt (1+ cnt))
18450 (if msg (message msg cnt))
18451 (goto-char beg)
18452 (delete-region beg end)
18453 (insert (org-format-latex-as-mathml
18454 txt block-type prefix dir)))
18455 (t
18456 (error "Unknown conversion type %s for LaTeX fragments"
18457 processing-type)))))))))
18459 (defun org-create-math-formula (latex-frag &optional mathml-file)
18460 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18461 Use `org-latex-to-mathml-convert-command'. If the conversion is
18463 elements otherwise return nil. When MATHML-FILE is specified,
18464 write the results in to that file. When invoked as an
18465 interactive command, prompt for LATEX-FRAG, with initial value
18466 set to the current active region and echo the results for user
18467 inspection."
18468 (interactive (list (let ((frag (when (org-region-active-p)
18469 (buffer-substring-no-properties
18470 (region-beginning) (region-end)))))
18471 (read-string "LaTeX Fragment: " frag nil frag))))
18472 (unless latex-frag (error "Invalid LaTeX fragment"))
18473 (let* ((tmp-in-file (file-relative-name
18474 (make-temp-name (expand-file-name "ltxmathml-in"))))
18475 (ignore (write-region latex-frag nil tmp-in-file))
18476 (tmp-out-file (file-relative-name
18477 (make-temp-name (expand-file-name "ltxmathml-out"))))
18478 (cmd (format-spec
18479 org-latex-to-mathml-convert-command
18480 `((?j . ,(shell-quote-argument
18481 (expand-file-name org-latex-to-mathml-jar-file)))
18482 (?I . ,(shell-quote-argument tmp-in-file))
18483 (?o . ,(shell-quote-argument tmp-out-file)))))
18484 mathml shell-command-output)
18485 (when (org-called-interactively-p 'any)
18486 (unless (org-format-latex-mathml-available-p)
18487 (user-error "LaTeX to MathML converter not configured")))
18488 (message "Running %s" cmd)
18489 (setq shell-command-output (shell-command-to-string cmd))
18490 (setq mathml
18491 (when (file-readable-p tmp-out-file)
18492 (with-current-buffer (find-file-noselect tmp-out-file t)
18493 (goto-char (point-min))
18494 (when (re-search-forward
18495 (concat
18496 (regexp-quote
18499 (regexp-quote "</math>")) nil t)
18500 (prog1 (match-string 0) (kill-buffer))))))
18501 (cond
18502 (mathml
18503 (setq mathml
18505 (when mathml-file
18506 (write-region mathml nil mathml-file))
18507 (when (org-called-interactively-p 'any)
18508 (message mathml)))
18509 ((message "LaTeX to MathML conversion failed")
18510 (message shell-command-output)))
18511 (delete-file tmp-in-file)
18512 (when (file-exists-p tmp-out-file)
18513 (delete-file tmp-out-file))
18514 mathml))
18516 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18517 prefix &optional dir)
18518 "Use `org-create-math-formula' but check local cache first."
18519 (let* ((absprefix (expand-file-name prefix dir))
18520 (print-length nil) (print-level nil)
18521 (formula-id (concat
18522 "formula-"
18523 (sha1
18524 (prin1-to-string
18525 (list latex-frag
18526 org-latex-to-mathml-convert-command)))))
18527 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18528 (formula-cache-dir (file-name-directory formula-cache)))
18530 (unless (file-directory-p formula-cache-dir)
18531 (make-directory formula-cache-dir t))
18533 (unless (file-exists-p formula-cache)
18534 (org-create-math-formula latex-frag formula-cache))
18536 (if (file-exists-p formula-cache)
18537 ;; Successful conversion. Return the link to MathML file.
18538 (org-add-props
18539 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18541 'org-latex-src-embed-type (if latex-frag-type
18542 'paragraph 'character)))
18543 ;; Failed conversion. Return the LaTeX fragment verbatim
18544 latex-frag)))
18546 (defun org-create-formula-image (string tofile options buffer &optional type)
18547 "Create an image from LaTeX source using dvipng or convert.
18548 This function calls either `org-create-formula-image-with-dvipng'
18549 or `org-create-formula-image-with-imagemagick' depending on the
18550 value of `org-latex-create-formula-image-program' or on the value
18551 of the optional TYPE variable.
18553 Note: ultimately these two function should be combined as they
18554 share a good deal of logic."
18555 (org-check-external-command
18556 "latex" "needed to convert LaTeX fragments to images")
18557 (funcall
18558 (case (or type org-latex-create-formula-image-program)
18559 ('dvipng
18560 (org-check-external-command
18561 "dvipng" "needed to convert LaTeX fragments to images")
18562 #'org-create-formula-image-with-dvipng)
18563 ('imagemagick
18564 (org-check-external-command
18565 "convert" "you need to install imagemagick")
18566 #'org-create-formula-image-with-imagemagick)
18567 (t (error
18568 "Invalid value of `org-latex-create-formula-image-program'")))
18569 string tofile options buffer))
18571 (declare-function org-export-get-backend "ox" (name))
18572 (declare-function org-export--get-global-options "ox" (&optional backend))
18573 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18574 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18575 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18576 (defun org-create-formula--latex-header ()
18577 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18578 (let ((info (org-combine-plists (org-export--get-global-options
18579 (org-export-get-backend 'latex))
18580 (org-export--get-inbuffer-options
18581 (org-export-get-backend 'latex)))))
18582 (org-latex-guess-babel-language
18583 (org-latex-guess-inputenc
18584 (org-splice-latex-header
18585 org-format-latex-header
18586 org-latex-default-packages-alist
18587 org-latex-packages-alist t
18588 (plist-get info :latex-header)))
18589 info)))
18591 ;; This function borrows from Ganesh Swami's latex2png.el
18592 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18593 "This calls dvipng."
18594 (require 'ox-latex)
18595 (let* ((tmpdir (if (featurep 'xemacs)
18596 (temp-directory)
18597 temporary-file-directory))
18598 (texfilebase (make-temp-name
18599 (expand-file-name "orgtex" tmpdir)))
18600 (texfile (concat texfilebase ".tex"))
18601 (dvifile (concat texfilebase ".dvi"))
18602 (pngfile (concat texfilebase ".png"))
18603 (fnh (if (featurep 'xemacs)
18604 (font-height (face-font 'default))
18605 (face-attribute 'default :height nil)))
18606 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18607 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18608 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18609 "Black"))
18610 (bg (or (plist-get options (if buffer :background :html-background))
18611 "Transparent")))
18612 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18613 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18614 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18615 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18616 (let ((latex-header (org-create-formula--latex-header)))
18617 (with-temp-file texfile
18618 (insert latex-header)
18620 (let ((dir default-directory))
18621 (condition-case nil
18622 (progn
18623 (cd tmpdir)
18624 (call-process "latex" nil nil nil texfile))
18625 (error nil))
18626 (cd dir))
18627 (if (not (file-exists-p dvifile))
18628 (progn (message "Failed to create dvi file from %s" texfile) nil)
18629 (condition-case nil
18630 (if (featurep 'xemacs)
18631 (call-process "dvipng" nil nil nil
18632 "-fg" fg "-bg" bg
18633 "-T" "tight"
18634 "-o" pngfile
18635 dvifile)
18636 (call-process "dvipng" nil nil nil
18637 "-fg" fg "-bg" bg
18638 "-D" dpi
18639 ;;"-x" scale "-y" scale
18640 "-T" "tight"
18641 "-o" pngfile
18642 dvifile))
18643 (error nil))
18644 (if (not (file-exists-p pngfile))
18645 (if org-format-latex-signal-error
18646 (error "Failed to create png file from %s" texfile)
18647 (message "Failed to create png file from %s" texfile)
18648 nil)
18649 ;; Use the requested file name and clean up
18650 (copy-file pngfile tofile 'replace)
18651 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18652 (if (file-exists-p (concat texfilebase e))
18653 (delete-file (concat texfilebase e))))
18654 pngfile))))
18656 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18657 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18658 "This calls convert, which is included into imagemagick."
18659 (require 'ox-latex)
18660 (let* ((tmpdir (if (featurep 'xemacs)
18661 (temp-directory)
18662 temporary-file-directory))
18663 (texfilebase (make-temp-name
18664 (expand-file-name "orgtex" tmpdir)))
18665 (texfile (concat texfilebase ".tex"))
18666 (pdffile (concat texfilebase ".pdf"))
18667 (pngfile (concat texfilebase ".png"))
18668 (fnh (if (featurep 'xemacs)
18669 (font-height (face-font 'default))
18670 (face-attribute 'default :height nil)))
18671 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18672 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18673 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18674 "black"))
18675 (bg (or (plist-get options (if buffer :background :html-background))
18676 "white")))
18677 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18678 (setq fg (org-latex-color-format fg)))
18679 (if (eq bg 'default) (setq bg (org-latex-color :background))
18680 (setq bg (org-latex-color-format
18681 (if (string= bg "Transparent") "white" bg))))
18682 (let ((latex-header (org-create-formula--latex-header)))
18683 (with-temp-file texfile
18684 (insert latex-header)
18690 string
18693 (org-latex-compile texfile t)
18694 (if (not (file-exists-p pdffile))
18695 (progn (message "Failed to create pdf file from %s" texfile) nil)
18696 (condition-case nil
18697 (if (featurep 'xemacs)
18698 (call-process "convert" nil nil nil
18699 "-density" "96"
18700 "-trim"
18701 "-antialias"
18702 pdffile
18703 "-quality" "100"
18704 ;; "-sharpen" "0x1.0"
18705 pngfile)
18706 (call-process "convert" nil nil nil
18707 "-density" dpi
18708 "-trim"
18709 "-antialias"
18710 pdffile
18711 "-quality" "100"
18712 ;; "-sharpen" "0x1.0"
18713 pngfile))
18714 (error nil))
18715 (if (not (file-exists-p pngfile))
18716 (if org-format-latex-signal-error
18717 (error "Failed to create png file from %s" texfile)
18718 (message "Failed to create png file from %s" texfile)
18719 nil)
18720 ;; Use the requested file name and clean up
18721 (copy-file pngfile tofile 'replace)
18722 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18723 (if (file-exists-p (concat texfilebase e))
18724 (delete-file (concat texfilebase e))))
18725 pngfile))))
18727 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18728 "Fill a LaTeX header template TPL.
18729 In the template, the following place holders will be recognized:
18732 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18734 [NO-PACKAGES] do not include PKG
18735 [EXTRA] the string EXTRA
18736 [NO-EXTRA] do not include EXTRA
18738 For backward compatibility, if both the positive and the negative place
18740 assumed to be present at the end of the template.
18741 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18742 EXTRA is a string.
18743 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18744 (let (rpl (end ""))
18746 (setq rpl (if (or (match-end 1) (not def-pkg))
18747 "" (org-latex-packages-to-string def-pkg snippets-p t))
18748 tpl (replace-match rpl t t tpl))
18749 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18752 (setq rpl (if (or (match-end 1) (not pkg))
18753 "" (org-latex-packages-to-string pkg snippets-p t))
18754 tpl (replace-match rpl t t tpl))
18755 (if pkg (setq end
18757 (org-latex-packages-to-string pkg snippets-p)))))
18760 (setq rpl (if (or (match-end 1) (not extra))
18762 tpl (replace-match rpl t t tpl))
18768 tpl)))
18770 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18772 (setq pkg (mapconcat (lambda(p)
18773 (cond
18774 ((stringp p) p)
18775 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18776 (format "%% Package %s omitted" (cadr p)))
18777 ((equal "" (car p))
18779 (t
18781 (car p) (cadr p)))))
18782 pkg
18786 (defun org-dvipng-color (attr)
18787 "Return a RGB color specification for dvipng."
18788 (apply 'format "rgb %s %s %s"
18789 (mapcar 'org-normalize-color
18790 (if (featurep 'xemacs)
18791 (color-rgb-components
18792 (face-property 'default
18793 (cond ((eq attr :foreground) 'foreground)
18794 ((eq attr :background) 'background))))
18795 (color-values (face-attribute 'default attr nil))))))
18797 (defun org-dvipng-color-format (color-name)
18798 "Convert COLOR-NAME to a RGB color value for dvipng."
18799 (apply 'format "rgb %s %s %s"
18800 (mapcar 'org-normalize-color
18801 (color-values color-name))))
18803 (defun org-latex-color (attr)
18804 "Return a RGB color for the LaTeX color package."
18805 (apply 'format "%s,%s,%s"
18806 (mapcar 'org-normalize-color
18807 (if (featurep 'xemacs)
18808 (color-rgb-components
18809 (face-property 'default
18810 (cond ((eq attr :foreground) 'foreground)
18811 ((eq attr :background) 'background))))
18812 (color-values (face-attribute 'default attr nil))))))
18814 (defun org-latex-color-format (color-name)
18815 "Convert COLOR-NAME to a RGB color value."
18816 (apply 'format "%s,%s,%s"
18817 (mapcar 'org-normalize-color
18818 (color-values color-name))))
18820 (defun org-normalize-color (value)
18821 "Return string to be used as color value for an RGB component."
18822 (format "%g" (/ value 65535.0)))
18825 \f
18826 ;; Image display
18828 (defvar org-inline-image-overlays nil)
18829 (make-variable-buffer-local 'org-inline-image-overlays)
18831 (defun org-toggle-inline-images (&optional include-linked)
18832 "Toggle the display of inline images.
18833 INCLUDE-LINKED is passed to `org-display-inline-images'."
18834 (interactive "P")
18835 (if org-inline-image-overlays
18836 (progn
18837 (org-remove-inline-images)
18838 (message "Inline image display turned off"))
18839 (org-display-inline-images include-linked)
18840 (if (and (org-called-interactively-p)
18841 org-inline-image-overlays)
18842 (message "%d images displayed inline"
18843 (length org-inline-image-overlays))
18844 (message "No images to display inline"))))
18846 (defun org-redisplay-inline-images ()
18847 "Refresh the display of inline images."
18848 (interactive)
18849 (if (not org-inline-image-overlays)
18850 (org-toggle-inline-images)
18851 (org-toggle-inline-images)
18852 (org-toggle-inline-images)))
18854 (defun org-display-inline-images (&optional include-linked refresh beg end)
18855 "Display inline images.
18856 Normally only links without a description part are inlined, because this
18857 is how it will work for export. When INCLUDE-LINKED is set, also links
18858 with a description part will be inlined. This can be nice for a quick
18859 look at those images, but it does not reflect what exported files will look
18860 like.
18861 When REFRESH is set, refresh existing images between BEG and END.
18862 This will create new image displays only if necessary.
18863 BEG and END default to the buffer boundaries."
18864 (interactive "P")
18865 (when (display-graphic-p)
18866 (unless refresh
18867 (org-remove-inline-images)
18868 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18869 (save-excursion
18870 (save-restriction
18871 (widen)
18872 (setq beg (or beg (point-min)) end (or end (point-max)))
18873 (goto-char beg)
18875 (substring (org-image-file-name-regexp) 0 -2)
18877 (case-fold-search t)
18878 old file ov img type attrwidth width)
18879 (while (re-search-forward re end t)
18880 (setq old (get-char-property-and-overlay (match-beginning 1)
18881 'org-image-overlay)
18882 file (expand-file-name
18883 (concat (or (match-string 3) "") (match-string 4))))
18884 (when (image-type-available-p 'imagemagick)
18885 (setq attrwidth (if (or (listp org-image-actual-width)
18886 (null org-image-actual-width))
18887 (save-excursion
18888 (save-match-data
18889 (when (re-search-backward
18891 (save-excursion
18893 (string-to-number (match-string 1))))))
18894 width (cond ((eq org-image-actual-width t) nil)
18895 ((null org-image-actual-width) attrwidth)
18896 ((numberp org-image-actual-width)
18897 org-image-actual-width)
18898 ((listp org-image-actual-width)
18899 (or attrwidth (car org-image-actual-width))))
18900 type (if width 'imagemagick)))
18901 (when (file-exists-p file)
18902 (if (and (car-safe old) refresh)
18903 (image-refresh (overlay-get (cdr old) 'display))
18904 (setq img (save-match-data (create-image file type nil :width width)))
18905 (when img
18906 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18907 (overlay-put ov 'display img)
18908 (overlay-put ov 'face 'default)
18909 (overlay-put ov 'org-image-overlay t)
18910 (overlay-put ov 'modification-hooks
18911 (list 'org-display-inline-remove-overlay))
18912 (push ov org-inline-image-overlays))))))))))
18914 (define-obsolete-function-alias
18915 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18917 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18918 "Remove inline-display overlay if a corresponding region is modified."
18919 (let ((inhibit-modification-hooks t))
18920 (when (and ov after)
18921 (delete ov org-inline-image-overlays)
18922 (delete-overlay ov))))
18924 (defun org-remove-inline-images ()
18925 "Remove inline display of images."
18926 (interactive)
18927 (mapc 'delete-overlay org-inline-image-overlays)
18928 (setq org-inline-image-overlays nil))
18930 ;;;; Key bindings
18932 ;; Outline functions from `outline-mode-prefix-map'
18933 ;; that can be remapped in Org:
18934 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18935 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18936 (define-key org-mode-map [remap outline-forward-same-level]
18937 'org-forward-heading-same-level)
18938 (define-key org-mode-map [remap outline-backward-same-level]
18939 'org-backward-heading-same-level)
18940 (define-key org-mode-map [remap show-branches]
18941 'org-kill-note-or-show-branches)
18942 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18943 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18944 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18946 ;; Outline functions from `outline-mode-prefix-map' that can not
18947 ;; be remapped in Org:
18948 ;;
18949 ;; - the column "key binding" shows whether the Outline function is still
18950 ;; available in Org mode on the same key that it has been bound to in
18951 ;; Outline mode:
18952 ;; - "overridden": key used for a different functionality in Org mode
18953 ;; - else: key still bound to the same Outline function in Org mode
18954 ;;
18955 ;; | Outline function | key binding | Org replacement |
18956 ;; |------------------------------------+-------------+-----------------------|
18957 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18958 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18959 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18960 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18961 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18962 ;; | `show-entry' | overridden | no replacement |
18963 ;; | `show-children' | `C-c C-i' | visibility cycling |
18964 ;; | `show-branches' | `C-c C-k' | still same function |
18965 ;; | `show-subtree' | overridden | visibility cycling |
18966 ;; | `show-all' | overridden | no replacement |
18967 ;; | `hide-subtree' | overridden | visibility cycling |
18968 ;; | `hide-body' | overridden | no replacement |
18969 ;; | `hide-entry' | overridden | visibility cycling |
18970 ;; | `hide-leaves' | overridden | no replacement |
18971 ;; | `hide-sublevels' | overridden | no replacement |
18972 ;; | `hide-other' | overridden | no replacement |
18974 ;; Make `C-c C-x' a prefix key
18975 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18977 ;; TAB key with modifiers
18978 (org-defkey org-mode-map "\C-i" 'org-cycle)
18979 (org-defkey org-mode-map [(tab)] 'org-cycle)
18980 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18982 ;; The following line is necessary under Suse GNU/Linux
18983 (unless (featurep 'xemacs)
18984 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18985 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18986 (define-key org-mode-map [backtab] 'org-shifttab)
18988 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18989 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18990 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18992 ;; Cursor keys with modifiers
18993 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18994 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18995 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18996 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18998 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18999 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19000 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19001 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19003 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19004 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19005 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19006 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19008 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19009 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19010 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19011 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19013 ;; Babel keys
19014 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19015 (mapc (lambda (pair)
19016 (define-key org-babel-map (car pair) (cdr pair)))
19017 org-babel-key-bindings)
19019 ;;; Extra keys for tty access.
19020 ;; We only set them when really needed because otherwise the
19021 ;; menus don't show the simple keys
19023 (when (or org-use-extra-keys
19024 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19025 (not window-system))
19026 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19027 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19028 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19029 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19030 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19031 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19032 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19033 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19034 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19035 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19036 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19037 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19038 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19039 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19040 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19041 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19042 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19043 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19044 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19045 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19046 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19047 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19048 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19049 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19050 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19051 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19052 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19053 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19055 ;; All the other keys
19057 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19058 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19059 (if (boundp 'narrow-map)
19060 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19061 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19062 (if (boundp 'narrow-map)
19063 (org-defkey narrow-map "b" 'org-narrow-to-block)
19064 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19065 (if (boundp 'narrow-map)
19066 (org-defkey narrow-map "e" 'org-narrow-to-element)
19067 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19068 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19069 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19070 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19071 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19072 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19073 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19074 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19075 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19076 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19077 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19078 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19079 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19080 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19081 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19082 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19083 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19084 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19085 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19086 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19087 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19088 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19089 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19090 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19091 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19092 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19093 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19095 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19096 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19097 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19098 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19099 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19100 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19101 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19102 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19103 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19104 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19105 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19106 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19107 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19108 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19109 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19110 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19111 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19112 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19113 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19114 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19115 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19117 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19118 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19119 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19120 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19121 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19122 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19123 (org-defkey org-mode-map "\C-c^" 'org-sort)
19124 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19125 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19126 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19127 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19128 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19129 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19130 (org-defkey org-mode-map "\C-m" 'org-return)
19131 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19132 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19133 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19134 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19135 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19136 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19137 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19138 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19139 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19140 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19141 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19142 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19143 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19144 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19145 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19146 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19147 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19148 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19149 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19150 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19151 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19152 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19153 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19155 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19156 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19157 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19159 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19160 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19161 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19162 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19163 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19164 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19165 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19166 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19167 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19168 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19169 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19170 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19171 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19173 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19174 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19175 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19176 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19177 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19178 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19179 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19180 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19181 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19183 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19184 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19185 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19186 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19187 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19189 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19191 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19193 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19194 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19196 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19199 (when (featurep 'xemacs)
19200 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19203 (defconst org-speed-commands-default
19204 '(
19205 ("Outline Navigation")
19206 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19207 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19208 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19209 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19210 ("F" . org-next-block)
19211 ("B" . org-previous-block)
19212 ("u" . (org-speed-move-safe 'outline-up-heading))
19213 ("j" . org-goto)
19214 ("g" . (org-refile t))
19215 ("Outline Visibility")
19216 ("c" . org-cycle)
19217 ("C" . org-shifttab)
19218 (" " . org-display-outline-path)
19219 ("s" . org-narrow-to-subtree)
19220 ("=" . org-columns)
19221 ("Outline Structure Editing")
19222 ("U" . org-shiftmetaup)
19223 ("D" . org-shiftmetadown)
19224 ("r" . org-metaright)
19225 ("l" . org-metaleft)
19226 ("R" . org-shiftmetaright)
19227 ("L" . org-shiftmetaleft)
19228 ("i" . (progn (forward-char 1) (call-interactively
19229 'org-insert-heading-respect-content)))
19230 ("^" . org-sort)
19231 ("w" . org-refile)
19232 ("a" . org-archive-subtree-default-with-confirmation)
19233 ("@" . org-mark-subtree)
19234 ("#" . org-toggle-comment)
19235 ("Clock Commands")
19236 ("I" . org-clock-in)
19237 ("O" . org-clock-out)
19238 ("Meta Data Editing")
19239 ("t" . org-todo)
19240 ("," . (org-priority))
19241 ("0" . (org-priority ?\ ))
19242 ("1" . (org-priority ?A))
19243 ("2" . (org-priority ?B))
19244 ("3" . (org-priority ?C))
19245 (":" . org-set-tags-command)
19246 ("e" . org-set-effort)
19247 ("E" . org-inc-effort)
19248 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19249 (org-entry-put (point) "APPT_WARNTIME" m)))
19250 ("Agenda Views etc")
19251 ("v" . org-agenda)
19252 ("/" . org-sparse-tree)
19253 ("Misc")
19254 ("o" . org-open-at-point)
19255 ("?" . org-speed-command-help)
19256 ("<" . (org-agenda-set-restriction-lock 'subtree))
19257 (">" . (org-agenda-remove-restriction-lock))
19258 )
19259 "The default speed commands.")
19261 (defun org-print-speed-command (e)
19262 (if (> (length (car e)) 1)
19263 (progn
19265 (princ (car e))
19267 (princ (make-string (length (car e)) ?-))
19269 (princ (car e))
19270 (princ " ")
19271 (if (symbolp (cdr e))
19272 (princ (symbol-name (cdr e)))
19273 (prin1 (cdr e)))
19276 (defun org-speed-command-help ()
19277 "Show the available speed commands."
19278 (interactive)
19279 (if (not org-use-speed-commands)
19280 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19281 (with-output-to-temp-buffer "*Help*"
19283 (mapc 'org-print-speed-command org-speed-commands-user)
19286 (mapc 'org-print-speed-command org-speed-commands-default))
19287 (with-current-buffer "*Help*"
19288 (setq truncate-lines t))))
19290 (defun org-speed-move-safe (cmd)
19291 "Execute CMD, but make sure that the cursor always ends up in a headline.
19292 If not, return to the original position and throw an error."
19293 (interactive)
19294 (let ((pos (point)))
19295 (call-interactively cmd)
19296 (unless (and (bolp) (org-at-heading-p))
19297 (goto-char pos)
19298 (error "Boundary reached while executing %s" cmd))))
19300 (defvar org-self-insert-command-undo-counter 0)
19302 (defvar org-table-auto-blank-field) ; defined in org-table.el
19303 (defvar org-speed-command nil)
19305 (define-obsolete-function-alias
19306 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19308 (defun org-speed-command-activate (keys)
19309 "Hook for activating single-letter speed commands.
19310 `org-speed-commands-default' specifies a minimal command set.
19311 Use `org-speed-commands-user' for further customization."
19312 (when (or (and (bolp) (looking-at org-outline-regexp))
19313 (and (functionp org-use-speed-commands)
19314 (funcall org-use-speed-commands)))
19315 (cdr (assoc keys (append org-speed-commands-user
19316 org-speed-commands-default)))))
19318 (define-obsolete-function-alias
19319 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19321 (defun org-babel-speed-command-activate (keys)
19322 "Hook for activating single-letter code block commands."
19323 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19324 (cdr (assoc keys org-babel-key-bindings))))
19326 (defcustom org-speed-command-hook
19327 '(org-speed-command-default-hook org-babel-speed-command-hook)
19328 "Hook for activating speed commands at strategic locations.
19329 Hook functions are called in sequence until a valid handler is
19330 found.
19332 Each hook takes a single argument, a user-pressed command key
19333 which is also a `self-insert-command' from the global map.
19335 Within the hook, examine the cursor position and the command key
19336 and return nil or a valid handler as appropriate. Handler could
19337 be one of an interactive command, a function, or a form.
19339 Set `org-use-speed-commands' to non-nil value to enable this
19340 hook. The default setting is `org-speed-command-activate'."
19341 :group 'org-structure
19342 :version "24.1"
19343 :type 'hook)
19345 (defun org-self-insert-command (N)
19346 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19347 If the cursor is in a table looking at whitespace, the whitespace is
19348 overwritten, and the table is not marked as requiring realignment."
19349 (interactive "p")
19350 (org-check-before-invisible-edit 'insert)
19351 (cond
19352 ((and org-use-speed-commands
19353 (setq org-speed-command
19354 (run-hook-with-args-until-success
19355 'org-speed-command-hook (this-command-keys))))
19356 (cond
19357 ((commandp org-speed-command)
19358 (setq this-command org-speed-command)
19359 (call-interactively org-speed-command))
19360 ((functionp org-speed-command)
19361 (funcall org-speed-command))
19362 ((and org-speed-command (listp org-speed-command))
19363 (eval org-speed-command))
19364 (t (let (org-use-speed-commands)
19365 (call-interactively 'org-self-insert-command)))))
19366 ((and
19367 (org-table-p)
19368 (progn
19369 ;; check if we blank the field, and if that triggers align
19370 (and (featurep 'org-table) org-table-auto-blank-field
19371 (member last-command
19372 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19374 ;; got extra space, this field does not determine column width
19375 (let (org-table-may-need-update) (org-table-blank-field))
19376 ;; no extra space, this field may determine column width
19377 (org-table-blank-field)))
19378 t)
19379 (eq N 1)
19381 (let (org-table-may-need-update)
19382 (goto-char (1- (match-end 0)))
19383 (backward-delete-char 1)
19384 (goto-char (match-beginning 0))
19385 (self-insert-command N)))
19386 (t
19387 (setq org-table-may-need-update t)
19388 (self-insert-command N)
19389 (org-fix-tags-on-the-fly)
19390 (if org-self-insert-cluster-for-undo
19391 (if (not (eq last-command 'org-self-insert-command))
19392 (setq org-self-insert-command-undo-counter 1)
19393 (if (>= org-self-insert-command-undo-counter 20)
19394 (setq org-self-insert-command-undo-counter 1)
19395 (and (> org-self-insert-command-undo-counter 0)
19396 buffer-undo-list (listp buffer-undo-list)
19397 (not (cadr buffer-undo-list)) ; remove nil entry
19398 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19399 (setq org-self-insert-command-undo-counter
19400 (1+ org-self-insert-command-undo-counter))))))))
19402 (defun org-check-before-invisible-edit (kind)
19403 "Check is editing if kind KIND would be dangerous with invisible text around.
19404 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19405 ;; First, try to get out of here as quickly as possible, to reduce overhead
19406 (if (and org-catch-invisible-edits
19407 (or (not (boundp 'visible-mode)) (not visible-mode))
19408 (or (get-char-property (point) 'invisible)
19409 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19410 ;; OK, we need to take a closer look
19411 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19412 (invisible-before-point (if (bobp) nil (get-char-property
19413 (1- (point)) 'invisible)))
19414 (border-and-ok-direction
19415 (or
19416 ;; Check if we are acting predictably before invisible text
19417 (and invisible-at-point (not invisible-before-point)
19418 (memq kind '(insert delete-backward)))
19419 ;; Check if we are acting predictably after invisible text
19420 ;; This works not well, and I have turned it off. It seems
19421 ;; better to always show and stop after invisible text.
19422 ;; (and (not invisible-at-point) invisible-before-point
19423 ;; (memq kind '(insert delete)))
19424 )))
19425 (when (or (memq invisible-at-point '(outline org-hide-block t))
19426 (memq invisible-before-point '(outline org-hide-block t)))
19427 (if (eq org-catch-invisible-edits 'error)
19428 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19429 (if (and org-custom-properties-overlays
19430 (y-or-n-p "Display invisible properties in this buffer? "))
19431 (org-toggle-custom-properties-visibility)
19432 ;; Make the area visible
19433 (save-excursion
19434 (if invisible-before-point
19435 (goto-char (previous-single-char-property-change
19436 (point) 'invisible)))
19437 (org-cycle))
19438 (cond
19439 ((eq org-catch-invisible-edits 'show)
19440 ;; That's it, we do the edit after showing
19441 (message
19442 "Unfolding invisible region around point before editing")
19443 (sit-for 1))
19444 ((and (eq org-catch-invisible-edits 'smart)
19445 border-and-ok-direction)
19446 (message "Unfolding invisible region around point before editing"))
19447 (t
19448 ;; Don't do the edit, make the user repeat it in full visibility
19449 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19451 (defun org-fix-tags-on-the-fly ()
19452 (when (and (equal (char-after (point-at-bol)) ?*)
19453 (org-at-heading-p))
19454 (org-align-tags-here org-tags-column)))
19456 (defun org-delete-backward-char (N)
19457 "Like `delete-backward-char', insert whitespace at field end in tables.
19458 When deleting backwards, in tables this function will insert whitespace in
19460 still be marked for re-alignment if the field did fill the entire column,
19461 because, in this case the deletion might narrow the column."
19462 (interactive "p")
19463 (save-match-data
19464 (org-check-before-invisible-edit 'delete-backward)
19465 (if (and (org-table-p)
19466 (eq N 1)
19467 (string-match "|" (buffer-substring (point-at-bol) (point)))
19468 (looking-at ".*?|"))
19469 (let ((pos (point))
19471 (c org-table-may-need-update))
19472 (backward-delete-char N)
19473 (if (not overwrite-mode)
19474 (progn
19475 (skip-chars-forward "^|")
19476 (insert " ")
19477 (goto-char (1- pos))))
19478 ;; noalign: if there were two spaces at the end, this field
19479 ;; does not determine the width of the column.
19480 (if noalign (setq org-table-may-need-update c)))
19481 (backward-delete-char N)
19482 (org-fix-tags-on-the-fly))))
19484 (defun org-delete-char (N)
19485 "Like `delete-char', but insert whitespace at field end in tables.
19486 When deleting characters, in tables this function will insert whitespace in
19488 still be marked for re-alignment if the field did fill the entire column,
19489 because, in this case the deletion might narrow the column."
19490 (interactive "p")
19491 (save-match-data
19492 (org-check-before-invisible-edit 'delete)
19493 (if (and (org-table-p)
19494 (not (bolp))
19495 (not (= (char-after) ?|))
19496 (eq N 1))
19497 (if (looking-at ".*?|")
19498 (let ((pos (point))
19500 (c org-table-may-need-update))
19501 (replace-match
19502 (concat (substring (match-string 0) 1 -1) " |") nil t)
19503 (goto-char pos)
19504 ;; noalign: if there were two spaces at the end, this field
19505 ;; does not determine the width of the column.
19506 (if noalign (setq org-table-may-need-update c)))
19507 (delete-char N))
19508 (delete-char N)
19509 (org-fix-tags-on-the-fly))))
19511 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19512 (put 'org-self-insert-command 'delete-selection t)
19513 (put 'orgtbl-self-insert-command 'delete-selection t)
19514 (put 'org-delete-char 'delete-selection 'supersede)
19515 (put 'org-delete-backward-char 'delete-selection 'supersede)
19516 (put 'org-yank 'delete-selection 'yank)
19518 ;; Make `flyspell-mode' delay after some commands
19519 (put 'org-self-insert-command 'flyspell-delayed t)
19520 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19521 (put 'org-delete-char 'flyspell-delayed t)
19522 (put 'org-delete-backward-char 'flyspell-delayed t)
19524 ;; Make pabbrev-mode expand after org-mode commands
19525 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19526 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19528 ;; How to do this: Measure non-white length of current string
19529 ;; If equal to column width, we should realign.
19531 (defun org-remap (map &rest commands)
19532 "In MAP, remap the functions given in COMMANDS.
19533 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19534 (let (new old)
19535 (while commands
19536 (setq old (pop commands) new (pop commands))
19537 (if (fboundp 'command-remapping)
19538 (org-defkey map (vector 'remap old) new)
19539 (substitute-key-definition old new map global-map)))))
19541 (defun org-transpose-words ()
19542 "Transpose words for Org.
19543 This uses the `org-mode-transpose-word-syntax-table' syntax
19544 table, which interprets characters in `org-emphasis-alist' as
19545 word constituants."
19546 (interactive)
19547 (with-syntax-table org-mode-transpose-word-syntax-table
19548 (call-interactively 'transpose-words)))
19549 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19551 (when (eq org-enable-table-editor 'optimized)
19552 ;; If the user wants maximum table support, we need to hijack
19553 ;; some standard editing functions
19554 (org-remap org-mode-map
19555 'self-insert-command 'org-self-insert-command
19556 'delete-char 'org-delete-char
19557 'delete-backward-char 'org-delete-backward-char)
19558 (org-defkey org-mode-map "|" 'org-force-self-insert))
19560 (defvar org-ctrl-c-ctrl-c-hook nil
19561 "Hook for functions attaching themselves to `C-c C-c'.
19563 This can be used to add additional functionality to the C-c C-c
19564 key which executes context-dependent commands. This hook is run
19565 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19566 run after the last test.
19568 Each function will be called with no arguments. The function
19569 must check if the context is appropriate for it to act. If yes,
19570 it should do its thing and then return a non-nil value. If the
19571 context is wrong, just do nothing and return nil.")
19573 (defvar org-ctrl-c-ctrl-c-final-hook nil
19574 "Hook for functions attaching themselves to `C-c C-c'.
19576 This can be used to add additional functionality to the C-c C-c
19577 key which executes context-dependent commands. This hook is run
19578 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19579 before the first test.
19581 Each function will be called with no arguments. The function
19582 must check if the context is appropriate for it to act. If yes,
19583 it should do its thing and then return a non-nil value. If the
19584 context is wrong, just do nothing and return nil.")
19586 (defvar org-tab-first-hook nil
19587 "Hook for functions to attach themselves to TAB.
19588 See `org-ctrl-c-ctrl-c-hook' for more information.
19589 This hook runs as the first action when TAB is pressed, even before
19590 `org-cycle' messes around with the `outline-regexp' to cater for
19591 inline tasks and plain list item folding.
19592 If any function in this hook returns t, any other actions that
19593 would have been caused by TAB (such as table field motion or visibility
19594 cycling) will not occur.")
19596 (defvar org-tab-after-check-for-table-hook nil
19597 "Hook for functions to attach themselves to TAB.
19598 See `org-ctrl-c-ctrl-c-hook' for more information.
19599 This hook runs after it has been established that the cursor is not in a
19600 table, but before checking if the cursor is in a headline or if global cycling
19601 should be done.
19602 If any function in this hook returns t, not other actions like visibility
19603 cycling will be done.")
19605 (defvar org-tab-after-check-for-cycling-hook nil
19606 "Hook for functions to attach themselves to TAB.
19607 See `org-ctrl-c-ctrl-c-hook' for more information.
19608 This hook runs after it has been established that not table field motion and
19609 not visibility should be done because of current context. This is probably
19610 the place where a package like yasnippets can hook in.")
19612 (defvar org-tab-before-tab-emulation-hook nil
19613 "Hook for functions to attach themselves to TAB.
19614 See `org-ctrl-c-ctrl-c-hook' for more information.
19615 This hook runs after every other options for TAB have been exhausted, but
19618 (defvar org-metaleft-hook nil
19619 "Hook for functions attaching themselves to `M-left'.
19620 See `org-ctrl-c-ctrl-c-hook' for more information.")
19621 (defvar org-metaright-hook nil
19622 "Hook for functions attaching themselves to `M-right'.
19623 See `org-ctrl-c-ctrl-c-hook' for more information.")
19624 (defvar org-metaup-hook nil
19625 "Hook for functions attaching themselves to `M-up'.
19626 See `org-ctrl-c-ctrl-c-hook' for more information.")
19627 (defvar org-metadown-hook nil
19628 "Hook for functions attaching themselves to `M-down'.
19629 See `org-ctrl-c-ctrl-c-hook' for more information.")
19630 (defvar org-shiftmetaleft-hook nil
19631 "Hook for functions attaching themselves to `M-S-left'.
19632 See `org-ctrl-c-ctrl-c-hook' for more information.")
19633 (defvar org-shiftmetaright-hook nil
19634 "Hook for functions attaching themselves to `M-S-right'.
19635 See `org-ctrl-c-ctrl-c-hook' for more information.")
19636 (defvar org-shiftmetaup-hook nil
19637 "Hook for functions attaching themselves to `M-S-up'.
19638 See `org-ctrl-c-ctrl-c-hook' for more information.")
19639 (defvar org-shiftmetadown-hook nil
19640 "Hook for functions attaching themselves to `M-S-down'.
19641 See `org-ctrl-c-ctrl-c-hook' for more information.")
19642 (defvar org-metareturn-hook nil
19643 "Hook for functions attaching themselves to `M-RET'.
19644 See `org-ctrl-c-ctrl-c-hook' for more information.")
19645 (defvar org-shiftup-hook nil
19646 "Hook for functions attaching themselves to `S-up'.
19647 See `org-ctrl-c-ctrl-c-hook' for more information.")
19648 (defvar org-shiftup-final-hook nil
19649 "Hook for functions attaching themselves to `S-up'.
19650 This one runs after all other options except shift-select have been excluded.
19651 See `org-ctrl-c-ctrl-c-hook' for more information.")
19652 (defvar org-shiftdown-hook nil
19653 "Hook for functions attaching themselves to `S-down'.
19654 See `org-ctrl-c-ctrl-c-hook' for more information.")
19655 (defvar org-shiftdown-final-hook nil
19656 "Hook for functions attaching themselves to `S-down'.
19657 This one runs after all other options except shift-select have been excluded.
19658 See `org-ctrl-c-ctrl-c-hook' for more information.")
19659 (defvar org-shiftleft-hook nil
19660 "Hook for functions attaching themselves to `S-left'.
19661 See `org-ctrl-c-ctrl-c-hook' for more information.")
19662 (defvar org-shiftleft-final-hook nil
19663 "Hook for functions attaching themselves to `S-left'.
19664 This one runs after all other options except shift-select have been excluded.
19665 See `org-ctrl-c-ctrl-c-hook' for more information.")
19666 (defvar org-shiftright-hook nil
19667 "Hook for functions attaching themselves to `S-right'.
19668 See `org-ctrl-c-ctrl-c-hook' for more information.")
19669 (defvar org-shiftright-final-hook nil
19670 "Hook for functions attaching themselves to `S-right'.
19671 This one runs after all other options except shift-select have been excluded.
19672 See `org-ctrl-c-ctrl-c-hook' for more information.")
19674 (defun org-modifier-cursor-error ()
19675 "Throw an error, a modified cursor command was applied in wrong context."
19676 (user-error "This command is active in special context like tables, headlines or items"))
19678 (defun org-shiftselect-error ()
19679 "Throw an error because Shift-Cursor command was applied in wrong context."
19680 (if (and (boundp 'shift-select-mode) shift-select-mode)
19681 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19682 (user-error "This command works only in special context like headlines or timestamps")))
19684 (defun org-call-for-shift-select (cmd)
19685 (let ((this-command-keys-shift-translated t))
19686 (call-interactively cmd)))
19688 (defun org-shifttab (&optional arg)
19689 "Global visibility cycling or move to previous table field.
19690 Call `org-table-previous-field' within a table.
19691 When ARG is nil, cycle globally through visibility states.
19692 When ARG is a numeric prefix, show contents of this level."
19693 (interactive "P")
19694 (cond
19695 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19696 ((integerp arg)
19697 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19698 (message "Content view to level: %d" arg)
19699 (org-content (prefix-numeric-value arg2))
19700 (org-cycle-show-empty-lines t)
19701 (setq org-cycle-global-status 'overview)))
19702 (t (call-interactively 'org-global-cycle))))
19704 (defun org-shiftmetaleft ()
19705 "Promote subtree or delete table column.
19706 Calls `org-promote-subtree', `org-outdent-item-tree', or
19707 `org-table-delete-column', depending on context. See the
19708 individual commands for more information."
19709 (interactive)
19710 (cond
19711 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19712 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19713 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19714 ((if (not (org-region-active-p)) (org-at-item-p)
19715 (save-excursion (goto-char (region-beginning))
19716 (org-at-item-p)))
19717 (call-interactively 'org-outdent-item-tree))
19718 (t (org-modifier-cursor-error))))
19720 (defun org-shiftmetaright ()
19721 "Demote subtree or insert table column.
19722 Calls `org-demote-subtree', `org-indent-item-tree', or
19723 `org-table-insert-column', depending on context. See the
19724 individual commands for more information."
19725 (interactive)
19726 (cond
19727 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19728 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19729 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19730 ((if (not (org-region-active-p)) (org-at-item-p)
19731 (save-excursion (goto-char (region-beginning))
19732 (org-at-item-p)))
19733 (call-interactively 'org-indent-item-tree))
19734 (t (org-modifier-cursor-error))))
19736 (defun org-shiftmetaup (&optional arg)
19737 "Move subtree up or kill table row.
19738 Calls `org-move-subtree-up' or `org-table-kill-row' or
19739 `org-move-item-up' or `org-timestamp-up', depending on context.
19740 See the individual commands for more information."
19741 (interactive "P")
19742 (cond
19743 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19744 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19745 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19746 ((org-at-item-p) (call-interactively 'org-move-item-up))
19747 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19748 (call-interactively 'org-timestamp-up)))
19749 (t (call-interactively 'org-drag-line-backward))))
19751 (defun org-shiftmetadown (&optional arg)
19752 "Move subtree down or insert table row.
19753 Calls `org-move-subtree-down' or `org-table-insert-row' or
19754 `org-move-item-down' or `org-timestamp-up', depending on context.
19755 See the individual commands for more information."
19756 (interactive "P")
19757 (cond
19758 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19759 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19760 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19761 ((org-at-item-p) (call-interactively 'org-move-item-down))
19762 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19763 (call-interactively 'org-timestamp-down)))
19764 (t (call-interactively 'org-drag-line-forward))))
19766 (defsubst org-hidden-tree-error ()
19767 (user-error
19768 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19770 (defun org-metaleft (&optional arg)
19771 "Promote heading or move table column to left.
19772 Calls `org-do-promote' or `org-table-move-column', depending on context.
19773 With no specific context, calls the Emacs default `backward-word'.
19774 See the individual commands for more information."
19775 (interactive "P")
19776 (cond
19777 ((run-hook-with-args-until-success 'org-metaleft-hook))
19778 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19779 ((org-with-limited-levels
19780 (or (org-at-heading-p)
19781 (and (org-region-active-p)
19782 (save-excursion
19783 (goto-char (region-beginning))
19784 (org-at-heading-p)))))
19785 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19786 (call-interactively 'org-do-promote))
19787 ;; At an inline task.
19788 ((org-at-heading-p)
19789 (call-interactively 'org-inlinetask-promote))
19790 ((or (org-at-item-p)
19791 (and (org-region-active-p)
19792 (save-excursion
19793 (goto-char (region-beginning))
19794 (org-at-item-p))))
19795 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19796 (call-interactively 'org-outdent-item))
19797 (t (call-interactively 'backward-word))))
19799 (defun org-metaright (&optional arg)
19800 "Demote a subtree, a list item or move table column to right.
19801 In front of a drawer or a block keyword, indent it correctly.
19802 With no specific context, calls the Emacs default `forward-word'.
19803 See the individual commands for more information."
19804 (interactive "P")
19805 (cond
19806 ((run-hook-with-args-until-success 'org-metaright-hook))
19807 ((org-at-table-p) (call-interactively 'org-table-move-column))
19808 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19809 ((org-at-block-p) (call-interactively 'org-indent-block))
19810 ((org-with-limited-levels
19811 (or (org-at-heading-p)
19812 (and (org-region-active-p)
19813 (save-excursion
19814 (goto-char (region-beginning))
19815 (org-at-heading-p)))))
19816 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19817 (call-interactively 'org-do-demote))
19818 ;; At an inline task.
19819 ((org-at-heading-p)
19820 (call-interactively 'org-inlinetask-demote))
19821 ((or (org-at-item-p)
19822 (and (org-region-active-p)
19823 (save-excursion
19824 (goto-char (region-beginning))
19825 (org-at-item-p))))
19826 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19827 (call-interactively 'org-indent-item))
19828 (t (call-interactively 'forward-word))))
19830 (defun org-check-for-hidden (what)
19831 "Check if there are hidden headlines/items in the current visual line.
19832 WHAT can be either `headlines' or `items'. If the current line is
19833 an outline or item heading and it has a folded subtree below it,
19834 this function returns t, nil otherwise."
19835 (let ((re (cond
19836 ((eq what 'headlines) org-outline-regexp-bol)
19837 ((eq what 'items) (org-item-beginning-re))
19838 (t (error "This should not happen"))))
19839 beg end)
19840 (save-excursion
19841 (catch 'exit
19842 (unless (org-region-active-p)
19843 (setq beg (point-at-bol))
19844 (beginning-of-line 2)
19845 (while (and (not (eobp)) ;; this is like `next-line'
19846 (get-char-property (1- (point)) 'invisible))
19847 (beginning-of-line 2))
19848 (setq end (point))
19849 (goto-char beg)
19850 (goto-char (point-at-eol))
19851 (setq end (max end (point)))
19852 (while (re-search-forward re end t)
19853 (if (get-char-property (match-beginning 0) 'invisible)
19854 (throw 'exit t))))
19855 nil))))
19857 (defun org-metaup (&optional arg)
19858 "Move subtree up or move table row up.
19859 Calls `org-move-subtree-up' or `org-table-move-row' or
19860 `org-move-item-up', depending on context. See the individual commands
19861 for more information."
19862 (interactive "P")
19863 (cond
19864 ((run-hook-with-args-until-success 'org-metaup-hook))
19865 ((org-region-active-p)
19866 (let* ((a (min (region-beginning) (region-end)))
19867 (b (1- (max (region-beginning) (region-end))))
19868 (c (save-excursion (goto-char a)
19869 (move-beginning-of-line 0)))
19870 (d (save-excursion (goto-char a)
19871 (move-end-of-line 0) (point))))
19872 (transpose-regions a b c d)
19873 (goto-char c)))
19874 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19875 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19876 ((org-at-item-p) (call-interactively 'org-move-item-up))
19877 (t (org-drag-element-backward))))
19879 (defun org-metadown (&optional arg)
19880 "Move subtree down or move table row down.
19881 Calls `org-move-subtree-down' or `org-table-move-row' or
19882 `org-move-item-down', depending on context. See the individual
19883 commands for more information."
19884 (interactive "P")
19885 (cond
19886 ((run-hook-with-args-until-success 'org-metadown-hook))
19887 ((org-region-active-p)
19888 (let* ((a (min (region-beginning) (region-end)))
19889 (b (max (region-beginning) (region-end)))
19890 (c (save-excursion (goto-char b)
19891 (move-beginning-of-line 1)))
19892 (d (save-excursion (goto-char b)
19893 (move-end-of-line 1) (1+ (point)))))
19894 (transpose-regions a b c d)
19895 (goto-char d)))
19896 ((org-at-table-p) (call-interactively 'org-table-move-row))
19897 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19898 ((org-at-item-p) (call-interactively 'org-move-item-down))
19899 (t (org-drag-element-forward))))
19901 (defun org-shiftup (&optional arg)
19902 "Increase item in timestamp or increase priority of current headline.
19903 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19904 depending on context. See the individual commands for more information."
19905 (interactive "P")
19906 (cond
19907 ((run-hook-with-args-until-success 'org-shiftup-hook))
19908 ((and org-support-shift-select (org-region-active-p))
19909 (org-call-for-shift-select 'previous-line))
19910 ((org-at-timestamp-p t)
19911 (call-interactively (if org-edit-timestamp-down-means-later
19912 'org-timestamp-down 'org-timestamp-up)))
19913 ((and (not (eq org-support-shift-select 'always))
19914 org-enable-priority-commands
19915 (org-at-heading-p))
19916 (call-interactively 'org-priority-up))
19917 ((and (not org-support-shift-select) (org-at-item-p))
19918 (call-interactively 'org-previous-item))
19919 ((org-clocktable-try-shift 'up arg))
19920 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19921 (org-support-shift-select
19922 (org-call-for-shift-select 'previous-line))
19923 (t (org-shiftselect-error))))
19925 (defun org-shiftdown (&optional arg)
19926 "Decrease item in timestamp or decrease priority of current headline.
19927 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19928 depending on context. See the individual commands for more information."
19929 (interactive "P")
19930 (cond
19931 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19932 ((and org-support-shift-select (org-region-active-p))
19933 (org-call-for-shift-select 'next-line))
19934 ((org-at-timestamp-p t)
19935 (call-interactively (if org-edit-timestamp-down-means-later
19936 'org-timestamp-up 'org-timestamp-down)))
19937 ((and (not (eq org-support-shift-select 'always))
19938 org-enable-priority-commands
19939 (org-at-heading-p))
19940 (call-interactively 'org-priority-down))
19941 ((and (not org-support-shift-select) (org-at-item-p))
19942 (call-interactively 'org-next-item))
19943 ((org-clocktable-try-shift 'down arg))
19944 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19945 (org-support-shift-select
19946 (org-call-for-shift-select 'next-line))
19947 (t (org-shiftselect-error))))
19949 (defun org-shiftright (&optional arg)
19950 "Cycle the thing at point or in the current line, depending on context.
19951 Depending on context, this does one of the following:
19953 - switch a timestamp at point one day into the future
19954 - on a headline, switch to the next TODO keyword.
19955 - on an item, switch entire list to the next bullet type
19956 - on a property line, switch to the next allowed value
19957 - on a clocktable definition line, move time block into the future"
19958 (interactive "P")
19959 (cond
19960 ((run-hook-with-args-until-success 'org-shiftright-hook))
19961 ((and org-support-shift-select (org-region-active-p))
19962 (org-call-for-shift-select 'forward-char))
19963 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19964 ((and (not (eq org-support-shift-select 'always))
19965 (org-at-heading-p))
19966 (let ((org-inhibit-logging
19967 (not org-treat-S-cursor-todo-selection-as-state-change))
19968 (org-inhibit-blocking
19969 (not org-treat-S-cursor-todo-selection-as-state-change)))
19970 (org-call-with-arg 'org-todo 'right)))
19971 ((or (and org-support-shift-select
19972 (not (eq org-support-shift-select 'always))
19973 (org-at-item-bullet-p))
19974 (and (not org-support-shift-select) (org-at-item-p)))
19975 (org-call-with-arg 'org-cycle-list-bullet nil))
19976 ((and (not (eq org-support-shift-select 'always))
19977 (org-at-property-p))
19978 (call-interactively 'org-property-next-allowed-value))
19979 ((org-clocktable-try-shift 'right arg))
19980 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19981 (org-support-shift-select
19982 (org-call-for-shift-select 'forward-char))
19983 (t (org-shiftselect-error))))
19985 (defun org-shiftleft (&optional arg)
19986 "Cycle the thing at point or in the current line, depending on context.
19987 Depending on context, this does one of the following:
19989 - switch a timestamp at point one day into the past
19990 - on a headline, switch to the previous TODO keyword.
19991 - on an item, switch entire list to the previous bullet type
19992 - on a property line, switch to the previous allowed value
19993 - on a clocktable definition line, move time block into the past"
19994 (interactive "P")
19995 (cond
19996 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19997 ((and org-support-shift-select (org-region-active-p))
19998 (org-call-for-shift-select 'backward-char))
19999 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20000 ((and (not (eq org-support-shift-select 'always))
20001 (org-at-heading-p))
20002 (let ((org-inhibit-logging
20003 (not org-treat-S-cursor-todo-selection-as-state-change))
20004 (org-inhibit-blocking
20005 (not org-treat-S-cursor-todo-selection-as-state-change)))
20006 (org-call-with-arg 'org-todo 'left)))
20007 ((or (and org-support-shift-select
20008 (not (eq org-support-shift-select 'always))
20009 (org-at-item-bullet-p))
20010 (and (not org-support-shift-select) (org-at-item-p)))
20011 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20012 ((and (not (eq org-support-shift-select 'always))
20013 (org-at-property-p))
20014 (call-interactively 'org-property-previous-allowed-value))
20015 ((org-clocktable-try-shift 'left arg))
20016 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20017 (org-support-shift-select
20018 (org-call-for-shift-select 'backward-char))
20019 (t (org-shiftselect-error))))
20021 (defun org-shiftcontrolright ()
20022 "Switch to next TODO set."
20023 (interactive)
20024 (cond
20025 ((and org-support-shift-select (org-region-active-p))
20026 (org-call-for-shift-select 'forward-word))
20027 ((and (not (eq org-support-shift-select 'always))
20028 (org-at-heading-p))
20029 (org-call-with-arg 'org-todo 'nextset))
20030 (org-support-shift-select
20031 (org-call-for-shift-select 'forward-word))
20032 (t (org-shiftselect-error))))
20034 (defun org-shiftcontrolleft ()
20035 "Switch to previous TODO set."
20036 (interactive)
20037 (cond
20038 ((and org-support-shift-select (org-region-active-p))
20039 (org-call-for-shift-select 'backward-word))
20040 ((and (not (eq org-support-shift-select 'always))
20041 (org-at-heading-p))
20042 (org-call-with-arg 'org-todo 'previousset))
20043 (org-support-shift-select
20044 (org-call-for-shift-select 'backward-word))
20045 (t (org-shiftselect-error))))
20047 (defun org-shiftcontrolup (&optional n)
20048 "Change timestamps synchronously up in CLOCK log lines.
20049 Optional argument N tells to change by that many units."
20050 (interactive "P")
20051 (cond ((and (not org-support-shift-select)
20052 (org-at-clock-log-p)
20053 (org-at-timestamp-p t))
20054 (org-clock-timestamps-up n))
20055 (t (org-shiftselect-error))))
20057 (defun org-shiftcontroldown (&optional n)
20058 "Change timestamps synchronously down in CLOCK log lines.
20059 Optional argument N tells to change by that many units."
20060 (interactive "P")
20061 (cond ((and (not org-support-shift-select)
20062 (org-at-clock-log-p)
20063 (org-at-timestamp-p t))
20064 (org-clock-timestamps-down n))
20065 (t (org-shiftselect-error))))
20067 (defun org-ctrl-c-ret ()
20068 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20069 (interactive)
20070 (cond
20071 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20072 (t (call-interactively 'org-insert-heading))))
20074 (defun org-find-visible ()
20075 (let ((s (point)))
20076 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20077 (get-char-property s 'invisible)))
20078 s))
20079 (defun org-find-invisible ()
20080 (let ((s (point)))
20081 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20082 (not (get-char-property s 'invisible))))
20083 s))
20085 (defun org-copy-visible (beg end)
20086 "Copy the visible parts of the region."
20087 (interactive "r")
20088 (let (snippets s)
20089 (save-excursion
20090 (save-restriction
20091 (narrow-to-region beg end)
20092 (setq s (goto-char (point-min)))
20093 (while (not (= (point) (point-max)))
20094 (goto-char (org-find-invisible))
20095 (push (buffer-substring s (point)) snippets)
20096 (setq s (goto-char (org-find-visible))))))
20097 (kill-new (apply 'concat (nreverse snippets)))))
20099 (defun org-copy-special ()
20100 "Copy region in table or copy current subtree.
20101 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20102 See the individual commands for more information."
20103 (interactive)
20104 (call-interactively
20105 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20107 (defun org-cut-special ()
20108 "Cut region in table or cut current subtree.
20109 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20110 See the individual commands for more information."
20111 (interactive)
20112 (call-interactively
20113 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20115 (defun org-paste-special (arg)
20116 "Paste rectangular region into table, or past subtree relative to level.
20117 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20118 See the individual commands for more information."
20119 (interactive "P")
20120 (if (org-at-table-p)
20121 (org-table-paste-rectangle)
20122 (org-paste-subtree arg)))
20124 (defsubst org-in-fixed-width-region-p ()
20125 "Is point in a fixed-width region?"
20126 (save-match-data
20127 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20129 (defun org-edit-special (&optional arg)
20130 "Call a special editor for the element at point.
20131 When at a table, call the formula editor with `org-table-edit-formulas'.
20132 When in a source code block, call `org-edit-src-code'.
20133 When in a fixed-width region, call `org-edit-fixed-width-region'.
20134 When at an #+INCLUDE keyword, visit the included file.
20135 On a link, call `ffap' to visit the link at point.
20136 Otherwise, return a user error."
20137 (interactive "P")
20138 (let ((element (org-element-at-point)))
20139 (assert (not buffer-read-only) nil
20140 "Buffer is read-only: %s" (buffer-name))
20141 (case (org-element-type element)
20142 (src-block
20143 (if (not arg) (org-edit-src-code)
20144 (let* ((info (org-babel-get-src-block-info))
20145 (lang (nth 0 info))
20146 (params (nth 2 info))
20147 (session (cdr (assq :session params))))
20148 (if (not session) (org-edit-src-code)
20149 ;; At a src-block with a session and function called with
20150 ;; an ARG: switch to the buffer related to the inferior
20151 ;; process.
20152 (switch-to-buffer
20153 (funcall (intern (concat "org-babel-prep-session:" lang))
20154 session params))))))
20155 (keyword
20156 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20157 (find-file
20158 (org-remove-double-quotes
20159 (car (org-split-string (org-element-property :value element)))))
20160 (user-error "No special environment to edit here")))
20161 (table
20162 (if (eq (org-element-property :type element) 'table.el)
20163 (org-edit-src-code)
20164 (call-interactively 'org-table-edit-formulas)))
20165 ;; Only Org tables contain `table-row' type elements.
20166 (table-row (call-interactively 'org-table-edit-formulas))
20167 ((example-block export-block) (org-edit-src-code))
20168 (fixed-width (org-edit-fixed-width-region))
20169 (otherwise
20170 ;; No notable element at point. Though, we may be at a link,
20171 ;; which is an object. Thus, scan deeper.
20172 (if (eq (org-element-type (org-element-context element)) 'link)
20173 (call-interactively 'ffap)
20174 (user-error "No special environment to edit here"))))))
20176 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20177 (defun org-ctrl-c-ctrl-c (&optional arg)
20178 "Set tags in headline, or update according to changed information at point.
20180 This command does many different things, depending on context:
20182 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20183 this is what we do.
20185 - If the cursor is on a statistics cookie, update it.
20187 - If the cursor is in a headline, prompt for tags and insert them
20188 into the current line, aligned to `org-tags-column'. When called
20189 with prefix arg, realign all tags in the current buffer.
20191 - If the cursor is in one of the special #+KEYWORD lines, this
20192 triggers scanning the buffer for these lines and updating the
20193 information.
20195 - If the cursor is inside a table, realign the table. This command
20196 works even if the automatic table editor has been turned off.
20198 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20199 the entire table.
20201 - If the cursor is at a footnote reference or definition, jump to
20202 the corresponding definition or references, respectively.
20204 - If the cursor is a the beginning of a dynamic block, update it.
20206 - If the current buffer is a capture buffer, close note and file it.
20208 - If the cursor is on a <<<target>>>, update radio targets and
20209 corresponding links in this buffer.
20211 - If the cursor is on a numbered item in a plain list, renumber the
20212 ordered list.
20214 - If the cursor is on a checkbox, toggle it.
20216 - If the cursor is on a code block, evaluate it. The variable
20217 `org-confirm-babel-evaluate' can be used to control prompting
20218 before code block evaluation, by default every code block
20219 evaluation requires confirmation. Code block evaluation can be
20220 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20221 (interactive "P")
20222 (cond
20223 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20224 org-occur-highlights
20225 org-latex-fragment-image-overlays)
20226 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20227 (org-remove-occur-highlights)
20228 (org-remove-latex-fragment-image-overlays)
20229 (message "Temporary highlights/overlays removed from current buffer"))
20230 ((and (local-variable-p 'org-finish-function (current-buffer))
20231 (fboundp org-finish-function))
20232 (funcall org-finish-function))
20233 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20234 (t
20235 (let* ((context (org-element-context)) (type (org-element-type context)))
20236 ;; Test if point is within a blank line.
20238 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20239 (user-error "C-c C-c can do nothing useful at this location"))
20240 ;; When at a link, act according to the parent instead.
20241 (when (eq type 'link)
20242 (setq context (org-element-property :parent context))
20243 (setq type (org-element-type context)))
20244 ;; For convenience: at the first line of a paragraph on the
20245 ;; same line as an item, apply function on that item instead.
20246 (when (eq type 'paragraph)
20247 (let ((parent (org-element-property :parent context)))
20248 (when (and (eq (org-element-type parent) 'item)
20249 (= (point-at-bol) (org-element-property :begin parent)))
20250 (setq context parent type 'item))))
20251 ;; Act according to type of element or object at point.
20252 (case type
20253 (clock (org-clock-update-time-maybe))
20254 (dynamic-block
20255 (save-excursion
20256 (goto-char (org-element-property :post-affiliated context))
20257 (org-update-dblock)))
20258 (footnote-definition
20259 (goto-char (org-element-property :post-affiliated context))
20260 (call-interactively 'org-footnote-action))
20261 (footnote-reference (call-interactively 'org-footnote-action))
20262 ((headline inlinetask)
20263 (save-excursion (goto-char (org-element-property :begin context))
20264 (call-interactively 'org-set-tags)))
20265 (item
20266 ;; At an item: a double C-u set checkbox to "[-]"
20267 ;; unconditionally, whereas a single one will toggle its
20268 ;; presence. Without an universal argument, if the item
20269 ;; has a checkbox, toggle it. Otherwise repair the list.
20270 (let* ((box (org-element-property :checkbox context))
20271 (struct (org-element-property :structure context))
20272 (old-struct (copy-tree struct))
20273 (parents (org-list-parents-alist struct))
20274 (prevs (org-list-prevs-alist struct))
20275 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20276 (org-list-set-checkbox
20277 (org-element-property :begin context) struct
20278 (cond ((equal arg '(16)) "[-]")
20279 ((and (not box) (equal arg '(4))) "[ ]")
20280 ((or (not box) (equal arg '(4))) nil)
20281 ((eq box 'on) "[ ]")
20282 (t "[X]")))
20283 ;; Mimic `org-list-write-struct' but with grabbing
20284 ;; a return value from `org-list-struct-fix-box'.
20285 (org-list-struct-fix-ind struct parents 2)
20286 (org-list-struct-fix-item-end struct)
20287 (org-list-struct-fix-bul struct prevs)
20288 (org-list-struct-fix-ind struct parents)
20289 (let ((block-item
20290 (org-list-struct-fix-box struct parents prevs orderedp)))
20291 (if (and box (equal struct old-struct))
20292 (if (equal arg '(16))
20293 (message "Checkboxes already reset")
20294 (user-error "Cannot toggle this checkbox: %s"
20295 (if (eq box 'on)
20296 "all subitems checked"
20297 "unchecked subitems")))
20298 (org-list-struct-apply-struct struct old-struct)
20299 (org-update-checkbox-count-maybe))
20300 (when block-item
20301 (message "Checkboxes were removed due to empty box at line %d"
20302 (org-current-line block-item))))))
20303 (keyword
20304 (let ((org-inhibit-startup-visibility-stuff t)
20305 (org-startup-align-all-tables nil))
20306 (when (boundp 'org-table-coordinate-overlays)
20307 (mapc 'delete-overlay org-table-coordinate-overlays)
20308 (setq org-table-coordinate-overlays nil))
20309 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20310 (message "Local setup has been refreshed"))
20311 (plain-list
20312 ;; At a plain list, with a double C-u argument, set
20313 ;; checkboxes of each item to "[-]", whereas a single one
20314 ;; will toggle their presence according to the state of the
20315 ;; first item in the list. Without an argument, repair the
20316 ;; list.
20317 (let* ((begin (org-element-property :contents-begin context))
20318 (beginm (move-marker (make-marker) begin))
20319 (struct (org-element-property :structure context))
20320 (old-struct (copy-tree struct))
20321 (first-box (save-excursion
20322 (goto-char begin)
20323 (looking-at org-list-full-item-re)
20324 (match-string-no-properties 3)))
20325 (new-box (cond ((equal arg '(16)) "[-]")
20326 ((equal arg '(4)) (unless first-box "[ ]"))
20327 ((equal first-box "[X]") "[ ]")
20328 (t "[X]"))))
20329 (cond
20330 (arg
20331 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20332 (org-list-get-all-items
20333 begin struct (org-list-prevs-alist struct))))
20334 ((and first-box (eq (point) begin))
20335 ;; For convenience, when point is at bol on the first
20336 ;; item of the list and no argument is provided, simply
20337 ;; toggle checkbox of that item, if any.
20338 (org-list-set-checkbox begin struct new-box)))
20339 (org-list-write-struct
20340 struct (org-list-parents-alist struct) old-struct)
20341 (org-update-checkbox-count-maybe)
20342 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20343 ((property-drawer node-property)
20344 (call-interactively 'org-property-action))
20345 ((radio-target target)
20346 (call-interactively 'org-update-radio-target-regexp))
20347 (statistics-cookie
20348 (call-interactively 'org-update-statistics-cookies))
20349 ((table table-cell table-row)
20350 ;; At a table, recalculate every field and align it. Also
20351 ;; send the table if necessary. If the table has
20352 ;; a `table.el' type, just give up. At a table row or
20353 ;; cell, maybe recalculate line but always align table.
20354 (if (eq (org-element-property :type context) 'table.el)
20355 (message "Use C-c ' to edit table.el tables")
20356 (let ((org-enable-table-editor t))
20357 (if (or (eq type 'table)
20358 ;; Check if point is at a TBLFM line.
20359 (and (eq type 'table-row)
20360 (= (point) (org-element-property :end context))))
20361 (save-excursion
20362 (if (org-at-TBLFM-p)
20363 (progn (require 'org-table)
20364 (org-table-calc-current-TBLFM))
20365 (goto-char (org-element-property :contents-begin context))
20366 (org-call-with-arg 'org-table-recalculate (or arg t))
20367 (orgtbl-send-table 'maybe)))
20368 (org-table-maybe-eval-formula)
20369 (cond (arg (call-interactively 'org-table-recalculate))
20370 ((org-table-maybe-recalculate-line))
20371 (t (org-table-align)))))))
20372 (timestamp (org-timestamp-change 0 'day))
20373 (otherwise
20374 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20375 (user-error
20376 "C-c C-c can do nothing useful at this location")))))))))
20378 (defun org-mode-restart ()
20379 "Restart Org-mode, to scan again for special lines.
20380 Also updates the keyword regular expressions."
20381 (interactive)
20382 (org-mode)
20383 (message "Org-mode restarted"))
20385 (defun org-kill-note-or-show-branches ()
20386 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20387 (interactive)
20388 (if (not org-finish-function)
20389 (progn
20390 (hide-subtree)
20391 (call-interactively 'show-branches))
20392 (let ((org-note-abort t))
20393 (funcall org-finish-function))))
20395 (defun org-open-line (n)
20396 "Insert a new row in tables, call `open-line' elsewhere.
20397 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20398 (interactive "*p")
20399 (cond
20400 ((not org-special-ctrl-o)
20401 (open-line n))
20402 ((org-at-table-p)
20403 (org-table-insert-row))
20404 (t
20405 (open-line n))))
20407 (defun org-return (&optional indent)
20408 "Goto next table row or insert a newline.
20409 Calls `org-table-next-row' or `newline', depending on context.
20410 See the individual commands for more information."
20411 (interactive)
20412 (let (org-ts-what)
20413 (cond
20414 ((or (bobp) (org-in-src-block-p))
20415 (if indent (newline-and-indent) (newline)))
20416 ((org-at-table-p)
20417 (org-table-justify-field-maybe)
20418 (call-interactively 'org-table-next-row))
20419 ;; when `newline-and-indent' is called within a list, make sure
20420 ;; text moved stays inside the item.
20421 ((and (org-in-item-p) indent)
20422 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20423 (progn
20424 (save-match-data (newline))
20425 (org-indent-line-to (length (match-string 0))))
20426 (let ((ind (org-get-indentation)))
20427 (newline)
20428 (if (org-looking-back org-list-end-re)
20429 (org-indent-line)
20430 (org-indent-line-to ind)))))
20431 ((and org-return-follows-link
20432 (org-at-timestamp-p t)
20433 (not (eq org-ts-what 'after)))
20434 (org-follow-timestamp-link))
20435 ((and org-return-follows-link
20436 (let ((tprop (get-text-property (point) 'face)))
20437 (or (eq tprop 'org-link)
20438 (and (listp tprop) (memq 'org-link tprop)))))
20439 (call-interactively 'org-open-at-point))
20440 ((and (org-at-heading-p)
20441 (looking-at
20443 (org-show-entry)
20444 (end-of-line 1)
20445 (newline))
20446 (t (if indent (newline-and-indent) (newline))))))
20448 (defun org-return-indent ()
20449 "Goto next table row or insert a newline and indent.
20450 Calls `org-table-next-row' or `newline-and-indent', depending on
20451 context. See the individual commands for more information."
20452 (interactive)
20453 (org-return t))
20455 (defun org-ctrl-c-star ()
20456 "Compute table, or change heading status of lines.
20457 Calls `org-table-recalculate' or `org-toggle-heading',
20458 depending on context."
20459 (interactive)
20460 (cond
20461 ((org-at-table-p)
20462 (call-interactively 'org-table-recalculate))
20463 (t
20464 ;; Convert all lines in region to list items
20465 (call-interactively 'org-toggle-heading))))
20467 (defun org-ctrl-c-minus ()
20468 "Insert separator line in table or modify bullet status of line.
20469 Also turns a plain line or a region of lines into list items.
20470 Calls `org-table-insert-hline', `org-toggle-item', or
20471 `org-cycle-list-bullet', depending on context."
20472 (interactive)
20473 (cond
20474 ((org-at-table-p)
20475 (call-interactively 'org-table-insert-hline))
20476 ((org-region-active-p)
20477 (call-interactively 'org-toggle-item))
20478 ((org-in-item-p)
20479 (call-interactively 'org-cycle-list-bullet))
20480 (t
20481 (call-interactively 'org-toggle-item))))
20483 (defun org-toggle-item (arg)
20484 "Convert headings or normal lines to items, items to normal lines.
20485 If there is no active region, only the current line is considered.
20487 If the first non blank line in the region is a headline, convert
20488 all headlines to items, shifting text accordingly.
20490 If it is an item, convert all items to normal lines.
20492 If it is normal text, change region into a list of items.
20493 With a prefix argument ARG, change the region in a single item."
20494 (interactive "P")
20495 (let ((shift-text
20496 (function
20497 ;; Shift text in current section to IND, from point to END.
20498 ;; The function leaves point to END line.
20499 (lambda (ind end)
20500 (let ((min-i 1000) (end (copy-marker end)))
20501 ;; First determine the minimum indentation (MIN-I) of
20502 ;; the text.
20503 (save-excursion
20504 (catch 'exit
20505 (while (< (point) end)
20506 (let ((i (org-get-indentation)))
20507 (cond
20508 ;; Skip blank lines and inline tasks.
20510 ((looking-at org-outline-regexp-bol))
20511 ;; We can't find less than 0 indentation.
20512 ((zerop i) (throw 'exit (setq min-i 0)))
20513 ((< i min-i) (setq min-i i))))
20514 (forward-line))))
20515 ;; Then indent each line so that a line indented to
20516 ;; MIN-I becomes indented to IND. Ignore blank lines
20517 ;; and inline tasks in the process.
20518 (let ((delta (- ind min-i)))
20519 (while (< (point) end)
20521 (looking-at org-outline-regexp-bol))
20522 (org-indent-line-to (+ (org-get-indentation) delta)))
20523 (forward-line)))))))
20524 (skip-blanks
20525 (function
20526 ;; Return beginning of first non-blank line, starting from
20527 ;; line at POS.
20528 (lambda (pos)
20529 (save-excursion
20530 (goto-char pos)
20532 (point-at-bol)))))
20533 beg end)
20534 ;; Determine boundaries of changes.
20535 (if (org-region-active-p)
20536 (setq beg (funcall skip-blanks (region-beginning))
20537 end (copy-marker (region-end)))
20538 (setq beg (funcall skip-blanks (point-at-bol))
20539 end (copy-marker (point-at-eol))))
20540 ;; Depending on the starting line, choose an action on the text
20541 ;; between BEG and END.
20542 (org-with-limited-levels
20543 (save-excursion
20544 (goto-char beg)
20545 (cond
20546 ;; Case 1. Start at an item: de-itemize. Note that it only
20547 ;; happens when a region is active: `org-ctrl-c-minus'
20548 ;; would call `org-cycle-list-bullet' otherwise.
20549 ((org-at-item-p)
20550 (while (< (point) end)
20551 (when (org-at-item-p)
20553 (delete-region (point) (match-end 0)))
20554 (forward-line)))
20555 ;; Case 2. Start at an heading: convert to items.
20556 ((org-at-heading-p)
20557 (let* ((bul (org-list-bullet-string "-"))
20558 (bul-len (length bul))
20559 ;; Indentation of the first heading. It should be
20560 ;; relative to the indentation of its parent, if any.
20561 (start-ind (save-excursion
20562 (cond
20563 ((not org-adapt-indentation) 0)
20564 ((not (outline-previous-heading)) 0)
20565 (t (length (match-string 0))))))
20566 ;; Level of first heading. Further headings will be
20567 ;; compared to it to determine hierarchy in the list.
20568 (ref-level (org-reduced-level (org-outline-level))))
20569 (while (< (point) end)
20570 (let* ((level (org-reduced-level (org-outline-level)))
20571 (delta (max 0 (- level ref-level))))
20572 ;; If current headline is less indented than the first
20573 ;; one, set it as reference, in order to preserve
20574 ;; subtrees.
20575 (when (< level ref-level) (setq ref-level level))
20576 (replace-match bul t t)
20577 (org-indent-line-to (+ start-ind (* delta bul-len)))
20578 ;; Ensure all text down to END (or SECTION-END) belongs
20579 ;; to the newly created item.
20580 (let ((section-end (save-excursion
20581 (or (outline-next-heading) (point)))))
20582 (forward-line)
20583 (funcall shift-text
20584 (+ start-ind (* (1+ delta) bul-len))
20585 (min end section-end)))))))
20586 ;; Case 3. Normal line with ARG: make the first line of region
20587 ;; an item, and shift indentation of others lines to
20588 ;; set them as item's body.
20589 (arg (let* ((bul (org-list-bullet-string "-"))
20590 (bul-len (length bul))
20591 (ref-ind (org-get-indentation)))
20593 (insert bul)
20594 (forward-line)
20595 (while (< (point) end)
20596 ;; Ensure that lines less indented than first one
20597 ;; still get included in item body.
20598 (funcall shift-text
20599 (+ ref-ind bul-len)
20600 (min end (save-excursion (or (outline-next-heading)
20601 (point)))))
20602 (forward-line))))
20603 ;; Case 4. Normal line without ARG: turn each non-item line
20604 ;; into an item.
20605 (t
20606 (while (< (point) end)
20607 (unless (or (org-at-heading-p) (org-at-item-p))
20609 (replace-match
20611 (forward-line))))))))
20613 (defun org-toggle-heading (&optional nstars)
20614 "Convert headings to normal text, or items or text to headings.
20615 If there is no active region, only convert the current line.
20618 point into heading.
20620 In a region:
20622 - If the first non blank line is a headline, remove the stars
20623 from all headlines in the region.
20625 - If it is a normal line, turn each and every normal line (i.e.,
20626 not an heading or an item) in the region into headings. If you
20627 want to convert only the first line of this region, use one
20628 universal prefix argument.
20630 - If it is a plain list item, turn all plain list items into headings.
20632 When converting a line into a heading, the number of stars is chosen
20633 such that the lines become children of the current entry. However,
20634 when a numeric prefix argument is given, its value determines the
20635 number of stars to add."
20636 (interactive "P")
20637 (let ((skip-blanks
20638 (function
20639 ;; Return beginning of first non-blank line, starting from
20640 ;; line at POS.
20641 (lambda (pos)
20642 (save-excursion
20643 (goto-char pos)
20644 (while (org-at-comment-p) (forward-line))
20646 (point-at-bol)))))
20647 beg end toggled)
20648 ;; Determine boundaries of changes. If a universal prefix has
20649 ;; been given, put the list in a region. If region ends at a bol,
20650 ;; do not consider the last line to be in the region.
20652 (when (and current-prefix-arg (org-at-item-p))
20653 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20654 (org-mark-element))
20656 (if (org-region-active-p)
20657 (setq beg (funcall skip-blanks (region-beginning))
20658 end (copy-marker (save-excursion
20659 (goto-char (region-end))
20660 (if (bolp) (point) (point-at-eol)))))
20661 (setq beg (funcall skip-blanks (point-at-bol))
20662 end (copy-marker (point-at-eol))))
20663 ;; Ensure inline tasks don't count as headings.
20664 (org-with-limited-levels
20665 (save-excursion
20666 (goto-char beg)
20667 (cond
20668 ;; Case 1. Started at an heading: de-star headings.
20669 ((org-at-heading-p)
20670 (while (< (point) end)
20671 (when (org-at-heading-p t)
20672 (looking-at org-outline-regexp) (replace-match "")
20673 (setq toggled t))
20674 (forward-line)))
20675 ;; Case 2. Started at an item: change items into headlines.
20676 ;; One star will be added by `org-list-to-subtree'.
20677 ((org-at-item-p)
20678 (let* ((stars (make-string
20679 ;; subtract the star that will be added again by
20680 ;; `org-list-to-subtree'
20681 (if (numberp nstars) (1- nstars)
20682 (or (org-current-level) 0))
20683 ?*))
20684 (add-stars
20685 (cond (nstars "") ; stars from prefix only
20686 ((equal stars "") "") ; before first heading
20687 (org-odd-levels-only "*") ; inside heading, odd
20688 (t "")))) ; inside heading, oddeven
20689 (while (< (point) end)
20690 (when (org-at-item-p)
20691 ;; Pay attention to cases when region ends before list.
20692 (let* ((struct (org-list-struct))
20693 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20694 (save-restriction
20695 (narrow-to-region (point) list-end)
20696 (insert
20697 (org-list-to-subtree
20698 (org-list-parse-list t)
20699 '(:istart (concat stars add-stars (funcall get-stars depth))
20700 :icount (concat stars add-stars (funcall get-stars depth)))))))
20701 (setq toggled t))
20702 (forward-line))))
20703 ;; Case 3. Started at normal text: make every line an heading,
20704 ;; skipping headlines and items.
20705 (t (let* ((stars
20706 (make-string
20707 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20708 (add-stars
20709 (cond (nstars "") ; stars from prefix only
20710 ((equal stars "") "*") ; before first heading
20711 (org-odd-levels-only "**") ; inside heading, odd
20712 (t "*"))) ; inside heading, oddeven
20713 (rpl (concat stars add-stars " "))
20714 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20715 (while (< (point) (if (equal nstars '(4)) lend end))
20716 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20718 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20719 (forward-line)))))))
20720 (unless toggled (message "Cannot toggle heading from here"))))
20722 (defun org-meta-return (&optional arg)
20723 "Insert a new heading or wrap a region in a table.
20724 Calls `org-insert-heading' or `org-table-wrap-region', depending
20725 on context. See the individual commands for more information."
20726 (interactive "P")
20727 (org-check-before-invisible-edit 'insert)
20728 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20729 (let* ((element (org-element-at-point))
20730 (type (org-element-type element)))
20731 (when (eq type 'table-row)
20732 (setq element (org-element-property :parent element))
20733 (setq type 'table))
20734 (if (and (eq type 'table)
20735 (eq (org-element-property :type element) 'org)
20736 (>= (point) (org-element-property :contents-begin element))
20737 (< (point) (org-element-property :contents-end element)))
20738 (call-interactively 'org-table-wrap-region)
20739 (call-interactively 'org-insert-heading)))))
20741 ;;; Menu entries
20743 (defsubst org-in-subtree-not-table-p ()
20744 "Are we in a subtree and not in a table?"
20745 (and (not (org-before-first-heading-p))
20746 (not (org-at-table-p))))
20748 ;; Define the Org-mode menus
20749 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20750 '("Tbl"
20751 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20752 ["Next Field" org-cycle (org-at-table-p)]
20753 ["Previous Field" org-shifttab (org-at-table-p)]
20754 ["Next Row" org-return (org-at-table-p)]
20755 "--"
20756 ["Blank Field" org-table-blank-field (org-at-table-p)]
20757 ["Edit Field" org-table-edit-field (org-at-table-p)]
20758 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20759 "--"
20760 ("Column"
20761 ["Move Column Left" org-metaleft (org-at-table-p)]
20762 ["Move Column Right" org-metaright (org-at-table-p)]
20763 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20764 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20765 ("Row"
20766 ["Move Row Up" org-metaup (org-at-table-p)]
20767 ["Move Row Down" org-metadown (org-at-table-p)]
20768 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20769 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20770 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20771 "--"
20772 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20773 ("Rectangle"
20774 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20775 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20776 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20777 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20778 "--"
20779 ("Calculate"
20780 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20781 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20782 ["Edit Formulas" org-edit-special (org-at-table-p)]
20783 "--"
20784 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20785 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20786 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20787 "--"
20788 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20789 "--"
20790 ["Sum Column/Rectangle" org-table-sum
20791 (or (org-at-table-p) (org-region-active-p))]
20792 ["Which Column?" org-table-current-column (org-at-table-p)])
20793 ["Debug Formulas"
20794 org-table-toggle-formula-debugger
20795 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20796 ["Show Col/Row Numbers"
20797 org-table-toggle-coordinate-overlays
20798 :style toggle
20799 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20800 "--"
20801 ["Create" org-table-create (and (not (org-at-table-p))
20802 org-enable-table-editor)]
20803 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20804 ["Import from File" org-table-import (not (org-at-table-p))]
20805 ["Export to File" org-table-export (org-at-table-p)]
20806 "--"
20807 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20809 (easy-menu-define org-org-menu org-mode-map "Org menu"
20810 '("Org"
20811 ("Show/Hide"
20812 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20813 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20814 ["Sparse Tree..." org-sparse-tree t]
20815 ["Reveal Context" org-reveal t]
20816 ["Show All" show-all t]
20817 "--"
20818 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20819 "--"
20820 ["New Heading" org-insert-heading t]
20821 ("Navigate Headings"
20822 ["Up" outline-up-heading t]
20823 ["Next" outline-next-visible-heading t]
20824 ["Previous" outline-previous-visible-heading t]
20825 ["Next Same Level" outline-forward-same-level t]
20826 ["Previous Same Level" outline-backward-same-level t]
20827 "--"
20828 ["Jump" org-goto t])
20829 ("Edit Structure"
20830 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20831 "--"
20832 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20833 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20834 "--"
20835 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20836 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20837 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20838 "--"
20839 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20840 "--"
20841 ["Copy visible text" org-copy-visible t]
20842 "--"
20843 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20844 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20845 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20846 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20847 "--"
20848 ["Sort Region/Children" org-sort t]
20849 "--"
20850 ["Convert to odd levels" org-convert-to-odd-levels t]
20851 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20852 ("Editing"
20853 ["Emphasis..." org-emphasize t]
20854 ["Edit Source Example" org-edit-special t]
20855 "--"
20856 ["Footnote new/jump" org-footnote-action t]
20857 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20858 ("Archive"
20859 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20860 "--"
20861 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20862 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20863 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20864 )
20865 "--"
20866 ("Hyperlinks"
20867 ["Store Link (Global)" org-store-link t]
20868 ["Find existing link to here" org-occur-link-in-agenda-files t]
20869 ["Insert Link" org-insert-link t]
20870 ["Follow Link" org-open-at-point t]
20871 "--"
20872 ["Next link" org-next-link t]
20873 ["Previous link" org-previous-link t]
20874 "--"
20875 ["Descriptive Links"
20876 org-toggle-link-display
20877 :style radio
20878 :selected org-descriptive-links
20879 ]
20880 ["Literal Links"
20881 org-toggle-link-display
20882 :style radio
20883 :selected (not org-descriptive-links)])
20884 "--"
20885 ("TODO Lists"
20886 ["TODO/DONE/-" org-todo t]
20887 ("Select keyword"
20888 ["Next keyword" org-shiftright (org-at-heading-p)]
20889 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20890 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20891 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20892 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20893 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20894 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20895 "--"
20896 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20897 :selected org-enforce-todo-dependencies :style toggle :active t]
20898 "Settings for tree at point"
20899 ["Do Children sequentially" org-toggle-ordered-property :style radio
20900 :selected (org-entry-get nil "ORDERED")
20901 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20902 ["Do Children parallel" org-toggle-ordered-property :style radio
20903 :selected (not (org-entry-get nil "ORDERED"))
20904 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20905 "--"
20906 ["Set Priority" org-priority t]
20907 ["Priority Up" org-shiftup t]
20908 ["Priority Down" org-shiftdown t]
20909 "--"
20910 ["Get news from all feeds" org-feed-update-all t]
20911 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20912 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20913 ("TAGS and Properties"
20914 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20915 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20916 "--"
20917 ["Set property" org-set-property (not (org-before-first-heading-p))]
20918 ["Column view of properties" org-columns t]
20919 ["Insert Column View DBlock" org-insert-columns-dblock t])
20920 ("Dates and Scheduling"
20921 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20922 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20923 ("Change Date"
20924 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20925 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20926 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20927 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20928 ["Compute Time Range" org-evaluate-time-range t]
20929 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20930 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20931 "--"
20932 ["Custom time format" org-toggle-time-stamp-overlays
20933 :style radio :selected org-display-custom-times]
20934 "--"
20935 ["Goto Calendar" org-goto-calendar t]
20936 ["Date from Calendar" org-date-from-calendar t]
20937 "--"
20938 ["Start/Restart Timer" org-timer-start t]
20939 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20940 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20941 ["Insert Timer String" org-timer t]
20942 ["Insert Timer Item" org-timer-item t])
20943 ("Logging work"
20944 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20945 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20946 ["Clock out" org-clock-out t]
20947 ["Clock cancel" org-clock-cancel t]
20948 "--"
20949 ["Mark as default task" org-clock-mark-default-task t]
20950 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20951 ["Goto running clock" org-clock-goto t]
20952 "--"
20953 ["Display times" org-clock-display t]
20954 ["Create clock table" org-clock-report t]
20955 "--"
20956 ["Record DONE time"
20957 (progn (setq org-log-done (not org-log-done))
20958 (message "Switching to %s will %s record a timestamp"
20959 (car org-done-keywords)
20960 (if org-log-done "automatically" "not")))
20961 :style toggle :selected org-log-done])
20962 "--"
20963 ["Agenda Command..." org-agenda t]
20964 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20965 ("File List for Agenda")
20966 ("Special views current file"
20967 ["TODO Tree" org-show-todo-tree t]
20968 ["Check Deadlines" org-check-deadlines t]
20969 ["Timeline" org-timeline t]
20970 ["Tags/Property tree" org-match-sparse-tree t])
20971 "--"
20972 ["Export/Publish..." org-export-dispatch t]
20973 ("LaTeX"
20974 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20975 :selected org-cdlatex-mode]
20976 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20977 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20978 ["Modify math symbol" org-cdlatex-math-modify
20979 (org-inside-LaTeX-fragment-p)]
20980 ["Insert citation" org-reftex-citation t]
20981 "--"
20982 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20983 "--"
20984 ("MobileOrg"
20985 ["Push Files and Views" org-mobile-push t]
20986 ["Get Captured and Flagged" org-mobile-pull t]
20987 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20988 "--"
20989 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20990 "--"
20991 ("Documentation"
20992 ["Show Version" org-version t]
20993 ["Info Documentation" org-info t])
20994 ("Customize"
20995 ["Browse Org Group" org-customize t]
20996 "--"
20997 ["Expand This Menu" org-create-customize-menu
20998 (fboundp 'customize-menu-create)])
20999 ["Send bug report" org-submit-bug-report t]
21000 "--"
21001 ("Refresh/Reload"
21002 ["Refresh setup current buffer" org-mode-restart t]
21003 ["Reload Org (after update)" org-reload t]
21004 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21005 ))
21007 (defun org-info (&optional node)
21008 "Read documentation for Org-mode in the info system.
21009 With optional NODE, go directly to that node."
21010 (interactive)
21011 (info (format "(org)%s" (or node ""))))
21013 ;;;###autoload
21014 (defun org-submit-bug-report ()
21015 "Submit a bug report on Org-mode via mail.
21017 Don't hesitate to report any problems or inaccurate documentation.
21019 If you don't have setup sending mail from (X)Emacs, please copy the
21020 output buffer into your mail program, as it gives us important
21021 information about your Org-mode version and configuration."
21022 (interactive)
21023 (require 'reporter)
21024 (org-load-modules-maybe)
21025 (org-require-autoloaded-modules)
21026 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21027 (reporter-submit-bug-report
21028 "emacs-orgmode@gnu.org"
21029 (org-version nil 'full)
21030 (let (list)
21031 (save-window-excursion
21032 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21033 (delete-other-windows)
21034 (erase-buffer)
21035 (insert "You are about to submit a bug report to the Org-mode mailing list.
21037 We would like to add your full Org-mode and Outline configuration to the
21038 bug report. This greatly simplifies the work of the maintainer and
21039 other experts on the mailing list.
21041 HOWEVER, some variables you have customized may contain private
21042 information. The names of customers, colleagues, or friends, might
21043 appear in the form of file names, tags, todo states, or search strings.
21044 If you answer yes to the prompt, you might want to check and remove
21045 such private information before sending the email.")
21046 (add-text-properties (point-min) (point-max) '(face org-warning))
21047 (when (yes-or-no-p "Include your Org-mode configuration ")
21048 (mapatoms
21049 (lambda (v)
21050 (and (boundp v)
21052 (or (and (symbol-value v)
21054 (and
21055 (get v 'custom-type) (get v 'standard-value)
21056 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21057 (push v list)))))
21058 (kill-buffer (get-buffer "*Warn about privacy*"))
21059 list))
21060 nil nil
21061 "Remember to cover the basics, that is, what you expected to happen and
21062 what in fact did happen. You don't know how to make a good report? See
21064 http://orgmode.org/manual/Feedback.html#Feedback
21066 Your bug report will be posted to the Org-mode mailing list.
21067 ------------------------------------------------------------------------")
21068 (save-excursion
21073 (defun org-install-agenda-files-menu ()
21074 (let ((bl (buffer-list)))
21075 (save-excursion
21076 (while bl
21077 (set-buffer (pop bl))
21078 (if (derived-mode-p 'org-mode) (setq bl nil)))
21079 (when (derived-mode-p 'org-mode)
21080 (easy-menu-change
21081 '("Org") "File List for Agenda"
21082 (append
21083 (list
21084 ["Edit File List" (org-edit-agenda-file-list) t]
21085 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21086 ["Remove Current File from List" org-remove-file t]
21087 ["Cycle through agenda files" org-cycle-agenda-files t]
21088 ["Occur in all agenda files" org-occur-in-agenda-files t]
21089 "--")
21090 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21092 ;;;; Documentation
21094 (defun org-require-autoloaded-modules ()
21095 (interactive)
21096 (mapc 'require
21097 '(org-agenda org-archive org-attach org-clock org-colview org-id
21098 org-table org-timer)))
21100 ;;;###autoload
21101 (defun org-reload (&optional uncompiled)
21102 "Reload all org lisp files.
21103 With prefix arg UNCOMPILED, load the uncompiled versions."
21104 (interactive "P")
21105 (require 'loadhist)
21106 (let* ((org-dir (org-find-library-dir "org"))
21107 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21109 (remove-re (mapconcat 'identity
21110 (mapcar (lambda (f) (concat "^" f "$"))
21111 (list (if (featurep 'xemacs)
21112 "org-colview"
21113 "org-colview-xemacs")
21114 "org" "org-loaddefs" "org-version"))
21116 (feats (delete-dups
21117 (mapcar 'file-name-sans-extension
21118 (mapcar 'file-name-nondirectory
21119 (delq nil
21120 (mapcar 'feature-file
21121 features))))))
21122 (lfeat (append
21123 (sort
21124 (setq feats
21125 (delq nil (mapcar
21126 (lambda (f)
21127 (if (and (string-match feature-re f)
21128 (not (string-match remove-re f)))
21129 f nil))
21130 feats)))
21131 'string-lessp)
21132 (list "org-version" "org")))
21133 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21134 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21135 load-uncore load-misses)
21136 (setq load-misses
21137 (delq 't
21138 (mapcar (lambda (f)
21139 (or (org-load-noerror-mustsuffix (concat org-dir f))
21140 (and (string= org-dir contrib-dir)
21141 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21142 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21143 (add-to-list 'load-uncore f 'append)
21144 't)
21145 f))
21146 lfeat)))
21147 (if load-uncore
21149 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21150 (if load-misses
21152 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21155 ;;;###autoload
21156 (defun org-customize ()
21157 "Call the customize function with org as argument."
21158 (interactive)
21159 (org-load-modules-maybe)
21160 (org-require-autoloaded-modules)
21161 (customize-browse 'org))
21163 (defun org-create-customize-menu ()
21164 "Create a full customization menu for Org-mode, insert it into the menu."
21165 (interactive)
21166 (org-load-modules-maybe)
21167 (org-require-autoloaded-modules)
21168 (if (fboundp 'customize-menu-create)
21169 (progn
21170 (easy-menu-change
21171 '("Org") "Customize"
21172 `(["Browse Org group" org-customize t]
21173 "--"
21174 ,(customize-menu-create 'org)
21175 ["Set" Custom-set t]
21176 ["Save" Custom-save t]
21177 ["Reset to Current" Custom-reset-current t]
21178 ["Reset to Saved" Custom-reset-saved t]
21179 ["Reset to Standard Settings" Custom-reset-standard t]))
21181 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21183 ;;;; Miscellaneous stuff
21185 ;;; Generally useful functions
21187 (defun org-get-at-bol (property)
21188 "Get text property PROPERTY at beginning of line."
21189 (get-text-property (point-at-bol) property))
21191 (defun org-find-text-property-in-string (prop s)
21192 "Return the first non-nil value of property PROP in string S."
21193 (or (get-text-property 0 prop s)
21194 (get-text-property (or (next-single-property-change 0 prop s) 0)
21195 prop s)))
21197 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21198 "Display the given MESSAGE as a warning."
21199 (if (fboundp 'display-warning)
21200 (display-warning 'org message
21201 (if (featurep 'xemacs) 'warning :warning))
21202 (let ((buf (get-buffer-create "*Org warnings*")))
21203 (with-current-buffer buf
21204 (goto-char (point-max))
21205 (insert "Warning (Org): " message)
21206 (unless (bolp)
21207 (newline)))
21208 (display-buffer buf)
21209 (sit-for 0))))
21211 (defun org-eval (form)
21212 "Eval FORM and return result."
21213 (condition-case error
21214 (eval form)
21215 (error (format "%%![Error: %s]" error))))
21217 (defun org-in-clocktable-p ()
21218 "Check if the cursor is in a clocktable."
21219 (let ((pos (point)) start)
21220 (save-excursion
21221 (end-of-line 1)
21223 (setq start (match-beginning 0))
21225 (>= (match-end 0) pos)
21226 start))))
21228 (defun org-in-commented-line ()
21229 "Is point in a line starting with `#'?"
21230 (equal (char-after (point-at-bol)) ?#))
21232 (defun org-in-indented-comment-line ()
21233 "Is point in a line starting with `#' after some white space?"
21234 (save-excursion
21235 (save-match-data
21236 (goto-char (point-at-bol))
21239 (defun org-in-verbatim-emphasis ()
21240 (save-match-data
21241 (and (org-in-regexp org-emph-re 2)
21242 (>= (point) (match-beginning 3))
21243 (<= (point) (match-end 4))
21244 (member (match-string 3) '("=" "~")))))
21246 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21247 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21248 (if (and marker (marker-buffer marker)
21249 (buffer-live-p (marker-buffer marker)))
21250 (progn
21251 (org-pop-to-buffer-same-window (marker-buffer marker))
21252 (if (or (> marker (point-max)) (< marker (point-min)))
21253 (widen))
21254 (goto-char marker)
21255 (org-show-context 'org-goto))
21256 (if bookmark
21257 (bookmark-jump bookmark)
21258 (error "Cannot find location"))))
21260 (defun org-quote-csv-field (s)
21261 "Quote field for inclusion in CSV material."
21264 s))
21266 (defun org-force-self-insert (N)
21267 "Needed to enforce self-insert under remapping."
21268 (interactive "p")
21269 (self-insert-command N))
21271 (defun org-string-width (s)
21272 "Compute width of string, ignoring invisible characters.
21273 This ignores character with invisibility property `org-link', and also
21274 characters with property `org-cwidth', because these will become invisible
21275 upon the next fontification round."
21276 (let (b l)
21277 (when (or (eq t buffer-invisibility-spec)
21278 (assq 'org-link buffer-invisibility-spec))
21279 (while (setq b (text-property-any 0 (length s)
21280 'invisible 'org-link s))
21281 (setq s (concat (substring s 0 b)
21282 (substring s (or (next-single-property-change
21283 b 'invisible s) (length s)))))))
21284 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21285 (setq s (concat (substring s 0 b)
21286 (substring s (or (next-single-property-change
21287 b 'org-cwidth s) (length s))))))
21288 (setq l (string-width s) b -1)
21289 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21290 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21291 l))
21293 (defun org-shorten-string (s maxlength)
21294 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21295 If the string is shorter or has length MAXLENGTH, just return the
21296 original string. If it is longer, the functions finds a space in the
21297 string, breaks this string off at that locations and adds three dots
21298 as ellipsis. Including the ellipsis, the string will not be longer
21299 than MAXLENGTH. If finding a good breaking point in the string does
21300 not work, the string is just chopped off in the middle of a word
21301 if necessary."
21302 (if (<= (length s) maxlength)
21303 s
21304 (let* ((n (max (- maxlength 4) 1))
21306 (if (string-match re s)
21307 (concat (match-string 1 s) "...")
21308 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21310 (defun org-get-indentation (&optional line)
21311 "Get the indentation of the current line, interpreting tabs.
21312 When LINE is given, assume it represents a line and compute its indentation."
21313 (if line
21314 (if (string-match "^ *" (org-remove-tabs line))
21315 (match-end 0))
21316 (save-excursion
21317 (beginning-of-line 1)
21319 (current-column))))
21321 (defun org-get-string-indentation (s)
21322 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21323 (let ((n -1) (i 0) (w tab-width) c)
21324 (catch 'exit
21325 (while (< (setq n (1+ n)) (length s))
21326 (setq c (aref s n))
21327 (cond ((= c ?\ ) (setq i (1+ i)))
21329 (t (throw 'exit t)))))
21330 i))
21332 (defun org-remove-tabs (s &optional width)
21333 "Replace tabulators in S with spaces.
21334 Assumes that s is a single line, starting in column 0."
21335 (setq width (or width tab-width))
21337 (setq s (replace-match
21338 (make-string
21339 (- (* width (/ (+ (match-beginning 0) width) width))
21340 (match-beginning 0)) ?\ )
21341 t t s)))
21342 s)
21344 (defun org-fix-indentation (line ind)
21345 "Fix indentation in LINE.
21346 IND is a cons cell with target and minimum indentation.
21347 If the current indentation in LINE is smaller than the minimum,
21348 leave it alone. If it is larger than ind, set it to the target."
21349 (let* ((l (org-remove-tabs line))
21350 (i (org-get-indentation l))
21351 (i1 (car ind)) (i2 (cdr ind)))
21352 (if (>= i i2) (setq l (substring line i2)))
21353 (if (> i1 0)
21354 (concat (make-string i1 ?\ ) l)
21355 l)))
21357 (defun org-remove-indentation (code &optional n)
21358 "Remove the maximum common indentation from the lines in CODE.
21359 N may optionally be the number of spaces to remove."
21360 (with-temp-buffer
21361 (insert code)
21362 (org-do-remove-indentation n)
21363 (buffer-string)))
21365 (defun org-do-remove-indentation (&optional n)
21366 "Remove the maximum common indentation from the buffer."
21367 (untabify (point-min) (point-max))
21368 (let ((min 10000) re)
21369 (if n
21370 (setq min n)
21371 (goto-char (point-min))
21373 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21374 (unless (or (= min 0) (= min 10000))
21376 (goto-char (point-min))
21377 (while (re-search-forward re nil t)
21378 (replace-match "")
21379 (end-of-line 1))
21380 min)))
21382 (defun org-fill-template (template alist)
21383 "Find each %key of ALIST in TEMPLATE and replace it."
21384 (let ((case-fold-search nil)
21385 entry key value)
21386 (setq alist (sort (copy-sequence alist)
21387 (lambda (a b) (< (length (car a)) (length (car b))))))
21388 (while (setq entry (pop alist))
21389 (setq template
21390 (replace-regexp-in-string
21391 (concat "%" (regexp-quote (car entry)))
21392 (or (cdr entry) "") template t t)))
21393 template))
21395 (defun org-base-buffer (buffer)
21396 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21397 (if (not buffer)
21398 buffer
21399 (or (buffer-base-buffer buffer)
21400 buffer)))
21402 (defun org-trim (s)
21403 "Remove whitespace at beginning and end of string."
21406 s)
21408 (defun org-wrap (string &optional width lines)
21409 "Wrap string to either a number of lines, or a width in characters.
21410 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21411 that costs. If there is a word longer than WIDTH, the text is actually
21412 wrapped to the length of that word.
21413 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21414 many lines, whatever width that takes.
21415 The return value is a list of lines, without newlines at the end."
21417 (maxword (apply 'max (mapcar 'org-string-width words)))
21418 w ll)
21419 (cond (width
21420 (org-do-wrap words (max maxword width)))
21421 (lines
21422 (setq w maxword)
21423 (setq ll (org-do-wrap words maxword))
21424 (if (<= (length ll) lines)
21425 ll
21426 (setq ll words)
21427 (while (> (length ll) lines)
21428 (setq w (1+ w))
21429 (setq ll (org-do-wrap words w)))
21430 ll))
21431 (t (error "Cannot wrap this")))))
21433 (defun org-do-wrap (words width)
21434 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21435 (let (lines line)
21436 (while words
21437 (setq line (pop words))
21438 (while (and words (< (+ (length line) (length (car words))) width))
21439 (setq line (concat line " " (pop words))))
21440 (setq lines (push line lines)))
21441 (nreverse lines)))
21443 (defun org-split-string (string &optional separators)
21444 "Splits STRING into substrings at SEPARATORS.
21445 No empty strings are returned if there are matches at the beginning
21446 and end of string."
21448 (start 0)
21449 notfirst
21450 (list nil))
21451 (while (and (string-match rexp string
21452 (if (and notfirst
21453 (= start (match-beginning 0))
21454 (< start (length string)))
21455 (1+ start) start))
21456 (< (match-beginning 0) (length string)))
21457 (setq notfirst t)
21458 (or (eq (match-beginning 0) 0)
21459 (and (eq (match-beginning 0) (match-end 0))
21460 (eq (match-beginning 0) start))
21461 (setq list
21462 (cons (substring string start (match-beginning 0))
21463 list)))
21464 (setq start (match-end 0)))
21465 (or (eq start (length string))
21466 (setq list
21467 (cons (substring string start)
21468 list)))
21469 (nreverse list)))
21471 (defun org-quote-vert (s)
21473 (while (string-match "|" s)
21475 s)
21477 (defun org-uuidgen-p (s)
21478 "Is S an ID created by UUIDGEN?"
21479 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21481 (defun org-in-src-block-p (&optional inside)
21482 "Whether point is in a code source block.
21483 When INSIDE is non-nil, don't consider we are within a src block
21484 when point is at #+BEGIN_SRC or #+END_SRC."
21485 (let ((case-fold-search t) ov)
21486 (or (and (setq ov (overlays-at (point)))
21487 (memq 'org-block-background
21488 (overlay-properties (car ov))))
21489 (and (not inside)
21490 (save-match-data
21491 (save-excursion
21492 (beginning-of-line)
21495 (defun org-context ()
21496 "Return a list of contexts of the current cursor position.
21497 If several contexts apply, all are returned.
21498 Each context entry is a list with a symbol naming the context, and
21499 two positions indicating start and end of the context. Possible
21500 contexts are:
21502 :headline anywhere in a headline
21503 :headline-stars on the leading stars in a headline
21504 :todo-keyword on a TODO keyword (including DONE) in a headline
21505 :tags on the TAGS in a headline
21506 :priority on the priority cookie in a headline
21507 :item on the first line of a plain list item
21508 :item-bullet on the bullet/number of a plain list item
21509 :checkbox on the checkbox in a plain list item
21510 :table in an org-mode table
21511 :table-special on a special filed in a table
21512 :table-table in a table.el table
21513 :clocktable in a clocktable
21514 :src-block in a source block
21515 :link on a hyperlink
21516 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21517 :target on a <<target>>
21518 :radio-target on a <<<radio-target>>>
21519 :latex-fragment on a LaTeX fragment
21520 :latex-preview on a LaTeX fragment with overlaid preview image
21522 This function expects the position to be visible because it uses font-lock
21523 faces as a help to recognize the following contexts: :table-special, :link,
21524 and :keyword."
21525 (let* ((f (get-text-property (point) 'face))
21526 (faces (if (listp f) f (list f)))
21527 (case-fold-search t)
21528 (p (point)) clist o)
21529 ;; First the large context
21530 (cond
21531 ((org-at-heading-p t)
21532 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21533 (when (progn
21534 (beginning-of-line 1)
21535 (looking-at org-todo-line-tags-regexp))
21536 (push (org-point-in-group p 1 :headline-stars) clist)
21537 (push (org-point-in-group p 2 :todo-keyword) clist)
21538 (push (org-point-in-group p 4 :tags) clist))
21539 (goto-char p)
21542 (push (org-point-in-group p 0 :priority) clist)))
21544 ((org-at-item-p)
21545 (push (org-point-in-group p 2 :item-bullet) clist)
21546 (push (list :item (point-at-bol)
21547 (save-excursion (org-end-of-item) (point)))
21548 clist)
21549 (and (org-at-item-checkbox-p)
21550 (push (org-point-in-group p 0 :checkbox) clist)))
21552 ((org-at-table-p)
21553 (push (list :table (org-table-begin) (org-table-end)) clist)
21554 (if (memq 'org-formula faces)
21555 (push (list :table-special
21556 (previous-single-property-change p 'face)
21557 (next-single-property-change p 'face)) clist)))
21558 ((org-at-table-p 'any)
21559 (push (list :table-table) clist)))
21560 (goto-char p)
21562 (let ((case-fold-search t))
21563 ;; New the "medium" contexts: clocktables, source blocks
21564 (cond ((org-in-clocktable-p)
21565 (push (list :clocktable
21567 (search-backward "#+BEGIN: clocktable" nil t))
21568 (match-beginning 0))
21570 (match-end 0))) clist))
21571 ((org-in-src-block-p)
21572 (push (list :src-block
21574 (search-backward "#+BEGIN_SRC" nil t))
21575 (match-beginning 0))
21576 (and (search-forward "#+END_SRC" nil t)
21577 (match-beginning 0))) clist))))
21578 (goto-char p)
21580 ;; Now the small context
21581 (cond
21582 ((org-at-timestamp-p)
21583 (push (org-point-in-group p 0 :timestamp) clist))
21584 ((memq 'org-link faces)
21585 (push (list :link
21586 (previous-single-property-change p 'face)
21587 (next-single-property-change p 'face)) clist))
21588 ((memq 'org-special-keyword faces)
21589 (push (list :keyword
21590 (previous-single-property-change p 'face)
21591 (next-single-property-change p 'face)) clist))
21592 ((org-at-target-p)
21593 (push (org-point-in-group p 0 :target) clist)
21594 (goto-char (1- (match-beginning 0)))
21595 (if (looking-at org-radio-target-regexp)
21596 (push (org-point-in-group p 0 :radio-target) clist))
21597 (goto-char p))
21598 ((setq o (car (delq nil
21599 (mapcar
21600 (lambda (x)
21601 (if (memq x org-latex-fragment-image-overlays) x))
21602 (overlays-at (point))))))
21603 (push (list :latex-fragment
21604 (overlay-start o) (overlay-end o)) clist)
21605 (push (list :latex-preview
21606 (overlay-start o) (overlay-end o)) clist))
21607 ((org-inside-LaTeX-fragment-p)
21608 ;; FIXME: positions wrong.
21609 (push (list :latex-fragment (point) (point)) clist)))
21611 (setq clist (nreverse (delq nil clist)))
21612 clist))
21614 ;; FIXME: Compare with at-regexp-p Do we need both?
21615 (defun org-in-regexp (re &optional nlines visually)
21616 "Check if point is inside a match of regexp.
21617 Normally only the current line is checked, but you can include NLINES extra
21618 lines both before and after point into the search.
21619 If VISUALLY is set, require that the cursor is not after the match but
21620 really on, so that the block visually is on the match."
21621 (catch 'exit
21622 (let ((pos (point))
21623 (eol (point-at-eol (+ 1 (or nlines 0))))
21624 (inc (if visually 1 0)))
21625 (save-excursion
21626 (beginning-of-line (- 1 (or nlines 0)))
21627 (while (re-search-forward re eol t)
21628 (if (and (<= (match-beginning 0) pos)
21629 (>= (+ inc (match-end 0)) pos))
21630 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21632 (defun org-at-regexp-p (regexp)
21633 "Is point inside a match of REGEXP in the current line?"
21634 (catch 'exit
21635 (save-excursion
21636 (let ((pos (point)) (end (point-at-eol)))
21637 (beginning-of-line 1)
21638 (while (re-search-forward regexp end t)
21639 (if (and (<= (match-beginning 0) pos)
21640 (>= (match-end 0) pos))
21641 (throw 'exit t)))
21642 nil))))
21644 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21645 "Non-nil when point is between matches of START-RE and END-RE.
21647 Also return a non-nil value when point is on one of the matches.
21649 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21650 buffer positions. Default values are the positions of headlines
21651 surrounding the point.
21653 The functions returns a cons cell whose car (resp. cdr) is the
21654 position before START-RE (resp. after END-RE)."
21655 (save-match-data
21656 (let ((pos (point))
21657 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21658 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21659 beg end)
21660 (save-excursion
21661 ;; Point is on a block when on START-RE or if START-RE can be
21662 ;; found before it...
21663 (and (or (org-at-regexp-p start-re)
21664 (re-search-backward start-re limit-up t))
21665 (setq beg (match-beginning 0))
21666 ;; ... and END-RE after it...
21667 (goto-char (match-end 0))
21668 (re-search-forward end-re limit-down t)
21669 (> (setq end (match-end 0)) pos)
21670 ;; ... without another START-RE in-between.
21671 (goto-char (match-beginning 0))
21672 (not (re-search-backward start-re (1+ beg) t))
21673 ;; Return value.
21674 (cons beg end))))))
21676 (defun org-in-block-p (names)
21677 "Non-nil when point belongs to a block whose name belongs to NAMES.
21679 NAMES is a list of strings containing names of blocks.
21681 Return first block name matched, or nil. Beware that in case of
21682 nested blocks, the returned name may not belong to the closest
21683 block from point."
21684 (save-match-data
21685 (catch 'exit
21686 (let ((case-fold-search t)
21687 (lim-up (save-excursion (outline-previous-heading)))
21688 (lim-down (save-excursion (outline-next-heading))))
21689 (mapc (lambda (name)
21690 (let ((n (regexp-quote name)))
21691 (when (org-between-regexps-p
21694 lim-up lim-down)
21695 (throw 'exit n))))
21696 names))
21697 nil)))
21699 (defun org-in-drawer-p ()
21700 "Is point within a drawer?"
21701 (save-match-data
21702 (let ((case-fold-search t)
21703 (lim-up (save-excursion (outline-previous-heading)))
21704 (lim-down (save-excursion (outline-next-heading))))
21705 (org-between-regexps-p
21708 lim-up lim-down))))
21710 (defun org-occur-in-agenda-files (regexp &optional nlines)
21711 "Call `multi-occur' with buffers for all agenda files."
21713 (let* ((files (org-agenda-files))
21714 (tnames (mapcar 'file-truename files))
21715 (extra org-agenda-text-search-extra-files)
21716 f)
21717 (when (eq (car extra) 'agenda-archives)
21718 (setq extra (cdr extra))
21719 (setq files (org-add-archive-files files)))
21720 (while (setq f (pop extra))
21721 (unless (member (file-truename f) tnames)
21722 (add-to-list 'files f 'append)
21723 (add-to-list 'tnames (file-truename f) 'append)))
21724 (multi-occur
21725 (mapcar (lambda (x)
21726 (with-current-buffer
21727 (or (get-file-buffer x) (find-file-noselect x))
21728 (widen)
21729 (current-buffer)))
21730 files)
21731 regexp)))
21733 (if (boundp 'occur-mode-find-occurrence-hook)
21734 ;; Emacs 23
21735 (add-hook 'occur-mode-find-occurrence-hook
21736 (lambda ()
21737 (when (derived-mode-p 'org-mode)
21738 (org-reveal))))
21739 ;; Emacs 22
21740 (defadvice occur-mode-goto-occurrence
21741 (after org-occur-reveal activate)
21742 (and (derived-mode-p 'org-mode) (org-reveal)))
21743 (defadvice occur-mode-goto-occurrence-other-window
21744 (after org-occur-reveal activate)
21745 (and (derived-mode-p 'org-mode) (org-reveal)))
21746 (defadvice occur-mode-display-occurrence
21747 (after org-occur-reveal activate)
21748 (when (derived-mode-p 'org-mode)
21749 (let ((pos (occur-mode-find-occurrence)))
21750 (with-current-buffer (marker-buffer pos)
21751 (save-excursion
21752 (goto-char pos)
21753 (org-reveal)))))))
21755 (defun org-occur-link-in-agenda-files ()
21756 "Create a link and search for it in the agendas.
21757 The link is not stored in `org-stored-links', it is just created
21758 for the search purpose."
21759 (interactive)
21760 (let ((link (condition-case nil
21761 (org-store-link nil)
21762 (error "Unable to create a link to here"))))
21763 (org-occur-in-agenda-files (regexp-quote link))))
21765 (defun org-reverse-string (string)
21766 "Return the reverse of STRING."
21767 (apply 'string (reverse (string-to-list string))))
21769 (defsubst org-uniquify (list)
21770 "Non-destructively remove duplicate elements from LIST."
21771 (let ((res (copy-sequence list))) (delete-dups res)))
21773 (defun org-uniquify-alist (alist)
21774 "Merge elements of ALIST with the same key.
21776 For example, in this alist:
21778 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21779 => '((a 1 3) (b 2))
21781 merge (a 1) and (a 3) into (a 1 3).
21783 The function returns the new ALIST."
21784 (let (rtn)
21785 (mapc
21786 (lambda (e)
21787 (let (n)
21788 (if (not (assoc (car e) rtn))
21789 (push e rtn)
21790 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21791 (setq rtn (assq-delete-all (car e) rtn))
21792 (push n rtn))))
21793 alist)
21794 rtn))
21796 (defun org-delete-all (elts list)
21797 "Remove all elements in ELTS from LIST."
21798 (while elts
21799 (setq list (delete (pop elts) list)))
21800 list)
21802 (defun org-count (cl-item cl-seq)
21803 "Count the number of occurrences of ITEM in SEQ.
21804 Taken from `count' in cl-seq.el with all keyword arguments removed."
21805 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21806 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21807 (while (< cl-start cl-end)
21808 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21809 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21810 (setq cl-start (1+ cl-start)))
21811 cl-count))
21813 (defun org-remove-if (predicate seq)
21814 "Remove everything from SEQ that fulfills PREDICATE."
21815 (let (res e)
21816 (while seq
21817 (setq e (pop seq))
21818 (if (not (funcall predicate e)) (push e res)))
21819 (nreverse res)))
21821 (defun org-remove-if-not (predicate seq)
21822 "Remove everything from SEQ that does not fulfill PREDICATE."
21823 (let (res e)
21824 (while seq
21825 (setq e (pop seq))
21826 (if (funcall predicate e) (push e res)))
21827 (nreverse res)))
21829 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21830 "Reduce two-argument FUNCTION across SEQ.
21831 Taken from `reduce' in cl-seq.el with all keyword arguments but
21833 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21834 (cadr (memq :initial-value cl-keys)))
21835 (cl-seq (pop cl-seq))
21836 (t (funcall cl-func)))))
21837 (while cl-seq
21838 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21839 cl-accum))
21841 (defun org-every (pred seq)
21842 "Return true if PREDICATE is true of every element of SEQ.
21843 Adapted from `every' in cl.el."
21844 (catch 'org-every
21845 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21846 t))
21848 (defun org-some (pred seq)
21849 "Return true if PREDICATE is true of any element of SEQ.
21850 Adapted from `some' in cl.el."
21851 (catch 'org-some
21852 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21853 nil))
21855 (defun org-back-over-empty-lines ()
21856 "Move backwards over whitespace, to the beginning of the first empty line.
21857 Returns the number of empty lines passed."
21858 (let ((pos (point)))
21859 (if (cdr (assoc 'heading org-blank-before-new-entry))
21861 (unless (eobp)
21862 (forward-line -1)))
21863 (beginning-of-line 2)
21864 (goto-char (min (point) pos))
21865 (count-lines (point) pos)))
21867 (defun org-skip-whitespace ()
21870 (defun org-point-in-group (point group &optional context)
21871 "Check if POINT is in match-group GROUP.
21872 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21873 match. If the match group does not exist or point is not inside it,
21874 return nil."
21875 (and (match-beginning group)
21876 (>= point (match-beginning group))
21877 (<= point (match-end group))
21878 (if context
21879 (list context (match-beginning group) (match-end group))
21880 t)))
21882 (defun org-switch-to-buffer-other-window (&rest args)
21883 "Switch to buffer in a second window on the current frame.
21884 In particular, do not allow pop-up frames.
21885 Returns the newly created buffer."
21886 (org-no-popups
21887 (apply 'switch-to-buffer-other-window args)))
21889 (defun org-combine-plists (&rest plists)
21890 "Create a single property list from all plists in PLISTS.
21891 The process starts by copying the first list, and then setting properties
21892 from the other lists. Settings in the last list are the most significant
21893 ones and overrule settings in the other lists."
21894 (let ((rtn (copy-sequence (pop plists)))
21895 p v ls)
21896 (while plists
21897 (setq ls (pop plists))
21898 (while ls
21899 (setq p (pop ls) v (pop ls))
21900 (setq rtn (plist-put rtn p v))))
21901 rtn))
21903 (defun org-replace-escapes (string table)
21904 "Replace %-escapes in STRING with values in TABLE.
21906 The sequences in STRING may contain normal field width and padding information,
21908 so values can contain further %-escapes if they are define later in TABLE."
21909 (let ((tbl (copy-alist table))
21910 (case-fold-search nil)
21911 (pchg 0)
21912 e re rpl)
21913 (while (setq e (pop tbl))
21914 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21915 (when (and (cdr e) (string-match re (cdr e)))
21916 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21917 (safe "SREF"))
21918 (add-text-properties 0 3 (list 'sref sref) safe)
21919 (setcdr e (replace-match safe t t (cdr e)))))
21920 (while (string-match re string)
21921 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21922 (cdr e)))
21923 (setq string (replace-match rpl t t string))))
21924 (while (setq pchg (next-property-change pchg string))
21925 (let ((sref (get-text-property pchg 'sref string)))
21926 (when (and sref (string-match "SREF" string pchg))
21927 (setq string (replace-match sref t t string)))))
21928 string))
21930 (defun org-sublist (list start end)
21931 "Return a section of LIST, from START to END.
21932 Counting starts at 1."
21933 (let (rtn (c start))
21934 (setq list (nthcdr (1- start) list))
21935 (while (and list (<= c end))
21936 (push (pop list) rtn)
21937 (setq c (1+ c)))
21938 (nreverse rtn)))
21940 (defun org-find-base-buffer-visiting (file)
21941 "Like `find-buffer-visiting' but always return the base buffer and
21942 not an indirect buffer."
21943 (let ((buf (or (get-file-buffer file)
21944 (find-buffer-visiting file))))
21945 (if buf
21946 (or (buffer-base-buffer buf) buf)
21947 nil)))
21949 (defun org-image-file-name-regexp (&optional extensions)
21950 "Return regexp matching the file names of images.
21951 If EXTENSIONS is given, only match these."
21952 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21953 (image-file-name-regexp)
21954 (let ((image-file-name-extensions
21955 (or extensions
21956 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21957 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21959 (regexp-opt (nconc (mapcar 'upcase
21960 image-file-name-extensions)
21961 image-file-name-extensions)
21962 t)
21965 (defun org-file-image-p (file &optional extensions)
21966 "Return non-nil if FILE is an image."
21967 (save-match-data
21968 (string-match (org-image-file-name-regexp extensions) file)))
21970 (defun org-get-cursor-date (&optional with-time)
21971 "Return the date at cursor in as a time.
21972 This works in the calendar and in the agenda, anywhere else it just
21973 returns the current time.
21974 If WITH-TIME is non-nil, returns the time of the event at point (in
21975 the agenda) or the current time of the day."
21976 (let (date day defd tp tm hod mod)
21977 (when with-time
21978 (setq tp (get-text-property (point) 'time))
21980 (setq hod (string-to-number (match-string 1 tp))
21981 mod (string-to-number (match-string 2 tp))))
21982 (or tp (setq hod (nth 2 (decode-time (current-time)))
21983 mod (nth 1 (decode-time (current-time))))))
21984 (cond
21985 ((eq major-mode 'calendar-mode)
21986 (setq date (calendar-cursor-to-date)
21987 defd (encode-time 0 (or mod 0) (or hod 0)
21988 (nth 1 date) (nth 0 date) (nth 2 date))))
21989 ((eq major-mode 'org-agenda-mode)
21990 (setq day (get-text-property (point) 'day))
21991 (if day
21992 (setq date (calendar-gregorian-from-absolute day)
21993 defd (encode-time 0 (or mod 0) (or hod 0)
21994 (nth 1 date) (nth 0 date) (nth 2 date))))))
21995 (or defd (current-time))))
21997 (defun org-mark-subtree (&optional up)
21998 "Mark the current subtree.
21999 This puts point at the start of the current subtree, and mark at
22000 the end. If a numeric prefix UP is given, move up into the
22001 hierarchy of headlines by UP levels before marking the subtree."
22002 (interactive "P")
22003 (org-with-limited-levels
22004 (cond ((org-at-heading-p) (beginning-of-line))
22005 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22006 (t (outline-previous-visible-heading 1))))
22007 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22008 (if (org-called-interactively-p 'any)
22009 (call-interactively 'org-mark-element)
22010 (org-mark-element)))
22013 ;;; Indentation
22015 (defun org-indent-line ()
22016 "Indent line depending on context."
22017 (interactive)
22018 (let* ((pos (point))
22019 (itemp (org-at-item-p))
22020 (case-fold-search t)
22022 (inline-task-p (and (featurep 'org-inlinetask)
22023 (org-inlinetask-in-task-p)))
22024 (inline-re (and inline-task-p
22025 (org-inlinetask-outline-regexp)))
22026 column)
22027 (if (and orgstruct-is-++ (eq pos (point)))
22028 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22029 (indent-according-to-mode))
22030 (beginning-of-line 1)
22031 (cond
22032 ;; Headings
22033 ((looking-at org-outline-regexp) (setq column 0))
22034 ;; Footnote definition
22035 ((looking-at org-footnote-definition-re) (setq column 0))
22036 ;; Literal examples
22038 (setq column (org-get-indentation))) ; do nothing
22039 ;; Lists
22040 ((ignore-errors (goto-char (org-in-item-p)))
22041 (setq column (if itemp
22042 (org-get-indentation)
22043 (org-list-item-body-column (point))))
22044 (goto-char pos))
22045 ;; Drawers
22047 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22048 (save-excursion
22049 (goto-char (1- (match-beginning 1)))
22050 (setq column (current-column))))
22051 ;; Special blocks
22053 (save-excursion
22054 (re-search-backward
22056 (setq column (org-get-indentation (match-string 0))))
22059 (save-excursion
22061 (setq column
22062 (cond ((equal (downcase (match-string 1)) "src")
22063 ;; src blocks: let `org-edit-src-exit' handle them
22064 (org-get-indentation))
22065 ((equal (downcase (match-string 1)) "example")
22066 (max (org-get-indentation)
22067 (org-get-indentation (match-string 0))))
22068 (t
22069 (org-get-indentation (match-string 0))))))
22070 ;; This line has nothing special, look at the previous relevant
22071 ;; line to compute indentation
22072 (t
22073 (beginning-of-line 0)
22074 (while (and (not (bobp))
22075 (not (looking-at org-table-line-regexp))
22076 (not (looking-at org-drawer-regexp))
22077 ;; When point started in an inline task, do not move
22078 ;; above task starting line.
22079 (not (and inline-task-p (looking-at inline-re)))
22080 ;; Skip drawers, blocks, empty lines, verbatim,
22081 ;; comments, tables, footnotes definitions, lists,
22082 ;; inline tasks.
22084 (re-search-backward org-drawer-regexp nil t))
22088 (looking-at org-footnote-definition-re)
22089 (and (not inline-task-p)
22090 (featurep 'org-inlinetask)
22091 (org-inlinetask-in-task-p)
22092 (or (org-inlinetask-goto-beginning) t))))
22093 (beginning-of-line 0))
22094 (cond
22095 ;; There was a list item above.
22096 ((ignore-errors (goto-char (org-in-item-p)))
22097 (goto-char (org-list-get-top-point (org-list-struct)))
22098 (setq column (org-get-indentation)))
22099 ;; There was an heading above.
22101 (if (not org-adapt-indentation)
22102 (setq column 0)
22103 (goto-char (match-end 0))
22104 (setq column (current-column))))
22105 ;; A drawer had started and is unfinished
22106 ((looking-at org-drawer-regexp)
22107 (goto-char (1- (match-beginning 1)))
22108 (setq column (current-column)))
22109 ;; Else, nothing noticeable found: get indentation and go on.
22110 (t (setq column (org-get-indentation))))))
22111 ;; Now apply indentation and move cursor accordingly
22112 (goto-char pos)
22113 (if (<= (current-column) (current-indentation))
22114 (org-indent-line-to column)
22115 (save-excursion (org-indent-line-to column)))
22116 ;; Special polishing for properties, see `org-property-format'
22117 (setq column (current-column))
22118 (beginning-of-line 1)
22119 (if (looking-at org-property-re)
22120 (replace-match (concat (match-string 4)
22121 (format org-property-format
22122 (match-string 1) (match-string 3)))
22123 t t))
22124 (org-move-to-column column))))
22126 (defun org-indent-drawer ()
22127 "Indent the drawer at point."
22128 (interactive)
22129 (let ((p (point))
22130 (e (and (save-excursion (re-search-forward ":END:" nil t))
22131 (match-end 0)))
22132 (folded
22133 (save-excursion
22134 (end-of-line)
22135 (when (overlays-at (point))
22136 (member 'invisible (overlay-properties
22137 (car (overlays-at (point)))))))))
22138 (when folded (org-cycle))
22139 (indent-for-tab-command)
22140 (while (and (move-beginning-of-line 2) (< (point) e))
22141 (indent-for-tab-command))
22142 (goto-char p)
22143 (when folded (org-cycle)))
22144 (message "Drawer at point indented"))
22146 (defun org-indent-block ()
22147 "Indent the block at point."
22148 (interactive)
22149 (let ((p (point))
22150 (case-fold-search t)
22152 (match-end 0)))
22153 (folded
22154 (save-excursion
22155 (end-of-line)
22156 (when (overlays-at (point))
22157 (member 'invisible (overlay-properties
22158 (car (overlays-at (point)))))))))
22159 (when folded (org-cycle))
22160 (indent-for-tab-command)
22161 (while (and (move-beginning-of-line 2) (< (point) e))
22162 (indent-for-tab-command))
22163 (goto-char p)
22164 (when folded (org-cycle)))
22165 (message "Block at point indented"))
22167 (defun org-indent-region (start end)
22168 "Indent region."
22169 (interactive "r")
22170 (save-excursion
22171 (let ((line-end (org-current-line end)))
22172 (goto-char start)
22173 (while (< (org-current-line) line-end)
22174 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22175 (t (call-interactively 'org-indent-line)))
22176 (move-beginning-of-line 2)))))
22179 ;;; Filling
22181 ;; We use our own fill-paragraph and auto-fill functions.
22183 ;; `org-fill-paragraph' relies on adaptive filling and context
22184 ;; checking. Appropriate `fill-prefix' is computed with
22185 ;; `org-adaptive-fill-function'.
22187 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22188 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22189 ;; `org-adaptive-fill-function' value. Internally,
22190 ;; `org-comment-line-break-function' breaks the line.
22192 ;; `org-setup-filling' installs filling and auto-filling related
22193 ;; variables during `org-mode' initialization.
22195 (defvar org-element-paragraph-separate) ; org-element.el
22196 (defun org-setup-filling ()
22197 (require 'org-element)
22198 ;; Prevent auto-fill from inserting unwanted new items.
22199 (when (boundp 'fill-nobreak-predicate)
22200 (org-set-local
22201 'fill-nobreak-predicate
22202 (org-uniquify
22203 (append fill-nobreak-predicate
22204 '(org-fill-line-break-nobreak-p
22205 org-fill-paragraph-with-timestamp-nobreak-p)))))
22206 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22207 (org-set-local 'paragraph-start paragraph-ending)
22208 (org-set-local 'paragraph-separate paragraph-ending))
22209 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22210 (org-set-local 'auto-fill-inhibit-regexp nil)
22211 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22212 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22213 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22215 (defun org-fill-line-break-nobreak-p ()
22216 "Non-nil when a new line at point would create an Org line break."
22217 (save-excursion
22222 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22223 "Non-nil when a new line at point would split a timestamp."
22224 (and (org-at-timestamp-p t)
22225 (not (looking-at org-ts-regexp-both))))
22227 (declare-function message-in-body-p "message" ())
22228 (defvar orgtbl-line-start-regexp) ; From org-table.el
22229 (defun org-adaptive-fill-function ()
22230 "Compute a fill prefix for the current line.
22231 Return fill prefix, as a string, or nil if current line isn't
22232 meant to be filled. For convenience, if `adaptive-fill-regexp'
22233 matches in paragraphs or comments, use it."
22234 (catch 'exit
22235 (when (derived-mode-p 'message-mode)
22236 (save-excursion
22237 (beginning-of-line)
22238 (cond ((or (not (message-in-body-p))
22239 (looking-at orgtbl-line-start-regexp))
22240 (throw 'exit nil))
22241 ((looking-at message-cite-prefix-regexp)
22242 (throw 'exit (match-string-no-properties 0)))
22243 ((looking-at org-outline-regexp)
22244 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22245 (org-with-wide-buffer
22246 (let* ((p (line-beginning-position))
22247 (element (save-excursion
22248 (beginning-of-line)
22249 (or (ignore-errors (org-element-at-point))
22250 (user-error "An element cannot be parsed line %d"
22251 (line-number-at-pos (point))))))
22252 (type (org-element-type element))
22253 (post-affiliated (org-element-property :post-affiliated element)))
22254 (unless (and post-affiliated (< p post-affiliated))
22255 (case type
22256 (comment
22257 (save-excursion
22258 (beginning-of-line)
22260 (concat (match-string 0) "# ")))
22261 (footnote-definition "")
22262 ((item plain-list)
22263 (make-string (org-list-item-body-column
22264 (or post-affiliated
22265 (org-element-property :begin element)))
22266 ? ))
22267 (paragraph
22268 ;; Fill prefix is usually the same as the current line,
22269 ;; unless the paragraph is at the beginning of an item.
22270 (let ((parent (org-element-property :parent element)))
22271 (save-excursion
22272 (beginning-of-line)
22273 (cond ((eq (org-element-type parent) 'item)
22274 (make-string (org-list-item-body-column
22275 (org-element-property :begin parent))
22276 ? ))
22277 ((and adaptive-fill-regexp
22278 ;; Locally disable
22279 ;; `adaptive-fill-function' to let
22280 ;; `fill-context-prefix' handle
22281 ;; `adaptive-fill-regexp' variable.
22282 (let (adaptive-fill-function)
22283 (fill-context-prefix
22284 post-affiliated
22285 (org-element-property :end element)))))
22287 (t "")))))
22288 (comment-block
22289 ;; Only fill contents if P is within block boundaries.
22290 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22291 (forward-line)
22292 (point)))
22293 (cend (save-excursion
22294 (goto-char (org-element-property :end element))
22296 (line-beginning-position))))
22297 (when (and (>= p cbeg) (< p cend))
22299 (match-string 0)
22300 ""))))))))))
22302 (declare-function message-goto-body "message" ())
22303 (defvar message-cite-prefix-regexp) ; From message.el
22304 (defun org-fill-paragraph (&optional justify)
22305 "Fill element at point, when applicable.
22307 This function only applies to comment blocks, comments, example
22308 blocks and paragraphs. Also, as a special case, re-align table
22309 when point is at one.
22311 If JUSTIFY is non-nil (interactively, with prefix argument),
22312 justify as well. If `sentence-end-double-space' is non-nil, then
22313 period followed by one space does not end a sentence, so don't
22314 break a line there. The variable `fill-column' controls the
22315 width for filling.
22317 For convenience, when point is at a plain list, an item or
22318 a footnote definition, try to fill the first paragraph within."
22319 (interactive)
22320 (if (and (derived-mode-p 'message-mode)
22321 (or (not (message-in-body-p))
22322 (save-excursion (move-beginning-of-line 1)
22323 (looking-at message-cite-prefix-regexp))))
22324 ;; First ensure filling is correct in message-mode.
22325 (let ((fill-paragraph-function
22326 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22327 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22328 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22329 (paragraph-separate
22330 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22331 (fill-paragraph nil))
22332 (with-syntax-table org-mode-transpose-word-syntax-table
22333 ;; Move to end of line in order to get the first paragraph
22334 ;; within a plain list or a footnote definition.
22335 (let ((element (save-excursion
22336 (end-of-line)
22337 (or (ignore-errors (org-element-at-point))
22338 (user-error "An element cannot be parsed line %d"
22339 (line-number-at-pos (point)))))))
22340 ;; First check if point is in a blank line at the beginning of
22341 ;; the buffer. In that case, ignore filling.
22342 (case (org-element-type element)
22343 ;; Use major mode filling function is src blocks.
22344 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22345 ;; Align Org tables, leave table.el tables as-is.
22346 (table-row (org-table-align) t)
22347 (table
22348 (when (eq (org-element-property :type element) 'org)
22349 (save-excursion
22350 (goto-char (org-element-property :post-affiliated element))
22351 (org-table-align)))
22352 t)
22353 (paragraph
22354 ;; Paragraphs may contain `line-break' type objects.
22355 (let ((beg (max (point-min)
22356 (org-element-property :contents-begin element)))
22357 (end (min (point-max)
22358 (org-element-property :contents-end element))))
22359 ;; Do nothing if point is at an affiliated keyword.
22360 (if (< (line-end-position) beg) t
22361 (when (derived-mode-p 'message-mode)
22362 ;; In `message-mode', do not fill following citation
22363 ;; in current paragraph nor text before message body.
22364 (let ((body-start (save-excursion (message-goto-body))))
22365 (when body-start (setq beg (max body-start beg))))
22366 (when (save-excursion
22367 (re-search-forward
22368 (concat "^" message-cite-prefix-regexp) end t))
22369 (setq end (match-beginning 0))))
22370 ;; Fill paragraph, taking line breaks into account.
22371 ;; For that, slice the paragraph using line breaks as
22372 ;; separators, and fill the parts in reverse order to
22373 ;; avoid messing with markers.
22374 (save-excursion
22375 (goto-char end)
22376 (mapc
22377 (lambda (pos)
22378 (fill-region-as-paragraph pos (point) justify)
22379 (goto-char pos))
22380 ;; Find the list of ending positions for line breaks
22381 ;; in the current paragraph. Add paragraph
22382 ;; beginning to include first slice.
22383 (nreverse
22384 (cons beg
22385 (org-element-map
22386 (org-element--parse-objects
22387 beg end nil (org-element-restriction 'paragraph))
22388 'line-break
22389 (lambda (lb) (org-element-property :end lb)))))))
22390 t)))
22391 ;; Contents of `comment-block' type elements should be
22392 ;; filled as plain text, but only if point is within block
22393 ;; markers.
22394 (comment-block
22395 (let* ((case-fold-search t)
22396 (beg (save-excursion
22397 (goto-char (org-element-property :begin element))
22399 (forward-line)
22400 (point)))
22401 (end (save-excursion
22402 (goto-char (org-element-property :end element))
22404 (line-beginning-position))))
22405 (if (or (< (point) beg) (> (point) end)) t
22406 (fill-region-as-paragraph
22407 (save-excursion (end-of-line)
22409 (line-beginning-position))
22410 (save-excursion (beginning-of-line)
22412 (line-beginning-position))
22413 justify))))
22414 ;; Fill comments.
22415 (comment
22416 (let ((begin (org-element-property :post-affiliated element))
22417 (end (org-element-property :end element)))
22418 (when (and (>= (point) begin) (<= (point) end))
22419 (let ((begin (save-excursion
22420 (end-of-line)
22422 (progn (forward-line) (point))
22423 begin)))
22424 (end (save-excursion
22425 (end-of-line)
22427 (1- (line-beginning-position))
22429 (line-end-position)))))
22430 ;; Do not fill comments when at a blank line.
22431 (when (> end begin)
22432 (let ((fill-prefix
22433 (save-excursion
22434 (beginning-of-line)
22436 (let ((comment-prefix (match-string 0)))
22437 (goto-char (match-end 0))
22438 (if (looking-at adaptive-fill-regexp)
22439 (concat comment-prefix (match-string 0))
22440 (concat comment-prefix " "))))))
22441 (save-excursion
22442 (fill-region-as-paragraph begin end justify))))))
22443 t))
22444 ;; Ignore every other element.
22445 (otherwise t))))))
22447 (defun org-auto-fill-function ()
22448 "Auto-fill function."
22449 ;; Check if auto-filling is meaningful.
22450 (let ((fc (current-fill-column)))
22451 (when (and fc (> (current-column) fc))
22452 (let* ((fill-prefix (org-adaptive-fill-function))
22453 ;; Enforce empty fill prefix, if required. Otherwise, it
22454 ;; will be computed again.
22455 (adaptive-fill-mode (not (equal fill-prefix ""))))
22456 (when fill-prefix (do-auto-fill))))))
22458 (defun org-comment-line-break-function (&optional soft)
22459 "Break line at point and indent, continuing comment if within one.
22460 The inserted newline is marked hard if variable
22461 `use-hard-newlines' is true, unless optional argument SOFT is
22462 non-nil."
22464 (save-excursion (forward-char -1) (delete-horizontal-space))
22465 (delete-horizontal-space)
22466 (indent-to-left-margin)
22467 (insert-before-markers-and-inherit fill-prefix))
22470 ;;; Comments
22472 ;; Org comments syntax is quite complex. It requires the entire line
22473 ;; to be just a comment. Also, even with the right syntax at the
22474 ;; beginning of line, some some elements (i.e. verse-block or
22475 ;; example-block) don't accept comments. Usual Emacs comment commands
22476 ;; cannot cope with those requirements. Therefore, Org replaces them.
22478 ;; Org still relies on `comment-dwim', but cannot trust
22479 ;; `comment-only-p'. So, `comment-region-function' and
22480 ;; `uncomment-region-function' both point
22481 ;; to`org-comment-or-uncomment-region'. Eventually,
22482 ;; `org-insert-comment' takes care of insertion of comments at the
22483 ;; beginning of line.
22485 ;; `org-setup-comments-handling' install comments related variables
22486 ;; during `org-mode' initialization.
22488 (defun org-setup-comments-handling ()
22489 (interactive)
22490 (org-set-local 'comment-use-syntax nil)
22491 (org-set-local 'comment-start "# ")
22493 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22494 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22495 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22497 (defun org-insert-comment ()
22498 "Insert an empty comment above current line.
22499 If the line is empty, insert comment at its beginning."
22500 (beginning-of-line)
22502 (org-indent-line)
22503 (insert "# "))
22505 (defvar comment-empty-lines) ; From newcomment.el.
22506 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22507 "Comment or uncomment each non-blank line in the region.
22508 Uncomment each non-blank line between BEG and END if it only
22509 contains commented lines. Otherwise, comment them."
22510 (save-restriction
22511 ;; Restrict region
22512 (narrow-to-region (save-excursion (goto-char beg)
22514 (line-beginning-position))
22515 (save-excursion (goto-char end)
22517 (line-end-position)))
22518 (let ((uncommentp
22519 ;; UNCOMMENTP is non-nil when every non blank line between
22520 ;; BEG and END is a comment.
22521 (save-excursion
22522 (goto-char (point-min))
22523 (while (and (not (eobp))
22524 (let ((element (org-element-at-point)))
22525 (and (eq (org-element-type element) 'comment)
22526 (goto-char (min (point-max)
22527 (org-element-property
22528 :end element)))))))
22529 (eobp))))
22530 (if uncommentp
22531 ;; Only blank lines and comments in region: uncomment it.
22532 (save-excursion
22533 (goto-char (point-min))
22534 (while (not (eobp))
22536 (replace-match "" nil nil nil 1))
22537 (forward-line)))
22538 ;; Comment each line in region.
22539 (let ((min-indent (point-max)))
22540 ;; First find the minimum indentation across all lines.
22541 (save-excursion
22542 (goto-char (point-min))
22543 (while (and (not (eobp)) (not (zerop min-indent)))
22545 (setq min-indent (min min-indent (current-indentation))))
22546 (forward-line)))
22547 ;; Then loop over all lines.
22548 (save-excursion
22549 (goto-char (point-min))
22550 (while (not (eobp))
22552 ;; Don't get fooled by invisible text (e.g. link path)
22553 ;; when moving to column MIN-INDENT.
22554 (let ((buffer-invisibility-spec nil))
22555 (org-move-to-column min-indent t))
22556 (insert comment-start))
22557 (forward-line))))))))
22560 ;;; Planning
22562 ;; This section contains tools to operate on timestamp objects, as
22563 ;; returned by, e.g. `org-element-context'.
22565 (defun org-timestamp-has-time-p (timestamp)
22566 "Non-nil when TIMESTAMP has a time specified."
22567 (org-element-property :hour-start timestamp))
22569 (defun org-timestamp-format (timestamp format &optional end utc)
22570 "Format a TIMESTAMP element into a string.
22572 FORMAT is a format specifier to be passed to
22573 `format-time-string'.
22575 When optional argument END is non-nil, use end of date-range or
22576 time-range, if possible.
22578 When optional argument UTC is non-nil, time will be expressed as
22579 Universal Time."
22580 (format-time-string
22581 format
22582 (apply 'encode-time
22583 (cons 0
22584 (mapcar
22585 (lambda (prop) (or (org-element-property prop timestamp) 0))
22586 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22587 '(:minute-start :hour-start :day-start :month-start
22588 :year-start)))))
22589 utc))
22591 (defun org-timestamp-split-range (timestamp &optional end)
22592 "Extract a timestamp object from a date or time range.
22594 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22595 the end of the range. Otherwise, extract its start.
22597 Return a new timestamp object sharing the same parent as
22598 TIMESTAMP."
22599 (let ((type (org-element-property :type timestamp)))
22600 (if (memq type '(active inactive diary)) timestamp
22601 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22602 ;; Set new type.
22603 (org-element-put-property
22604 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22605 ;; Copy start properties over end properties if END is
22606 ;; non-nil. Otherwise, copy end properties over `start' ones.
22607 (let ((p-alist '((:minute-start . :minute-end)
22608 (:hour-start . :hour-end)
22609 (:day-start . :day-end)
22610 (:month-start . :month-end)
22611 (:year-start . :year-end))))
22612 (dolist (p-cell p-alist)
22613 (org-element-put-property
22614 split-ts
22615 (funcall (if end 'car 'cdr) p-cell)
22616 (org-element-property
22617 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22618 ;; Eventually refresh `:raw-value'.
22619 (org-element-put-property split-ts :raw-value nil)
22620 (org-element-put-property
22621 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22623 (defun org-timestamp-translate (timestamp &optional boundary)
22624 "Apply `org-translate-time' on a TIMESTAMP object.
22625 When optional argument BOUNDARY is non-nil, it is either the
22626 symbol `start' or `end'. In this case, only translate the
22627 starting or ending part of TIMESTAMP if it is a date or time
22628 range. Otherwise, translate both parts."
22629 (if (and (not boundary)
22630 (memq (org-element-property :type timestamp)
22631 '(active-range inactive-range)))
22632 (concat
22633 (org-translate-time
22634 (org-element-property :raw-value
22635 (org-timestamp-split-range timestamp)))
22636 "--"
22637 (org-translate-time
22638 (org-element-property :raw-value
22639 (org-timestamp-split-range timestamp t))))
22640 (org-translate-time
22641 (org-element-property
22642 :raw-value
22643 (if (not boundary) timestamp
22644 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22648 ;;; Other stuff.
22650 (defun org-toggle-fixed-width-section (arg)
22651 "Toggle the fixed-width export.
22652 If there is no active region, the QUOTE keyword at the current headline is
22653 inserted or removed. When present, it causes the text between this headline
22654 and the next to be exported as fixed-width text, and unmodified.
22655 If there is an active region, this command adds or removes a colon as the
22656 first character of this line. If the first character of a line is a colon,
22657 this line is also exported in fixed-width font."
22658 (interactive "P")
22659 (let* ((cc 0)
22660 (regionp (org-region-active-p))
22661 (beg (if regionp (region-beginning) (point)))
22662 (end (if regionp (region-end)))
22663 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22664 (case-fold-search nil)
22666 off)
22667 (if regionp
22668 (save-excursion
22669 (goto-char beg)
22670 (setq cc (current-column))
22671 (beginning-of-line 1)
22672 (setq off (looking-at re))
22673 (while (> nlines 0)
22674 (setq nlines (1- nlines))
22675 (beginning-of-line 1)
22676 (cond
22677 (arg
22678 (org-move-to-column cc t)
22680 (forward-line -1))
22681 ((and off (looking-at re))
22682 (replace-match "" t t nil 1))
22683 ((not off) (org-move-to-column cc t) (insert ": ")))
22684 (forward-line 1)))
22685 (save-excursion
22686 (org-back-to-heading)
22687 (cond
22688 ((looking-at (format org-heading-keyword-regexp-format
22689 org-quote-string))
22690 (goto-char (match-end 1))
22691 (looking-at (concat " +" org-quote-string))
22692 (replace-match "" t t)
22693 (when (eolp) (insert " ")))
22694 ((looking-at org-outline-regexp)
22695 (goto-char (match-end 0))
22696 (insert org-quote-string " ")))))))
22698 (defun org-reftex-citation ()
22699 "Use reftex-citation to insert a citation into the buffer.
22700 This looks for a line like
22702 #+BIBLIOGRAPHY: foo plain option:-d
22704 and derives from it that foo.bib is the bibliography file relevant
22705 for this document. It then installs the necessary environment for RefTeX
22706 to work in this buffer and calls `reftex-citation' to insert a citation
22707 into the buffer.
22709 Export of such citations to both LaTeX and HTML is handled by the contributed
22710 package ox-bibtex by Taru Karttunen."
22711 (interactive)
22712 (let ((reftex-docstruct-symbol 'rds)
22714 rds bib)
22715 (save-excursion
22716 (save-restriction
22717 (widen)
22718 (let ((case-fold-search t)
22720 (if (not (save-excursion
22721 (or (re-search-forward re nil t)
22722 (re-search-backward re nil t))))
22723 (error "No bibliography defined in file")
22724 (setq bib (concat (match-string 1) ".bib")
22725 rds (list (list 'bib bib)))))))
22726 (call-interactively 'reftex-citation)))
22728 ;;;; Functions extending outline functionality
22730 (defun org-beginning-of-line (&optional arg)
22731 "Go to the beginning of the current line. If that is invisible, continue
22732 to a visible line beginning. This makes the function of C-a more intuitive.
22733 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22734 first attempt, and only move to after the tags when the cursor is already
22735 beyond the end of the headline."
22736 (interactive "P")
22737 (let ((pos (point))
22738 (special (if (consp org-special-ctrl-a/e)
22739 (car org-special-ctrl-a/e)
22740 org-special-ctrl-a/e))
22741 deactivate-mark refpos)
22742 (if (org-bound-and-true-p visual-line-mode)
22743 (beginning-of-visual-line 1)
22744 (beginning-of-line 1))
22745 (if (and arg (fboundp 'move-beginning-of-line))
22746 (call-interactively 'move-beginning-of-line)
22747 (if (bobp)
22748 nil
22749 (backward-char 1)
22750 (if (org-truely-invisible-p)
22751 (while (and (not (bobp)) (org-truely-invisible-p))
22752 (backward-char 1)
22753 (beginning-of-line 1))
22754 (forward-char 1))))
22755 (when special
22756 (cond
22757 ((and (looking-at org-complex-heading-regexp)
22758 (= (char-after (match-end 1)) ?\ ))
22759 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22760 (point-at-eol)))
22761 (goto-char
22762 (if (eq special t)
22763 (cond ((> pos refpos) refpos)
22764 ((= pos (point)) refpos)
22765 (t (point)))
22766 (cond ((> pos (point)) (point))
22767 ((not (eq last-command this-command)) (point))
22768 (t refpos)))))
22769 ((org-at-item-p)
22770 ;; Being at an item and not looking at an the item means point
22771 ;; was previously moved to beginning of a visual line, which
22772 ;; doesn't contain the item. Therefore, do nothing special,
22773 ;; just stay here.
22774 (when (looking-at org-list-full-item-re)
22775 ;; Set special position at first white space character after
22776 ;; bullet, and check-box, if any.
22777 (let ((after-bullet
22778 (let ((box (match-end 3)))
22779 (if (not box) (match-end 1)
22780 (let ((after (char-after box)))
22781 (if (and after (= after ? )) (1+ box) box))))))
22782 ;; Special case: Move point to special position when
22783 ;; currently after it or at beginning of line.
22784 (if (eq special t)
22785 (when (or (> pos after-bullet) (= (point) pos))
22786 (goto-char after-bullet))
22787 ;; Reversed case: Move point to special position when
22788 ;; point was already at beginning of line and command is
22789 ;; repeated.
22790 (when (and (= (point) pos) (eq last-command this-command))
22791 (goto-char after-bullet))))))))
22792 (org-no-warnings
22793 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22794 (setq disable-point-adjustment
22795 (or (not (invisible-p (point)))
22796 (not (invisible-p (max (point-min) (1- (point))))))))
22798 (defun org-end-of-line (&optional arg)
22799 "Go to the end of the line.
22800 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22801 tags on the first attempt, and only move to after the tags when
22802 the cursor is already beyond the end of the headline."
22803 (interactive "P")
22804 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22805 org-special-ctrl-a/e))
22806 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22807 'end-of-visual-line)
22808 ((fboundp 'move-end-of-line) 'move-end-of-line)
22809 (t 'end-of-line)))
22810 deactivate-mark)
22811 (if (or (not special) arg) (call-interactively move-fun)
22812 (let* ((element (save-excursion (beginning-of-line)
22813 (org-element-at-point)))
22814 (type (org-element-type element)))
22815 (cond
22816 ((memq type '(headline inlinetask))
22817 (let ((pos (point)))
22818 (beginning-of-line 1)
22820 (if (eq special t)
22821 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22822 (goto-char (match-beginning 1))
22823 (goto-char (match-end 0)))
22824 (if (or (< pos (match-end 0))
22825 (not (eq this-command last-command)))
22826 (goto-char (match-end 0))
22827 (goto-char (match-beginning 1))))
22828 (call-interactively move-fun))))
22829 ((org-element-property :hiddenp element)
22830 ;; If element is hidden, `move-end-of-line' would put point
22831 ;; after it. Use `end-of-line' to stay on current line.
22832 (call-interactively 'end-of-line))
22833 (t (call-interactively move-fun)))))
22834 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22835 (setq disable-point-adjustment
22836 (or (not (invisible-p (point)))
22837 (not (invisible-p (max (point-min) (1- (point))))))))
22839 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22840 (define-key org-mode-map "\C-e" 'org-end-of-line)
22842 (defun org-backward-sentence (&optional arg)
22843 "Go to beginning of sentence, or beginning of table field.
22844 This will call `backward-sentence' or `org-table-beginning-of-field',
22845 depending on context."
22846 (interactive "P")
22847 (cond
22848 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22849 (t (call-interactively 'backward-sentence))))
22851 (defun org-forward-sentence (&optional arg)
22852 "Go to end of sentence, or end of table field.
22853 This will call `forward-sentence' or `org-table-end-of-field',
22854 depending on context."
22855 (interactive "P")
22856 (cond
22857 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22858 (t (call-interactively 'forward-sentence))))
22860 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22861 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22863 (defun org-kill-line (&optional arg)
22864 "Kill line, to tags or end of line."
22865 (interactive "P")
22866 (cond
22867 ((or (not org-special-ctrl-k)
22868 (bolp)
22869 (not (org-at-heading-p)))
22870 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22871 org-ctrl-k-protect-subtree)
22872 (if (or (eq org-ctrl-k-protect-subtree 'error)
22873 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22874 (user-error "C-k aborted as it would kill a hidden subtree")))
22875 (call-interactively
22876 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22878 (kill-region (point) (match-beginning 1))
22879 (org-set-tags nil t))
22880 (t (kill-region (point) (point-at-eol)))))
22882 (define-key org-mode-map "\C-k" 'org-kill-line)
22884 (defun org-yank (&optional arg)
22885 "Yank. If the kill is a subtree, treat it specially.
22886 This command will look at the current kill and check if is a single
22887 subtree, or a series of subtrees[1]. If it passes the test, and if the
22888 cursor is at the beginning of a line or after the stars of a currently
22889 empty headline, then the yank is handled specially. How exactly depends
22890 on the value of the following variables, both set by default.
22892 org-yank-folded-subtrees
22893 When set, the subtree(s) will be folded after insertion, but only
22894 if doing so would now swallow text after the yanked text.
22896 org-yank-adjusted-subtrees
22897 When set, the subtree will be promoted or demoted in order to
22898 fit into the local outline tree structure, which means that the level
22899 will be adjusted so that it becomes the smaller one of the two
22900 *visible* surrounding headings.
22902 Any prefix to this command will cause `yank' to be called directly with
22904 will just
22905 plainly yank the text as it is.
22907 \[1] The test checks if the first non-white line is a heading
22908 and if there are no other headings with fewer stars."
22909 (interactive "P")
22910 (org-yank-generic 'yank arg))
22912 (defun org-yank-generic (command arg)
22913 "Perform some yank-like command.
22915 This function implements the behavior described in the `org-yank'
22916 documentation. However, it has been generalized to work for any
22917 interactive command with similar behavior."
22919 ;; pretend to be command COMMAND
22920 (setq this-command command)
22922 (if arg
22923 (call-interactively command)
22925 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22926 (and (org-kill-is-subtree-p)
22927 (or (bolp)
22929 (string-match
22931 (buffer-substring (point-at-bol) (point)))))))
22932 swallowp)
22933 (cond
22934 ((and subtreep org-yank-folded-subtrees)
22935 (let ((beg (point))
22936 end)
22937 (if (and subtreep org-yank-adjusted-subtrees)
22938 (org-paste-subtree nil nil 'for-yank)
22939 (call-interactively command))
22941 (setq end (point))
22942 (goto-char beg)
22943 (when (and (bolp) subtreep
22944 (not (setq swallowp
22945 (org-yank-folding-would-swallow-text beg end))))
22946 (org-with-limited-levels
22947 (or (looking-at org-outline-regexp)
22948 (re-search-forward org-outline-regexp-bol end t))
22949 (while (and (< (point) end) (looking-at org-outline-regexp))
22950 (hide-subtree)
22951 (org-cycle-show-empty-lines 'folded)
22952 (condition-case nil
22953 (outline-forward-same-level 1)
22954 (error (goto-char end))))))
22955 (when swallowp
22956 (message
22957 "Inserted text not folded because that would swallow text"))
22959 (goto-char end)
22961 (beginning-of-line 1)
22962 (push-mark beg 'nomsg)))
22963 ((and subtreep org-yank-adjusted-subtrees)
22964 (let ((beg (point-at-bol)))
22965 (org-paste-subtree nil nil 'for-yank)
22966 (push-mark beg 'nomsg)))
22967 (t
22968 (call-interactively command))))))
22970 (defun org-yank-folding-would-swallow-text (beg end)
22971 "Would hide-subtree at BEG swallow any text after END?"
22972 (let (level)
22973 (org-with-limited-levels
22974 (save-excursion
22975 (goto-char beg)
22976 (when (or (looking-at org-outline-regexp)
22977 (re-search-forward org-outline-regexp-bol end t))
22978 (setq level (org-outline-level)))
22979 (goto-char end)
22981 (if (or (eobp)
22982 (and (bolp) (looking-at org-outline-regexp)
22983 (<= (org-outline-level) level)))
22984 nil ; Nothing would be swallowed
22985 t))))) ; something would swallow
22987 (define-key org-mode-map "\C-y" 'org-yank)
22989 (defun org-truely-invisible-p ()
22990 "Check if point is at a character currently not visible.
22991 This version does not only check the character property, but also
22992 `visible-mode'."
22993 ;; Early versions of noutline don't have `outline-invisible-p'.
22994 (if (org-bound-and-true-p visible-mode)
22995 nil
22996 (outline-invisible-p)))
22998 (defun org-invisible-p2 ()
22999 "Check if point is at a character currently not visible."
23000 (save-excursion
23001 (if (and (eolp) (not (bobp))) (backward-char 1))
23002 ;; Early versions of noutline don't have `outline-invisible-p'.
23003 (outline-invisible-p)))
23005 (defun org-back-to-heading (&optional invisible-ok)
23006 "Call `outline-back-to-heading', but provide a better error message."
23007 (condition-case nil
23008 (outline-back-to-heading invisible-ok)
23009 (error (error "Before first headline at position %d in buffer %s"
23010 (point) (current-buffer)))))
23012 (defun org-before-first-heading-p ()
23013 "Before first heading?"
23014 (save-excursion
23015 (end-of-line)
23016 (null (re-search-backward org-outline-regexp-bol nil t))))
23018 (defun org-at-heading-p (&optional ignored)
23019 (outline-on-heading-p t))
23020 ;; Compatibility alias with Org versions < 7.8.03
23021 (defalias 'org-on-heading-p 'org-at-heading-p)
23023 (defun org-at-comment-p nil
23024 "Is cursor in a line starting with a # character?"
23025 (save-excursion
23026 (beginning-of-line)
23027 (looking-at "^#")))
23029 (defun org-at-drawer-p nil
23030 "Is cursor at a drawer keyword?"
23031 (save-excursion
23032 (move-beginning-of-line 1)
23033 (looking-at org-drawer-regexp)))
23035 (defun org-at-block-p nil
23036 "Is cursor at a block keyword?"
23037 (save-excursion
23038 (move-beginning-of-line 1)
23039 (looking-at org-block-regexp)))
23041 (defun org-point-at-end-of-empty-headline ()
23042 "If point is at the end of an empty headline, return t, else nil.
23043 If the heading only contains a TODO keyword, it is still still considered
23044 empty."
23046 (when org-todo-line-regexp
23047 (save-excursion
23048 (beginning-of-line 1)
23049 (let ((case-fold-search nil))
23050 (looking-at org-todo-line-regexp)
23051 (string= (match-string 3) ""))))))
23053 (defun org-at-heading-or-item-p ()
23054 (or (org-at-heading-p) (org-at-item-p)))
23056 (defun org-at-target-p ()
23057 (or (org-in-regexp org-radio-target-regexp)
23058 (org-in-regexp org-target-regexp)))
23059 ;; Compatibility alias with Org versions < 7.8.03
23060 (defalias 'org-on-target-p 'org-at-target-p)
23062 (defun org-up-heading-all (arg)
23063 "Move to the heading line of which the present line is a subheading.
23064 This function considers both visible and invisible heading lines.
23065 With argument, move up ARG levels."
23066 (if (fboundp 'outline-up-heading-all)
23067 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23068 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23070 (defun org-up-heading-safe ()
23071 "Move to the heading line of which the present line is a subheading.
23072 This version will not throw an error. It will return the level of the
23073 headline found, or nil if no higher level is found.
23075 Also, this function will be a lot faster than `outline-up-heading',
23076 because it relies on stars being the outline starters. This can really
23077 make a significant difference in outlines with very many siblings."
23078 (let (start-level re)
23079 (org-back-to-heading t)
23080 (setq start-level (funcall outline-level))
23081 (if (equal start-level 1)
23082 nil
23084 (if (re-search-backward re nil t)
23085 (funcall outline-level)))))
23087 (defun org-first-sibling-p ()
23088 "Is this heading the first child of its parents?"
23089 (interactive)
23090 (let ((re org-outline-regexp-bol)
23091 level l)
23092 (unless (org-at-heading-p t)
23093 (user-error "Not at a heading"))
23094 (setq level (funcall outline-level))
23095 (save-excursion
23096 (if (not (re-search-backward re nil t))
23097 t
23098 (setq l (funcall outline-level))
23099 (< l level)))))
23101 (defun org-goto-sibling (&optional previous)
23102 "Goto the next sibling, even if it is invisible.
23103 When PREVIOUS is set, go to the previous sibling instead. Returns t
23104 when a sibling was found. When none is found, return nil and don't
23105 move point."
23106 (let ((fun (if previous 're-search-backward 're-search-forward))
23107 (pos (point))
23108 (re org-outline-regexp-bol)
23109 level l)
23110 (when (condition-case nil (org-back-to-heading t) (error nil))
23111 (setq level (funcall outline-level))
23112 (catch 'exit
23113 (or previous (forward-char 1))
23114 (while (funcall fun re nil t)
23115 (setq l (funcall outline-level))
23116 (when (< l level) (goto-char pos) (throw 'exit nil))
23117 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23118 (goto-char pos)
23119 nil))))
23121 (defun org-show-siblings ()
23122 "Show all siblings of the current headline."
23123 (save-excursion
23124 (while (org-goto-sibling) (org-flag-heading nil)))
23125 (save-excursion
23126 (while (org-goto-sibling 'previous)
23127 (org-flag-heading nil))))
23129 (defun org-goto-first-child ()
23130 "Goto the first child, even if it is invisible.
23131 Return t when a child was found. Otherwise don't move point and
23132 return nil."
23133 (let (level (pos (point)) (re org-outline-regexp-bol))
23134 (when (condition-case nil (org-back-to-heading t) (error nil))
23135 (setq level (outline-level))
23136 (forward-char 1)
23137 (if (and (re-search-forward re nil t) (> (outline-level) level))
23138 (progn (goto-char (match-beginning 0)) t)
23139 (goto-char pos) nil))))
23141 (defun org-show-hidden-entry ()
23142 "Show an entry where even the heading is hidden."
23143 (save-excursion
23144 (org-show-entry)))
23146 (defun org-flag-heading (flag &optional entry)
23147 "Flag the current heading. FLAG non-nil means make invisible.
23148 When ENTRY is non-nil, show the entire entry."
23149 (save-excursion
23150 (org-back-to-heading t)
23151 ;; Check if we should show the entire entry
23152 (if entry
23153 (progn
23154 (org-show-entry)
23155 (save-excursion
23156 (and (outline-next-heading)
23157 (org-flag-heading nil))))
23158 (outline-flag-region (max (point-min) (1- (point)))
23159 (save-excursion (outline-end-of-heading) (point))
23160 flag))))
23162 (defun org-get-next-sibling ()
23163 "Move to next heading of the same level, and return point.
23164 If there is no such heading, return nil.
23165 This is like outline-next-sibling, but invisible headings are ok."
23166 (let ((level (funcall outline-level)))
23167 (outline-next-heading)
23168 (while (and (not (eobp)) (> (funcall outline-level) level))
23169 (outline-next-heading))
23170 (if (or (eobp) (< (funcall outline-level) level))
23171 nil
23172 (point))))
23174 (defun org-get-last-sibling ()
23175 "Move to previous heading of the same level, and return point.
23176 If there is no such heading, return nil."
23177 (let ((opoint (point))
23178 (level (funcall outline-level)))
23179 (outline-previous-heading)
23180 (when (and (/= (point) opoint) (outline-on-heading-p t))
23181 (while (and (> (funcall outline-level) level)
23182 (not (bobp)))
23183 (outline-previous-heading))
23184 (if (< (funcall outline-level) level)
23185 nil
23186 (point)))))
23188 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23189 "Goto to the end of a subtree."
23190 ;; This contains an exact copy of the original function, but it uses
23191 ;; `org-back-to-heading', to make it work also in invisible
23192 ;; trees. And is uses an invisible-ok argument.
23193 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23194 ;; Furthermore, when used inside Org, finding the end of a large subtree
23195 ;; with many children and grandchildren etc, this can be much faster
23196 ;; than the outline version.
23197 (org-back-to-heading invisible-ok)
23198 (let ((first t)
23199 (level (funcall outline-level)))
23200 (if (and (derived-mode-p 'org-mode) (< level 1000))
23201 ;; A true heading (not a plain list item), in Org-mode
23202 ;; This means we can easily find the end by looking
23203 ;; only for the right number of stars. Using a regexp to do
23204 ;; this is so much faster than using a Lisp loop.
23206 (forward-char 1)
23207 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23208 ;; something else, do it the slow way
23209 (while (and (not (eobp))
23210 (or first (> (funcall outline-level) level)))
23211 (setq first nil)
23212 (outline-next-heading)))
23213 (unless to-heading
23215 (progn
23216 ;; Go to end of line before heading
23217 (forward-char -1)
23219 ;; leave blank line before heading
23220 (forward-char -1))))))
23221 (point))
23223 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23224 "Use Org version in org-mode, for dramatic speed-up."
23225 (if (derived-mode-p 'org-mode)
23226 (progn
23227 (org-end-of-subtree nil t)
23228 (unless (eobp) (backward-char 1)))
23229 ad-do-it))
23231 (defun org-end-of-meta-data-and-drawers ()
23232 "Jump to the first text after meta data and drawers in the current entry.
23233 This will move over empty lines, lines with planning time stamps,
23234 clocking lines, and drawers."
23235 (org-back-to-heading t)
23236 (let ((end (save-excursion (outline-next-heading) (point)))
23239 (forward-line 1)
23240 (while (re-search-forward re end t)
23241 (if (not (match-end 1))
23242 ;; empty or planning line
23243 (forward-line 1)
23244 ;; a drawer, find the end
23246 (forward-line 1)))
23248 (point)))
23250 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23251 "Move forward to the ARG'th subheading at same level as this one.
23252 Stop at the first and last subheadings of a superior heading.
23253 Normally this only looks at visible headings, but when INVISIBLE-OK is
23254 non-nil it will also look at invisible ones."
23255 (interactive "p")
23256 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23257 (if (and arg (< arg 0))
23258 (goto-char (point-min))
23259 (outline-next-heading))
23260 (org-at-heading-p)
23261 (let ((level (- (match-end 0) (match-beginning 0) 1))
23262 (f (if (and arg (< arg 0))
23263 're-search-backward
23264 're-search-forward))
23265 (count (if arg (abs arg) 1))
23266 (result (point)))
23267 (while (and (prog1 (> count 0)
23268 (forward-char (if (and arg (< arg 0)) -1 1)))
23269 (funcall f org-outline-regexp-bol nil 'move))
23270 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23271 (cond ((< l level) (setq count 0))
23272 ((and (= l level)
23273 (or invisible-ok
23274 (progn
23275 (goto-char (line-beginning-position))
23276 (not (outline-invisible-p)))))
23277 (setq count (1- count))
23278 (when (eq l level)
23279 (setq result (point)))))))
23280 (goto-char result))
23281 (beginning-of-line 1)))
23283 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23284 "Move backward to the ARG'th subheading at same level as this one.
23285 Stop at the first and last subheadings of a superior heading."
23286 (interactive "p")
23287 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23289 (defun org-next-block (arg &optional backward block-regexp)
23290 "Jump to the next block.
23291 With a prefix argument ARG, jump forward ARG many source blocks.
23292 When BACKWARD is non-nil, jump to the previous block.
23293 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23294 (interactive "p")
23295 (let ((re (or block-regexp org-block-regexp))
23296 (re-search-fn (or (and backward 're-search-backward)
23297 're-search-forward)))
23298 (if (looking-at re) (forward-char 1))
23299 (condition-case nil
23300 (funcall re-search-fn re nil nil arg)
23301 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23302 (goto-char (match-beginning 0)) (org-show-context)))
23304 (defun org-previous-block (arg &optional block-regexp)
23305 "Jump to the previous block.
23306 With a prefix argument ARG, jump backward ARG many source blocks.
23307 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23308 (interactive "p")
23309 (org-next-block arg t block-regexp))
23311 (defun org-forward-paragraph ()
23312 "Move forward to beginning of next paragraph or equivalent.
23314 The function moves point to the beginning of the next visible
23315 structural element, which can be a paragraph, a table, a list
23316 item, etc. It also provides some special moves for convenience:
23318 - On an affiliated keyword, jump to the beginning of the
23319 relative element.
23320 - On an item or a footnote definition, move to the second
23321 element inside, if any.
23322 - On a table or a property drawer, jump after it.
23323 - On a verse or source block, stop after blank lines."
23324 (interactive)
23325 (when (eobp) (user-error "Cannot move further down"))
23326 (let* ((deactivate-mark nil)
23327 (element (org-element-at-point))
23328 (type (org-element-type element))
23329 (post-affiliated (org-element-property :post-affiliated element))
23330 (contents-begin (org-element-property :contents-begin element))
23331 (contents-end (org-element-property :contents-end element))
23332 (end (let ((end (org-element-property :end element)) (parent element))
23333 (while (and (setq parent (org-element-property :parent parent))
23334 (= (org-element-property :contents-end parent) end))
23335 (setq end (org-element-property :end parent)))
23336 end)))
23337 (cond ((not element)
23339 (or (eobp) (beginning-of-line)))
23340 ;; On affiliated keywords, move to element's beginning.
23341 ((and post-affiliated (< (point) post-affiliated))
23342 (goto-char post-affiliated))
23343 ;; At a table row, move to the end of the table. Similarly,
23344 ;; at a node property, move to the end of the property
23345 ;; drawer.
23346 ((memq type '(node-property table-row))
23347 (goto-char (org-element-property
23348 :end (org-element-property :parent element))))
23349 ((memq type '(property-drawer table)) (goto-char end))
23350 ;; Consider blank lines as separators in verse and source
23351 ;; blocks to ease editing.
23352 ((memq type '(src-block verse-block))
23353 (when (eq type 'src-block)
23354 (setq contents-end
23355 (save-excursion (goto-char end)
23357 (line-beginning-position))))
23358 (beginning-of-line)
23361 (goto-char end)
23363 (if (= (point) contents-end) (goto-char end)
23364 (beginning-of-line))))
23365 ;; With no contents, just skip element.
23366 ((not contents-begin) (goto-char end))
23367 ;; If contents are invisible, skip the element altogether.
23368 ((outline-invisible-p (line-end-position))
23369 (case type
23370 (headline
23371 (org-with-limited-levels (outline-next-visible-heading 1)))
23372 ;; At a plain list, make sure we move to the next item
23373 ;; instead of skipping the whole list.
23374 (plain-list (forward-char)
23375 (org-forward-paragraph))
23376 (otherwise (goto-char end))))
23377 ((>= (point) contents-end) (goto-char end))
23378 ((>= (point) contents-begin)
23379 ;; This can only happen on paragraphs and plain lists.
23380 (case type
23381 (paragraph (goto-char end))
23382 ;; At a plain list, try to move to second element in
23383 ;; first item, if possible.
23384 (plain-list (end-of-line)
23385 (org-forward-paragraph))))
23386 ;; When contents start on the middle of a line (e.g. in
23387 ;; items and footnote definitions), try to reach first
23388 ;; element starting after current line.
23389 ((> (line-end-position) contents-begin)
23390 (end-of-line)
23391 (org-forward-paragraph))
23392 (t (goto-char contents-begin)))))
23394 (defun org-backward-paragraph ()
23395 "Move backward to start of previous paragraph or equivalent.
23397 The function moves point to the beginning of the current
23398 structural element, which can be a paragraph, a table, a list
23399 item, etc., or to the beginning of the previous visible one if
23400 point is already there. It also provides some special moves for
23401 convenience:
23403 - On an affiliated keyword, jump to the first one.
23404 - On a table or a property drawer, move to its beginning.
23405 - On a verse or source block, stop before blank lines."
23406 (interactive)
23407 (when (bobp) (user-error "Cannot move further up"))
23408 (let* ((deactivate-mark nil)
23409 (element (org-element-at-point))
23410 (type (org-element-type element))
23411 (contents-begin (org-element-property :contents-begin element))
23412 (contents-end (org-element-property :contents-end element))
23413 (post-affiliated (org-element-property :post-affiliated element))
23414 (begin (org-element-property :begin element)))
23415 (cond
23416 ((not element) (goto-char (point-min)))
23417 ((= (point) begin)
23418 (backward-char)
23419 (org-backward-paragraph))
23420 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23421 ((memq type '(node-property table-row))
23422 (goto-char (org-element-property
23423 :post-affiliated (org-element-property :parent element))))
23424 ((memq type '(property-drawer table)) (goto-char begin))
23425 ((memq type '(src-block verse-block))
23426 (when (eq type 'src-block)
23427 (setq contents-begin
23428 (save-excursion (goto-char begin) (forward-line) (point))))
23429 (if (= (point) contents-begin) (goto-char post-affiliated)
23430 ;; Inside a verse block, see blank lines as paragraph
23431 ;; separators.
23432 (let ((origin (point)))
23436 (if (= (point) origin) (goto-char contents-begin)
23437 (beginning-of-line))))))
23438 ((not contents-begin) (goto-char (or post-affiliated begin)))
23439 ((eq type 'paragraph)
23440 (goto-char contents-begin)
23441 ;; When at first paragraph in an item or a footnote definition,
23442 ;; move directly to beginning of line.
23443 (let ((parent-contents
23444 (org-element-property
23445 :contents-begin (org-element-property :parent element))))
23446 (when (and parent-contents (= parent-contents contents-begin))
23447 (beginning-of-line))))
23448 ;; At the end of a greater element, move to the beginning of the
23449 ;; last element within.
23450 ((>= (point) contents-end)
23451 (goto-char (1- contents-end))
23452 (org-backward-paragraph))
23453 (t (goto-char (or post-affiliated begin))))
23454 ;; Ensure we never leave point invisible.
23455 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23457 (defun org-forward-element ()
23458 "Move forward by one element.
23459 Move to the next element at the same level, when possible."
23460 (interactive)
23461 (cond ((eobp) (user-error "Cannot move further down"))
23462 ((org-with-limited-levels (org-at-heading-p))
23463 (let ((origin (point)))
23464 (goto-char (org-end-of-subtree nil t))
23465 (unless (org-with-limited-levels (org-at-heading-p))
23466 (goto-char origin)
23467 (user-error "Cannot move further down"))))
23468 (t
23469 (let* ((elem (org-element-at-point))
23470 (end (org-element-property :end elem))
23471 (parent (org-element-property :parent elem)))
23472 (cond ((and parent (= (org-element-property :contents-end parent) end))
23473 (goto-char (org-element-property :end parent)))
23474 ((integer-or-marker-p end) (goto-char end))
23475 (t (message "No element at point")))))))
23477 (defun org-backward-element ()
23478 "Move backward by one element.
23479 Move to the previous element at the same level, when possible."
23480 (interactive)
23481 (cond ((bobp) (user-error "Cannot move further up"))
23482 ((org-with-limited-levels (org-at-heading-p))
23483 ;; At a headline, move to the previous one, if any, or stay
23484 ;; here.
23485 (let ((origin (point)))
23486 (org-with-limited-levels (org-backward-heading-same-level 1))
23487 ;; When current headline has no sibling above, move to its
23488 ;; parent.
23489 (when (= (point) origin)
23490 (or (org-with-limited-levels (org-up-heading-safe))
23491 (progn (goto-char origin)
23492 (user-error "Cannot move further up"))))))
23493 (t
23494 (let* ((trail (org-element-at-point 'keep-trail))
23495 (elem (car trail))
23496 (prev-elem (nth 1 trail))
23497 (beg (org-element-property :begin elem)))
23498 (cond
23499 ;; Move to beginning of current element if point isn't
23500 ;; there already.
23501 ((null beg) (message "No element at point"))
23502 ((/= (point) beg) (goto-char beg))
23503 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23504 ((org-before-first-heading-p) (goto-char (point-min)))
23505 (t (org-back-to-heading)))))))
23507 (defun org-up-element ()
23508 "Move to upper element."
23509 (interactive)
23510 (if (org-with-limited-levels (org-at-heading-p))
23511 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23512 (let* ((elem (org-element-at-point))
23513 (parent (org-element-property :parent elem)))
23514 (if parent (goto-char (org-element-property :begin parent))
23515 (if (org-with-limited-levels (org-before-first-heading-p))
23516 (user-error "No surrounding element")
23517 (org-with-limited-levels (org-back-to-heading)))))))
23519 (defvar org-element-greater-elements)
23520 (defun org-down-element ()
23521 "Move to inner element."
23522 (interactive)
23523 (let ((element (org-element-at-point)))
23524 (cond
23525 ((memq (org-element-type element) '(plain-list table))
23526 (goto-char (org-element-property :contents-begin element))
23527 (forward-char))
23528 ((memq (org-element-type element) org-element-greater-elements)
23529 ;; If contents are hidden, first disclose them.
23530 (when (org-element-property :hiddenp element) (org-cycle))
23531 (goto-char (or (org-element-property :contents-begin element)
23532 (user-error "No content for this element"))))
23533 (t (user-error "No inner element")))))
23535 (defun org-drag-element-backward ()
23536 "Move backward element at point."
23537 (interactive)
23538 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23539 (let* ((trail (org-element-at-point 'keep-trail))
23540 (elem (car trail))
23541 (prev-elem (nth 1 trail)))
23542 ;; Error out if no previous element or previous element is
23543 ;; a parent of the current one.
23544 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23545 (user-error "Cannot drag element backward")
23546 (let ((pos (point)))
23547 (org-element-swap-A-B prev-elem elem)
23548 (goto-char (+ (org-element-property :begin prev-elem)
23549 (- pos (org-element-property :begin elem)))))))))
23551 (defun org-drag-element-forward ()
23552 "Move forward element at point."
23553 (interactive)
23554 (let* ((pos (point))
23555 (elem (org-element-at-point)))
23556 (when (= (point-max) (org-element-property :end elem))
23557 (user-error "Cannot drag element forward"))
23558 (goto-char (org-element-property :end elem))
23559 (let ((next-elem (org-element-at-point)))
23560 (when (or (org-element-nested-p elem next-elem)
23561 (and (eq (org-element-type next-elem) 'headline)
23562 (not (eq (org-element-type elem) 'headline))))
23563 (goto-char pos)
23564 (user-error "Cannot drag element forward"))
23565 ;; Compute new position of point: it's shifted by NEXT-ELEM
23566 ;; body's length (without final blanks) and by the length of
23567 ;; blanks between ELEM and NEXT-ELEM.
23568 (let ((size-next (- (save-excursion
23569 (goto-char (org-element-property :end next-elem))
23571 (forward-line)
23572 ;; Small correction if buffer doesn't end
23573 ;; with a newline character.
23574 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23575 (org-element-property :begin next-elem)))
23576 (size-blank (- (org-element-property :end elem)
23577 (save-excursion
23578 (goto-char (org-element-property :end elem))
23580 (forward-line)
23581 (point)))))
23582 (org-element-swap-A-B elem next-elem)
23583 (goto-char (+ pos size-next size-blank))))))
23585 (defun org-drag-line-forward (arg)
23586 "Drag the line at point ARG lines forward."
23587 (interactive "p")
23588 (dotimes (n (abs arg))
23589 (let ((c (current-column)))
23590 (if (< 0 arg)
23591 (progn
23592 (beginning-of-line 2)
23593 (transpose-lines 1)
23594 (beginning-of-line 0))
23595 (transpose-lines 1)
23596 (beginning-of-line -1))
23597 (org-move-to-column c))))
23599 (defun org-drag-line-backward (arg)
23600 "Drag the line at point ARG lines backward."
23601 (interactive "p")
23602 (org-drag-line-forward (- arg)))
23604 (defun org-mark-element ()
23605 "Put point at beginning of this element, mark at end.
23607 Interactively, if this command is repeated or (in Transient Mark
23608 mode) if the mark is active, it marks the next element after the
23609 ones already marked."
23610 (interactive)
23611 (let (deactivate-mark)
23612 (if (and (org-called-interactively-p 'any)
23613 (or (and (eq last-command this-command) (mark t))
23614 (and transient-mark-mode mark-active)))
23615 (set-mark
23616 (save-excursion
23617 (goto-char (mark))
23618 (goto-char (org-element-property :end (org-element-at-point)))))
23619 (let ((element (org-element-at-point)))
23620 (end-of-line)
23621 (push-mark (org-element-property :end element) t t)
23622 (goto-char (org-element-property :begin element))))))
23624 (defun org-narrow-to-element ()
23625 "Narrow buffer to current element."
23626 (interactive)
23627 (let ((elem (org-element-at-point)))
23628 (cond
23629 ((eq (car elem) 'headline)
23630 (narrow-to-region
23631 (org-element-property :begin elem)
23632 (org-element-property :end elem)))
23633 ((memq (car elem) org-element-greater-elements)
23634 (narrow-to-region
23635 (org-element-property :contents-begin elem)
23636 (org-element-property :contents-end elem)))
23637 (t
23638 (narrow-to-region
23639 (org-element-property :begin elem)
23640 (org-element-property :end elem))))))
23642 (defun org-transpose-element ()
23643 "Transpose current and previous elements, keeping blank lines between.
23644 Point is moved after both elements."
23645 (interactive)
23646 (org-skip-whitespace)
23647 (let ((end (org-element-property :end (org-element-at-point))))
23648 (org-drag-element-backward)
23649 (goto-char end)))
23651 (defun org-unindent-buffer ()
23652 "Un-indent the visible part of the buffer.
23653 Relative indentation (between items, inside blocks, etc.) isn't
23654 modified."
23655 (interactive)
23656 (unless (eq major-mode 'org-mode)
23657 (user-error "Cannot un-indent a buffer not in Org mode"))
23658 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23659 unindent-tree ; For byte-compiler.
23660 (unindent-tree
23661 (function
23662 (lambda (contents)
23663 (mapc
23664 (lambda (element)
23665 (if (memq (org-element-type element) '(headline section))
23666 (funcall unindent-tree (org-element-contents element))
23667 (save-excursion
23668 (save-restriction
23669 (narrow-to-region
23670 (org-element-property :begin element)
23671 (org-element-property :end element))
23672 (org-do-remove-indentation)))))
23673 (reverse contents))))))
23674 (funcall unindent-tree (org-element-contents parse-tree))))
23676 (defun org-show-subtree ()
23677 "Show everything after this heading at deeper levels."
23678 (interactive)
23679 (outline-flag-region
23680 (point)
23681 (save-excursion
23682 (org-end-of-subtree t t))
23683 nil))
23685 (defun org-show-entry ()
23686 "Show the body directly following this heading.
23687 Show the heading too, if it is currently invisible."
23688 (interactive)
23689 (save-excursion
23690 (condition-case nil
23691 (progn
23692 (org-back-to-heading t)
23693 (outline-flag-region
23694 (max (point-min) (1- (point)))
23695 (save-excursion
23696 (if (re-search-forward
23698 (match-beginning 1)
23699 (point-max)))
23700 nil)
23701 (org-cycle-hide-drawers 'children))
23702 (error nil))))
23704 (defun org-make-options-regexp (kwds &optional extra)
23705 "Make a regular expression for keyword lines."
23706 (concat
23712 ;; Make isearch reveal the necessary context
23713 (defun org-isearch-end ()
23714 "Reveal context after isearch exits."
23715 (when isearch-success ; only if search was successful
23716 (if (featurep 'xemacs)
23717 ;; Under XEmacs, the hook is run in the correct place,
23718 ;; we directly show the context.
23719 (org-show-context 'isearch)
23720 ;; In Emacs the hook runs *before* restoring the overlays.
23721 ;; So we have to use a one-time post-command-hook to do this.
23722 ;; (Emacs 22 has a special variable, see function `org-mode')
23723 (unless (and (boundp 'isearch-mode-end-hook-quit)
23724 isearch-mode-end-hook-quit)
23725 ;; Only when the isearch was not quitted.
23726 (org-add-hook 'post-command-hook 'org-isearch-post-command
23727 'append 'local)))
23728 (org-fix-ellipsis-at-bol)))
23730 (defun org-isearch-post-command ()
23731 "Remove self from hook, and show context."
23732 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23733 (org-show-context 'isearch))
23736 ;;;; Integration with and fixes for other packages
23738 ;;; Imenu support
23740 (defvar org-imenu-markers nil
23741 "All markers currently used by Imenu.")
23742 (make-variable-buffer-local 'org-imenu-markers)
23744 (defun org-imenu-new-marker (&optional pos)
23745 "Return a new marker for use by Imenu, and remember the marker."
23746 (let ((m (make-marker)))
23747 (move-marker m (or pos (point)))
23748 (push m org-imenu-markers)
23749 m))
23751 (defun org-imenu-get-tree ()
23752 "Produce the index for Imenu."
23753 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23754 (setq org-imenu-markers nil)
23755 (let* ((n org-imenu-depth)
23756 (re (concat "^" (org-get-limited-outline-regexp)))
23757 (subs (make-vector (1+ n) nil))
23758 (last-level 0)
23759 m level head0 head)
23760 (save-excursion
23761 (save-restriction
23762 (widen)
23763 (goto-char (point-max))
23764 (while (re-search-backward re nil t)
23765 (setq level (org-reduced-level (funcall outline-level)))
23766 (when (and (<= level n)
23767 (looking-at org-complex-heading-regexp)
23768 (setq head0 (org-match-string-no-properties 4)))
23769 (setq head (org-link-display-format head0)
23770 m (org-imenu-new-marker))
23771 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23772 (if (>= level last-level)
23773 (push (cons head m) (aref subs level))
23774 (push (cons head (aref subs (1+ level))) (aref subs level))
23775 (loop for i from (1+ level) to n do (aset subs i nil)))
23776 (setq last-level level)))))
23777 (aref subs 1)))
23779 (eval-after-load "imenu"
23780 '(progn
23781 (add-hook 'imenu-after-jump-hook
23782 (lambda ()
23783 (if (derived-mode-p 'org-mode)
23784 (org-show-context 'org-goto))))))
23786 (defun org-link-display-format (link)
23787 "Replace a link with its the description.
23788 If there is no description, use the link target."
23789 (save-match-data
23790 (if (string-match org-bracket-link-analytic-regexp link)
23791 (replace-match (if (match-end 5)
23792 (match-string 5 link)
23793 (concat (match-string 1 link)
23794 (match-string 3 link)))
23795 nil t link)
23796 link)))
23798 (defun org-toggle-link-display ()
23799 "Toggle the literal or descriptive display of links."
23800 (interactive)
23801 (if org-descriptive-links
23802 (progn (org-remove-from-invisibility-spec '(org-link))
23803 (org-restart-font-lock)
23804 (setq org-descriptive-links nil))
23805 (progn (add-to-invisibility-spec '(org-link))
23806 (org-restart-font-lock)
23807 (setq org-descriptive-links t))))
23809 ;; Speedbar support
23811 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23812 "Overlay marking the agenda restriction line in speedbar.")
23813 (overlay-put org-speedbar-restriction-lock-overlay
23814 'face 'org-agenda-restriction-lock)
23815 (overlay-put org-speedbar-restriction-lock-overlay
23816 'help-echo "Agendas are currently limited to this item.")
23817 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23819 (defun org-speedbar-set-agenda-restriction ()
23820 "Restrict future agenda commands to the location at point in speedbar.
23822 (interactive)
23823 (require 'org-agenda)
23824 (let (p m tp np dir txt)
23825 (cond
23826 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23827 'org-imenu t))
23828 (setq m (get-text-property p 'org-imenu-marker))
23829 (with-current-buffer (marker-buffer m)
23830 (goto-char m)
23831 (org-agenda-set-restriction-lock 'subtree)))
23832 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23833 'speedbar-function 'speedbar-find-file))
23834 (setq tp (previous-single-property-change
23835 (1+ p) 'speedbar-function)
23836 np (next-single-property-change
23837 tp 'speedbar-function)
23838 dir (speedbar-line-directory)
23839 txt (buffer-substring-no-properties (or tp (point-min))
23840 (or np (point-max))))
23841 (with-current-buffer (find-file-noselect
23842 (let ((default-directory dir))
23843 (expand-file-name txt)))
23844 (unless (derived-mode-p 'org-mode)
23845 (user-error "Cannot restrict to non-Org-mode file"))
23846 (org-agenda-set-restriction-lock 'file)))
23847 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23848 (move-overlay org-speedbar-restriction-lock-overlay
23849 (point-at-bol) (point-at-eol))
23850 (setq current-prefix-arg nil)
23851 (org-agenda-maybe-redo)))
23853 (defvar speedbar-file-key-map)
23854 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23855 (eval-after-load "speedbar"
23856 '(progn
23857 (speedbar-add-supported-extension ".org")
23858 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23859 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23860 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23861 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23862 (add-hook 'speedbar-visiting-tag-hook
23863 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23865 ;;; Fixes and Hacks for problems with other packages
23867 ;; Make flyspell not check words in links, to not mess up our keymap
23868 (defvar org-element-affiliated-keywords) ; From org-element.el
23869 (defvar org-element-block-name-alist) ; From org-element.el
23870 (defun org-mode-flyspell-verify ()
23871 "Don't let flyspell put overlays at active buttons, or on
23872 {todo,all-time,additional-option-like}-keywords."
23873 (require 'org-element) ; For `org-element-affiliated-keywords'
23874 (let ((pos (max (1- (point)) (point-min)))
23875 (word (thing-at-point 'word)))
23876 (and (not (get-text-property pos 'keymap))
23877 (not (get-text-property pos 'org-no-flyspell))
23878 (not (member word org-todo-keywords-1))
23879 (not (member word org-all-time-keywords))
23880 (not (member word org-options-keywords))
23881 (not (member word (mapcar 'car org-startup-options)))
23882 (not (member-ignore-case word org-element-affiliated-keywords))
23883 (not (member-ignore-case word (org-get-export-keywords)))
23884 (not (member-ignore-case
23885 word (mapcar 'car org-element-block-name-alist)))
23886 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23887 (not (org-in-src-block-p)))))
23889 (defun org-remove-flyspell-overlays-in (beg end)
23890 "Remove flyspell overlays in region."
23891 (and (org-bound-and-true-p flyspell-mode)
23892 (fboundp 'flyspell-delete-region-overlays)
23893 (flyspell-delete-region-overlays beg end))
23894 (add-text-properties beg end '(org-no-flyspell t)))
23896 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23897 (eval-after-load "bookmark"
23898 '(if (boundp 'bookmark-after-jump-hook)
23899 ;; We can use the hook
23900 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23901 ;; Hook not available, use advice
23902 (defadvice bookmark-jump (after org-make-visible activate)
23903 "Make the position visible."
23904 (org-bookmark-jump-unhide))))
23906 ;; Make sure saveplace shows the location if it was hidden
23907 (eval-after-load "saveplace"
23908 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23909 "Make the position visible."
23910 (org-bookmark-jump-unhide)))
23912 ;; Make sure ecb shows the location if it was hidden
23913 (eval-after-load "ecb"
23914 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23915 "Make hierarchy visible when jumping into location from ECB tree buffer."
23916 (if (derived-mode-p 'org-mode)
23917 (org-show-context))))
23919 (defun org-bookmark-jump-unhide ()
23920 "Unhide the current position, to show the bookmark location."
23921 (and (derived-mode-p 'org-mode)
23922 (or (outline-invisible-p)
23923 (save-excursion (goto-char (max (point-min) (1- (point))))
23924 (outline-invisible-p)))
23925 (org-show-context 'bookmark-jump)))
23927 ;; Make session.el ignore our circular variable
23928 (defvar session-globals-exclude)
23929 (eval-after-load "session"
23930 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23932 ;;;; Finish up
23934 (provide 'org)
23936 (run-hooks 'org-load-hook)
23938 ;;; org.el ends here