| blob | 3a676309efb8687dd93881ed0ce62a2c956ab806 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;
26 ;;; Commentary:
27 ;;
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
30 ;;
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
45 ;;
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
49 ;;
50 ;; http://orgmode.org/org.html#Installation
51 ;;
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
59 ;;
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
62 ;;
63 ;;; Code:
70 ;;;; Require other packages
85 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
86 ;; some places -- e.g. see the macro `org-with-limited-levels'.
87 ;;
88 ;; In Org buffers, the value of `outline-regexp' is that of
89 ;; `org-outline-regexp'. The only function still directly relying on
90 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
91 ;; job when `orgstruct-mode' is active.
96 "Regexp to match Org headlines.
97 This is similar to `org-outline-regexp' but additionally makes
101 "Matches a headline, putting stars and text into groups.
104 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
117 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
163 ;; load languages based on value of `org-babel-load-languages'
166 ;;;###autoload
168 "Load the languages defined in `org-babel-load-languages'."
180 org-babel-load-languages))
182 ;;;###autoload
184 "Load Emacs Lisp source code blocks in the Org-mode FILE.
185 This function exports the source code using `org-babel-tangle'
186 and then loads the resulting file using `load-file'. With prefix
187 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
188 file to byte-code before it is loaded."
198 ;; tangle if the org-mode file is newer than the elisp file
207 exported-file)))
210 "Languages which can be evaluated in Org-mode buffers.
211 This list can be used to load support for any of the languages
212 below, note that each language will depend on a different set of
213 system executables and/or Emacs modes. When a language is
215 with `org-babel-execute-src-block' bound by default to C-c
216 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
217 be set to remove code block evaluation from the C-c C-c
218 keybinding. By default only Emacs Lisp (which has no
219 requirements) is loaded."
224 :key-type
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 _version)))
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
888 "Matches first line of a hidden block.
893 "Regular expression for specifying repeated events.
897 "Options concerning the general structure of Org-mode files."
902 "Options about how to make context of a location visible."
926 "Non-nil means show full hierarchy when revealing a location.
927 Org-mode often shows locations in an org-mode file which might have
928 been invisible before. When this is set, the hierarchy of headings
929 above the exposed location is shown.
930 Turning this off for example for sparse trees makes them very compact.
931 Instead of t, this can also be an alist specifying this option for different
932 contexts. Valid contexts are
933 agenda when exposing an entry from the agenda
934 org-goto when using the command `org-goto' on key C-c C-j
935 occur-tree when using the command `org-occur' on key C-c /
936 tags-tree when constructing a sparse tree based on tags matches
937 link-search when exposing search matches associated with a link
938 mark-goto when exposing the jump goal of a mark
939 bookmark-jump when exposing a bookmark location
940 isearch when exiting from an incremental search
941 default default for all contexts not set explicitly"
946 "Non-nil means show following heading when revealing a location.
947 Org-mode often shows locations in an org-mode file which might have
948 been invisible before. When this is set, the heading following the
949 match is shown.
950 Turning this off for example for sparse trees makes them very compact,
951 but makes it harder to edit the location of the match. In such a case,
953 Instead of t, this can also be an alist specifying this option for different
954 contexts. See `org-show-hierarchy-above' for valid contexts."
959 "Non-nil means show all sibling heading when revealing a location.
960 Org-mode often shows locations in an org-mode file which might have
961 been invisible before. When this is set, the sibling of the current entry
962 heading are all made visible. If `org-show-hierarchy-above' is t,
963 the same happens on each level of the hierarchy above the current entry.
965 By default this is on for the isearch context, off for all other contexts.
966 Turning this off for example for sparse trees makes them very compact,
967 but makes it harder to edit the location of the match. In such a case,
969 Instead of t, this can also be an alist specifying this option for different
970 contexts. See `org-show-hierarchy-above' for valid contexts."
972 :type org-context-choice
977 "Non-nil means show the entry below a headline when revealing a location.
978 Org-mode often shows locations in an org-mode file which might have
979 been invisible before. When this is set, the text below the headline that is
980 exposed is also shown.
982 By default this is off for all contexts.
983 Instead of t, this can also be an alist specifying this option for different
984 contexts. See `org-show-hierarchy-above' for valid contexts."
989 "How should indirect tree buffers be displayed?
990 This applies to indirect buffers created with the commands
992 Valid values are:
993 current-window Display in the current window
994 other-window Just display in another window.
995 dedicated-frame Create one new frame, and re-use it each time.
996 new-frame Make a new frame each time. Note that in this case
997 previously-made indirect buffers are kept, and you need to
998 kill these buffers yourself."
1008 "Non-nil means activate single letter commands at beginning of a headline.
1009 This may also be a function to test for appropriate locations where speed
1010 commands should be active."
1018 "Alist of additional speed commands.
1019 This list will be checked before `org-speed-commands-default'
1020 when the variable `org-use-speed-commands' is non-nil
1021 and when the cursor is at the beginning of a headline.
1022 The car if each entry is a string with a single letter, which must
1023 be assigned to `self-insert-command' in the global map.
1024 The cdr is either a command to be called interactively, a function
1025 to be called, or a form to be evaluated.
1026 An entry that is just a list with a single string will be interpreted
1027 as a descriptive headline that will be added when listing the speed
1028 commands in the Help buffer using the `?' speed command."
1043 "Names for bookmarks automatically set by some Org commands.
1044 This can provide strings as names for a number of bookmakrs Org sets
1045 automatically. The following keys are currently implemented:
1046 :last-capture
1047 :last-capture-marker
1048 :last-refile
1049 When a key does not show up in the property list, the corresponding bookmark
1050 is not set."
1055 "Options concerning visibility cycling in Org-mode."
1060 "Non-nil means skip CHILDREN state in entries that don't have any."
1065 "Maximum level which should still be subject to visibility cycling.
1066 Levels higher than this will, for cycling, be treated as text, not a headline.
1067 When `org-odd-levels-only' is set, a value of N in this variable actually
1068 means 2N-1 stars as the limiting headline.
1069 When nil, cycle all levels.
1070 Note that the limiting level of cycling is also influenced by
1071 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1072 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1073 than its value."
1080 "Non-nil means entering Org-mode will fold all blocks.
1081 This can also be set in on a per-file basis with
1083 #+STARTUP: hideblocks
1084 #+STARTUP: showblocks"
1090 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1091 This makes it possible to do global cycling without having to use S-TAB or
1093 of the buffer must not be a headline -- it may be empty or some other text.
1094 When used in this way, `org-cycle-hook' is disabled temporarily to make
1095 sure the cursor stays at the beginning of the buffer. When this option is
1096 nil, don't do anything special at the beginning of the buffer."
1101 "Non-nil means cycle entry level or item indentation in new empty entries.
1103 When the cursor is at the end of an empty headline, i.e., with only stars
1104 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1105 and then all possible ancestor states, before returning to the original state.
1106 This makes data entry extremely fast: M-RET to create a new headline,
1107 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1109 When the cursor is at the end of an empty plain list item, one TAB will
1110 make it a subitem, two or more tabs will back up to make this an item
1111 higher up in the item hierarchy."
1116 "Where should `org-cycle' emulate TAB.
1117 nil Never
1118 white Only in completely white lines
1119 whitestart Only at the beginning of lines, before the first non-white char
1120 t Everywhere except in headlines
1121 exc-hl-bol Everywhere except at the start of a headline
1122 If TAB is used in a place where it does not emulate TAB, the current subtree
1123 visibility is cycled."
1132 "Number of empty lines needed to keep an empty line between collapsed trees.
1133 If you leave an empty line between the end of a subtree and the following
1134 headline, this empty line is hidden when the subtree is folded.
1135 Org-mode will leave (exactly) one empty line visible if the number of
1136 empty lines is equal or larger to the number given in this variable.
1137 So the default 2 means at least 2 empty lines after the end of a subtree
1138 are needed to produce free space between a collapsed subtree and the
1139 following headline.
1141 If the number is negative, and the number of empty lines is at least -N,
1142 all empty lines are shown.
1144 Special case: when 0, never leave empty lines in collapsed view."
1150 "Hook that is run before visibility cycling is happening.
1151 The function(s) in this hook must accept a single argument which indicates
1152 the new state that will be set right after running this hook. The
1153 argument is a symbol. Before a global state change, it can have the values
1154 `overview', `content', or `all'. Before a local state change, it can have
1155 the values `folded', `children', or `subtree'."
1160 org-cycle-hide-drawers
1161 org-cycle-hide-inline-tasks
1162 org-cycle-show-empty-lines
1163 org-optimize-window-after-visibility-change)
1164 "Hook that is run after `org-cycle' has changed the buffer visibility.
1165 The function(s) in this hook must accept a single argument which indicates
1166 the new state that was set by the most recent `org-cycle' command. The
1167 argument is a symbol. After a global state change, it can have the values
1168 `overview', `contents', or `all'. After a local state change, it can have
1169 the values `folded', `children', or `subtree'."
1174 "Options concerning structure editing in Org-mode."
1179 "Non-nil means skip even levels and only use odd levels for the outline.
1180 This has the effect that two stars are being added/taken away in
1181 promotion/demotion commands. It also influences how levels are
1182 handled by the exporters.
1183 Changing it requires restart of `font-lock-mode' to become effective
1184 for fontification also in regions already fontified.
1185 You may also set this on a per-file basis by adding one of the following
1186 lines to the buffer:
1188 #+STARTUP: odd
1189 #+STARTUP: oddeven"
1195 "Non-nil means adapt indentation to outline node level.
1197 When this variable is set, Org assumes that you write outlines by
1198 indenting text in each node to align with the headline (after the stars).
1199 The following issues are influenced by this variable:
1201 - When this is set and the *entire* text in an entry is indented, the
1202 indentation is increased by one space in a demotion command, and
1203 decreased by one in a promotion command. If any line in the entry
1204 body starts with text at column 0, indentation is not changed at all.
1206 - Property drawers and planning information is inserted indented when
1207 this variable s set. When nil, they will not be indented.
1209 - TAB indents a line relative to context. The lines below a headline
1210 will be indented when this variable is set.
1212 Note that this is all about true indentation, by adding and removing
1213 space characters. See also `org-indent.el' which does level-dependent
1214 indentation in a virtual way, i.e. at display time in Emacs."
1219 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1221 When t, `C-a' will bring back the cursor to the beginning of the
1222 headline text, i.e. after the stars and after a possible TODO
1223 keyword. In an item, this will be the position after bullet and
1224 check-box, if any. When the cursor is already at that position,
1225 another `C-a' will bring it to the beginning of the line.
1227 `C-e' will jump to the end of the headline, ignoring the presence
1228 of tags in the headline. A second `C-e' will then jump to the
1229 true end of the line, after any tags. This also means that, when
1230 this variable is non-nil, `C-e' also will never jump beyond the
1231 end of the heading of a folded section, i.e. not after the
1232 ellipses.
1234 When set to the symbol `reversed', the first `C-a' or `C-e' works
1235 normally, going to the true line boundary first. Only a directly
1236 following, identical keypress will bring the cursor to the
1237 special positions.
1239 This may also be a cons cell where the behavior for `C-a' and
1240 `C-e' is set separately."
1258 "Non-nil means `C-k' will behave specially in headlines.
1259 When nil, `C-k' will call the default `kill-line' command.
1260 When t, the following will happen while the cursor is in the headline:
1262 - When the cursor is at the beginning of a headline, kill the entire
1263 line and possible the folded subtree below the line.
1264 - When in the middle of the headline text, kill the headline up to the tags.
1265 - When after the headline text, kill the tags."
1270 "Non-nil means, do not delete a hidden subtree with C-k.
1271 When set to the symbol `error', simply throw an error when C-k is
1272 used to kill (part-of) a headline that has hidden text behind it.
1273 Any other non-nil value will result in a query to the user, if it is
1274 OK to kill that hidden subtree. When nil, kill without remorse."
1283 "Non-nil means, make `C-o' insert a row in tables."
1288 "Check if in invisible region before inserting or deleting a character.
1289 Valid values are:
1291 nil Do not check, so just do invisible edits.
1292 error Throw an error and do nothing.
1293 show Make point visible, and do the requested edit.
1294 show-and-error Make point visible, then throw an error and abort the edit.
1295 smart Make point visible, and do insertion/deletion if it is
1296 adjacent to visible text and the change feels predictable.
1297 Never delete a previously invisible character or add in the
1298 middle or right after an invisible region. Basically, this
1299 allows insertion and backward-delete right before ellipses.
1300 FIXME: maybe in this case we should not even show?"
1311 "Non-nil means when yanking subtrees, fold them.
1312 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1313 it starts with a heading and all other headings in it are either children
1314 or siblings, then fold all the subtrees. However, do this only if no
1315 text after the yank would be swallowed into a folded tree by this action."
1320 "Non-nil means when yanking subtrees, adjust the level.
1321 With this setting, `org-paste-subtree' is used to insert the subtree, see
1322 this function for details."
1327 "Non-nil means M-RET will split the line at the cursor position.
1328 When nil, it will go to the end of the line before making a
1329 new line.
1330 You may also set this option in a different way for different
1331 contexts. Valid contexts are:
1333 headline when creating a new headline
1334 item when creating a new item
1335 table in a table field
1336 default the value to be used for all contexts not explicitly
1337 customized"
1354 "Non-nil means insert new headings after the current subtree.
1355 When nil, the new heading is created directly after the current line.
1356 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1357 this variable on for the duration of the command."
1363 "Should `org-insert-heading' leave a blank line before new heading/item?
1364 The value is an alist, with `heading' and `plain-list-item' as CAR,
1365 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1366 which case Org will look at the surrounding headings/items and try to
1367 make an intelligent decision whether to insert a blank line or not.
1369 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1370 the setting here is ignored and no empty line is inserted to avoid breaking
1371 the list structure."
1384 "Hook being run after inserting a new heading."
1390 This currently only means they are never auto-wrapped.
1391 When nil, such lines will be treated like ordinary lines.
1392 See also the QUOTE keyword."
1397 "Non-nil means typing characters in `org-goto' starts incremental search.
1398 When nil, you can use these keybindings to navigate the buffer:
1400 q Quit the org-goto interface
1401 n Go to the next visible heading
1402 p Go to the previous visible heading
1403 f Go one heading forward on same level
1404 b Go one heading backward on same level
1405 u Go one heading up"
1410 "Options concerning sparse trees in Org-mode."
1415 "Non-nil means highlight all matches that define a sparse tree.
1416 The highlights will automatically disappear the next time the buffer is
1417 changed by an edit command."
1422 "Non-nil means any change to the buffer will remove temporary highlights.
1423 Such highlights are created by `org-occur' and `org-clock-display'.
1424 When nil, `C-c C-c needs to be used to get rid of the highlights.
1425 The highlights created by `org-preview-latex-fragment' always need
1426 `C-c C-c' to be removed."
1433 "Hook that is run after `org-occur' has constructed a sparse tree.
1434 This can be used to recenter the window to show as much of the structure
1435 as possible."
1440 "Options concerning imenu and speedbar in Org-mode."
1445 "The maximum level for Imenu access to Org-mode headlines.
1446 This also applied for speedbar access."
1451 "Options concerning tables in Org-mode."
1457 When nil, such lines will be treated like ordinary lines.
1459 When equal to the symbol `optimized', the table editor will be optimized to
1460 do the following:
1461 - Automatic overwrite mode in front of whitespace in table fields.
1462 This makes the structure of the table stay in tact as long as the edited
1463 field does not exceed the column width.
1464 - Minimize the number of realigns. Normally, the table is aligned each time
1465 TAB or RET are pressed to move to another field. With optimization this
1466 happens only if changes to a field might have changed the column width.
1467 Optimization requires replacing the functions `self-insert-command',
1468 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1469 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1470 very good at guessing when a re-align will be necessary, but you can always
1473 If you would like to use the optimized version in Org-mode, but the
1474 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1476 This variable can be used to turn on and off the table editor during a session,
1477 but in order to toggle optimization, a restart is required.
1479 See also the variable `org-table-auto-blank-field'."
1488 "Non-nil means cluster self-insert commands for undo when possible.
1489 If this is set, then, like in the Emacs command loop, 20 consecutive
1490 characters will be undone together.
1491 This is configurable, because there is some impact on typing performance."
1496 "Non-nil means TAB will automatically notice a table.el table.
1497 When it sees such a table, it moves point into it and - if necessary -
1498 calls `table-recognize-table'."
1503 "Options concerning links in Org-mode."
1508 "Buffer-local version of `org-link-abbrev-alist', which see.
1513 "Alist of link abbreviations.
1514 The car of each element is a string, to be replaced at the start of a link.
1516 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1518 [[linkkey:tag][description]]
1520 The 'linkkey' must be a word word, starting with a letter, followed
1521 by letters, numbers, '-' or '_'.
1523 If REPLACE is a string, the tag will simply be appended to create the link.
1526 at that point (see the function `url-hexify-string'). If the string contains
1528 be invoked: this function takes the tag as its only argument and must return
1529 a string.
1531 REPLACE may also be a function that will be called with the tag as the
1532 only argument to create the link, which should be returned as a string.
1534 See the manual for examples."
1544 "Non-nil means Org will display descriptive links.
1545 E.g. [[http://orgmode.org][Org website]] will be displayed as
1547 description. When set to `nil', Org will display the full links
1548 literally.
1550 You can interactively set the value of this variable by calling
1551 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1556 "How the path name in file links should be stored.
1557 Valid values are:
1559 relative Relative to the current directory, i.e. the directory of the file
1560 into which the link is being inserted.
1561 absolute Absolute path, if possible with ~ for home directory.
1562 noabbrev Absolute path, no abbreviation of home directory.
1563 adaptive Use relative path for files in the current directory and sub-
1564 directories of it. For other files, use an absolute path."
1573 "Types of links that should be activated in Org-mode files.
1574 This is a list of symbols, each leading to the activation of a certain link
1575 type. In principle, it does not hurt to turn on most link types - there may
1576 be a small gain when turning off unused link types. The types are:
1578 bracket The recommended [[link][description]] or [[link]] links with hiding.
1579 angle Links in angular brackets that may contain whitespace like
1580 <bbdb:Carsten Dominik>.
1581 plain Plain links in normal text, no whitespace, like http://google.com.
1582 radio Text that is matched by a radio target, see manual for details.
1583 tag Tag settings in a headline (link to tag search).
1584 date Time stamps (link to calendar).
1585 footnote Footnote labels.
1587 Changing this variable requires a restart of Emacs to become effective."
1599 "Function to use for generating link descriptions from links.
1600 When nil, the link location will be used. This function must take
1601 two parameters: the first one is the link, the second one is the
1602 description generated by `org-insert-link'. The function should
1603 return the description to use."
1608 "Options concerning storing links in Org-mode."
1613 "When non-nil, hexify URL when creating a link."
1619 "Format of the description part of a link to an email or usenet message.
1620 The following %-escapes will be replaced by corresponding information:
1628 %s subject
1629 %d date
1630 %m message-id.
1632 You may use normal field width specification between the % and the letter.
1633 This is for example useful to limit the length of the subject.
1647 It should match if the message is from the user him/herself."
1652 "Non-nil means file links from `org-store-link' contain context.
1653 A search string will be added to the file name with :: as separator and
1654 used to find the context when the link is activated by the command
1655 `org-open-at-point'. When this option is t, the entire active region
1656 will be placed in the search string of the file link. If set to a
1657 positive integer, only the first n lines of context will be stored.
1660 negates this setting for the duration of the command."
1665 "Non-nil means keep link in list for entire session.
1667 The command `org-store-link' adds a link pointing to the current
1668 location to an internal list. These links accumulate during a session.
1669 The command `org-insert-link' can be used to insert links into any
1670 Org-mode file (offering completion for all stored links). When this
1672 will be removed from the list, to make completing the unused links
1673 more efficient."
1678 "Options concerning following links in Org-mode."
1683 "Function to translate links with different syntax to Org syntax.
1684 This can be used to translate links created for example by the Planner
1685 or emacs-wiki packages to Org syntax.
1686 The function must accept two parameters, a TYPE containing the link
1688 which is everything after the link protocol. It should return a cons
1689 with possibly modified values of type and path.
1690 Org contains a function for this, so if you set this variable to
1691 `org-translate-link-from-planner', you should be able follow many
1692 links created by planner."
1697 "Hook that is run after a link has been followed."
1702 "Non-nil means on links TAB will follow the link.
1703 Needs to be set before org.el is loaded.
1704 This really should not be used, it does not make sense, and the
1705 implementation is bad."
1710 "Non-nil means on links RET will follow the link.
1711 In tables, the special behavior of RET has precedence."
1717 "Non-nil means mouse-1 on a link will follow the link.
1718 A longer mouse click will still set point. Does not work on XEmacs.
1719 Needs to be set before org.el is loaded."
1724 "Number of different positions to be recorded in the ring.
1725 Changing this requires a restart of Emacs to work correctly."
1730 "Non-nil means internal links in Org files must exactly match a headline.
1731 When nil, the link search tries to match a phrase with all words
1732 in the search text."
1739 query-to-create)))
1747 "Setup the frame configuration for following links.
1748 When following a link with Emacs, it may often be useful to display
1749 this link in another window or frame. This variable can be used to
1750 set this up for the different types of links.
1751 For VM, use any of
1752 `vm-visit-folder'
1753 `vm-visit-folder-other-window'
1754 `vm-visit-folder-other-frame'
1755 For Gnus, use any of
1756 `gnus'
1757 `gnus-other-frame'
1758 `org-gnus-no-new-news'
1759 For FILE, use any of
1760 `find-file'
1761 `find-file-other-window'
1762 `find-file-other-frame'
1763 For Wanderlust use any of
1764 `wl'
1765 `wl-other-frame'
1766 For the calendar, use the variable `calendar-setup'.
1767 For BBDB, it is currently only possible to display the matches in
1768 another window."
1797 "Non-nil means use indirect buffer to display infile links.
1798 Activating internal links (from one location in a file to another location
1799 in the same file) normally just jumps to the location. When the link is
1801 is displayed in
1802 another window. When this option is set, the other window actually displays
1803 an indirect buffer clone of the current buffer, to avoid any visibility
1804 changes to the current buffer."
1809 "Non-nil means `org-open-file' will open non-existing files.
1810 When nil, an error will be generated.
1811 This variable applies only to external applications because they
1812 might choke on non-existing files. If the link is to a file that
1813 will be opened in Emacs, the variable is ignored."
1818 "Non-nil means a link to a directory really means to index.org.
1819 When nil, following a directory link will run dired or open a finder/explorer
1820 window on that directory."
1825 "Function and arguments to call for following mailto links.
1826 This is a list with the first element being a Lisp function, and the
1827 remaining elements being arguments to the function. In string arguments,
1828 %a will be replaced by the address, and %s will be replaced by the subject
1829 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1838 "Non-nil means ask for confirmation before executing shell links.
1839 Shell links can be dangerous: just think about a link
1841 [[shell:rm -rf ~/*][Google Search]]
1844 but really it would remove your entire home directory.
1845 Therefore we advise against setting this variable to nil.
1846 Just change it to `y-or-n-p' if you want to confirm with a
1854 'safe-local-variable
1858 "A regexp to skip confirmation for shell links."
1864 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1865 Elisp links can be dangerous: just think about a link
1870 but really it would remove your entire home directory.
1871 Therefore we advise against setting this variable to nil.
1872 Just change it to `y-or-n-p' if you want to confirm with a
1880 'safe-local-variable
1884 "A regexp to skip confirmation for Elisp links."
1893 "Default file applications on a UNIX or GNU/Linux system.
1904 "Default file applications on a MacOS X system.
1906 for some files for which the OS does not have a good default.
1914 'mswindows-shell-execute
1919 'mswindows-shell-execute
1922 "Default file applications on a Windows NT system.
1931 "External applications for opening `file:path' items in a document.
1932 Org-mode uses system defaults for different file types, but
1933 you can use this variable to set the application for a given file
1934 extension. The entries in this list are cons cells where the car identifies
1935 files and the cdr the corresponding command. Possible values for the
1936 file identifier are
1938 ways, depending on its contents:
1940 - Alphanumeric characters only:
1941 Match links with this file extension.
1943 to open PDFs with evince.
1945 - Regular expression: Match links where the
1946 filename matches the regexp. If you want to
1947 use groups here, use shy groups.
1951 to open *.html and *.xhtml with firefox.
1953 - Regular expression which contains (non-shy) groups:
1955 anything after that, matches the regexp.
1956 In a custom command string, %1, %2, etc. are replaced with
1957 the parts of the link that were matched by the groups.
1958 For backwards compatibility, if a command string is given
1959 that does not use any of the group matches, this case is
1960 handled identically to the second one (i.e. match against
1961 file name only).
1962 In a custom lisp form, you can access the group matches with
1963 (match-string n link).
1966 to open [[file:document.pdf::5]] with evince at page 5.
1968 `directory' Matches a directory
1969 `remote' Matches a remote file, accessible through tramp or efs.
1970 Remote files most likely should be visited through Emacs
1971 because external applications cannot handle such paths.
1972 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1973 so all files Emacs knows how to handle. Using this with
1974 command `emacs' will open most files in Emacs. Beware that this
1975 will also open html files inside Emacs, unless you add
1977 t Default for files not matched by any of the other options.
1978 `system' The system command to open files, like `open' on Windows
1979 and Mac OS X, and mailcap under GNU/Linux. This is the command
1980 that will be selected if you call `C-c C-o' with a double
1983 Possible values for the command are:
1984 `emacs' The file will be visited by the current Emacs process.
1985 `default' Use the default application for this file type, which is the
1986 association for t in the list, most likely in the system-specific
1987 part.
1988 This can be used to overrule an unwanted setting in the
1989 system-specific variable.
1991 This command is specified by the entry whose car is `system'.
1992 Most likely, the system-specific version of this variable
1993 does define this command, but you can overrule/replace it
1994 here.
1995 string A command to be executed by a shell; %s will be replaced
1996 by the path to the file.
1997 sexp A Lisp form which will be evaluated. The file path will
1998 be available in the Lisp variable `file'.
1999 For more examples, see the system specific constants
2000 `org-file-apps-defaults-macosx'
2001 `org-file-apps-defaults-windowsnt'
2002 `org-file-apps-defaults-gnu'."
2012 auto-mode))
2021 "The URL of the DOI server."
2027 "Options concerning refiling entries in Org-mode."
2032 "Directory with org files.
2033 This is just a default location to look for Org files. There is no need
2034 at all to put your files into this directory. It is only used in the
2035 following situations:
2037 1. When a capture template specifies a target file that is not an
2038 absolute path. The path will then be interpreted relative to
2039 `org-directory'
2040 2. When a capture note is filed away in an interactive way (when exiting the
2041 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2042 with `org-directory' as the default path."
2049 "Default target for storing notes.
2050 Used as a fall back file for org-remember.el and org-capture.el, for
2051 templates that do not specify a target file."
2057 file))
2060 "The default interface to be used for `org-goto'.
2061 Allowed values are:
2062 outline The interface shows an outline of the relevant file
2063 and the correct heading is found by moving through
2064 the outline or by searching with incremental search.
2065 outline-path-completion Headlines in the current buffer are offered via
2066 completion. This is the interface also used by
2067 the refile command."
2074 "Maximum target level when running `org-goto' with refile interface."
2079 "Non-nil means store new notes at the beginning of a file or entry.
2080 When nil, new notes will be filed to the end of a file or entry.
2081 This can also be a list with cons cells of regular expressions that
2082 are matched against file names, and values."
2093 "Information to record when a task is refiled.
2095 Possible values are:
2097 nil Don't add anything
2098 time Add a time stamp to the task
2099 note Prompt for a note and add it with template `org-log-note-headings'
2101 This option can also be set with on a per-file-basis with
2103 #+STARTUP: nologrefile
2104 #+STARTUP: logrefile
2105 #+STARTUP: lognoterefile
2107 You can have local logging settings for a subtree by setting the LOGGING
2108 property to one or more of these keywords.
2110 When bulk-refiling from the agenda, the value `note' is forbidden and
2111 will temporarily be changed to `time'."
2122 This is a list of cons cells. Each cell contains:
2123 - a specification of the files to be considered, either a list of files,
2124 or a symbol whose function or variable value will be used to retrieve
2125 a file name or a list of file names. If you use `org-agenda-files' for
2126 that, all agenda files will be scanned for targets. Nil means consider
2127 headings in the current buffer.
2128 - A specification of how to find candidate refile targets. This may be
2129 any of:
2131 This tag has to be present in all target headlines, inheritance will
2132 not be considered.
2134 todo keyword.
2136 headlines that are refiling targets.
2137 - a cons cell (:level . N). Any headline of level N is considered a target.
2138 Note that, when `org-odd-levels-only' is set, level corresponds to
2139 order in hierarchy, not to the number of stars.
2140 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2141 Note that, when `org-odd-levels-only' is set, level corresponds to
2142 order in hierarchy, not to the number of stars.
2144 Each element of this list generates a set of possible targets.
2145 The union of these sets is presented (with completion) to
2146 the user by `org-refile'.
2148 You can set the variable `org-refile-target-verify-function' to a function
2149 to verify each headline found by the simple criteria above.
2151 When this variable is nil, all top-level headlines in the current buffer
2152 are used, equivalent to the value `((nil . (:level . 1))'."
2168 "Function to verify if the headline at point should be a refile target.
2169 The function will be called without arguments, with point at the
2170 beginning of the headline. It should return t and leave point
2171 where it is if the headline is a valid target for refiling.
2173 If the target should not be selected, the function must return nil.
2174 In addition to this, it may move point to a place from where the search
2175 should be continued. For example, the function may decide that the entire
2176 subtree of the current entry should be excluded and move point to the end
2177 of the subtree."
2184 "Non-nil means cache refile targets to speed up the process.
2185 The cache for a particular file will be updated automatically when
2186 the buffer has been killed, or when any of the marker used for flagging
2187 refile targets no longer points at a live buffer.
2188 If you have added new entries to a buffer that might themselves be targets,
2189 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2190 find that easier, `C-u C-u C-u C-c C-w'."
2196 "Non-nil means provide refile targets as paths.
2197 So a level 3 headline will be available as level1/level2/level3.
2199 When the value is `file', also include the file name (without directory)
2200 into the path. In this case, you can also stop the completion after
2201 the file name, to get entries inserted as top level in the file.
2203 When `full-file-path', include the full file path."
2212 "Non-nil means complete the outline path in hierarchical steps.
2213 When Org-mode uses the refile interface to select an outline path
2214 \(see variable `org-refile-use-outline-path'), the completion of
2215 the path can be done is a single go, or if can be done in steps down
2216 the headline hierarchy. Going in steps is probably the best if you
2217 do not use a special completion package like `ido' or `icicles'.
2218 However, when using these packages, going in one step can be very
2219 fast, while still showing the whole path to the entry."
2224 "Non-nil means allow to create new nodes as refile targets.
2226 of an existing node. When the value of this variable is `confirm',
2227 new node creation must be confirmed by the user (recommended)
2228 When nil, the completion must match an existing entry.
2230 Note that, if the new heading is not seen by the criteria
2231 listed in `org-refile-targets', multiple instances of the same
2232 heading would be created by trying again to file under the new
2233 heading."
2241 "Non-nil means also refile active region within a subtree.
2243 By default `org-refile' doesn't allow refiling regions if they
2244 don't contain a set of subtrees, but it might be convenient to
2245 do so sometimes: in that case, the first line of the region is
2246 converted to a headline before refiling."
2252 "Options concerning TODO items in Org-mode."
2257 "Options concerning Progress logging in Org-mode."
2264 "The available interpretation symbols for customizing `org-todo-keywords'.
2268 "List of TODO entry keyword sequences and their interpretation.
2271 Each sequence starts with a symbol, either `sequence' or `type',
2272 indicating if the keywords should be interpreted as a sequence of
2273 action steps, or as different types of TODO items. The first
2274 keywords are states requiring action - these states will select a headline
2275 for inclusion into the global TODO list Org-mode produces. If one of
2278 the last keyword is treated as the only DONE state of the sequence.
2281 additional state where no keyword is present. For details about this
2282 cycling, see the manual.
2284 TODO keywords and interpretation can also be set on a per-file basis with
2285 the special #+SEQ_TODO and #+TYP_TODO lines.
2287 Each keyword can optionally specify a character for fast state selection
2288 \(in combination with the variable `org-use-fast-todo-selection')
2289 and specifiers for state change logging, using the same syntax that
2292 indicates to record a time stamp each time this state is selected.
2294 Each keyword may also specify if a timestamp or a note should be
2295 recorded when entering or leaving the state, by adding additional
2296 characters in the parenthesis after the keyword. This looks like this:
2298 record only the time of the state change. With X and Y being either
2300 Y when leaving the state if and only if the *target* state does not
2301 define X. You may omit any of the fast-selection key or X or /Y,
2302 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2304 For backward compatibility, this variable may also be just a list
2305 of keywords. In this case the interpretation (sequence or type) will be
2306 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2316 ;;Quick and dirty way to see
2317 ;;`org-todo-interpretations'. This takes the
2318 ;;place of item arguments
2319 :convert-widget
2326 org-todo-interpretation-widgets))
2327 widget))
2362 "Controls how TODO keywords are interpreted.
2363 This variable is in principle obsolete and is only used for
2364 backward compatibility, if the interpretation of todo keywords is
2365 not given already in `org-todo-keywords'. See that variable for
2366 more information."
2373 "Non-nil means use the fast todo selection scheme with C-c C-t.
2374 This variable describes if and under what circumstances the cycling
2375 mechanism for TODO keywords will be replaced by a single-key, direct
2376 selection scheme.
2378 When nil, fast selection is never used.
2380 When the symbol `prefix', it will be used when `org-todo' is called
2381 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2382 `C-u t' in an agenda buffer.
2384 When t, fast selection is used by default. In this case, the prefix
2385 argument forces cycling instead.
2387 In all cases, the special interface is only used if access keys have
2388 actually been assigned by the user, i.e. if keywords in the configuration
2389 are followed by a letter in parenthesis, like TODO(t)."
2397 "Non-nil means update todo statistics after insert and toggle.
2398 ALL-HEADLINES means update todo statistics by including headlines
2399 with no TODO keyword as well, counting them as not done.
2400 A list of TODO keywords means the same, but skip keywords that are
2401 not in this list.
2403 When this is set, todo statistics is updated in the parent of the
2404 current entry each time a todo state is changed."
2414 "Non-nil means TODO statistics covers just direct children.
2415 When nil, all entries in the subtree are considered.
2416 This has only an effect if `org-provide-todo-statistics' is set.
2417 To set this to nil for only a single subtree, use a COOKIE_DATA
2423 "Hook which is run after the state of a TODO item was changed.
2424 The new state (a string with a TODO keyword, or nil) is available in the
2425 Lisp variable `org-state'."
2430 "Hook for functions that are allowed to block a state change.
2432 Functions in this hook should not modify the buffer.
2433 Each function gets as its single argument a property list,
2434 see `org-trigger-hook' for more information about this list.
2436 If any of the functions in this hook returns nil, the state change
2440 "Hook for functions that are triggered by a state change.
2442 Each function gets as its single argument a property list with at
2443 least the following elements:
2445 (:type type-of-change :position pos-at-entry-start
2446 :from old-state :to new-state)
2448 Depending on the type, more properties may be present.
2450 This mechanism is currently implemented for:
2452 TODO state changes
2453 ------------------
2454 :type todo-state-change
2455 :from previous state (keyword as a string), or nil, or a symbol
2456 'todo' or 'done', to indicate the general type of state.
2460 "Non-nil means undone TODO entries will block switching the parent to DONE.
2461 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2462 be blocked if any prior sibling is not yet done.
2463 Finally, if the parent is blocked because of ordered siblings of its own,
2464 the child will also be blocked."
2476 "Non-nil means unchecked boxes will block switching the parent to DONE.
2477 When this is nil, checkboxes have no influence on switching TODO states.
2478 When non-nil, you first need to check off all check boxes before the TODO
2479 entry can be switched to DONE.
2480 This variable needs to be set before org.el is loaded, and you need to
2481 restart Emacs after a change to make the change effective. The only way
2482 to change is while Emacs is running is through the customize interface."
2494 "Non-nil means inserting a TODO heading is treated as state change.
2496 logging will apply if appropriate. When nil, the new TODO item will
2497 be inserted directly, and no logging will take place."
2502 "Non-nil means switching TODO states with S-cursor counts as state change.
2503 This is the default behavior. However, setting this to nil allows a
2504 convenient way to select a TODO state and bypass any logging associated
2505 with that."
2510 "Tag changes that should be triggered by TODO state changes.
2511 This is a list. Each entry is
2513 (state-change (tag . flag) .......)
2515 State-change can be a string with a state, and empty string to indicate the
2516 state that has no TODO keyword, or it can be one of the symbols `todo'
2517 or `done', meaning any not-done or done state, respectively."
2531 "Information to record when a task moves to the DONE state.
2533 Possible values are:
2535 nil Don't add anything, just change the keyword
2536 time Add a time stamp to the task
2537 note Prompt for a note and add it with template `org-log-note-headings'
2539 This option can also be set with on a per-file-basis with
2541 #+STARTUP: nologdone
2542 #+STARTUP: logdone
2543 #+STARTUP: lognotedone
2545 You can have local logging settings for a subtree by setting the LOGGING
2546 property to one or more of these keywords."
2554 ;; Normalize old uses of org-log-done.
2561 "Information to record when the scheduling date of a tasks is modified.
2563 Possible values are:
2565 nil Don't add anything, just change the date
2566 time Add a time stamp to the task
2567 note Prompt for a note and add it with template `org-log-note-headings'
2569 This option can also be set with on a per-file-basis with
2571 #+STARTUP: nologreschedule
2572 #+STARTUP: logreschedule
2573 #+STARTUP: lognotereschedule"
2582 "Information to record when the deadline date of a tasks is modified.
2584 Possible values are:
2586 nil Don't add anything, just change the date
2587 time Add a time stamp to the task
2588 note Prompt for a note and add it with template `org-log-note-headings'
2590 This option can also be set with on a per-file-basis with
2592 #+STARTUP: nologredeadline
2593 #+STARTUP: logredeadline
2594 #+STARTUP: lognoteredeadline
2596 You can have local logging settings for a subtree by setting the LOGGING
2597 property to one or more of these keywords."
2606 "Non-nil means record a note when clocking out of an item.
2607 This can also be configured on a per-file basis by adding one of
2608 the following lines anywhere in the buffer:
2610 #+STARTUP: lognoteclock-out
2611 #+STARTUP: nolognoteclock-out"
2617 "Non-nil means the CLOSED time stamp will contain date and time.
2618 When nil, only the date will be recorded."
2632 "Headings for notes added to entries.
2633 The value is an alist, with the car being a symbol indicating the note
2634 context, and the cdr is the heading to be used. The heading may also be the
2635 empty string.
2636 %t in the heading will be replaced by a time stamp.
2637 %T will be an active time stamp instead the default inactive one
2638 %d will be replaced by a short-format time stamp.
2639 %D will be replaced by an active short-format time stamp.
2640 %s will be replaced by the new TODO state, in double quotes.
2641 %S will be replaced by the old TODO state, in double quotes.
2642 %u will be replaced by the user name.
2643 %U will be replaced by the full user name.
2645 In fact, it is not a good idea to change the `state' entry, because
2646 agenda log mode depends on the format of these entries."
2652 "Heading when changing todo state (todo sequence only)"
2666 "Non-nil means insert state change notes and time stamps into a drawer.
2667 When nil, state changes notes will be inserted after the headline and
2668 any scheduling and clock lines, but not inside a drawer.
2670 The value of this variable should be the name of the drawer to use.
2671 LOGBOOK is proposed as the default drawer for this purpose, you can
2672 also set this to a string to define the drawer of your choice.
2676 A value of t or nil can also be set with on a per-file-basis with
2678 #+STARTUP: logdrawer
2679 #+STARTUP: nologdrawer
2681 If this variable is set, `org-log-state-notes-insert-after-drawers'
2682 will be ignored.
2684 You can set the property LOG_INTO_DRAWER to overrule this setting for
2685 a subtree."
2696 "Return the value of `org-log-into-drawer', but let properties overrule.
2697 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2698 used instead of the default value."
2707 "Non-nil means insert state change notes after any drawers in entry.
2708 Only the drawers that *immediately* follow the headline and the
2709 deadline/scheduled line are skipped.
2710 When nil, insert notes right after the heading and perhaps the line
2711 with deadline/scheduling if present.
2713 This variable will have no effect if `org-log-into-drawer' is
2714 set."
2720 "Non-nil means the latest state note will be directly after heading.
2721 When nil, the state change notes will be ordered according to time.
2723 This option can also be set with on a per-file-basis with
2725 #+STARTUP: logstatesreversed
2726 #+STARTUP: nologstatesreversed"
2732 "The TODO state to which a repeater should return the repeating task.
2733 By default this is the first task in a TODO sequence, or the previous state
2734 in a TODO_TYP set. But you can specify another task here.
2735 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2742 "Non-nil means record moving through the DONE state when triggering repeat.
2743 An auto-repeating task is immediately switched back to TODO when
2746 record a closing note, there will be no record of the task moving
2747 through DONE. This variable forces taking a note anyway.
2749 nil Don't force a record
2750 time Record a time stamp
2751 note Prompt for a note and add it with template `org-log-note-headings'
2753 This option can also be set with on a per-file-basis with
2755 #+STARTUP: nologrepeat
2756 #+STARTUP: logrepeat
2757 #+STARTUP: lognoterepeat
2759 You can have local logging settings for a subtree by setting the LOGGING
2760 property to one or more of these keywords."
2770 "Priorities in Org-mode."
2775 "Non-nil means priority commands are active.
2776 When nil, these commands will be disabled, so that you never accidentally
2777 set a priority."
2782 "The highest priority of TODO items. A character like ?A, ?B etc.
2783 Must have a smaller ASCII number than `org-lowest-priority'."
2788 "The lowest priority of TODO items. A character like ?A, ?B etc.
2789 Must have a larger ASCII number than `org-highest-priority'."
2794 "The default priority of TODO items.
2795 This is the priority an item gets if no explicit priority is given.
2796 When starting to cycle on an empty priority the first step in the cycle
2797 depends on `org-priority-start-cycle-with-default'. The resulting first
2798 step priority must not exceed the range from `org-highest-priority' to
2799 `org-lowest-priority' which means that `org-default-priority' has to be
2800 in this range exclusive or inclusive the range boundaries. Else the
2801 first step refuses to set the default and the second will fall back
2802 to (depending on the command used) the highest or lowest priority."
2807 "Non-nil means start with default priority when starting to cycle.
2808 When this is nil, the first step in the cycle will be (depending on the
2809 command used) one higher or lower than the default priority.
2810 See also `org-default-priority'."
2815 "Function to extract the priority from a string.
2816 The string is normally the headline. If this is nil Org computes the
2817 priority from the priority cookie like [#A] in the headline. It returns
2818 an integer, increasing by 1000 for each priority level.
2819 The user can set a different function here, which should take a string
2820 as an argument and return the numeric priority."
2828 "Options concerning time stamps and deadlines in Org-mode."
2833 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2834 When nil, these labeled time stamps are forces into the second line of an
2835 entry, just after the headline. When scheduling from the global TODO list,
2836 the time stamp will always be forced into the second line."
2841 "Formats for `format-time-string' which are used for time stamps.
2845 "Number of minutes to round time stamps to.
2846 These are two values, the first applies when first creating a time stamp.
2847 The second applies when changing it with the commands `S-up' and `S-down'.
2848 When changing the time stamp, this means that it will change in steps
2849 of N minutes, as given by the second value.
2851 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2852 numbers should be factors of 60, so for example 5, 10, 15.
2854 When this is larger than 1, you can still force an exact time stamp by using
2855 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2856 and by using a prefix arg to `S-up/down' to specify the exact number
2857 of minutes to shift."
2867 ;; Normalize old customizations of this variable.
2871 org-time-stamp-rounding-minutes)))
2874 "Non-nil means overlay custom formats over all time stamps.
2875 The formats are defined through the variable `org-time-stamp-custom-formats'.
2876 To turn this on on a per-file basis, insert anywhere in the file:
2877 #+STARTUP: customtime"
2885 "Custom formats for time stamps. See `format-time-string' for the syntax.
2886 These are overlaid over the default ISO format if the variable
2887 `org-display-custom-times' is set. Time like %H:%M should be at the
2888 end of the second format. The custom formats are also honored by export
2889 commands, if custom time display is turned on at the time of export."
2894 "Get the right format for a time string."
2899 f)))
2903 "The format string used when creating CLOCKSUM lines.
2904 This is also used when Org mode generates a time duration.
2906 The value can be a single format string containing two
2907 %-sequences, which will be filled with the number of hours and
2908 minutes in that order.
2910 Alternatively, the value can be a plist associating any of the
2911 keys :years, :months, :weeks, :days, :hours or :minutes with
2912 format strings. The time duration is formatted using only the
2913 time components that are needed and concatenating the results.
2914 If a time unit in absent, it falls back to the next smallest
2915 unit.
2917 The keys :require-years, :require-months, :require-days,
2918 :require-weeks, :require-hours, :require-minutes are also
2919 meaningful. A non-nil value for these keys indicates that the
2920 corresponding time component should always be included, even if
2921 its value is 0.
2924 For example,
2927 :require-minutes t)
2929 means durations longer than a day will be expressed in days,
2930 hours and minutes, and durations less than a day will always be
2931 expressed in hours and minutes (even for durations less than an
2932 hour).
2934 The value
2938 means durations longer than a day will be expressed in days and
2939 minutes, and durations less than a day will be expressed entirely
2940 in minutes (even for durations longer than an hour)."
2980 See `org-time-clocksum-format' for more on time clock formats."
2988 E.g. by default, one day is considered to be a 8 hours effort,
2989 so a task that has been clocked for 16 hours will be displayed
2990 as during 2 days in the clock display or in the clocktable.
2992 See `org-effort-durations' on how to set effort durations
2993 and `org-time-clocksum-format' for more on time clock formats."
3001 "The format string used when creating CLOCKSUM lines,
3002 or when Org mode generates a time duration, if
3003 `org-time-clocksum-use-fractional' is enabled.
3005 The value can be a single format string containing one
3006 %-sequence, which will be filled with the number of hours as
3007 a float.
3009 Alternatively, the value can be a plist associating any of the
3010 keys :years, :months, :weeks, :days, :hours or :minutes with
3011 a format string. The time duration is formatted using the
3012 largest time unit which gives a non-zero integer part. If all
3013 specified formats have zero integer part, the smallest time unit
3014 is used."
3031 "Number of days before expiration during which a deadline becomes active.
3032 This variable governs the display in sparse trees and in the agenda.
3033 When 0 or negative, it means use this number (the absolute value of it)
3034 even if a deadline has a different individual lead time specified.
3036 Custom commands can set this variable in the options section."
3042 "Number of days before a scheduled item becomes active.
3043 This variable governs the display in sparse trees and in the agenda.
3044 The default value (i.e. 0) means: don't delay scheduled item.
3045 When negative, it means use this number (the absolute value of it)
3046 even if a scheduled item has a different individual delay time
3047 specified.
3049 Custom commands can set this variable in the options section."
3057 "Non-nil means assume future for incomplete date input from user.
3058 This affects the following situations:
3059 1. The user gives a month but not a year.
3062 2. The user gives a day, but no month.
3065 it will be considered as *this* month.
3067 If you set this variable to the symbol `time', then also the following
3068 will work:
3070 3. If the user gives a time.
3071 If the time is before now, it will be interpreted as tomorrow.
3073 Currently none of this works for ISO week specifications.
3075 When this option is nil, the current day, month and year will always be
3076 used as defaults.
3078 See also `org-agenda-jump-prefer-future'."
3086 "Should the agenda jump command prefer the future for incomplete dates?
3087 The default is to do the same as configured in `org-read-date-prefer-future'.
3088 But you can also set a deviating value here.
3089 This may t or nil, or the symbol `org-read-date-prefer-future'."
3095 org-read-date-prefer-future)
3100 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3102 Depending on the system Emacs is running on, certain dates cannot
3103 be represented with the type used internally to represent time.
3104 Dates between 1970-1-1 and 2038-1-1 can always be represented
3105 correctly. Some systems allow for earlier dates, some for later,
3106 some for both. One way to find out it to insert any date into an
3107 Org buffer, putting the cursor on the year and hitting S-up and
3108 S-down to test the range.
3110 When this variable is set to t, the date/time prompt will not let
3111 you specify dates outside the 1970-2037 range, so it is certain that
3112 these dates will work in whatever version of Emacs you are
3113 running, and also that you can move a file from one Emacs implementation
3114 to another. WHenever Org is forcing the year for you, it will display
3115 a message and beep.
3117 When this variable is nil, Org will check if the date is
3118 representable in the specific Emacs implementation you are using.
3119 If not, it will force a year, usually the current year, and beep
3120 to remind you. Currently this setting is not recommended because
3121 the likelihood that you will open your Org files in an Emacs that
3122 has limited date range is not negligible.
3124 A workaround for this problem is to use diary sexp dates for time
3125 stamps outside of this range."
3131 "Non-nil means display current interpretation of date prompt live.
3132 This display will be in an overlay, in the minibuffer."
3137 "Non-nil means pop up a calendar when prompting for a date.
3138 In the calendar, the date can be selected with mouse-1. However, the
3139 minibuffer will also be active, and you can simply enter the date as well.
3140 When nil, only the minibuffer will be available."
3147 'org-read-date-minibuffer-setup-hook
3150 "Hook to be used to set up keys for the date/time interface.
3151 Add key definitions to `minibuffer-local-map', which will be a
3152 temporary copy.
3154 WARNING: This option is obsolete, you should use
3155 `org-read-date-minibuffer-local-map' to set up keys."
3160 "The hour when your day really ends. Must be an integer.
3161 This has influence for the following applications:
3163 the time given here, the day recognized as TODAY is actually yesterday.
3164 - When a date is read from the user and it is still before the time given
3165 here, the current date and time will be assumed to be yesterday, 23:59.
3166 Also, timestamps inserted in capture templates follow this rule.
3168 IMPORTANT: This is a feature whose implementation is and likely will
3169 remain incomplete. Really, it is only here because past midnight seems to
3170 be the favorite working time of John Wiegley :-)"
3175 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3176 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3178 23:59 of the previous day."
3184 "When non-nil, use the last clock out time for `org-todo'.
3185 Note that this option has precedence over the combined use of
3186 `org-use-effective-time' and `org-extend-today-until'."
3193 "Non-nil means S-down will increase the time in a time stamp.
3194 When nil, S-up will increase."
3199 "Non-nil means make the calendar window follow timestamp changes.
3200 When a timestamp is modified and the calendar window is visible, it will be
3201 moved to the new date."
3206 "Options concerning tags in Org-mode."
3211 "List of tags allowed in Org-mode files.
3212 When this list is nil, Org-mode will base TAG input on what is already in the
3213 buffer.
3214 The value of this variable is an alist, the car of each entry must be a
3215 keyword as a string, the cdr may be a character that is used to select
3216 that tag through the fast-tag-selection interface.
3217 See the manual for details."
3234 "List of tags that will always appear in all Org-mode files.
3235 This is in addition to any in buffer settings or customizations
3236 of `org-tag-alist'.
3237 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3238 The value of this variable is an alist, the car of each entry must be a
3239 keyword as a string, the cdr may be a character that is used to select
3240 that tag through the fast-tag-selection interface.
3241 See the manual for details.
3242 To disable these tags on a per-file basis, insert anywhere in the file:
3243 #+STARTUP: noptag"
3255 "If non-nil, always offer completion for all tags of all agenda files.
3256 Instead of customizing this variable directly, you might want to
3257 set it locally for capture buffers, because there no list of
3258 tags in that file can be created dynamically (there are none).
3260 (add-hook 'org-capture-mode-hook
3261 (lambda ()
3262 (set (make-local-variable
3263 'org-complete-tags-always-offer-all-agenda-tags)
3264 t)))"
3270 "List of tags that can be inherited by all entries in the file.
3271 The tags will be inherited if the variable `org-use-tag-inheritance'
3272 says they should be.
3276 "Non-nil means use fast tag selection scheme.
3277 This is a special interface to select and deselect tags with single keys.
3278 When nil, fast selection is never used.
3279 When the symbol `auto', fast selection is used if and only if selection
3280 characters for tags have been configured, either through the variable
3281 `org-tag-alist' or through a #+TAGS line in the buffer.
3282 When t, fast selection is always used and selection keys are assigned
3283 automatically if necessary."
3291 "Non-nil means fast tag selection exits after first change.
3292 When nil, you have to press RET to exit it.
3293 During fast tag selection, you can toggle this flag with `C-c'.
3294 This variable can also have the value `expert'. In this case, the window
3295 displaying the tags menu is not even shown, until you press C-c again."
3303 "Non-nil means fast tags selection interface will also offer TODO states.
3307 "The column to which tags should be indented in a headline.
3308 If this number is positive, it specifies the column. If it is negative,
3309 it means that the tags should be flushright to that column. For example,
3310 -80 works well for a normal 80 character screen.
3311 When 0, place tags directly after headline text, with only one space in
3312 between."
3317 "Non-nil keeps tags aligned when modifying headlines.
3318 Some operations (i.e. demoting) change the length of a headline and
3319 therefore shift the tags around. With this option turned on, after
3320 each such operation the tags are again aligned to `org-tags-column'."
3325 "Non-nil means tags in levels apply also for sublevels.
3326 When nil, only the tags directly given in a specific line apply there.
3327 This may also be a list of tags that should be inherited, or a regexp that
3328 matches tags that should be inherited. Additional control is possible
3329 with the variable `org-tags-exclude-from-inheritance' which gives an
3330 explicit list of tags to be excluded from inheritance, even if the value of
3331 `org-use-tag-inheritance' would select it for inheritance.
3333 If this option is t, a match early-on in a tree can lead to a large
3334 number of matches in the subtree when constructing the agenda or creating
3335 a sparse tree. If you only want to see the first match in a tree during
3336 a search, check out the variable `org-tags-match-list-sublevels'."
3345 "List of tags that should never be inherited.
3346 This is a way to exclude a few tags from inheritance. For way to do
3347 the opposite, to actively allow inheritance for selected tags,
3348 see the variable `org-use-tag-inheritance'."
3353 "Check if TAG is one that should be inherited."
3365 "Non-nil means list also sublevels of headlines matching a search.
3366 This variable applies to tags/property searches, and also to stuck
3367 projects because this search is based on a tags match as well.
3369 When set to the symbol `indented', sublevels are indented with
3370 leading dots.
3372 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3373 the sublevels of a headline matching a tag search often also match
3374 the same search. Listing all of them can create very long lists.
3375 Setting this variable to nil causes subtrees of a match to be skipped.
3377 This variable is semi-obsolete and probably should always be true. It
3378 is better to limit inheritance to certain tags using the variables
3379 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3387 "When set, tags are sorted using this function as a comparator."
3403 "Options concerning properties in Org-mode."
3408 "How property key/value pairs should be formatted by `indent-line'.
3409 When `indent-line' hits a property definition, it will format the line
3410 according to this format, mainly to make sure that the values are
3411 lined-up with respect to each other."
3416 "Alist of properties and functions to adjust inserted values.
3417 Elements of this alist must be of the form
3419 ([string] [function])
3421 where [string] must be a property name and [function] must be a
3422 lambda expression: this lambda expression must take one argument,
3423 the value to adjust, and return the new value as a string.
3427 and the clock summary:
3430 (let ((clocksum (org-clock-sum-current-item))
3431 (effort (org-duration-string-to-minutes
3433 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3440 "Non-nil means properties apply also for sublevels.
3442 This setting is chiefly used during property searches. Turning it on can
3443 cause significant overhead when doing a search, which is why it is not
3444 on by default.
3446 When nil, only the properties directly given in the current entry count.
3447 When t, every property is inherited. The value may also be a list of
3448 properties that should have inheritance, or a regular expression matching
3449 properties that should be inherited.
3451 However, note that some special properties use inheritance under special
3452 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3454 for valid values of a property.
3456 Note for programmers:
3457 When querying an entry with `org-entry-get', you can control if inheritance
3458 should be used. By default, `org-entry-get' looks only at the local
3459 properties. You can request inheritance by setting the inherit argument
3460 to t (to force inheritance) or to `selective' (to respect the setting
3461 in this variable)."
3470 "Check if PROPERTY is one that should be inherited."
3481 "The default column format, if no other format has been defined.
3482 This variable can be set on the per-file basis by inserting a line
3484 #+COLUMNS: %25ITEM ....."
3489 "The ellipses to be used when a field in column view is truncated.
3490 When this is the empty string, as many characters as possible are shown,
3491 but then there will be no visual indication that the field has been truncated.
3492 When this is a string of length N, the last N characters of a truncated
3493 field are replaced by this string. If the column is narrower than the
3494 ellipses string, only part of the ellipses string will be shown."
3499 "Function that modifies values for display in column view.
3500 For example, it can be used to cut out a certain part from a time stamp.
3501 The function must take 2 arguments:
3503 column-title The title of the column (*not* the property name)
3504 value The value that should be modified.
3506 The function should return the value that should be displayed,
3507 or nil if the normal value should be used."
3512 "The property that is being used to keep track of effort estimates.
3513 Effort estimates given in this property need to have the format H:MM."
3521 "List of property/value pairs that can be inherited by any entry.
3523 These are fixed values, for the preset properties. The user variable
3524 that can be used to add to this list is `org-global-properties'.
3526 The entries in this list are cons cells where the car is a property
3527 name and cdr is a string with the value. If the value represents
3532 "List of property/value pairs that can be inherited by any entry.
3534 This list will be combined with the constant `org-global-properties-fixed'.
3536 The entries in this list are cons cells where the car is a property
3537 name and cdr is a string with the value.
3539 You can set buffer-local values for the same purpose in the variable
3540 `org-file-properties' this by adding lines like
3542 #+PROPERTY: NAME VALUE"
3549 "List of property/value pairs that can be inherited by any entry.
3550 Valid for the current buffer.
3555 "Options concerning agenda views in Org-mode."
3560 "Variable used by org files to set a category for agenda display.
3561 Such files should use a file variable to set it, for example
3565 or contain a special line
3567 #+CATEGORY: ELisp
3569 If the file does not specify a category, then file's base name
3575 "The files to be used for agenda display.
3579 If an entry is a directory, all files in that directory that are matched by
3580 `org-agenda-file-regexp' will be part of the file list.
3582 If the value of the variable is not a list but a single file name, then
3583 the list of agenda files is actually stored and maintained in that file, one
3584 agenda file per line. In this file paths can be given relative to
3585 `org-directory'. Tilde expansion and environment variable substitution
3586 are also made."
3593 "Regular expression to match files for `org-agenda-files'.
3594 If any element in the list in that variable contains a directory instead
3595 of a normal file, all files in that directory that are matched by this
3596 regular expression will be included."
3601 "List of extra files to be searched by text search commands.
3602 These files will be searched in addition to the agenda files by the
3603 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3604 Note that these files will only be searched for text search commands,
3605 not for the other agenda views like todo lists, tag searches or the weekly
3606 agenda. This variable is intended to list notes and possibly archive files
3607 that should also be searched by these two commands.
3608 In fact, if the first element in the list is the symbol `agenda-archives',
3609 then all archive files of all agenda files will be added to the search
3610 scope."
3620 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3621 A nil value means to remove them, after a query, from the list."
3626 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3627 The command `org-calendar-goto-agenda' will be bound to this key. The
3628 default is the character `c' because then `c' can be used to switch back and
3629 forth between agenda and calendar."
3634 "The key to be installed in `calendar-mode-map' for adding diary entries.
3635 This option is irrelevant until `org-agenda-diary-file' has been configured
3636 to point to an Org-mode file. When that is the case, the command
3637 `org-agenda-diary-entry' will be bound to the key given here, by default
3638 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3639 if you want to continue doing this, you need to change this to a different
3640 key."
3645 "File to which to add new entries with the `i' key in agenda and calendar.
3646 When this is the symbol `diary-file', the functionality in the Emacs
3647 calendar will be used to add entries to the `diary-file'. But when this
3648 points to a file, `org-agenda-diary-entry' will be used instead."
3662 org-calendar-insert-diary-entry-key
3666 "Options for embedding LaTeX code into Org-mode."
3674 "Options for creating images from LaTeX fragments.
3675 This is a property list with the following properties:
3677 `default' means use the foreground of the default face.
3678 `auto' means use the foreground from the text face.
3680 `default' means use the background of the default face.
3681 `auto' means use the background from the text face.
3682 :scale a scaling factor for the size of the images, to get more pixels
3683 :html-foreground, :html-background, :html-scale
3684 the same numbers for HTML export.
3685 :matchers a list indicating which matchers should be used to
3686 find LaTeX fragments. Valid members of this list are:
3697 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3698 When nil, just push out a message."
3705 Use this to specify additional executable file say a jar file.
3707 When using MathToWeb as the converter, specify the full-path to
3708 your mathtoweb.jar file."
3716 "Command to convert LaTeX fragments to MathML.
3717 Replace format-specifiers in the command as noted below and use
3718 `shell-command' to convert LaTeX to MathML.
3719 %j: Executable file in fully expanded form as specified by
3720 `org-latex-to-mathml-jar-file'.
3721 %I: Input LaTeX file in fully expanded form
3722 %o: Output MathML file
3723 This command is used by `org-create-math-formula'.
3725 When using MathToWeb as the converter, set this to
3734 "Program to convert LaTeX fragments with.
3736 dvipng Process the LaTeX fragments to dvi file, then convert
3737 dvi files to png files using dvipng.
3738 This will also include processing of non-math environments.
3739 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3740 to convert pdf files to png files"
3748 "Path to store latex preview images.
3749 A relative path here creates many directories relative to the
3750 processed org files paths. An absolute path puts all preview
3751 images at the same place."
3757 "Return t if `org-latex-to-mathml-convert-command' is usable."
3760 org-latex-to-mathml-convert-command)
3762 org-latex-to-mathml-convert-command))))
3767 t))))))
3771 \[PACKAGES]
3772 \[DEFAULT-PACKAGES]
3774 % The settings below are copied from fullpage.sty
3787 "The document header used for processing LaTeX fragments.
3788 It is imperative that this header make sure that no page number
3789 appears on the page. The package defined in the variables
3790 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3792 header, or they will be appended."
3797 "Set the packages alist and make sure it has 3 elements per entry."
3801 x))
3802 val)))
3805 "Get the packages alist and make sure it has 3 elements per entry."
3809 x))
3829 "Alist of default packages to be inserted in the header.
3831 Change this only if one of the packages here causes an
3832 incompatibility with another package you are using.
3834 The packages in this list are needed by one part or another of
3835 Org mode to function properly:
3837 - inputenc, fontenc: for basic font and character selection
3838 - fixltx2e: Important patches of LaTeX itself
3839 - graphicx: for including images
3840 - longtable: For multipage tables
3841 - float, wrapfig: for figure placement
3842 - rotating: for sideways figures and tables
3843 - ulem: for underline and strike-through
3844 - amsmath: for subscript and superscript and math environments
3845 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
3846 for interpreting the entities in `org-entities'. You can skip
3847 some of these packages if you don't use any of their symbols.
3848 - hyperref: for cross references
3850 Therefore you should not modify this variable unless you know
3851 what you are doing. The one reason to change it anyway is that
3852 you might be loading some other package that conflicts with one
3853 of the default packages. Each cell is of the format
3855 the package also needs to be included when compiling LaTeX
3856 snippets into images for inclusion into non-LaTeX output."
3871 "Alist of packages to be inserted in every LaTeX header.
3873 These will be inserted after `org-latex-default-packages-alist'.
3874 Each cell is of the format:
3878 SNIPPET-FLAG, when t, indicates that this package is also needed
3879 when turning LaTeX snippets into images for inclusion into
3880 non-LaTeX output.
3882 Make sure that you only list packages here which:
3884 - you want in every file
3885 - do not conflict with the setup in `org-format-latex-header'.
3886 - do not conflict with the default packages in
3887 `org-latex-default-packages-alist'."
3901 "Settings for Org-mode appearance."
3906 "Non-nil means fontify only the stars in each headline.
3907 When nil, the entire headline is fontified.
3908 Changing it requires restart of `font-lock-mode' to become effective
3909 also in regions already fontified."
3914 "Non-nil means hide the first N-1 stars in a headline.
3915 This works by using the face `org-hide' for these stars. This
3916 face is white for a light background, and black for a dark
3917 background. You may have to customize the face `org-hide' to
3918 make this work.
3919 Changing it requires restart of `font-lock-mode' to become effective
3920 also in regions already fontified.
3921 You may also set this on a per-file basis by adding one of the following
3922 lines to the buffer:
3924 #+STARTUP: hidestars
3925 #+STARTUP: showstars"
3930 "List of symbols corresponding to keywords to be hidden the org buffer.
3931 For example, a value '(title) for this list will make the document's title
3932 appear in the buffer without the initial #+TITLE: keyword."
3941 "List of properties (as strings) with a special meaning.
3942 The default use of these custom properties is to let the user
3943 hide them with `org-toggle-custom-properties-visibility'."
3950 "Non-nil means change the face of a headline if it is marked DONE.
3951 Normally, only the TODO/DONE keyword indicates the state of a headline.
3952 When this is non-nil, the headline after the keyword is set to the
3953 `org-headline-done' as an additional indication."
3958 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3959 Changing this variable requires a restart of Emacs to take effect."
3964 "Non-nil means fontify the whole line for headings.
3965 This is useful when setting a background color for the
3966 org-level-* faces."
3971 "Non-nil means highlight LaTeX related syntax in the buffer.
3972 When non nil, the value should be a list containing any of the
3973 following symbols:
3974 `latex' Highlight LaTeX snippets and environments.
3975 `script' Highlight subscript and superscript.
3976 `entities' Highlight entities."
3988 "Non-nil mean font-lock should hide the emphasis marker characters."
3993 "Non-nil means show entities as UTF8 characters.
4000 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4006 "Regular expression for matching emphasis.
4007 After a match, the match groups contain these elements:
4008 0 The match of the full regular expression, including the characters
4009 before and after the proper match
4010 1 The character before the proper match, or empty at beginning of line
4011 2 The proper match, including the leading and trailing markers
4012 3 The leading marker like * or /, indicating the type of highlighting
4013 4 The text between the emphasis markers, not including the markers
4020 "Set variable and compute the emphasis regular expression."
4024 org-emphasis-alist org-emphasis-regexp-components)
4036 ;; make sure special characters appear at the right position in the class
4048 ;; Make the regexp
4056 body1
4068 body1
4074 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4075 ;; set this option proved cumbersome. See this message/thread:
4076 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4079 "Components used to build the regular expression for emphasis.
4080 This is a list with five entries. Terminology: In an emphasis string
4084 specify what is allowed/forbidden in each part:
4086 pre Chars allowed as prematch. Beginning of line will be allowed too.
4087 post Chars allowed as postmatch. End of line will be allowed too.
4088 border The chars *forbidden* as border characters.
4090 non-shy groups here, and don't allow newline here.
4091 newline The maximum number of newlines allowed in an emphasis exp.
4102 "Alist of characters and faces to emphasize text.
4103 Text starting and ending with a special character will be emphasized,
4104 for example *bold*, _underlined_ and /italic/. This variable sets the
4105 marker characters and the face to be used by font-lock for highlighting
4106 in Org-mode Emacs buffers.
4108 You need to reload Org or to restart Emacs after customizing this."
4123 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4126 ;;; Miscellaneous options
4129 "Completion in Org-mode."
4134 "Non-nil means use ido completion wherever possible.
4135 Note that `ido-mode' must be active for this variable to be relevant.
4136 If you decide to turn this variable on, you might well want to turn off
4137 `org-outline-path-complete-in-steps'.
4138 See also `org-completion-use-iswitchb'."
4143 "Non-nil means use iswitchb completion wherever possible.
4144 Note that `iswitchb-mode' must be active for this variable to be relevant.
4145 If you decide to turn this variable on, you might well want to turn off
4146 `org-outline-path-complete-in-steps'.
4147 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4153 Normal means, no org-mode-specific context."
4157 ;;; Functions and variables from their packages
4158 ;; Declared here to avoid compiler warnings
4160 ;; XEmacs only
4166 ;; Emacs only
4169 ;; Various packages
4188 org-agenda-format-item "org-agenda"
4215 ;;; Autoload and prepare some org modules
4217 ;; Some table stuff that needs to be defined here, because it is used
4218 ;; by the functions setting up org-mode or checking for table context.
4231 "Detect the first line outside a table when searching from within it.
4234 ;; Autoload the functions in org-table.el that are needed by functions here.
4243 ;;;###autoload
4245 "Unconditionally turn on `orgtbl-mode'."
4250 "Return t if the cursor is inside an org-type table.
4251 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4256 org-table-line-regexp)))
4257 nil))
4261 "Return t if and only if we are at a table.el table."
4268 "If there is a table.el table nearby, recognize it and move into it."
4274 nil
4284 t
4289 t)
4290 nil)
4291 nil))
4294 "Return t if the cursor is inside a hline in a table."
4299 nil))
4302 "Apply FUNCTION to the start of all tables in the buffer."
4312 ;; Exclude tables in src/example/verbatim/clocktable blocks
4320 ;; Declare and autoload functions from org-agenda.el
4332 "Return t when point (or POS) is in #+TBLFM line."
4347 "Return the buffer where the clock is currently running.
4348 Return nil if no clock is running."
4353 org-clock-update-time-maybe
4354 org-clocktable-shift)))
4357 "Check if the current buffer contains the running clock.
4358 If yes, offer to stop it and to save the buffer with the changes."
4367 "Check if this line starts a clock table, if yes, shift the time block."
4371 ;;;###autoload
4373 "Set up hooks for clock persistence."
4378 ;; Define the variable already here, to make sure we have it.
4380 "Non-nil if Org-Indent mode is enabled.
4383 ;; Autoload archiving code
4384 ;; The stuff that is needed for cycling and tags has to be defined here.
4387 "Options concerning archiving in Org-mode."
4392 "The location where subtrees should be archived.
4394 The value of this variable is a string, consisting of two parts,
4395 separated by a double-colon. The first part is a filename and
4396 the second part is a headline.
4398 When the filename is omitted, archiving happens in the same file.
4399 %s in the filename will be replaced by the current file
4400 name (without the directory part). Archiving to a different file
4401 is useful to keep archived entries from contributing to the
4402 Org-mode Agenda.
4404 The archived entries will be filed as subtrees of the specified
4405 headline. When the headline is omitted, the subtrees are simply
4406 filed away at the end of the file, as top-level entries. Also in
4407 the heading you can use %s to represent the file name, this can be
4408 useful when using the same archive for a number of different files.
4410 Here are a few examples:
4412 If the current file is Projects.org, archive in file
4413 Projects.org_archive, as top-level trees. This is the default.
4416 Archive in the current file, under the top-level headline
4420 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4423 Archive in file ~/org/archive.org (absolute path), under headlines
4428 items to the datetree. Items are placed in either the CLOSED
4429 date of the item, or the current date if there is no CLOSED date.
4430 The heading will be a subentry to the current date. There doesn't
4431 need to be a heading, but there always needs to be a slash after
4432 datetree. For example, to store archived items directly in the
4436 Archive in file ./basement (relative path), as level 3 trees
4439 You may set this option on a per-file basis by adding to the buffer a
4440 line like
4442 #+ARCHIVE: basement::** Finished Tasks
4444 You may also define it locally for a subtree by setting an ARCHIVE property
4445 in the entry. If such a property is found in an entry, or anywhere up
4446 the hierarchy, it will be used."
4451 "The tag that marks a subtree as archived.
4452 An archived subtree does not open during visibility cycling, and does
4453 not contribute to the agenda listings.
4454 After changing this, font-lock must be restarted in the relevant buffers to
4455 get the proper fontification."
4461 "Non-nil means the agenda will skip any items located in archived trees.
4462 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4463 variable is no longer recommended, you should leave it at the value t.
4464 Instead, use the key `v' to cycle the archives-mode in the agenda."
4470 "Non-nil means ignore archived trees when creating column view."
4476 "Non-nil means `org-cycle' will open archived trees.
4477 An archived tree is a tree marked with the tag ARCHIVE.
4478 When nil, archived trees will stay folded. You can still open them with
4479 normal outline commands like `show-all', but not with the cycling commands."
4485 "Non-nil means sparse tree construction shows matches in archived trees.
4486 When nil, matches in these trees are highlighted, but the trees are kept in
4487 collapsed state."
4493 "The default date type when building a sparse tree.
4494 When this is nil, a date is a scheduled or a deadline timestamp.
4495 Otherwise, these types are allowed:
4497 all: all timestamps
4498 active: only active timestamps (<...>)
4499 inactive: only inactive timestamps (<...)
4500 scheduled: only scheduled timestamps
4501 deadline: only deadline timestamps"
4513 "Re-hide all archived subtrees after a visibility state change."
4524 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4527 "Cycle subtree even if it is archived."
4534 "Re-hide all archived subtrees after a visibility state change."
4551 flag)))
4559 ;; Autoload Column View Code
4567 org-columns-get-format-and-top-level
4568 org-columns-compute
4569 org-columns-remove-overlays))
4571 ;; Autoload ID code
4579 org-id-copy
4580 org-id-get-with-outline-path-completion
4581 org-id-get-with-outline-drilling))
4583 ;;; Variables for pre-computed regular expressions, all buffer local
4598 "Matches a headline and puts everything into groups:
4599 group 1: the stars
4600 group 2: The todo keyword, maybe
4601 group 3: Priority cookie
4602 group 4: True headline
4606 "Printf format to make regexp to match an exact headline.
4607 This regexp will match the headline of any node which has the
4608 exact headline text that is put into the format, but may have any
4612 "Matches a headline and puts TODO state into group 2 if present.
4664 "Regular expression to match a plain time or time range.
4665 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4666 groups carry important information:
4667 0 the full match
4668 1 the first time, range or not
4676 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4677 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4678 groups carry important information:
4679 0 the full match
4680 7 hours of duration
4689 "Regular expression to match a timestamp time or time range.
4690 After a match, the following groups carry important information:
4691 0 the full match
4692 1 date plus weekday, for back referencing to make sure both times are on the same day
4693 2 the first time, range or not
4754 "Variable associated with STARTUP options for org-mode.
4755 Each element is a list of three items: the startup options (as written
4756 in the #+STARTUP line), the corresponding variable, and the value to set
4757 this variable to if the option is found. An optional forth element PUSH
4761 "Update PROPS with KEY and VAL."
4775 "Printf format for a regexp matching a headline with some keyword.
4776 This regexp will match the headline of any node which has the
4777 exact keyword that is put into the format. The keyword isn't in
4781 "Printf format for a regexp matching a headline, possibly with some keyword.
4782 This regexp can match any headline with the specified keyword, or
4783 without a keyword. The keyword isn't in any group by default,
4787 "When non-nil (the default), use group tags.
4788 This can be turned on/off through `org-toggle-tags-groups'."
4794 "Toggle support for group tags.
4795 Support for group tags is controlled by the option
4796 `org-group-tags', which is non-nil by default."
4800 org-group-tags)
4808 "Precompute variables used for tags."
4814 tags ftags key value)
4831 ftags
4835 ;; Process the file tags.
4839 ;; Process the tags.
4850 org-tag-alist)))
4859 org-tag-groups-alist)
4882 ;; Return a list with tag variables
4887 "Precompute regular expressions used in the current buffer."
4905 kwds kws0 kwsa key log value cat arch const links hw dws
4906 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4914 ext-setup-or-nil
4922 ;; Append setupfile tags to existing tags
4926 org-tag-alist
4928 org-tag-groups-alist
4946 ;; general TODO-like setup
4955 links)))
4962 props))))
4967 l var val)
4985 ;; Prevent checking in Gnus messages
4997 ;; search for property blocks
5006 props)))))))
5020 ;; Process the TODO keywords
5022 ;; Use the global values as if they had been given locally.
5034 kws)))
5037 kwsa nil
5040 ;; 1 2
5048 kw)
5050 kws0)
5067 ;; Compute the regular expressions and other local variables.
5068 ;; Using `org-outline-regexp-bol' would complicate them much,
5069 ;; because of the fixed white space at the end of that string.
5077 org-not-done-keywords
5079 org-todo-regexp
5083 org-not-done-regexp
5087 org-not-done-heading-regexp
5089 org-todo-line-regexp
5091 org-complex-heading-regexp
5098 org-complex-heading-regexp-format
5103 ;; Stats cookies can be stuck to body.
5110 org-todo-line-tags-regexp
5117 org-deadline-time-regexp
5119 org-deadline-time-hour-regexp
5122 org-deadline-line-regexp
5124 org-scheduled-regexp
5126 org-scheduled-time-regexp
5128 org-scheduled-time-hour-regexp
5131 org-closed-time-regexp
5133 org-keyword-time-regexp
5139 org-keyword-time-not-clock-regexp
5145 org-maybe-keyword-time-regexp
5151 org-all-time-keywords
5154 org-clock-string org-closed-string)))
5159 "Return the contents of FILE, as a string."
5170 "Extract the log state setting from a TODO keyword string.
5184 "Remove a pair of parenthesis at the end of each string in LIST."
5188 x))
5189 list))
5192 "Assign fast keys to a keyword-key alist.
5193 Respect keys that are already there."
5211 ;;; Some variables used in various places
5218 "Function to be called when `C-c C-c' is used.
5222 ;; FIXME: Occasionally check by commenting these, to make sure
5223 ;; no other functions uses these, forgetting to let-bind them.
5228 ;; Defined somewhere in this file, but used before definition.
5234 ;;;; Define the Org-mode
5236 ;; We use a before-change function to check if a table might need
5237 ;; an update.
5239 "Indicates that a table might need an update.
5240 This variable is set by `org-before-change-function'.
5243 "Every change indicates that a table might need an update."
5258 (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"))
5261 ;; Other stuff we need.
5267 ;; (require 'org-macs) moved higher up in the file before it is first used
5269 ;; (require 'org-compat) moved higher up in the file before it is first used
5277 ;; babel
5280 ;;;###autoload
5282 "Outline-based notes management and organizer, alias
5285 Org-mode develops organizational tasks around a NOTES file which
5286 contains information about projects as plain text. Org-mode is
5287 implemented on top of outline-mode, which is ideal to keep the content
5288 of large files well structured. It supports ToDo items, deadlines and
5289 time stamps, which magically appear in the diary listing of the Emacs
5290 calendar. Tables are easily created with a built-in table editor.
5291 Plain text URL-like links connect to websites, emails (VM), Usenet
5292 messages (Gnus), BBDB entries, and any files related to the project.
5293 For printing and sharing of notes, an Org-mode file (or a part of it)
5294 can be exported as a structured ASCII or HTML file.
5296 The following commands are available:
5300 ;; Get rid of Outline menus, they are not needed
5301 ;; Need to do this here because define-derived-mode sets up
5302 ;; the keymap so late. Still, it is a waste to call this each time
5303 ;; we switch another buffer into org-mode.
5306 ;; Assume this is Greg's port, it uses easymenu
5332 org-display-table 4
5335 org-ellipsis)))
5342 ;; tag faces set outside customize.... force initialization.
5344 ;; Calc embedded
5346 ;; Modify a few syntax entries
5353 ;; Activate before-change-function
5357 ;; Check for running clock before killing a buffer
5359 ;; Initialize macros templates.
5361 ;; Initialize radio targets.
5363 ;; Indentation.
5366 ;; Filling and auto-filling.
5368 ;; Comments.
5370 ;; Beginning/end of defun
5373 ;; Next error for sparse trees
5375 ;; Make sure dependence stuff works reliably, even for users who set it
5376 ;; too late :-(
5388 ;; Align options lines
5390 'align-mode-rules-list
5395 ;; Imenu
5399 ;; Make isearch reveal context
5402 ;; Emacs 21 and XEmacs make use of the hook
5404 ;; Emacs 22 deals with this through a special variable
5409 ;; Setup the pcomplete hooks
5422 ;; If empty file that did not turn on org-mode automatically, make it to.
5438 ;; Try to set org-hide correctly
5441 ;; Update `customize-package-emacs-version-alist'
5451 org-emphasis-alist)
5452 st))
5465 "unspecified-bg"
5478 "Current time, possibly rounded to ROUNDING-MINUTES.
5479 When ROUNDING-MINUTES is not an integer, fall back on the car of
5480 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5481 the rounding returns a past time."
5493 res))))
5496 "Return today date, considering `org-extend-today-until'."
5501 ;;;; Font-Lock stuff, including the activators
5532 "Regular expression used to analyze links.
5533 Here is what the match groups contain after a match:
5534 1: http:
5535 2: http
5536 3: path
5537 4: [desc]
5548 "Create a regular expression which will match a balanced sexp.
5549 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5550 as single character strings.
5551 The regexp returned will match the entire expression including the
5552 delimiters. It will also define a single group which contains the
5553 match except for the outermost delimiters. The maximum depth of
5554 stacked delimiters is N. Escaping delimiters is not possible."
5583 "Update the link regular expressions.
5584 This should be called after the variable `org-link-types' has changed."
5588 org-link-re-with-space
5594 org-link-re-with-space2
5600 org-link-re-with-space3
5605 org-angle-link-re
5611 org-plain-link-re
5615 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5616 org-bracket-link-regexp
5618 org-bracket-link-analytic-regexp
5626 org-bracket-link-analytic-regexp++
5634 org-any-link-re
5643 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5646 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5647 "Regular expression matching time strings for analysis.
5648 This one does not require the space after the date, so it can be used
5650 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5667 "Regular expression matching a time stamp or time stamp range.
5673 "Run through the buffer and add overlays to emphasized strings."
5682 'face
5695 rtn))
5698 "Insert or change an emphasis, i.e. a font like bold or italic.
5699 If there is an active region, change that region to a new emphasis.
5700 If there is no region, just insert the marker characters and position
5701 the cursor between them.
5702 CHAR should be the marker character. If it is a space, it means to
5703 remove the emphasis of the selected region.
5704 If CHAR is not given (for example in an interactive call) it will be
5705 prompted for."
5748 "Run through the buffer and add overlays to links."
5757 nil
5764 t)))
5772 t)))
5775 "When non-nil, fontify code in code blocks."
5782 "When non-nil, allow promoting a top level subtree.
5783 The leading star of the top level headline will be replaced
5784 by a #."
5795 "Fontify #+ lines and blocks."
5798 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5799 limit t)
5807 end end1 quoting block-type ovl)
5810 ;; a single line of backend-specific content
5818 ; for backend-specific code
5819 t)
5821 ;; Truly a block
5834 beg end
5842 ;; remove old background overlays
5847 ;; add a background overlay
5862 t))
5882 t)
5888 ;; just any other in-buffer setting, but not indented
5892 t)
5896 "Run through the buffer and add overlays to links."
5905 t)))
5908 "Run through the buffer and add overlays to footnotes."
5915 'keymap org-mouse-map
5916 'help-echo
5918 "Footnote definition"
5920 'font-lock-fontified t
5921 'font-lock-multiline t
5925 "Run through the buffer and add overlays to bracketed links."
5938 ;; We need to remove the invisible property here. Table narrowing
5939 ;; may have made some of this invisible.
5957 t)))
5960 "Run through the buffer and add overlays to dates."
5973 t)))
5982 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5986 "Run through the buffer and add overlays to target matches."
5994 'keymap org-mouse-map
5998 t)))))
6001 "Find all radio targets in this file and update the regular expression."
6016 t)))
6024 "Compute regular expression for LaTeX, entities and sub/superscript.
6025 Result depends on variable `org-highlight-latex-and-related'."
6027 'org-latex-and-related-regexp
6039 org-latex-regexps)))))
6046 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6047 LIMIT bounds the search for syntax to highlight. Stop at first
6048 highlighted object, if any. Return t if some highlighting was
6049 done, nil otherwise."
6058 1
6066 nil)))
6069 "Restart `font-lock-mode', to force refontification."
6075 "Return a list of all targets in this file.
6076 When optional argument RADIO is non-nil, only find radio
6077 targets."
6082 ;; Make sure point is really within the object.
6087 rtn)))
6090 "Make regular expression matching all strings in TARGETS.
6091 The regular expression finds the targets also if there is a line break
6092 between words."
6101 x)
6102 targets
6114 t)))
6117 "Compute the outline level of the heading at point.
6118 If this is called at a normal headline, the level is the number of stars.
6119 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6124 0
6131 "Return a regexp matching a PROPERTY line.
6132 Match group 3 will be set to the value if it exists."
6139 "Regular expression matching a property line.
6140 There are four matching groups:
6141 1: :PROPKEY: including the leading and trailing colon,
6142 2: PROPKEY without the leading and trailing colon,
6143 3: PROPVAL without leading or trailing spaces,
6144 4: the indentation of the current line,
6151 "Functions that can manipulate `org-font-lock-extra-keywords'.
6152 This is called after `org-font-lock-extra-keywords' is defined, but before
6153 it is installed to be used by font lock. This can be useful if something
6157 "Run `org-font-lock-hook' within LIMIT."
6161 "Set font lock defaults for the current buffer."
6166 ;; Call the hook
6168 ;; Headlines
6175 ;; Table lines
6178 ;; Table internals
6183 ;; Drawers
6186 ;; Properties
6190 ;; Links
6198 ;; Targets.
6200 ;; Diary sexps.
6202 ;; Macro
6205 ;; TODO keyword
6207 org-todo-regexp)
6209 ;; DONE
6217 nil)
6218 ;; Priorities
6220 ;; Tags
6222 ;; Tags groups
6228 ;; Special keywords
6233 ;; Emphasis
6238 ;; Checkboxes
6239 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6244 ;; Description list items
6247 ;; ARCHIVEd headings
6249 org-outline-regexp-bol
6252 ;; Specials
6256 ;; Code
6258 ;; COMMENT
6264 ;; Blocks and meta lines
6268 ;; Now set the full font-lock-keywords
6275 "Toggle the composition display of entities as UTF8 characters."
6291 "Display or hide properties in `org-custom-properties'."
6308 org-custom-properties)))))))
6311 "Find an entity to fontify."
6317 limit t)
6332 nil))))
6335 "Fontify string S like in Org-mode."
6347 "Get the right face for match N in font-lock matching of headlines."
6360 "Get the right face for a TODO keyword KWD.
6361 If KWD is a number, get the corresponding match group."
6369 "Create a face list that inherits INHERIT, but sets the foreground color.
6370 When FACE-OR-COLOR is not a string, just return it."
6374 face-or-color)
6375 face-or-color))
6378 "Add the special tag faces."
6387 "Add the special priority faces."
6395 org-priority-faces)))
6400 "Get the right face for a TODO keyword KWD.
6401 If KWD is a number, get the corresponding match group."
6408 "Remove fontification and activation overlays from links."
6413 deactivate-mark buffer-file-name buffer-file-truename)
6417 invisible t intangible t
6418 org-no-flyspell t org-emphasis t))
6428 "Remove specific display properties that have been added by font lock.
6429 The will remove the raise properties that are used to show superscripts
6430 and subscripts."
6440 "Add raise properties to sub/superscripts."
6444 org-match-substring-regexp
6445 org-match-substring-with-braces-regexp)
6446 limit t)
6456 ;; Handle a_b^c
6459 t
6461 'display
6477 t)))))
6479 ;;;; Visibility cycling, including org-goto and indirect buffer
6481 ;;; Cycling
6493 "Display a message, but avoid logging it in the *Messages* buffer."
6497 ;;;###autoload
6499 "TAB-action and visibility cycling for Org-mode.
6501 This is the command invoked in Org-mode by the TAB key. Its main purpose
6502 is outline visibility cycling, but it also invokes other actions
6503 in special contexts.
6505 - When this function is called with a prefix argument, rotate the entire
6506 buffer through 3 states (global cycling)
6507 1. OVERVIEW: Show only top-level headlines.
6508 2. CONTENTS: Show all headlines of all levels, but no body text.
6509 3. SHOW ALL: Show everything.
6510 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6511 determined by the variable `org-startup-folded', and by any VISIBILITY
6512 properties in the buffer.
6513 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6514 including any drawers.
6516 - When inside a table, re-align the table and move to the next field.
6518 - When point is at the beginning of a headline, rotate the subtree started
6519 by this line through 3 different states (local cycling)
6520 1. FOLDED: Only the main headline is shown.
6521 2. CHILDREN: The main headline and the direct children are shown.
6522 From this state, you can move to one of the children
6523 and zoom in further.
6524 3. SUBTREE: Show the entire subtree, including body text.
6525 If there is no subtree, switch directly from CHILDREN to FOLDED.
6527 - When point is at the beginning of an empty headline and the variable
6528 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6529 of the headline by demoting and promoting it to likely levels. This
6530 speeds up creation document structure by pressing TAB once or several
6531 times right after creating a new headline.
6533 - When there is a numeric prefix, go up to a heading with level ARG, do
6534 a `show-subtree' and return to the previous cursor position. If ARG
6535 is negative, go up that many levels.
6537 - When point is not at the beginning of a headline, execute the global
6538 binding for TAB, which is re-indenting the line. See the option
6539 `org-cycle-emulate-tab' for details.
6541 - Special case: if point is at the beginning of the buffer and there is
6542 no headline in line 1, this function will act as if called with prefix arg
6543 (C-u TAB, same as S-TAB) also when called without prefix arg.
6544 But only if also the variable `org-cycle-global-at-bob' is t."
6554 org-inlinetask-min-level
6559 limit-level)))
6562 outline-regexp
6570 org-cycle-hook))
6574 ;; special case: use global cycling
6588 ;; Table: enter it or move to the next field.
6599 ;; Global cycling: delegate to `org-cycle-internal-global'.
6602 ;; Drawers: delegate to `org-flag-drawer'.
6609 ;; Show-subtree, ARG levels up from here.
6617 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6625 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6632 ;; From there: TAB emulation and template completion.
6654 t
6663 "Do the global cycling action."
6664 ;; Hack to avoid display of messages for .org attachments in Gnus
6669 ;; We just created the overview - now do table of contents
6670 ;; This can be slow in very large buffers, so indicate action
6680 ;; We just showed the table of contents - now show everything
6688 ;; Default action: go to overview
6696 "Do the local cycling action."
6698 ;; First, determine end of headline (EOH), end of subtree or item
6699 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6719 ;; Determine end invisible part of buffer (EOL)
6721 ;; XEmacs doesn't have `next-single-char-property-change'
6731 ;; Find out what to do next and set `this-command'
6734 ;; Nothing is hidden behind this heading
6747 org-cycle-skip-children-state-if-no-children))))
6748 ;; Entire subtree is hidden in one line: children view
6755 ;; FIXME: This slows down the func way too much.
6756 ;; How keep drawers hidden in subtree anyway?
6757 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6758 ;; (org-cycle-hide-drawers 'subtree))
6760 ;; Fold every list in subtree to top-level items.
6783 ;; We just showed the children, or no children are there,
6784 ;; now show everything.
6794 ;; Default action: hide the subtree.
6802 ;;;###autoload
6804 "Cycle the global visibility. For details see `org-cycle'.
6806 With a numeric prefix, show all headlines up to that level."
6822 "Set the visibility required by startup options and properties."
6837 "Switch subtree visibilities according to :VISIBILITY: property."
6844 nil t)
6868 ;; This function uses outline-regexp instead of the more fundamental
6869 ;; org-outline-regexp so that org-cycle-global works outside of Org
6870 ;; buffers, where outline-regexp is needed.
6872 "Switch to overview mode, showing only top-level headlines.
6873 Really, this shows all headlines with level equal or greater than the level
6874 of the first headline in the buffer. This is important, because if the
6875 first headline is not level one, then (hide-sublevels 1) gives confusing
6876 results."
6890 "Show all headlines in the buffer, like a table of contents.
6891 With numerical argument N, show content up to level N."
6894 ;; Visit all headings and show their offspring
6901 t)
6910 "Adjust the window after a change in outline visibility.
6911 This function is the default value of the hook `org-cycle-hook'."
6921 "Remove outline overlays that do not contain non-white stuff."
6931 "Fix visibility issues after moving a subtree."
6932 ;; First, find a reasonable region to look at:
6933 ;; Start two siblings above, end three below
6951 ;; Properly fold already folded siblings
6962 "Show empty lines above all visible headlines.
6963 The region to be covered depends on STATE when called through
6964 `org-cycle-hook'. Lisp program can use t for STATE to get the
6965 entire buffer covered. Note that an empty line is only shown if there
6966 are at least `org-cycle-separator-lines' empty lines before the headline."
6976 beg end b e)
7000 ;; Never hide empty lines at the end of the file.
7010 "Move to the parent and re-show empty lines before visible headlines."
7016 "Return `org-agenda-files' list, plus all open org-mode files.
7017 This is useful for operations that need to scan all of a user's
7018 open and agenda-wise Org files."
7026 files))
7029 "Return the beginning position of the current entry."
7033 "Return the end position of the current entry."
7037 "Re-hide all drawers after a visibility state change.
7038 When non-nil, optional argument EXCEPTIONS is a list of strings
7039 specifying which drawers should not be hidden."
7055 "Re-hide inline task when switching to 'contents visibility state."
7058 org-inlinetask-min-level)
7062 "When FLAG is non-nil, hide the drawer we are at.
7063 Otherwise make it visible. When optional argument ELEMENT is
7064 a parsed drawer, as returned by `org-element-at-point', hide or
7065 show that drawer instead."
7075 flag)))))
7078 "Is the end of the current subtree visible?"
7083 "Move cursor to the first headline and recenter the headline.
7084 Optional argument N means put the headline into the Nth line of the window."
7090 ;;; Saving and restoring visibility
7093 "Return a list of the locations of all outline overlays.
7094 These are overlays with the `invisible' property value `outline'.
7095 The return value is a list of cons cells, with start and stop
7096 positions for each overlay.
7097 If USE-MARKERS is set, return the positions as markers."
7115 "Create visibility overlays for all positions in DATA.
7116 DATA should have been made by `org-outline-overlay-data'."
7124 data)))))
7126 ;;; Folding of blocks
7133 "Call FUNCTION at the head of all source blocks in the current buffer.
7134 Optional arguments START and END can be used to limit the range."
7146 "Toggle the visibility of all blocks in the current buffer."
7150 "Fold all blocks in the current buffer."
7156 "Unfold all blocks in the current buffer."
7162 "Toggle visibility of block at point."
7173 "Toggle the visibility of the current block."
7180 ov)
7196 ;; make the block accessible to isearch
7198 ov 'isearch-open-invisible
7209 ;; org-tab-after-check-for-cycling-hook
7211 ;; Remove overlays when changing major mode
7216 ;;; Org-goto
7222 "Set the keymap `org-goto'."
7226 mouse-drag-region universal-argument org-occur))
7227 cmd)
7243 nil)
7244 (org-defkey map "q" 'org-goto-quit)
7245 (org-defkey map "n" 'outline-next-visible-heading)
7246 (org-defkey map "p" 'outline-previous-visible-heading)
7247 (org-defkey map "f" 'outline-forward-same-level)
7248 (org-defkey map "b" 'outline-backward-same-level)
7249 (org-defkey map "u" 'outline-up-heading))
7250 (org-defkey map "/" 'org-occur)
7251 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7252 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7253 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7254 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7255 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7256 map)))
7258 (defconst org-goto-help
7259 "Browse buffer copy, to find location or copy text.%s
7260 RET=jump to location C-g=quit and return to previous location
7261 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7263 (defvar org-goto-start-pos) ; dynamically scoped parameter
7265 (defun org-goto (&optional alternative-interface)
7266 "Look up a different location in the current file, keeping current visibility.
7268 When you want look-up or go to a different location in a
7269 document, the fastest way is often to fold the entire buffer and
7270 then dive into the tree. This method has the disadvantage, that
7271 the previous location will be folded, which may not be what you
7272 want.
7274 This command works around this by showing a copy of the current
7275 buffer in an indirect buffer, in overview mode. You can dive
7276 into the tree in that copy, use org-occur and incremental search
7277 to find a location. When pressing RET or `Q', the command
7278 returns to the original buffer in which the visibility is still
7279 unchanged. After RET it will also jump to the location selected
7280 in the indirect buffer and expose the headline hierarchy above.
7282 With a prefix argument, use the alternative interface: e.g. if
7283 `org-goto-interface' is 'outline use 'outline-path-completion."
7284 (interactive "P")
7285 (org-goto-map)
7286 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7287 (org-refile-use-outline-path t)
7288 (org-refile-target-verify-function nil)
7289 (interface
7290 (if (not alternative-interface)
7291 org-goto-interface
7292 (if (eq org-goto-interface 'outline)
7293 'outline-path-completion
7294 'outline)))
7295 (org-goto-start-pos (point))
7296 (selected-point
7297 (if (eq interface 'outline)
7298 (car (org-get-location (current-buffer) org-goto-help))
7299 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7300 (org-refile-check-position pa)
7301 (nth 3 pa)))))
7302 (if selected-point
7303 (progn
7304 (org-mark-ring-push org-goto-start-pos)
7305 (goto-char selected-point)
7306 (if (or (outline-invisible-p) (org-invisible-p2))
7307 (org-show-context 'org-goto)))
7308 (message "Quit"))))
7310 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7311 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7312 (defvar org-goto-local-auto-isearch-map) ; defined below
7314 (defun org-get-location (buf help)
7315 "Let the user select a location in the Org-mode buffer BUF.
7316 This function uses a recursive edit. It returns the selected position
7317 or nil."
7318 (org-no-popups
7319 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7320 (isearch-hide-immediately nil)
7321 (isearch-search-fun-function
7322 (lambda () 'org-goto-local-search-headings))
7323 (org-goto-selected-point org-goto-exit-command))
7324 (save-excursion
7325 (save-window-excursion
7326 (delete-other-windows)
7327 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7328 (org-pop-to-buffer-same-window
7329 (condition-case nil
7330 (make-indirect-buffer (current-buffer) "*org-goto*")
7331 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7332 (with-output-to-temp-buffer "*Org Help*"
7333 (princ (format help (if org-goto-auto-isearch
7334 " Just type for auto-isearch."
7335 " n/p/f/b/u to navigate, q to quit."))))
7336 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7337 (setq buffer-read-only nil)
7338 (let ((org-startup-truncated t)
7339 (org-startup-folded nil)
7340 (org-startup-align-all-tables nil))
7341 (org-mode)
7342 (org-overview))
7343 (setq buffer-read-only t)
7344 (if (and (boundp 'org-goto-start-pos)
7345 (integer-or-marker-p org-goto-start-pos))
7346 (let ((org-show-hierarchy-above t)
7347 (org-show-siblings t)
7348 (org-show-following-heading t))
7349 (goto-char org-goto-start-pos)
7350 (and (outline-invisible-p) (org-show-context)))
7351 (goto-char (point-min)))
7352 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7353 (message "Select location and press RET")
7354 (use-local-map org-goto-map)
7355 (recursive-edit)))
7356 (kill-buffer "*org-goto*")
7357 (cons org-goto-selected-point org-goto-exit-command))))
7359 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7360 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7361 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7362 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7364 (defun org-goto-local-search-headings (string bound noerror)
7365 "Search and make sure that any matches are in headlines."
7366 (catch 'return
7367 (while (if isearch-forward
7368 (search-forward string bound noerror)
7369 (search-backward string bound noerror))
7370 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7371 (and (member :headline context)
7372 (not (member :tags context))))
7373 (throw 'return (point))))))
7375 (defun org-goto-local-auto-isearch ()
7376 "Start isearch."
7377 (interactive)
7378 (goto-char (point-min))
7379 (let ((keys (this-command-keys)))
7380 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7381 (isearch-mode t)
7382 (isearch-process-search-char (string-to-char keys)))))
7384 (defun org-goto-ret (&optional arg)
7385 "Finish `org-goto' by going to the new location."
7386 (interactive "P")
7387 (setq org-goto-selected-point (point)
7388 org-goto-exit-command 'return)
7389 (throw 'exit nil))
7391 (defun org-goto-left ()
7392 "Finish `org-goto' by going to the new location."
7393 (interactive)
7394 (if (org-at-heading-p)
7395 (progn
7396 (beginning-of-line 1)
7397 (setq org-goto-selected-point (point)
7398 org-goto-exit-command 'left)
7399 (throw 'exit nil))
7400 (user-error "Not on a heading")))
7402 (defun org-goto-right ()
7403 "Finish `org-goto' by going to the new location."
7404 (interactive)
7405 (if (org-at-heading-p)
7406 (progn
7407 (setq org-goto-selected-point (point)
7408 org-goto-exit-command 'right)
7409 (throw 'exit nil))
7410 (user-error "Not on a heading")))
7412 (defun org-goto-quit ()
7413 "Finish `org-goto' without cursor motion."
7414 (interactive)
7415 (setq org-goto-selected-point nil)
7416 (setq org-goto-exit-command 'quit)
7417 (throw 'exit nil))
7419 ;;; Indirect buffer display of subtrees
7421 (defvar org-indirect-dedicated-frame nil
7422 "This is the frame being used for indirect tree display.")
7423 (defvar org-last-indirect-buffer nil)
7425 (defun org-tree-to-indirect-buffer (&optional arg)
7426 "Create indirect buffer and narrow it to current subtree.
7427 With a numerical prefix ARG, go up to this level and then take that tree.
7428 If ARG is negative, go up that many levels.
7430 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7431 indirect buffer previously made with this command, to avoid proliferation of
7432 indirect buffers. However, when you call the command with a \
7434 when `org-indirect-buffer-display' is `new-frame', the last buffer
7435 is kept so that you can work with several indirect buffers at the same time.
7436 If `org-indirect-buffer-display' is `dedicated-frame', the \
7438 requests that a new frame be made for the new buffer, so that the dedicated
7439 frame is not changed."
7440 (interactive "P")
7441 (let ((cbuf (current-buffer))
7442 (cwin (selected-window))
7443 (pos (point))
7444 beg end level heading ibuf)
7445 (save-excursion
7446 (org-back-to-heading t)
7447 (when (numberp arg)
7448 (setq level (org-outline-level))
7449 (if (< arg 0) (setq arg (+ level arg)))
7450 (while (> (setq level (org-outline-level)) arg)
7451 (org-up-heading-safe)))
7452 (setq beg (point)
7453 heading (org-get-heading))
7454 (org-end-of-subtree t t)
7455 (if (org-at-heading-p) (backward-char 1))
7456 (setq end (point)))
7457 (if (and (buffer-live-p org-last-indirect-buffer)
7458 (not (eq org-indirect-buffer-display 'new-frame))
7459 (not arg))
7460 (kill-buffer org-last-indirect-buffer))
7461 (setq ibuf (org-get-indirect-buffer cbuf)
7462 org-last-indirect-buffer ibuf)
7463 (cond
7464 ((or (eq org-indirect-buffer-display 'new-frame)
7465 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7466 (select-frame (make-frame))
7467 (delete-other-windows)
7468 (org-pop-to-buffer-same-window ibuf)
7469 (org-set-frame-title heading))
7470 ((eq org-indirect-buffer-display 'dedicated-frame)
7471 (raise-frame
7472 (select-frame (or (and org-indirect-dedicated-frame
7473 (frame-live-p org-indirect-dedicated-frame)
7474 org-indirect-dedicated-frame)
7475 (setq org-indirect-dedicated-frame (make-frame)))))
7476 (delete-other-windows)
7477 (org-pop-to-buffer-same-window ibuf)
7478 (org-set-frame-title (concat "Indirect: " heading)))
7479 ((eq org-indirect-buffer-display 'current-window)
7480 (org-pop-to-buffer-same-window ibuf))
7481 ((eq org-indirect-buffer-display 'other-window)
7482 (pop-to-buffer ibuf))
7483 (t (error "Invalid value")))
7484 (if (featurep 'xemacs)
7485 (save-excursion (org-mode) (turn-on-font-lock)))
7486 (narrow-to-region beg end)
7487 (show-all)
7488 (goto-char pos)
7489 (run-hook-with-args 'org-cycle-hook 'all)
7490 (and (window-live-p cwin) (select-window cwin))))
7492 (defun org-get-indirect-buffer (&optional buffer)
7493 (setq buffer (or buffer (current-buffer)))
7494 (let ((n 1) (base (buffer-name buffer)) bname)
7495 (while (buffer-live-p
7496 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7497 (setq n (1+ n)))
7498 (condition-case nil
7499 (make-indirect-buffer buffer bname 'clone)
7500 (error (make-indirect-buffer buffer bname)))))
7502 (defun org-set-frame-title (title)
7503 "Set the title of the current frame to the string TITLE."
7504 ;; FIXME: how to name a single frame in XEmacs???
7505 (unless (featurep 'xemacs)
7506 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7508 ;;;; Structure editing
7510 ;;; Inserting headlines
7512 (defun org-previous-line-empty-p (&optional next)
7513 "Is the previous line a blank line?
7514 When NEXT is non-nil, check the next line instead."
7515 (save-excursion
7516 (and (not (bobp))
7517 (or (beginning-of-line (if next 2 0)) t)
7518 (save-match-data
7521 (defun org-insert-heading (&optional arg invisible-ok)
7522 "Insert a new heading or item with same depth at point.
7523 If point is in a plain list and ARG is nil, create a new list item.
7524 With one universal prefix argument, insert a heading even in lists.
7525 With two universal prefix arguments, insert the heading at the end
7526 of the parent subtree.
7528 If point is at the beginning of a headline, insert a sibling before
7529 the current headline. If point is not at the beginning, split the line
7530 and create a new headline with the text in the current line after point
7531 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7533 If point is at the beginning of a normal line, turn this line into
7534 a heading.
7536 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7537 This is important for non-interactive uses of the command."
7538 (interactive "P")
7539 (if (org-called-interactively-p 'any) (org-reveal))
7540 (let ((itemp (org-in-item-p))
7541 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7542 (respect-content (or org-insert-heading-respect-content
7543 (equal arg '(16))))
7544 (initial-content "")
7545 (adjust-empty-lines t))
7547 (cond
7549 ((or (= (buffer-size) 0)
7550 (and (not (save-excursion
7551 (and (ignore-errors (org-back-to-heading invisible-ok))
7552 (org-at-heading-p))))
7553 (or arg (not itemp))))
7554 ;; At beginning of buffer or so high up that only a heading
7555 ;; makes sense.
7556 (insert
7558 (if (org-in-src-block-p) ",* " "* "))
7559 (run-hooks 'org-insert-heading-hook))
7561 ((and itemp (not (equal arg '(4))))
7562 ;; Insert an item
7563 (org-insert-item))
7565 (t
7566 ;; Insert a heading
7567 (save-restriction
7568 (widen)
7569 (let* ((level nil)
7570 (on-heading (org-at-heading-p))
7571 (empty-line-p (if on-heading
7572 (org-previous-line-empty-p)
7573 ;; We will decide later
7574 nil))
7575 ;; Get a level string to fall back on
7576 (fix-level
7577 (save-excursion
7578 (org-back-to-heading t)
7579 (if (org-previous-line-empty-p) (setq empty-line-p t))
7580 (looking-at org-outline-regexp)
7581 (make-string (1- (length (match-string 0))) ?*)))
7582 (stars
7583 (save-excursion
7584 (condition-case nil
7585 (progn
7586 (org-back-to-heading invisible-ok)
7587 (when (and (not on-heading)
7588 (featurep 'org-inlinetask)
7589 (integerp org-inlinetask-min-level)
7590 (>= (length (match-string 0))
7591 org-inlinetask-min-level))
7592 ;; Find a heading level before the inline task
7593 (while (and (setq level (org-up-heading-safe))
7594 (>= level org-inlinetask-min-level)))
7595 (if (org-at-heading-p)
7596 (org-back-to-heading invisible-ok)
7597 (error "This should not happen")))
7598 (unless (and (save-excursion
7599 (save-match-data
7600 (org-backward-heading-same-level
7601 1 invisible-ok))
7602 (= (point) (match-beginning 0)))
7603 (not (org-previous-line-empty-p t)))
7604 (setq empty-line-p (or empty-line-p
7605 (org-previous-line-empty-p))))
7606 (match-string 0))
7607 (error (or fix-level "* ")))))
7608 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7609 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7610 pos hide-previous previous-pos)
7612 ;; If we insert after content, move there and clean up whitespace
7613 (when respect-content
7614 (org-end-of-subtree nil t)
7617 (unless (eobp) (forward-char 1))
7619 (unless (bobp) (backward-char 1))
7622 ;; If we are splitting, grab the text that should be moved to the new headline
7623 (when may-split
7624 (if (org-on-heading-p)
7625 ;; This is a heading, we split intelligently (keeping tags)
7626 (let ((pos (point)))
7627 (goto-char (point-at-bol))
7628 (unless (looking-at org-complex-heading-regexp)
7629 (error "This should not happen"))
7630 (when (and (match-beginning 4)
7631 (> pos (match-beginning 4))
7632 (< pos (match-end 4)))
7633 (setq initial-content (buffer-substring pos (match-end 4)))
7634 (goto-char pos)
7635 (delete-region (point) (match-end 4))
7637 (replace-match "")
7638 (insert (make-string (length initial-content) ?\ )))
7639 (setq initial-content (org-trim initial-content)))
7640 (goto-char pos))
7641 ;; a normal line
7642 (unless (bolp)
7643 (setq initial-content (buffer-substring (point) (point-at-eol)))
7644 (delete-region (point) (point-at-eol))
7645 (setq initial-content (org-trim initial-content)))))
7647 ;; If we are at the beginning of the line, insert before it. Else after
7648 (cond
7651 (open-line 1))
7652 (t
7653 (goto-char (point-at-eol))
7656 ;; Insert the new heading
7657 (insert stars)
7658 (just-one-space)
7659 (insert initial-content)
7660 (when adjust-empty-lines
7661 (if (or (not blank)
7662 (and blank (not (org-previous-line-empty-p))))
7663 (org-N-empty-lines-before-current (if blank 1 0))))
7664 (run-hooks 'org-insert-heading-hook)))))))
7666 (defun org-N-empty-lines-before-current (N)
7667 "Make the number of empty lines before current exactly N.
7668 So this will delete or add empty lines."
7669 (save-excursion
7670 (goto-char (point-at-bol))
7672 (replace-match ""))
7674 (while (> N 0)
7676 (setq N (1- N)))))
7678 (defun org-get-heading (&optional no-tags no-todo)
7679 "Return the heading of the current entry, without the stars.
7680 When NO-TAGS is non-nil, don't include tags.
7681 When NO-TODO is non-nil, don't include TODO keywords."
7682 (save-excursion
7683 (org-back-to-heading t)
7684 (cond
7685 ((and no-tags no-todo)
7686 (looking-at org-complex-heading-regexp)
7687 (match-string 4))
7688 (no-tags
7689 (looking-at (concat org-outline-regexp
7692 (match-string 1))
7693 (no-todo
7694 (looking-at org-todo-line-regexp)
7695 (match-string 3))
7696 (t (looking-at org-heading-regexp)
7697 (match-string 2)))))
7699 (defvar orgstruct-mode) ; defined below
7701 (defun org-heading-components ()
7702 "Return the components of the current heading.
7703 This is a list with the following elements:
7704 - the level as an integer
7705 - the reduced level, different if `org-odd-levels-only' is set.
7706 - the TODO keyword, or nil
7707 - the priority character, like ?A, or nil if no priority is given
7708 - the headline text itself, or the tags string if no headline text
7709 - the tags string, or nil."
7710 (save-excursion
7711 (org-back-to-heading t)
7712 (if (let (case-fold-search)
7713 (looking-at
7714 (if orgstruct-mode
7715 org-heading-regexp
7716 org-complex-heading-regexp)))
7717 (if orgstruct-mode
7718 (list (length (match-string 1))
7719 (org-reduced-level (length (match-string 1)))
7720 nil
7721 nil
7722 (match-string 2)
7723 nil)
7724 (list (length (match-string 1))
7725 (org-reduced-level (length (match-string 1)))
7726 (org-match-string-no-properties 2)
7727 (and (match-end 3) (aref (match-string 3) 2))
7728 (org-match-string-no-properties 4)
7729 (org-match-string-no-properties 5))))))
7731 (defun org-get-entry ()
7732 "Get the entry text, after heading, entire subtree."
7733 (save-excursion
7734 (org-back-to-heading t)
7735 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7737 (defun org-insert-heading-after-current ()
7738 "Insert a new heading with same level as current, after current subtree."
7739 (interactive)
7740 (org-back-to-heading)
7741 (org-insert-heading)
7742 (org-move-subtree-down)
7743 (end-of-line 1))
7745 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7746 "Insert heading with `org-insert-heading-respect-content' set to t."
7747 (interactive "P")
7748 (let ((org-insert-heading-respect-content t))
7749 (org-insert-heading '(4) invisible-ok)))
7751 (defun org-insert-todo-heading-respect-content (&optional force-state)
7752 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7753 (interactive "P")
7754 (let ((org-insert-heading-respect-content t))
7755 (org-insert-todo-heading force-state '(4))))
7757 (defun org-insert-todo-heading (arg &optional force-heading)
7758 "Insert a new heading with the same level and TODO state as current heading.
7759 If the heading has no TODO state, or if the state is DONE, use the first
7760 state (TODO by default). Also one prefix arg, force first state. With two
7761 prefix args, force inserting at the end of the parent subtree."
7762 (interactive "P")
7763 (when (or force-heading (not (org-insert-item 'checkbox)))
7764 (org-insert-heading (or (and (equal arg '(16)) '(16))
7765 force-heading))
7766 (save-excursion
7767 (org-back-to-heading)
7768 (outline-previous-heading)
7769 (looking-at org-todo-line-regexp))
7770 (let*
7771 ((new-mark-x
7772 (if (or arg
7773 (not (match-beginning 2))
7774 (member (match-string 2) org-done-keywords))
7775 (car org-todo-keywords-1)
7776 (match-string 2)))
7777 (new-mark
7778 (or
7779 (run-hook-with-args-until-success
7780 'org-todo-get-default-hook new-mark-x nil)
7781 new-mark-x)))
7782 (beginning-of-line 1)
7783 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7784 (if org-treat-insert-todo-heading-as-state-change
7785 (org-todo new-mark)
7786 (insert new-mark " "))))
7787 (when org-provide-todo-statistics
7788 (org-update-parent-todo-statistics))))
7790 (defun org-insert-subheading (arg)
7791 "Insert a new subheading and demote it.
7792 Works for outline headings and for plain lists alike."
7793 (interactive "P")
7794 (org-insert-heading arg)
7795 (cond
7796 ((org-at-heading-p) (org-do-demote))
7797 ((org-at-item-p) (org-indent-item))))
7799 (defun org-insert-todo-subheading (arg)
7800 "Insert a new subheading with TODO keyword or checkbox and demote it.
7801 Works for outline headings and for plain lists alike."
7802 (interactive "P")
7803 (org-insert-todo-heading arg)
7804 (cond
7805 ((org-at-heading-p) (org-do-demote))
7806 ((org-at-item-p) (org-indent-item))))
7808 ;;; Promotion and Demotion
7810 (defvar org-after-demote-entry-hook nil
7811 "Hook run after an entry has been demoted.
7812 The cursor will be at the beginning of the entry.
7813 When a subtree is being demoted, the hook will be called for each node.")
7815 (defvar org-after-promote-entry-hook nil
7816 "Hook run after an entry has been promoted.
7817 The cursor will be at the beginning of the entry.
7818 When a subtree is being promoted, the hook will be called for each node.")
7820 (defun org-promote-subtree ()
7821 "Promote the entire subtree.
7822 See also `org-promote'."
7823 (interactive)
7824 (save-excursion
7825 (org-with-limited-levels (org-map-tree 'org-promote)))
7826 (org-fix-position-after-promote))
7828 (defun org-demote-subtree ()
7829 "Demote the entire subtree. See `org-demote'.
7830 See also `org-promote'."
7831 (interactive)
7832 (save-excursion
7833 (org-with-limited-levels (org-map-tree 'org-demote)))
7834 (org-fix-position-after-promote))
7837 (defun org-do-promote ()
7838 "Promote the current heading higher up the tree.
7839 If the region is active in `transient-mark-mode', promote all headings
7840 in the region."
7841 (interactive)
7842 (save-excursion
7843 (if (org-region-active-p)
7844 (org-map-region 'org-promote (region-beginning) (region-end))
7845 (org-promote)))
7846 (org-fix-position-after-promote))
7848 (defun org-do-demote ()
7849 "Demote the current heading lower down the tree.
7850 If the region is active in `transient-mark-mode', demote all headings
7851 in the region."
7852 (interactive)
7853 (save-excursion
7854 (if (org-region-active-p)
7855 (org-map-region 'org-demote (region-beginning) (region-end))
7856 (org-demote)))
7857 (org-fix-position-after-promote))
7859 (defun org-fix-position-after-promote ()
7860 "Make sure that after pro/demotion cursor position is right."
7861 (let ((pos (point)))
7862 (when (save-excursion
7863 (beginning-of-line 1)
7864 (looking-at org-todo-line-regexp)
7865 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7866 (cond ((eobp) (insert " "))
7867 ((eolp) (insert " "))
7868 ((equal (char-after) ?\ ) (forward-char 1))))))
7870 (defun org-current-level ()
7871 "Return the level of the current entry, or nil if before the first headline.
7872 The level is the number of stars at the beginning of the headline."
7873 (save-excursion
7874 (org-with-limited-levels
7875 (if (ignore-errors (org-back-to-heading t))
7876 (funcall outline-level)))))
7878 (defun org-get-previous-line-level ()
7879 "Return the outline depth of the last headline before the current line.
7880 Returns 0 for the first headline in the buffer, and nil if before the
7881 first headline."
7882 (let ((current-level (org-current-level))
7883 (prev-level (when (> (line-number-at-pos) 1)
7884 (save-excursion
7885 (beginning-of-line 0)
7886 (org-current-level)))))
7887 (cond ((null current-level) nil) ; Before first headline
7888 ((null prev-level) 0) ; At first headline
7889 (prev-level))))
7891 (defun org-reduced-level (l)
7892 "Compute the effective level of a heading.
7893 This takes into account the setting of `org-odd-levels-only'."
7894 (cond
7895 ((zerop l) 0)
7896 (org-odd-levels-only (1+ (floor (/ l 2))))
7897 (t l)))
7899 (defun org-level-increment ()
7900 "Return the number of stars that will be added or removed at a
7901 time to headlines when structure editing, based on the value of
7902 `org-odd-levels-only'."
7903 (if org-odd-levels-only 2 1))
7905 (defun org-get-valid-level (level &optional change)
7906 "Rectify a level change under the influence of `org-odd-levels-only'
7907 LEVEL is a current level, CHANGE is by how much the level should be
7908 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7909 even level numbers will become the next higher odd number."
7910 (if org-odd-levels-only
7911 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7912 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7913 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7914 (max 1 (+ level (or change 0)))))
7916 (if (boundp 'define-obsolete-function-alias)
7917 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7918 (define-obsolete-function-alias 'org-get-legal-level
7919 'org-get-valid-level)
7920 (define-obsolete-function-alias 'org-get-legal-level
7921 'org-get-valid-level "23.1")))
7923 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7924 ;; ̀org-with-limited-levels'
7925 (defun org-promote ()
7926 "Promote the current heading higher up the tree.
7927 If the region is active in `transient-mark-mode', promote all headings
7928 in the region."
7929 (org-back-to-heading t)
7930 (let* ((level (save-match-data (funcall outline-level)))
7931 (after-change-functions (remove 'flyspell-after-change-function
7932 after-change-functions))
7933 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7934 (diff (abs (- level (length up-head) -1))))
7935 (cond ((and (= level 1) org-called-with-limited-levels
7936 org-allow-promoting-top-level-subtree)
7937 (replace-match "# " nil t))
7938 ((= level 1)
7939 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7940 (t (replace-match up-head nil t)))
7941 ;; Fixup tag positioning
7942 (unless (= level 1)
7943 (and org-auto-align-tags (org-set-tags nil t))
7944 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7945 (run-hooks 'org-after-promote-entry-hook)))
7947 (defun org-demote ()
7948 "Demote the current heading lower down the tree.
7949 If the region is active in `transient-mark-mode', demote all headings
7950 in the region."
7951 (org-back-to-heading t)
7952 (let* ((level (save-match-data (funcall outline-level)))
7953 (after-change-functions (remove 'flyspell-after-change-function
7954 after-change-functions))
7955 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7956 (diff (abs (- level (length down-head) -1))))
7957 (replace-match down-head nil t)
7958 ;; Fixup tag positioning
7959 (and org-auto-align-tags (org-set-tags nil t))
7960 (if org-adapt-indentation (org-fixup-indentation diff))
7961 (run-hooks 'org-after-demote-entry-hook)))
7963 (defun org-cycle-level ()
7964 "Cycle the level of an empty headline through possible states.
7965 This goes first to child, then to parent, level, then up the hierarchy.
7966 After top level, it switches back to sibling level."
7967 (interactive)
7968 (let ((org-adapt-indentation nil))
7969 (when (org-point-at-end-of-empty-headline)
7970 (setq this-command 'org-cycle-level) ; Only needed for caching
7971 (let ((cur-level (org-current-level))
7972 (prev-level (org-get-previous-line-level)))
7973 (cond
7974 ;; If first headline in file, promote to top-level.
7975 ((= prev-level 0)
7976 (loop repeat (/ (- cur-level 1) (org-level-increment))
7977 do (org-do-promote)))
7978 ;; If same level as prev, demote one.
7979 ((= prev-level cur-level)
7980 (org-do-demote))
7981 ;; If parent is top-level, promote to top level if not already.
7982 ((= prev-level 1)
7983 (loop repeat (/ (- cur-level 1) (org-level-increment))
7984 do (org-do-promote)))
7985 ;; If top-level, return to prev-level.
7986 ((= cur-level 1)
7987 (loop repeat (/ (- prev-level 1) (org-level-increment))
7988 do (org-do-demote)))
7989 ;; If less than prev-level, promote one.
7990 ((< cur-level prev-level)
7991 (org-do-promote))
7992 ;; If deeper than prev-level, promote until higher than
7993 ;; prev-level.
7994 ((> cur-level prev-level)
7995 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7996 do (org-do-promote))))
7997 t))))
7999 (defun org-map-tree (fun)
8000 "Call FUN for every heading underneath the current one."
8001 (org-back-to-heading)
8002 (let ((level (funcall outline-level)))
8003 (save-excursion
8004 (funcall fun)
8005 (while (and (progn
8006 (outline-next-heading)
8007 (> (funcall outline-level) level))
8008 (not (eobp)))
8009 (funcall fun)))))
8011 (defun org-map-region (fun beg end)
8012 "Call FUN for every heading between BEG and END."
8013 (let ((org-ignore-region t))
8014 (save-excursion
8015 (setq end (copy-marker end))
8016 (goto-char beg)
8017 (if (and (re-search-forward org-outline-regexp-bol nil t)
8018 (< (point) end))
8019 (funcall fun))
8020 (while (and (progn
8021 (outline-next-heading)
8022 (< (point) end))
8023 (not (eobp)))
8024 (funcall fun)))))
8026 (defvar org-property-end-re) ; silence byte-compiler
8027 (defun org-fixup-indentation (diff)
8028 "Change the indentation in the current entry by DIFF.
8029 However, if any line in the current entry has no indentation, or if it
8030 would end up with no indentation after the change, nothing at all is done."
8031 (save-excursion
8032 (let ((end (save-excursion (outline-next-heading)
8033 (point-marker)))
8034 (prohibit (if (> diff 0)
8037 col)
8038 (unless (save-excursion (end-of-line 1)
8039 (re-search-forward prohibit end t))
8040 (while (and (< (point) end)
8042 (goto-char (match-end 0))
8043 (setq col (current-column))
8044 (if (< diff 0) (replace-match ""))
8045 (org-indent-to-column (+ diff col))))
8046 (move-marker end nil))))
8048 (defun org-convert-to-odd-levels ()
8049 "Convert an org-mode file with all levels allowed to one with odd levels.
8050 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8051 level 5 etc."
8052 (interactive)
8053 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8054 (let ((outline-level 'org-outline-level)
8055 (org-odd-levels-only nil) n)
8056 (save-excursion
8057 (goto-char (point-min))
8059 (setq n (- (length (match-string 0)) 2))
8060 (while (>= (setq n (1- n)) 0)
8061 (org-demote))
8062 (end-of-line 1))))))
8064 (defun org-convert-to-oddeven-levels ()
8065 "Convert an org-mode file with only odd levels to one with odd/even levels.
8066 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8067 file contains a section with an even level, conversion would
8068 destroy the structure of the file. An error is signaled in this
8069 case."
8070 (interactive)
8071 (goto-char (point-min))
8072 ;; First check if there are no even levels
8074 (org-show-context t)
8075 (error "Not all levels are odd in this file. Conversion not possible"))
8076 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8077 (let ((outline-regexp org-outline-regexp)
8078 (outline-level 'org-outline-level)
8079 (org-odd-levels-only nil) n)
8080 (save-excursion
8081 (goto-char (point-min))
8083 (setq n (/ (1- (length (match-string 0))) 2))
8084 (while (>= (setq n (1- n)) 0)
8085 (org-promote))
8086 (end-of-line 1))))))
8088 (defun org-tr-level (n)
8089 "Make N odd if required."
8090 (if org-odd-levels-only (1+ (/ n 2)) n))
8092 ;;; Vertical tree motion, cutting and pasting of subtrees
8094 (defun org-move-subtree-up (&optional arg)
8095 "Move the current subtree up past ARG headlines of the same level."
8096 (interactive "p")
8097 (org-move-subtree-down (- (prefix-numeric-value arg))))
8099 (defun org-move-subtree-down (&optional arg)
8100 "Move the current subtree down past ARG headlines of the same level."
8101 (interactive "p")
8102 (setq arg (prefix-numeric-value arg))
8103 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8104 'org-get-last-sibling))
8105 (ins-point (make-marker))
8106 (cnt (abs arg))
8107 (col (current-column))
8108 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8109 ;; Select the tree
8110 (org-back-to-heading)
8111 (setq beg0 (point))
8112 (save-excursion
8113 (setq ne-beg (org-back-over-empty-lines))
8114 (setq beg (point)))
8115 (save-match-data
8116 (save-excursion (outline-end-of-heading)
8117 (setq folded (outline-invisible-p)))
8118 (outline-end-of-subtree))
8119 (outline-next-heading)
8120 (setq ne-end (org-back-over-empty-lines))
8121 (setq end (point))
8122 (goto-char beg0)
8123 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8124 ;; include less whitespace
8125 (save-excursion
8126 (goto-char beg)
8127 (forward-line (- ne-beg ne-end))
8128 (setq beg (point))))
8129 ;; Find insertion point, with error handling
8130 (while (> cnt 0)
8131 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8132 (progn (goto-char beg0)
8133 (user-error "Cannot move past superior level or buffer limit")))
8134 (setq cnt (1- cnt)))
8135 (if (> arg 0)
8136 ;; Moving forward - still need to move over subtree
8137 (progn (org-end-of-subtree t t)
8138 (save-excursion
8139 (org-back-over-empty-lines)
8140 (or (bolp) (newline)))))
8141 (setq ne-ins (org-back-over-empty-lines))
8142 (move-marker ins-point (point))
8143 (setq txt (buffer-substring beg end))
8144 (org-save-markers-in-region beg end)
8145 (delete-region beg end)
8146 (org-remove-empty-overlays-at beg)
8147 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8148 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8150 (let ((bbb (point)))
8151 (insert-before-markers txt)
8152 (org-reinstall-markers-in-region bbb)
8153 (move-marker ins-point bbb))
8155 (setq ins-end (point))
8156 (goto-char ins-point)
8157 (org-skip-whitespace)
8158 (when (and (< arg 0)
8159 (org-first-sibling-p)
8160 (> ne-ins ne-beg))
8161 ;; Move whitespace back to beginning
8162 (save-excursion
8163 (goto-char ins-end)
8164 (let ((kill-whole-line t))
8165 (kill-line (- ne-ins ne-beg)) (point)))
8167 (move-marker ins-point nil)
8168 (if folded
8169 (hide-subtree)
8170 (org-show-entry)
8171 (show-children)
8172 (org-cycle-hide-drawers 'children))
8173 (org-clean-visibility-after-subtree-move)
8174 ;; move back to the initial column we were at
8175 (move-to-column col)))
8177 (defvar org-subtree-clip ""
8178 "Clipboard for cut and paste of subtrees.
8179 This is actually only a copy of the kill, because we use the normal kill
8180 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8182 (defvar org-subtree-clip-folded nil
8183 "Was the last copied subtree folded?
8184 This is used to fold the tree back after pasting.")
8186 (defun org-cut-subtree (&optional n)
8187 "Cut the current subtree into the clipboard.
8188 With prefix arg N, cut this many sequential subtrees.
8189 This is a short-hand for marking the subtree and then cutting it."
8190 (interactive "p")
8191 (org-copy-subtree n 'cut))
8193 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8194 "Copy the current subtree it in the clipboard.
8195 With prefix arg N, copy this many sequential subtrees.
8196 This is a short-hand for marking the subtree and then copying it.
8197 If CUT is non-nil, actually cut the subtree.
8198 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8199 of some markers in the region, even if CUT is non-nil. This is
8200 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8201 (interactive "p")
8202 (let (beg end folded (beg0 (point)))
8203 (if (org-called-interactively-p 'any)
8204 (org-back-to-heading nil) ; take what looks like a subtree
8205 (org-back-to-heading t)) ; take what is really there
8206 (setq beg (point))
8208 (save-match-data
8209 (if nosubtrees
8210 (outline-next-heading)
8211 (save-excursion (outline-end-of-heading)
8212 (setq folded (outline-invisible-p)))
8213 (condition-case nil
8214 (org-forward-heading-same-level (1- n) t)
8215 (error nil))
8216 (org-end-of-subtree t t)))
8217 (setq end (point))
8218 (goto-char beg0)
8219 (when (> end beg)
8220 (setq org-subtree-clip-folded folded)
8221 (when (or cut force-store-markers)
8222 (org-save-markers-in-region beg end))
8223 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8224 (setq org-subtree-clip (current-kill 0))
8225 (message "%s: Subtree(s) with %d characters"
8226 (if cut "Cut" "Copied")
8227 (length org-subtree-clip)))))
8229 (defun org-paste-subtree (&optional level tree for-yank)
8230 "Paste the clipboard as a subtree, with modification of headline level.
8231 The entire subtree is promoted or demoted in order to match a new headline
8232 level.
8234 If the cursor is at the beginning of a headline, the same level as
8235 that headline is used to paste the tree.
8237 If not, the new level is derived from the *visible* headings
8238 before and after the insertion point, and taken to be the inferior headline
8239 level of the two. So if the previous visible heading is level 3 and the
8240 next is level 4 (or vice versa), level 4 will be used for insertion.
8241 This makes sure that the subtree remains an independent subtree and does
8242 not swallow low level entries.
8244 You can also force a different level, either by using a numeric prefix
8245 argument, or by inserting the heading marker by hand. For example, if the
8248 If optional TREE is given, use this text instead of the kill ring.
8250 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8251 move back over whitespace before inserting, and move point to the end of
8252 the inserted text when done."
8253 (interactive "P")
8254 (setq tree (or tree (and kill-ring (current-kill 0))))
8255 (unless (org-kill-is-subtree-p tree)
8256 (user-error "%s"
8257 (substitute-command-keys
8259 (org-with-limited-levels
8260 (let* ((visp (not (outline-invisible-p)))
8261 (txt tree)
8263 (old-level (if (string-match org-outline-regexp-bol txt)
8264 (- (match-end 0) (match-beginning 0) 1)
8265 -1))
8266 (force-level (cond (level (prefix-numeric-value level))
8268 (string-match
8270 (point-at-bol) (point))))
8271 (- (match-end 1) (match-beginning 1)))
8272 ((and (bolp)
8273 (looking-at org-outline-regexp))
8274 (- (match-end 0) (point) 1))))
8275 (previous-level (save-excursion
8276 (condition-case nil
8277 (progn
8278 (outline-previous-visible-heading 1)
8279 (if (looking-at ^re_)
8280 (- (match-end 0) (match-beginning 0) 1)
8281 1))
8282 (error 1))))
8283 (next-level (save-excursion
8284 (condition-case nil
8285 (progn
8286 (or (looking-at org-outline-regexp)
8287 (outline-next-visible-heading 1))
8288 (if (looking-at ^re_)
8289 (- (match-end 0) (match-beginning 0) 1)
8290 1))
8291 (error 1))))
8292 (new-level (or force-level (max previous-level next-level)))
8293 (shift (if (or (= old-level -1)
8294 (= new-level -1)
8295 (= old-level new-level))
8296 0
8297 (- new-level old-level)))
8298 (delta (if (> shift 0) -1 1))
8299 (func (if (> shift 0) 'org-demote 'org-promote))
8300 (org-odd-levels-only nil)
8301 beg end newend)
8302 ;; Remove the forced level indicator
8303 (if force-level
8304 (delete-region (point-at-bol) (point)))
8305 ;; Paste
8306 (beginning-of-line (if (bolp) 1 2))
8307 (setq beg (point))
8308 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8309 (insert-before-markers txt)
8311 (setq newend (point))
8312 (org-reinstall-markers-in-region beg)
8313 (setq end (point))
8314 (goto-char beg)
8316 (setq beg (point))
8317 (if (and (outline-invisible-p) visp)
8318 (save-excursion (outline-show-heading)))
8319 ;; Shift if necessary
8320 (unless (= shift 0)
8321 (save-restriction
8322 (narrow-to-region beg end)
8323 (while (not (= shift 0))
8324 (org-map-region func (point-min) (point-max))
8325 (setq shift (+ delta shift)))
8326 (goto-char (point-min))
8327 (setq newend (point-max))))
8328 (when (or (org-called-interactively-p 'interactive) for-yank)
8329 (message "Clipboard pasted as level %d subtree" new-level))
8330 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8331 kill-ring
8332 (eq org-subtree-clip (current-kill 0))
8333 org-subtree-clip-folded)
8334 ;; The tree was folded before it was killed/copied
8335 (hide-subtree))
8336 (and for-yank (goto-char newend)))))
8338 (defun org-kill-is-subtree-p (&optional txt)
8339 "Check if the current kill is an outline subtree, or a set of trees.
8340 Returns nil if kill does not start with a headline, or if the first
8341 headline level is not the largest headline level in the tree.
8342 So this will actually accept several entries of equal levels as well,
8343 which is OK for `org-paste-subtree'.
8344 If optional TXT is given, check this string instead of the current kill."
8345 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8346 (re (org-get-limited-outline-regexp))
8347 (^re (concat "^" re))
8348 (start-level (and kill
8349 (string-match
8351 kill)
8352 (- (match-end 2) (match-beginning 2) 1)))
8353 (start (1+ (or (match-beginning 2) -1))))
8354 (if (not start-level)
8355 (progn
8356 nil) ;; does not even start with a heading
8357 (catch 'exit
8358 (while (setq start (string-match ^re kill (1+ start)))
8359 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8360 (throw 'exit nil)))
8361 t))))
8363 (defvar org-markers-to-move nil
8364 "Markers that should be moved with a cut-and-paste operation.
8365 Those markers are stored together with their positions relative to
8366 the start of the region.")
8368 (defun org-save-markers-in-region (beg end)
8369 "Check markers in region.
8370 If these markers are between BEG and END, record their position relative
8371 to BEG, so that after moving the block of text, we can put the markers back
8372 into place.
8373 This function gets called just before an entry or tree gets cut from the
8374 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8375 called immediately, to move the markers with the entries."
8376 (setq org-markers-to-move nil)
8377 (when (featurep 'org-clock)
8378 (org-clock-save-markers-for-cut-and-paste beg end))
8379 (when (featurep 'org-agenda)
8380 (org-agenda-save-markers-for-cut-and-paste beg end)))
8382 (defun org-check-and-save-marker (marker beg end)
8383 "Check if MARKER is between BEG and END.
8384 If yes, remember the marker and the distance to BEG."
8385 (when (and (marker-buffer marker)
8386 (equal (marker-buffer marker) (current-buffer)))
8387 (if (and (>= marker beg) (< marker end))
8388 (push (cons marker (- marker beg)) org-markers-to-move))))
8390 (defun org-reinstall-markers-in-region (beg)
8391 "Move all remembered markers to their position relative to BEG."
8392 (mapc (lambda (x)
8393 (move-marker (car x) (+ beg (cdr x))))
8394 org-markers-to-move)
8395 (setq org-markers-to-move nil))
8397 (defun org-narrow-to-subtree ()
8398 "Narrow buffer to the current subtree."
8399 (interactive)
8400 (save-excursion
8401 (save-match-data
8402 (org-with-limited-levels
8403 (narrow-to-region
8404 (progn (org-back-to-heading t) (point))
8405 (progn (org-end-of-subtree t t)
8406 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8407 (point)))))))
8409 (defun org-narrow-to-block ()
8410 "Narrow buffer to the current block."
8411 (interactive)
8412 (let* ((case-fold-search t)
8415 (if blockp
8416 (narrow-to-region (car blockp) (cdr blockp))
8417 (user-error "Not in a block"))))
8419 (eval-when-compile
8420 (defvar org-property-drawer-re))
8422 (defvar org-property-start-re) ;; defined below
8423 (defun org-clone-subtree-with-time-shift (n &optional shift)
8424 "Clone the task (subtree) at point N times.
8425 The clones will be inserted as siblings.
8427 In interactive use, the user will be prompted for the number of
8428 clones to be produced. If the entry has a timestamp, the user
8429 will also be prompted for a time shift, which may be a repeater
8430 as used in time stamps, for example `+3d'. To disable this,
8431 you can call the function with a universal prefix argument.
8433 When a valid repeater is given and the entry contains any time
8434 stamps, the clones will become a sequence in time, with time
8435 stamps in the subtree shifted for each clone produced. If SHIFT
8436 is nil or the empty string, time stamps will be left alone. The
8437 ID property of the original subtree is removed.
8439 If the original subtree did contain time stamps with a repeater,
8440 the following will happen:
8441 - the repeater will be removed in each clone
8442 - an additional clone will be produced, with the current, unshifted
8443 date(s) in the entry.
8444 - the original entry will be placed *after* all the clones, with
8445 repeater intact.
8446 - the start days in the repeater in the original entry will be shifted
8447 to past the last clone.
8448 In this way you can spell out a number of instances of a repeating task,
8449 and still retain the repeater to cover future instances of the task."
8450 (interactive "nNumber of clones to produce: ")
8451 (let ((shift
8452 (or shift
8453 (if (and (not (equal current-prefix-arg '(4)))
8454 (save-excursion
8455 (re-search-forward org-ts-regexp-both
8456 (save-excursion
8457 (org-end-of-subtree t)
8458 (point)) t)))
8459 (read-from-minibuffer
8460 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8461 ""))) ;; No time shift
8462 (n-no-remove -1)
8463 (drawer-re org-drawer-regexp)
8464 beg end template task idprop
8465 shift-n shift-what doshift nmin nmax)
8466 (if (not (and (integerp n) (> n 0)))
8467 (error "Invalid number of replications %s" n))
8470 shift)))
8471 (error "Invalid shift specification %s" shift))
8472 (when doshift
8473 (setq shift-n (string-to-number (match-string 1 shift))
8474 shift-what (cdr (assoc (match-string 2 shift)
8475 '(("d" . day) ("w" . week)
8476 ("m" . month) ("y" . year))))))
8477 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8478 (setq nmin 1 nmax n)
8479 (org-back-to-heading t)
8480 (setq beg (point))
8481 (setq idprop (org-entry-get nil "ID"))
8482 (org-end-of-subtree t t)
8484 (setq end (point))
8485 (setq template (buffer-substring beg end))
8486 (when (and doshift
8488 (delete-region beg end)
8489 (setq end beg)
8490 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8491 (goto-char end)
8492 (loop for n from nmin to nmax do
8493 ;; prepare clone
8494 (with-temp-buffer
8495 (insert template)
8496 (org-mode)
8497 (goto-char (point-min))
8498 (org-show-subtree)
8499 (and idprop (if org-clone-delete-id
8500 (org-entry-delete nil "ID")
8501 (org-id-get-create t)))
8502 (unless (= n 0)
8504 (kill-whole-line))
8505 (goto-char (point-min))
8506 (while (re-search-forward drawer-re nil t)
8507 (org-remove-empty-drawer-at (point))))
8508 (goto-char (point-min))
8509 (when doshift
8510 (while (re-search-forward org-ts-regexp-both nil t)
8511 (org-timestamp-change (* n shift-n) shift-what))
8512 (unless (= n n-no-remove)
8513 (goto-char (point-min))
8514 (while (re-search-forward org-ts-regexp nil t)
8515 (save-excursion
8516 (goto-char (match-beginning 0))
8518 (delete-region (match-beginning 1) (match-end 1)))))))
8519 (setq task (buffer-string)))
8520 (insert task))
8521 (goto-char beg)))
8523 ;;; Outline Sorting
8525 (defun org-sort (with-case)
8526 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8527 Optional argument WITH-CASE means sort case-sensitively."
8528 (interactive "P")
8529 (cond
8530 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8531 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8532 (t
8533 (org-call-with-arg 'org-sort-entries with-case))))
8535 (defun org-sort-remove-invisible (s)
8536 "Remove invisible links from string S."
8537 (remove-text-properties 0 (length s) org-rm-props s)
8538 (while (string-match org-bracket-link-regexp s)
8539 (setq s (replace-match (if (match-end 2)
8540 (match-string 3 s)
8541 (match-string 1 s)) t t s)))
8542 (let ((st (format " %s " s)))
8543 (while (string-match org-emph-re st)
8544 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8545 (setq s (substring st 1 -1)))
8546 s)
8548 (defvar org-priority-regexp) ; defined later in the file
8550 (defvar org-after-sorting-entries-or-items-hook nil
8551 "Hook that is run after a bunch of entries or items have been sorted.
8552 When children are sorted, the cursor is in the parent line when this
8553 hook gets called. When a region or a plain list is sorted, the cursor
8554 will be in the first entry of the sorted region/list.")
8556 (defun org-sort-entries
8557 (&optional with-case sorting-type getkey-func compare-func property)
8558 "Sort entries on a certain level of an outline tree.
8559 If there is an active region, the entries in the region are sorted.
8560 Else, if the cursor is before the first entry, sort the top-level items.
8561 Else, the children of the entry at point are sorted.
8563 Sorting can be alphabetically, numerically, by date/time as given by
8564 a time stamp, by a property, by priority order, or by a custom function.
8566 The command prompts for the sorting type unless it has been given to the
8567 function through the SORTING-TYPE argument, which needs to be a character,
8568 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8569 precise meaning of each character:
8571 n Numerically, by converting the beginning of the entry/item to a number.
8572 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8573 o By order of TODO keywords.
8574 t By date/time, either the first active time stamp in the entry, or, if
8575 none exist, by the first inactive one.
8576 s By the scheduled date/time.
8577 d By deadline date/time.
8578 c By creation time, which is assumed to be the first inactive time stamp
8579 at the beginning of a line.
8580 p By priority according to the cookie.
8581 r By the value of a property.
8583 Capital letters will reverse the sort order.
8585 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8586 called with point at the beginning of the record. It must return either
8587 a string or a number that should serve as the sorting key for that record.
8589 Comparing entries ignores case by default. However, with an optional argument
8590 WITH-CASE, the sorting considers case as well.
8592 Sorting is done against the visible part of the headlines, it ignores hidden
8593 links."
8594 (interactive "P")
8595 (let ((case-func (if with-case 'identity 'downcase))
8596 (cmstr
8597 ;; The clock marker is lost when using `sort-subr', let's
8598 ;; store the clocking string.
8599 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8600 (save-excursion
8601 (goto-char org-clock-marker)
8602 (looking-back "^.*") (match-string-no-properties 0))))
8603 start beg end stars re re2
8604 txt what tmp)
8605 ;; Find beginning and end of region to sort
8606 (cond
8607 ((org-region-active-p)
8608 ;; we will sort the region
8609 (setq end (region-end)
8610 what "region")
8611 (goto-char (region-beginning))
8612 (if (not (org-at-heading-p)) (outline-next-heading))
8613 (setq start (point)))
8614 ((or (org-at-heading-p)
8615 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8616 ;; we will sort the children of the current headline
8617 (org-back-to-heading)
8618 (setq start (point)
8619 end (progn (org-end-of-subtree t t)
8621 (org-back-over-empty-lines)
8622 (point))
8623 what "children")
8624 (goto-char start)
8625 (show-subtree)
8626 (outline-next-heading))
8627 (t
8628 ;; we will sort the top-level entries in this file
8629 (goto-char (point-min))
8630 (or (org-at-heading-p) (outline-next-heading))
8631 (setq start (point))
8632 (goto-char (point-max))
8633 (beginning-of-line 1)
8635 ;; File ends in a non-white line
8636 (end-of-line 1)
8638 (setq end (point-max))
8639 (setq what "top-level")
8640 (goto-char start)
8641 (show-all)))
8643 (setq beg (point))
8644 (if (>= beg end) (user-error "Nothing to sort"))
8647 (setq stars (match-string 1)
8648 re (concat "^" (regexp-quote stars) " +")
8650 txt (buffer-substring beg end))
8652 (if (and (not (equal stars "*")) (string-match re2 txt))
8653 (user-error "Region to sort contains a level above the first entry"))
8655 (unless sorting-type
8656 (message
8657 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8659 A/N/P/R/O/F/T/S/D/C means reversed:"
8660 what)
8661 (setq sorting-type (read-char-exclusive))
8663 (unless getkey-func
8664 (and (= (downcase sorting-type) ?f)
8665 (setq getkey-func
8666 (org-icompleting-read "Sort using function: "
8667 obarray 'fboundp t nil nil))
8668 (setq getkey-func (intern getkey-func))))
8670 (and (= (downcase sorting-type) ?r)
8671 (not property)
8672 (setq property
8673 (org-icompleting-read "Property: "
8674 (mapcar 'list (org-buffer-property-keys t))
8675 nil t))))
8677 (message "Sorting entries...")
8679 (save-restriction
8680 (narrow-to-region start end)
8681 (let ((dcst (downcase sorting-type))
8682 (case-fold-search nil)
8683 (now (current-time)))
8684 (sort-subr
8685 (/= dcst sorting-type)
8686 ;; This function moves to the beginning character of the "record" to
8687 ;; be sorted.
8688 (lambda nil
8689 (if (re-search-forward re nil t)
8690 (goto-char (match-beginning 0))
8691 (goto-char (point-max))))
8692 ;; This function moves to the last character of the "record" being
8693 ;; sorted.
8694 (lambda nil
8695 (save-match-data
8696 (condition-case nil
8697 (outline-forward-same-level 1)
8698 (error
8699 (goto-char (point-max))))))
8700 ;; This function returns the value that gets sorted against.
8701 (lambda nil
8702 (cond
8703 ((= dcst ?n)
8704 (if (looking-at org-complex-heading-regexp)
8705 (string-to-number (org-sort-remove-invisible (match-string 4)))
8706 nil))
8707 ((= dcst ?a)
8708 (if (looking-at org-complex-heading-regexp)
8709 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8710 nil))
8711 ((= dcst ?t)
8712 (let ((end (save-excursion (outline-next-heading) (point))))
8713 (if (or (re-search-forward org-ts-regexp end t)
8714 (re-search-forward org-ts-regexp-both end t))
8715 (org-time-string-to-seconds (match-string 0))
8716 (org-float-time now))))
8717 ((= dcst ?c)
8718 (let ((end (save-excursion (outline-next-heading) (point))))
8719 (if (re-search-forward
8721 end t)
8722 (org-time-string-to-seconds (match-string 0))
8723 (org-float-time now))))
8724 ((= dcst ?s)
8725 (let ((end (save-excursion (outline-next-heading) (point))))
8726 (if (re-search-forward org-scheduled-time-regexp end t)
8727 (org-time-string-to-seconds (match-string 1))
8728 (org-float-time now))))
8729 ((= dcst ?d)
8730 (let ((end (save-excursion (outline-next-heading) (point))))
8731 (if (re-search-forward org-deadline-time-regexp end t)
8732 (org-time-string-to-seconds (match-string 1))
8733 (org-float-time now))))
8734 ((= dcst ?p)
8735 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8736 (string-to-char (match-string 2))
8737 org-default-priority))
8738 ((= dcst ?r)
8739 (or (org-entry-get nil property) ""))
8740 ((= dcst ?o)
8741 (if (looking-at org-complex-heading-regexp)
8742 (- 9999 (length (member (match-string 2)
8743 org-todo-keywords-1)))))
8744 ((= dcst ?f)
8745 (if getkey-func
8746 (progn
8747 (setq tmp (funcall getkey-func))
8748 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8749 tmp)
8750 (error "Invalid key function `%s'" getkey-func)))
8751 (t (error "Invalid sorting type `%c'" sorting-type))))
8752 nil
8753 (cond
8754 ((= dcst ?a) 'string<)
8755 ((= dcst ?f) compare-func)
8756 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8757 (run-hooks 'org-after-sorting-entries-or-items-hook)
8758 ;; Reset the clock marker if needed
8759 (when cmstr
8760 (save-excursion
8761 (goto-char start)
8762 (search-forward cmstr nil t)
8763 (move-marker org-clock-marker (point))))
8764 (message "Sorting entries...done")))
8766 (defun org-do-sort (table what &optional with-case sorting-type)
8767 "Sort TABLE of WHAT according to SORTING-TYPE.
8768 The user will be prompted for the SORTING-TYPE if the call to this
8769 function does not specify it. WHAT is only for the prompt, to indicate
8770 what is being sorted. The sorting key will be extracted from
8771 the car of the elements of the table.
8772 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8773 (unless sorting-type
8774 (message
8775 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8776 what)
8777 (setq sorting-type (read-char-exclusive)))
8778 (let ((dcst (downcase sorting-type))
8779 extractfun comparefun)
8780 ;; Define the appropriate functions
8781 (cond
8782 ((= dcst ?n)
8783 (setq extractfun 'string-to-number
8784 comparefun (if (= dcst sorting-type) '< '>)))
8785 ((= dcst ?a)
8786 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8787 (lambda(x) (downcase (org-sort-remove-invisible x))))
8788 comparefun (if (= dcst sorting-type)
8789 'string<
8790 (lambda (a b) (and (not (string< a b))
8791 (not (string= a b)))))))
8792 ((= dcst ?t)
8793 (setq extractfun
8794 (lambda (x)
8795 (if (or (string-match org-ts-regexp x)
8796 (string-match org-ts-regexp-both x))
8797 (org-float-time
8798 (org-time-string-to-time (match-string 0 x)))
8799 0))
8800 comparefun (if (= dcst sorting-type) '< '>)))
8801 (t (error "Invalid sorting type `%c'" sorting-type)))
8803 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8804 table)
8805 (lambda (a b) (funcall comparefun (car a) (car b))))))
8808 ;;; The orgstruct minor mode
8810 ;; Define a minor mode which can be used in other modes in order to
8811 ;; integrate the org-mode structure editing commands.
8813 ;; This is really a hack, because the org-mode structure commands use
8814 ;; keys which normally belong to the major mode. Here is how it
8815 ;; works: The minor mode defines all the keys necessary to operate the
8816 ;; structure commands, but wraps the commands into a function which
8817 ;; tests if the cursor is currently at a headline or a plain list
8818 ;; item. If that is the case, the structure command is used,
8819 ;; temporarily setting many Org-mode variables like regular
8820 ;; expressions for filling etc. However, when any of those keys is
8821 ;; used at a different location, function uses `key-binding' to look
8822 ;; up if the key has an associated command in another currently active
8823 ;; keymap (minor modes, major mode, global), and executes that
8824 ;; command. There might be problems if any of the keys is otherwise
8825 ;; used as a prefix key.
8827 (defcustom orgstruct-heading-prefix-regexp nil
8828 "Regexp that matches the custom prefix of Org headlines in
8829 orgstruct(++)-mode."
8830 :group 'org
8831 :version "24.4"
8832 :package-version '(Org . "8.0")
8833 :type 'string)
8834 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8836 (defcustom orgstruct-setup-hook nil
8837 "Hook run after orgstruct-mode-map is filled."
8838 :group 'org
8839 :version "24.4"
8840 :package-version '(Org . "8.0")
8841 :type 'hook)
8843 (defvar orgstruct-initialized nil)
8845 (defvar org-local-vars nil
8846 "List of local variables, for use by `orgstruct-mode'.")
8848 ;;;###autoload
8849 (define-minor-mode orgstruct-mode
8850 "Toggle the minor mode `orgstruct-mode'.
8851 This mode is for using Org-mode structure commands in other
8852 modes. The following keys behave as if Org-mode were active, if
8853 the cursor is on a headline, or on a plain list item (both as
8854 defined by Org-mode)."
8855 nil " OrgStruct" (make-sparse-keymap)
8856 (funcall (if orgstruct-mode
8857 'add-to-invisibility-spec
8858 'remove-from-invisibility-spec)
8859 '(outline . t))
8860 (when orgstruct-mode
8861 (org-load-modules-maybe)
8862 (unless orgstruct-initialized
8863 (orgstruct-setup)
8864 (setq orgstruct-initialized t))))
8866 ;;;###autoload
8867 (defun turn-on-orgstruct ()
8868 "Unconditionally turn on `orgstruct-mode'."
8869 (orgstruct-mode 1))
8871 (defvar org-fb-vars nil)
8872 (make-variable-buffer-local 'org-fb-vars)
8873 (defun orgstruct++-mode (&optional arg)
8874 "Toggle `orgstruct-mode', the enhanced version of it.
8875 In addition to setting orgstruct-mode, this also exports all
8876 indentation and autofilling variables from org-mode into the
8877 buffer. It will also recognize item context in multiline items."
8878 (interactive "P")
8879 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8880 (if (< arg 1)
8881 (progn (orgstruct-mode -1)
8882 (mapc (lambda(v)
8883 (org-set-local (car v)
8884 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8885 org-fb-vars))
8886 (orgstruct-mode 1)
8887 (setq org-fb-vars nil)
8888 (unless org-local-vars
8889 (setq org-local-vars (org-get-local-variables)))
8890 (let (var val)
8891 (mapc
8892 (lambda (x)
8893 (when (string-match
8895 (symbol-name (car x)))
8896 (setq var (car x) val (nth 1 x))
8897 (push (list var `(quote ,(eval var))) org-fb-vars)
8898 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8899 org-local-vars)
8900 (org-set-local 'orgstruct-is-++ t))))
8902 (defvar orgstruct-is-++ nil
8903 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8904 (make-variable-buffer-local 'orgstruct-is-++)
8906 ;;;###autoload
8907 (defun turn-on-orgstruct++ ()
8908 "Unconditionally turn on `orgstruct++-mode'."
8909 (orgstruct++-mode 1))
8911 (defun orgstruct-error ()
8912 "Error when there is no default binding for a structure key."
8913 (interactive)
8914 (funcall (if (fboundp 'user-error)
8915 'user-error
8916 'error)
8917 "This key has no function outside structure elements"))
8919 (defun orgstruct-setup ()
8920 "Setup orgstruct keymap."
8921 (dolist (cell '((org-demote . t)
8922 (org-metaleft . t)
8923 (org-metaright . t)
8924 (org-promote . t)
8925 (org-shiftmetaleft . t)
8926 (org-shiftmetaright . t)
8927 org-backward-element
8928 org-backward-heading-same-level
8929 org-ctrl-c-ret
8930 org-ctrl-c-minus
8931 org-ctrl-c-star
8932 org-cycle
8933 org-forward-heading-same-level
8934 org-insert-heading
8935 org-insert-heading-respect-content
8936 org-kill-note-or-show-branches
8937 org-mark-subtree
8938 org-meta-return
8939 org-metadown
8940 org-metaup
8941 org-narrow-to-subtree
8942 org-promote-subtree
8943 org-reveal
8944 org-shiftdown
8945 org-shiftleft
8946 org-shiftmetadown
8947 org-shiftmetaup
8948 org-shiftright
8949 org-shifttab
8950 org-shifttab
8951 org-shiftup
8952 org-show-subtree
8953 org-sort
8954 org-up-element
8955 outline-demote
8956 outline-next-visible-heading
8957 outline-previous-visible-heading
8958 outline-promote
8959 outline-up-heading
8960 show-children))
8961 (let ((f (or (car-safe cell) cell))
8962 (disable-when-heading-prefix (cdr-safe cell)))
8963 (when (fboundp f)
8964 (let ((new-bindings))
8965 (dolist (binding (nconc (where-is-internal f org-mode-map)
8966 (where-is-internal f outline-mode-map)))
8967 (push binding new-bindings)
8968 ;; TODO use local-function-key-map
8969 (dolist (rep '(("<tab>" . "TAB")
8970 ("<return>" . "RET")
8971 ("<escape>" . "ESC")
8972 ("<delete>" . "DEL")))
8973 (setq binding (read-kbd-macro
8974 (let ((case-fold-search))
8975 (replace-regexp-in-string
8976 (regexp-quote (cdr rep))
8977 (car rep)
8978 (key-description binding)))))
8979 (pushnew binding new-bindings :test 'equal)))
8980 (dolist (binding new-bindings)
8981 (let ((key (lookup-key orgstruct-mode-map binding)))
8982 (when (or (not key) (numberp key))
8983 (condition-case nil
8984 (org-defkey orgstruct-mode-map
8985 binding
8986 (orgstruct-make-binding f binding disable-when-heading-prefix))
8987 (error nil)))))))))
8988 (run-hooks 'orgstruct-setup-hook))
8990 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
8991 "Create a function for binding in the structure minor mode.
8992 FUN is the command to call inside a table. KEY is the key that
8993 should be checked in for a command to execute outside of tables.
8994 Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
8995 if `orgstruct-heading-prefix-regexp' is non-nil."
8996 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
8997 (let ((nname name)
8998 (i 0))
8999 (while (fboundp (intern nname))
9000 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9001 (setq name (intern nname)))
9002 (eval
9003 (let ((bindings '((org-heading-regexp
9004 (concat "^"
9005 orgstruct-heading-prefix-regexp
9007 (org-outline-regexp
9009 (org-outline-regexp-bol
9010 (concat "^" org-outline-regexp))
9011 (outline-regexp org-outline-regexp)
9013 (outline-level 'org-outline-level)
9014 (outline-heading-alist))))
9015 `(defun ,name (arg)
9017 "Outside of structure, run the binding of `"
9018 (key-description key) "'."
9019 (when disable-when-heading-prefix
9020 (concat
9023 "`" (symbol-name fun) "'.")))
9024 (interactive "p")
9025 (let* ((disable
9026 ,(when disable-when-heading-prefix
9027 '(and orgstruct-heading-prefix-regexp
9028 (not (string= orgstruct-heading-prefix-regexp "")))))
9029 (fallback
9030 (or disable
9031 (not
9032 (let* ,bindings
9033 (org-context-p 'headline 'item
9034 ,(when (memq fun
9035 '(org-insert-heading
9036 org-insert-heading-respect-content
9037 org-meta-return))
9038 '(when orgstruct-is-++
9039 'item-body))))))))
9040 (if fallback
9041 (let* ((orgstruct-mode)
9042 (binding
9043 (loop with key = ,key
9044 for rep in
9045 '(nil
9050 do
9051 (when rep
9052 (setq key (read-kbd-macro
9053 (let ((case-fold-search))
9054 (replace-regexp-in-string
9055 (car rep)
9056 (cdr rep)
9057 (key-description key))))))
9058 thereis (key-binding key))))
9059 (if (keymapp binding)
9060 (set-temporary-overlay-map binding)
9061 (let ((func (or binding
9062 (unless disable
9063 'orgstruct-error))))
9064 (when func
9065 (call-interactively func)))))
9066 (org-run-like-in-org-mode
9067 (lambda ()
9068 (interactive)
9069 (let* ,bindings
9070 (call-interactively ',fun)))))))))
9071 name))
9073 (defun org-contextualize-keys (alist contexts)
9074 "Return valid elements in ALIST depending on CONTEXTS.
9076 `org-agenda-custom-commands' or `org-capture-templates' are the
9077 values used for ALIST, and `org-agenda-custom-commands-contexts'
9078 or `org-capture-templates-contexts' are the associated contexts
9079 definitions."
9080 (let ((contexts
9081 ;; normalize contexts
9082 (mapcar
9083 (lambda(c) (cond ((listp (cadr c))
9084 (list (car c) (car c) (cadr c)))
9085 ((string= "" (cadr c))
9086 (list (car c) (car c) (caddr c)))
9087 (t c))) contexts))
9088 (a alist) c r s)
9089 ;; loop over all commands or templates
9090 (while (setq c (pop a))
9091 (let (vrules repl)
9092 (cond
9093 ((not (assoc (car c) contexts))
9094 (push c r))
9095 ((and (assoc (car c) contexts)
9096 (setq vrules (org-contextualize-validate-key
9097 (car c) contexts)))
9098 (mapc (lambda (vr)
9099 (when (not (equal (car vr) (cadr vr)))
9100 (setq repl vr))) vrules)
9101 (if (not repl) (push c r)
9102 (push (cadr repl) s)
9103 (push
9104 (cons (car c)
9105 (cdr (or (assoc (cadr repl) alist)
9106 (error "Undefined key `%s' as contextual replacement for `%s'"
9107 (cadr repl) (car c)))))
9108 r))))))
9109 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9110 (delq
9111 nil
9112 (delete-dups
9113 (mapcar (lambda (x)
9114 (let ((tpl (car x)))
9115 (when (not (delq
9116 nil
9117 (mapcar (lambda(y)
9118 (equal y tpl)) s))) x)))
9119 (reverse r))))))
9121 (defun org-contextualize-validate-key (key contexts)
9122 "Check CONTEXTS for agenda or capture KEY."
9123 (let (r rr res)
9124 (while (setq r (pop contexts))
9125 (mapc
9126 (lambda (rr)
9127 (when
9128 (and (equal key (car r))
9129 (if (functionp rr) (funcall rr)
9130 (or (and (eq (car rr) 'in-file)
9131 (buffer-file-name)
9132 (string-match (cdr rr) (buffer-file-name)))
9133 (and (eq (car rr) 'in-mode)
9134 (string-match (cdr rr) (symbol-name major-mode)))
9135 (and (eq (car rr) 'in-buffer)
9136 (string-match (cdr rr) (buffer-name)))
9137 (when (and (eq (car rr) 'not-in-file)
9138 (buffer-file-name))
9139 (not (string-match (cdr rr) (buffer-file-name))))
9140 (when (eq (car rr) 'not-in-mode)
9141 (not (string-match (cdr rr) (symbol-name major-mode))))
9142 (when (eq (car rr) 'not-in-buffer)
9143 (not (string-match (cdr rr) (buffer-name)))))))
9144 (push r res)))
9145 (car (last r))))
9146 (delete-dups (delq nil res))))
9148 (defun org-context-p (&rest contexts)
9149 "Check if local context is any of CONTEXTS.
9150 Possible values in the list of contexts are `table', `headline', and `item'."
9151 (let ((pos (point)))
9152 (goto-char (point-at-bol))
9153 (prog1 (or (and (memq 'table contexts)
9155 (and (memq 'headline contexts)
9156 (looking-at org-outline-regexp))
9157 (and (memq 'item contexts)
9159 (and (memq 'item-body contexts)
9160 (org-in-item-p)))
9161 (goto-char pos))))
9163 (defun org-get-local-variables ()
9164 "Return a list of all local variables in an Org mode buffer."
9165 (let (varlist)
9166 (with-current-buffer (get-buffer-create "*Org tmp*")
9167 (erase-buffer)
9168 (org-mode)
9169 (setq varlist (buffer-local-variables)))
9170 (kill-buffer "*Org tmp*")
9171 (delq nil
9172 (mapcar
9173 (lambda (x)
9174 (setq x
9175 (if (symbolp x)
9176 (list x)
9177 (list (car x) (cdr x))))
9178 (if (and (not (get (car x) 'org-state))
9179 (string-match
9180 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9181 (symbol-name (car x))))
9182 x nil))
9183 varlist))))
9185 (defun org-clone-local-variables (from-buffer &optional regexp)
9186 "Clone local variables from FROM-BUFFER.
9187 Optional argument REGEXP selects variables to clone."
9188 (mapc
9189 (lambda (pair)
9190 (and (symbolp (car pair))
9191 (or (null regexp)
9192 (string-match regexp (symbol-name (car pair))))
9193 (set (make-local-variable (car pair))
9194 (cdr pair))))
9195 (buffer-local-variables from-buffer)))
9197 ;;;###autoload
9198 (defun org-run-like-in-org-mode (cmd)
9199 "Run a command, pretending that the current buffer is in Org-mode.
9200 This will temporarily bind local variables that are typically bound in
9201 Org-mode to the values they have in Org-mode, and then interactively
9202 call CMD."
9203 (org-load-modules-maybe)
9204 (unless org-local-vars
9205 (setq org-local-vars (org-get-local-variables)))
9206 (let (binds)
9207 (dolist (var org-local-vars)
9208 (when (or (not (boundp (car var)))
9209 (eq (symbol-value (car var))
9210 (default-value (car var))))
9211 (push (list (car var) `(quote ,(cadr var))) binds)))
9212 (eval `(let ,binds
9213 (call-interactively (quote ,cmd))))))
9215 ;;;; Archiving
9217 (defun org-get-category (&optional pos force-refresh)
9218 "Get the category applying to position POS."
9219 (save-match-data
9220 (if force-refresh (org-refresh-category-properties))
9221 (let ((pos (or pos (point))))
9222 (or (get-text-property pos 'org-category)
9223 (progn (org-refresh-category-properties)
9224 (get-text-property pos 'org-category))))))
9226 (defun org-refresh-category-properties ()
9227 "Refresh category text properties in the buffer."
9228 (let ((case-fold-search t)
9229 (inhibit-read-only t)
9230 (def-cat (cond
9231 ((null org-category)
9232 (if buffer-file-name
9233 (file-name-sans-extension
9234 (file-name-nondirectory buffer-file-name))
9235 "???"))
9236 ((symbolp org-category) (symbol-name org-category))
9237 (t org-category)))
9238 beg end cat pos optionp)
9239 (org-with-silent-modifications
9240 (save-excursion
9241 (save-restriction
9242 (widen)
9243 (goto-char (point-min))
9244 (put-text-property (point) (point-max) 'org-category def-cat)
9245 (while (re-search-forward
9247 (setq pos (match-end 0)
9248 optionp (equal (char-after (match-beginning 0)) ?#)
9249 cat (org-trim (match-string 2)))
9250 (if optionp
9251 (setq beg (point-at-bol) end (point-max))
9252 (org-back-to-heading t)
9253 (setq beg (point) end (org-end-of-subtree t t)))
9254 (put-text-property beg end 'org-category cat)
9255 (put-text-property beg end 'org-category-position beg)
9256 (goto-char pos)))))))
9258 (defun org-refresh-properties (dprop tprop)
9259 "Refresh buffer text properties.
9260 DPROP is the drawer property and TPROP is the corresponding text
9261 property to set."
9262 (let ((case-fold-search t)
9263 (inhibit-read-only t) p)
9264 (org-with-silent-modifications
9265 (save-excursion
9266 (save-restriction
9267 (widen)
9268 (goto-char (point-min))
9270 (setq p (org-match-string-no-properties 1))
9271 (save-excursion
9272 (org-back-to-heading t)
9273 (put-text-property
9274 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9277 ;;;; Link Stuff
9279 ;;; Link abbreviations
9281 (defun org-link-expand-abbrev (link)
9282 "Apply replacements as defined in `org-link-abbrev-alist'."
9284 (let* ((key (match-string 1 link))
9285 (as (or (assoc key org-link-abbrev-alist-local)
9286 (assoc key org-link-abbrev-alist)))
9287 (tag (and (match-end 2) (match-string 3 link)))
9288 rpl)
9289 (if (not as)
9290 link
9291 (setq rpl (cdr as))
9292 (cond
9293 ((symbolp rpl) (funcall rpl tag))
9295 (replace-match
9296 (save-match-data
9297 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9298 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9299 ((string-match "%h" rpl)
9300 (replace-match (url-hexify-string (or tag "")) t t rpl))
9301 (t (concat rpl tag)))))
9302 link))
9304 ;;; Storing and inserting links
9306 (defvar org-insert-link-history nil
9307 "Minibuffer history for links inserted with `org-insert-link'.")
9309 (defvar org-stored-links nil
9310 "Contains the links stored with `org-store-link'.")
9312 (defvar org-store-link-plist nil
9313 "Plist with info about the most recently link created with `org-store-link'.")
9315 (defvar org-link-protocols nil
9316 "Link protocols added to Org-mode using `org-add-link-type'.")
9318 (defvar org-store-link-functions nil
9319 "List of functions that are called to create and store a link.
9320 Each function will be called in turn until one returns a non-nil
9321 value. Each function should check if it is responsible for creating
9322 this link (for example by looking at the major mode).
9323 If not, it must exit and return nil.
9324 If yes, it should return a non-nil value after a calling
9325 `org-store-link-props' with a list of properties and values.
9326 Special properties are:
9330 This is obligatory as well.
9331 :description Optional default description for the second pair
9332 of brackets in an Org-mode link. The user can still change
9333 this when inserting this link into an Org-mode buffer.
9335 In addition to these, any additional properties can be specified
9336 and then used in capture templates.")
9338 (defun org-add-link-type (type &optional follow export)
9339 "Add TYPE to the list of `org-link-types'.
9340 Re-compute all regular expressions depending on `org-link-types'
9342 FOLLOW and EXPORT are two functions.
9344 FOLLOW should take the link path as the single argument and do whatever
9345 is necessary to follow the link, for example find a file or display
9346 a mail message.
9348 EXPORT should format the link path for export to one of the export formats.
9349 It should be a function accepting three arguments:
9352 desc the description of the link, if any, or a description added by
9353 org-export-normalize-links if there is none
9354 format the export format, a symbol like `html' or `latex' or `ascii'..
9356 The function may use the FORMAT information to return different values
9357 depending on the format. The return value will be put literally into
9358 the exported file. If the return value is nil, this means Org should
9359 do what it normally does with links which do not have EXPORT defined.
9361 Org-mode has a built-in default for exporting links. If you are happy with
9362 this default, there is no need to define an export function for the link
9363 type. For a simple example of an export function, see `org-bbdb.el'."
9364 (add-to-list 'org-link-types type t)
9365 (org-make-link-regexps)
9366 (if (assoc type org-link-protocols)
9367 (setcdr (assoc type org-link-protocols) (list follow export))
9368 (push (list type follow export) org-link-protocols)))
9370 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9371 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9373 ;;;###autoload
9374 (defun org-store-link (arg)
9376 This link is added to `org-stored-links' and can later be inserted
9379 For some link types, a prefix arg is interpreted.
9380 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9381 For file links, arg negates `org-context-in-file-links'.
9383 A double prefix arg force skipping storing functions that are not
9384 part of Org's core.
9386 A triple prefix arg force storing a link for each line in the
9387 active region."
9388 (interactive "P")
9389 (org-load-modules-maybe)
9390 (if (and (equal arg '(64)) (org-region-active-p))
9391 (save-excursion
9392 (let ((end (region-end)))
9393 (goto-char (region-beginning))
9394 (set-mark (point))
9395 (while (< (point-at-eol) end)
9396 (move-end-of-line 1) (activate-mark)
9397 (let (current-prefix-arg)
9398 (call-interactively 'org-store-link))
9399 (move-beginning-of-line 2)
9400 (set-mark (point)))))
9401 (org-with-limited-levels
9402 (setq org-store-link-plist nil)
9403 (let (link cpltxt desc description search
9404 txt custom-id agenda-link sfuns sfunsn)
9405 (cond
9407 ;; Store a link using an external link type
9408 ((and (not (equal arg '(16)))
9409 (setq sfuns
9410 (delq
9411 nil (mapcar (lambda (f)
9412 (let (fs) (if (funcall f) (push f fs))))
9413 org-store-link-functions))
9414 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9415 (or (and (cdr sfuns)
9416 (funcall (intern
9417 (completing-read
9418 "Which function for creating the link? "
9419 sfunsn t (car sfunsn)))))
9420 (funcall (caar sfuns)))
9421 (setq link (plist-get org-store-link-plist :link)
9422 desc (or (plist-get org-store-link-plist
9423 :description) link))))
9425 ;; Store a link from a source code buffer
9426 ((org-src-edit-buffer-p)
9427 (let (label gc)
9428 (while (or (not label)
9429 (save-excursion
9430 (save-restriction
9431 (widen)
9432 (goto-char (point-min))
9433 (re-search-forward
9434 (regexp-quote (format org-coderef-label-format label))
9435 nil t))))
9436 (when label (message "Label exists already") (sit-for 2))
9437 (setq label (read-string "Code line label: " label)))
9438 (end-of-line 1)
9439 (setq link (format org-coderef-label-format label))
9440 (setq gc (- 79 (length link)))
9441 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9442 (insert link)
9443 (setq link (concat "(" label ")") desc nil)))
9445 ;; We are in the agenda, link to referenced location
9446 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9447 (let ((m (or (get-text-property (point) 'org-hd-marker)
9448 (get-text-property (point) 'org-marker))))
9449 (when m
9450 (org-with-point-at m
9451 (setq agenda-link
9452 (if (org-called-interactively-p 'any)
9453 (call-interactively 'org-store-link)
9454 (org-store-link nil)))))))
9456 ((eq major-mode 'calendar-mode)
9457 (let ((cd (calendar-cursor-to-date)))
9458 (setq link
9459 (format-time-string
9460 (car org-time-stamp-formats)
9461 (apply 'encode-time
9462 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9463 nil nil nil))))
9464 (org-store-link-props :type "calendar" :date cd)))
9466 ((eq major-mode 'help-mode)
9467 (setq link (concat "help:" (save-excursion
9468 (goto-char (point-min))
9469 (looking-at "^[^ ]+")
9470 (match-string 0))))
9471 (org-store-link-props :type "help"))
9473 ((eq major-mode 'w3-mode)
9474 (setq cpltxt (if (and (buffer-name)
9475 (not (string-match "Untitled" (buffer-name))))
9476 (buffer-name)
9477 (url-view-url t))
9478 link (url-view-url t))
9479 (org-store-link-props :type "w3" :url (url-view-url t)))
9481 ((eq major-mode 'image-mode)
9482 (setq cpltxt (concat "file:"
9483 (abbreviate-file-name buffer-file-name))
9484 link cpltxt)
9485 (org-store-link-props :type "image" :file buffer-file-name))
9487 ;; In dired, store a link to the file of the current line
9488 ((eq major-mode 'dired-mode)
9489 (let ((file (dired-get-filename nil t)))
9490 (setq file (if file
9491 (abbreviate-file-name
9492 (expand-file-name (dired-get-filename nil t)))
9493 ;; otherwise, no file so use current directory.
9494 default-directory))
9495 (setq cpltxt (concat "file:" file)
9496 link cpltxt)))
9498 ((setq search (run-hook-with-args-until-success
9499 'org-create-file-search-functions))
9500 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9501 "::" search))
9502 (setq cpltxt (or description link)))
9504 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9505 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9506 (cond
9507 ;; Store a link using the target at point
9509 (setq cpltxt
9510 (concat "file:"
9511 (abbreviate-file-name
9512 (buffer-file-name (buffer-base-buffer)))
9513 "::" (match-string 1))
9514 link cpltxt))
9515 ((and (featurep 'org-id)
9516 (or (eq org-id-link-to-org-use-id t)
9517 (and (org-called-interactively-p 'any)
9518 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9519 (and (eq org-id-link-to-org-use-id
9520 'create-if-interactive-and-no-custom-id)
9521 (not custom-id))))
9522 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9523 ;; Store a link using the ID at point
9524 (setq link (condition-case nil
9525 (prog1 (org-id-store-link)
9526 (setq desc (plist-get org-store-link-plist
9527 :description)))
9528 (error
9529 ;; Probably before first headline, link only to file
9530 (concat "file:"
9531 (abbreviate-file-name
9532 (buffer-file-name (buffer-base-buffer))))))))
9533 (t
9534 ;; Just link to current headline
9535 (setq cpltxt (concat "file:"
9536 (abbreviate-file-name
9537 (buffer-file-name (buffer-base-buffer)))))
9538 ;; Add a context search string
9539 (when (org-xor org-context-in-file-links arg)
9540 (let* ((ee (org-element-at-point))
9541 (et (org-element-type ee))
9542 (ev (plist-get (cadr ee) :value))
9543 (ek (plist-get (cadr ee) :key))
9544 (eok (and (stringp ek) (string-match "name" ek))))
9545 (setq txt (cond
9546 ((org-at-heading-p) nil)
9547 ((and (eq et 'keyword) eok) ev)
9548 ((org-region-active-p)
9549 (buffer-substring (region-beginning) (region-end)))))
9551 (setq cpltxt
9552 (concat cpltxt "::"
9553 (condition-case nil
9554 (org-make-org-heading-search-string txt)
9555 (error "")))
9556 desc (or (and (eq et 'keyword) eok ev)
9557 (nth 4 (ignore-errors (org-heading-components)))
9558 "NONE")))))
9560 (setq cpltxt (substring cpltxt 0 -2)))
9561 (setq link cpltxt))))
9563 ((buffer-file-name (buffer-base-buffer))
9564 ;; Just link to this file here.
9565 (setq cpltxt (concat "file:"
9566 (abbreviate-file-name
9567 (buffer-file-name (buffer-base-buffer)))))
9568 ;; Add a context string.
9569 (when (org-xor org-context-in-file-links arg)
9570 (setq txt (if (org-region-active-p)
9571 (buffer-substring (region-beginning) (region-end))
9572 (buffer-substring (point-at-bol) (point-at-eol))))
9573 ;; Only use search option if there is some text.
9575 (setq cpltxt
9576 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9577 desc "NONE")))
9578 (setq link cpltxt))
9580 ((org-called-interactively-p 'interactive)
9581 (user-error "No method for storing a link from this buffer"))
9583 (t (setq link nil)))
9585 ;; We're done setting link and desc, clean up
9586 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9587 (setq link (or link cpltxt)
9588 desc (or desc cpltxt))
9589 (cond ((equal desc "NONE") (setq desc nil))
9590 ((string-match org-bracket-link-analytic-regexp desc)
9591 (let ((d0 (match-string 3 desc))
9592 (p0 (match-string 5 desc)))
9593 (setq desc
9594 (replace-regexp-in-string
9595 org-bracket-link-regexp
9596 (concat (or p0 d0)
9597 (if (equal (length (match-string 0 desc))
9598 (length desc)) "*" "")) desc)))))
9600 ;; Return the link
9601 (if (not (and (or (org-called-interactively-p 'any)
9602 executing-kbd-macro) link))
9603 (or agenda-link (and link (org-make-link-string link desc)))
9604 (push (list link desc) org-stored-links)
9605 (message "Stored: %s" (or desc link))
9606 (when custom-id
9607 (setq link (concat "file:" (abbreviate-file-name
9608 (buffer-file-name)) "::#" custom-id))
9609 (push (list link desc) org-stored-links)))))))
9611 (defun org-store-link-props (&rest plist)
9612 "Store link properties, extract names and addresses."
9613 (let (x adr)
9614 (when (setq x (plist-get plist :from))
9615 (setq adr (mail-extract-address-components x))
9616 (setq plist (plist-put plist :fromname (car adr)))
9617 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9618 (when (setq x (plist-get plist :to))
9619 (setq adr (mail-extract-address-components x))
9620 (setq plist (plist-put plist :toname (car adr)))
9621 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9622 (let ((from (plist-get plist :from))
9623 (to (plist-get plist :to)))
9624 (when (and from to org-from-is-user-regexp)
9625 (setq plist
9626 (plist-put plist :fromto
9627 (if (string-match org-from-is-user-regexp from)
9628 (concat "to %t")
9629 (concat "from %f"))))))
9630 (setq org-store-link-plist plist))
9632 (defun org-add-link-props (&rest plist)
9633 "Add these properties to the link property list."
9634 (let (key value)
9635 (while plist
9636 (setq key (pop plist) value (pop plist))
9637 (setq org-store-link-plist
9638 (plist-put org-store-link-plist key value)))))
9640 (defun org-email-link-description (&optional fmt)
9641 "Return the description part of an email link.
9642 This takes information from `org-store-link-plist' and formats it
9643 according to FMT (default from `org-email-link-description-format')."
9644 (setq fmt (or fmt org-email-link-description-format))
9645 (let* ((p org-store-link-plist)
9646 (to (plist-get p :toaddress))
9647 (from (plist-get p :fromaddress))
9648 (table
9649 (list
9650 (cons "%c" (plist-get p :fromto))
9651 (cons "%F" (plist-get p :from))
9652 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9653 (cons "%T" (plist-get p :to))
9654 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9655 (cons "%s" (plist-get p :subject))
9656 (cons "%d" (plist-get p :date))
9657 (cons "%m" (plist-get p :message-id)))))
9658 (when (string-match "%c" fmt)
9659 ;; Check if the user wrote this message
9660 (if (and org-from-is-user-regexp from to
9661 (save-match-data (string-match org-from-is-user-regexp from)))
9662 (setq fmt (replace-match "to %t" t t fmt))
9663 (setq fmt (replace-match "from %f" t t fmt))))
9664 (org-replace-escapes fmt table)))
9666 (defun org-make-org-heading-search-string (&optional string)
9667 "Make search string for the current headline or STRING."
9668 (let ((s (or string
9669 (and (derived-mode-p 'org-mode)
9670 (save-excursion
9671 (org-back-to-heading t)
9672 (org-element-property :raw-value (org-element-at-point))))))
9673 (lines org-context-in-file-links))
9674 (or string (setq s (concat "*" s))) ; Add * for headlines
9676 (when (and string (integerp lines) (> lines 0))
9678 (when (< lines (length slines))
9679 (setq s (mapconcat
9680 'identity
9681 (reverse (nthcdr (- (length slines) lines)
9685 (defun org-make-link-string (link &optional description)
9686 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9688 (error "Empty link"))
9689 (when (and description
9690 (stringp description)
9692 (setq description nil))
9693 (when (stringp description)
9694 ;; Remove brackets from the description, they are fatal.
9696 (setq description (replace-match "{" t t description)))
9698 (setq description (replace-match "}" t t description))))
9699 (when (equal link description)
9700 ;; No description needed, it is identical
9701 (setq description nil))
9702 (when (and (not description)
9703 (not (string-match (org-image-file-name-regexp) link))
9704 (not (equal link (org-link-escape link))))
9705 (setq description (org-extract-attributes link)))
9706 (setq link
9707 (cond ((string-match (org-image-file-name-regexp) link) link)
9708 ((string-match org-link-types-re link)
9709 (concat (match-string 1 link)
9710 (org-link-escape (substring link (match-end 1)))))
9711 (t (org-link-escape link))))
9712 (concat "[[" link "]"
9713 (if description (concat "[" description "]") "")
9714 "]"))
9716 (defconst org-link-escape-chars
9717 ;;%20 %2B %3B %3D %5B %5D
9718 '(?\ ?\+ ?\; ?\= ?\[ ?\])
9719 "List of characters that should be escaped in link.
9720 This is the list that is used for internal purposes.")
9722 (defconst org-link-escape-chars-browser
9723 ;;%20 %22
9725 "List of escapes for characters that are problematic in links.
9726 This is the list that is used before handing over to the browser.")
9728 (defun org-link-escape (text &optional table merge)
9729 "Return percent escaped representation of TEXT.
9730 TEXT is a string with the text to escape.
9731 Optional argument TABLE is a list with characters that should be
9732 escaped. When nil, `org-link-escape-chars' is used.
9733 If optional argument MERGE is set, merge TABLE into
9734 `org-link-escape-chars'."
9735 (cond
9736 ((and table merge)
9737 (mapc (lambda (defchr)
9738 (unless (member defchr table)
9739 (setq table (cons defchr table)))) org-link-escape-chars))
9740 ((null table)
9741 (setq table org-link-escape-chars)))
9742 (mapconcat
9743 (lambda (char)
9744 (if (or (member char table)
9745 (and (or (< char 32) (= char ?\%) (> char 126))
9746 org-url-hexify-p))
9747 (mapconcat (lambda (sequence-element)
9748 (format "%%%.2X" sequence-element))
9749 (or (encode-coding-char char 'utf-8)
9750 (error "Unable to percent escape character: %s"
9751 (char-to-string char))) "")
9752 (char-to-string char))) text ""))
9754 (defun org-link-escape-browser (text)
9755 (if (org-string-match-p
9756 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
9757 text)
9758 (org-link-escape text org-link-escape-chars-browser)
9759 text))
9761 (defun org-link-unescape (str)
9762 "Unhex hexified Unicode strings as returned from the JavaScript function
9763 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9764 (unless (and (null str) (string= "" str))
9765 (let ((pos 0) (case-fold-search t) unhexed)
9767 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9768 (setq str (replace-match unhexed t t str))
9769 (setq pos (+ pos (length unhexed))))))
9770 str)
9772 (defun org-link-unescape-compound (hex)
9773 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9774 Note: this function also decodes single byte encodings like
9775 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9776 (save-match-data
9777 (let* ((bytes (cdr (split-string hex "%")))
9778 (ret "")
9779 (eat 0)
9780 (sum 0))
9781 (while bytes
9782 (let* ((val (string-to-number (pop bytes) 16))
9783 (shift-xor
9784 (if (= 0 eat)
9785 (cond
9786 ((>= val 252) (cons 6 252))
9787 ((>= val 248) (cons 5 248))
9788 ((>= val 240) (cons 4 240))
9789 ((>= val 224) (cons 3 224))
9790 ((>= val 192) (cons 2 192))
9791 (t (cons 0 0)))
9792 (cons 6 128))))
9793 (if (>= val 192) (setq eat (car shift-xor)))
9794 (setq val (logxor val (cdr shift-xor)))
9795 (setq sum (+ (lsh sum (car shift-xor)) val))
9796 (if (> eat 0) (setq eat (- eat 1)))
9797 (cond
9798 ((= 0 eat) ;multi byte
9799 (setq ret (concat ret (org-char-to-string sum)))
9800 (setq sum 0))
9801 ((not bytes) ; single byte(s)
9802 (setq ret (org-link-unescape-single-byte-sequence hex))))
9803 )) ;; end (while bytes
9804 ret )))
9806 (defun org-link-unescape-single-byte-sequence (hex)
9807 "Unhexify hex-encoded single byte character sequences."
9808 (mapconcat (lambda (byte)
9809 (char-to-string (string-to-number byte 16)))
9810 (cdr (split-string hex "%")) ""))
9812 (defun org-xor (a b)
9813 "Exclusive or."
9814 (if a (not b) b))
9816 (defun org-fixup-message-id-for-http (s)
9817 "Replace special characters in a message id, so it can be used in an http query."
9818 (when (string-match "%" s)
9819 (setq s (mapconcat (lambda (c)
9820 (if (eq c ?%)
9821 "%25"
9822 (char-to-string c)))
9823 s "")))
9824 (while (string-match "<" s)
9825 (setq s (replace-match "%3C" t t s)))
9826 (while (string-match ">" s)
9827 (setq s (replace-match "%3E" t t s)))
9828 (while (string-match "@" s)
9829 (setq s (replace-match "%40" t t s)))
9830 s)
9832 (defun org-link-prettify (link)
9833 "Return a human-readable representation of LINK.
9834 The car of LINK must be a raw link the cdr of LINK must be either
9835 a link description or nil."
9836 (let ((desc (or (cadr link) "<no description>")))
9837 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9838 "<" (car link) ">")))
9840 ;;;###autoload
9841 (defun org-insert-link-global ()
9842 "Insert a link like Org-mode does.
9843 This command can be called in any mode to insert a link in Org-mode syntax."
9844 (interactive)
9845 (org-load-modules-maybe)
9846 (org-run-like-in-org-mode 'org-insert-link))
9848 (defun org-insert-all-links (&optional keep)
9849 "Insert all links in `org-stored-links'."
9850 (interactive "P")
9851 (let ((links (copy-sequence org-stored-links)) l)
9852 (while (setq l (if keep (pop links) (pop org-stored-links)))
9853 (insert "- ")
9854 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9857 (defun org-link-fontify-links-to-this-file ()
9858 "Fontify links to the current file in `org-stored-links'."
9859 (let ((f (buffer-file-name)) a b)
9860 (setq a (mapcar (lambda(l)
9861 (let ((ll (car l)))
9863 (equal f (expand-file-name (match-string 1 ll))))
9864 ll)))
9865 org-stored-links))
9866 (when (featurep 'org-id)
9867 (setq b (mapcar (lambda(l)
9868 (let ((ll (car l)))
9870 (equal f (expand-file-name
9871 (or (org-id-find-id-file
9872 (match-string 1 ll)) ""))))
9873 ll)))
9874 org-stored-links)))
9875 (mapcar (lambda(l)
9876 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9877 (delq nil (append a b)))))
9879 (defvar org-link-links-in-this-file nil)
9880 (defun org-insert-link (&optional complete-file link-location default-description)
9881 "Insert a link. At the prompt, enter the link.
9883 Completion can be used to insert any of the link protocol prefixes like
9884 http or ftp in use.
9886 The history can be used to select a link previously stored with
9887 `org-store-link'. When the empty string is entered (i.e. if you just
9888 press RET at the prompt), the link defaults to the most recently
9889 stored link. As SPC triggers completion in the minibuffer, you need to
9890 use M-SPC or C-q SPC to force the insertion of a space character.
9892 You will also be prompted for a description, and if one is given, it will
9893 be displayed in the buffer instead of the link.
9895 If there is already a link at point, this command will allow you to edit link
9896 and description parts.
9899 be selected using completion. The path to the file will be relative to the
9900 current directory if the file is in the current directory or a subdirectory.
9901 Otherwise, the link will be the absolute path as completed in the minibuffer
9902 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9903 option `org-link-file-path-type'.
9906 the current directory or below.
9909 `org-keep-stored-link-after-insertion'.
9911 If `org-make-link-description-function' is non-nil, this function will be
9912 called with the link target, and the result will be the default
9913 link description.
9915 If the LINK-LOCATION parameter is non-nil, this value will be
9916 used as the link location instead of reading one interactively.
9918 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9919 be used as the default description."
9920 (interactive "P")
9921 (let* ((wcf (current-window-configuration))
9922 (origbuf (current-buffer))
9923 (region (if (org-region-active-p)
9924 (buffer-substring (region-beginning) (region-end))))
9925 (remove (and region (list (region-beginning) (region-end))))
9926 (desc region)
9927 tmphist ; byte-compile incorrectly complains about this
9928 (link link-location)
9929 (abbrevs org-link-abbrev-alist-local)
9930 entry file all-prefixes auto-desc)
9931 (cond
9932 (link-location) ; specified by arg, just use it.
9933 ((org-in-regexp org-bracket-link-regexp 1)
9934 ;; We do have a link at point, and we are going to edit it.
9935 (setq remove (list (match-beginning 0) (match-end 0)))
9936 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9937 (setq link (read-string "Link: "
9938 (org-link-unescape
9939 (org-match-string-no-properties 1)))))
9940 ((or (org-in-regexp org-angle-link-re)
9941 (org-in-regexp org-plain-link-re))
9942 ;; Convert to bracket link
9943 (setq remove (list (match-beginning 0) (match-end 0))
9944 link (read-string "Link: "
9945 (org-remove-angle-brackets (match-string 0)))))
9946 ((member complete-file '((4) (16)))
9947 ;; Completing read for file names.
9948 (setq link (org-file-complete-link complete-file)))
9949 (t
9950 ;; Read link, with completion for stored links.
9951 (org-link-fontify-links-to-this-file)
9952 (org-switch-to-buffer-other-window "*Org Links*")
9953 (with-current-buffer "*Org Links*"
9954 (erase-buffer)
9955 (insert "Insert a link.
9957 (when org-stored-links
9959 (insert (mapconcat 'org-link-prettify
9961 (goto-char (point-min)))
9962 (let ((cw (selected-window)))
9963 (select-window (get-buffer-window "*Org Links*" 'visible))
9964 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9965 (unless (pos-visible-in-window-p (point-max))
9966 (org-fit-window-to-buffer))
9967 (and (window-live-p cw) (select-window cw)))
9968 ;; Fake a link history, containing the stored links.
9969 (setq tmphist (append (mapcar 'car org-stored-links)
9970 org-insert-link-history))
9971 (setq all-prefixes (append (mapcar 'car abbrevs)
9972 (mapcar 'car org-link-abbrev-alist)
9973 org-link-types))
9974 (unwind-protect
9975 (progn
9976 (setq link
9977 (org-completing-read
9978 "Link: "
9979 (append
9980 (mapcar (lambda (x) (concat x ":"))
9981 all-prefixes)
9982 (mapcar 'car org-stored-links))
9983 nil nil nil
9984 'tmphist
9985 (caar org-stored-links)))
9987 (user-error "No link selected"))
9988 (mapc (lambda(l)
9989 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9990 org-stored-links)
9991 (if (or (member link all-prefixes)
9992 (and (equal ":" (substring link -1))
9993 (member (substring link 0 -1) all-prefixes)
9994 (setq link (substring link 0 -1))))
9995 (setq link (with-current-buffer origbuf
9996 (org-link-try-special-completion link)))))
9997 (set-window-configuration wcf)
9998 (kill-buffer "*Org Links*"))
9999 (setq entry (assoc link org-stored-links))
10000 (or entry (push link org-insert-link-history))
10001 (setq desc (or desc (nth 1 entry)))))
10003 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10004 (not org-keep-stored-link-after-insertion))
10005 (setq org-stored-links (delq (assoc link org-stored-links)
10006 org-stored-links)))
10008 (if (string-match org-plain-link-re link)
10009 ;; URL-like link, normalize the use of angular brackets.
10010 (setq link (org-remove-angle-brackets link)))
10012 ;; Check if we are linking to the current file with a search
10013 ;; option If yes, simplify the link by using only the search
10014 ;; option.
10015 (when (and buffer-file-name
10017 (let* ((path (match-string 1 link))
10018 (case-fold-search nil)
10019 (search (match-string 2 link)))
10020 (save-match-data
10021 (if (equal (file-truename buffer-file-name) (file-truename path))
10022 ;; We are linking to this same file, with a search option
10023 (setq link search)))))
10025 ;; Check if we can/should use a relative path. If yes, simplify the link
10027 (let* ((type (match-string 1 link))
10028 (path (match-string 2 link))
10029 (origpath path)
10030 (case-fold-search nil))
10031 (cond
10032 ((or (eq org-link-file-path-type 'absolute)
10033 (equal complete-file '(16)))
10034 (setq path (abbreviate-file-name (expand-file-name path))))
10035 ((eq org-link-file-path-type 'noabbrev)
10036 (setq path (expand-file-name path)))
10037 ((eq org-link-file-path-type 'relative)
10038 (setq path (file-relative-name path)))
10039 (t
10040 (save-match-data
10041 (if (string-match (concat "^" (regexp-quote
10042 (expand-file-name
10043 (file-name-as-directory
10044 default-directory))))
10045 (expand-file-name path))
10046 ;; We are linking a file with relative path name.
10047 (setq path (substring (expand-file-name path)
10048 (match-end 0)))
10049 (setq path (abbreviate-file-name (expand-file-name path)))))))
10050 (setq link (concat type path))
10051 (if (equal desc origpath)
10052 (setq desc path))))
10054 (if org-make-link-description-function
10055 (setq desc
10056 (or (condition-case nil
10057 (funcall org-make-link-description-function link desc)
10058 (error (progn (message "Can't get link description from `%s'"
10059 (symbol-name org-make-link-description-function))
10060 (sit-for 2) nil)))
10061 (read-string "Description: " default-description)))
10062 (if default-description (setq desc default-description)
10063 (setq desc (or (and auto-desc desc)
10064 (read-string "Description: " desc)))))
10067 (if remove (apply 'delete-region remove))
10068 (insert (org-make-link-string link desc))))
10070 (defun org-link-try-special-completion (type)
10071 "If there is completion support for link type TYPE, offer it."
10072 (let ((fun (intern (concat "org-" type "-complete-link"))))
10073 (if (functionp fun)
10074 (funcall fun)
10075 (read-string "Link (no completion support): " (concat type ":")))))
10077 (defun org-file-complete-link (&optional arg)
10078 "Create a file link using completion."
10079 (let (file link)
10080 (setq file (org-iread-file-name "File: "))
10081 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10082 (pwd1 (file-name-as-directory (abbreviate-file-name
10083 (expand-file-name ".")))))
10084 (cond
10085 ((equal arg '(16))
10086 (setq link (concat
10087 "file:"
10088 (abbreviate-file-name (expand-file-name file)))))
10090 (setq link (concat "file:" (match-string 1 file))))
10092 (expand-file-name file))
10093 (setq link (concat
10094 "file:" (match-string 1 (expand-file-name file)))))
10095 (t (setq link (concat "file:" file)))))
10096 link))
10098 (defun org-iread-file-name (&rest args)
10099 "Read-file-name using `ido-mode' speedup if available.
10100 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10101 See `read-file-name' for a description of parameters."
10102 (org-without-partial-completion
10103 (if (and org-completion-use-ido
10104 (fboundp 'ido-read-file-name)
10105 (boundp 'ido-mode) ido-mode
10106 (listp (second args)))
10107 (let ((ido-enter-matching-directory nil))
10108 (apply 'ido-read-file-name args))
10109 (apply 'read-file-name args))))
10111 (defun org-completing-read (&rest args)
10112 "Completing-read with SPACE being a normal character."
10113 (let ((enable-recursive-minibuffers t)
10114 (minibuffer-local-completion-map
10115 (copy-keymap minibuffer-local-completion-map)))
10116 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10117 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10118 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10119 (apply 'org-icompleting-read args)))
10121 (defun org-completing-read-no-i (&rest args)
10122 (let (org-completion-use-ido org-completion-use-iswitchb)
10123 (apply 'org-completing-read args)))
10125 (defun org-iswitchb-completing-read (prompt choices &rest args)
10126 "Use iswitch as a completing-read replacement to choose from choices.
10127 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10128 from."
10129 (let* ((iswitchb-use-virtual-buffers nil)
10130 (iswitchb-make-buflist-hook
10131 (lambda ()
10132 (setq iswitchb-temp-buflist choices))))
10133 (iswitchb-read-buffer prompt)))
10135 (defun org-icompleting-read (&rest args)
10136 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10137 (org-without-partial-completion
10138 (if (and org-completion-use-ido
10139 (fboundp 'ido-completing-read)
10140 (boundp 'ido-mode) ido-mode
10141 (listp (second args)))
10142 (let ((ido-enter-matching-directory nil))
10143 (apply 'ido-completing-read (concat (car args))
10144 (if (consp (car (nth 1 args)))
10145 (mapcar 'car (nth 1 args))
10146 (nth 1 args))
10147 (cddr args)))
10148 (if (and org-completion-use-iswitchb
10149 (boundp 'iswitchb-mode) iswitchb-mode
10150 (listp (second args)))
10151 (apply 'org-iswitchb-completing-read (concat (car args))
10152 (if (consp (car (nth 1 args)))
10153 (mapcar 'car (nth 1 args))
10154 (nth 1 args))
10155 (cddr args))
10156 (apply 'completing-read args)))))
10158 (defun org-extract-attributes (s)
10159 "Extract the attributes cookie from a string and set as text property."
10160 (let (a attr (start 0) key value)
10161 (save-match-data
10163 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10165 (setq key (match-string 1 a) value (match-string 2 a)
10166 start (match-end 0)
10167 attr (plist-put attr (intern key) value))))
10168 (org-add-props s nil 'org-attr attr))
10169 s))
10171 ;;; Opening/following a link
10173 (defvar org-link-search-failed nil)
10175 (defvar org-open-link-functions nil
10176 "Hook for functions finding a plain text link.
10177 These functions must take a single argument, the link content.
10178 They will be called for links that look like [[link text][description]]
10182 These functions will be called *before* Org attempts to resolve the
10183 link by doing text searches in the current buffer - so if you want a
10185 handle this as a special case.
10187 When the function does handle the link, it must return a non-nil value.
10188 If it decides that it is not responsible for this link, it must return
10189 nil to indicate that that Org-mode can continue with other options
10190 like exact and fuzzy text search.")
10192 (defun org-next-link (&optional search-backward)
10193 "Move forward to the next link.
10194 If the link is in hidden text, expose it."
10195 (interactive "P")
10196 (when (and org-link-search-failed (eq this-command last-command))
10197 (goto-char (point-min))
10198 (message "Link search wrapped back to beginning of buffer"))
10199 (setq org-link-search-failed nil)
10200 (let* ((pos (point))
10201 (ct (org-context))
10202 (a (assoc :link ct))
10203 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10204 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10205 ((looking-at org-any-link-re)
10206 ;; Don't stay stuck at link without an org-link face
10207 (forward-char (if search-backward -1 1))))
10208 (if (funcall srch-fun org-any-link-re nil t)
10209 (progn
10210 (goto-char (match-beginning 0))
10211 (if (outline-invisible-p) (org-show-context)))
10212 (goto-char pos)
10213 (setq org-link-search-failed t)
10214 (message "No further link found"))))
10216 (defun org-previous-link ()
10217 "Move backward to the previous link.
10218 If the link is in hidden text, expose it."
10219 (interactive)
10220 (funcall 'org-next-link t))
10222 (defun org-translate-link (s)
10223 "Translate a link string if a translation function has been defined."
10224 (if (and org-link-translation-function
10225 (fboundp org-link-translation-function)
10227 (progn
10228 (setq s (funcall org-link-translation-function
10229 (match-string 1 s) (match-string 2 s)))
10230 (concat (car s) ":" (cdr s)))
10231 s))
10233 (defun org-translate-link-from-planner (type path)
10234 "Translate a link from Emacs Planner syntax so that Org can follow it.
10235 This is still an experimental function, your mileage may vary."
10236 (cond
10237 ((member type '("http" "https" "news" "ftp"))
10238 ;; standard Internet links are the same.
10239 nil)
10240 ((and (equal type "irc") (string-match "^//" path))
10241 ;; Planner has two / at the beginning of an irc link, we have 1.
10242 ;; We should have zero, actually....
10243 (setq path (substring path 1)))
10244 ((and (equal type "lisp") (string-match "^/" path))
10245 ;; Planner has a slash, we do not.
10246 (setq type "elisp" path (substring path 1)))
10248 ;; A typical message link. Planner has the id after the final slash,
10249 ;; we separate it with a hash mark
10250 (setq path (concat (match-string 1 path) "#"
10251 (org-remove-angle-brackets (match-string 2 path))))))
10252 (cons type path))
10254 (defun org-find-file-at-mouse (ev)
10255 "Open file link or URL at mouse."
10256 (interactive "e")
10257 (mouse-set-point ev)
10258 (org-open-at-point 'in-emacs))
10260 (defun org-open-at-mouse (ev)
10261 "Open file link or URL at mouse.
10262 See the docstring of `org-open-file' for details."
10263 (interactive "e")
10264 (mouse-set-point ev)
10265 (if (eq major-mode 'org-agenda-mode)
10266 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10267 (org-open-at-point))
10269 (defvar org-window-config-before-follow-link nil
10270 "The window configuration before following a link.
10271 This is saved in case the need arises to restore it.")
10273 (defvar org-open-link-marker (make-marker)
10274 "Marker pointing to the location where `org-open-at-point; was called.")
10276 ;;;###autoload
10277 (defun org-open-at-point-global ()
10278 "Follow a link like Org-mode does.
10279 This command can be called in any mode to follow a link that has
10280 Org-mode syntax."
10281 (interactive)
10282 (org-run-like-in-org-mode 'org-open-at-point))
10284 ;;;###autoload
10285 (defun org-open-link-from-string (s &optional arg reference-buffer)
10286 "Open a link in the string S, as if it was in Org-mode."
10288 (let ((reference-buffer (or reference-buffer (current-buffer))))
10289 (with-temp-buffer
10290 (let ((org-inhibit-startup (not reference-buffer)))
10291 (org-mode)
10292 (insert s)
10293 (goto-char (point-min))
10294 (when reference-buffer
10295 (setq org-link-abbrev-alist-local
10296 (with-current-buffer reference-buffer
10297 org-link-abbrev-alist-local)))
10298 (org-open-at-point arg reference-buffer)))))
10300 (defvar org-open-at-point-functions nil
10301 "Hook that is run when following a link at point.
10303 Functions in this hook must return t if they identify and follow
10304 a link at point. If they don't find anything interesting at point,
10305 they must return nil.")
10307 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10308 (defun org-open-at-point (&optional arg reference-buffer)
10309 "Open link at or after point.
10310 If there is no link at point, this function will search forward up to
10311 the end of the current line.
10312 Normally, files will be opened by an appropriate application. If the
10313 optional prefix argument ARG is non-nil, Emacs will visit the file.
10314 With a double prefix argument, try to open outside of Emacs, in the
10315 application the system uses for this file type."
10316 (interactive "P")
10317 ;; if in a code block, then open the block's results
10318 (unless (call-interactively #'org-babel-open-src-block-result)
10319 (org-load-modules-maybe)
10320 (move-marker org-open-link-marker (point))
10321 (setq org-window-config-before-follow-link (current-window-configuration))
10322 (org-remove-occur-highlights nil nil t)
10323 (cond
10324 ((and (org-at-heading-p)
10325 (not (org-at-timestamp-p t))
10326 (not (org-in-regexp
10331 (not (get-text-property (point) 'org-linked-text)))
10332 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10333 (lk0 (car lkall))
10334 (lk (if (stringp lk0) (list lk0) lk0))
10335 (lkend (cdr lkall)))
10336 (mapcar (lambda(l)
10337 (search-forward l nil lkend)
10338 (goto-char (match-beginning 0))
10339 (org-open-at-point))
10340 lk))
10341 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10342 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10343 ((and (org-at-timestamp-p t)
10344 (not (org-in-regexp org-bracket-link-regexp)))
10345 (org-follow-timestamp-link))
10346 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10347 (not (org-in-regexp org-any-link-re)))
10348 (org-footnote-action))
10349 (t
10350 (let (type path link line search (pos (point)))
10351 (catch 'match
10352 (save-excursion
10354 (when (org-in-regexp org-bracket-link-regexp 1)
10355 (setq link (org-extract-attributes
10356 (org-link-unescape (org-match-string-no-properties 1))))
10358 (setq link (replace-match " " t t link)))
10359 (setq link (org-link-expand-abbrev link))
10360 (cond
10361 ((or (file-name-absolute-p link)
10363 (setq type "file" path link))
10364 ((string-match org-link-re-with-space3 link)
10365 (setq type (match-string 1 link) path (match-string 2 link)))
10367 (setq type "help" path (match-string 1 link)))
10368 (t (setq type "thisfile" path link)))
10369 (throw 'match t)))
10371 (when (get-text-property (point) 'org-linked-text)
10372 (setq type "thisfile"
10373 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10374 (1+ (point)) (point))
10375 path (buffer-substring
10376 (or (previous-single-property-change pos 'org-linked-text)
10377 (point-min))
10378 (or (next-single-property-change pos 'org-linked-text)
10379 (point-max)))
10380 ;; Ensure we will search for a <<<radio>>> link, not
10381 ;; a simple reference like <<ref>>
10382 path (concat "<" path))
10383 (throw 'match t))
10385 (save-excursion
10386 (when (or (org-in-regexp org-angle-link-re)
10387 (let ((match (org-in-regexp org-plain-link-re)))
10388 ;; Check a plain link is not within a bracket link
10389 (and match
10390 (save-excursion
10391 (progn
10392 (goto-char (car match))
10393 (not (org-in-regexp org-bracket-link-regexp))))))
10394 (let ((line_ending (save-excursion (end-of-line) (point))))
10395 ;; We are in a line before a plain or bracket link
10396 (or (re-search-forward org-plain-link-re line_ending t)
10397 (re-search-forward org-bracket-link-regexp line_ending t))))
10398 (setq type (match-string 1)
10399 path (org-link-unescape (match-string 2)))
10400 (throw 'match t)))
10401 (save-excursion
10403 (setq type "tags"
10404 path (match-string 1))
10405 (while (string-match ":" path)
10406 (setq path (replace-match "+" t t path)))
10407 (throw 'match t)))
10409 (setq type "tree-match"
10410 path (match-string 1))
10411 (throw 'match t)))
10412 (unless path
10413 (user-error "No link found"))
10415 ;; switch back to reference buffer
10416 ;; needed when if called in a temporary buffer through
10417 ;; org-open-link-from-string
10418 (with-current-buffer (or reference-buffer (current-buffer))
10420 ;; Remove any trailing spaces in path
10422 (setq path (replace-match "" t t path)))
10423 (if (and org-link-translation-function
10424 (fboundp org-link-translation-function))
10425 ;; Check if we need to translate the link
10426 (let ((tmp (funcall org-link-translation-function type path)))
10427 (setq type (car tmp) path (cdr tmp))))
10429 (cond
10431 ((assoc type org-link-protocols)
10432 (funcall (nth 1 (assoc type org-link-protocols)) path))
10434 ((equal type "help")
10435 (let ((f-or-v (intern path)))
10436 (cond ((fboundp f-or-v)
10437 (describe-function f-or-v))
10438 ((boundp f-or-v)
10439 (describe-variable f-or-v))
10440 (t (error "Not a known function or variable")))))
10442 ((equal type "mailto")
10443 (let ((cmd (car org-link-mailto-program))
10444 (args (cdr org-link-mailto-program)) args1
10445 (address path) (subject "") a)
10447 (setq address (match-string 1 path)
10448 subject (org-link-escape (match-string 2 path))))
10449 (while args
10450 (cond
10451 ((not (stringp (car args))) (push (pop args) args1))
10452 (t (setq a (pop args))
10453 (if (string-match "%a" a)
10454 (setq a (replace-match address t t a)))
10455 (if (string-match "%s" a)
10456 (setq a (replace-match subject t t a)))
10457 (push a args1))))
10458 (apply cmd (nreverse args1))))
10460 ((member type '("http" "https" "ftp" "news"))
10461 (browse-url (concat type ":" (org-link-escape-browser path))))
10463 ((string= type "doi")
10464 (browse-url (concat org-doi-server-url
10465 (org-link-escape-browser path))))
10467 ((member type '("message"))
10468 (browse-url (concat type ":" path)))
10470 ((string= type "tags")
10471 (org-tags-view arg path))
10473 ((string= type "tree-match")
10476 ((string= type "file")
10478 (setq line (string-to-number (match-string 1 path))
10479 path (substring path 0 (match-beginning 0)))
10481 (setq search (match-string 1 path)
10482 path (substring path 0 (match-beginning 0)))))
10483 (if (string-match "[*?{]" (file-name-nondirectory path))
10484 (dired path)
10485 (org-open-file path arg line search)))
10487 ((string= type "shell")
10488 (let ((buf (generate-new-buffer "*Org Shell Output"))
10489 (cmd path))
10490 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10491 (string-match org-confirm-shell-link-not-regexp cmd))
10492 (not org-confirm-shell-link-function)
10493 (funcall org-confirm-shell-link-function
10495 (org-add-props cmd nil
10496 'face 'org-warning))))
10497 (progn
10498 (message "Executing %s" cmd)
10499 (shell-command cmd buf)
10500 (if (featurep 'midnight)
10501 (setq clean-buffer-list-kill-buffer-names
10502 (cons buf clean-buffer-list-kill-buffer-names))))
10503 (error "Abort"))))
10505 ((string= type "elisp")
10506 (let ((cmd path))
10507 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10508 (string-match org-confirm-elisp-link-not-regexp cmd))
10509 (not org-confirm-elisp-link-function)
10510 (funcall org-confirm-elisp-link-function
10512 (org-add-props cmd nil
10513 'face 'org-warning))))
10514 (message "%s => %s" cmd
10515 (if (equal (string-to-char cmd) ?\()
10516 (eval (read cmd))
10517 (call-interactively (read cmd))))
10518 (error "Abort"))))
10520 ((and (string= type "thisfile")
10521 (or (run-hook-with-args-until-success
10522 'org-open-link-functions path)
10523 (and (string-match "^id:" link)
10524 (or (featurep 'org-id) (require 'org-id))
10525 (progn
10526 (funcall (nth 1 (assoc "id" org-link-protocols))
10527 (substring path 3))
10528 t)))))
10530 ((string= type "thisfile")
10531 (if arg
10532 (switch-to-buffer-other-window
10533 (org-get-buffer-for-internal-link (current-buffer)))
10534 (org-mark-ring-push))
10535 (let ((cmd `(org-link-search
10536 ,path
10537 ,(cond ((equal arg '(4)) ''occur)
10538 ((equal arg '(16)) ''org-occur))
10539 ,pos)))
10540 (condition-case nil (let ((org-link-search-inhibit-query t))
10541 (eval cmd))
10542 (error (progn (widen) (eval cmd))))))
10544 (t (browse-url-at-point)))))))
10545 (move-marker org-open-link-marker nil)
10546 (run-hook-with-args 'org-follow-link-hook)))
10548 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10549 "Offer links in the current entry and return the selected link.
10550 If there is only one link, return it.
10551 If NTH is an integer, return the NTH link found.
10552 If ZERO is a string, check also this string for a link, and if
10553 there is one, return it."
10554 (with-current-buffer buffer
10555 (save-excursion
10556 (save-restriction
10557 (widen)
10558 (goto-char marker)
10562 (cnt ?0)
10563 (in-emacs (if (integerp nth) nil nth))
10564 have-zero end links link c)
10565 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10566 (push (match-string 0 zero) links)
10567 (setq cnt (1- cnt) have-zero t))
10568 (save-excursion
10569 (org-back-to-heading t)
10570 (setq end (save-excursion (outline-next-heading) (point)))
10571 (while (re-search-forward re end t)
10572 (push (match-string 0) links))
10573 (setq links (org-uniquify (reverse links))))
10574 (cond
10575 ((null links)
10576 (message "No links"))
10577 ((equal (length links) 1)
10578 (setq link (car links)))
10579 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10580 (setq link (nth (if have-zero nth (1- nth)) links)))
10581 (t ; we have to select a link
10582 (save-excursion
10583 (save-window-excursion
10584 (delete-other-windows)
10585 (with-output-to-temp-buffer "*Select Link*"
10586 (mapc (lambda (l)
10587 (if (not (string-match org-bracket-link-regexp l))
10589 (org-remove-angle-brackets l)))
10590 (if (match-end 3)
10592 (match-string 3 l) (match-string 1 l)))
10594 (match-string 1 l))))))
10595 links))
10596 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10597 (message "Select link to open, RET to open all:")
10598 (setq c (read-char-exclusive))
10599 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10600 (when (equal c ?q) (error "Abort"))
10601 (if (equal c ?\C-m)
10602 (setq link links)
10603 (setq nth (- c ?0))
10604 (if have-zero (setq nth (1+ nth)))
10605 (unless (and (integerp nth) (>= (length links) nth))
10606 (user-error "Invalid link selection"))
10607 (setq link (nth (1- nth) links)))))
10608 (cons link end))))))
10610 ;; Add special file links that specify the way of opening
10612 (org-add-link-type "file+sys" 'org-open-file-with-system)
10613 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10614 (defun org-open-file-with-system (path)
10615 "Open file at PATH using the system way of opening it."
10616 (org-open-file path 'system))
10617 (defun org-open-file-with-emacs (path)
10618 "Open file at PATH in Emacs."
10619 (org-open-file path 'emacs))
10622 ;;; File search
10624 (defvar org-create-file-search-functions nil
10625 "List of functions to construct the right search string for a file link.
10626 These functions are called in turn with point at the location to
10627 which the link should point.
10629 A function in the hook should first test if it would like to
10630 handle this file type, for example by checking the `major-mode'
10631 or the file extension. If it decides not to handle this file, it
10632 should just return nil to give other functions a chance. If it
10633 does handle the file, it must return the search string to be used
10634 when following the link. The search string will be part of the
10635 file link, given after a double colon, and `org-open-at-point'
10636 will automatically search for it. If special measures must be
10637 taken to make the search successful, another function should be
10638 added to the companion hook `org-execute-file-search-functions',
10639 which see.
10641 A function in this hook may also use `setq' to set the variable
10642 `description' to provide a suggestion for the descriptive text to
10643 be used for this link when it gets inserted into an Org-mode
10646 (defvar org-execute-file-search-functions nil
10647 "List of functions to execute a file search triggered by a link.
10649 Functions added to this hook must accept a single argument, the
10650 search string that was part of the file link, the part after the
10651 double colon. The function must first check if it would like to
10652 handle this search, for example by checking the `major-mode' or
10653 the file extension. If it decides not to handle this search, it
10654 should just return nil to give other functions a chance. If it
10655 does handle the search, it must return a non-nil value to keep
10656 other functions from trying.
10658 Each function can access the current prefix argument through the
10659 variable `current-prefix-arg'. Note that a single prefix is used
10660 to force opening a link in Emacs, so it may be good to only use a
10661 numeric or double prefix to guide the search function.
10663 In case this is needed, a function in this hook can also restore
10664 the window configuration before `org-open-at-point' was called using:
10666 (set-window-configuration org-window-config-before-follow-link)")
10668 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10669 (defun org-link-search (s &optional type avoid-pos stealth)
10670 "Search for a link search option.
10671 If S is surrounded by forward slashes, it is interpreted as a
10672 regular expression. In org-mode files, this will create an `org-occur'
10673 sparse tree. In ordinary files, `occur' will be used to list matches.
10674 If the current buffer is in `dired-mode', grep will be used to search
10675 in all files. If AVOID-POS is given, ignore matches near that position.
10677 When optional argument STEALTH is non-nil, do not modify
10678 visibility around point, thus ignoring
10679 `org-show-hierarchy-above', `org-show-following-heading' and
10680 `org-show-siblings' variables."
10681 (let ((case-fold-search t)
10685 org-emphasis-alist)
10687 (pos (point))
10688 (pre nil) (post nil)
10689 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10690 (cond
10691 ;; First check if there are any special search functions
10692 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10693 ;; Now try the builtin stuff
10694 ((and (equal (string-to-char s0) ?#)
10695 (> (length s0) 1)
10696 (save-excursion
10697 (goto-char (point-min))
10698 (and
10699 (re-search-forward
10702 (setq type 'dedicated
10703 pos (match-beginning 0))))
10704 ;; There is an exact target for this
10705 (goto-char pos)
10706 (org-back-to-heading t)))
10707 ((save-excursion
10708 (goto-char (point-min))
10709 (and
10710 (re-search-forward
10711 (concat "<<" (regexp-quote s0) ">>") nil t)
10712 (setq type 'dedicated
10713 pos (match-beginning 0))))
10714 ;; There is an exact target for this
10715 (goto-char pos))
10716 ((save-excursion
10717 (goto-char (point-min))
10718 (and
10719 (re-search-forward
10721 (setq type 'dedicated pos (match-beginning 0))))
10722 ;; Found an element with a matching #+name affiliated keyword.
10723 (goto-char pos))
10725 (save-excursion
10726 (goto-char (point-min))
10727 (and
10728 (re-search-forward
10729 (concat "[^[]" (regexp-quote
10730 (format org-coderef-label-format
10731 (match-string 1 s0))))
10732 nil t)
10733 (setq type 'dedicated
10734 pos (1+ (match-beginning 0))))))
10735 ;; There is a coderef target for this
10736 (goto-char pos))
10738 ;; A regular expression
10739 (cond
10740 ((derived-mode-p 'org-mode)
10741 (org-occur (match-string 1 s)))
10742 (t (org-do-occur (match-string 1 s)))))
10743 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10744 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10745 (goto-char (point-min))
10746 (cond
10747 ((let (case-fold-search)
10748 (re-search-forward (format org-complex-heading-regexp-format
10749 (regexp-quote s))
10750 nil t))
10751 ;; OK, found a match
10752 (setq type 'dedicated)
10753 (goto-char (match-beginning 0)))
10754 ((and (not org-link-search-inhibit-query)
10755 (eq org-link-search-must-match-exact-headline 'query-to-create)
10756 (y-or-n-p "No match - create this as a new heading? "))
10757 (goto-char (point-max))
10758 (or (bolp) (newline))
10760 (beginning-of-line 0))
10761 (t
10762 (goto-char pos)
10763 (error "No match"))))
10764 (t
10765 ;; A normal search string
10766 (when (equal (string-to-char s) ?*)
10767 ;; Anchor on headlines, post may include tags.
10770 s (substring s 1)))
10771 (remove-text-properties
10772 0 (length s)
10773 '(face nil mouse-face nil keymap nil fontified nil) s)
10774 ;; Make a series of regular expressions to find a match
10785 re4 (concat "[^a-zA-Z_]" re4_)
10787 re1 (concat pre re2 post)
10788 re3 (concat pre (if pre re4_ re4) post)
10789 re5 (concat pre ".*" re4)
10790 re2 (concat pre re2)
10791 re2a (concat pre (if pre re2a_ re2a))
10792 re4 (concat pre (if pre re4_ re4))
10796 (cond
10797 ((eq type 'org-occur) (org-occur reall))
10798 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10799 (t (goto-char (point-min))
10800 (setq type 'fuzzy)
10801 (if (or (and (org-search-not-self 1 re0 nil t)
10802 (setq type 'dedicated))
10803 (org-search-not-self 1 re1 nil t)
10804 (org-search-not-self 1 re2 nil t)
10805 (org-search-not-self 1 re2a nil t)
10806 (org-search-not-self 1 re3 nil t)
10807 (org-search-not-self 1 re4 nil t)
10808 (org-search-not-self 1 re5 nil t))
10809 (goto-char (match-beginning 1))
10810 (goto-char pos)
10811 (error "No match"))))))
10812 (and (derived-mode-p 'org-mode)
10813 (not stealth)
10814 (org-show-context 'link-search))
10815 type))
10817 (defun org-search-not-self (group &rest args)
10818 "Execute `re-search-forward', but only accept matches that do not
10819 enclose the position of `org-open-link-marker'."
10820 (let ((m org-open-link-marker))
10821 (catch 'exit
10822 (while (apply 're-search-forward args)
10823 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10824 (goto-char (match-end group))
10825 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10826 (> (match-beginning 0) (marker-position m))
10827 (< (match-end 0) (marker-position m)))
10828 (save-match-data
10829 (or (not (org-in-regexp
10830 org-bracket-link-analytic-regexp 1))
10831 (not (match-end 4)) ; no description
10832 (and (<= (match-beginning 4) (point))
10833 (>= (match-end 4) (point))))))
10834 (throw 'exit (point))))))))
10836 (defun org-get-buffer-for-internal-link (buffer)
10837 "Return a buffer to be used for displaying the link target of internal links."
10838 (cond
10839 ((not org-display-internal-link-with-indirect-buffer)
10840 buffer)
10841 ((string-match "(Clone)$" (buffer-name buffer))
10842 (message "Buffer is already a clone, not making another one")
10843 ;; we also do not modify visibility in this case
10844 buffer)
10845 (t ; make a new indirect buffer for displaying the link
10846 (let* ((bn (buffer-name buffer))
10847 (ibn (concat bn "(Clone)"))
10848 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10849 (with-current-buffer ib (org-overview))
10850 ib))))
10852 (defun org-do-occur (regexp &optional cleanup)
10853 "Call the Emacs command `occur'.
10854 If CLEANUP is non-nil, remove the printout of the regular expression
10855 in the *Occur* buffer. This is useful if the regex is long and not useful
10856 to read."
10857 (occur regexp)
10858 (when cleanup
10859 (let ((cwin (selected-window)) win beg end)
10860 (when (setq win (get-buffer-window "*Occur*"))
10861 (select-window win))
10862 (goto-char (point-min))
10863 (when (re-search-forward "match[a-z]+" nil t)
10864 (setq beg (match-end 0))
10866 (setq end (1- (match-beginning 0)))))
10867 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10868 (goto-char (point-min))
10869 (select-window cwin))))
10871 ;;; The mark ring for links jumps
10873 (defvar org-mark-ring nil
10874 "Mark ring for positions before jumps in Org-mode.")
10875 (defvar org-mark-ring-last-goto nil
10876 "Last position in the mark ring used to go back.")
10877 ;; Fill and close the ring
10878 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10879 (loop for i from 1 to org-mark-ring-length do
10880 (push (make-marker) org-mark-ring))
10881 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10882 org-mark-ring)
10884 (defun org-mark-ring-push (&optional pos buffer)
10885 "Put the current position or POS into the mark ring and rotate it."
10886 (interactive)
10887 (setq pos (or pos (point)))
10888 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10889 (move-marker (car org-mark-ring)
10890 (or pos (point))
10891 (or buffer (current-buffer)))
10892 (message "%s"
10893 (substitute-command-keys
10896 (defun org-mark-ring-goto (&optional n)
10897 "Jump to the previous position in the mark ring.
10898 With prefix arg N, jump back that many stored positions. When
10899 called several times in succession, walk through the entire ring.
10900 Org-mode commands jumping to a different position in the current file,
10901 or to another Org-mode file, automatically push the old position
10902 onto the ring."
10903 (interactive "p")
10904 (let (p m)
10905 (if (eq last-command this-command)
10906 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10907 (setq p org-mark-ring))
10908 (setq org-mark-ring-last-goto p)
10909 (setq m (car p))
10910 (org-pop-to-buffer-same-window (marker-buffer m))
10911 (goto-char m)
10912 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10914 (defun org-remove-angle-brackets (s)
10915 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10916 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10917 s)
10918 (defun org-add-angle-brackets (s)
10919 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10920 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10921 s)
10922 (defun org-remove-double-quotes (s)
10925 s)
10927 ;;; Following specific links
10929 (defun org-follow-timestamp-link ()
10930 "Open an agenda view for the time-stamp date/range at point."
10931 (cond
10932 ((org-at-date-range-p t)
10933 (let ((org-agenda-start-on-weekday)
10934 (t1 (match-string 1))
10935 (t2 (match-string 2)) tt1 tt2)
10936 (setq tt1 (time-to-days (org-time-string-to-time t1))
10937 tt2 (time-to-days (org-time-string-to-time t2)))
10938 (let ((org-agenda-buffer-tmp-name
10939 (format "*Org Agenda(a:%s)"
10940 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10941 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10942 ((org-at-timestamp-p t)
10943 (let ((org-agenda-buffer-tmp-name
10944 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10945 (org-agenda-list nil (time-to-days (org-time-string-to-time
10946 (substring (match-string 1) 0 10)))
10947 1)))
10948 (t (error "This should not happen"))))
10951 ;;; Following file links
10952 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10953 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10954 (declare-function mailcap-mime-info
10955 "mailcap" (string &optional request no-decode))
10956 (defvar org-wait nil)
10957 (defun org-open-file (path &optional in-emacs line search)
10958 "Open the file at PATH.
10959 First, this expands any special file name abbreviations. Then the
10960 configuration variable `org-file-apps' is checked if it contains an
10961 entry for this file type, and if yes, the corresponding command is launched.
10963 If no application is found, Emacs simply visits the file.
10965 With optional prefix argument IN-EMACS, Emacs will visit the file.
10967 prefix arg, Org tries to avoid opening in Emacs
10968 and to use an external application to visit the file.
10970 Optional LINE specifies a line to go to, optional SEARCH a string
10971 to search for. If LINE or SEARCH is given, the file will be
10972 opened in Emacs, unless an entry from org-file-apps that makes
10973 use of groups in a regexp matches.
10975 If you want to change the way frames are used when following a
10976 link, please customize `org-link-frame-setup'.
10978 If the file does not exist, an error is thrown."
10979 (let* ((file (if (equal path "")
10980 buffer-file-name
10981 (substitute-in-file-name (expand-file-name path))))
10982 (file-apps (append org-file-apps (org-default-apps)))
10983 (apps (org-remove-if
10984 'org-file-apps-entry-match-against-dlink-p file-apps))
10985 (apps-dlink (org-remove-if-not
10986 'org-file-apps-entry-match-against-dlink-p file-apps))
10987 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10988 (dirp (if remp nil (file-directory-p file)))
10989 (file (if (and dirp org-open-directory-means-index-dot-org)
10990 (concat (file-name-as-directory file) "index.org")
10991 file))
10992 (a-m-a-p (assq 'auto-mode apps))
10993 (dfile (downcase file))
10994 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10995 (link (cond ((and (eq line nil)
10996 (eq search nil))
10997 file)
10998 (line
10999 (concat file "::" (number-to-string line)))
11000 (search
11001 (concat file "::" search))))
11002 (dlink (downcase link))
11003 (old-buffer (current-buffer))
11004 (old-pos (point))
11005 (old-mode major-mode)
11006 ext cmd link-match-data)
11008 (setq ext (match-string 1 dfile))
11010 (setq ext (match-string 1 dfile))))
11011 (cond
11012 ((member in-emacs '((16) system))
11013 (setq cmd (cdr (assoc 'system apps))))
11014 (in-emacs (setq cmd 'emacs))
11015 (t
11016 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11017 (and dirp (cdr (assoc 'directory apps)))
11018 ; first, try matching against apps-dlink
11019 ; if we get a match here, store the match data for later
11020 (let ((match (assoc-default dlink apps-dlink
11021 'string-match)))
11022 (if match
11023 (progn (setq link-match-data (match-data))
11024 match)
11025 (progn (setq in-emacs (or in-emacs line search))
11026 nil))) ; if we have no match in apps-dlink,
11027 ; always open the file in emacs if line or search
11028 ; is given (for backwards compatibility)
11029 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11030 'string-match)
11031 (cdr (assoc ext apps))
11032 (cdr (assoc t apps))))))
11033 (when (eq cmd 'system)
11034 (setq cmd (cdr (assoc 'system apps))))
11035 (when (eq cmd 'default)
11036 (setq cmd (cdr (assoc t apps))))
11037 (when (eq cmd 'mailcap)
11038 (require 'mailcap)
11039 (mailcap-parse-mailcaps)
11040 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11041 (command (mailcap-mime-info mime-type)))
11042 (if (stringp command)
11043 (setq cmd command)
11044 (setq cmd 'emacs))))
11045 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11046 (not (file-exists-p file))
11047 (not org-open-non-existing-files))
11048 (user-error "No such file: %s" file))
11049 (cond
11051 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11053 (setq cmd (replace-match "%s" t t cmd)))
11054 (while (string-match "%s" cmd)
11055 (setq cmd (replace-match
11056 (save-match-data
11057 (shell-quote-argument
11058 (convert-standard-filename file)))
11059 t t cmd)))
11061 ;; Replace "%1", "%2" etc. in command with group matches from regex
11062 (save-match-data
11063 (let ((match-index 1)
11064 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11065 (set-match-data link-match-data)
11066 (while (<= match-index number-of-groups)
11067 (let ((regex (concat "%" (number-to-string match-index)))
11068 (replace-with (match-string match-index dlink)))
11069 (while (string-match regex cmd)
11070 (setq cmd (replace-match replace-with t t cmd))))
11071 (setq match-index (+ match-index 1)))))
11073 (save-window-excursion
11074 (message "Running %s...done" cmd)
11075 (start-process-shell-command cmd nil cmd)
11076 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11077 ((or (stringp cmd)
11078 (eq cmd 'emacs))
11079 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11080 (widen)
11081 (if line (org-goto-line line)
11082 (if search (org-link-search search))))
11083 ((consp cmd)
11084 (let ((file (convert-standard-filename file)))
11085 (save-match-data
11086 (set-match-data link-match-data)
11087 (eval cmd))))
11088 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11089 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11090 (or (not (equal old-buffer (current-buffer)))
11091 (not (equal old-pos (point))))
11092 (org-mark-ring-push old-pos old-buffer))))
11094 (defun org-file-apps-entry-match-against-dlink-p (entry)
11095 "This function returns non-nil if `entry' uses a regular
11096 expression which should be matched against the whole link by
11097 org-open-file.
11099 It assumes that is the case when the entry uses a regular
11100 expression which has at least one grouping construct and the
11101 action is either a lisp form or a command string containing
11102 '%1', i.e. using at least one subexpression match as a
11103 parameter."
11104 (let ((selector (car entry))
11105 (action (cdr entry)))
11106 (if (stringp selector)
11107 (and (> (regexp-opt-depth selector) 0)
11108 (or (and (stringp action)
11109 (string-match "%[0-9]" action))
11110 (consp action)))
11111 nil)))
11113 (defun org-default-apps ()
11114 "Return the default applications for this operating system."
11115 (cond
11116 ((eq system-type 'darwin)
11117 org-file-apps-defaults-macosx)
11118 ((eq system-type 'windows-nt)
11119 org-file-apps-defaults-windowsnt)
11120 (t org-file-apps-defaults-gnu)))
11122 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11123 "Convert extensions to regular expressions in the cars of LIST.
11124 Also, weed out any non-string entries, because the return value is used
11125 only for regexp matching.
11126 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11127 point to the symbol `emacs', indicating that the file should
11128 be opened in Emacs."
11129 (append
11130 (delq nil
11131 (mapcar (lambda (x)
11132 (if (not (stringp (car x)))
11133 nil
11135 x
11137 list))
11138 (if add-auto-mode
11139 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11141 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11142 (defun org-file-remote-p (file)
11143 "Test whether FILE specifies a location on a remote system.
11144 Return non-nil if the location is indeed remote.
11148 (cond ((fboundp 'file-remote-p)
11149 (file-remote-p file))
11150 ((fboundp 'tramp-handle-file-remote-p)
11151 (tramp-handle-file-remote-p file))
11152 ((and (boundp 'ange-ftp-name-format)
11153 (string-match (car ange-ftp-name-format) file))
11154 t)))
11157 ;;;; Refiling
11159 (defun org-get-org-file ()
11160 "Read a filename, with default directory `org-directory'."
11161 (let ((default (or org-default-notes-file remember-data-file)))
11162 (read-file-name (format "File name [%s]: " default)
11163 (file-name-as-directory org-directory)
11164 default)))
11166 (defun org-notes-order-reversed-p ()
11167 "Check if the current file should receive notes in reversed order."
11168 (cond
11169 ((not org-reverse-note-order) nil)
11170 ((eq t org-reverse-note-order) t)
11171 ((not (listp org-reverse-note-order)) nil)
11172 (t (catch 'exit
11173 (let ((all org-reverse-note-order)
11174 entry)
11175 (while (setq entry (pop all))
11176 (if (string-match (car entry) buffer-file-name)
11177 (throw 'exit (cdr entry))))
11178 nil)))))
11180 (defvar org-refile-target-table nil
11181 "The list of refile targets, created by `org-refile'.")
11183 (defvar org-agenda-new-buffers nil
11184 "Buffers created to visit agenda files.")
11186 (defvar org-refile-cache nil
11187 "Cache for refile targets.")
11189 (defvar org-refile-markers nil
11190 "All the markers used for caching refile locations.")
11192 (defun org-refile-marker (pos)
11193 "Get a new refile marker, but only if caching is in use."
11194 (if (not org-refile-use-cache)
11195 pos
11196 (let ((m (make-marker)))
11197 (move-marker m pos)
11198 (push m org-refile-markers)
11199 m)))
11201 (defun org-refile-cache-clear ()
11202 "Clear the refile cache and disable all the markers."
11203 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11204 (setq org-refile-markers nil)
11205 (setq org-refile-cache nil)
11206 (message "Refile cache has been cleared"))
11208 (defun org-refile-cache-check-set (set)
11209 "Check if all the markers in the cache still have live buffers."
11210 (let (marker)
11211 (catch 'exit
11212 (while (and set (setq marker (nth 3 (pop set))))
11213 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11214 (when (and marker (null (marker-buffer marker)))
11215 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11216 (sit-for 3)
11217 (throw 'exit nil)))
11218 t)))
11220 (defun org-refile-cache-put (set &rest identifiers)
11221 "Push the refile targets SET into the cache, under IDENTIFIERS."
11222 (let* ((key (sha1 (prin1-to-string identifiers)))
11223 (entry (assoc key org-refile-cache)))
11224 (if entry
11225 (setcdr entry set)
11226 (push (cons key set) org-refile-cache))))
11228 (defun org-refile-cache-get (&rest identifiers)
11229 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11230 (cond
11231 ((not org-refile-cache) nil)
11232 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11233 (t
11234 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11235 org-refile-cache))))
11236 (and set (org-refile-cache-check-set set) set)))))
11238 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11239 "Produce a table with refile targets."
11240 (let ((case-fold-search nil)
11241 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11242 (entries (or org-refile-targets '((nil . (:level . 1)))))
11243 targets tgs txt re files f desc descre fast-path-p level pos0)
11244 (message "Getting targets...")
11245 (with-current-buffer (or default-buffer (current-buffer))
11246 (while (setq entry (pop entries))
11247 (setq files (car entry) desc (cdr entry))
11248 (setq fast-path-p nil)
11249 (cond
11250 ((null files) (setq files (list (current-buffer))))
11251 ((eq files 'org-agenda-files)
11252 (setq files (org-agenda-files 'unrestricted)))
11253 ((and (symbolp files) (fboundp files))
11254 (setq files (funcall files)))
11255 ((and (symbolp files) (boundp files))
11256 (setq files (symbol-value files))))
11257 (if (stringp files) (setq files (list files)))
11258 (cond
11259 ((eq (car desc) :tag)
11261 ((eq (car desc) :todo)
11263 ((eq (car desc) :regexp)
11264 (setq descre (cdr desc)))
11265 ((eq (car desc) :level)
11267 (if org-odd-levels-only
11268 (1- (* 2 (cdr desc)))
11269 (cdr desc)))
11271 ((eq (car desc) :maxlevel)
11272 (setq fast-path-p t)
11274 (if org-odd-levels-only
11275 (1- (* 2 (cdr desc)))
11276 (cdr desc)))
11278 (t (error "Bad refiling target description %s" desc)))
11279 (while (setq f (pop files))
11280 (with-current-buffer
11281 (if (bufferp f) f (org-get-agenda-file-buffer f))
11282 (or
11283 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11284 (progn
11285 (if (bufferp f) (setq f (buffer-file-name
11286 (buffer-base-buffer f))))
11287 (setq f (and f (expand-file-name f)))
11288 (if (eq org-refile-use-outline-path 'file)
11289 (push (list (file-name-nondirectory f) f nil nil) tgs))
11290 (save-excursion
11291 (save-restriction
11292 (widen)
11293 (goto-char (point-min))
11294 (while (re-search-forward descre nil t)
11295 (goto-char (setq pos0 (point-at-bol)))
11296 (catch 'next
11297 (when org-refile-target-verify-function
11298 (save-match-data
11299 (or (funcall org-refile-target-verify-function)
11300 (throw 'next t))))
11301 (when (and (looking-at org-complex-heading-regexp)
11302 (not (member (match-string 4) excluded-entries))
11303 (match-string 4))
11304 (setq level (org-reduced-level
11305 (- (match-end 1) (match-beginning 1)))
11306 txt (org-link-display-format (match-string 4))
11308 re (format org-complex-heading-regexp-format
11309 (regexp-quote (match-string 4))))
11310 (when org-refile-use-outline-path
11311 (setq txt (mapconcat
11312 'org-protect-slash
11313 (append
11314 (if (eq org-refile-use-outline-path
11315 'file)
11316 (list (file-name-nondirectory
11317 (buffer-file-name
11318 (buffer-base-buffer))))
11319 (if (eq org-refile-use-outline-path
11320 'full-file-path)
11321 (list (buffer-file-name
11322 (buffer-base-buffer)))))
11323 (org-get-outline-path fast-path-p
11324 level txt)
11325 (list txt))
11326 "/")))
11327 (push (list txt f re (org-refile-marker (point)))
11328 tgs)))
11329 (when (= (point) pos0)
11330 ;; verification function has not moved point
11331 (goto-char (point-at-eol))))))))
11332 (when org-refile-use-cache
11333 (org-refile-cache-put tgs (buffer-file-name) descre))
11334 (setq targets (append tgs targets))))))
11335 (message "Getting targets...done")
11336 (nreverse targets)))
11338 (defun org-protect-slash (s)
11339 (while (string-match "/" s)
11341 s)
11343 (defvar org-olpa (make-vector 20 nil))
11345 (defun org-get-outline-path (&optional fastp level heading)
11346 "Return the outline path to the current entry, as a list.
11348 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11349 routine which makes outline path derivations for an entire file,
11350 avoiding backtracing. Refile target collection makes use of that."
11351 (if fastp
11352 (progn
11353 (if (> level 19)
11354 (error "Outline path failure, more than 19 levels"))
11355 (loop for i from level upto 19 do
11356 (aset org-olpa i nil))
11357 (prog1
11358 (delq nil (append org-olpa nil))
11359 (aset org-olpa level heading)))
11360 (let (rtn case-fold-search)
11361 (save-excursion
11362 (save-restriction
11363 (widen)
11364 (while (org-up-heading-safe)
11365 (when (looking-at org-complex-heading-regexp)
11366 (push (org-trim
11367 (replace-regexp-in-string
11368 ;; Remove statistical/checkboxes cookies
11370 (org-match-string-no-properties 4)))
11371 rtn)))
11372 rtn)))))
11374 (defun org-format-outline-path (path &optional width prefix separator)
11375 "Format the outline path PATH for display.
11376 WIDTH is the maximum number of characters that is available.
11377 PREFIX is a prefix to be included in the returned string,
11378 such as the file name.
11379 SEPARATOR is inserted between the different parts of the path,
11381 (setq width (or width 79))
11382 (if prefix (setq width (- width (length prefix))))
11383 (if (not path)
11384 (or prefix "")
11385 (let* ((nsteps (length path))
11386 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11387 (maxwidth (if (<= total-width width)
11388 10000 ;; everything fits
11389 ;; we need to shorten the level headings
11390 (/ (- width nsteps) nsteps)))
11391 (org-odd-levels-only nil)
11392 (n 0)
11393 (total (1+ (length prefix))))
11394 (setq maxwidth (max maxwidth 10))
11395 (concat prefix
11396 (if prefix (or separator "/"))
11397 (mapconcat
11398 (lambda (h)
11399 (setq n (1+ n))
11400 (if (and (= n nsteps) (< maxwidth 10000))
11401 (setq maxwidth (- total-width total)))
11402 (if (< (length h) maxwidth)
11403 (progn (setq total (+ total (length h) 1)) h)
11404 (setq h (substring h 0 (- maxwidth 2))
11405 total (+ total maxwidth 1))
11407 (setq h (substring h 0 (match-beginning 0))))
11408 (setq h (concat h "..")))
11409 (org-add-props h nil 'face
11410 (nth (% (1- n) org-n-level-faces)
11411 org-level-faces))
11412 h)
11413 path (or separator "/"))))))
11415 (defun org-display-outline-path (&optional file current separator just-return-string)
11416 "Display the current outline path in the echo area.
11418 If FILE is non-nil, prepend the output with the file name.
11419 If CURRENT is non-nil, append the current heading to the output.
11420 SEPARATOR is passed through to `org-format-outline-path'. It separates
11422 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11423 (interactive "P")
11424 (let* (case-fold-search
11425 (bfn (buffer-file-name (buffer-base-buffer)))
11426 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11427 res)
11428 (if current (setq path (append path
11429 (save-excursion
11430 (org-back-to-heading t)
11431 (if (looking-at org-complex-heading-regexp)
11432 (list (match-string 4)))))))
11433 (setq res
11434 (org-format-outline-path
11435 path
11436 (1- (frame-width))
11437 (and file bfn (concat (file-name-nondirectory bfn) separator))
11438 separator))
11439 (if just-return-string
11440 (org-no-properties res)
11441 (org-unlogged-message "%s" res))))
11443 (defvar org-refile-history nil
11444 "History for refiling operations.")
11446 (defvar org-after-refile-insert-hook nil
11447 "Hook run after `org-refile' has inserted its stuff at the new location.
11448 Note that this is still *before* the stuff will be removed from
11449 the *old* location.")
11451 (defvar org-capture-last-stored-marker)
11452 (defvar org-refile-keep nil
11453 "Non-nil means `org-refile' will copy instead of refile.")
11455 (defun org-copy ()
11456 "Like `org-refile', but copy."
11457 (interactive)
11458 (let ((org-refile-keep t))
11459 (funcall 'org-refile nil nil nil "Copy")))
11461 (defun org-refile (&optional goto default-buffer rfloc msg)
11462 "Move the entry or entries at point to another heading.
11463 The list of target headings is compiled using the information in
11464 `org-refile-targets', which see.
11466 At the target location, the entry is filed as a subitem of the target
11467 heading. Depending on `org-reverse-note-order', the new subitem will
11468 either be the first or the last subitem.
11470 If there is an active region, all entries in that region will be moved.
11471 However, the region must fulfill the requirement that the first heading
11472 is the first one sets the top-level of the moved text - at most siblings
11473 below it are allowed.
11475 With prefix arg GOTO, the command will only visit the target location
11476 and not actually move anything.
11479 go to the location where the last refiling operation has put the subtree.
11481 With a numeric prefix argument of `2', refile to the running clock.
11483 With a numeric prefix argument of `3', emulate `org-refile-keep'
11484 being set to `t' and copy to the target location, don't move it.
11485 Beware that keeping refiled entries may result in duplicated ID
11486 properties.
11488 RFLOC can be a refile location obtained in a different way.
11493 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11495 If you are using target caching (see `org-refile-use-cache'),
11496 you have to clear the target cache in order to find new targets.
11497 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11498 prefix argument (`C-u C-u C-u C-c C-w')."
11500 (interactive "P")
11501 (if (member goto '(0 (64)))
11502 (org-refile-cache-clear)
11503 (let* ((actionmsg (or msg "Refile"))
11504 (cbuf (current-buffer))
11505 (regionp (org-region-active-p))
11506 (region-start (and regionp (region-beginning)))
11507 (region-end (and regionp (region-end)))
11508 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11509 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11510 pos it nbuf file re level reversed)
11511 (setq last-command nil)
11512 (when regionp
11513 (goto-char region-start)
11514 (or (bolp) (goto-char (point-at-bol)))
11515 (setq region-start (point))
11516 (unless (or (org-kill-is-subtree-p
11517 (buffer-substring region-start region-end))
11518 (prog1 org-refile-active-region-within-subtree
11519 (let ((s (point-at-eol)))
11520 (org-toggle-heading)
11521 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11522 (user-error "The region is not a (sequence of) subtree(s)")))
11523 (if (equal goto '(16))
11524 (org-refile-goto-last-stored)
11525 (when (or
11526 (and (equal goto 2)
11527 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11528 (prog1
11529 (setq it (list (or org-clock-heading "running clock")
11530 (buffer-file-name
11531 (marker-buffer org-clock-hd-marker))
11532 ""
11533 (marker-position org-clock-hd-marker)))
11534 (setq goto nil)))
11535 (setq it (or rfloc
11536 (let (heading-text)
11537 (save-excursion
11538 (unless goto
11539 (org-back-to-heading t)
11540 (setq heading-text
11541 (nth 4 (org-heading-components))))
11543 (org-refile-get-location
11544 (cond (goto "Goto")
11545 (regionp (concat actionmsg " region to"))
11548 default-buffer
11549 (and (not (equal '(4) goto))
11550 org-refile-allow-creating-parent-nodes)
11551 goto))))))
11552 (setq file (nth 1 it)
11553 re (nth 2 it)
11554 pos (nth 3 it))
11555 (if (and (not goto)
11556 pos
11557 (equal (buffer-file-name) file)
11558 (if regionp
11559 (and (>= pos region-start)
11560 (<= pos region-end))
11561 (and (>= pos (point))
11562 (< pos (save-excursion
11563 (org-end-of-subtree t t))))))
11564 (error "Cannot refile to position inside the tree or region"))
11566 (setq nbuf (or (find-buffer-visiting file)
11567 (find-file-noselect file)))
11568 (if (and goto (not (equal goto 3)))
11569 (progn
11570 (org-pop-to-buffer-same-window nbuf)
11571 (goto-char pos)
11572 (org-show-context 'org-goto))
11573 (if regionp
11574 (progn
11575 (org-kill-new (buffer-substring region-start region-end))
11576 (org-save-markers-in-region region-start region-end))
11577 (org-copy-subtree 1 nil t))
11578 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11579 (find-file-noselect file)))
11580 (setq reversed (org-notes-order-reversed-p))
11581 (save-excursion
11582 (save-restriction
11583 (widen)
11584 (if pos
11585 (progn
11586 (goto-char pos)
11587 (looking-at org-outline-regexp)
11588 (setq level (org-get-valid-level (funcall outline-level) 1))
11589 (goto-char
11590 (if reversed
11591 (or (outline-next-heading) (point-max))
11592 (or (save-excursion (org-get-next-sibling))
11593 (org-end-of-subtree t t)
11594 (point-max)))))
11595 (setq level 1)
11596 (if (not reversed)
11597 (goto-char (point-max))
11598 (goto-char (point-min))
11599 (or (outline-next-heading) (goto-char (point-max)))))
11600 (if (not (bolp)) (newline))
11601 (org-paste-subtree level)
11602 (when org-log-refile
11603 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11604 (unless (eq org-log-refile 'note)
11605 (save-excursion (org-add-log-note))))
11606 (and org-auto-align-tags
11607 (let ((org-loop-over-headlines-in-active-region nil))
11608 (org-set-tags nil t)))
11609 (let ((bookmark-name (plist-get org-bookmark-names-plist
11610 :last-refile)))
11611 (when bookmark-name
11612 (with-demoted-errors
11613 (bookmark-set bookmark-name))))
11614 ;; If we are refiling for capture, make sure that the
11615 ;; last-capture pointers point here
11616 (when (org-bound-and-true-p org-refile-for-capture)
11617 (let ((bookmark-name (plist-get org-bookmark-names-plist
11618 :last-capture-marker)))
11619 (when bookmark-name
11620 (with-demoted-errors
11621 (bookmark-set bookmark-name))))
11622 (move-marker org-capture-last-stored-marker (point)))
11623 (if (fboundp 'deactivate-mark) (deactivate-mark))
11624 (run-hooks 'org-after-refile-insert-hook))))
11625 (unless org-refile-keep
11626 (if regionp
11627 (delete-region (point) (+ (point) (- region-end region-start)))
11628 (delete-region
11629 (and (org-back-to-heading t) (point))
11630 (min (buffer-size) (org-end-of-subtree t t) (point)))))
11631 (when (featurep 'org-inlinetask)
11632 (org-inlinetask-remove-END-maybe))
11633 (setq org-markers-to-move nil)
11636 (defun org-refile-goto-last-stored ()
11637 "Go to the location where the last refile was stored."
11638 (interactive)
11639 (bookmark-jump "org-refile-last-stored")
11640 (message "This is the location of the last refile"))
11642 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11643 no-exclude)
11644 "Prompt the user for a refile location, using PROMPT.
11645 PROMPT should not be suffixed with a colon and a space, because
11646 this function appends the default value from
11647 `org-refile-history' automatically, if that is not empty.
11648 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11649 this is used for the GOTO interface."
11650 (let ((org-refile-targets org-refile-targets)
11651 (org-refile-use-outline-path org-refile-use-outline-path)
11652 excluded-entries)
11653 (when (and (derived-mode-p 'org-mode)
11654 (not org-refile-use-cache)
11655 (not no-exclude))
11656 (org-map-tree
11657 (lambda()
11658 (setq excluded-entries
11659 (append excluded-entries (list (org-get-heading t t)))))))
11660 (setq org-refile-target-table
11661 (org-refile-get-targets default-buffer excluded-entries)))
11662 (unless org-refile-target-table
11663 (user-error "No refile targets"))
11664 (let* ((cbuf (current-buffer))
11665 (partial-completion-mode nil)
11666 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11667 (cfunc (if (and org-refile-use-outline-path
11668 org-outline-path-complete-in-steps)
11669 'org-olpath-completing-read
11670 'org-icompleting-read))
11671 (extra (if org-refile-use-outline-path "/" ""))
11672 (cbnex (concat (buffer-name) extra))
11673 (filename (and cfn (expand-file-name cfn)))
11674 (tbl (mapcar
11675 (lambda (x)
11676 (if (and (not (member org-refile-use-outline-path
11677 '(file full-file-path)))
11678 (not (equal filename (nth 1 x))))
11679 (cons (concat (car x) extra " ("
11680 (file-name-nondirectory (nth 1 x)) ")")
11681 (cdr x))
11682 (cons (concat (car x) extra) (cdr x))))
11683 org-refile-target-table))
11684 (completion-ignore-case t)
11685 cdef
11686 (prompt (concat prompt
11687 (or (and (car org-refile-history)
11688 (concat " (default " (car org-refile-history) ")"))
11689 (and (assoc cbnex tbl) (setq cdef cbnex)
11690 (concat " (default " cbnex ")"))) ": "))
11691 pa answ parent-target child parent old-hist)
11692 (setq old-hist org-refile-history)
11693 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11694 nil 'org-refile-history (or cdef (car org-refile-history))))
11695 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11696 (org-refile-check-position pa)
11697 (if pa
11698 (progn
11699 (when (or (not org-refile-history)
11700 (not (eq old-hist org-refile-history))
11701 (not (equal (car pa) (car org-refile-history))))
11702 (setq org-refile-history
11703 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11704 org-refile-history
11705 (cdr org-refile-history))))
11706 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11707 (pop org-refile-history)))
11708 pa)
11710 (progn
11711 (setq parent (match-string 1 answ)
11712 child (match-string 2 answ))
11713 (setq parent-target (or (assoc parent tbl)
11714 (assoc (concat parent "/") tbl)))
11715 (when (and parent-target
11716 (or (eq new-nodes t)
11717 (and (eq new-nodes 'confirm)
11719 child)))))
11720 (org-refile-new-child parent-target child)))
11721 (user-error "Invalid target location")))))
11723 (declare-function org-string-nw-p "org-macs" (s))
11724 (defun org-refile-check-position (refile-pointer)
11725 "Check if the refile pointer matches the headline to which it points."
11726 (let* ((file (nth 1 refile-pointer))
11727 (re (nth 2 refile-pointer))
11728 (pos (nth 3 refile-pointer))
11729 buffer)
11730 (if (and (not (markerp pos)) (not file))
11731 (user-error "Please save the buffer to a file before refiling")
11732 (when (org-string-nw-p re)
11733 (setq buffer (if (markerp pos)
11734 (marker-buffer pos)
11735 (or (find-buffer-visiting file)
11736 (find-file-noselect file))))
11737 (with-current-buffer buffer
11738 (save-excursion
11739 (save-restriction
11740 (widen)
11741 (goto-char pos)
11742 (beginning-of-line 1)
11743 (unless (org-looking-at-p re)
11744 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11746 (defun org-refile-new-child (parent-target child)
11747 "Use refile target PARENT-TARGET to add new CHILD below it."
11748 (unless parent-target
11749 (error "Cannot find parent for new node"))
11750 (let ((file (nth 1 parent-target))
11751 (pos (nth 3 parent-target))
11752 level)
11753 (with-current-buffer (or (find-buffer-visiting file)
11754 (find-file-noselect file))
11755 (save-excursion
11756 (save-restriction
11757 (widen)
11758 (if pos
11759 (goto-char pos)
11760 (goto-char (point-max))
11761 (if (not (bolp)) (newline)))
11762 (when (looking-at org-outline-regexp)
11763 (setq level (funcall outline-level))
11764 (org-end-of-subtree t t))
11765 (org-back-over-empty-lines)
11767 (if pos (org-get-valid-level level 1) 1) ?*)
11769 (beginning-of-line 0)
11770 (list (concat (car parent-target) "/" child) file "" (point)))))))
11772 (defun org-olpath-completing-read (prompt collection &rest args)
11773 "Read an outline path like a file name."
11774 (let ((thetable collection)
11775 (org-completion-use-ido nil) ; does not work with ido.
11776 (org-completion-use-iswitchb nil)) ; or iswitchb
11777 (apply
11778 'org-icompleting-read prompt
11779 (lambda (string predicate &optional flag)
11780 (let (rtn r f (l (length string)))
11781 (cond
11782 ((eq flag nil)
11783 ;; try completion
11784 (try-completion string thetable))
11785 ((eq flag t)
11786 ;; all-completions
11787 (setq rtn (all-completions string thetable predicate))
11788 (mapcar
11789 (lambda (x)
11790 (setq r (substring x l))
11791 (if (string-match " ([^)]*)$" x)
11792 (setq f (match-string 0 x))
11793 (setq f ""))
11794 (if (string-match "/" r)
11795 (concat string (substring r 0 (match-end 0)) f)
11796 x))
11797 rtn))
11798 ((eq flag 'lambda)
11799 ;; exact match?
11800 (assoc string thetable)))))
11801 args)))
11803 ;;;; Dynamic blocks
11805 (defun org-find-dblock (name)
11806 "Find the first dynamic block with name NAME in the buffer.
11807 If not found, stay at current position and return nil."
11808 (let ((case-fold-search t) pos)
11809 (save-excursion
11810 (goto-char (point-min))
11811 (setq pos (and (re-search-forward
11813 (match-beginning 0))))
11814 (if pos (goto-char pos))
11815 pos))
11817 (defconst org-dblock-start-re
11819 "Matches the start line of a dynamic block, with parameters.")
11822 "Matches the end of a dynamic block.")
11824 (defun org-create-dblock (plist)
11825 "Create a dynamic block section, with parameters taken from PLIST.
11826 PLIST must contain a :name entry which is used as name of the block."
11828 (end-of-line 1)
11829 (newline))
11830 (let ((col (current-column))
11831 (name (plist-get plist :name)))
11832 (insert "#+BEGIN: " name)
11833 (while plist
11834 (if (eq (car plist) :name)
11835 (setq plist (cddr plist))
11836 (insert " " (prin1-to-string (pop plist)))))
11838 (beginning-of-line -2)))
11840 (defun org-prepare-dblock ()
11841 "Prepare dynamic block for refresh.
11842 This empties the block, puts the cursor at the insert position and returns
11843 the property list including an extra property :name with the block name."
11844 (unless (looking-at org-dblock-start-re)
11845 (user-error "Not at a dynamic block"))
11846 (let* ((begdel (1+ (match-end 0)))
11847 (name (org-no-properties (match-string 1)))
11848 (params (append (list :name name)
11849 (read (concat "(" (match-string 3) ")")))))
11850 (save-excursion
11851 (beginning-of-line 1)
11853 (setq params (plist-put params :indentation-column (current-column))))
11854 (unless (re-search-forward org-dblock-end-re nil t)
11855 (error "Dynamic block not terminated"))
11856 (setq params
11857 (append params
11858 (list :content (buffer-substring
11859 begdel (match-beginning 0)))))
11860 (delete-region begdel (match-beginning 0))
11861 (goto-char begdel)
11862 (open-line 1)
11863 params))
11865 (defun org-map-dblocks (&optional command)
11866 "Apply COMMAND to all dynamic blocks in the current buffer.
11867 If COMMAND is not given, use `org-update-dblock'."
11868 (let ((cmd (or command 'org-update-dblock)))
11869 (save-excursion
11870 (goto-char (point-min))
11871 (while (re-search-forward org-dblock-start-re nil t)
11872 (goto-char (match-beginning 0))
11873 (save-excursion
11874 (condition-case nil
11875 (funcall cmd)
11876 (error (message "Error during update of dynamic block"))))
11877 (unless (re-search-forward org-dblock-end-re nil t)
11878 (error "Dynamic block not terminated"))))))
11880 (defun org-dblock-update (&optional arg)
11881 "User command for updating dynamic blocks.
11882 Update the dynamic block at point. With prefix ARG, update all dynamic
11883 blocks in the buffer."
11884 (interactive "P")
11885 (if arg
11886 (org-update-all-dblocks)
11887 (or (looking-at org-dblock-start-re)
11888 (org-beginning-of-dblock))
11889 (org-update-dblock)))
11891 (defun org-update-dblock ()
11892 "Update the dynamic block at point.
11893 This means to empty the block, parse for parameters and then call
11894 the correct writing function."
11895 (interactive)
11896 (save-window-excursion
11897 (let* ((pos (point))
11898 (line (org-current-line))
11899 (params (org-prepare-dblock))
11900 (name (plist-get params :name))
11901 (indent (plist-get params :indentation-column))
11902 (cmd (intern (concat "org-dblock-write:" name))))
11903 (message "Updating dynamic block `%s' at line %d..." name line)
11904 (funcall cmd params)
11905 (message "Updating dynamic block `%s' at line %d...done" name line)
11906 (goto-char pos)
11907 (when (and indent (> indent 0))
11908 (setq indent (make-string indent ?\ ))
11909 (save-excursion
11910 (org-beginning-of-dblock)
11911 (forward-line 1)
11912 (while (not (looking-at org-dblock-end-re))
11913 (insert indent)
11914 (beginning-of-line 2))
11915 (when (looking-at org-dblock-end-re)
11917 (replace-match ""))
11918 (insert indent)))))))
11920 (defun org-beginning-of-dblock ()
11921 "Find the beginning of the dynamic block at point.
11922 Error if there is no such block at point."
11923 (let ((pos (point))
11924 beg)
11925 (end-of-line 1)
11926 (if (and (re-search-backward org-dblock-start-re nil t)
11927 (setq beg (match-beginning 0))
11928 (re-search-forward org-dblock-end-re nil t)
11929 (> (match-end 0) pos))
11930 (goto-char beg)
11931 (goto-char pos)
11932 (error "Not in a dynamic block"))))
11934 (defun org-update-all-dblocks ()
11935 "Update all dynamic blocks in the buffer.
11936 This function can be used in a hook."
11937 (interactive)
11938 (when (derived-mode-p 'org-mode)
11939 (org-map-dblocks 'org-update-dblock)))
11942 ;;;; Completion
11944 (declare-function org-export-backend-name "org-export" (cl-x))
11945 (declare-function org-export-backend-options "org-export" (cl-x))
11946 (defun org-get-export-keywords ()
11947 "Return a list of all currently understood export keywords.
11948 Export keywords include options, block names, attributes and
11949 keywords relative to each registered export back-end."
11950 (let (keywords)
11951 (dolist (backend
11952 (org-bound-and-true-p org-export--registered-backends)
11953 (delq nil keywords))
11954 ;; Back-end name (for keywords, like #+LATEX:)
11955 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
11956 (dolist (option-entry (org-export-backend-options backend))
11957 ;; Back-end options.
11958 (push (nth 1 option-entry) keywords)))))
11960 (defconst org-options-keywords
11961 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11962 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11963 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11964 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11965 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11967 (defcustom org-structure-template-alist
11981 ("A" "#+ASCII: " "")
11982 ("i" "#+INDEX: ?" "#+INDEX: ?")
11983 ("I" "#+INCLUDE: %file ?"
11985 "Structure completion elements.
11986 This is a list of abbreviation keys and values. The value gets inserted
11987 if you type `<' followed by the key and then press the completion key,
11988 usually `M-TAB'. %file will be replaced by a file name after prompting
11989 for the file using completion. The cursor will be placed at the position
11990 of the `?` in the template.
11991 There are two templates for each key, the first uses the original Org syntax,
11992 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11993 the default when the /org-mtags.el/ module has been loaded. See also the
11994 variable `org-mtags-prefer-muse-templates'."
11995 :group 'org-completion
11996 :type '(repeat
11997 (list
11998 (string :tag "Key")
11999 (string :tag "Template")
12000 (string :tag "Muse Template"))))
12002 (defun org-try-structure-completion ()
12003 "Try to complete a structure template before point.
12005 expands them."
12006 (let ((l (buffer-substring (point-at-bol) (point)))
12007 a)
12010 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12011 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12012 (match-beginning 1)) a)
12013 t)))
12015 (defun org-complete-expand-structure-template (start cell)
12016 "Expand a structure template."
12017 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12018 (rpl (nth (if musep 2 1) cell))
12019 (ind ""))
12020 (delete-region start (point))
12022 (cond
12023 ((bolp))
12025 (setq ind (buffer-substring (point-at-bol) (point))))
12026 (t (newline))))
12027 (setq start (point))
12028 (if (string-match "%file" rpl)
12029 (setq rpl (replace-match
12030 (concat
12032 (save-match-data
12033 (abbreviate-file-name (read-file-name "Include file: ")))
12035 t t rpl)))
12038 (insert rpl)
12041 ;;;; TODO, DEADLINE, Comments
12043 (defun org-toggle-comment ()
12044 "Change the COMMENT state of an entry."
12045 (interactive)
12046 (save-excursion
12047 (org-back-to-heading)
12048 (let (case-fold-search)
12049 (cond
12050 ((looking-at (format org-heading-keyword-regexp-format
12051 org-comment-string))
12052 (goto-char (match-end 1))
12053 (looking-at (concat " +" org-comment-string))
12054 (replace-match "" t t)
12055 (when (eolp) (insert " ")))
12056 ((looking-at org-outline-regexp)
12057 (goto-char (match-end 0))
12058 (insert org-comment-string " "))))))
12060 (defvar org-last-todo-state-is-todo nil
12061 "This is non-nil when the last TODO state change led to a TODO state.
12062 If the last change removed the TODO tag or switched to DONE, then
12063 this is nil.")
12065 (defvar org-setting-tags nil) ; dynamically skipped
12067 (defvar org-todo-setup-filter-hook nil
12068 "Hook for functions that pre-filter todo specs.
12069 Each function takes a todo spec and returns either nil or the spec
12070 transformed into canonical form." )
12072 (defvar org-todo-get-default-hook nil
12073 "Hook for functions that get a default item for todo.
12074 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12075 nil or a string to be used for the todo mark." )
12077 (defvar org-agenda-headline-snapshot-before-repeat)
12079 (defun org-current-effective-time ()
12080 "Return current time adjusted for `org-extend-today-until' variable."
12081 (let* ((ct (org-current-time))
12082 (dct (decode-time ct))
12083 (ct1
12084 (cond
12085 (org-use-last-clock-out-time-as-effective-time
12086 (or (org-clock-get-last-clock-out-time) ct))
12087 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12088 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12089 (t ct))))
12090 ct1))
12092 (defun org-todo-yesterday (&optional arg)
12093 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12094 (interactive "P")
12095 (if (eq major-mode 'org-agenda-mode)
12096 (apply 'org-agenda-todo-yesterday arg)
12097 (let* ((hour (third (decode-time
12098 (org-current-time))))
12099 (org-extend-today-until (1+ hour)))
12100 (org-todo arg))))
12102 (defvar org-block-entry-blocking ""
12103 "First entry preventing the TODO state change.")
12105 (defun org-todo (&optional arg)
12106 "Change the TODO state of an item.
12107 The state of an item is given by a keyword at the start of the heading,
12108 like
12109 *** TODO Write paper
12110 *** DONE Call mom
12112 The different keywords are specified in the variable `org-todo-keywords'.
12114 So for this example: when the item starts with TODO, it is changed to DONE.
12115 When it starts with DONE, the DONE is removed. And when neither TODO nor
12116 DONE are present, add TODO at the beginning of the heading.
12119 state.
12120 With numeric prefix arg, switch to that state.
12122 keywords (nextset).
12124 With a numeric prefix arg of 0, inhibit note taking for the change.
12126 For calling through lisp, arg is also interpreted in the following way:
12127 'none -> empty state
12129 'done -> switch to DONE
12130 'nextset -> switch to the next set of keywords
12131 'previousset -> switch to the previous set of keywords
12133 really is a member of `org-todo-keywords'."
12134 (interactive "P")
12135 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12136 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12137 'region-start-level 'region))
12138 org-loop-over-headlines-in-active-region)
12139 (org-map-entries
12140 `(org-todo ,arg)
12141 org-loop-over-headlines-in-active-region
12142 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12143 (if (equal arg '(16)) (setq arg 'nextset))
12144 (let ((org-blocker-hook org-blocker-hook)
12145 commentp
12146 case-fold-search)
12147 (when (equal arg '(64))
12148 (setq arg nil org-blocker-hook nil))
12149 (when (and org-blocker-hook
12150 (or org-inhibit-blocking
12151 (org-entry-get nil "NOBLOCKING")))
12152 (setq org-blocker-hook nil))
12153 (save-excursion
12154 (catch 'exit
12155 (org-back-to-heading t)
12157 (org-toggle-comment)
12158 (setq commentp t))
12159 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12162 (let* ((match-data (match-data))
12163 (startpos (point-at-bol))
12164 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12165 (org-log-done org-log-done)
12166 (org-log-repeat org-log-repeat)
12167 (org-todo-log-states org-todo-log-states)
12168 (org-inhibit-logging
12169 (if (equal arg 0)
12170 (progn (setq arg nil) 'note) org-inhibit-logging))
12171 (this (match-string 1))
12172 (hl-pos (match-beginning 0))
12173 (head (org-get-todo-sequence-head this))
12174 (ass (assoc head org-todo-kwd-alist))
12175 (interpret (nth 1 ass))
12176 (done-word (nth 3 ass))
12177 (final-done-word (nth 4 ass))
12178 (org-last-state (or this ""))
12179 (completion-ignore-case t)
12180 (member (member this org-todo-keywords-1))
12181 (tail (cdr member))
12182 (org-state (cond
12183 ((and org-todo-key-trigger
12184 (or (and (equal arg '(4))
12185 (eq org-use-fast-todo-selection 'prefix))
12186 (and (not arg) org-use-fast-todo-selection
12187 (not (eq org-use-fast-todo-selection
12188 'prefix)))))
12189 ;; Use fast selection
12190 (org-fast-todo-selection))
12191 ((and (equal arg '(4))
12192 (or (not org-use-fast-todo-selection)
12193 (not org-todo-key-trigger)))
12194 ;; Read a state with completion
12195 (org-icompleting-read
12196 "State: " (mapcar 'list org-todo-keywords-1)
12197 nil t))
12198 ((eq arg 'right)
12199 (if this
12200 (if tail (car tail) nil)
12201 (car org-todo-keywords-1)))
12202 ((eq arg 'left)
12203 (if (equal member org-todo-keywords-1)
12204 nil
12205 (if this
12206 (nth (- (length org-todo-keywords-1)
12207 (length tail) 2)
12208 org-todo-keywords-1)
12209 (org-last org-todo-keywords-1))))
12210 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12211 (setq arg nil))) ; hack to fall back to cycling
12212 (arg
12213 ;; user or caller requests a specific state
12214 (cond
12215 ((equal arg "") nil)
12216 ((eq arg 'none) nil)
12217 ((eq arg 'done) (or done-word (car org-done-keywords)))
12218 ((eq arg 'nextset)
12219 (or (car (cdr (member head org-todo-heads)))
12220 (car org-todo-heads)))
12221 ((eq arg 'previousset)
12222 (let ((org-todo-heads (reverse org-todo-heads)))
12223 (or (car (cdr (member head org-todo-heads)))
12224 (car org-todo-heads))))
12225 ((car (member arg org-todo-keywords-1)))
12226 ((stringp arg)
12227 (user-error "State `%s' not valid in this file" arg))
12228 ((nth (1- (prefix-numeric-value arg))
12229 org-todo-keywords-1))))
12230 ((null member) (or head (car org-todo-keywords-1)))
12231 ((equal this final-done-word) nil) ;; -> make empty
12232 ((null tail) nil) ;; -> first entry
12233 ((memq interpret '(type priority))
12234 (if (eq this-command last-command)
12235 (car tail)
12236 (if (> (length tail) 0)
12237 (or done-word (car org-done-keywords))
12238 nil)))
12239 (t
12240 (car tail))))
12241 (org-state (or
12242 (run-hook-with-args-until-success
12243 'org-todo-get-default-hook org-state org-last-state)
12244 org-state))
12245 (next (if org-state (concat " " org-state " ") " "))
12246 (change-plist (list :type 'todo-state-change :from this :to org-state
12247 :position startpos))
12248 dolog now-done-p)
12249 (when org-blocker-hook
12250 (setq org-last-todo-state-is-todo
12251 (not (member this org-done-keywords)))
12252 (unless (save-excursion
12253 (save-match-data
12254 (org-with-wide-buffer
12255 (run-hook-with-args-until-failure
12256 'org-blocker-hook change-plist))))
12257 (if (org-called-interactively-p 'interactive)
12259 this org-state org-block-entry-blocking)
12260 ;; fail silently
12262 this org-state org-block-entry-blocking)
12263 (throw 'exit nil))))
12264 (store-match-data match-data)
12265 (replace-match next t t)
12266 (unless (pos-visible-in-window-p hl-pos)
12267 (message "TODO state changed to %s" (org-trim next)))
12268 (unless head
12269 (setq head (org-get-todo-sequence-head org-state)
12270 ass (assoc head org-todo-kwd-alist)
12271 interpret (nth 1 ass)
12272 done-word (nth 3 ass)
12273 final-done-word (nth 4 ass)))
12274 (when (memq arg '(nextset previousset))
12275 (message "Keyword-Set %d/%d: %s"
12276 (- (length org-todo-sets) -1
12277 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12278 (length org-todo-sets)
12279 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12280 (setq org-last-todo-state-is-todo
12281 (not (member org-state org-done-keywords)))
12282 (setq now-done-p (and (member org-state org-done-keywords)
12283 (not (member this org-done-keywords))))
12284 (and logging (org-local-logging logging))
12285 (when (and (or org-todo-log-states org-log-done)
12286 (not (eq org-inhibit-logging t))
12287 (not (memq arg '(nextset previousset))))
12288 ;; we need to look at recording a time and note
12289 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12290 (nth 2 (assoc this org-todo-log-states))))
12291 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12292 (setq dolog 'time))
12293 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12294 (and org-state
12295 (member org-state org-not-done-keywords)
12296 (not (member this org-not-done-keywords))))
12297 ;; This is now a todo state and was not one before
12298 ;; If there was a CLOSED time stamp, get rid of it.
12299 (org-add-planning-info nil nil 'closed))
12300 (when (and now-done-p org-log-done)
12301 ;; It is now done, and it was not done before
12302 (org-add-planning-info 'closed (org-current-effective-time))
12303 (if (and (not dolog) (eq 'note org-log-done))
12304 (org-add-log-setup 'done org-state this 'findpos 'note)))
12305 (when (and org-state dolog)
12306 ;; This is a non-nil state, and we need to log it
12307 (org-add-log-setup 'state org-state this 'findpos dolog)))
12308 ;; Fixup tag positioning
12309 (org-todo-trigger-tag-changes org-state)
12310 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12311 (when org-provide-todo-statistics
12312 (org-update-parent-todo-statistics))
12313 (run-hooks 'org-after-todo-state-change-hook)
12314 (if (and arg (not (member org-state org-done-keywords)))
12315 (setq head (org-get-todo-sequence-head org-state)))
12316 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12317 ;; Do we need to trigger a repeat?
12318 (when now-done-p
12319 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12320 ;; This is for the agenda, take a snapshot of the headline.
12321 (save-match-data
12322 (setq org-agenda-headline-snapshot-before-repeat
12323 (org-get-heading))))
12324 (org-auto-repeat-maybe org-state))
12325 ;; Fixup cursor location if close to the keyword
12326 (if (and (outline-on-heading-p)
12327 (not (bolp))
12328 (save-excursion (beginning-of-line 1)
12329 (looking-at org-todo-line-regexp))
12330 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12331 (progn
12332 (goto-char (or (match-end 2) (match-end 1)))
12333 (and (looking-at " ") (just-one-space))))
12334 (when org-trigger-hook
12335 (save-excursion
12336 (run-hook-with-args 'org-trigger-hook change-plist)))
12337 (when commentp (org-toggle-comment))))))))
12339 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12340 "Block turning an entry into a TODO, using the hierarchy.
12341 This checks whether the current task should be blocked from state
12342 changes. Such blocking occurs when:
12344 1. The task has children which are not all in a completed state.
12346 2. A task has a parent with the property :ORDERED:, and there
12347 are siblings prior to the current task with incomplete
12348 status.
12350 3. The parent of the task is blocked because it has siblings that should
12351 be done first, or is child of a block grandparent TODO entry."
12353 (if (not org-enforce-todo-dependencies)
12354 t ; if locally turned off don't block
12355 (catch 'dont-block
12356 ;; If this is not a todo state change, or if this entry is already DONE,
12357 ;; do not block
12358 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12359 (member (plist-get change-plist :from)
12360 (cons 'done org-done-keywords))
12361 (member (plist-get change-plist :to)
12362 (cons 'todo org-not-done-keywords))
12363 (not (plist-get change-plist :to)))
12364 (throw 'dont-block t))
12365 ;; If this task has children, and any are undone, it's blocked
12366 (save-excursion
12367 (org-back-to-heading t)
12368 (let ((this-level (funcall outline-level)))
12369 (outline-next-heading)
12370 (let ((child-level (funcall outline-level)))
12371 (while (and (not (eobp))
12372 (> child-level this-level))
12373 ;; this todo has children, check whether they are all
12374 ;; completed
12375 (if (and (not (org-entry-is-done-p))
12376 (org-entry-is-todo-p))
12377 (progn (setq org-block-entry-blocking (org-get-heading))
12378 (throw 'dont-block nil)))
12379 (outline-next-heading)
12380 (setq child-level (funcall outline-level))))))
12381 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12382 ;; any previous siblings are undone, it's blocked
12383 (save-excursion
12384 (org-back-to-heading t)
12385 (let* ((pos (point))
12386 (parent-pos (and (org-up-heading-safe) (point))))
12387 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12388 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12389 (forward-line 1)
12390 (re-search-forward org-not-done-heading-regexp pos t))
12391 (setq org-block-entry-blocking (match-string 0))
12392 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12393 ;; Search further up the hierarchy, to see if an ancestor is blocked
12394 (while t
12395 (goto-char parent-pos)
12396 (if (not (looking-at org-not-done-heading-regexp))
12397 (throw 'dont-block t)) ; do not block, parent is not a TODO
12398 (setq pos (point))
12399 (setq parent-pos (and (org-up-heading-safe) (point)))
12400 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12401 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12402 (forward-line 1)
12403 (re-search-forward org-not-done-heading-regexp pos t)
12404 (setq org-block-entry-blocking (org-get-heading)))
12405 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12407 (defcustom org-track-ordered-property-with-tag nil
12408 "Should the ORDERED property also be shown as a tag?
12409 The ORDERED property decides if an entry should require subtasks to be
12410 completed in sequence. Since a property is not very visible, setting
12411 this option means that toggling the ORDERED property with the command
12412 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12413 not relevant for the behavior, but it makes things more visible.
12415 Note that toggling the tag with tags commands will not change the property
12416 and therefore not influence behavior!
12418 This can be t, meaning the tag ORDERED should be used, It can also be a
12419 string to select a different tag for this task."
12420 :group 'org-todo
12421 :type '(choice
12422 (const :tag "No tracking" nil)
12423 (const :tag "Track with ORDERED tag" t)
12424 (string :tag "Use other tag")))
12426 (defun org-toggle-ordered-property ()
12427 "Toggle the ORDERED property of the current entry.
12428 For better visibility, you can track the value of this property with a tag.
12429 See variable `org-track-ordered-property-with-tag'."
12430 (interactive)
12431 (let* ((t1 org-track-ordered-property-with-tag)
12432 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12433 (save-excursion
12434 (org-back-to-heading)
12435 (if (org-entry-get nil "ORDERED")
12436 (progn
12437 (org-delete-property "ORDERED")
12438 (and tag (org-toggle-tag tag 'off))
12439 (message "Subtasks can be completed in arbitrary order"))
12440 (org-entry-put nil "ORDERED" "t")
12441 (and tag (org-toggle-tag tag 'on))
12442 (message "Subtasks must be completed in sequence")))))
12444 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12445 (defun org-block-todo-from-checkboxes (change-plist)
12446 "Block turning an entry into a TODO, using checkboxes.
12447 This checks whether the current task should be blocked from state
12448 changes because there are unchecked boxes in this entry."
12449 (if (not org-enforce-todo-checkbox-dependencies)
12450 t ; if locally turned off don't block
12451 (catch 'dont-block
12452 ;; If this is not a todo state change, or if this entry is already DONE,
12453 ;; do not block
12454 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12455 (member (plist-get change-plist :from)
12456 (cons 'done org-done-keywords))
12457 (member (plist-get change-plist :to)
12458 (cons 'todo org-not-done-keywords))
12459 (not (plist-get change-plist :to)))
12460 (throw 'dont-block t))
12461 ;; If this task has checkboxes that are not checked, it's blocked
12462 (save-excursion
12463 (org-back-to-heading t)
12464 (let ((beg (point)) end)
12465 (outline-next-heading)
12466 (setq end (point))
12467 (goto-char beg)
12468 (if (org-list-search-forward
12469 (concat (org-item-beginning-re)
12472 end t)
12473 (progn
12474 (if (boundp 'org-blocked-by-checkboxes)
12475 (setq org-blocked-by-checkboxes t))
12476 (throw 'dont-block nil)))))
12477 t))) ; do not block
12479 (defun org-entry-blocked-p ()
12480 "Is the current entry blocked?"
12481 (org-with-silent-modifications
12482 (if (org-entry-get nil "NOBLOCKING")
12483 nil ;; Never block this entry
12484 (not (run-hook-with-args-until-failure
12485 'org-blocker-hook
12486 (list :type 'todo-state-change
12487 :position (point)
12488 :from 'todo
12489 :to 'done))))))
12491 (defun org-update-statistics-cookies (all)
12492 "Update the statistics cookie, either from TODO or from checkboxes.
12493 This should be called with the cursor in a line with a statistics cookie."
12494 (interactive "P")
12495 (if all
12496 (progn
12497 (org-update-checkbox-count 'all)
12498 (org-map-entries 'org-update-parent-todo-statistics))
12499 (if (not (org-at-heading-p))
12500 (org-update-checkbox-count)
12501 (let ((pos (point-marker))
12502 end l1 l2)
12503 (ignore-errors (org-back-to-heading t))
12504 (if (not (org-at-heading-p))
12505 (org-update-checkbox-count)
12506 (setq l1 (org-outline-level))
12507 (setq end (save-excursion
12508 (outline-next-heading)
12509 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12510 (point)))
12511 (if (and (save-excursion
12512 (re-search-forward
12514 (not (save-excursion (re-search-forward
12516 (org-update-checkbox-count)
12517 (if (and l2 (> l2 l1))
12518 (progn
12519 (goto-char end)
12520 (org-update-parent-todo-statistics))
12521 (goto-char pos)
12522 (beginning-of-line 1)
12523 (while (re-search-forward
12525 (point-at-eol) t)
12526 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12527 (goto-char pos)
12528 (move-marker pos nil)))))
12530 (defvar org-entry-property-inherited-from) ;; defined below
12531 (defun org-update-parent-todo-statistics ()
12532 "Update any statistics cookie in the parent of the current headline.
12533 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12534 the entire subtree and this will travel up the hierarchy and update
12535 statistics everywhere."
12536 (let* ((prop (save-excursion (org-up-heading-safe)
12537 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12538 (recursive (or (not org-hierarchical-todo-statistics)
12540 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12541 0))
12542 (first t)
12544 level ltoggle l1 new ndel
12545 (cnt-all 0) (cnt-done 0) is-percent kwd
12546 checkbox-beg ov ovs ove cookie-present)
12547 (catch 'exit
12548 (save-excursion
12549 (beginning-of-line 1)
12550 (setq ltoggle (funcall outline-level))
12551 ;; Three situations are to consider:
12553 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12554 ;; to the top-level ancestor on the headline;
12556 ;; 2. If parent has "recursive" property, repeat up to the
12557 ;; headline setting that property, taking inheritance into
12558 ;; account;
12560 ;; 3. Else, move up to direct parent and proceed only once.
12561 (while (and (setq level (org-up-heading-safe))
12562 (or recursive first)
12563 (>= (point) lim))
12564 (setq first nil cookie-present nil)
12565 (unless (and level
12566 (not (string-match
12568 (downcase (or (org-entry-get nil "COOKIE_DATA")
12569 "")))))
12570 (throw 'exit nil))
12571 (while (re-search-forward box-re (point-at-eol) t)
12572 (setq cnt-all 0 cnt-done 0 cookie-present t)
12573 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12574 (save-match-data
12575 (unless (outline-next-heading) (throw 'exit nil))
12576 (while (and (looking-at org-complex-heading-regexp)
12577 (> (setq l1 (length (match-string 1))) level))
12578 (setq kwd (and (or recursive (= l1 ltoggle))
12579 (match-string 2)))
12580 (if (or (eq org-provide-todo-statistics 'all-headlines)
12581 (and (listp org-provide-todo-statistics)
12582 (or (member kwd org-provide-todo-statistics)
12583 (member kwd org-done-keywords))))
12584 (setq cnt-all (1+ cnt-all))
12585 (if (eq org-provide-todo-statistics t)
12586 (and kwd (setq cnt-all (1+ cnt-all)))))
12587 (and (member kwd org-done-keywords)
12588 (setq cnt-done (1+ cnt-done)))
12589 (outline-next-heading)))
12590 (setq new
12591 (if is-percent
12592 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12593 (format "[%d/%d]" cnt-done cnt-all))
12594 ndel (- (match-end 0) checkbox-beg))
12595 ;; handle overlays when updating cookie from column view
12596 (when (setq ov (car (overlays-at checkbox-beg)))
12597 (setq ovs (overlay-start ov) ove (overlay-end ov))
12598 (delete-overlay ov))
12599 (goto-char checkbox-beg)
12600 (insert new)
12601 (delete-region (point) (+ (point) ndel))
12602 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12603 (when ov (move-overlay ov ovs ove)))
12604 (when cookie-present
12605 (run-hook-with-args 'org-after-todo-statistics-hook
12606 cnt-done (- cnt-all cnt-done))))))
12607 (run-hooks 'org-todo-statistics-hook)))
12609 (defvar org-after-todo-statistics-hook nil
12610 "Hook that is called after a TODO statistics cookie has been updated.
12611 Each function is called with two arguments: the number of not-done entries
12612 and the number of done entries.
12614 For example, the following function, when added to this hook, will switch
12615 an entry to DONE when all children are done, and back to TODO when new
12616 entries are set to a TODO status. Note that this hook is only called
12617 when there is a statistics cookie in the headline!
12619 (defun org-summary-todo (n-done n-not-done)
12621 (let (org-log-done org-log-states) ; turn off logging
12623 ")
12625 (defvar org-todo-statistics-hook nil
12626 "Hook that is run whenever Org thinks TODO statistics should be updated.
12627 This hook runs even if there is no statistics cookie present, in which case
12628 `org-after-todo-statistics-hook' would not run.")
12630 (defun org-todo-trigger-tag-changes (state)
12631 "Apply the changes defined in `org-todo-state-tags-triggers'."
12632 (let ((l org-todo-state-tags-triggers)
12633 changes)
12634 (when (or (not state) (equal state ""))
12635 (setq changes (append changes (cdr (assoc "" l)))))
12636 (when (and (stringp state) (> (length state) 0))
12637 (setq changes (append changes (cdr (assoc state l)))))
12638 (when (member state org-not-done-keywords)
12639 (setq changes (append changes (cdr (assoc 'todo l)))))
12640 (when (member state org-done-keywords)
12641 (setq changes (append changes (cdr (assoc 'done l)))))
12642 (dolist (c changes)
12643 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12645 (defun org-local-logging (value)
12646 "Get logging settings from a property VALUE."
12647 (let* (words w a)
12648 ;; directly set the variables, they are already local.
12649 (setq org-log-done nil
12650 org-log-repeat nil
12651 org-todo-log-states nil)
12652 (setq words (org-split-string value))
12653 (while (setq w (pop words))
12654 (cond
12655 ((setq a (assoc w org-startup-options))
12656 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12657 (set (nth 1 a) (nth 2 a))))
12658 ((setq a (org-extract-log-state-settings w))
12659 (and (member (car a) org-todo-keywords-1)
12660 (push a org-todo-log-states)))))))
12662 (defun org-get-todo-sequence-head (kwd)
12663 "Return the head of the TODO sequence to which KWD belongs.
12664 If KWD is not set, check if there is a text property remembering the
12665 right sequence."
12666 (let (p)
12667 (cond
12668 ((not kwd)
12669 (or (get-text-property (point-at-bol) 'org-todo-head)
12670 (progn
12671 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12672 nil (point-at-eol)))
12673 (get-text-property p 'org-todo-head))))
12674 ((not (member kwd org-todo-keywords-1))
12675 (car org-todo-keywords-1))
12676 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12678 (defun org-fast-todo-selection ()
12679 "Fast TODO keyword selection with single keys.
12680 Returns the new TODO keyword, or nil if no state change should occur."
12681 (let* ((fulltable org-todo-key-alist)
12682 (done-keywords org-done-keywords) ;; needed for the faces.
12683 (maxlen (apply 'max (mapcar
12684 (lambda (x)
12685 (if (stringp (car x)) (string-width (car x)) 0))
12686 fulltable)))
12687 (expert nil)
12688 (fwidth (+ maxlen 3 1 3))
12689 (ncol (/ (- (window-width) 4) fwidth))
12690 tg cnt e c tbl
12691 groups ingroup)
12692 (save-excursion
12693 (save-window-excursion
12694 (if expert
12695 (set-buffer (get-buffer-create " *Org todo*"))
12696 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12697 (erase-buffer)
12698 (org-set-local 'org-done-keywords done-keywords)
12699 (setq tbl fulltable cnt 0)
12700 (while (setq e (pop tbl))
12701 (cond
12702 ((equal e '(:startgroup))
12703 (push '() groups) (setq ingroup t)
12704 (when (not (= cnt 0))
12705 (setq cnt 0)
12707 (insert "{ "))
12708 ((equal e '(:endgroup))
12709 (setq ingroup nil cnt 0)
12711 ((equal e '(:newline))
12712 (when (not (= cnt 0))
12713 (setq cnt 0)
12715 (setq e (car tbl))
12716 (while (equal (car tbl) '(:newline))
12718 (setq tbl (cdr tbl)))))
12719 (t
12720 (setq tg (car e) c (cdr e))
12721 (if ingroup (push tg (car groups)))
12722 (setq tg (org-add-props tg nil 'face
12723 (org-get-todo-face tg)))
12724 (if (and (= cnt 0) (not ingroup)) (insert " "))
12725 (insert "[" c "] " tg (make-string
12726 (- fwidth 4 (length tg)) ?\ ))
12727 (when (= (setq cnt (1+ cnt)) ncol)
12729 (if ingroup (insert " "))
12730 (setq cnt 0)))))
12732 (goto-char (point-min))
12733 (if (not expert) (org-fit-window-to-buffer))
12734 (message "[a-z..]:Set [SPC]:clear")
12735 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12736 (cond
12737 ((or (= c ?\C-g)
12738 (and (= c ?q) (not (rassoc c fulltable))))
12739 (setq quit-flag t))
12740 ((= c ?\ ) nil)
12741 ((setq e (rassoc c fulltable) tg (car e))
12742 tg)
12743 (t (setq quit-flag t)))))))
12745 (defun org-entry-is-todo-p ()
12746 (member (org-get-todo-state) org-not-done-keywords))
12748 (defun org-entry-is-done-p ()
12749 (member (org-get-todo-state) org-done-keywords))
12751 (defun org-get-todo-state ()
12752 "Return the TODO keyword of the current subtree."
12753 (save-excursion
12754 (org-back-to-heading t)
12755 (and (looking-at org-todo-line-regexp)
12756 (match-end 2)
12757 (match-string 2))))
12759 (defun org-at-date-range-p (&optional inactive-ok)
12760 "Is the cursor inside a date range?"
12761 (interactive)
12762 (save-excursion
12763 (catch 'exit
12764 (let ((pos (point)))
12766 (skip-chars-backward "<[")
12767 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12768 (>= (match-end 0) pos)
12769 (throw 'exit t))
12771 (skip-chars-backward "<[")
12772 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12773 (>= (match-end 0) pos)
12774 (throw 'exit t)))
12775 nil)))
12777 (defun org-get-repeat (&optional tagline)
12778 "Check if there is a deadline/schedule with repeater in this entry."
12779 (save-match-data
12780 (save-excursion
12781 (org-back-to-heading t)
12782 (and (re-search-forward (if tagline
12784 org-repeat-re)
12785 (org-entry-end-position) t)
12786 (match-string-no-properties 1)))))
12788 (defvar org-last-changed-timestamp)
12789 (defvar org-last-inserted-timestamp)
12790 (defvar org-log-post-message)
12791 (defvar org-log-note-purpose)
12792 (defvar org-log-note-how)
12793 (defvar org-log-note-extra)
12794 (defun org-auto-repeat-maybe (done-word)
12795 "Check if the current headline contains a repeated deadline/schedule.
12796 If yes, set TODO state back to what it was and change the base date
12797 of repeating deadline/scheduled time stamps to new date.
12798 This function is run automatically after each state change to a DONE state."
12799 ;; last-state is dynamically scoped into this function
12800 (let* ((repeat (org-get-repeat))
12801 (aa (assoc org-last-state org-todo-kwd-alist))
12802 (interpret (nth 1 aa))
12803 (head (nth 2 aa))
12804 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12805 (msg "Entry repeats: ")
12806 (org-log-done nil)
12807 (org-todo-log-states nil)
12808 re type n what ts time to-state)
12809 (when repeat
12810 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12811 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12812 org-todo-repeat-to-state))
12813 (unless (and to-state (member to-state org-todo-keywords-1))
12814 (setq to-state (if (eq interpret 'type) org-last-state head)))
12815 (org-todo to-state)
12816 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12817 (org-entry-put nil "LAST_REPEAT" (format-time-string
12818 (org-time-stamp-format t t))))
12819 (when org-log-repeat
12820 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12821 (memq 'org-add-log-note post-command-hook))
12822 ;; OK, we are already setup for some record
12823 (if (eq org-log-repeat 'note)
12824 ;; make sure we take a note, not only a time stamp
12825 (setq org-log-note-how 'note))
12826 ;; Set up for taking a record
12827 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12828 org-last-state
12829 'findpos org-log-repeat)))
12830 (org-back-to-heading t)
12831 (org-add-planning-info nil nil 'closed)
12835 (while (re-search-forward
12836 re (save-excursion (outline-next-heading) (point)) t)
12837 (setq type (if (match-end 1) org-scheduled-string
12838 (if (match-end 3) org-deadline-string "Plain:"))
12839 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12841 (setq n (string-to-number (match-string 2 ts))
12842 what (match-string 3 ts))
12843 (if (equal what "w") (setq n (* n 7) what "d"))
12845 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12846 ;; Preparation, see if we need to modify the start date for the change
12847 (when (match-end 1)
12848 (setq time (save-match-data (org-time-string-to-time ts)))
12849 (cond
12850 ((equal (match-string 1 ts) ".")
12851 ;; Shift starting date to today
12852 (org-timestamp-change
12853 (- (org-today) (time-to-days time))
12854 'day))
12855 ((equal (match-string 1 ts) "+")
12856 (let ((nshiftmax 10) (nshift 0))
12857 (while (or (= nshift 0)
12858 (<= (time-to-days time)
12859 (time-to-days (current-time))))
12860 (when (= (incf nshift) nshiftmax)
12861 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12862 (error "Abort")))
12863 (org-timestamp-change n (cdr (assoc what whata)))
12864 (org-at-timestamp-p t)
12865 (setq ts (match-string 1))
12866 (setq time (save-match-data (org-time-string-to-time ts)))))
12867 (org-timestamp-change (- n) (cdr (assoc what whata)))
12868 ;; rematch, so that we have everything in place for the real shift
12869 (org-at-timestamp-p t)
12870 (setq ts (match-string 1))
12872 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12873 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12874 (setq org-log-post-message msg)
12875 (message "%s" msg))))
12877 (defun org-show-todo-tree (arg)
12878 "Make a compact tree which shows all headlines marked with TODO.
12879 The tree will show the lines where the regexp matches, and all higher
12880 headlines above the match.
12882 With a numeric prefix N, construct a sparse tree for the Nth element
12883 of `org-todo-keywords-1'."
12884 (interactive "P")
12885 (let ((case-fold-search nil)
12886 (kwd-re
12887 (cond ((null arg) org-not-done-regexp)
12888 ((equal arg '(4))
12889 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12890 (mapcar 'list org-todo-keywords-1))))
12894 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12895 (regexp-quote (nth (1- (prefix-numeric-value arg))
12896 org-todo-keywords-1)))
12897 (t (user-error "Invalid prefix argument: %s" arg)))))
12898 (message "%d TODO entries found"
12899 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12901 (defun org-deadline (arg &optional time)
12903 With one universal prefix argument, remove any deadline from the item.
12904 With two universal prefix arguments, prompt for a warning delay.
12905 With argument TIME, set the deadline at the corresponding date. TIME
12907 (interactive "P")
12908 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12909 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12910 'region-start-level 'region))
12911 org-loop-over-headlines-in-active-region)
12912 (org-map-entries
12913 `(org-deadline ',arg ,time)
12914 org-loop-over-headlines-in-active-region
12915 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12916 (let* ((old-date (org-entry-get nil "DEADLINE"))
12917 (old-date-time (if old-date (org-time-string-to-time old-date)))
12918 (repeater (and old-date
12919 (string-match
12921 old-date)
12922 (match-string 1 old-date))))
12923 (cond
12924 ((equal arg '(4))
12925 (when (and old-date org-log-redeadline)
12926 (org-add-log-setup 'deldeadline nil old-date 'findpos
12927 org-log-redeadline))
12928 (org-remove-timestamp-with-keyword org-deadline-string)
12929 (message "Item no longer has a deadline."))
12930 ((equal arg '(16))
12931 (save-excursion
12932 (if (re-search-forward
12933 org-deadline-time-regexp
12934 (save-excursion (outline-next-heading) (point)) t)
12935 (let* ((rpl0 (match-string 1))
12936 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12937 (replace-match
12938 (concat org-deadline-string
12939 " <" rpl
12940 (format " -%dd"
12941 (abs
12942 (- (time-to-days
12943 (save-match-data
12944 (org-read-date nil t nil "Warn starting from" old-date-time)))
12945 (time-to-days old-date-time))))
12946 ">") t t))
12947 (user-error "No deadline information to update"))))
12948 (t
12949 (org-add-planning-info 'deadline time 'closed)
12950 (when (and old-date org-log-redeadline
12951 (not (equal old-date
12952 (substring org-last-inserted-timestamp 1 -1))))
12953 (org-add-log-setup 'redeadline nil old-date 'findpos
12954 org-log-redeadline))
12955 (when repeater
12956 (save-excursion
12957 (org-back-to-heading t)
12958 (when (re-search-forward (concat org-deadline-string " "
12959 org-last-inserted-timestamp)
12960 (save-excursion
12961 (outline-next-heading) (point)) t)
12962 (goto-char (1- (match-end 0)))
12963 (insert " " repeater)
12964 (setq org-last-inserted-timestamp
12965 (concat (substring org-last-inserted-timestamp 0 -1)
12966 " " repeater
12967 (substring org-last-inserted-timestamp -1))))))
12968 (message "Deadline on %s" org-last-inserted-timestamp))))))
12970 (defun org-schedule (arg &optional time)
12971 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12972 With one universal prefix argument, remove any scheduling date from the item.
12973 With two universal prefix arguments, prompt for a delay cookie.
12974 With argument TIME, scheduled at the corresponding date. TIME can
12976 (interactive "P")
12977 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12978 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12979 'region-start-level 'region))
12980 org-loop-over-headlines-in-active-region)
12981 (org-map-entries
12982 `(org-schedule ',arg ,time)
12983 org-loop-over-headlines-in-active-region
12984 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12985 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12986 (old-date-time (if old-date (org-time-string-to-time old-date)))
12987 (repeater (and old-date
12988 (string-match
12990 old-date)
12991 (match-string 1 old-date))))
12992 (cond
12993 ((equal arg '(4))
12994 (progn
12995 (when (and old-date org-log-reschedule)
12996 (org-add-log-setup 'delschedule nil old-date 'findpos
12997 org-log-reschedule))
12998 (org-remove-timestamp-with-keyword org-scheduled-string)
12999 (message "Item is no longer scheduled.")))
13000 ((equal arg '(16))
13001 (save-excursion
13002 (if (re-search-forward
13003 org-scheduled-time-regexp
13004 (save-excursion (outline-next-heading) (point)) t)
13005 (let* ((rpl0 (match-string 1))
13006 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13007 (replace-match
13008 (concat org-scheduled-string
13009 " <" rpl
13010 (format " -%dd"
13011 (abs
13012 (- (time-to-days
13013 (save-match-data
13014 (org-read-date nil t nil "Delay until" old-date-time)))
13015 (time-to-days old-date-time))))
13016 ">") t t))
13017 (user-error "No scheduled information to update"))))
13018 (t
13019 (org-add-planning-info 'scheduled time 'closed)
13020 (when (and old-date org-log-reschedule
13021 (not (equal old-date
13022 (substring org-last-inserted-timestamp 1 -1))))
13023 (org-add-log-setup 'reschedule nil old-date 'findpos
13024 org-log-reschedule))
13025 (when repeater
13026 (save-excursion
13027 (org-back-to-heading t)
13028 (when (re-search-forward (concat org-scheduled-string " "
13029 org-last-inserted-timestamp)
13030 (save-excursion
13031 (outline-next-heading) (point)) t)
13032 (goto-char (1- (match-end 0)))
13033 (insert " " repeater)
13034 (setq org-last-inserted-timestamp
13035 (concat (substring org-last-inserted-timestamp 0 -1)
13036 " " repeater
13037 (substring org-last-inserted-timestamp -1))))))
13038 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13040 (defun org-get-scheduled-time (pom &optional inherit)
13041 "Get the scheduled time as a time tuple, of a format suitable
13042 for calling org-schedule with, or if there is no scheduling,
13043 returns nil."
13044 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13045 (when time
13046 (apply 'encode-time (org-parse-time-string time)))))
13048 (defun org-get-deadline-time (pom &optional inherit)
13049 "Get the deadline as a time tuple, of a format suitable for
13050 calling org-deadline with, or if there is no scheduling, returns
13051 nil."
13052 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13053 (when time
13054 (apply 'encode-time (org-parse-time-string time)))))
13056 (defun org-remove-timestamp-with-keyword (keyword)
13057 "Remove all time stamps with KEYWORD in the current entry."
13059 beg)
13060 (save-excursion
13061 (org-back-to-heading t)
13062 (setq beg (point))
13063 (outline-next-heading)
13064 (while (re-search-backward re beg t)
13065 (replace-match "")
13067 (equal (char-before) ?\ ))
13068 (backward-delete-char 1)
13070 (point-at-bol) (point-at-eol)))
13071 (delete-region (point-at-bol)
13072 (min (point-max) (1+ (point-at-eol))))))))))
13074 (defun org-add-planning-info (what &optional time &rest remove)
13075 "Insert new timestamp with keyword in the line directly after the headline.
13076 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13077 If non is given, the user is prompted for a date.
13078 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13079 be removed."
13080 (interactive)
13081 (let (org-time-was-given org-end-time-was-given ts
13082 end default-time default-input)
13084 (catch 'exit
13085 (when (and (memq what '(scheduled deadline))
13086 (or (not time)
13087 (and (stringp time)
13088 (string-match "^[-+]+[0-9]" time))))
13089 ;; Try to get a default date/time from existing timestamp
13090 (save-excursion
13091 (org-back-to-heading t)
13092 (setq end (save-excursion (outline-next-heading) (point)))
13093 (when (re-search-forward (if (eq what 'scheduled)
13094 org-scheduled-time-regexp
13095 org-deadline-time-regexp)
13096 end t)
13097 (setq ts (match-string 1)
13098 default-time
13099 (apply 'encode-time (org-parse-time-string ts))
13100 default-input (and ts (org-get-compact-tod ts))))))
13101 (when what
13102 (setq time
13103 (if (stringp time)
13104 ;; This is a string (relative or absolute), set proper date
13105 (apply 'encode-time
13106 (org-read-date-analyze
13107 time default-time (decode-time default-time)))
13108 ;; If necessary, get the time from the user
13109 (or time (org-read-date nil 'to-time nil nil
13110 default-time default-input)))))
13112 (when (and org-insert-labeled-timestamps-at-point
13113 (member what '(scheduled deadline)))
13114 (insert
13115 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13116 (org-insert-time-stamp time org-time-was-given
13117 nil nil nil (list org-end-time-was-given))
13118 (setq what nil))
13119 (save-excursion
13120 (save-restriction
13121 (let (col list elt ts buffer-invisibility-spec)
13122 (org-back-to-heading t)
13124 (goto-char (match-end 1))
13125 (setq col (current-column))
13126 (goto-char (match-end 0))
13128 (when (and (not what)
13129 (not (looking-at
13131 org-keyword-time-not-clock-regexp))))
13132 ;; Nothing to add, nothing to remove...... :-)
13133 (throw 'exit nil))
13134 (if (and (not (looking-at org-outline-regexp))
13137 (not (equal (match-string 1) org-clock-string)))
13138 (narrow-to-region (match-beginning 0) (match-end 0))
13140 (backward-char 1)
13141 (narrow-to-region (point) (point))
13142 (and org-adapt-indentation (org-indent-to-column col)))
13143 ;; Check if we have to remove something.
13144 (setq list (cons what remove))
13145 (while list
13146 (setq elt (pop list))
13147 (when (or (and (eq elt 'scheduled)
13148 (re-search-forward org-scheduled-time-regexp nil t))
13149 (and (eq elt 'deadline)
13150 (re-search-forward org-deadline-time-regexp nil t))
13151 (and (eq elt 'closed)
13152 (re-search-forward org-closed-time-regexp nil t)))
13153 (replace-match "")
13154 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13156 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13157 (when what
13158 (insert
13159 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13160 (cond ((eq what 'scheduled) org-scheduled-string)
13161 ((eq what 'deadline) org-deadline-string)
13162 ((eq what 'closed) org-closed-string))
13163 " ")
13164 (setq ts (org-insert-time-stamp
13165 time
13166 (or org-time-was-given
13167 (and (eq what 'closed) org-log-done-with-time))
13168 (eq what 'closed)
13169 nil nil (list org-end-time-was-given)))
13170 (insert
13171 (if (not (or (bolp) (eq (char-before) ?\ )
13172 (memq (char-after) '(32 10))
13173 (eobp))) " " ""))
13174 (end-of-line 1))
13175 (goto-char (point-min))
13176 (widen)
13179 (delete-region (1- (point)) (point-at-eol)))
13180 ts))))))
13182 (defvar org-log-note-marker (make-marker))
13183 (defvar org-log-note-purpose nil)
13184 (defvar org-log-note-state nil)
13185 (defvar org-log-note-previous-state nil)
13186 (defvar org-log-note-how nil)
13187 (defvar org-log-note-extra nil)
13188 (defvar org-log-note-window-configuration nil)
13189 (defvar org-log-note-return-to (make-marker))
13190 (defvar org-log-note-effective-time nil
13191 "Remembered current time so that dynamically scoped
13192 `org-extend-today-until' affects tha timestamps in state change
13193 log")
13195 (defvar org-log-post-message nil
13196 "Message to be displayed after a log note has been stored.
13197 The auto-repeater uses this.")
13199 (defun org-add-note ()
13200 "Add a note to the current entry.
13201 This is done in the same way as adding a state change note."
13202 (interactive)
13203 (org-add-log-setup 'note nil nil 'findpos nil))
13205 (defvar org-property-end-re)
13206 (defun org-add-log-setup (&optional purpose state prev-state
13207 findpos how extra)
13208 "Set up the post command hook to take a note.
13209 If this is about to TODO state change, the new state is expected in STATE.
13210 When FINDPOS is non-nil, find the correct position for the note in
13211 the current entry. If not, assume that it can be inserted at point.
13212 HOW is an indicator what kind of note should be created.
13213 EXTRA is additional text that will be inserted into the notes buffer."
13214 (let* ((org-log-into-drawer (org-log-into-drawer))
13215 (drawer (cond ((stringp org-log-into-drawer)
13216 org-log-into-drawer)
13217 (org-log-into-drawer "LOGBOOK"))))
13218 (save-restriction
13219 (save-excursion
13220 (when findpos
13221 (org-back-to-heading t)
13222 (narrow-to-region (point) (save-excursion
13223 (outline-next-heading) (point)))
13227 (goto-char (match-end 0))
13228 (cond
13229 (drawer
13231 nil t)
13232 (progn
13233 (goto-char (match-end 0))
13234 (or org-log-states-order-reversed
13235 (and (re-search-forward org-property-end-re nil t)
13236 (goto-char (1- (match-beginning 0))))))
13238 (beginning-of-line 0)
13239 (org-indent-line)
13240 (beginning-of-line 2)
13241 (org-indent-line)
13242 (end-of-line 0)))
13243 ((and org-log-state-notes-insert-after-drawers
13244 (save-excursion
13245 (forward-line) (looking-at org-drawer-regexp)))
13246 (forward-line)
13247 (while (looking-at org-drawer-regexp)
13248 (goto-char (match-end 0))
13249 (re-search-forward org-property-end-re (point-max) t)
13250 (forward-line))
13251 (forward-line -1)))
13252 (unless org-log-states-order-reversed
13254 (org-skip-over-state-notes)
13256 (move-marker org-log-note-marker (point))
13257 (setq org-log-note-purpose purpose
13258 org-log-note-state state
13259 org-log-note-previous-state prev-state
13260 org-log-note-how how
13261 org-log-note-extra extra
13262 org-log-note-effective-time (org-current-effective-time))
13263 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13265 (defun org-skip-over-state-notes ()
13266 "Skip past the list of State notes in an entry."
13268 (when (ignore-errors (goto-char (org-in-item-p)))
13269 (let* ((struct (org-list-struct))
13270 (prevs (org-list-prevs-alist struct)))
13272 (goto-char (or (org-list-get-next-item (point) struct prevs)
13273 (org-list-get-item-end (point) struct)))))))
13275 (defun org-add-log-note (&optional purpose)
13276 "Pop up a window for taking a note, and add this note later at point."
13277 (remove-hook 'post-command-hook 'org-add-log-note)
13278 (setq org-log-note-window-configuration (current-window-configuration))
13279 (delete-other-windows)
13280 (move-marker org-log-note-return-to (point))
13281 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13282 (goto-char org-log-note-marker)
13283 (org-switch-to-buffer-other-window "*Org Note*")
13284 (erase-buffer)
13285 (if (memq org-log-note-how '(time state))
13286 (let (current-prefix-arg) (org-store-log-note))
13287 (let ((org-inhibit-startup t)) (org-mode))
13288 (insert (format "# Insert note for %s.
13290 (cond
13291 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13292 ((eq org-log-note-purpose 'done) "closed todo item")
13293 ((eq org-log-note-purpose 'state)
13295 (or org-log-note-previous-state "")
13296 (or org-log-note-state "")))
13297 ((eq org-log-note-purpose 'reschedule)
13298 "rescheduling")
13299 ((eq org-log-note-purpose 'delschedule)
13300 "no longer scheduled")
13301 ((eq org-log-note-purpose 'redeadline)
13302 "changing deadline")
13303 ((eq org-log-note-purpose 'deldeadline)
13304 "removing deadline")
13305 ((eq org-log-note-purpose 'refile)
13306 "refiling")
13307 ((eq org-log-note-purpose 'note)
13308 "this entry")
13309 (t (error "This should not happen")))))
13310 (if org-log-note-extra (insert org-log-note-extra))
13311 (org-set-local 'org-finish-function 'org-store-log-note)
13312 (run-hooks 'org-log-buffer-setup-hook)))
13314 (defvar org-note-abort nil) ; dynamically scoped
13315 (defun org-store-log-note ()
13316 "Finish taking a log note, and insert it to where it belongs."
13317 (let ((txt (buffer-string)))
13318 (kill-buffer (current-buffer))
13319 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13320 lines ind bul)
13322 (setq txt (replace-match "" t t txt)))
13324 (setq txt (replace-match "" t t txt)))
13327 (setq note
13328 (org-replace-escapes
13329 note
13330 (list (cons "%u" (user-login-name))
13331 (cons "%U" user-full-name)
13332 (cons "%t" (format-time-string
13333 (org-time-stamp-format 'long 'inactive)
13334 org-log-note-effective-time))
13335 (cons "%T" (format-time-string
13336 (org-time-stamp-format 'long nil)
13337 org-log-note-effective-time))
13338 (cons "%d" (format-time-string
13339 (org-time-stamp-format nil 'inactive)
13340 org-log-note-effective-time))
13341 (cons "%D" (format-time-string
13342 (org-time-stamp-format nil nil)
13343 org-log-note-effective-time))
13344 (cons "%s" (if org-log-note-state
13346 ""))
13347 (cons "%S" (if org-log-note-previous-state
13351 (push note lines))
13352 (when (or current-prefix-arg org-note-abort)
13353 (when org-log-into-drawer
13354 (org-remove-empty-drawer-at org-log-note-marker))
13355 (setq lines nil))
13356 (when lines
13357 (with-current-buffer (marker-buffer org-log-note-marker)
13358 (save-excursion
13359 (goto-char org-log-note-marker)
13360 (move-marker org-log-note-marker nil)
13361 (end-of-line 1)
13363 (setq ind (save-excursion
13364 (if (ignore-errors (goto-char (org-in-item-p)))
13365 (let ((struct (org-list-struct)))
13366 (org-list-get-ind
13367 (org-list-get-top-point struct) struct))
13369 (cond
13370 ((and (org-at-heading-p)
13371 org-adapt-indentation)
13372 (1+ (org-current-level)))
13373 ((org-at-heading-p) 0)
13374 (t (org-get-indentation))))))
13375 (setq bul (org-list-bullet-string "-"))
13376 (org-indent-line-to ind)
13377 (insert bul (pop lines))
13378 (let ((ind-body (+ (length bul) ind)))
13379 (while lines
13381 (org-indent-line-to ind-body)
13382 (insert (pop lines))))
13383 (message "Note stored")
13384 (org-back-to-heading t)
13385 (org-cycle-hide-drawers 'children))
13386 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13387 ;; from within `org-add-log-note' because `buffer-undo-list'
13388 ;; is then modified outside of `org-with-remote-undo'.
13389 (when (eq this-command 'org-agenda-todo)
13390 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13391 ;; Don't add undo information when called from `org-agenda-todo'
13392 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13393 (set-window-configuration org-log-note-window-configuration)
13394 (with-current-buffer (marker-buffer org-log-note-return-to)
13395 (goto-char org-log-note-return-to))
13396 (move-marker org-log-note-return-to nil)
13397 (and org-log-post-message (message "%s" org-log-post-message))))
13399 (defun org-remove-empty-drawer-at (pos)
13400 "Remove an empty drawer at position POS.
13401 POS may also be a marker."
13402 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13403 (org-with-wide-buffer
13404 (goto-char pos)
13405 (let ((drawer (org-element-at-point)))
13406 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13407 (not (org-element-property :contents-begin drawer)))
13408 (delete-region (org-element-property :begin drawer)
13409 (progn (goto-char (org-element-property :end drawer))
13411 (forward-line)
13412 (point))))))))
13414 (defvar org-ts-type nil)
13415 (defun org-sparse-tree (&optional arg type)
13416 "Create a sparse tree, prompt for the details.
13417 This command can create sparse trees. You first need to select the type
13418 of match used to create the tree:
13420 t Show all TODO entries.
13421 T Show entries with a specific TODO keyword.
13422 m Show entries selected by a tags/property match.
13423 p Enter a property name and its value (both with completion on existing
13424 names/values) and show entries with that property.
13425 r Show entries matching a regular expression (`/' can be used as well).
13426 b Show deadlines and scheduled items before a date.
13427 a Show deadlines and scheduled items after a date.
13428 d Show deadlines due within `org-deadline-warning-days'.
13429 D Show deadlines and scheduled items between a date range."
13430 (interactive "P")
13431 (let (ans kwd value ts-type)
13432 (setq type (or type org-sparse-tree-default-date-type))
13433 (setq org-ts-type type)
13434 (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"
13435 (cond ((eq type 'all) "all timestamps")
13436 ((eq type 'scheduled) "only scheduled")
13437 ((eq type 'deadline) "only deadline")
13438 ((eq type 'active) "only active timestamps")
13439 ((eq type 'inactive) "only inactive timestamps")
13440 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13441 ((eq type 'closed) "with a closed time-stamp")
13442 (t "scheduled/deadline")))
13443 (setq ans (read-char-exclusive))
13444 (cond
13445 ((equal ans ?c)
13446 (org-sparse-tree
13447 arg (cadr (member type '(scheduled-or-deadline
13448 all scheduled deadline active inactive closed)))))
13449 ((equal ans ?d)
13450 (call-interactively 'org-check-deadlines))
13451 ((equal ans ?b)
13452 (call-interactively 'org-check-before-date))
13453 ((equal ans ?a)
13454 (call-interactively 'org-check-after-date))
13455 ((equal ans ?D)
13456 (call-interactively 'org-check-dates-range))
13457 ((equal ans ?t)
13458 (call-interactively 'org-show-todo-tree))
13459 ((equal ans ?T)
13460 (org-show-todo-tree '(4)))
13461 ((member ans '(?T ?m))
13462 (call-interactively 'org-match-sparse-tree))
13463 ((member ans '(?p ?P))
13464 (setq kwd (org-icompleting-read "Property: "
13465 (mapcar 'list (org-buffer-property-keys))))
13466 (setq value (org-icompleting-read "Value: "
13467 (mapcar 'list (org-property-values kwd))))
13470 (org-match-sparse-tree arg (concat kwd "=" value)))
13471 ((member ans '(?r ?R ?/))
13472 (call-interactively 'org-occur))
13475 (defvar org-occur-highlights nil
13476 "List of overlays used for occur matches.")
13477 (make-variable-buffer-local 'org-occur-highlights)
13478 (defvar org-occur-parameters nil
13479 "Parameters of the active org-occur calls.
13480 This is a list, each call to org-occur pushes as cons cell,
13481 containing the regular expression and the callback, onto the list.
13482 The list can contain several entries if `org-occur' has been called
13483 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13484 will only contain one set of parameters. When the highlights are
13485 removed (for example with `C-c C-c', or with the next edit (depending
13486 on `org-remove-highlights-with-change'), this variable is emptied
13487 as well.")
13488 (make-variable-buffer-local 'org-occur-parameters)
13490 (defun org-occur (regexp &optional keep-previous callback)
13491 "Make a compact tree which shows all matches of REGEXP.
13492 The tree will show the lines where the regexp matches, and all higher
13493 headlines above the match. It will also show the heading after the match,
13494 to make sure editing the matching entry is easy.
13495 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13496 call to `org-occur' will be kept, to allow stacking of calls to this
13497 command.
13498 If CALLBACK is non-nil, it is a function which is called to confirm
13499 that the match should indeed be shown."
13501 (when (equal regexp "")
13502 (user-error "Regexp cannot be empty"))
13503 (unless keep-previous
13504 (org-remove-occur-highlights nil nil t))
13505 (push (cons regexp callback) org-occur-parameters)
13506 (let ((cnt 0))
13507 (save-excursion
13508 (goto-char (point-min))
13509 (if (or (not keep-previous) ; do not want to keep
13510 (not org-occur-highlights)) ; no previous matches
13511 ;; hide everything
13512 (org-overview))
13513 (while (re-search-forward regexp nil t)
13514 (when (or (not callback)
13515 (save-match-data (funcall callback)))
13516 (setq cnt (1+ cnt))
13517 (when org-highlight-sparse-tree-matches
13518 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13519 (org-show-context 'occur-tree))))
13520 (when org-remove-highlights-with-change
13521 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13522 nil 'local))
13523 (unless org-sparse-tree-open-archived-trees
13524 (org-hide-archived-subtrees (point-min) (point-max)))
13525 (run-hooks 'org-occur-hook)
13526 (if (org-called-interactively-p 'interactive)
13527 (message "%d match(es) for regexp %s" cnt regexp))
13528 cnt))
13530 (defun org-occur-next-match (&optional n reset)
13531 "Function for `next-error-function' to find sparse tree matches.
13532 N is the number of matches to move, when negative move backwards.
13533 RESET is entirely ignored - this function always goes back to the
13534 starting point when no match is found."
13535 (let* ((limit (if (< n 0) (point-min) (point-max)))
13536 (search-func (if (< n 0)
13537 'previous-single-char-property-change
13538 'next-single-char-property-change))
13539 (n (abs n))
13540 (pos (point))
13541 p1)
13542 (catch 'exit
13543 (while (setq p1 (funcall search-func (point) 'org-type))
13544 (when (equal p1 limit)
13545 (goto-char pos)
13546 (error "No more matches"))
13547 (when (equal (get-char-property p1 'org-type) 'org-occur)
13548 (setq n (1- n))
13549 (when (= n 0)
13550 (goto-char p1)
13551 (throw 'exit (point))))
13552 (goto-char p1))
13553 (goto-char p1)
13554 (error "No more matches"))))
13556 (defun org-show-context (&optional key)
13557 "Make sure point and context are visible.
13558 How much context is shown depends upon the variables
13559 `org-show-hierarchy-above', `org-show-following-heading',
13560 `org-show-entry-below' and `org-show-siblings'."
13561 (let ((heading-p (org-at-heading-p t))
13562 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13563 (following-p (org-get-alist-option org-show-following-heading key))
13564 (entry-p (org-get-alist-option org-show-entry-below key))
13565 (siblings-p (org-get-alist-option org-show-siblings key)))
13566 ;; Show heading or entry text
13567 (if (and heading-p (not entry-p))
13568 (org-flag-heading nil) ; only show the heading
13569 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13570 (org-show-hidden-entry))) ; show entire entry
13571 (when following-p
13572 ;; Show next sibling, or heading below text
13573 (save-excursion
13574 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13575 (org-flag-heading nil))))
13576 (when siblings-p (org-show-siblings))
13577 (when hierarchy-p
13578 ;; show all higher headings, possibly with siblings
13579 (save-excursion
13580 (while (and (condition-case nil
13581 (progn (org-up-heading-all 1) t)
13582 (error nil))
13583 (not (bobp)))
13584 (org-flag-heading nil)
13585 (when siblings-p (org-show-siblings)))))
13586 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13588 (defvar org-reveal-start-hook nil
13589 "Hook run before revealing a location.")
13591 (defun org-reveal (&optional siblings)
13592 "Show current entry, hierarchy above it, and the following headline.
13593 This can be used to show a consistent set of context around locations
13594 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13595 not t for the search context.
13597 With optional argument SIBLINGS, on each level of the hierarchy all
13598 siblings are shown. This repairs the tree structure to what it would
13599 look like when opened with hierarchical calls to `org-cycle'.
13601 go to the parent and show the
13602 entire tree."
13603 (interactive "P")
13604 (run-hooks 'org-reveal-start-hook)
13605 (let ((org-show-hierarchy-above t)
13606 (org-show-following-heading t)
13607 (org-show-siblings (if siblings t org-show-siblings)))
13608 (org-show-context nil))
13609 (when (equal siblings '(16))
13610 (save-excursion
13611 (when (org-up-heading-safe)
13612 (org-show-subtree)
13613 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13615 (defun org-highlight-new-match (beg end)
13616 "Highlight from BEG to END and mark the highlight is an occur headline."
13617 (let ((ov (make-overlay beg end)))
13618 (overlay-put ov 'face 'secondary-selection)
13619 (overlay-put ov 'org-type 'org-occur)
13620 (push ov org-occur-highlights)))
13622 (defun org-remove-occur-highlights (&optional beg end noremove)
13623 "Remove the occur highlights from the buffer.
13624 BEG and END are ignored. If NOREMOVE is nil, remove this function
13625 from the `before-change-functions' in the current buffer."
13626 (interactive)
13627 (unless org-inhibit-highlight-removal
13628 (mapc 'delete-overlay org-occur-highlights)
13629 (setq org-occur-highlights nil)
13630 (setq org-occur-parameters nil)
13631 (unless noremove
13632 (remove-hook 'before-change-functions
13633 'org-remove-occur-highlights 'local))))
13635 ;;;; Priorities
13638 "Regular expression matching the priority indicator.")
13640 (defvar org-remove-priority-next-time nil)
13642 (defun org-priority-up ()
13643 "Increase the priority of the current item."
13644 (interactive)
13645 (org-priority 'up))
13647 (defun org-priority-down ()
13648 "Decrease the priority of the current item."
13649 (interactive)
13650 (org-priority 'down))
13652 (defun org-priority (&optional action show)
13653 "Change the priority of an item.
13654 ACTION can be `set', `up', `down', or a character."
13655 (interactive "P")
13656 (if (equal action '(4))
13657 (org-show-priority)
13658 (unless org-enable-priority-commands
13659 (user-error "Priority commands are disabled"))
13660 (setq action (or action 'set))
13661 (let (current new news have remove)
13662 (save-excursion
13663 (org-back-to-heading t)
13664 (if (looking-at org-priority-regexp)
13665 (setq current (string-to-char (match-string 2))
13666 have t))
13667 (cond
13668 ((eq action 'remove)
13669 (setq remove t new ?\ ))
13670 ((or (eq action 'set)
13671 (if (featurep 'xemacs) (characterp action) (integerp action)))
13672 (if (not (eq action 'set))
13673 (setq new action)
13674 (message "Priority %c-%c, SPC to remove: "
13675 org-highest-priority org-lowest-priority)
13676 (save-match-data
13677 (setq new (read-char-exclusive))))
13678 (if (and (= (upcase org-highest-priority) org-highest-priority)
13679 (= (upcase org-lowest-priority) org-lowest-priority))
13680 (setq new (upcase new)))
13681 (cond ((equal new ?\ ) (setq remove t))
13682 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13683 (user-error "Priority must be between `%c' and `%c'"
13684 org-highest-priority org-lowest-priority))))
13685 ((eq action 'up)
13686 (setq new (if have
13687 (1- current) ; normal cycling
13688 ;; last priority was empty
13689 (if (eq last-command this-command)
13690 org-lowest-priority ; wrap around empty to lowest
13691 ;; default
13692 (if org-priority-start-cycle-with-default
13693 org-default-priority
13694 (1- org-default-priority))))))
13695 ((eq action 'down)
13696 (setq new (if have
13697 (1+ current) ; normal cycling
13698 ;; last priority was empty
13699 (if (eq last-command this-command)
13700 org-highest-priority ; wrap around empty to highest
13701 ;; default
13702 (if org-priority-start-cycle-with-default
13703 org-default-priority
13704 (1+ org-default-priority))))))
13705 (t (user-error "Invalid action")))
13706 (if (or (< (upcase new) org-highest-priority)
13707 (> (upcase new) org-lowest-priority))
13708 (if (and (memq action '(up down))
13709 (not have) (not (eq last-command this-command)))
13710 ;; `new' is from default priority
13711 (error
13712 "The default can not be set, see `org-default-priority' why")
13713 ;; normal cycling: `new' is beyond highest/lowest priority
13714 ;; and is wrapped around to the empty priority
13715 (setq remove t)))
13716 (setq news (format "%c" new))
13717 (if have
13718 (if remove
13719 (replace-match "" t t nil 1)
13720 (replace-match news t t nil 2))
13721 (if remove
13722 (user-error "No priority cookie found in line")
13723 (let ((case-fold-search nil))
13724 (looking-at org-todo-line-regexp))
13725 (if (match-end 2)
13726 (progn
13727 (goto-char (match-end 2))
13728 (insert " [#" news "]"))
13729 (goto-char (match-beginning 3))
13730 (insert "[#" news "] "))))
13731 (org-preserve-lc (org-set-tags nil 'align)))
13732 (if remove
13733 (message "Priority removed")
13734 (message "Priority of current item set to %s" news)))))
13736 (defun org-show-priority ()
13737 "Show the priority of the current item.
13738 This priority is composed of the main priority given with the [#A] cookies,
13739 and by additional input from the age of a schedules or deadline entry."
13740 (interactive)
13741 (let ((pri (if (eq major-mode 'org-agenda-mode)
13742 (org-get-at-bol 'priority)
13743 (save-excursion
13744 (save-match-data
13745 (beginning-of-line)
13746 (and (looking-at org-heading-regexp)
13747 (org-get-priority (match-string 0))))))))
13748 (message "Priority is %d" (if pri pri -1000))))
13750 (defun org-get-priority (s)
13751 "Find priority cookie and return priority."
13752 (save-match-data
13753 (if (functionp org-get-priority-function)
13754 (funcall org-get-priority-function)
13755 (if (not (string-match org-priority-regexp s))
13756 (* 1000 (- org-lowest-priority org-default-priority))
13757 (* 1000 (- org-lowest-priority
13758 (string-to-char (match-string 2 s))))))))
13760 ;;;; Tags
13762 (defvar org-agenda-archives-mode)
13763 (defvar org-map-continue-from nil
13764 "Position from where mapping should continue.
13765 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13767 (defvar org-scanner-tags nil
13768 "The current tag list while the tags scanner is running.")
13769 (defvar org-trust-scanner-tags nil
13770 "Should `org-get-tags-at' use the tags for the scanner.
13771 This is for internal dynamical scoping only.
13772 When this is non-nil, the function `org-get-tags-at' will return the value
13773 of `org-scanner-tags' instead of building the list by itself. This
13774 can lead to large speed-ups when the tags scanner is used in a file with
13775 many entries, and when the list of tags is retrieved, for example to
13776 obtain a list of properties. Building the tags list for each entry in such
13777 a file becomes an N^2 operation - but with this variable set, it scales
13778 as N.")
13780 (defun org-scan-tags (action matcher todo-only &optional start-level)
13781 "Sca headline tags with inheritance and produce output ACTION.
13783 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13784 or `agenda' to produce an entry list for an agenda view. It can also be
13785 a Lisp form or a function that should be called at each matched headline, in
13786 this case the return value is a list of all return values from these calls.
13788 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13789 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13790 only lines with a not-done TODO keyword are included in the output.
13791 This should be the same variable that was scoped into
13792 and set by `org-make-tags-matcher' when it constructed MATCHER.
13794 START-LEVEL can be a string with asterisks, reducing the scope to
13795 headlines matching this string."
13796 (require 'org-agenda)
13797 (let* ((re (concat "^"
13798 (if start-level
13799 ;; Get the correct level to match
13801 org-outline-regexp)
13805 (props (list 'face 'default
13806 'done-face 'org-agenda-done
13807 'undone-face 'default
13808 'mouse-face 'highlight
13809 'org-not-done-regexp org-not-done-regexp
13810 'org-todo-regexp org-todo-regexp
13811 'org-complex-heading-regexp org-complex-heading-regexp
13812 'help-echo
13813 (format "mouse-2 or RET jump to org file %s"
13814 (abbreviate-file-name
13815 (or (buffer-file-name (buffer-base-buffer))
13816 (buffer-name (buffer-base-buffer)))))))
13817 (org-map-continue-from nil)
13818 lspos tags tags-list
13819 (tags-alist (list (cons 0 org-file-tags)))
13820 (llast 0) rtn rtn1 level category i txt
13821 todo marker entry priority)
13822 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13823 (setq action (list 'lambda nil action)))
13824 (save-excursion
13825 (goto-char (point-min))
13826 (when (eq action 'sparse-tree)
13827 (org-overview)
13828 (org-remove-occur-highlights))
13829 (while (let (case-fold-search)
13830 (re-search-forward re nil t))
13831 (setq org-map-continue-from nil)
13832 (catch :skip
13833 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13834 tags (if (match-end 4) (org-match-string-no-properties 4)))
13835 (goto-char (setq lspos (match-beginning 0)))
13836 (setq level (org-reduced-level (org-outline-level))
13837 category (org-get-category))
13838 (setq i llast llast level)
13839 ;; remove tag lists from same and sublevels
13840 (while (>= i level)
13841 (when (setq entry (assoc i tags-alist))
13842 (setq tags-alist (delete entry tags-alist)))
13843 (setq i (1- i)))
13844 ;; add the next tags
13845 (when tags
13846 (setq tags (org-split-string tags ":")
13847 tags-alist
13848 (cons (cons level tags) tags-alist)))
13849 ;; compile tags for current headline
13850 (setq tags-list
13851 (if org-use-tag-inheritance
13852 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13853 tags)
13854 org-scanner-tags tags-list)
13855 (when org-use-tag-inheritance
13856 (setcdr (car tags-alist)
13857 (mapcar (lambda (x)
13858 (setq x (copy-sequence x))
13859 (org-add-prop-inherited x))
13860 (cdar tags-alist))))
13861 (when (and tags org-use-tag-inheritance
13862 (or (not (eq t org-use-tag-inheritance))
13863 org-tags-exclude-from-inheritance))
13864 ;; selective inheritance, remove uninherited ones
13865 (setcdr (car tags-alist)
13866 (org-remove-uninherited-tags (cdar tags-alist))))
13867 (when (and
13869 ;; eval matcher only when the todo condition is OK
13870 (and (or (not todo-only) (member todo org-not-done-keywords))
13871 (let ((case-fold-search t) (org-trust-scanner-tags t))
13872 (eval matcher)))
13874 ;; Call the skipper, but return t if it does not skip,
13875 ;; so that the `and' form continues evaluating
13876 (progn
13877 (unless (eq action 'sparse-tree) (org-agenda-skip))
13878 t)
13880 ;; Check if timestamps are deselecting this entry
13881 (or (not todo-only)
13882 (and (member todo org-not-done-keywords)
13883 (or (not org-agenda-tags-todo-honor-ignore-options)
13884 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13886 ;; select this headline
13887 (cond
13888 ((eq action 'sparse-tree)
13889 (and org-highlight-sparse-tree-matches
13890 (org-get-heading) (match-end 0)
13891 (org-highlight-new-match
13892 (match-beginning 1) (match-end 1)))
13893 (org-show-context 'tags-tree))
13894 ((eq action 'agenda)
13895 (setq txt (org-agenda-format-item
13896 ""
13897 (concat
13898 (if (eq org-tags-match-list-sublevels 'indented)
13899 (make-string (1- level) ?.) "")
13900 (org-get-heading))
13901 level category
13902 tags-list)
13903 priority (org-get-priority txt))
13904 (goto-char lspos)
13905 (setq marker (org-agenda-new-marker))
13906 (org-add-props txt props
13907 'org-marker marker 'org-hd-marker marker 'org-category category
13908 'todo-state todo
13909 'priority priority 'type "tagsmatch")
13910 (push txt rtn))
13911 ((functionp action)
13912 (setq org-map-continue-from nil)
13913 (save-excursion
13914 (setq rtn1 (funcall action))
13915 (push rtn1 rtn)))
13916 (t (user-error "Invalid action")))
13918 ;; if we are to skip sublevels, jump to end of subtree
13919 (unless org-tags-match-list-sublevels
13920 (org-end-of-subtree t)
13921 (backward-char 1))))
13922 ;; Get the correct position from where to continue
13923 (if org-map-continue-from
13924 (goto-char org-map-continue-from)
13925 (and (= (point) lspos) (end-of-line 1)))))
13926 (when (and (eq action 'sparse-tree)
13927 (not org-sparse-tree-open-archived-trees))
13928 (org-hide-archived-subtrees (point-min) (point-max)))
13929 (nreverse rtn)))
13931 (defun org-remove-uninherited-tags (tags)
13932 "Remove all tags that are not inherited from the list TAGS."
13933 (cond
13934 ((eq org-use-tag-inheritance t)
13935 (if org-tags-exclude-from-inheritance
13936 (org-delete-all org-tags-exclude-from-inheritance tags)
13937 tags))
13938 ((not org-use-tag-inheritance) nil)
13939 ((stringp org-use-tag-inheritance)
13940 (delq nil (mapcar
13941 (lambda (x)
13942 (if (and (string-match org-use-tag-inheritance x)
13943 (not (member x org-tags-exclude-from-inheritance)))
13944 x nil))
13945 tags)))
13946 ((listp org-use-tag-inheritance)
13947 (delq nil (mapcar
13948 (lambda (x)
13949 (if (member x org-use-tag-inheritance) x nil))
13950 tags)))))
13952 (defun org-match-sparse-tree (&optional todo-only match)
13953 "Create a sparse tree according to tags string MATCH.
13954 MATCH can contain positive and negative selection of tags, like
13956 If optional argument TODO-ONLY is non-nil, only select lines that are
13957 also TODO lines."
13958 (interactive "P")
13959 (org-agenda-prepare-buffers (list (current-buffer)))
13960 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13962 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13964 (defvar org-cached-props nil)
13965 (defun org-cached-entry-get (pom property)
13966 (if (or (eq t org-use-property-inheritance)
13967 (and (stringp org-use-property-inheritance)
13968 (string-match org-use-property-inheritance property))
13969 (and (listp org-use-property-inheritance)
13970 (member property org-use-property-inheritance)))
13971 ;; Caching is not possible, check it directly
13972 (org-entry-get pom property 'inherit)
13973 ;; Get all properties, so that we can do complicated checks easily
13974 (cdr (assoc property (or org-cached-props
13975 (setq org-cached-props
13976 (org-entry-properties pom)))))))
13978 (defun org-global-tags-completion-table (&optional files)
13979 "Return the list of all tags in all agenda buffer/files.
13980 Optional FILES argument is a list of files which can be used
13981 instead of the agenda files."
13982 (save-excursion
13983 (org-uniquify
13984 (delq nil
13985 (apply 'append
13986 (mapcar
13987 (lambda (file)
13988 (set-buffer (find-file-noselect file))
13989 (append (org-get-buffer-tags)
13990 (mapcar (lambda (x) (if (stringp (car-safe x))
13991 (list (car-safe x)) nil))
13992 org-tag-alist)))
13993 (if (and files (car files))
13994 files
13995 (org-agenda-files))))))))
13997 (defun org-make-tags-matcher (match)
13998 "Create the TAGS/TODO matcher form for the selection string MATCH.
14000 The variable `todo-only' is scoped dynamically into this function.
14001 It will be set to t if the matcher restricts matching to TODO entries,
14002 otherwise will not be touched.
14004 Returns a cons of the selection string MATCH and the constructed
14005 lisp form implementing the matcher. The matcher is to be evaluated
14006 at an Org entry, with point on the headline, and returns t if the
14007 entry matches the selection string MATCH. The returned lisp form
14008 references two variables with information about the entry, which
14009 must be bound around the form's evaluation: todo, the TODO keyword
14010 at the entry (or nil of none); and tags-list, the list of all tags
14011 at the entry including inherited ones. Additionally, the category
14012 of the entry (if any) must be specified as the text property
14013 'org-category on the headline.
14015 See also `org-scan-tags'.
14016 "
14017 (declare (special todo-only))
14018 (unless (boundp 'todo-only)
14019 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14020 (unless match
14021 ;; Get a new match request, with completion against the global
14022 ;; tags table and the local tags in current buffer
14023 (let ((org-last-tags-completion-table
14024 (org-uniquify
14025 (delq nil (append (org-get-buffer-tags)
14026 (org-global-tags-completion-table))))))
14027 (setq match (org-completing-read-no-i
14028 "Match: " 'org-tags-completion-function nil nil nil
14029 'org-tags-history))))
14031 ;; Parse the string and create a lisp form
14032 (let ((match0 match)
14033 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14034 minus tag mm
14035 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14036 orterms term orlist re-p str-p level-p level-op time-p
14037 prop-p pn pv po gv rest (start 0) (ss 0))
14038 ;; Expand group tags
14039 (setq match (org-tags-expand match))
14041 ;; Check if there is a TODO part of this match, which would be the
14042 ;; part after a "/". TO make sure that this slash is not part of
14043 ;; a property value to be matched against, we also check that there
14044 ;; is no " after that slash.
14045 ;; First, find the last slash
14046 (while (string-match "/+" match ss)
14047 (setq start (match-beginning 0) ss (match-end 0)))
14048 (if (and (string-match "/+" match start)
14050 ;; match contains also a todo-matching request
14051 (progn
14052 (setq tagsmatch (substring match 0 (match-beginning 0))
14053 todomatch (substring match (match-end 0)))
14054 (if (string-match "^!" todomatch)
14055 (setq todo-only t todomatch (substring todomatch 1)))
14057 (setq todomatch nil)))
14058 ;; only matching tags
14059 (setq tagsmatch match todomatch nil))
14061 ;; Make the tags matcher
14063 (setq tagsmatcher t)
14064 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14065 (while (setq term (pop orterms))
14067 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14068 (while (string-match re term)
14069 (setq rest (substring term (match-end 0))
14070 minus (and (match-end 1)
14071 (equal (match-string 1 term) "-"))
14072 tag (save-match-data (replace-regexp-in-string
14074 (match-string 2 term)))
14075 re-p (equal (string-to-char tag) ?{)
14076 level-p (match-end 4)
14077 prop-p (match-end 5)
14078 mm (cond
14079 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14080 (level-p
14081 (setq level-op (org-op-to-function (match-string 3 term)))
14082 `(,level-op level ,(string-to-number
14083 (match-string 4 term))))
14084 (prop-p
14085 (setq pn (match-string 5 term)
14086 po (match-string 6 term)
14087 pv (match-string 7 term)
14088 re-p (equal (string-to-char pv) ?{)
14090 time-p (save-match-data
14092 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14093 (if time-p (setq pv (org-matcher-time pv)))
14094 (setq po (org-op-to-function po (if time-p 'time str-p)))
14095 (cond
14096 ((equal pn "CATEGORY")
14097 (setq gv '(get-text-property (point) 'org-category)))
14098 ((equal pn "TODO")
14099 (setq gv 'todo))
14100 (t
14101 (setq gv `(org-cached-entry-get nil ,pn))))
14102 (if re-p
14103 (if (eq po 'org<>)
14104 `(not (string-match ,pv (or ,gv "")))
14105 `(string-match ,pv (or ,gv "")))
14106 (if str-p
14107 `(,po (or ,gv "") ,pv)
14108 `(,po (string-to-number (or ,gv ""))
14109 ,(string-to-number pv) ))))
14110 (t `(member ,tag tags-list)))
14111 mm (if minus (list 'not mm) mm)
14112 term rest)
14113 (push mm tagsmatcher))
14114 (push (if (> (length tagsmatcher) 1)
14115 (cons 'and tagsmatcher)
14116 (car tagsmatcher))
14117 orlist)
14118 (setq tagsmatcher nil))
14119 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14120 (setq tagsmatcher
14121 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14122 ;; Make the todo matcher
14124 (setq todomatcher t)
14125 (setq orterms (org-split-string todomatch "|") orlist nil)
14126 (while (setq term (pop orterms))
14127 (while (string-match re term)
14128 (setq minus (and (match-end 1)
14129 (equal (match-string 1 term) "-"))
14130 kwd (match-string 2 term)
14131 re-p (equal (string-to-char kwd) ?{)
14132 term (substring term (match-end 0))
14133 mm (if re-p
14134 `(string-match ,(substring kwd 1 -1) todo)
14135 (list 'equal 'todo kwd))
14136 mm (if minus (list 'not mm) mm))
14137 (push mm todomatcher))
14138 (push (if (> (length todomatcher) 1)
14139 (cons 'and todomatcher)
14140 (car todomatcher))
14141 orlist)
14142 (setq todomatcher nil))
14143 (setq todomatcher (if (> (length orlist) 1)
14144 (cons 'or orlist) (car orlist))))
14146 ;; Return the string and lisp forms of the matcher
14147 (setq matcher (if todomatcher
14148 (list 'and tagsmatcher todomatcher)
14149 tagsmatcher))
14150 (when todo-only
14151 (setq matcher (list 'and '(member todo org-not-done-keywords)
14152 matcher)))
14153 (cons match0 matcher)))
14155 (defun org-tags-expand (match &optional single-as-list downcased)
14156 "Expand group tags in MATCH.
14158 This replaces every group tag in MATCH with a regexp tag search.
14160 will be replaced like this:
14166 Replacing by a regexp preserves the structure of the match.
14167 E.g., this expansion
14174 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14175 assumed to be a single group tag, and the function will return
14176 the list of tags in this group.
14178 When DOWNCASE is non-nil, expand downcased TAGS."
14179 (if org-group-tags
14180 (let* ((case-fold-search t)
14181 (stable org-mode-syntax-table)
14182 (tal (or org-tag-groups-alist-for-agenda
14183 org-tag-groups-alist))
14184 (tal (if downcased
14185 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14186 (tml (mapcar 'car tal))
14187 (rtnmatch match) rpl)
14188 ;; @ and _ are allowed as word-components in tags
14189 (modify-syntax-entry ?@ "w" stable)
14190 (modify-syntax-entry ?_ "w" stable)
14191 (while (and tml
14192 (with-syntax-table stable
14193 (string-match
14196 (let* ((dir (match-string 1 rtnmatch))
14197 (tag (match-string 2 rtnmatch))
14198 (tag (if downcased (downcase tag) tag)))
14199 (setq tml (delete tag tml))
14200 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14201 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14203 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14204 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14205 (if single-as-list
14206 (or (reverse rpl) (list rtnmatch))
14207 rtnmatch))
14208 (if single-as-list (list (if downcased (downcase match) match))
14209 match)))
14211 (defun org-op-to-function (op &optional stringp)
14212 "Turn an operator into the appropriate function."
14213 (setq op
14214 (cond
14215 ((equal op "<" ) '(< string< org-time<))
14216 ((equal op ">" ) '(> org-string> org-time>))
14217 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14218 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14219 ((member op '("=" "==")) '(= string= org-time=))
14220 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14221 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14223 (defun org<> (a b) (not (= a b)))
14224 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14225 (defun org-string>= (a b) (not (string< a b)))
14226 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14227 (defun org-string<> (a b) (not (string= a b)))
14228 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14229 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14230 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14231 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14232 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14233 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14234 (defun org-2ft (s)
14235 "Convert S to a floating point time.
14236 If S is already a number, just return it. If it is a string, parse
14237 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14238 (cond
14239 ((numberp s) s)
14240 ((stringp s)
14241 (condition-case nil
14242 (float-time (apply 'encode-time (org-parse-time-string s)))
14243 (error 0.)))
14244 (t 0.)))
14246 (defun org-time-today ()
14247 "Time in seconds today at 0:00.
14248 Returns the float number of seconds since the beginning of the
14249 epoch to the beginning of today (00:00)."
14250 (float-time (apply 'encode-time
14251 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14253 (defun org-matcher-time (s)
14254 "Interpret a time comparison value."
14255 (save-match-data
14256 (cond
14257 ((string= s "<now>") (float-time))
14258 ((string= s "<today>") (org-time-today))
14259 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14260 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14262 (+ (org-time-today)
14263 (* (string-to-number (match-string 1 s))
14264 (cdr (assoc (match-string 2 s)
14265 '(("d" . 86400.0) ("w" . 604800.0)
14266 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14267 (t (org-2ft s)))))
14269 (defun org-match-any-p (re list)
14270 "Does re match any element of list?"
14271 (setq list (mapcar (lambda (x) (string-match re x)) list))
14272 (delq nil list))
14274 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14275 (defvar org-tags-overlay (make-overlay 1 1))
14276 (org-detach-overlay org-tags-overlay)
14278 (defun org-get-local-tags-at (&optional pos)
14279 "Get a list of tags defined in the current headline."
14280 (org-get-tags-at pos 'local))
14282 (defun org-get-local-tags ()
14283 "Get a list of tags defined in the current headline."
14284 (org-get-tags-at nil 'local))
14286 (defun org-get-tags-at (&optional pos local)
14287 "Get a list of all headline tags applicable at POS.
14288 POS defaults to point. If tags are inherited, the list contains
14289 the targets in the same sequence as the headlines appear, i.e.
14290 the tags of the current headline come last.
14291 When LOCAL is non-nil, only return tags from the current headline,
14292 ignore inherited ones."
14293 (interactive)
14294 (if (and org-trust-scanner-tags
14295 (or (not pos) (equal pos (point)))
14296 (not local))
14297 org-scanner-tags
14298 (let (tags ltags lastpos parent)
14299 (save-excursion
14300 (save-restriction
14301 (widen)
14302 (goto-char (or pos (point)))
14303 (save-match-data
14304 (catch 'done
14305 (condition-case nil
14306 (progn
14307 (org-back-to-heading t)
14308 (while (not (equal lastpos (point)))
14309 (setq lastpos (point))
14310 (when (looking-at
14312 (setq ltags (org-split-string
14313 (org-match-string-no-properties 1) ":"))
14314 (when parent
14315 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14316 (setq tags (append
14317 (if parent
14318 (org-remove-uninherited-tags ltags)
14319 ltags)
14320 tags)))
14321 (or org-use-tag-inheritance (throw 'done t))
14322 (if local (throw 'done t))
14323 (or (org-up-heading-safe) (error nil))
14324 (setq parent t)))
14325 (error nil)))))
14326 (if local
14327 tags
14328 (reverse (delete-dups
14329 (reverse (append
14330 (org-remove-uninherited-tags
14331 org-file-tags) tags)))))))))
14333 (defun org-add-prop-inherited (s)
14334 (add-text-properties 0 (length s) '(inherited t) s)
14335 s)
14337 (defun org-toggle-tag (tag &optional onoff)
14338 "Toggle the tag TAG for the current line.
14339 If ONOFF is `on' or `off', don't toggle but set to this state."
14340 (let (res current)
14341 (save-excursion
14342 (org-back-to-heading t)
14344 (point-at-eol) t)
14345 (progn
14346 (setq current (match-string 1))
14347 (replace-match ""))
14348 (setq current ""))
14349 (setq current (nreverse (org-split-string current ":")))
14350 (cond
14351 ((eq onoff 'on)
14352 (setq res t)
14353 (or (member tag current) (push tag current)))
14354 ((eq onoff 'off)
14355 (or (not (member tag current)) (setq current (delete tag current))))
14356 (t (if (member tag current)
14357 (setq current (delete tag current))
14358 (setq res t)
14359 (push tag current))))
14360 (end-of-line 1)
14361 (if current
14362 (progn
14363 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14364 (org-set-tags nil t))
14365 (delete-horizontal-space))
14366 (run-hooks 'org-after-tags-change-hook))
14367 res))
14369 (defun org-align-tags-here (to-col)
14370 ;; Assumes that this is a headline
14371 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14372 (beginning-of-line 1)
14374 (< pos (match-beginning 2)))
14375 (progn
14376 (setq tags-l (- (match-end 2) (match-beginning 2)))
14377 (goto-char (match-beginning 1))
14378 (insert " ")
14379 (delete-region (point) (1+ (match-beginning 2)))
14380 (setq ncol (max (current-column)
14381 (1+ col)
14382 (if (> to-col 0)
14383 to-col
14384 (- (abs to-col) tags-l))))
14385 (setq p (point))
14386 (insert (make-string (- ncol (current-column)) ?\ ))
14387 (setq ncol (current-column))
14388 (when indent-tabs-mode (tabify p (point-at-eol)))
14389 (org-move-to-column (min ncol col) t))
14390 (goto-char pos))))
14392 (defun org-set-tags-command (&optional arg just-align)
14393 "Call the set-tags command for the current entry."
14394 (interactive "P")
14395 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14396 (org-set-tags arg just-align)
14397 (save-excursion
14398 (unless (and (org-region-active-p)
14399 org-loop-over-headlines-in-active-region)
14400 (org-back-to-heading t))
14401 (org-set-tags arg just-align))))
14403 (defun org-set-tags-to (data)
14404 "Set the tags of the current entry to DATA, replacing the current tags.
14405 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14406 If DATA is nil or the empty string, any tags will be removed."
14407 (interactive "sTags: ")
14408 (setq data
14409 (cond
14410 ((eq data nil) "")
14411 ((equal data "") "")
14412 ((stringp data)
14413 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14414 ":"))
14415 ((listp data)
14416 (concat ":" (mapconcat 'identity data ":") ":"))))
14417 (when data
14418 (save-excursion
14419 (org-back-to-heading t)
14420 (when (looking-at org-complex-heading-regexp)
14421 (if (match-end 5)
14422 (progn
14423 (goto-char (match-beginning 5))
14424 (insert data)
14425 (delete-region (point) (point-at-eol))
14426 (org-set-tags nil 'align))
14427 (goto-char (point-at-eol))
14428 (insert " " data)
14429 (org-set-tags nil 'align)))
14430 (beginning-of-line 1)
14432 (delete-region (match-beginning 1) (match-end 1))))))
14434 (defun org-align-all-tags ()
14435 "Align the tags i all headings."
14436 (interactive)
14437 (save-excursion
14438 (or (ignore-errors (org-back-to-heading t))
14439 (outline-next-heading))
14440 (if (org-at-heading-p)
14441 (org-set-tags t)
14442 (message "No headings"))))
14444 (defvar org-indent-indentation-per-level)
14445 (defun org-set-tags (&optional arg just-align)
14446 "Set the tags for the current headline.
14447 With prefix ARG, realign all tags in headings in the current buffer."
14448 (interactive "P")
14449 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14450 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14451 'region-start-level 'region))
14452 org-loop-over-headlines-in-active-region)
14453 (org-map-entries
14454 ;; We don't use ARG and JUST-ALIGN here these args are not
14455 ;; useful when looping over headlines
14456 `(org-set-tags)
14457 org-loop-over-headlines-in-active-region
14458 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14459 (let* ((re org-outline-regexp-bol)
14460 (current (unless arg (org-get-tags-string)))
14461 (col (current-column))
14462 (org-setting-tags t)
14463 table current-tags inherited-tags ; computed below when needed
14464 tags p0 c0 c1 rpl di tc level)
14465 (if arg
14466 (save-excursion
14467 (goto-char (point-min))
14468 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14469 (while (re-search-forward re nil t)
14470 (org-set-tags nil t)
14471 (end-of-line 1)))
14472 (message "All tags realigned to column %d" org-tags-column))
14473 (if just-align
14474 (setq tags current)
14475 ;; Get a new set of tags from the user
14476 (save-excursion
14477 (setq table (append org-tag-persistent-alist
14478 (or org-tag-alist (org-get-buffer-tags))
14479 (and
14480 org-complete-tags-always-offer-all-agenda-tags
14481 (org-global-tags-completion-table
14482 (org-agenda-files))))
14483 org-last-tags-completion-table table
14484 current-tags (org-split-string current ":")
14485 inherited-tags (nreverse
14486 (nthcdr (length current-tags)
14487 (nreverse (org-get-tags-at))))
14488 tags
14489 (if (or (eq t org-use-fast-tag-selection)
14490 (and org-use-fast-tag-selection
14491 (delq nil (mapcar 'cdr table))))
14492 (org-fast-tag-selection
14493 current-tags inherited-tags table
14494 (if org-fast-tag-selection-include-todo
14495 org-todo-key-alist))
14496 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14497 (org-trim
14498 (org-icompleting-read "Tags: "
14499 'org-tags-completion-function
14500 nil nil current 'org-tags-history))))))
14501 (while (string-match "[-+&]+" tags)
14502 ;; No boolean logic, just a list
14503 (setq tags (replace-match ":" t t tags))))
14505 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14507 (if org-tags-sort-function
14508 (setq tags (mapconcat 'identity
14509 (sort (org-split-string
14510 tags (org-re "[^[:alnum:]_@#%]+"))
14511 org-tags-sort-function) ":")))
14514 (setq tags "")
14515 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14516 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14518 ;; Insert new tags at the correct column
14519 (beginning-of-line 1)
14520 (setq level (or (and (looking-at org-outline-regexp)
14521 (- (match-end 0) (point) 1))
14522 1))
14523 (cond
14524 ((and (equal current "") (equal tags "")))
14525 ((re-search-forward
14527 (point-at-eol) t)
14528 (if (equal tags "")
14529 (setq rpl "")
14530 (goto-char (match-beginning 0))
14531 (setq c0 (current-column)
14532 ;; compute offset for the case of org-indent-mode active
14533 di (if org-indent-mode
14534 (* (1- org-indent-indentation-per-level) (1- level))
14535 0)
14536 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14537 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14538 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14539 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14540 (replace-match rpl t t)
14541 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14542 tags)
14543 (t (error "Tags alignment failed")))
14544 (org-move-to-column col)
14545 (unless just-align
14546 (run-hooks 'org-after-tags-change-hook))))))
14548 (defun org-change-tag-in-region (beg end tag off)
14549 "Add or remove TAG for each entry in the region.
14550 This works in the agenda, and also in an org-mode buffer."
14551 (interactive
14552 (list (region-beginning) (region-end)
14553 (let ((org-last-tags-completion-table
14554 (if (derived-mode-p 'org-mode)
14555 (org-uniquify
14556 (delq nil (append (org-get-buffer-tags)
14557 (org-global-tags-completion-table))))
14558 (org-global-tags-completion-table))))
14559 (org-icompleting-read
14560 "Tag: " 'org-tags-completion-function nil nil nil
14561 'org-tags-history))
14562 (progn
14564 (equal (read-char-exclusive) ?r))))
14565 (if (fboundp 'deactivate-mark) (deactivate-mark))
14566 (let ((agendap (equal major-mode 'org-agenda-mode))
14567 l1 l2 m buf pos newhead (cnt 0))
14568 (goto-char end)
14569 (setq l2 (1- (org-current-line)))
14570 (goto-char beg)
14571 (setq l1 (org-current-line))
14572 (loop for l from l1 to l2 do
14573 (org-goto-line l)
14574 (setq m (get-text-property (point) 'org-hd-marker))
14575 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14576 (and agendap m))
14577 (setq buf (if agendap (marker-buffer m) (current-buffer))
14578 pos (if agendap m (point)))
14579 (with-current-buffer buf
14580 (save-excursion
14581 (save-restriction
14582 (goto-char pos)
14583 (setq cnt (1+ cnt))
14584 (org-toggle-tag tag (if off 'off 'on))
14585 (setq newhead (org-get-heading)))))
14586 (and agendap (org-agenda-change-all-lines newhead m))))
14587 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14589 (defun org-tags-completion-function (string predicate &optional flag)
14590 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14591 (confirm (lambda (x) (stringp (car x)))))
14593 (setq s1 (match-string 1 string)
14594 s2 (match-string 2 string))
14595 (setq s1 "" s2 string))
14596 (cond
14597 ((eq flag nil)
14598 ;; try completion
14599 (setq rtn (try-completion s2 ctable confirm))
14600 (if (stringp rtn)
14601 (setq rtn
14602 (concat s1 s2 (substring rtn (length s2))
14603 (if (and org-add-colon-after-tag-completion
14604 (assoc rtn ctable))
14605 ":" ""))))
14606 rtn)
14607 ((eq flag t)
14608 ;; all-completions
14609 (all-completions s2 ctable confirm))
14610 ((eq flag 'lambda)
14611 ;; exact match?
14612 (assoc s2 ctable)))))
14614 (defun org-fast-tag-insert (kwd tags face &optional end)
14615 "Insert KDW, and the TAGS, the latter with face FACE.
14616 Also insert END."
14617 (insert (format "%-12s" (concat kwd ":"))
14618 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14619 (or end "")))
14621 (defun org-fast-tag-show-exit (flag)
14622 (save-excursion
14623 (org-goto-line 3)
14625 (replace-match ""))
14626 (when flag
14627 (end-of-line 1)
14628 (org-move-to-column (- (window-width) 19) t)
14629 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14631 (defun org-set-current-tags-overlay (current prefix)
14632 "Add an overlay to CURRENT tag with PREFIX."
14633 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14634 (if (featurep 'xemacs)
14635 (org-overlay-display org-tags-overlay (concat prefix s)
14636 'secondary-selection)
14637 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14638 (org-overlay-display org-tags-overlay (concat prefix s)))))
14640 (defvar org-last-tag-selection-key nil)
14641 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14642 "Fast tag selection with single keys.
14643 CURRENT is the current list of tags in the headline, INHERITED is the
14644 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14645 possibly with grouping information. TODO-TABLE is a similar table with
14646 TODO keywords, should these have keys assigned to them.
14647 If the keys are nil, a-z are automatically assigned.
14648 Returns the new tags string, or nil to not change the current settings."
14649 (let* ((fulltable (append table todo-table))
14650 (maxlen (apply 'max (mapcar
14651 (lambda (x)
14652 (if (stringp (car x)) (string-width (car x)) 0))
14653 fulltable)))
14654 (buf (current-buffer))
14655 (expert (eq org-fast-tag-selection-single-key 'expert))
14656 (buffer-tags nil)
14657 (fwidth (+ maxlen 3 1 3))
14658 (ncol (/ (- (window-width) 4) fwidth))
14659 (i-face 'org-done)
14660 (c-face 'org-todo)
14661 tg cnt e c char c1 c2 ntable tbl rtn
14662 ov-start ov-end ov-prefix
14663 (exit-after-next org-fast-tag-selection-single-key)
14664 (done-keywords org-done-keywords)
14665 groups ingroup)
14666 (save-excursion
14667 (beginning-of-line 1)
14668 (if (looking-at
14670 (setq ov-start (match-beginning 1)
14671 ov-end (match-end 1)
14672 ov-prefix "")
14673 (setq ov-start (1- (point-at-eol))
14674 ov-end (1+ ov-start))
14676 (setq ov-prefix
14677 (concat
14678 (buffer-substring (1- (point)) (point))
14679 (if (> (current-column) org-tags-column)
14680 " "
14681 (make-string (- org-tags-column (current-column)) ?\ ))))))
14682 (move-overlay org-tags-overlay ov-start ov-end)
14683 (save-window-excursion
14684 (if expert
14685 (set-buffer (get-buffer-create " *Org tags*"))
14686 (delete-other-windows)
14687 (split-window-vertically)
14688 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14689 (erase-buffer)
14690 (org-set-local 'org-done-keywords done-keywords)
14693 (org-fast-tag-show-exit exit-after-next)
14694 (org-set-current-tags-overlay current ov-prefix)
14695 (setq tbl fulltable char ?a cnt 0)
14696 (while (setq e (pop tbl))
14697 (cond
14698 ((equal (car e) :startgroup)
14699 (push '() groups) (setq ingroup t)
14700 (when (not (= cnt 0))
14701 (setq cnt 0)
14703 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14704 ((equal (car e) :endgroup)
14705 (setq ingroup nil cnt 0)
14707 ((equal e '(:newline))
14708 (when (not (= cnt 0))
14709 (setq cnt 0)
14711 (setq e (car tbl))
14712 (while (equal (car tbl) '(:newline))
14714 (setq tbl (cdr tbl)))))
14715 ((equal e '(:grouptags)) nil)
14716 (t
14717 (setq tg (copy-sequence (car e)) c2 nil)
14718 (if (cdr e)
14719 (setq c (cdr e))
14720 ;; automatically assign a character.
14721 (setq c1 (string-to-char
14722 (downcase (substring
14723 tg (if (= (string-to-char tg) ?@) 1 0)))))
14724 (if (or (rassoc c1 ntable) (rassoc c1 table))
14725 (while (or (rassoc char ntable) (rassoc char table))
14726 (setq char (1+ char)))
14727 (setq c2 c1))
14728 (setq c (or c2 char)))
14729 (if ingroup (push tg (car groups)))
14730 (setq tg (org-add-props tg nil 'face
14731 (cond
14732 ((not (assoc tg table))
14733 (org-get-todo-face tg))
14734 ((member tg current) c-face)
14735 ((member tg inherited) i-face))))
14736 (if (equal (caar tbl) :grouptags)
14737 (org-add-props tg nil 'face 'org-tag-group))
14738 (if (and (= cnt 0) (not ingroup)) (insert " "))
14739 (insert "[" c "] " tg (make-string
14740 (- fwidth 4 (length tg)) ?\ ))
14741 (push (cons tg c) ntable)
14742 (when (= (setq cnt (1+ cnt)) ncol)
14744 (if ingroup (insert " "))
14745 (setq cnt 0)))))
14746 (setq ntable (nreverse ntable))
14748 (goto-char (point-min))
14749 (if (not expert) (org-fit-window-to-buffer))
14750 (setq rtn
14751 (catch 'exit
14752 (while t
14753 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14754 (if (not groups) "no " "")
14755 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14756 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14757 (setq org-last-tag-selection-key c)
14758 (cond
14760 ((= c ?!)
14761 (setq groups (not groups))
14762 (goto-char (point-min))
14763 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14764 ((= c ?\C-c)
14765 (if (not expert)
14766 (org-fast-tag-show-exit
14767 (setq exit-after-next (not exit-after-next)))
14768 (setq expert nil)
14769 (delete-other-windows)
14770 (set-window-buffer (split-window-vertically) " *Org tags*")
14771 (org-switch-to-buffer-other-window " *Org tags*")
14772 (org-fit-window-to-buffer)))
14773 ((or (= c ?\C-g)
14774 (and (= c ?q) (not (rassoc c ntable))))
14775 (org-detach-overlay org-tags-overlay)
14776 (setq quit-flag t))
14777 ((= c ?\ )
14778 (setq current nil)
14779 (if exit-after-next (setq exit-after-next 'now)))
14781 (condition-case nil
14782 (setq tg (org-icompleting-read
14783 "Tag: "
14784 (or buffer-tags
14785 (with-current-buffer buf
14786 (org-get-buffer-tags)))))
14787 (quit (setq tg "")))
14789 (add-to-list 'buffer-tags (list tg))
14790 (if (member tg current)
14791 (setq current (delete tg current))
14792 (push tg current)))
14793 (if exit-after-next (setq exit-after-next 'now)))
14794 ((setq e (rassoc c todo-table) tg (car e))
14795 (with-current-buffer buf
14796 (save-excursion (org-todo tg)))
14797 (if exit-after-next (setq exit-after-next 'now)))
14798 ((setq e (rassoc c ntable) tg (car e))
14799 (if (member tg current)
14800 (setq current (delete tg current))
14801 (loop for g in groups do
14802 (if (member tg g)
14803 (mapc (lambda (x)
14804 (setq current (delete x current)))
14805 g)))
14806 (push tg current))
14807 (if exit-after-next (setq exit-after-next 'now))))
14809 ;; Create a sorted list
14810 (setq current
14811 (sort current
14812 (lambda (a b)
14813 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14814 (if (eq exit-after-next 'now) (throw 'exit t))
14815 (goto-char (point-min))
14816 (beginning-of-line 2)
14817 (delete-region (point) (point-at-eol))
14818 (org-fast-tag-insert "Current" current c-face)
14819 (org-set-current-tags-overlay current ov-prefix)
14820 (while (re-search-forward
14822 (setq tg (match-string 1))
14823 (add-text-properties
14824 (match-beginning 1) (match-end 1)
14825 (list 'face
14826 (cond
14827 ((member tg current) c-face)
14828 ((member tg inherited) i-face)
14829 (t (get-text-property (match-beginning 1) 'face))))))
14830 (goto-char (point-min)))))
14831 (org-detach-overlay org-tags-overlay)
14832 (if rtn
14833 (mapconcat 'identity current ":")
14834 nil))))
14836 (defun org-get-tags-string ()
14837 "Get the TAGS string in the current headline."
14838 (unless (org-at-heading-p t)
14839 (user-error "Not on a heading"))
14840 (save-excursion
14841 (beginning-of-line 1)
14843 (org-match-string-no-properties 1)
14844 "")))
14846 (defun org-get-tags ()
14847 "Get the list of tags specified in the current headline."
14848 (org-split-string (org-get-tags-string) ":"))
14850 (defun org-get-buffer-tags ()
14851 "Get a table of all tags used in the buffer, for completion."
14852 (let (tags)
14853 (save-excursion
14854 (goto-char (point-min))
14855 (while (re-search-forward
14857 (when (equal (char-after (point-at-bol 0)) ?*)
14858 (mapc (lambda (x) (add-to-list 'tags x))
14859 (org-split-string (org-match-string-no-properties 1) ":")))))
14860 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14861 (mapcar 'list tags)))
14863 ;;;; The mapping API
14865 (defun org-map-entries (func &optional match scope &rest skip)
14866 "Call FUNC at each headline selected by MATCH in SCOPE.
14868 FUNC is a function or a lisp form. The function will be called without
14869 arguments, with the cursor positioned at the beginning of the headline.
14870 The return values of all calls to the function will be collected and
14871 returned as a list.
14873 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14874 does not need to preserve point. After evaluation, the cursor will be
14875 moved to the end of the line (presumably of the headline of the
14876 processed entry) and search continues from there. Under some
14877 circumstances, this may not produce the wanted results. For example,
14878 if you have removed (e.g. archived) the current (sub)tree it could
14879 mean that the next entry will be skipped entirely. In such cases, you
14880 can specify the position from where search should continue by making
14881 FUNC set the variable `org-map-continue-from' to the desired buffer
14882 position.
14884 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14885 Only headlines that are matched by this query will be considered during
14886 the iteration. When MATCH is nil or t, all headlines will be
14887 visited by the iteration.
14889 SCOPE determines the scope of this command. It can be any of:
14891 nil The current buffer, respecting the restriction if any
14892 tree The subtree started with the entry at point
14893 region The entries within the active region, if any
14894 region-start-level
14895 The entries within the active region, but only those at
14896 the same level than the first one.
14897 file The current buffer, without restriction
14898 file-with-archives
14899 The current buffer, and any archives associated with it
14900 agenda All agenda files
14901 agenda-with-archives
14902 All agenda files with any archive files associated with them
14903 \(file1 file2 ...)
14904 If this is a list, all files in the list will be scanned
14906 The remaining args are treated as settings for the skipping facilities of
14907 the scanner. The following items can be given here:
14909 archive skip trees with the archive tag
14910 comment skip trees with the COMMENT keyword
14911 function or Emacs Lisp form:
14912 will be used as value for `org-agenda-skip-function', so
14913 whenever the function returns a position, FUNC will not be
14914 called for that entry and search will continue from the
14915 position returned
14917 If your function needs to retrieve the tags including inherited tags
14918 at the *current* entry, you can use the value of the variable
14919 `org-scanner-tags' which will be much faster than getting the value
14920 with `org-get-tags-at'. If your function gets properties with
14921 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14922 to t around the call to `org-entry-properties' to get the same speedup.
14923 Note that if your function moves around to retrieve tags and properties at
14924 a *different* entry, you cannot use these techniques."
14925 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14926 (not (org-region-active-p)))
14927 (let* ((org-agenda-archives-mode nil) ; just to make sure
14928 (org-agenda-skip-archived-trees (memq 'archive skip))
14929 (org-agenda-skip-comment-trees (memq 'comment skip))
14930 (org-agenda-skip-function
14931 (car (org-delete-all '(comment archive) skip)))
14932 (org-tags-match-list-sublevels t)
14933 (start-level (eq scope 'region-start-level))
14934 matcher file res
14935 org-todo-keywords-for-agenda
14936 org-done-keywords-for-agenda
14937 org-todo-keyword-alist-for-agenda
14938 org-tag-alist-for-agenda
14939 todo-only)
14941 (cond
14942 ((eq match t) (setq matcher t))
14943 ((eq match nil) (setq matcher t))
14944 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14946 (save-window-excursion
14947 (save-restriction
14948 (cond ((eq scope 'tree)
14949 (org-back-to-heading t)
14950 (org-narrow-to-subtree)
14951 (setq scope nil))
14952 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14953 (org-region-active-p))
14954 ;; If needed, set start-level to a string like "2"
14955 (when start-level
14956 (save-excursion
14957 (goto-char (region-beginning))
14958 (unless (org-at-heading-p) (outline-next-heading))
14959 (setq start-level (org-current-level))))
14960 (narrow-to-region (region-beginning)
14961 (save-excursion
14962 (goto-char (region-end))
14963 (unless (and (bolp) (org-at-heading-p))
14964 (outline-next-heading))
14965 (point)))
14966 (setq scope nil)))
14968 (if (not scope)
14969 (progn
14970 (org-agenda-prepare-buffers
14971 (list (buffer-file-name (current-buffer))))
14972 (setq res (org-scan-tags func matcher todo-only start-level)))
14973 ;; Get the right scope
14974 (cond
14975 ((and scope (listp scope) (symbolp (car scope)))
14976 (setq scope (eval scope)))
14977 ((eq scope 'agenda)
14978 (setq scope (org-agenda-files t)))
14979 ((eq scope 'agenda-with-archives)
14980 (setq scope (org-agenda-files t))
14981 (setq scope (org-add-archive-files scope)))
14982 ((eq scope 'file)
14983 (setq scope (list (buffer-file-name))))
14984 ((eq scope 'file-with-archives)
14985 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14986 (org-agenda-prepare-buffers scope)
14987 (while (setq file (pop scope))
14988 (with-current-buffer (org-find-base-buffer-visiting file)
14989 (save-excursion
14990 (save-restriction
14991 (widen)
14992 (goto-char (point-min))
14993 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14994 res)))
14996 ;;;; Properties
14998 ;;; Setting and retrieving properties
15000 (defconst org-special-properties
15001 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15002 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15003 "The special properties valid in Org-mode.
15005 These are properties that are not defined in the property drawer,
15006 but in some other way.")
15008 (defconst org-default-properties
15009 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15010 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15011 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15012 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15013 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15014 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15015 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15016 "Some properties that are used by Org-mode for various purposes.
15017 Being in this list makes sure that they are offered for completion.")
15020 "Regular expression matching the first line of a property drawer.")
15023 "Regular expression matching the last line of a property drawer.")
15026 "Regular expression matching the first line of a property drawer.")
15029 "Regular expression matching the first line of a property drawer.")
15031 (defconst org-property-drawer-re
15034 "Matches an entire property drawer.")
15036 (defconst org-clock-drawer-re
15039 "Matches an entire clock drawer.")
15041 (defun org-property-action ()
15042 "Do an action on properties."
15043 (interactive)
15044 (let (c)
15045 (org-at-property-p)
15046 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15047 (setq c (read-char-exclusive))
15048 (cond
15049 ((equal c ?s)
15050 (call-interactively 'org-set-property))
15051 ((equal c ?d)
15052 (call-interactively 'org-delete-property))
15053 ((equal c ?D)
15054 (call-interactively 'org-delete-property-globally))
15055 ((equal c ?c)
15056 (call-interactively 'org-compute-property-at-point))
15057 (t (user-error "No such property action %c" c)))))
15059 (defun org-inc-effort ()
15060 "Increment the value of the effort property in the current entry."
15061 (interactive)
15062 (org-set-effort nil t))
15064 (defvar org-clock-effort) ;; Defined in org-clock.el
15065 (defvar org-clock-current-task) ;; Defined in org-clock.el
15066 (defun org-set-effort (&optional value increment)
15067 "Set the effort property of the current entry.
15068 With numerical prefix arg, use the nth allowed value, 0 stands for the
15069 10th allowed value.
15071 When INCREMENT is non-nil, set the property to the next allowed value."
15072 (interactive "P")
15073 (if (equal value 0) (setq value 10))
15074 (let* ((completion-ignore-case t)
15075 (prop org-effort-property)
15076 (cur (org-entry-get nil prop))
15077 (allowed (org-property-get-allowed-values nil prop 'table))
15078 (existing (mapcar 'list (org-property-values prop)))
15079 (heading (nth 4 (org-heading-components)))
15080 rpl
15081 (val (cond
15082 ((stringp value) value)
15083 ((and allowed (integerp value))
15084 (or (car (nth (1- value) allowed))
15085 (car (org-last allowed))))
15086 ((and allowed increment)
15087 (or (caadr (member (list cur) allowed))
15088 (user-error "Allowed effort values are not set")))
15089 (allowed
15090 (message "Select 1-9,0, [RET%s]: %s"
15091 (if cur (concat "=" cur) "")
15092 (mapconcat 'car allowed " "))
15093 (setq rpl (read-char-exclusive))
15095 cur
15096 (setq rpl (- rpl ?0))
15097 (if (equal rpl 0) (setq rpl 10))
15098 (if (and (> rpl 0) (<= rpl (length allowed)))
15099 (car (nth (1- rpl) allowed))
15100 (org-completing-read "Effort: " allowed nil))))
15101 (t
15102 (let (org-completion-use-ido org-completion-use-iswitchb)
15103 (org-completing-read
15105 (concat "[" cur "]") "")
15106 ": ")
15107 existing nil nil "" nil cur))))))
15108 (unless (equal (org-entry-get nil prop) val)
15109 (org-entry-put nil prop val))
15110 (save-excursion
15111 (org-back-to-heading t)
15112 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15113 (when (string= heading org-clock-current-task)
15114 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15115 (org-clock-update-mode-line))
15116 (message "%s is now %s" prop val)))
15118 (defun org-at-property-p ()
15119 "Is cursor inside a property drawer?"
15120 (save-excursion
15121 (when (equal 'node-property (car (org-element-at-point)))
15122 (beginning-of-line 1)
15123 (looking-at org-property-re))))
15125 (defun org-get-property-block (&optional beg end force)
15126 "Return the (beg . end) range of the body of the property drawer.
15127 BEG and END are the beginning and end of the current subtree, or of
15128 the part before the first headline. If they are not given, they will
15129 be found. If the drawer does not exist and FORCE is non-nil, create
15130 the drawer."
15131 (catch 'exit
15132 (save-excursion
15133 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15134 (progn (org-back-to-heading t) (point))))
15135 (end (or end (and (not (outline-next-heading)) (point-max))
15136 (point))))
15137 (goto-char beg)
15138 (if (re-search-forward org-property-start-re end t)
15139 (setq beg (1+ (match-end 0)))
15140 (if force
15141 (save-excursion
15142 (org-insert-property-drawer)
15143 (setq end (progn (outline-next-heading) (point))))
15144 (throw 'exit nil))
15145 (goto-char beg)
15146 (if (re-search-forward org-property-start-re end t)
15147 (setq beg (1+ (match-end 0)))))
15148 (if (re-search-forward org-property-end-re end t)
15149 (setq end (match-beginning 0))
15150 (or force (throw 'exit nil))
15151 (goto-char beg)
15152 (setq end beg)
15153 (org-indent-line)
15155 (cons beg end)))))
15157 (defun org-entry-properties (&optional pom which specific)
15158 "Get all properties of the entry at point-or-marker POM.
15159 This includes the TODO keyword, the tags, time strings for deadline,
15160 scheduled, and clocking, and any additional properties defined in the
15161 entry. The return value is an alist, keys may occur multiple times
15162 if the property key was used several times.
15163 POM may also be nil, in which case the current entry is used.
15164 If WHICH is nil or `all', get all properties. If WHICH is
15165 `special' or `standard', only get that subclass. If WHICH
15166 is a string only get exactly this property. SPECIFIC can be a string, the
15167 specific property we are interested in. Specifying it can speed
15168 things up because then unnecessary parsing is avoided."
15169 (setq which (or which 'all))
15170 (org-with-point-at pom
15171 (let ((clockstr (substring org-clock-string 0 -1))
15172 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15173 (case-fold-search nil)
15174 beg end range props sum-props key key1 value string clocksum clocksumt)
15175 (save-excursion
15176 (when (condition-case nil
15177 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15178 (error nil))
15179 (setq beg (point))
15180 (setq sum-props (get-text-property (point) 'org-summaries))
15181 (setq clocksum (get-text-property (point) :org-clock-minutes)
15182 clocksumt (get-text-property (point) :org-clock-minutes-today))
15183 (outline-next-heading)
15184 (setq end (point))
15185 (when (memq which '(all special))
15186 ;; Get the special properties, like TODO and tags
15187 (goto-char beg)
15188 (when (and (or (not specific) (string= specific "TODO"))
15189 (looking-at org-todo-line-regexp) (match-end 2))
15190 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15191 (when (and (or (not specific) (string= specific "PRIORITY"))
15192 (looking-at org-priority-regexp))
15193 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15194 (when (or (not specific) (string= specific "FILE"))
15195 (push (cons "FILE" buffer-file-name) props))
15196 (when (and (or (not specific) (string= specific "TAGS"))
15197 (setq value (org-get-tags-string))
15199 (push (cons "TAGS" value) props))
15200 (when (and (or (not specific) (string= specific "ALLTAGS"))
15201 (setq value (org-get-tags-at)))
15202 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15203 ":"))
15204 props))
15205 (when (or (not specific) (string= specific "BLOCKED"))
15206 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15207 (when (or (not specific)
15208 (member specific
15209 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15210 "TIMESTAMP" "TIMESTAMP_IA")))
15211 (catch 'match
15212 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15213 (setq key (if (match-end 1)
15214 (substring (org-match-string-no-properties 1)
15215 0 -1))
15216 string (if (equal key clockstr)
15217 (org-trim
15218 (buffer-substring-no-properties
15219 (match-beginning 3) (goto-char
15220 (point-at-eol))))
15221 (substring (org-match-string-no-properties 3)
15222 1 -1)))
15223 ;; Get the correct property name from the key. This is
15224 ;; necessary if the user has configured time keywords.
15225 (setq key1 (concat key ":"))
15226 (cond
15227 ((not key)
15228 (setq key
15229 (if (= (char-after (match-beginning 3)) ?\[)
15230 "TIMESTAMP_IA" "TIMESTAMP")))
15231 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15232 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15233 ((equal key1 org-closed-string) (setq key "CLOSED"))
15234 ((equal key1 org-clock-string) (setq key "CLOCK")))
15235 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15236 (progn
15237 (push (cons key string) props)
15238 ;; no need to search further if match is found
15239 (throw 'match t))
15240 (when (or (equal key "CLOCK") (not (assoc key props)))
15241 (push (cons key string) props)))))))
15243 (when (memq which '(all standard))
15244 ;; Get the standard properties, like :PROP: ...
15245 (setq range (org-get-property-block beg end))
15246 (when range
15247 (goto-char (car range))
15248 (while (re-search-forward org-property-re
15249 (cdr range) t)
15250 (setq key (org-match-string-no-properties 2)
15251 value (org-trim (or (org-match-string-no-properties 3) "")))
15252 (unless (member key excluded)
15253 (push (cons key (or value "")) props)))))
15254 (if clocksum
15255 (push (cons "CLOCKSUM"
15256 (org-columns-number-to-string (/ (float clocksum) 60.)
15257 'add_times))
15258 props))
15259 (if clocksumt
15260 (push (cons "CLOCKSUM_T"
15261 (org-columns-number-to-string (/ (float clocksumt) 60.)
15262 'add_times))
15263 props))
15264 (unless (assoc "CATEGORY" props)
15265 (push (cons "CATEGORY" (org-get-category)) props))
15266 (append sum-props (nreverse props)))))))
15268 (defun org-entry-get (pom property &optional inherit literal-nil)
15269 "Get value of PROPERTY for entry or content at point-or-marker POM.
15270 If INHERIT is non-nil and the entry does not have the property,
15271 then also check higher levels of the hierarchy.
15272 If INHERIT is the symbol `selective', use inheritance only if the setting
15273 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15274 If the property is present but empty, the return value is the empty string.
15275 If the property is not present at all, nil is returned.
15278 do not interpret it as the list atom nil. This is used for inheritance
15280 (org-with-point-at pom
15281 (if (and inherit (if (eq inherit 'selective)
15282 (org-property-inherit-p property)
15283 t))
15284 (org-entry-get-with-inheritance property literal-nil)
15285 (if (member property org-special-properties)
15286 ;; We need a special property. Use `org-entry-properties' to
15287 ;; retrieve it, but specify the wanted property
15288 (cdr (assoc property (org-entry-properties nil 'special property)))
15289 (let ((range (org-get-property-block)))
15290 (when (and range (not (eq (car range) (cdr range))))
15291 (let* ((props (list (or (assoc property org-file-properties)
15292 (assoc property org-global-properties)
15293 (assoc property org-global-properties-fixed))))
15294 (ap (lambda (key)
15295 (when (re-search-forward
15296 (org-re-property key) (cdr range) t)
15297 (setq props
15298 (org-update-property-plist
15299 key
15300 (if (match-end 3)
15301 (org-match-string-no-properties 3) "")
15302 props)))))
15303 val)
15304 (goto-char (car range))
15305 (funcall ap property)
15306 (goto-char (car range))
15307 (while (funcall ap (concat property "+")))
15308 (setq val (cdr (assoc property props)))
15309 (when val (if literal-nil val (org-not-nil val))))))))))
15311 (defun org-property-or-variable-value (var &optional inherit)
15312 "Check if there is a property fixing the value of VAR.
15313 If yes, return this value. If not, return the current value of the variable."
15314 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15316 (read prop)
15317 (symbol-value var))))
15319 (defun org-entry-delete (pom property)
15320 "Delete the property PROPERTY from entry at point-or-marker POM."
15321 (unless (member property org-special-properties)
15322 (org-with-point-at pom
15323 (let ((range (org-get-property-block)))
15324 (if (and range
15325 (goto-char (car range))
15326 (re-search-forward
15327 (org-re-property property)
15328 (cdr range) t))
15329 (progn
15330 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15331 (org-remove-empty-drawer-at (car range))
15332 t)
15333 nil)))))
15335 ;; Multi-values properties are properties that contain multiple values
15336 ;; These values are assumed to be single words, separated by whitespace.
15337 (defun org-entry-add-to-multivalued-property (pom property value)
15338 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15339 (let* ((old (org-entry-get pom property))
15341 (setq value (org-entry-protect-space value))
15342 (unless (member value values)
15343 (setq values (append values (list value)))
15344 (org-entry-put pom property
15345 (mapconcat 'identity values " ")))))
15347 (defun org-entry-remove-from-multivalued-property (pom property value)
15348 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15349 (let* ((old (org-entry-get pom property))
15351 (setq value (org-entry-protect-space value))
15352 (when (member value values)
15353 (setq values (delete value values))
15354 (org-entry-put pom property
15355 (mapconcat 'identity values " ")))))
15357 (defun org-entry-member-in-multivalued-property (pom property value)
15358 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15359 (let* ((old (org-entry-get pom property))
15361 (setq value (org-entry-protect-space value))
15362 (member value values)))
15364 (defun org-entry-get-multivalued-property (pom property)
15365 "Return a list of values in a multivalued property."
15366 (let* ((value (org-entry-get pom property))
15368 (mapcar 'org-entry-restore-space values)))
15370 (defun org-entry-put-multivalued-property (pom property &rest values)
15371 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15372 VALUES should be a list of strings. Spaces will be protected."
15373 (org-entry-put pom property
15374 (mapconcat 'org-entry-protect-space values " "))
15375 (let* ((value (org-entry-get pom property))
15377 (mapcar 'org-entry-restore-space values)))
15379 (defun org-entry-protect-space (s)
15380 "Protect spaces and newline in string S."
15381 (while (string-match " " s)
15382 (setq s (replace-match "%20" t t s)))
15384 (setq s (replace-match "%0A" t t s)))
15385 s)
15387 (defun org-entry-restore-space (s)
15388 "Restore spaces and newline in string S."
15389 (while (string-match "%20" s)
15390 (setq s (replace-match " " t t s)))
15391 (while (string-match "%0A" s)
15393 s)
15395 (defvar org-entry-property-inherited-from (make-marker)
15396 "Marker pointing to the entry from where a property was inherited.
15397 Each call to `org-entry-get-with-inheritance' will set this marker to the
15398 location of the entry where the inheritance search matched. If there was
15399 no match, the marker will point nowhere.
15400 Note that also `org-entry-get' calls this function, if the INHERIT flag
15401 is set.")
15403 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15404 "Get PROPERTY of entry or content at point, search higher levels if needed.
15405 The search will stop at the first ancestor which has the property defined.
15407 should be considered as undefined (this is the meaning of nil here).
15409 (move-marker org-entry-property-inherited-from nil)
15410 (let (tmp)
15411 (save-excursion
15412 (save-restriction
15413 (widen)
15414 (catch 'ex
15415 (while t
15416 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15417 (or (ignore-errors (org-back-to-heading t))
15418 (goto-char (point-min)))
15419 (move-marker org-entry-property-inherited-from (point))
15420 (throw 'ex tmp))
15421 (or (ignore-errors (org-up-heading-safe))
15422 (throw 'ex nil))))))
15423 (setq tmp (or tmp
15424 (cdr (assoc property org-file-properties))
15425 (cdr (assoc property org-global-properties))
15426 (cdr (assoc property org-global-properties-fixed))))
15427 (if literal-nil tmp (org-not-nil tmp))))
15429 (defvar org-property-changed-functions nil
15430 "Hook called when the value of a property has changed.
15431 Each hook function should accept two arguments, the name of the property
15432 and the new value.")
15434 (defun org-entry-put (pom property value)
15435 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15436 (org-with-point-at pom
15437 (org-back-to-heading t)
15438 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15439 range)
15440 (cond
15441 ((equal property "TODO")
15443 (not (member value org-todo-keywords-1)))
15445 (if (or (not value)
15447 (setq value 'none))
15448 (org-todo value)
15449 (org-set-tags nil 'align))
15450 ((equal property "PRIORITY")
15452 (string-to-char value) ?\ ))
15453 (org-set-tags nil 'align))
15454 ((equal property "CLOCKSUM")
15455 (if (not (re-search-forward
15457 (error "Cannot find a clock log")
15458 (goto-char (- (match-end 1) 2))
15459 (cond
15460 ((eq value 'earlier) (org-timestamp-down))
15461 ((eq value 'later) (org-timestamp-up)))
15462 (org-clock-sum-current-item)))
15463 ((equal property "SCHEDULED")
15464 (if (re-search-forward org-scheduled-time-regexp end t)
15465 (cond
15466 ((eq value 'earlier) (org-timestamp-change -1 'day))
15467 ((eq value 'later) (org-timestamp-change 1 'day))
15468 (t (call-interactively 'org-schedule)))
15469 (call-interactively 'org-schedule)))
15470 ((equal property "DEADLINE")
15471 (if (re-search-forward org-deadline-time-regexp end t)
15472 (cond
15473 ((eq value 'earlier) (org-timestamp-change -1 'day))
15474 ((eq value 'later) (org-timestamp-change 1 'day))
15475 (t (call-interactively 'org-deadline)))
15476 (call-interactively 'org-deadline)))
15477 ((member property org-special-properties)
15478 (error "The %s property can not yet be set with `org-entry-put'"
15479 property))
15480 (t ; a non-special property
15481 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15482 (setq range (org-get-property-block beg end 'force))
15483 (goto-char (car range))
15484 (if (re-search-forward
15485 (org-re-property property) (cdr range) t)
15486 (progn
15487 (delete-region (match-beginning 0) (match-end 0))
15488 (goto-char (match-beginning 0)))
15489 (goto-char (cdr range))
15491 (backward-char 1)
15492 (org-indent-line))
15493 (insert ":" property ":")
15494 (and value (insert " " value))
15495 (org-indent-line)))))
15496 (run-hook-with-args 'org-property-changed-functions property value)))
15498 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15499 "Get all property keys in the current buffer.
15500 With INCLUDE-SPECIALS, also list the special properties that reflect things
15501 like tags and TODO state.
15502 With INCLUDE-DEFAULTS, also include properties that has special meaning
15503 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15504 and others.
15505 With INCLUDE-COLUMNS, also include property names given in COLUMN
15506 formats in the current buffer."
15507 (let (rtn range cfmt s p)
15508 (save-excursion
15509 (save-restriction
15510 (widen)
15511 (goto-char (point-min))
15512 (while (re-search-forward org-property-start-re nil t)
15513 (setq range (org-get-property-block))
15514 (goto-char (car range))
15515 (while (re-search-forward org-property-re
15516 (cdr range) t)
15517 (add-to-list 'rtn (org-match-string-no-properties 2)))
15518 (outline-next-heading))))
15520 (when include-specials
15521 (setq rtn (append org-special-properties rtn)))
15523 (when include-defaults
15524 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15525 (add-to-list 'rtn org-effort-property))
15527 (when include-columns
15528 (save-excursion
15529 (save-restriction
15530 (widen)
15531 (goto-char (point-min))
15532 (while (re-search-forward
15534 nil t)
15535 (setq cfmt (match-string 2) s 0)
15537 cfmt s)
15538 (setq s (match-end 0)
15539 p (match-string 1 cfmt))
15540 (unless (or (equal p "ITEM")
15541 (member p org-special-properties))
15542 (add-to-list 'rtn (match-string 1 cfmt))))))))
15544 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15546 (defun org-property-values (key)
15547 "Return a list of all values of property KEY in the current buffer."
15548 (save-excursion
15549 (save-restriction
15550 (widen)
15551 (goto-char (point-min))
15552 (let ((re (org-re-property key))
15553 values)
15554 (while (re-search-forward re nil t)
15555 (add-to-list 'values (org-trim (match-string 3))))
15556 (delete "" values)))))
15558 (defun org-insert-property-drawer ()
15559 "Insert a property drawer into the current entry."
15560 (org-back-to-heading t)
15561 (looking-at org-outline-regexp)
15562 (let ((indent (if org-adapt-indentation
15563 (- (match-end 0) (match-beginning 0))
15564 0))
15565 (beg (point))
15567 end hiddenp)
15568 (outline-next-heading)
15569 (setq end (point))
15570 (goto-char beg)
15571 (while (re-search-forward re end t))
15572 (setq hiddenp (outline-invisible-p))
15573 (end-of-line 1)
15576 (if (member (match-string 1) '("CLOCK:" ":END:"))
15577 ;; just skip this line
15578 (beginning-of-line 2)
15579 ;; Drawer start, find the end
15581 (beginning-of-line 1)))
15582 (org-skip-over-state-notes)
15585 (forward-char 1))
15586 (goto-char (point-at-eol))
15588 (beginning-of-line 0)
15589 (org-indent-to-column indent)
15590 (beginning-of-line 2)
15591 (org-indent-to-column indent)
15592 (beginning-of-line 0)
15593 (if hiddenp
15594 (save-excursion
15595 (org-back-to-heading t)
15596 (hide-entry))
15597 (org-flag-drawer t))))
15599 (defun org-insert-drawer (&optional arg drawer)
15600 "Insert a drawer at point.
15602 Optional argument DRAWER, when non-nil, is a string representing
15603 drawer's name. Otherwise, the user is prompted for a name.
15605 If a region is active, insert the drawer around that region
15606 instead.
15608 Point is left between drawer's boundaries."
15609 (interactive "P")
15610 (let* ((drawer (if arg "PROPERTIES"
15611 (or drawer (read-from-minibuffer "Drawer: ")))))
15612 (cond
15613 ;; With C-u, fall back on `org-insert-property-drawer'
15614 (arg (org-insert-property-drawer))
15615 ;;
15616 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
15617 (user-error "Invalid drawer name"))
15618 ;; With an active region, insert a drawer at point.
15619 ((not (org-region-active-p))
15620 (progn
15623 (forward-line -2)))
15624 ;; Otherwise, insert the drawer at point
15625 (t
15626 (let ((rbeg (region-beginning))
15627 (rend (copy-marker (region-end))))
15628 (unwind-protect
15629 (progn
15630 (goto-char rbeg)
15631 (beginning-of-line)
15632 (when (save-excursion
15633 (re-search-forward org-outline-regexp-bol rend t))
15634 (user-error "Drawers cannot contain headlines"))
15635 ;; Position point at the beginning of the first
15636 ;; non-blank line in region. Insert drawer's opening
15637 ;; there, then indent it.
15638 (org-skip-whitespace)
15639 (beginning-of-line)
15641 (forward-line -1)
15642 (indent-for-tab-command)
15643 ;; Move point to the beginning of the first blank line
15644 ;; after the last non-blank line in region. Insert
15645 ;; drawer's closing, then indent it.
15646 (goto-char rend)
15649 (deactivate-mark t)
15650 (indent-for-tab-command)
15652 ;; Clear marker, whatever the outcome of insertion is.
15653 (set-marker rend nil)))))))
15655 (defvar org-property-set-functions-alist nil
15656 "Property set function alist.
15657 Each entry should have the following format:
15659 (PROPERTY . READ-FUNCTION)
15661 The read function will be called with the same argument as
15662 `org-completing-read'.")
15664 (defun org-set-property-function (property)
15665 "Get the function that should be used to set PROPERTY.
15666 This is computed according to `org-property-set-functions-alist'."
15667 (or (cdr (assoc property org-property-set-functions-alist))
15668 'org-completing-read))
15670 (defun org-read-property-value (property)
15671 "Read PROPERTY value from user."
15672 (let* ((completion-ignore-case t)
15673 (allowed (org-property-get-allowed-values nil property 'table))
15674 (cur (org-entry-get nil property))
15675 (prompt (concat property " value"
15677 (concat " [" cur "]") "") ": "))
15678 (set-function (org-set-property-function property))
15679 (val (if allowed
15680 (funcall set-function prompt allowed nil
15681 (not (get-text-property 0 'org-unrestricted
15682 (caar allowed))))
15683 (let (org-completion-use-ido org-completion-use-iswitchb)
15684 (funcall set-function prompt
15685 (mapcar 'list (org-property-values property))
15686 nil nil "" nil cur)))))
15687 (if (equal val "")
15688 cur
15689 val)))
15691 (defvar org-last-set-property nil)
15692 (defvar org-last-set-property-value nil)
15693 (defun org-read-property-name ()
15694 "Read a property name."
15695 (let* ((completion-ignore-case t)
15696 (keys (org-buffer-property-keys nil t t))
15697 (default-prop (or (save-excursion
15698 (save-match-data
15699 (beginning-of-line)
15701 (null (string= (match-string 1) "END"))
15702 (match-string 1))))
15703 org-last-set-property))
15704 (property (org-icompleting-read
15705 (concat "Property"
15706 (if default-prop (concat " [" default-prop "]") "")
15707 ": ")
15708 (mapcar 'list keys)
15709 nil nil nil nil
15710 default-prop)))
15711 (if (member property keys)
15712 property
15713 (or (cdr (assoc (downcase property)
15714 (mapcar (lambda (x) (cons (downcase x) x))
15715 keys)))
15716 property))))
15718 (defun org-set-property-and-value (use-last)
15719 "Allow to set [PROPERTY]: [value] direction from prompt.
15720 When use-default, don't even ask, just use the last
15722 (interactive "P")
15723 (let* ((completion-ignore-case t)
15724 (pv (or (and use-last org-last-set-property-value)
15725 (org-completing-read
15727 nil nil nil nil nil
15728 org-last-set-property-value)))
15729 prop val)
15731 (setq prop (match-string 1 pv)
15732 val (match-string 2 pv))
15733 (org-set-property prop val))))
15735 (defun org-set-property (property value)
15736 "In the current entry, set PROPERTY to VALUE.
15737 When called interactively, this will prompt for a property name, offering
15738 completion on existing and default properties. And then it will prompt
15739 for a value, offering completion either on allowed values (via an inherited
15740 xxx_ALL property) or on existing values in other instances of this property
15741 in the current file."
15742 (interactive (list nil nil))
15743 (let* ((property (or property (org-read-property-name)))
15744 (value (or value (org-read-property-value property)))
15745 (fn (cdr (assoc property org-properties-postprocess-alist))))
15746 (setq org-last-set-property property)
15747 (setq org-last-set-property-value (concat property ": " value))
15748 ;; Possibly postprocess the inserted value:
15749 (when fn (setq value (funcall fn value)))
15750 (unless (equal (org-entry-get nil property) value)
15751 (org-entry-put nil property value))))
15753 (defun org-delete-property (property)
15754 "In the current entry, delete PROPERTY."
15755 (interactive
15756 (let* ((completion-ignore-case t)
15757 (prop (org-icompleting-read "Property: "
15758 (org-entry-properties nil 'standard))))
15759 (list prop)))
15760 (message "Property %s %s" property
15761 (if (org-entry-delete nil property)
15762 "deleted"
15763 "was not present in the entry")))
15765 (defun org-delete-property-globally (property)
15766 "Remove PROPERTY globally, from all entries."
15767 (interactive
15768 (let* ((completion-ignore-case t)
15769 (prop (org-icompleting-read
15770 "Globally remove property: "
15771 (mapcar 'list (org-buffer-property-keys)))))
15772 (list prop)))
15773 (save-excursion
15774 (save-restriction
15775 (widen)
15776 (goto-char (point-min))
15777 (let ((cnt 0))
15778 (while (re-search-forward
15779 (org-re-property property)
15780 nil t)
15781 (setq cnt (1+ cnt))
15782 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15785 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15787 (defun org-compute-property-at-point ()
15788 "Compute the property at point.
15789 This looks for an enclosing column format, extracts the operator and
15790 then applies it to the property in the column format's scope."
15791 (interactive)
15792 (unless (org-at-property-p)
15793 (user-error "Not at a property"))
15794 (let ((prop (org-match-string-no-properties 2)))
15795 (org-columns-get-format-and-top-level)
15796 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15797 (user-error "No operator defined for property %s" prop))
15798 (org-columns-compute prop)))
15800 (defvar org-property-allowed-value-functions nil
15801 "Hook for functions supplying allowed values for a specific property.
15802 The functions must take a single argument, the name of the property, and
15804 the values, this means that these values are intended as defaults for
15805 completion, but that other values should be allowed too.
15806 The functions must return nil if they are not responsible for this
15807 property.")
15809 (defun org-property-get-allowed-values (pom property &optional table)
15810 "Get allowed values for the property PROPERTY.
15811 When TABLE is non-nil, return an alist that can directly be used for
15812 completion."
15813 (let (vals)
15814 (cond
15815 ((equal property "TODO")
15816 (setq vals (org-with-point-at pom
15817 (append org-todo-keywords-1 '("")))))
15818 ((equal property "PRIORITY")
15819 (let ((n org-lowest-priority))
15820 (while (>= n org-highest-priority)
15821 (push (char-to-string n) vals)
15822 (setq n (1- n)))))
15823 ((member property org-special-properties))
15824 ((setq vals (run-hook-with-args-until-success
15825 'org-property-allowed-value-functions property)))
15826 (t
15827 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15829 (setq vals (car (read-from-string (concat "(" vals ")"))))
15830 (setq vals (mapcar (lambda (x)
15831 (cond ((stringp x) x)
15832 ((numberp x) (number-to-string x))
15833 ((symbolp x) (symbol-name x))
15834 (t "???")))
15835 vals)))))
15836 (when (member ":ETC" vals)
15837 (setq vals (remove ":ETC" vals))
15838 (org-add-props (car vals) '(org-unrestricted t)))
15839 (if table (mapcar 'list vals) vals)))
15841 (defun org-property-previous-allowed-value (&optional previous)
15842 "Switch to the next allowed value for this property."
15843 (interactive)
15844 (org-property-next-allowed-value t))
15846 (defun org-property-next-allowed-value (&optional previous)
15847 "Switch to the next allowed value for this property."
15848 (interactive)
15849 (unless (org-at-property-p)
15850 (user-error "Not at a property"))
15851 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15852 (key (match-string 2))
15853 (value (match-string 3))
15854 (allowed (or (org-property-get-allowed-values (point) key)
15855 (and (member value '("[ ]" "[-]" "[X]"))
15856 '("[ ]" "[X]"))))
15857 (heading (save-match-data (nth 4 (org-heading-components))))
15858 nval)
15859 (unless allowed
15860 (user-error "Allowed values for this property have not been defined"))
15861 (if previous (setq allowed (reverse allowed)))
15862 (if (member value allowed)
15863 (setq nval (car (cdr (member value allowed)))))
15864 (setq nval (or nval (car allowed)))
15865 (if (equal nval value)
15866 (user-error "Only one allowed value for this property"))
15867 (org-at-property-p)
15868 (replace-match (concat " :" key ": " nval) t t)
15869 (org-indent-line)
15870 (beginning-of-line 1)
15872 (when (equal prop org-effort-property)
15873 (save-excursion
15874 (org-back-to-heading t)
15875 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15876 (when (string= org-clock-current-task heading)
15877 (setq org-clock-effort nval)
15878 (org-clock-update-mode-line)))
15879 (run-hook-with-args 'org-property-changed-functions key nval)))
15881 (defun org-find-olp (path &optional this-buffer)
15882 "Return a marker pointing to the entry at outline path OLP.
15883 If anything goes wrong, throw an error.
15884 You can wrap this call to catch the error like this:
15886 (condition-case msg
15887 (org-mobile-locate-entry (match-string 4))
15888 (error (nth 1 msg)))
15890 The return value will then be either a string with the error message,
15891 or a marker if everything is OK.
15893 If THIS-BUFFER is set, the outline path does not contain a file,
15894 only headings."
15895 (let* ((file (if this-buffer buffer-file-name (pop path)))
15896 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15897 (level 1)
15898 (lmin 1)
15899 (lmax 1)
15900 limit re end found pos heading cnt flevel)
15901 (unless buffer (error "File not found :%s" file))
15902 (with-current-buffer buffer
15903 (save-excursion
15904 (save-restriction
15905 (widen)
15906 (setq limit (point-max))
15907 (goto-char (point-min))
15908 (while (setq heading (pop path))
15909 (setq re (format org-complex-heading-regexp-format
15910 (regexp-quote heading)))
15911 (setq cnt 0 pos (point))
15912 (while (re-search-forward re end t)
15913 (setq level (- (match-end 1) (match-beginning 1)))
15914 (if (and (>= level lmin) (<= level lmax))
15915 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15916 (when (= cnt 0) (error "Heading not found on level %d: %s"
15917 lmax heading))
15918 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15919 lmax heading))
15920 (goto-char found)
15921 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15922 (setq end (save-excursion (org-end-of-subtree t t))))
15923 (when (org-at-heading-p)
15924 (point-marker)))))))
15926 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15927 "Find node HEADING in BUFFER.
15928 Return a marker to the heading if it was found, or nil if not.
15929 If POS-ONLY is set, return just the position instead of a marker.
15931 The heading text must match exact, but it may have a TODO keyword,
15932 a priority cookie and tags in the standard locations."
15933 (with-current-buffer (or buffer (current-buffer))
15934 (save-excursion
15935 (save-restriction
15936 (widen)
15937 (goto-char (point-min))
15938 (let (case-fold-search)
15939 (if (re-search-forward
15940 (format org-complex-heading-regexp-format
15941 (regexp-quote heading)) nil t)
15942 (if pos-only
15943 (match-beginning 0)
15944 (move-marker (make-marker) (match-beginning 0)))))))))
15946 (defun org-find-exact-heading-in-directory (heading &optional dir)
15947 "Find Org node headline HEADING in all .org files in directory DIR.
15948 When the target headline is found, return a marker to this location."
15949 (let ((files (directory-files (or dir default-directory)
15951 file visiting m buffer)
15952 (catch 'found
15953 (while (setq file (pop files))
15954 (message "trying %s" file)
15955 (setq visiting (org-find-base-buffer-visiting file))
15956 (setq buffer (or visiting (find-file-noselect file)))
15957 (setq m (org-find-exact-headline-in-buffer
15958 heading buffer))
15959 (when (and (not m) (not visiting)) (kill-buffer buffer))
15960 (and m (throw 'found m))))))
15962 (defun org-find-entry-with-id (ident)
15963 "Locate the entry that contains the ID property with exact value IDENT.
15964 IDENT can be a string, a symbol or a number, this function will search for
15965 the string representation of it.
15966 Return the position where this entry starts, or nil if there is no such entry."
15967 (interactive "sID: ")
15968 (let ((id (cond
15969 ((stringp ident) ident)
15970 ((symbol-name ident) (symbol-name ident))
15971 ((numberp ident) (number-to-string ident))
15972 (t (error "IDENT %s must be a string, symbol or number" ident))))
15973 (case-fold-search nil))
15974 (save-excursion
15975 (save-restriction
15976 (widen)
15977 (goto-char (point-min))
15978 (when (re-search-forward
15980 nil t)
15981 (org-back-to-heading t)
15982 (point))))))
15984 ;;;; Timestamps
15986 (defvar org-last-changed-timestamp nil)
15987 (defvar org-last-inserted-timestamp nil
15988 "The last time stamp inserted with `org-insert-time-stamp'.")
15989 (defvar org-time-was-given) ; dynamically scoped parameter
15990 (defvar org-end-time-was-given) ; dynamically scoped parameter
15991 (defvar org-ts-what) ; dynamically scoped parameter
15993 (defun org-time-stamp (arg &optional inactive)
15994 "Prompt for a date/time and insert a time stamp.
15995 If the user specifies a time like HH:MM or if this command is
15996 called with at least one prefix argument, the time stamp contains
15997 the date and the time. Otherwise, only the date is be included.
15999 All parts of a date not specified by the user is filled in from
16000 the current date/time. So if you just press return without
16001 typing anything, the time stamp will represent the current
16002 date/time.
16004 If there is already a timestamp at the cursor, it will be
16005 modified.
16007 With two universal prefix arguments, insert an active timestamp
16008 with the current time without prompting the user.
16010 When called from lisp, the timestamp is inactive if INACTIVE is
16011 non-nil."
16012 (interactive "P")
16013 (let* ((ts nil)
16014 (default-time
16015 ;; Default time is either today, or, when entering a range,
16016 ;; the range start.
16017 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16018 (save-excursion
16019 (re-search-backward
16021 (- (point) 20) t)))
16022 (apply 'encode-time (org-parse-time-string (match-string 1)))
16023 (current-time)))
16024 (default-input (and ts (org-get-compact-tod ts)))
16025 (repeater (save-excursion
16026 (save-match-data
16027 (beginning-of-line)
16028 (when (re-search-forward
16030 (save-excursion (progn (end-of-line) (point))) t)
16031 (match-string 0)))))
16032 org-time-was-given org-end-time-was-given time)
16033 (cond
16034 ((and (org-at-timestamp-p t)
16035 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16036 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16037 (insert "--")
16038 (setq time (let ((this-command this-command))
16039 (org-read-date arg 'totime nil nil
16040 default-time default-input inactive)))
16041 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16042 ((org-at-timestamp-p t)
16043 (setq time (let ((this-command this-command))
16044 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16045 (when (org-at-timestamp-p t) ; just to get the match data
16046 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16047 (replace-match "")
16048 (setq org-last-changed-timestamp
16049 (org-insert-time-stamp
16050 time (or org-time-was-given arg)
16051 inactive nil nil (list org-end-time-was-given)))
16052 (when repeater (goto-char (1- (point))) (insert " " repeater)
16053 (setq org-last-changed-timestamp
16054 (concat (substring org-last-inserted-timestamp 0 -1)
16055 " " repeater ">"))))
16056 (message "Timestamp updated"))
16057 ((equal arg '(16))
16058 (org-insert-time-stamp (current-time) t inactive))
16059 (t
16060 (setq time (let ((this-command this-command))
16061 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16062 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16063 nil nil (list org-end-time-was-given))))))
16065 ;; FIXME: can we use this for something else, like computing time differences?
16066 (defun org-get-compact-tod (s)
16067 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16068 (let* ((t1 (match-string 1 s))
16069 (h1 (string-to-number (match-string 2 s)))
16070 (m1 (string-to-number (match-string 3 s)))
16071 (t2 (and (match-end 4) (match-string 5 s)))
16072 (h2 (and t2 (string-to-number (match-string 6 s))))
16073 (m2 (and t2 (string-to-number (match-string 7 s))))
16074 dh dm)
16075 (if (not t2)
16076 t1
16077 (setq dh (- h2 h1) dm (- m2 m1))
16078 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16079 (concat t1 "+" (number-to-string dh)
16080 (and (/= 0 dm) (format ":%02d" dm)))))))
16082 (defun org-time-stamp-inactive (&optional arg)
16083 "Insert an inactive time stamp.
16084 An inactive time stamp is enclosed in square brackets instead of angle
16085 brackets. It is inactive in the sense that it does not trigger agenda entries,
16086 does not link to the calendar and cannot be changed with the S-cursor keys.
16087 So these are more for recording a certain time/date."
16088 (interactive "P")
16089 (org-time-stamp arg 'inactive))
16091 (defvar org-date-ovl (make-overlay 1 1))
16092 (overlay-put org-date-ovl 'face 'org-date-selected)
16093 (org-detach-overlay org-date-ovl)
16095 (defvar org-ans1) ; dynamically scoped parameter
16096 (defvar org-ans2) ; dynamically scoped parameter
16098 (defvar org-plain-time-of-day-regexp) ; defined below
16100 (defvar org-overriding-default-time nil) ; dynamically scoped
16101 (defvar org-read-date-overlay nil)
16102 (defvar org-dcst nil) ; dynamically scoped
16103 (defvar org-read-date-history nil)
16104 (defvar org-read-date-final-answer nil)
16105 (defvar org-read-date-analyze-futurep nil)
16106 (defvar org-read-date-analyze-forced-year nil)
16107 (defvar org-read-date-inactive)
16109 (defvar org-read-date-minibuffer-local-map
16110 (let* ((org-replace-disputed-keys nil)
16111 (map (make-sparse-keymap)))
16112 (set-keymap-parent map minibuffer-local-map)
16113 (org-defkey map (kbd ".")
16114 (lambda () (interactive)
16115 ;; Are we at the beginning of the prompt?
16116 (if (looking-back "^[^:]+: ")
16117 (org-eval-in-calendar '(calendar-goto-today))
16118 (insert "."))))
16119 (org-defkey map (kbd "C-.")
16120 (lambda () (interactive)
16121 (org-eval-in-calendar '(calendar-goto-today))))
16122 (org-defkey map [(meta shift left)]
16123 (lambda () (interactive)
16124 (org-eval-in-calendar '(calendar-backward-month 1))))
16125 (org-defkey map [(meta shift right)]
16126 (lambda () (interactive)
16127 (org-eval-in-calendar '(calendar-forward-month 1))))
16128 (org-defkey map [(meta shift up)]
16129 (lambda () (interactive)
16130 (org-eval-in-calendar '(calendar-backward-year 1))))
16131 (org-defkey map [(meta shift down)]
16132 (lambda () (interactive)
16133 (org-eval-in-calendar '(calendar-forward-year 1))))
16134 (org-defkey map [?\e (shift left)]
16135 (lambda () (interactive)
16136 (org-eval-in-calendar '(calendar-backward-month 1))))
16137 (org-defkey map [?\e (shift right)]
16138 (lambda () (interactive)
16139 (org-eval-in-calendar '(calendar-forward-month 1))))
16140 (org-defkey map [?\e (shift up)]
16141 (lambda () (interactive)
16142 (org-eval-in-calendar '(calendar-backward-year 1))))
16143 (org-defkey map [?\e (shift down)]
16144 (lambda () (interactive)
16145 (org-eval-in-calendar '(calendar-forward-year 1))))
16146 (org-defkey map [(shift up)]
16147 (lambda () (interactive)
16148 (org-eval-in-calendar '(calendar-backward-week 1))))
16149 (org-defkey map [(shift down)]
16150 (lambda () (interactive)
16151 (org-eval-in-calendar '(calendar-forward-week 1))))
16152 (org-defkey map [(shift left)]
16153 (lambda () (interactive)
16154 (org-eval-in-calendar '(calendar-backward-day 1))))
16155 (org-defkey map [(shift right)]
16156 (lambda () (interactive)
16157 (org-eval-in-calendar '(calendar-forward-day 1))))
16158 (org-defkey map "!"
16159 (lambda () (interactive)
16160 (org-eval-in-calendar '(diary-view-entries))
16161 (message "")))
16162 (org-defkey map ">"
16163 (lambda () (interactive)
16164 (org-eval-in-calendar '(scroll-calendar-left 1))))
16165 (org-defkey map "<"
16166 (lambda () (interactive)
16167 (org-eval-in-calendar '(scroll-calendar-right 1))))
16168 (org-defkey map "\C-v"
16169 (lambda () (interactive)
16170 (org-eval-in-calendar
16171 '(calendar-scroll-left-three-months 1))))
16172 (org-defkey map "\M-v"
16173 (lambda () (interactive)
16174 (org-eval-in-calendar
16175 '(calendar-scroll-right-three-months 1))))
16176 map)
16177 "Keymap for minibuffer commands when using `org-read-date'.")
16179 (defun org-read-date (&optional org-with-time to-time from-string prompt
16180 default-time default-input inactive)
16181 "Read a date, possibly a time, and make things smooth for the user.
16182 The prompt will suggest to enter an ISO date, but you can also enter anything
16183 which will at least partially be understood by `parse-time-string'.
16184 Unrecognized parts of the date will default to the current day, month, year,
16185 hour and minute. If this command is called to replace a timestamp at point,
16186 or to enter the second timestamp of a range, the default time is taken
16187 from the existing stamp. Furthermore, the command prefers the future,
16188 so if you are giving a date where the year is not given, and the day-month
16189 combination is already past in the current year, it will assume you
16190 mean next year. For details, see the manual. A few examples:
16192 3-2-5 --> 2003-02-05
16193 feb 15 --> currentyear-02-15
16194 2/15 --> currentyear-02-15
16195 sep 12 9 --> 2009-09-12
16196 12:45 --> today 12:45
16197 22 sept 0:34 --> currentyear-09-22 0:34
16198 12 --> currentyear-currentmonth-12
16199 Fri --> nearest Friday after today
16200 -Tue --> last Tuesday
16201 etc.
16203 Furthermore you can specify a relative date by giving, as the *first* thing
16204 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16205 change in days weeks, months, years.
16206 With a single plus or minus, the date is relative to today. With a double
16207 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16208 +4d --> four days from today
16209 +4 --> same as above
16210 +2w --> two weeks from today
16211 ++5 --> five days from default date
16213 The function understands only English month and weekday abbreviations.
16215 While prompting, a calendar is popped up - you can also select the
16216 date with the mouse (button 1). The calendar shows a period of three
16217 months. To scroll it to other months, use the keys `>' and `<'.
16218 If you don't like the calendar, turn it off with
16219 \(setq org-read-date-popup-calendar nil)
16221 With optional argument TO-TIME, the date will immediately be converted
16222 to an internal time.
16223 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16224 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16225 still enter a time, and this function will inform the calling routine
16226 about this change. The calling routine may then choose to change the
16227 format used to insert the time stamp into the buffer to include the time.
16228 With optional argument FROM-STRING, read from this string instead from
16229 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16230 the time/date that is used for everything that is not specified by the
16231 user."
16232 (require 'parse-time)
16233 (let* ((org-time-stamp-rounding-minutes
16234 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16235 (org-dcst org-display-custom-times)
16236 (ct (org-current-time))
16237 (org-def (or org-overriding-default-time default-time ct))
16238 (org-defdecode (decode-time org-def))
16239 (dummy (progn
16240 (when (< (nth 2 org-defdecode) org-extend-today-until)
16241 (setcar (nthcdr 2 org-defdecode) -1)
16242 (setcar (nthcdr 1 org-defdecode) 59)
16243 (setq org-def (apply 'encode-time org-defdecode)
16244 org-defdecode (decode-time org-def)))))
16245 (mouse-autoselect-window nil) ; Don't let the mouse jump
16246 (calendar-frame-setup nil)
16247 (calendar-setup nil)
16248 (calendar-move-hook nil)
16249 (calendar-view-diary-initially-flag nil)
16250 (calendar-view-holidays-initially-flag nil)
16251 (timestr (format-time-string
16252 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16253 (prompt (concat (if prompt (concat prompt " ") "")
16254 (format "Date+time [%s]: " timestr)))
16255 ans (org-ans0 "") org-ans1 org-ans2 final)
16257 (cond
16258 (from-string (setq ans from-string))
16259 (org-read-date-popup-calendar
16260 (save-excursion
16261 (save-window-excursion
16262 (calendar)
16263 (org-eval-in-calendar '(setq cursor-type nil) t)
16264 (unwind-protect
16265 (progn
16266 (calendar-forward-day (- (time-to-days org-def)
16267 (calendar-absolute-from-gregorian
16268 (calendar-current-date))))
16269 (org-eval-in-calendar nil t)
16270 (let* ((old-map (current-local-map))
16271 (map (copy-keymap calendar-mode-map))
16272 (minibuffer-local-map
16273 (copy-keymap org-read-date-minibuffer-local-map)))
16274 (org-defkey map (kbd "RET") 'org-calendar-select)
16275 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16276 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16277 (unwind-protect
16278 (progn
16279 (use-local-map map)
16280 (setq org-read-date-inactive inactive)
16281 (add-hook 'post-command-hook 'org-read-date-display)
16282 (setq org-ans0 (read-string prompt default-input
16283 'org-read-date-history nil))
16284 ;; org-ans0: from prompt
16285 ;; org-ans1: from mouse click
16286 ;; org-ans2: from calendar motion
16287 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16288 (remove-hook 'post-command-hook 'org-read-date-display)
16289 (use-local-map old-map)
16290 (when org-read-date-overlay
16291 (delete-overlay org-read-date-overlay)
16292 (setq org-read-date-overlay nil)))))
16293 (bury-buffer "*Calendar*")))))
16295 (t ; Naked prompt only
16296 (unwind-protect
16297 (setq ans (read-string prompt default-input
16298 'org-read-date-history timestr))
16299 (when org-read-date-overlay
16300 (delete-overlay org-read-date-overlay)
16301 (setq org-read-date-overlay nil)))))
16303 (setq final (org-read-date-analyze ans org-def org-defdecode))
16305 (when org-read-date-analyze-forced-year
16306 (message "Year was forced into %s"
16307 (if org-read-date-force-compatible-dates
16308 "compatible range (1970-2037)"
16309 "range representable on this machine"))
16310 (ding))
16312 ;; One round trip to get rid of 34th of August and stuff like that....
16313 (setq final (decode-time (apply 'encode-time final)))
16315 (setq org-read-date-final-answer ans)
16317 (if to-time
16318 (apply 'encode-time final)
16319 (if (and (boundp 'org-time-was-given) org-time-was-given)
16320 (format "%04d-%02d-%02d %02d:%02d"
16321 (nth 5 final) (nth 4 final) (nth 3 final)
16322 (nth 2 final) (nth 1 final))
16323 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16325 (defvar org-def)
16326 (defvar org-defdecode)
16327 (defvar org-with-time)
16328 (defun org-read-date-display ()
16329 "Display the current date prompt interpretation in the minibuffer."
16330 (when org-read-date-display-live
16331 (when org-read-date-overlay
16332 (delete-overlay org-read-date-overlay))
16333 (when (minibufferp (current-buffer))
16334 (save-excursion
16335 (end-of-line 1)
16336 (while (not (equal (buffer-substring
16337 (max (point-min) (- (point) 4)) (point))
16338 " "))
16339 (insert " ")))
16340 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16341 " " (or org-ans1 org-ans2)))
16342 (org-end-time-was-given nil)
16343 (f (org-read-date-analyze ans org-def org-defdecode))
16344 (fmts (if org-dcst
16345 org-time-stamp-custom-formats
16346 org-time-stamp-formats))
16347 (fmt (if (or org-with-time
16348 (and (boundp 'org-time-was-given) org-time-was-given))
16349 (cdr fmts)
16350 (car fmts)))
16351 (txt (format-time-string fmt (apply 'encode-time f)))
16352 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16353 (txt (concat "=> " txt)))
16354 (when (and org-end-time-was-given
16355 (string-match org-plain-time-of-day-regexp txt))
16356 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16357 org-end-time-was-given
16358 (substring txt (match-end 0)))))
16359 (when org-read-date-analyze-futurep
16360 (setq txt (concat txt " (=>F)")))
16361 (setq org-read-date-overlay
16362 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16363 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16365 (defun org-read-date-analyze (ans org-def org-defdecode)
16366 "Analyze the combined answer of the date prompt."
16367 ;; FIXME: cleanup and comment
16368 (let ((nowdecode (decode-time (current-time)))
16369 delta deltan deltaw deltadef year month day
16370 hour minute second wday pm h2 m2 tl wday1
16371 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16372 (setq org-read-date-analyze-futurep nil
16373 org-read-date-analyze-forced-year nil)
16375 (setq ans "+0"))
16377 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16378 (setq ans (replace-match "" t t ans)
16379 deltan (car delta)
16380 deltaw (nth 1 delta)
16381 deltadef (nth 2 delta)))
16383 ;; Check if there is an iso week date in there. If yes, store the
16384 ;; info and postpone interpreting it until the rest of the parsing
16385 ;; is done.
16386 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16387 (setq iso-year (if (match-end 1)
16388 (org-small-year-to-year
16389 (string-to-number (match-string 1 ans))))
16390 iso-weekday (if (match-end 3)
16391 (string-to-number (match-string 3 ans)))
16392 iso-week (string-to-number (match-string 2 ans)))
16393 (setq ans (replace-match "" t t ans)))
16395 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16396 (when (string-match
16398 (setq year (if (match-end 2)
16399 (string-to-number (match-string 2 ans))
16400 (progn (setq kill-year t)
16401 (string-to-number (format-time-string "%Y"))))
16402 month (string-to-number (match-string 3 ans))
16403 day (string-to-number (match-string 4 ans)))
16404 (if (< year 100) (setq year (+ 2000 year)))
16406 t nil ans)))
16408 ;; Help matching dotted european dates
16409 (when (string-match
16410 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16411 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16412 (setq kill-year t)
16413 (string-to-number (format-time-string "%Y")))
16414 day (string-to-number (match-string 1 ans))
16415 month (string-to-number (match-string 2 ans))
16416 ans (replace-match (format "%04d-%02d-%02d" year month day)
16417 t nil ans)))
16419 ;; Help matching american dates, like 5/30 or 5/30/7
16420 (when (string-match
16421 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16422 (setq year (if (match-end 4)
16423 (string-to-number (match-string 4 ans))
16424 (progn (setq kill-year t)
16425 (string-to-number (format-time-string "%Y"))))
16426 month (string-to-number (match-string 1 ans))
16427 day (string-to-number (match-string 2 ans)))
16428 (if (< year 100) (setq year (+ 2000 year)))
16430 t nil ans)))
16431 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16432 ;; If there is a time with am/pm, and *no* time without it, we convert
16433 ;; so that matching will be successful.
16434 (loop for i from 1 to 2 do ; twice, for end time as well
16437 (setq hour (string-to-number (match-string 1 ans))
16438 minute (if (match-end 3)
16439 (string-to-number (match-string 3 ans))
16440 0)
16441 pm (equal ?p
16442 (string-to-char (downcase (match-string 4 ans)))))
16443 (if (and (= hour 12) (not pm))
16444 (setq hour 0)
16445 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16446 (setq ans (replace-match (format "%02d:%02d" hour minute)
16447 t t ans))))
16449 ;; Check if a time range is given as a duration
16450 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16451 (setq hour (string-to-number (match-string 1 ans))
16452 h2 (+ hour (string-to-number (match-string 3 ans)))
16453 minute (string-to-number (match-string 2 ans))
16454 m2 (+ minute (if (match-end 5) (string-to-number
16455 (match-string 5 ans))0)))
16456 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16457 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16458 t t ans)))
16460 ;; Check if there is a time range
16461 (when (boundp 'org-end-time-was-given)
16462 (setq org-time-was-given nil)
16463 (when (and (string-match org-plain-time-of-day-regexp ans)
16464 (match-end 8))
16465 (setq org-end-time-was-given (match-string 8 ans))
16466 (setq ans (concat (substring ans 0 (match-beginning 7))
16467 (substring ans (match-end 7))))))
16469 (setq tl (parse-time-string ans)
16470 day (or (nth 3 tl) (nth 3 org-defdecode))
16471 month (or (nth 4 tl)
16472 (if (and org-read-date-prefer-future
16473 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16474 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16475 (nth 4 org-defdecode)))
16476 year (or (and (not kill-year) (nth 5 tl))
16477 (if (and org-read-date-prefer-future
16478 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16479 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16480 (nth 5 org-defdecode)))
16481 hour (or (nth 2 tl) (nth 2 org-defdecode))
16482 minute (or (nth 1 tl) (nth 1 org-defdecode))
16483 second (or (nth 0 tl) 0)
16484 wday (nth 6 tl))
16486 (when (and (eq org-read-date-prefer-future 'time)
16487 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16488 (equal day (nth 3 nowdecode))
16489 (equal month (nth 4 nowdecode))
16490 (equal year (nth 5 nowdecode))
16491 (nth 2 tl)
16492 (or (< (nth 2 tl) (nth 2 nowdecode))
16493 (and (= (nth 2 tl) (nth 2 nowdecode))
16494 (nth 1 tl)
16495 (< (nth 1 tl) (nth 1 nowdecode)))))
16496 (setq day (1+ day)
16497 futurep t))
16499 ;; Special date definitions below
16500 (cond
16501 (iso-week
16502 ;; There was an iso week
16503 (require 'cal-iso)
16504 (setq futurep nil)
16505 (setq year (or iso-year year)
16506 day (or iso-weekday wday 1)
16507 wday nil ; to make sure that the trigger below does not match
16508 iso-date (calendar-gregorian-from-absolute
16509 (calendar-absolute-from-iso
16510 (list iso-week day year))))
16511 ; FIXME: Should we also push ISO weeks into the future?
16512 ; (when (and org-read-date-prefer-future
16513 ; (not iso-year)
16514 ; (< (calendar-absolute-from-gregorian iso-date)
16515 ; (time-to-days (current-time))))
16516 ; (setq year (1+ year)
16517 ; iso-date (calendar-gregorian-from-absolute
16518 ; (calendar-absolute-from-iso
16519 ; (list iso-week day year)))))
16520 (setq month (car iso-date)
16521 year (nth 2 iso-date)
16522 day (nth 1 iso-date)))
16523 (deltan
16524 (setq futurep nil)
16525 (unless deltadef
16526 (let ((now (decode-time (current-time))))
16527 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16528 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16529 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16530 ((equal deltaw "m") (setq month (+ month deltan)))
16531 ((equal deltaw "y") (setq year (+ year deltan)))))
16532 ((and wday (not (nth 3 tl)))
16533 ;; Weekday was given, but no day, so pick that day in the week
16534 ;; on or after the derived date.
16535 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16536 (unless (equal wday wday1)
16537 (setq day (+ day (% (- wday wday1 -7) 7))))))
16538 (if (and (boundp 'org-time-was-given)
16539 (nth 2 tl))
16540 (setq org-time-was-given t))
16541 (if (< year 100) (setq year (+ 2000 year)))
16542 ;; Check of the date is representable
16543 (if org-read-date-force-compatible-dates
16544 (progn
16545 (if (< year 1970)
16546 (setq year 1970 org-read-date-analyze-forced-year t))
16547 (if (> year 2037)
16548 (setq year 2037 org-read-date-analyze-forced-year t)))
16549 (condition-case nil
16550 (ignore (encode-time second minute hour day month year))
16551 (error
16552 (setq year (nth 5 org-defdecode))
16553 (setq org-read-date-analyze-forced-year t))))
16554 (setq org-read-date-analyze-futurep futurep)
16555 (list second minute hour day month year)))
16557 (defvar parse-time-weekdays)
16558 (defun org-read-date-get-relative (s today default)
16559 "Check string S for special relative date string.
16560 TODAY and DEFAULT are internal times, for today and for a default.
16561 Return shift list (N what def-flag)
16563 N is the number of WHATs to shift.
16564 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16565 the DEFAULT date rather than TODAY."
16566 (require 'parse-time)
16567 (when (and
16568 (string-match
16569 (concat
16574 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16575 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16576 (string-to-char (substring (match-string 1 s) -1))
16577 ?+))
16578 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16579 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16580 (what (if (match-end 3) (match-string 3 s) "d"))
16581 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16582 (date (if rel default today))
16583 (wday (nth 6 (decode-time date)))
16584 delta)
16585 (if wday1
16586 (progn
16587 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16588 (if (= delta 0) (setq delta 7))
16589 (if (= dir ?-)
16590 (progn
16591 (setq delta (- delta 7))
16592 (if (= delta 0) (setq delta -7))))
16593 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16594 (list delta "d" rel))
16595 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16597 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16598 "Turn a user-specified date into the internal representation.
16599 The internal representation needed by the calendar is (month day year).
16600 This is a wrapper to handle the brain-dead convention in calendar that
16601 user function argument order change dependent on argument order."
16602 (if (boundp 'calendar-date-style)
16603 (cond
16604 ((eq calendar-date-style 'american)
16605 (list arg1 arg2 arg3))
16606 ((eq calendar-date-style 'european)
16607 (list arg2 arg1 arg3))
16608 ((eq calendar-date-style 'iso)
16609 (list arg2 arg3 arg1)))
16610 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16611 (if (org-bound-and-true-p european-calendar-style)
16612 (list arg2 arg1 arg3)
16613 (list arg1 arg2 arg3)))))
16615 (defun org-eval-in-calendar (form &optional keepdate)
16616 "Eval FORM in the calendar window and return to current window.
16617 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16618 otherwise stick to the current value of `org-ans2'."
16619 (let ((sf (selected-frame))
16620 (sw (selected-window)))
16621 (select-window (get-buffer-window "*Calendar*" t))
16622 (eval form)
16623 (when (and (not keepdate) (calendar-cursor-to-date))
16624 (let* ((date (calendar-cursor-to-date))
16625 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16626 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16627 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16628 (select-window sw)
16629 (org-select-frame-set-input-focus sf)))
16631 (defun org-calendar-select ()
16632 "Return to `org-read-date' with the date currently selected.
16633 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16634 (interactive)
16635 (when (calendar-cursor-to-date)
16636 (let* ((date (calendar-cursor-to-date))
16637 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16638 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16639 (if (active-minibuffer-window) (exit-minibuffer))))
16641 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16642 "Insert a date stamp for the date given by the internal TIME.
16643 WITH-HM means use the stamp format that includes the time of the day.
16644 INACTIVE means use square brackets instead of angular ones, so that the
16645 stamp will not contribute to the agenda.
16646 PRE and POST are optional strings to be inserted before and after the
16647 stamp.
16648 The command returns the inserted time stamp."
16649 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16650 stamp)
16651 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16652 (insert-before-markers (or pre ""))
16653 (when (listp extra)
16654 (setq extra (car extra))
16655 (if (and (stringp extra)
16657 (setq extra (format "-%02d:%02d"
16658 (string-to-number (match-string 1 extra))
16659 (string-to-number (match-string 2 extra))))
16660 (setq extra nil)))
16661 (when extra
16662 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16663 (insert-before-markers (setq stamp (format-time-string fmt time)))
16664 (insert-before-markers (or post ""))
16665 (setq org-last-inserted-timestamp stamp)))
16667 (defun org-toggle-time-stamp-overlays ()
16668 "Toggle the use of custom time stamp formats."
16669 (interactive)
16670 (setq org-display-custom-times (not org-display-custom-times))
16671 (unless org-display-custom-times
16672 (let ((p (point-min)) (bmp (buffer-modified-p)))
16673 (while (setq p (next-single-property-change p 'display))
16674 (if (and (get-text-property p 'display)
16675 (eq (get-text-property p 'face) 'org-date))
16676 (remove-text-properties
16677 p (setq p (next-single-property-change p 'display))
16678 '(display t))))
16679 (set-buffer-modified-p bmp)))
16680 (if (featurep 'xemacs)
16681 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16682 (org-restart-font-lock)
16683 (setq org-table-may-need-update t)
16684 (if org-display-custom-times
16685 (message "Time stamps are overlaid with custom format")
16686 (message "Time stamp overlays removed")))
16688 (defun org-display-custom-time (beg end)
16689 "Overlay modified time stamp format over timestamp between BEG and END."
16690 (let* ((ts (buffer-substring beg end))
16691 t1 w1 with-hm tf time str w2 (off 0))
16692 (save-match-data
16693 (setq t1 (org-parse-time-string ts t))
16694 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16695 (setq off (- (match-end 0) (match-beginning 0)))))
16696 (setq end (- end off))
16697 (setq w1 (- end beg)
16698 with-hm (and (nth 1 t1) (nth 2 t1))
16699 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16700 time (org-fix-decoded-time t1)
16701 str (org-add-props
16702 (format-time-string
16703 (substring tf 1 -1) (apply 'encode-time time))
16704 nil 'mouse-face 'highlight)
16705 w2 (length str))
16706 (if (not (= w2 w1))
16707 (add-text-properties (1+ beg) (+ 2 beg)
16708 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16709 (if (featurep 'xemacs)
16710 (progn
16711 (put-text-property beg end 'invisible t)
16712 (put-text-property beg end 'end-glyph (make-glyph str)))
16713 (put-text-property beg end 'display str))))
16715 (defun org-translate-time (string)
16716 "Translate all timestamps in STRING to custom format.
16717 But do this only if the variable `org-display-custom-times' is set."
16718 (when org-display-custom-times
16719 (save-match-data
16720 (let* ((start 0)
16721 (re org-ts-regexp-both)
16722 t1 with-hm inactive tf time str beg end)
16723 (while (setq start (string-match re string start))
16724 (setq beg (match-beginning 0)
16725 end (match-end 0)
16726 t1 (save-match-data
16727 (org-parse-time-string (substring string beg end) t))
16728 with-hm (and (nth 1 t1) (nth 2 t1))
16729 inactive (equal (substring string beg (1+ beg)) "[")
16730 tf (funcall (if with-hm 'cdr 'car)
16731 org-time-stamp-custom-formats)
16732 time (org-fix-decoded-time t1)
16733 str (format-time-string
16734 (concat
16735 (if inactive "[" "<") (substring tf 1 -1)
16736 (if inactive "]" ">"))
16737 (apply 'encode-time time))
16738 string (replace-match str t t string)
16739 start (+ start (length str)))))))
16740 string)
16742 (defun org-fix-decoded-time (time)
16743 "Set 0 instead of nil for the first 6 elements of time.
16744 Don't touch the rest."
16745 (let ((n 0))
16746 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16748 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16750 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16751 "Difference between TIMESTAMP-STRING and now in days.
16752 If SECONDS is non-nil, return the difference in seconds."
16753 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16754 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16755 (funcall fdiff (current-time)))))
16757 (defun org-deadline-close (timestamp-string &optional ndays)
16758 "Is the time in TIMESTAMP-STRING close to the current date?"
16759 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16760 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16761 (not (org-entry-is-done-p))))
16763 (defun org-get-wdays (ts &optional delay zero-delay)
16764 "Get the deadline lead time appropriate for timestring TS.
16765 When DELAY is non-nil, get the delay time for scheduled items
16766 instead of the deadline lead time. When ZERO-DELAY is non-nil
16767 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16768 don't try to find the delay cookie in the scheduled timestamp."
16769 (let ((tv (if delay org-scheduled-delay-days
16770 org-deadline-warning-days)))
16771 (cond
16772 ((or (and delay (< tv 0))
16773 (and delay zero-delay (<= tv 0))
16774 (and (not delay) (<= tv 0)))
16775 ;; Enforce this value no matter what
16776 (- tv))
16778 ;; lead time is specified.
16779 (floor (* (string-to-number (match-string 1 ts))
16780 (cdr (assoc (match-string 2 ts)
16781 '(("d" . 1) ("w" . 7)
16782 ("m" . 30.4) ("y" . 365.25)
16783 ("h" . 0.041667)))))))
16784 ;; go for the default.
16785 (t tv))))
16787 (defun org-calendar-select-mouse (ev)
16788 "Return to `org-read-date' with the date currently selected.
16789 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16790 (interactive "e")
16791 (mouse-set-point ev)
16792 (when (calendar-cursor-to-date)
16793 (let* ((date (calendar-cursor-to-date))
16794 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16795 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16796 (if (active-minibuffer-window) (exit-minibuffer))))
16798 (defun org-check-deadlines (ndays)
16799 "Check if there are any deadlines due or past due.
16800 A deadline is considered due if it happens within `org-deadline-warning-days'
16801 days from today's date. If the deadline appears in an entry marked DONE,
16802 it is not shown. The prefix arg NDAYS can be used to test that many
16804 (interactive "P")
16805 (let* ((org-warn-days
16806 (cond
16807 ((equal ndays '(4)) 100000)
16808 (ndays (prefix-numeric-value ndays))
16809 (t (abs org-deadline-warning-days))))
16810 (case-fold-search nil)
16812 (callback
16813 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16815 (message "%d deadlines past-due or due within %d days"
16816 (org-occur regexp nil callback)
16817 org-warn-days)))
16819 (defsubst org-re-timestamp (type)
16820 "Return a regexp for timestamp TYPE.
16821 Allowed values for TYPE are:
16823 all: all timestamps
16824 active: only active timestamps (<...>)
16825 inactive: only inactive timestamps ([...])
16826 scheduled: only scheduled timestamps
16827 deadline: only deadline timestamps
16828 closed: only closed time-stamps
16830 When TYPE is nil, fall back on returning a regexp that matches
16831 both scheduled and deadline timestamps."
16832 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16833 ((eq type 'active) org-ts-regexp)
16837 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16838 ((eq type 'scheduled-or-deadline)
16841 (defun org-check-before-date (date)
16842 "Check if there are deadlines or scheduled entries before DATE."
16843 (interactive (list (org-read-date)))
16844 (let ((case-fold-search nil)
16845 (regexp (org-re-timestamp org-ts-type))
16846 (callback
16847 (lambda () (time-less-p
16848 (org-time-string-to-time (match-string 1))
16849 (org-time-string-to-time date)))))
16850 (message "%d entries before %s"
16851 (org-occur regexp nil callback) date)))
16853 (defun org-check-after-date (date)
16854 "Check if there are deadlines or scheduled entries after DATE."
16855 (interactive (list (org-read-date)))
16856 (let ((case-fold-search nil)
16857 (regexp (org-re-timestamp org-ts-type))
16858 (callback
16859 (lambda () (not
16860 (time-less-p
16861 (org-time-string-to-time (match-string 1))
16862 (org-time-string-to-time date))))))
16863 (message "%d entries after %s"
16864 (org-occur regexp nil callback) date)))
16866 (defun org-check-dates-range (start-date end-date)
16867 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16868 (interactive (list (org-read-date nil nil nil "Range starts")
16869 (org-read-date nil nil nil "Range end")))
16870 (let ((case-fold-search nil)
16871 (regexp (org-re-timestamp org-ts-type))
16872 (callback
16873 (lambda ()
16874 (let ((match (match-string 1)))
16875 (and
16876 (not (time-less-p
16877 (org-time-string-to-time match)
16878 (org-time-string-to-time start-date)))
16879 (time-less-p
16880 (org-time-string-to-time match)
16881 (org-time-string-to-time end-date)))))))
16882 (message "%d entries between %s and %s"
16883 (org-occur regexp nil callback) start-date end-date)))
16885 (defun org-evaluate-time-range (&optional to-buffer)
16886 "Evaluate a time range by computing the difference between start and end.
16887 Normally the result is just printed in the echo area, but with prefix arg
16888 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16889 If the time range is actually in a table, the result is inserted into the
16890 next column.
16891 For time difference computation, a year is assumed to be exactly 365
16892 days in order to avoid rounding problems."
16893 (interactive "P")
16894 (or
16895 (org-clock-update-time-maybe)
16896 (save-excursion
16897 (unless (org-at-date-range-p t)
16898 (goto-char (point-at-bol))
16899 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16900 (if (not (org-at-date-range-p t))
16901 (user-error "Not at a time-stamp range, and none found in current line")))
16902 (let* ((ts1 (match-string 1))
16903 (ts2 (match-string 2))
16904 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16905 (match-end (match-end 0))
16906 (time1 (org-time-string-to-time ts1))
16907 (time2 (org-time-string-to-time ts2))
16908 (t1 (org-float-time time1))
16909 (t2 (org-float-time time2))
16910 (diff (abs (- t2 t1)))
16911 (negative (< (- t2 t1) 0))
16912 ;; (ys (floor (* 365 24 60 60)))
16913 (ds (* 24 60 60))
16914 (hs (* 60 60))
16915 (fy "%dy %dd %02d:%02d")
16916 (fy1 "%dy %dd")
16917 (fd "%dd %02d:%02d")
16918 (fd1 "%dd")
16919 (fh "%02d:%02d")
16920 y d h m align)
16921 (if havetime
16922 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16923 y 0
16924 d (floor (/ diff ds)) diff (mod diff ds)
16925 h (floor (/ diff hs)) diff (mod diff hs)
16926 m (floor (/ diff 60)))
16927 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16928 y 0
16929 d (floor (+ (/ diff ds) 0.5))
16930 h 0 m 0))
16931 (if (not to-buffer)
16932 (message "%s" (org-make-tdiff-string y d h m))
16933 (if (org-at-table-p)
16934 (progn
16935 (goto-char match-end)
16936 (setq align t)
16937 (and (looking-at " *|") (goto-char (match-end 0))))
16938 (goto-char match-end))
16939 (if (looking-at
16941 (replace-match ""))
16942 (if negative (insert " -"))
16943 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16944 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16945 (insert " " (format fh h m))))
16946 (if align (org-table-align))
16947 (message "Time difference inserted")))))
16949 (defun org-make-tdiff-string (y d h m)
16950 (let ((fmt "")
16951 (l nil))
16952 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16953 l (push y l)))
16954 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16955 l (push d l)))
16956 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16957 l (push h l)))
16958 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16959 l (push m l)))
16960 (apply 'format fmt (nreverse l))))
16962 (defun org-time-string-to-time (s &optional buffer pos)
16963 "Convert a timestamp string into internal time."
16964 (condition-case errdata
16965 (apply 'encode-time (org-parse-time-string s))
16967 s (if (not (and buffer pos))
16968 ""
16969 (format " at %d in buffer `%s'" pos buffer))
16970 (cdr errdata)))))
16972 (defun org-time-string-to-seconds (s)
16973 "Convert a timestamp string to a number of seconds."
16974 (org-float-time (org-time-string-to-time s)))
16976 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16977 "Convert a time stamp to an absolute day number.
16978 If there is a specifier for a cyclic time stamp, get the closest
16979 date to DAYNR.
16980 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16981 The variable `date' is bound by the calendar when this is called."
16982 (cond
16984 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16985 daynr
16986 (+ daynr 1000)))
16988 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16989 (time-to-days (current-time))) (match-string 0 s)
16990 prefer show-all))
16991 (t (time-to-days
16992 (condition-case errdata
16993 (apply 'encode-time (org-parse-time-string s))
16995 s (if (not (and buffer pos))
16996 ""
16997 (format " at %d in buffer `%s'" pos buffer))
16998 (cdr errdata))))))))
17000 (defun org-days-to-iso-week (days)
17001 "Return the iso week number."
17002 (require 'cal-iso)
17003 (car (calendar-iso-from-absolute days)))
17005 (defun org-small-year-to-year (year)
17006 "Convert 2-digit years into 4-digit years.
17007 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17008 The year 2000 cannot be abbreviated. Any year larger than 99
17009 is returned unchanged."
17010 (if (< year 38)
17011 (setq year (+ 2000 year))
17012 (if (< year 100)
17013 (setq year (+ 1900 year))))
17014 year)
17016 (defun org-time-from-absolute (d)
17017 "Return the time corresponding to date D.
17018 D may be an absolute day number, or a calendar-type list (month day year)."
17019 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17020 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17022 (defun org-calendar-holiday ()
17023 "List of holidays, for Diary display in Org-mode."
17024 (require 'holidays)
17025 (let ((hl (funcall
17026 (if (fboundp 'calendar-check-holidays)
17027 'calendar-check-holidays 'check-calendar-holidays) date)))
17028 (if hl (mapconcat 'identity hl "; "))))
17030 (defun org-diary-sexp-entry (sexp entry date)
17031 "Process a SEXP diary ENTRY for DATE."
17032 (require 'diary-lib)
17033 (let ((result (if calendar-debug-sexp
17034 (let ((stack-trace-on-error t))
17035 (eval (car (read-from-string sexp))))
17036 (condition-case nil
17037 (eval (car (read-from-string sexp)))
17038 (error
17039 (beep)
17040 (message "Bad sexp at line %d in %s: %s"
17041 (org-current-line)
17042 (buffer-file-name) sexp)
17043 (sleep-for 2))))))
17044 (cond ((stringp result) (split-string result "; "))
17045 ((and (consp result)
17046 (not (consp (cdr result)))
17047 (stringp (cdr result))) (cdr result))
17048 ((and (consp result)
17049 (stringp (car result))) result)
17050 (result entry))))
17052 (defun org-diary-to-ical-string (frombuf)
17053 "Get iCalendar entries from diary entries in buffer FROMBUF.
17054 This uses the icalendar.el library."
17055 (let* ((tmpdir (if (featurep 'xemacs)
17056 (temp-directory)
17057 temporary-file-directory))
17058 (tmpfile (make-temp-name
17059 (expand-file-name "orgics" tmpdir)))
17060 buf rtn b e)
17061 (with-current-buffer frombuf
17062 (icalendar-export-region (point-min) (point-max) tmpfile)
17063 (setq buf (find-buffer-visiting tmpfile))
17064 (set-buffer buf)
17065 (goto-char (point-min))
17066 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17067 (setq b (match-beginning 0)))
17068 (goto-char (point-max))
17069 (if (re-search-backward "^END:VEVENT" nil t)
17070 (setq e (match-end 0)))
17072 (kill-buffer buf)
17073 (delete-file tmpfile)
17074 rtn))
17076 (defun org-closest-date (start current change prefer show-all)
17077 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17078 When PREFER is `past', return a date that is either CURRENT or past.
17079 When PREFER is `future', return a date that is either CURRENT or future.
17080 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17081 ;; Make the proper lists from the dates
17082 (catch 'exit
17083 (let ((a1 '(("h" . hour)
17084 ("d" . day)
17085 ("w" . week)
17086 ("m" . month)
17087 ("y" . year)))
17088 (shour (nth 2 (org-parse-time-string start)))
17089 dn dw sday cday n1 n2 n0
17090 d m y y1 y2 date1 date2 nmonths nm ny m2)
17092 (setq start (org-date-to-gregorian start)
17093 current (org-date-to-gregorian
17094 (if show-all
17095 current
17096 (time-to-days (current-time))))
17097 sday (calendar-absolute-from-gregorian start)
17098 cday (calendar-absolute-from-gregorian current))
17100 (if (<= cday sday) (throw 'exit sday))
17103 (setq dn (string-to-number (match-string 1 change))
17104 dw (cdr (assoc (match-string 2 change) a1)))
17105 (user-error "Invalid change specifier: %s" change))
17106 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17107 (cond
17108 ((eq dw 'hour)
17109 (let ((missing-hours
17110 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17111 dn)))
17112 (setq n1 (if (zerop missing-hours) cday
17113 (- cday (1+ (floor (/ missing-hours 24)))))
17114 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17115 ((eq dw 'day)
17116 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17117 n2 (+ n1 dn)))
17118 ((eq dw 'year)
17119 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17120 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17121 (setq date1 (list m d y1)
17122 n1 (calendar-absolute-from-gregorian date1)
17123 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17124 n2 (calendar-absolute-from-gregorian date2)))
17125 ((eq dw 'month)
17126 ;; approx number of month between the two dates
17127 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17128 ;; How often does dn fit in there?
17129 (setq d (nth 1 start) m (car start) y (nth 2 start)
17130 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17131 m (+ m nm)
17132 ny (floor (/ m 12))
17133 y (+ y ny)
17134 m (- m (* ny 12)))
17135 (while (> m 12) (setq m (- m 12) y (1+ y)))
17136 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17137 (setq m2 (+ m dn) y2 y)
17138 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17139 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17140 (while (<= n2 cday)
17141 (setq n1 n2 m m2 y y2)
17142 (setq m2 (+ m dn) y2 y)
17143 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17144 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17145 ;; Make sure n1 is the earlier date
17146 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17147 (if show-all
17148 (cond
17149 ((eq prefer 'past) (if (= cday n2) n2 n1))
17150 ((eq prefer 'future) (if (= cday n1) n1 n2))
17151 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17152 (cond
17153 ((eq prefer 'past) (if (= cday n2) n2 n1))
17154 ((eq prefer 'future) (if (= cday n1) n1 n2))
17155 (t (if (= cday n1) n1 n2)))))))
17157 (defun org-date-to-gregorian (date)
17158 "Turn any specification of DATE into a Gregorian date for the calendar."
17159 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17160 ((and (listp date) (= (length date) 3)) date)
17161 ((stringp date)
17162 (setq date (org-parse-time-string date))
17163 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17164 ((listp date)
17165 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17167 (defun org-parse-time-string (s &optional nodefault)
17168 "Parse the standard Org-mode time string.
17169 This should be a lot faster than the normal `parse-time-string'.
17170 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17171 hour and minute fields will be nil if not given."
17172 (cond ((string-match org-ts-regexp0 s)
17173 (list 0
17174 (if (or (match-beginning 8) (not nodefault))
17175 (string-to-number (or (match-string 8 s) "0")))
17176 (if (or (match-beginning 7) (not nodefault))
17177 (string-to-number (or (match-string 7 s) "0")))
17178 (string-to-number (match-string 4 s))
17179 (string-to-number (match-string 3 s))
17180 (string-to-number (match-string 2 s))
17181 nil nil nil))
17182 ((string-match "^<[^>]+>$" s)
17183 (decode-time (seconds-to-time (org-matcher-time s))))
17184 (t (error "Not a standard Org-mode time string: %s" s))))
17186 (defun org-timestamp-up (&optional arg)
17187 "Increase the date item at the cursor by one.
17188 If the cursor is on the year, change the year. If it is on the month,
17189 the day or the time, change that.
17190 With prefix ARG, change by that many units."
17191 (interactive "p")
17192 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17194 (defun org-timestamp-down (&optional arg)
17195 "Decrease the date item at the cursor by one.
17196 If the cursor is on the year, change the year. If it is on the month,
17197 the day or the time, change that.
17198 With prefix ARG, change by that many units."
17199 (interactive "p")
17200 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17202 (defun org-timestamp-up-day (&optional arg)
17203 "Increase the date in the time stamp by one day.
17204 With prefix ARG, change that many days."
17205 (interactive "p")
17206 (if (and (not (org-at-timestamp-p t))
17207 (org-at-heading-p))
17208 (org-todo 'up)
17209 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17211 (defun org-timestamp-down-day (&optional arg)
17212 "Decrease the date in the time stamp by one day.
17213 With prefix ARG, change that many days."
17214 (interactive "p")
17215 (if (and (not (org-at-timestamp-p t))
17216 (org-at-heading-p))
17217 (org-todo 'down)
17218 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17220 (defun org-at-timestamp-p (&optional inactive-ok)
17221 "Determine if the cursor is in or at a timestamp."
17222 (interactive)
17223 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17224 (pos (point))
17225 (ans (or (looking-at tsr)
17226 (save-excursion
17228 (if (> (point) (point-min)) (backward-char 1))
17229 (and (looking-at tsr)
17230 (> (- (match-end 0) pos) -1))))))
17231 (and ans
17232 (boundp 'org-ts-what)
17233 (setq org-ts-what
17234 (cond
17235 ((= pos (match-beginning 0)) 'bracket)
17236 ;; Point is considered to be "on the bracket" whether
17237 ;; it's really on it or right after it.
17238 ((= pos (1- (match-end 0))) 'bracket)
17239 ((= pos (match-end 0)) 'after)
17240 ((org-pos-in-match-range pos 2) 'year)
17241 ((org-pos-in-match-range pos 3) 'month)
17242 ((org-pos-in-match-range pos 7) 'hour)
17243 ((org-pos-in-match-range pos 8) 'minute)
17244 ((or (org-pos-in-match-range pos 4)
17245 (org-pos-in-match-range pos 5)) 'day)
17246 ((and (> pos (or (match-end 8) (match-end 5)))
17247 (< pos (match-end 0)))
17248 (- pos (or (match-end 8) (match-end 5))))
17249 (t 'day))))
17250 ans))
17252 (defun org-toggle-timestamp-type ()
17253 "Toggle the type (<active> or [inactive]) of a time stamp."
17254 (interactive)
17255 (when (org-at-timestamp-p t)
17256 (let ((beg (match-beginning 0)) (end (match-end 0))
17257 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17258 (save-excursion
17259 (goto-char beg)
17260 (while (re-search-forward "[][<>]" end t)
17261 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17262 t t)))
17263 (message "Timestamp is now %sactive"
17264 (if (equal (char-after beg) ?<) "" "in")))))
17266 (defun org-at-clock-log-p nil
17267 "Is the cursor on the clock log line?"
17268 (save-excursion
17269 (move-beginning-of-line 1)
17272 (defvar org-clock-history) ; defined in org-clock.el
17273 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17274 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17275 "Change the date in the time stamp at point.
17276 The date will be changed by N times WHAT. WHAT can be `day', `month',
17277 `year', `minute', `second'. If WHAT is not given, the cursor position
17278 in the timestamp determines what will be changed.
17280 (let ((origin (point)) origin-cat
17281 with-hm inactive
17282 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17283 org-ts-what
17284 extra rem
17285 ts time time0 fixnext clrgx)
17286 (if (not (org-at-timestamp-p t))
17287 (user-error "Not at a timestamp"))
17288 (if (and (not what) (eq org-ts-what 'bracket))
17289 (org-toggle-timestamp-type)
17290 ;; Point isn't on brackets. Remember the part of the time-stamp
17291 ;; the point was in. Indeed, size of time-stamps may change,
17292 ;; but point must be kept in the same category nonetheless.
17293 (setq origin-cat org-ts-what)
17294 (if (and (not what) (not (eq org-ts-what 'day))
17295 org-display-custom-times
17296 (get-text-property (point) 'display)
17297 (not (get-text-property (1- (point)) 'display)))
17298 (setq org-ts-what 'day))
17299 (setq org-ts-what (or what org-ts-what)
17300 inactive (= (char-after (match-beginning 0)) ?\[)
17301 ts (match-string 0))
17302 (replace-match "")
17303 (when (string-match
17304 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17305 ts)
17306 (setq extra (match-string 1 ts))
17307 (if suppress-tmp-delay
17308 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17310 (setq with-hm t))
17311 (setq time0 (org-parse-time-string ts))
17312 (when (and updown
17313 (eq org-ts-what 'minute)
17314 (not current-prefix-arg))
17315 ;; This looks like s-up and s-down. Change by one rounding step.
17316 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17317 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17318 (setcar (cdr time0) (+ (nth 1 time0)
17319 (if (> n 0) (- rem) (- dm rem))))))
17320 (setq time
17321 (encode-time (or (car time0) 0)
17322 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17323 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17324 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17325 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17326 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17327 (nthcdr 6 time0)))
17328 (when (and (member org-ts-what '(hour minute))
17329 extra
17331 (setq extra (org-modify-ts-extra
17332 extra
17333 (if (eq org-ts-what 'hour) 2 5)
17334 n dm)))
17335 (when (integerp org-ts-what)
17336 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17337 (if (eq what 'calendar)
17338 (let ((cal-date (org-get-date-from-calendar)))
17339 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17340 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17341 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17342 (setcar time0 (or (car time0) 0))
17343 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17344 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17345 (setq time (apply 'encode-time time0))))
17346 ;; Insert the new time-stamp, and ensure point stays in the same
17347 ;; category as before (i.e. not after the last position in that
17348 ;; category).
17349 (let ((pos (point)))
17350 ;; Stay before inserted string. `save-excursion' is of no use.
17351 (setq org-last-changed-timestamp
17352 (org-insert-time-stamp time with-hm inactive nil nil extra))
17353 (goto-char pos))
17354 (save-match-data
17355 (looking-at org-ts-regexp3)
17356 (goto-char (cond
17357 ;; `day' category ends before `hour' if any, or at
17358 ;; the end of the day name.
17359 ((eq origin-cat 'day)
17360 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17361 ((eq origin-cat 'hour) (min (match-end 7) origin))
17362 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17363 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17364 ;; `year' and `month' have both fixed size: point
17365 ;; couldn't have moved into another part.
17366 (t origin))))
17367 ;; Update clock if on a CLOCK line.
17368 (org-clock-update-time-maybe)
17369 ;; Maybe adjust the closest clock in `org-clock-history'
17370 (when org-clock-adjust-closest
17371 (if (not (and (org-at-clock-log-p)
17372 (< 1 (length (delq nil (mapcar 'marker-position
17373 org-clock-history))))))
17374 (message "No clock to adjust")
17375 (cond ((save-excursion ; fix previous clock?
17376 (re-search-backward org-ts-regexp0 nil t)
17379 ((save-excursion ; fix next clock?
17380 (re-search-backward org-ts-regexp0 nil t)
17383 (save-window-excursion
17384 ;; Find closest clock to point, adjust the previous/next one in history
17385 (let* ((p (save-excursion (org-back-to-heading t)))
17386 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17387 (clfixnth
17388 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17389 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17390 (if (not clfixpos)
17391 (message "No clock to adjust")
17392 (save-excursion
17393 (org-goto-marker-or-bmk clfixpos)
17394 (org-show-subtree)
17395 (when (re-search-forward clrgx nil t)
17396 (goto-char (match-beginning 1))
17397 (let (org-clock-adjust-closest)
17398 (org-timestamp-change n org-ts-what updown))
17399 (message "Clock adjusted in %s for heading: %s"
17400 (file-name-nondirectory (buffer-file-name))
17401 (org-get-heading t t)))))))))
17402 ;; Try to recenter the calendar window, if any.
17403 (if (and org-calendar-follow-timestamp-change
17404 (get-buffer-window "*Calendar*" t)
17405 (memq org-ts-what '(day month year)))
17406 (org-recenter-calendar (time-to-days time))))))
17408 (defun org-modify-ts-extra (s pos n dm)
17409 "Change the different parts of the lead-time and repeat fields in timestamp."
17410 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17411 ng h m new rem)
17412 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17413 (cond
17414 ((or (org-pos-in-match-range pos 2)
17415 (org-pos-in-match-range pos 3))
17416 (setq m (string-to-number (match-string 3 s))
17417 h (string-to-number (match-string 2 s)))
17418 (if (org-pos-in-match-range pos 2)
17419 (setq h (+ h n))
17420 (setq n (* dm (org-no-warnings (signum n))))
17421 (when (not (= 0 (setq rem (% m dm))))
17422 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17423 (setq m (+ m n)))
17424 (if (< m 0) (setq m (+ m 60) h (1- h)))
17425 (if (> m 59) (setq m (- m 60) h (1+ h)))
17426 (setq h (min 24 (max 0 h)))
17427 (setq ng 1 new (format "-%02d:%02d" h m)))
17428 ((org-pos-in-match-range pos 6)
17429 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17430 ((org-pos-in-match-range pos 5)
17431 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17433 ((org-pos-in-match-range pos 9)
17434 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17435 ((org-pos-in-match-range pos 8)
17436 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17438 (when ng
17439 (setq s (concat
17440 (substring s 0 (match-beginning ng))
17441 new
17442 (substring s (match-end ng))))))
17443 s))
17445 (defun org-recenter-calendar (date)
17446 "If the calendar is visible, recenter it to DATE."
17447 (let ((cwin (get-buffer-window "*Calendar*" t)))
17448 (when cwin
17449 (let ((calendar-move-hook nil))
17450 (with-selected-window cwin
17451 (calendar-goto-date (if (listp date) date
17452 (calendar-gregorian-from-absolute date))))))))
17454 (defun org-goto-calendar (&optional arg)
17455 "Go to the Emacs calendar at the current date.
17456 If there is a time stamp in the current line, go to that date.
17457 A prefix ARG can be used to force the current date."
17458 (interactive "P")
17459 (let ((tsr org-ts-regexp) diff
17460 (calendar-move-hook nil)
17461 (calendar-view-holidays-initially-flag nil)
17462 (calendar-view-diary-initially-flag nil))
17463 (if (or (org-at-timestamp-p)
17464 (save-excursion
17465 (beginning-of-line 1)
17466 (looking-at (concat ".*" tsr))))
17467 (let ((d1 (time-to-days (current-time)))
17468 (d2 (time-to-days
17469 (org-time-string-to-time (match-string 1)))))
17470 (setq diff (- d2 d1))))
17471 (calendar)
17472 (calendar-goto-today)
17473 (if (and diff (not arg)) (calendar-forward-day diff))))
17475 (defun org-get-date-from-calendar ()
17476 "Return a list (month day year) of date at point in calendar."
17477 (with-current-buffer "*Calendar*"
17478 (save-match-data
17479 (calendar-cursor-to-date))))
17481 (defun org-date-from-calendar ()
17482 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17483 If there is already a time stamp at the cursor position, update it."
17484 (interactive)
17485 (if (org-at-timestamp-p t)
17486 (org-timestamp-change 0 'calendar)
17487 (let ((cal-date (org-get-date-from-calendar)))
17488 (org-insert-time-stamp
17489 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17491 (defcustom org-effort-durations
17492 `(("h" . 60)
17493 ("d" . ,(* 60 8))
17494 ("w" . ,(* 60 8 5))
17495 ("m" . ,(* 60 8 5 4))
17496 ("y" . ,(* 60 8 5 40)))
17497 "Conversion factor to minutes for an effort modifier.
17499 Each entry has the form (MODIFIER . MINUTES).
17501 In an effort string, a number followed by MODIFIER is multiplied
17502 by the specified number of MINUTES to obtain an effort in
17503 minutes.
17507 :group 'org-agenda
17508 :version "24.1"
17509 :type '(alist :key-type (string :tag "Modifier")
17510 :value-type (number :tag "Minutes")))
17512 (defun org-minutes-to-clocksum-string (m)
17513 "Format number of minutes as a clocksum string.
17514 The format is determined by `org-time-clocksum-format',
17515 `org-time-clocksum-use-fractional' and
17516 `org-time-clocksum-fractional-format' and
17517 `org-time-clocksum-use-effort-durations'."
17518 (let ((clocksum "")
17519 (m (round m)) ; Don't allow fractions of minutes
17520 h d w mo y fmt n)
17521 (setq h (if org-time-clocksum-use-effort-durations
17522 (cdr (assoc "h" org-effort-durations)) 60)
17523 d (if org-time-clocksum-use-effort-durations
17524 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17525 w (if org-time-clocksum-use-effort-durations
17526 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17527 mo (if org-time-clocksum-use-effort-durations
17528 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17529 y (if org-time-clocksum-use-effort-durations
17530 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17531 ;; fractional format
17532 (if org-time-clocksum-use-fractional
17533 (cond
17534 ;; single format string
17535 ((stringp org-time-clocksum-fractional-format)
17536 (format org-time-clocksum-fractional-format (/ m (float h))))
17537 ;; choice of fractional formats for different time units
17538 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17539 (> (/ (truncate m) (* y d h)) 0))
17540 (format fmt (/ m (* y d (float h)))))
17541 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17542 (> (/ (truncate m) (* mo d h)) 0))
17543 (format fmt (/ m (* mo d (float h)))))
17544 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17545 (> (/ (truncate m) (* w d h)) 0))
17546 (format fmt (/ m (* w d (float h)))))
17547 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17548 (> (/ (truncate m) (* d h)) 0))
17549 (format fmt (/ m (* d (float h)))))
17550 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17551 (> (/ (truncate m) h) 0))
17552 (format fmt (/ m (float h))))
17553 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17554 (format fmt m))
17555 ;; fall back to smallest time unit with a format
17556 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17557 (format fmt (/ m (float h))))
17558 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17559 (format fmt (/ m (* d (float h)))))
17560 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17561 (format fmt (/ m (* w d (float h)))))
17562 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17563 (format fmt (/ m (* mo d (float h)))))
17564 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17565 (format fmt (/ m (* y d (float h))))))
17566 ;; standard (non-fractional) format, with single format string
17567 (if (stringp org-time-clocksum-format)
17568 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17569 ;; separate formats components
17570 (and (setq fmt (plist-get org-time-clocksum-format :years))
17571 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17572 (plist-get org-time-clocksum-format :require-years))
17573 (setq clocksum (concat clocksum (format fmt n))
17574 m (- m (* n y d h))))
17575 (and (setq fmt (plist-get org-time-clocksum-format :months))
17576 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17577 (plist-get org-time-clocksum-format :require-months))
17578 (setq clocksum (concat clocksum (format fmt n))
17579 m (- m (* n mo d h))))
17580 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17581 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17582 (plist-get org-time-clocksum-format :require-weeks))
17583 (setq clocksum (concat clocksum (format fmt n))
17584 m (- m (* n w d h))))
17585 (and (setq fmt (plist-get org-time-clocksum-format :days))
17586 (or (> (setq n (/ (truncate m) (* d h))) 0)
17587 (plist-get org-time-clocksum-format :require-days))
17588 (setq clocksum (concat clocksum (format fmt n))
17589 m (- m (* n d h))))
17590 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17591 (or (> (setq n (/ (truncate m) h)) 0)
17592 (plist-get org-time-clocksum-format :require-hours))
17593 (setq clocksum (concat clocksum (format fmt n))
17594 m (- m (* n h))))
17595 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17596 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17597 (setq clocksum (concat clocksum (format fmt m))))
17598 ;; return formatted time duration
17599 clocksum))))
17601 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17602 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17603 "Org mode version 8.0")
17605 (defun org-hours-to-clocksum-string (n)
17606 (org-minutes-to-clocksum-string (* n 60)))
17608 (defun org-hh:mm-string-to-minutes (s)
17609 "Convert a string H:MM to a number of minutes.
17610 If the string is just a number, interpret it as minutes.
17611 In fact, the first hh:mm or number in the string will be taken,
17612 there can be extra stuff in the string.
17613 If no number is found, the return value is 0."
17614 (cond
17615 ((integerp s) s)
17617 (+ (* (string-to-number (match-string 1 s)) 60)
17618 (string-to-number (match-string 2 s))))
17620 (string-to-number (match-string 1 s)))
17621 (t 0)))
17623 (defcustom org-image-actual-width t
17624 "Should we use the actual width of images when inlining them?
17626 When set to `t', always use the image width.
17628 When set to a number, use imagemagick (when available) to set
17629 the image's width to this value.
17631 When set to a number in a list, try to get the width from any
17632 #+ATTR.* keyword if it matches a width specification like
17634 #+ATTR_HTML: :width 300px
17636 and fall back on that number if none is found.
17638 When set to nil, try to get the width from an #+ATTR.* keyword
17639 and fall back on the original width if none is found.
17641 This requires Emacs >= 24.1, build with imagemagick support."
17642 :group 'org-appearance
17643 :version "24.4"
17644 :package-version '(Org . "8.0")
17645 :type '(choice
17646 (const :tag "Use the image width" t)
17647 (integer :tag "Use a number of pixels")
17648 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17649 (const :tag "Use #+ATTR* or don't resize" nil)))
17651 (defcustom org-agenda-inhibit-startup nil
17652 "Inhibit startup when preparing agenda buffers.
17653 When this variable is `t' (the default), the initialization of
17654 the Org agenda buffers is inhibited: e.g. the visibility state
17655 is not set, the tables are not re-aligned, etc."
17656 :type 'boolean
17657 :version "24.3"
17658 :group 'org-agenda)
17660 (defcustom org-agenda-ignore-drawer-properties nil
17661 "Avoid updating text properties when building the agenda.
17662 Properties are used to prepare buffers for effort estimates, appointments,
17663 and subtree-local categories.
17664 If you don't use these in the agenda, you can add them to this list and
17665 agenda building will be a bit faster.
17666 The value is a list, with zero or more of the symbols `effort', `appt',
17667 or `category'."
17668 :type '(set :greedy t
17669 (const effort)
17670 (const appt)
17671 (const category))
17672 :version "24.3"
17673 :group 'org-agenda)
17675 (defun org-duration-string-to-minutes (s &optional output-to-string)
17676 "Convert a duration string S to minutes.
17678 A bare number is interpreted as minutes, modifiers can be set by
17679 customizing `org-effort-durations' (which see).
17681 Entries containing a colon are interpreted as H:MM by
17682 `org-hh:mm-string-to-minutes'."
17683 (let ((result 0)
17685 (regexp-opt (mapcar 'car org-effort-durations))
17687 (while (string-match re s)
17688 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17689 (string-to-number (match-string 1 s))))
17690 (setq s (replace-match "" nil t s)))
17691 (setq result (floor result))
17692 (incf result (org-hh:mm-string-to-minutes s))
17693 (if output-to-string (number-to-string result) result)))
17695 ;;;; Files
17697 (defun org-save-all-org-buffers ()
17698 "Save all Org-mode buffers without user confirmation."
17699 (interactive)
17700 (message "Saving all Org-mode buffers...")
17701 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17702 (when (featurep 'org-id) (org-id-locations-save))
17703 (message "Saving all Org-mode buffers... done"))
17705 (defun org-revert-all-org-buffers ()
17706 "Revert all Org-mode buffers.
17707 Prompt for confirmation when there are unsaved changes.
17708 Be sure you know what you are doing before letting this function
17709 overwrite your changes.
17711 This function is useful in a setup where one tracks org files
17712 with a version control system, to revert on one machine after pulling
17713 changes from another. I believe the procedure must be like this:
17715 1. M-x org-save-all-org-buffers
17716 2. Pull changes from the other machine, resolve conflicts
17717 3. M-x org-revert-all-org-buffers"
17718 (interactive)
17719 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17720 (user-error "Abort"))
17721 (save-excursion
17722 (save-window-excursion
17723 (mapc
17724 (lambda (b)
17725 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17726 (with-current-buffer b buffer-file-name))
17727 (org-pop-to-buffer-same-window b)
17728 (revert-buffer t 'no-confirm)))
17729 (buffer-list))
17730 (when (and (featurep 'org-id) org-id-track-globally)
17731 (org-id-locations-load)))))
17733 ;;;; Agenda files
17735 ;;;###autoload
17736 (defun org-switchb (&optional arg)
17737 "Switch between Org buffers.
17738 With one prefix argument, restrict available buffers to files.
17739 With two prefix arguments, restrict available buffers to agenda files.
17741 Defaults to `iswitchb' for buffer name completion.
17742 Set `org-completion-use-ido' to make it use ido instead."
17743 (interactive "P")
17744 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17745 ((equal arg '(16)) (org-buffer-list 'agenda))
17746 (t (org-buffer-list))))
17747 (org-completion-use-iswitchb org-completion-use-iswitchb)
17748 (org-completion-use-ido org-completion-use-ido))
17749 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17750 (setq org-completion-use-iswitchb t))
17751 (org-pop-to-buffer-same-window
17752 (org-icompleting-read "Org buffer: "
17753 (mapcar 'list (mapcar 'buffer-name blist))
17754 nil t))))
17756 ;;; Define some older names previously used for this functionality
17757 ;;;###autoload
17758 (defalias 'org-ido-switchb 'org-switchb)
17759 ;;;###autoload
17760 (defalias 'org-iswitchb 'org-switchb)
17762 (defun org-buffer-list (&optional predicate exclude-tmp)
17763 "Return a list of Org buffers.
17764 PREDICATE can be `export', `files' or `agenda'.
17766 export restrict the list to Export buffers.
17767 files restrict the list to buffers visiting Org files.
17768 agenda restrict the list to buffers visiting agenda files.
17770 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17771 (let* ((bfn nil)
17772 (agenda-files (and (eq predicate 'agenda)
17773 (mapcar 'file-truename (org-agenda-files t))))
17774 (filter
17775 (cond
17776 ((eq predicate 'files)
17777 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17778 ((eq predicate 'export)
17779 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17780 ((eq predicate 'agenda)
17781 (lambda (b)
17782 (with-current-buffer b
17783 (and (derived-mode-p 'org-mode)
17784 (setq bfn (buffer-file-name b))
17785 (member (file-truename bfn) agenda-files)))))
17786 (t (lambda (b) (with-current-buffer b
17787 (or (derived-mode-p 'org-mode)
17788 (string-match "\*Org .*Export"
17789 (buffer-name b)))))))))
17790 (delq nil
17791 (mapcar
17792 (lambda(b)
17793 (if (and (funcall filter b)
17794 (or (not exclude-tmp)
17795 (not (string-match "tmp" (buffer-name b)))))
17796 b
17797 nil))
17798 (buffer-list)))))
17800 (defun org-agenda-files (&optional unrestricted archives)
17801 "Get the list of agenda files.
17802 Optional UNRESTRICTED means return the full list even if a restriction
17803 is currently in place.
17804 When ARCHIVES is t, include all archive files that are really being
17805 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17806 `org-agenda-archives-mode' is t."
17807 (let ((files
17808 (cond
17809 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17810 ((stringp org-agenda-files) (org-read-agenda-file-list))
17811 ((listp org-agenda-files) org-agenda-files)
17812 (t (error "Invalid value of `org-agenda-files'")))))
17813 (setq files (apply 'append
17814 (mapcar (lambda (f)
17815 (if (file-directory-p f)
17816 (directory-files
17817 f t org-agenda-file-regexp)
17818 (list f)))
17819 files)))
17820 (when org-agenda-skip-unavailable-files
17821 (setq files (delq nil
17822 (mapcar (function
17823 (lambda (file)
17824 (and (file-readable-p file) file)))
17825 files))))
17826 (when (or (eq archives t)
17827 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17828 (setq files (org-add-archive-files files)))
17829 files))
17831 (defun org-agenda-file-p (&optional file)
17832 "Return non-nil, if FILE is an agenda file.
17833 If FILE is omitted, use the file associated with the current
17834 buffer."
17835 (member (or file (buffer-file-name))
17836 (org-agenda-files t)))
17838 (defun org-edit-agenda-file-list ()
17839 "Edit the list of agenda files.
17840 Depending on setup, this either uses customize to edit the variable
17841 `org-agenda-files', or it visits the file that is holding the list. In the
17842 latter case, the buffer is set up in a way that saving it automatically kills
17843 the buffer and restores the previous window configuration."
17844 (interactive)
17845 (if (stringp org-agenda-files)
17846 (let ((cw (current-window-configuration)))
17847 (find-file org-agenda-files)
17848 (org-set-local 'org-window-configuration cw)
17849 (org-add-hook 'after-save-hook
17850 (lambda ()
17851 (set-window-configuration
17852 (prog1 org-window-configuration
17853 (kill-buffer (current-buffer))))
17854 (org-install-agenda-files-menu)
17855 (message "New agenda file list installed"))
17856 nil 'local)
17857 (message "%s" (substitute-command-keys
17859 (customize-variable 'org-agenda-files)))
17861 (defun org-store-new-agenda-file-list (list)
17862 "Set new value for the agenda file list and save it correctly."
17863 (if (stringp org-agenda-files)
17864 (let ((fe (org-read-agenda-file-list t)) b u)
17865 (while (setq b (find-buffer-visiting org-agenda-files))
17866 (kill-buffer b))
17867 (with-temp-file org-agenda-files
17868 (insert
17869 (mapconcat
17870 (lambda (f) ;; Keep un-expanded entries.
17871 (if (setq u (assoc f fe))
17872 (cdr u)
17873 f))
17876 (let ((org-mode-hook nil) (org-inhibit-startup t)
17877 (org-insert-mode-line-in-empty-file nil))
17878 (setq org-agenda-files list)
17879 (customize-save-variable 'org-agenda-files org-agenda-files))))
17881 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17882 "Read the list of agenda files from a file.
17883 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17884 filenames, used by `org-store-new-agenda-file-list' to write back
17885 un-expanded file names."
17886 (when (file-directory-p org-agenda-files)
17887 (error "`org-agenda-files' cannot be a single directory"))
17888 (when (stringp org-agenda-files)
17889 (with-temp-buffer
17890 (insert-file-contents org-agenda-files)
17891 (mapcar
17892 (lambda (f)
17893 (let ((e (expand-file-name (substitute-in-file-name f)
17894 org-directory)))
17895 (if pair-with-expansion
17896 (cons e f)
17897 e)))
17900 ;;;###autoload
17901 (defun org-cycle-agenda-files ()
17902 "Cycle through the files in `org-agenda-files'.
17903 If the current buffer visits an agenda file, find the next one in the list.
17904 If the current buffer does not, find the first agenda file."
17905 (interactive)
17906 (let* ((fs (org-agenda-files t))
17907 (files (append fs (list (car fs))))
17908 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17909 file)
17910 (unless files (user-error "No agenda files"))
17911 (catch 'exit
17912 (while (setq file (pop files))
17913 (if (equal (file-truename file) tcf)
17914 (when (car files)
17915 (find-file (car files))
17916 (throw 'exit t))))
17917 (find-file (car fs)))
17918 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17920 (defun org-agenda-file-to-front (&optional to-end)
17921 "Move/add the current file to the top of the agenda file list.
17922 If the file is not present in the list, it is added to the front. If it is
17923 present, it is moved there. With optional argument TO-END, add/move to the
17924 end of the list."
17925 (interactive "P")
17926 (let ((org-agenda-skip-unavailable-files nil)
17927 (file-alist (mapcar (lambda (x)
17928 (cons (file-truename x) x))
17929 (org-agenda-files t)))
17930 (ctf (file-truename
17931 (or buffer-file-name
17932 (user-error "Please save the current buffer to a file"))))
17933 x had)
17934 (setq x (assoc ctf file-alist) had x)
17936 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17937 (if to-end
17938 (setq file-alist (append (delq x file-alist) (list x)))
17939 (setq file-alist (cons x (delq x file-alist))))
17940 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17941 (org-install-agenda-files-menu)
17942 (message "File %s to %s of agenda file list"
17943 (if had "moved" "added") (if to-end "end" "front"))))
17945 (defun org-remove-file (&optional file)
17946 "Remove current file from the list of files in variable `org-agenda-files'.
17947 These are the files which are being checked for agenda entries.
17948 Optional argument FILE means use this file instead of the current."
17949 (interactive)
17950 (let* ((org-agenda-skip-unavailable-files nil)
17951 (file (or file buffer-file-name
17952 (user-error "Current buffer does not visit a file")))
17953 (true-file (file-truename file))
17954 (afile (abbreviate-file-name file))
17955 (files (delq nil (mapcar
17956 (lambda (x)
17957 (if (equal true-file
17958 (file-truename x))
17959 nil x))
17960 (org-agenda-files t)))))
17961 (if (not (= (length files) (length (org-agenda-files t))))
17962 (progn
17963 (org-store-new-agenda-file-list files)
17964 (org-install-agenda-files-menu)
17965 (message "Removed file: %s" afile))
17966 (message "File was not in list: %s (not removed)" afile))))
17968 (defun org-file-menu-entry (file)
17969 (vector file (list 'find-file file) t))
17971 (defun org-check-agenda-file (file)
17972 "Make sure FILE exists. If not, ask user what to do."
17973 (when (not (file-exists-p file))
17974 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17975 (abbreviate-file-name file))
17976 (let ((r (downcase (read-char-exclusive))))
17977 (cond
17978 ((equal r ?r)
17979 (org-remove-file file)
17980 (throw 'nextfile t))
17981 (t (error "Abort"))))))
17983 (defun org-get-agenda-file-buffer (file)
17984 "Get a buffer visiting FILE. If the buffer needs to be created, add
17985 it to the list of buffers which might be released later."
17986 (let ((buf (org-find-base-buffer-visiting file)))
17987 (if buf
17988 buf ; just return it
17989 ;; Make a new buffer and remember it
17990 (setq buf (find-file-noselect file))
17991 (if buf (push buf org-agenda-new-buffers))
17992 buf)))
17994 (defun org-release-buffers (blist)
17995 "Release all buffers in list, asking the user for confirmation when needed.
17996 When a buffer is unmodified, it is just killed. When modified, it is saved
17997 \(if the user agrees) and then killed."
17998 (let (buf file)
17999 (while (setq buf (pop blist))
18000 (setq file (buffer-file-name buf))
18001 (when (and (buffer-modified-p buf)
18002 file
18003 (y-or-n-p (format "Save file %s? " file)))
18004 (with-current-buffer buf (save-buffer)))
18005 (kill-buffer buf))))
18007 (defun org-agenda-prepare-buffers (files)
18008 "Create buffers for all agenda files, protect archived trees and comments."
18009 (interactive)
18010 (let ((pa '(:org-archived t))
18011 (pc '(:org-comment t))
18012 (pall '(:org-archived t :org-comment t))
18013 (inhibit-read-only t)
18014 (org-inhibit-startup org-agenda-inhibit-startup)
18015 (rea (concat ":" org-archive-tag ":"))
18016 file re)
18017 (setq org-tag-alist-for-agenda nil
18018 org-tag-groups-alist-for-agenda nil)
18019 (save-excursion
18020 (save-restriction
18021 (while (setq file (pop files))
18022 (catch 'nextfile
18023 (if (bufferp file)
18024 (set-buffer file)
18025 (org-check-agenda-file file)
18026 (set-buffer (org-get-agenda-file-buffer file)))
18027 (widen)
18028 (org-set-regexps-and-options-for-tags)
18029 (goto-char (point-min))
18030 (let ((case-fold-search t))
18031 (when (search-forward "#+setupfile" nil t)
18032 ;; Don't set all regexps and options systematically as
18033 ;; this is only run for setting agenda tags from setup
18034 ;; file
18035 (org-set-regexps-and-options)))
18036 (or (memq 'category org-agenda-ignore-drawer-properties)
18037 (org-refresh-category-properties))
18038 (or (memq 'effort org-agenda-ignore-drawer-properties)
18039 (org-refresh-properties org-effort-property 'org-effort))
18040 (or (memq 'appt org-agenda-ignore-drawer-properties)
18041 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18042 (setq org-todo-keywords-for-agenda
18043 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18044 (setq org-done-keywords-for-agenda
18045 (append org-done-keywords-for-agenda org-done-keywords))
18046 (setq org-todo-keyword-alist-for-agenda
18047 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18048 (setq org-tag-alist-for-agenda
18049 (org-uniquify
18050 (append org-tag-alist-for-agenda
18051 org-tag-alist
18052 org-tag-persistent-alist)))
18053 (if org-group-tags
18054 (setq org-tag-groups-alist-for-agenda
18055 (org-uniquify-alist
18056 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18057 (org-with-silent-modifications
18058 (save-excursion
18059 (remove-text-properties (point-min) (point-max) pall)
18060 (when org-agenda-skip-archived-trees
18061 (goto-char (point-min))
18062 (while (re-search-forward rea nil t)
18063 (if (org-at-heading-p t)
18064 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18065 (goto-char (point-min))
18066 (setq re (format org-heading-keyword-regexp-format
18067 org-comment-string))
18068 (while (re-search-forward re nil t)
18069 (add-text-properties
18070 (match-beginning 0) (org-end-of-subtree t) pc))))))))
18071 (setq org-todo-keywords-for-agenda
18072 (org-uniquify org-todo-keywords-for-agenda))
18073 (setq org-todo-keyword-alist-for-agenda
18074 (org-uniquify org-todo-keyword-alist-for-agenda))))
18076 \f
18077 ;;;; CDLaTeX minor mode
18079 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18080 "Keymap for the minor `org-cdlatex-mode'.")
18082 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18083 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18084 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18085 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18086 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18088 (defvar org-cdlatex-texmathp-advice-is-done nil
18089 "Flag remembering if we have applied the advice to texmathp already.")
18091 (define-minor-mode org-cdlatex-mode
18092 "Toggle the minor `org-cdlatex-mode'.
18093 This mode supports entering LaTeX environment and math in LaTeX fragments
18094 in Org-mode.
18096 nil " OCDL" nil
18097 (when org-cdlatex-mode
18098 (require 'cdlatex)
18099 (run-hooks 'cdlatex-mode-hook)
18100 (cdlatex-compute-tables))
18101 (unless org-cdlatex-texmathp-advice-is-done
18102 (setq org-cdlatex-texmathp-advice-is-done t)
18103 (defadvice texmathp (around org-math-always-on activate)
18104 "Always return t in org-mode buffers.
18105 This is because we want to insert math symbols without dollars even outside
18106 the LaTeX math segments. If Orgmode thinks that point is actually inside
18107 an embedded LaTeX fragment, let texmathp do its job.
18109 (interactive)
18110 (let (p)
18111 (cond
18112 ((not (derived-mode-p 'org-mode)) ad-do-it)
18113 ((eq this-command 'cdlatex-math-symbol)
18114 (setq ad-return-value t
18115 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18116 (t
18117 (let ((p (org-inside-LaTeX-fragment-p)))
18118 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18119 (setq ad-return-value t
18120 texmathp-why '("Org-mode embedded math" . 0))
18121 (if p ad-do-it)))))))))
18123 (defun turn-on-org-cdlatex ()
18124 "Unconditionally turn on `org-cdlatex-mode'."
18125 (org-cdlatex-mode 1))
18127 (defun org-try-cdlatex-tab ()
18128 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18129 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18130 - inside a LaTeX fragment, or
18131 - after the first word in a line, where an abbreviation expansion could
18132 insert a LaTeX environment."
18133 (when org-cdlatex-mode
18134 (cond
18135 ;; Before any word on the line: No expansion possible.
18137 ;; Just after first word on the line: Expand it. Make sure it
18138 ;; cannot happen on headlines, though.
18139 ((save-excursion
18140 (skip-chars-backward "a-zA-Z0-9*")
18142 (and (bolp) (not (org-at-heading-p))))
18143 (cdlatex-tab) t)
18144 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18146 (defun org-cdlatex-underscore-caret (&optional arg)
18147 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18148 Revert to the normal definition outside of these fragments."
18149 (interactive "P")
18150 (if (org-inside-LaTeX-fragment-p)
18151 (call-interactively 'cdlatex-sub-superscript)
18152 (let (org-cdlatex-mode)
18153 (call-interactively (key-binding (vector last-input-event))))))
18155 (defun org-cdlatex-math-modify (&optional arg)
18156 "Execute `cdlatex-math-modify' in LaTeX fragments.
18157 Revert to the normal definition outside of these fragments."
18158 (interactive "P")
18159 (if (org-inside-LaTeX-fragment-p)
18160 (call-interactively 'cdlatex-math-modify)
18161 (let (org-cdlatex-mode)
18162 (call-interactively (key-binding (vector last-input-event))))))
18165 \f
18166 ;;;; LaTeX fragments
18168 (defvar org-latex-regexps
18170 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18173 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18177 "Regular expressions for matching embedded LaTeX.")
18179 (defun org-inside-LaTeX-fragment-p ()
18180 "Test if point is inside a LaTeX fragment.
18182 sequence appearing also before point.
18183 Even though the matchers for math are configurable, this function assumes
18185 delimiters are skipped when they have been removed by customization.
18186 The return value is nil, or a cons cell with the delimiter and the
18187 position of this delimiter.
18189 This function does a reasonably good job, but can locally be fooled by
18190 for example currency specifications. For example it will assume being in
18192 fragments that are properly closed, but during editing, we have to live
18193 with the uncertainty caused by missing closing delimiters. This function
18194 looks only before point, not after."
18195 (catch 'exit
18196 (let ((pos (point))
18197 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18198 (lim (progn
18200 (point)))
18201 dd-on str (start 0) m re)
18202 (goto-char pos)
18203 (when dodollar
18205 re (nth 1 (assoc "$" org-latex-regexps)))
18206 (while (string-match re str start)
18207 (cond
18208 ((= (match-end 0) (length str))
18209 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18210 ((= (match-end 0) (- (length str) 5))
18211 (throw 'exit nil))
18212 (t (setq start (match-end 0))))))
18213 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18214 (goto-char pos)
18215 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18216 (and (match-beginning 2) (throw 'exit nil))
18217 ;; count $$
18219 (setq dd-on (not dd-on)))
18220 (goto-char pos)
18221 (if dd-on (cons "$$" m))))))
18223 (defun org-inside-latex-macro-p ()
18224 "Is point inside a LaTeX macro or its arguments?"
18225 (save-match-data
18226 (org-in-regexp
18229 (defvar org-latex-fragment-image-overlays nil
18230 "List of overlays carrying the images of latex fragments.")
18231 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18233 (defun org-remove-latex-fragment-image-overlays ()
18234 "Remove all overlays with LaTeX fragment images in current buffer."
18235 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18236 (setq org-latex-fragment-image-overlays nil))
18238 (defun org-preview-latex-fragment (&optional subtree)
18239 "Preview the LaTeX fragment at point, or all locally or globally.
18240 If the cursor is in a LaTeX fragment, create the image and overlay
18241 it over the source code. If there is no fragment at point, display
18242 all fragments in the current text, from one headline to the next. With
18243 prefix SUBTREE, display all fragments in the current subtree. With a
18245 the cursor is before the first headline,
18246 display all fragments in the buffer.
18248 (interactive "P")
18249 (unless buffer-file-name
18250 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18251 (when (display-graphic-p)
18252 (org-remove-latex-fragment-image-overlays)
18253 (save-excursion
18254 (save-restriction
18255 (let (beg end at msg)
18256 (cond
18257 ((or (equal subtree '(16))
18258 (not (save-excursion
18259 (re-search-backward org-outline-regexp-bol nil t))))
18260 (setq beg (point-min) end (point-max)
18261 msg "Creating images for buffer...%s"))
18262 ((equal subtree '(4))
18263 (org-back-to-heading)
18264 (setq beg (point) end (org-end-of-subtree t)
18265 msg "Creating images for subtree...%s"))
18266 (t
18267 (if (setq at (org-inside-LaTeX-fragment-p))
18268 (goto-char (max (point-min) (- (cdr at) 2)))
18269 (org-back-to-heading))
18270 (setq beg (point) end (progn (outline-next-heading) (point))
18271 msg (if at "Creating image...%s"
18272 "Creating images for entry...%s"))))
18273 (message msg "")
18274 (narrow-to-region beg end)
18275 (goto-char beg)
18276 (org-format-latex
18277 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18278 (file-name-nondirectory
18279 buffer-file-name)))
18280 default-directory 'overlays msg at 'forbuffer
18281 org-latex-create-formula-image-program)
18282 (message msg "done. Use `C-c C-c' to remove images."))))))
18284 (defun org-format-latex (prefix &optional dir overlays msg at
18285 forbuffer processing-type)
18286 "Replace LaTeX fragments with links to an image, and produce images.
18287 Some of the options can be changed using the variable
18288 `org-format-latex-options'."
18289 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18290 (let* ((prefixnodir (file-name-nondirectory prefix))
18291 (absprefix (expand-file-name prefix dir))
18292 (todir (file-name-directory absprefix))
18293 (opt org-format-latex-options)
18294 (optnew org-format-latex-options)
18295 (matchers (plist-get opt :matchers))
18296 (re-list org-latex-regexps)
18297 (cnt 0) txt hash link beg end re e checkdir
18298 string
18299 m n block-type block linkfile movefile ov)
18300 ;; Check the different regular expressions
18301 (while (setq e (pop re-list))
18302 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18304 (when (member m matchers)
18305 (goto-char (point-min))
18306 (while (re-search-forward re nil t)
18307 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18308 (or (not overlays)
18309 (not (eq (get-char-property (match-beginning n)
18310 'org-overlay-type)
18311 'org-latex-overlay))))
18312 (cond
18313 ((eq processing-type 'verbatim))
18314 ((eq processing-type 'mathjax)
18315 ;; Prepare for MathJax processing.
18316 (setq string (match-string n))
18317 (when (member m '("$" "$1"))
18318 (save-excursion
18319 (delete-region (match-beginning n) (match-end n))
18320 (goto-char (match-beginning n))
18322 ((or (eq processing-type 'dvipng)
18323 (eq processing-type 'imagemagick))
18324 ;; Process to an image.
18325 (setq txt (match-string n)
18326 beg (match-beginning n) end (match-end n)
18327 cnt (1+ cnt))
18328 (let ((face (face-at-point))
18329 (fg (plist-get opt :foreground))
18330 (bg (plist-get opt :background))
18331 ;; Ensure full list is printed.
18332 print-length print-level)
18333 (when forbuffer
18334 ;; Get the colors from the face at point.
18335 (goto-char beg)
18336 (when (eq fg 'auto)
18337 (setq fg (face-attribute face :foreground nil 'default)))
18338 (when (eq bg 'auto)
18339 (setq bg (face-attribute face :background nil 'default)))
18340 (setq optnew (copy-sequence opt))
18341 (plist-put optnew :foreground fg)
18342 (plist-put optnew :background bg))
18343 (setq hash (sha1 (prin1-to-string
18344 (list org-format-latex-header
18345 org-latex-default-packages-alist
18346 org-latex-packages-alist
18347 org-format-latex-options
18348 forbuffer txt fg bg)))
18349 linkfile (format "%s_%s.png" prefix hash)
18350 movefile (format "%s_%s.png" absprefix hash)))
18351 (setq link (concat block "[[file:" linkfile "]]" block))
18352 (if msg (message msg cnt))
18353 (goto-char beg)
18354 (unless checkdir ; Ensure the directory exists.
18355 (setq checkdir t)
18356 (or (file-directory-p todir) (make-directory todir t)))
18357 (unless (file-exists-p movefile)
18358 (org-create-formula-image
18359 txt movefile optnew forbuffer processing-type))
18360 (if overlays
18361 (progn
18362 (mapc (lambda (o)
18363 (if (eq (overlay-get o 'org-overlay-type)
18364 'org-latex-overlay)
18365 (delete-overlay o)))
18366 (overlays-in beg end))
18367 (setq ov (make-overlay beg end))
18368 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18369 (if (featurep 'xemacs)
18370 (progn
18371 (overlay-put ov 'invisible t)
18372 (overlay-put
18373 ov 'end-glyph
18374 (make-glyph (vector 'png :file movefile))))
18375 (overlay-put
18376 ov 'display
18377 (list 'image :type 'png :file movefile :ascent 'center)))
18378 (push ov org-latex-fragment-image-overlays)
18379 (goto-char end))
18380 (delete-region beg end)
18381 (insert (org-add-props link
18382 (list 'org-latex-src
18383 (replace-regexp-in-string
18385 'org-latex-src-embed-type
18386 (if block-type 'paragraph 'character))))))
18387 ((eq processing-type 'mathml)
18388 ;; Process to MathML
18389 (unless (save-match-data (org-format-latex-mathml-available-p))
18390 (user-error "LaTeX to MathML converter not configured"))
18391 (setq txt (match-string n)
18392 beg (match-beginning n) end (match-end n)
18393 cnt (1+ cnt))
18394 (if msg (message msg cnt))
18395 (goto-char beg)
18396 (delete-region beg end)
18397 (insert (org-format-latex-as-mathml
18398 txt block-type prefix dir)))
18399 (t
18400 (error "Unknown conversion type %s for LaTeX fragments"
18401 processing-type)))))))))
18403 (defun org-create-math-formula (latex-frag &optional mathml-file)
18404 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18405 Use `org-latex-to-mathml-convert-command'. If the conversion is
18407 elements otherwise return nil. When MATHML-FILE is specified,
18408 write the results in to that file. When invoked as an
18409 interactive command, prompt for LATEX-FRAG, with initial value
18410 set to the current active region and echo the results for user
18411 inspection."
18412 (interactive (list (let ((frag (when (org-region-active-p)
18413 (buffer-substring-no-properties
18414 (region-beginning) (region-end)))))
18415 (read-string "LaTeX Fragment: " frag nil frag))))
18416 (unless latex-frag (error "Invalid LaTeX fragment"))
18417 (let* ((tmp-in-file (file-relative-name
18418 (make-temp-name (expand-file-name "ltxmathml-in"))))
18419 (ignore (write-region latex-frag nil tmp-in-file))
18420 (tmp-out-file (file-relative-name
18421 (make-temp-name (expand-file-name "ltxmathml-out"))))
18422 (cmd (format-spec
18423 org-latex-to-mathml-convert-command
18424 `((?j . ,(shell-quote-argument
18425 (expand-file-name org-latex-to-mathml-jar-file)))
18426 (?I . ,(shell-quote-argument tmp-in-file))
18427 (?o . ,(shell-quote-argument tmp-out-file)))))
18428 mathml shell-command-output)
18429 (when (org-called-interactively-p 'any)
18430 (unless (org-format-latex-mathml-available-p)
18431 (user-error "LaTeX to MathML converter not configured")))
18432 (message "Running %s" cmd)
18433 (setq shell-command-output (shell-command-to-string cmd))
18434 (setq mathml
18435 (when (file-readable-p tmp-out-file)
18436 (with-current-buffer (find-file-noselect tmp-out-file t)
18437 (goto-char (point-min))
18438 (when (re-search-forward
18439 (concat
18440 (regexp-quote
18443 (regexp-quote "</math>")) nil t)
18444 (prog1 (match-string 0) (kill-buffer))))))
18445 (cond
18446 (mathml
18447 (setq mathml
18449 (when mathml-file
18450 (write-region mathml nil mathml-file))
18451 (when (org-called-interactively-p 'any)
18452 (message mathml)))
18453 ((message "LaTeX to MathML conversion failed")
18454 (message shell-command-output)))
18455 (delete-file tmp-in-file)
18456 (when (file-exists-p tmp-out-file)
18457 (delete-file tmp-out-file))
18458 mathml))
18460 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18461 prefix &optional dir)
18462 "Use `org-create-math-formula' but check local cache first."
18463 (let* ((absprefix (expand-file-name prefix dir))
18464 (print-length nil) (print-level nil)
18465 (formula-id (concat
18466 "formula-"
18467 (sha1
18468 (prin1-to-string
18469 (list latex-frag
18470 org-latex-to-mathml-convert-command)))))
18471 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18472 (formula-cache-dir (file-name-directory formula-cache)))
18474 (unless (file-directory-p formula-cache-dir)
18475 (make-directory formula-cache-dir t))
18477 (unless (file-exists-p formula-cache)
18478 (org-create-math-formula latex-frag formula-cache))
18480 (if (file-exists-p formula-cache)
18481 ;; Successful conversion. Return the link to MathML file.
18482 (org-add-props
18483 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18485 'org-latex-src-embed-type (if latex-frag-type
18486 'paragraph 'character)))
18487 ;; Failed conversion. Return the LaTeX fragment verbatim
18488 latex-frag)))
18490 (defun org-create-formula-image (string tofile options buffer &optional type)
18491 "Create an image from LaTeX source using dvipng or convert.
18492 This function calls either `org-create-formula-image-with-dvipng'
18493 or `org-create-formula-image-with-imagemagick' depending on the
18494 value of `org-latex-create-formula-image-program' or on the value
18495 of the optional TYPE variable.
18497 Note: ultimately these two function should be combined as they
18498 share a good deal of logic."
18499 (org-check-external-command
18500 "latex" "needed to convert LaTeX fragments to images")
18501 (funcall
18502 (case (or type org-latex-create-formula-image-program)
18503 ('dvipng
18504 (org-check-external-command
18505 "dvipng" "needed to convert LaTeX fragments to images")
18506 #'org-create-formula-image-with-dvipng)
18507 ('imagemagick
18508 (org-check-external-command
18509 "convert" "you need to install imagemagick")
18510 #'org-create-formula-image-with-imagemagick)
18511 (t (error
18512 "Invalid value of `org-latex-create-formula-image-program'")))
18513 string tofile options buffer))
18515 (declare-function org-export-get-backend "ox" (name))
18516 (declare-function org-export--get-global-options "ox" (&optional backend))
18517 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18518 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18519 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18520 (defun org-create-formula--latex-header ()
18521 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18522 (let ((info (org-combine-plists (org-export--get-global-options
18523 (org-export-get-backend 'latex))
18524 (org-export--get-inbuffer-options
18525 (org-export-get-backend 'latex)))))
18526 (org-latex-guess-babel-language
18527 (org-latex-guess-inputenc
18528 (org-splice-latex-header
18529 org-format-latex-header
18530 org-latex-default-packages-alist
18531 org-latex-packages-alist t
18532 (plist-get info :latex-header)))
18533 info)))
18535 ;; This function borrows from Ganesh Swami's latex2png.el
18536 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18537 "This calls dvipng."
18538 (require 'ox-latex)
18539 (let* ((tmpdir (if (featurep 'xemacs)
18540 (temp-directory)
18541 temporary-file-directory))
18542 (texfilebase (make-temp-name
18543 (expand-file-name "orgtex" tmpdir)))
18544 (texfile (concat texfilebase ".tex"))
18545 (dvifile (concat texfilebase ".dvi"))
18546 (pngfile (concat texfilebase ".png"))
18547 (fnh (if (featurep 'xemacs)
18548 (font-height (face-font 'default))
18549 (face-attribute 'default :height nil)))
18550 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18551 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18552 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18553 "Black"))
18554 (bg (or (plist-get options (if buffer :background :html-background))
18555 "Transparent")))
18556 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18557 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18558 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18559 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18560 (let ((latex-header (org-create-formula--latex-header)))
18561 (with-temp-file texfile
18562 (insert latex-header)
18564 (let ((dir default-directory))
18565 (condition-case nil
18566 (progn
18567 (cd tmpdir)
18568 (call-process "latex" nil nil nil texfile))
18569 (error nil))
18570 (cd dir))
18571 (if (not (file-exists-p dvifile))
18572 (progn (message "Failed to create dvi file from %s" texfile) nil)
18573 (condition-case nil
18574 (if (featurep 'xemacs)
18575 (call-process "dvipng" nil nil nil
18576 "-fg" fg "-bg" bg
18577 "-T" "tight"
18578 "-o" pngfile
18579 dvifile)
18580 (call-process "dvipng" nil nil nil
18581 "-fg" fg "-bg" bg
18582 "-D" dpi
18583 ;;"-x" scale "-y" scale
18584 "-T" "tight"
18585 "-o" pngfile
18586 dvifile))
18587 (error nil))
18588 (if (not (file-exists-p pngfile))
18589 (if org-format-latex-signal-error
18590 (error "Failed to create png file from %s" texfile)
18591 (message "Failed to create png file from %s" texfile)
18592 nil)
18593 ;; Use the requested file name and clean up
18594 (copy-file pngfile tofile 'replace)
18595 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18596 (if (file-exists-p (concat texfilebase e))
18597 (delete-file (concat texfilebase e))))
18598 pngfile))))
18600 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18601 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18602 "This calls convert, which is included into imagemagick."
18603 (require 'ox-latex)
18604 (let* ((tmpdir (if (featurep 'xemacs)
18605 (temp-directory)
18606 temporary-file-directory))
18607 (texfilebase (make-temp-name
18608 (expand-file-name "orgtex" tmpdir)))
18609 (texfile (concat texfilebase ".tex"))
18610 (pdffile (concat texfilebase ".pdf"))
18611 (pngfile (concat texfilebase ".png"))
18612 (fnh (if (featurep 'xemacs)
18613 (font-height (face-font 'default))
18614 (face-attribute 'default :height nil)))
18615 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18616 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18617 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18618 "black"))
18619 (bg (or (plist-get options (if buffer :background :html-background))
18620 "white")))
18621 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18622 (setq fg (org-latex-color-format fg)))
18623 (if (eq bg 'default) (setq bg (org-latex-color :background))
18624 (setq bg (org-latex-color-format
18625 (if (string= bg "Transparent") "white" bg))))
18626 (let ((latex-header (org-create-formula--latex-header)))
18627 (with-temp-file texfile
18628 (insert latex-header)
18634 string
18637 (org-latex-compile texfile t)
18638 (if (not (file-exists-p pdffile))
18639 (progn (message "Failed to create pdf file from %s" texfile) nil)
18640 (condition-case nil
18641 (if (featurep 'xemacs)
18642 (call-process "convert" nil nil nil
18643 "-density" "96"
18644 "-trim"
18645 "-antialias"
18646 pdffile
18647 "-quality" "100"
18648 ;; "-sharpen" "0x1.0"
18649 pngfile)
18650 (call-process "convert" nil nil nil
18651 "-density" dpi
18652 "-trim"
18653 "-antialias"
18654 pdffile
18655 "-quality" "100"
18656 ;; "-sharpen" "0x1.0"
18657 pngfile))
18658 (error nil))
18659 (if (not (file-exists-p pngfile))
18660 (if org-format-latex-signal-error
18661 (error "Failed to create png file from %s" texfile)
18662 (message "Failed to create png file from %s" texfile)
18663 nil)
18664 ;; Use the requested file name and clean up
18665 (copy-file pngfile tofile 'replace)
18666 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18667 (if (file-exists-p (concat texfilebase e))
18668 (delete-file (concat texfilebase e))))
18669 pngfile))))
18671 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18672 "Fill a LaTeX header template TPL.
18673 In the template, the following place holders will be recognized:
18676 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18678 [NO-PACKAGES] do not include PKG
18679 [EXTRA] the string EXTRA
18680 [NO-EXTRA] do not include EXTRA
18682 For backward compatibility, if both the positive and the negative place
18684 assumed to be present at the end of the template.
18685 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18686 EXTRA is a string.
18687 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18688 (let (rpl (end ""))
18690 (setq rpl (if (or (match-end 1) (not def-pkg))
18691 "" (org-latex-packages-to-string def-pkg snippets-p t))
18692 tpl (replace-match rpl t t tpl))
18693 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18696 (setq rpl (if (or (match-end 1) (not pkg))
18697 "" (org-latex-packages-to-string pkg snippets-p t))
18698 tpl (replace-match rpl t t tpl))
18699 (if pkg (setq end
18701 (org-latex-packages-to-string pkg snippets-p)))))
18704 (setq rpl (if (or (match-end 1) (not extra))
18706 tpl (replace-match rpl t t tpl))
18712 tpl)))
18714 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18716 (setq pkg (mapconcat (lambda(p)
18717 (cond
18718 ((stringp p) p)
18719 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18720 (format "%% Package %s omitted" (cadr p)))
18721 ((equal "" (car p))
18723 (t
18725 (car p) (cadr p)))))
18726 pkg
18730 (defun org-dvipng-color (attr)
18731 "Return a RGB color specification for dvipng."
18732 (apply 'format "rgb %s %s %s"
18733 (mapcar 'org-normalize-color
18734 (if (featurep 'xemacs)
18735 (color-rgb-components
18736 (face-property 'default
18737 (cond ((eq attr :foreground) 'foreground)
18738 ((eq attr :background) 'background))))
18739 (color-values (face-attribute 'default attr nil))))))
18741 (defun org-dvipng-color-format (color-name)
18742 "Convert COLOR-NAME to a RGB color value for dvipng."
18743 (apply 'format "rgb %s %s %s"
18744 (mapcar 'org-normalize-color
18745 (color-values color-name))))
18747 (defun org-latex-color (attr)
18748 "Return a RGB color for the LaTeX color package."
18749 (apply 'format "%s,%s,%s"
18750 (mapcar 'org-normalize-color
18751 (if (featurep 'xemacs)
18752 (color-rgb-components
18753 (face-property 'default
18754 (cond ((eq attr :foreground) 'foreground)
18755 ((eq attr :background) 'background))))
18756 (color-values (face-attribute 'default attr nil))))))
18758 (defun org-latex-color-format (color-name)
18759 "Convert COLOR-NAME to a RGB color value."
18760 (apply 'format "%s,%s,%s"
18761 (mapcar 'org-normalize-color
18762 (color-values color-name))))
18764 (defun org-normalize-color (value)
18765 "Return string to be used as color value for an RGB component."
18766 (format "%g" (/ value 65535.0)))
18769 \f
18770 ;; Image display
18772 (defvar org-inline-image-overlays nil)
18773 (make-variable-buffer-local 'org-inline-image-overlays)
18775 (defun org-toggle-inline-images (&optional include-linked)
18776 "Toggle the display of inline images.
18777 INCLUDE-LINKED is passed to `org-display-inline-images'."
18778 (interactive "P")
18779 (if org-inline-image-overlays
18780 (progn
18781 (org-remove-inline-images)
18782 (message "Inline image display turned off"))
18783 (org-display-inline-images include-linked)
18784 (if (and (org-called-interactively-p)
18785 org-inline-image-overlays)
18786 (message "%d images displayed inline"
18787 (length org-inline-image-overlays))
18788 (message "No images to display inline"))))
18790 (defun org-redisplay-inline-images ()
18791 "Refresh the display of inline images."
18792 (interactive)
18793 (if (not org-inline-image-overlays)
18794 (org-toggle-inline-images)
18795 (org-toggle-inline-images)
18796 (org-toggle-inline-images)))
18798 (defun org-display-inline-images (&optional include-linked refresh beg end)
18799 "Display inline images.
18801 An inline image is a link which follows either of these
18802 conventions:
18804 1. Its path is a file with an extension matching return value
18805 from `image-file-name-regexp' and it has no contents.
18807 2. Its description consists in a single link of the previous
18808 type.
18810 When optional argument INCLUDE-LINKED is non-nil, also links with
18811 a text description part will be inlined. This can be nice for
18812 a quick look at those images, but it does not reflect what
18813 exported files will look like.
18815 When optional argument REFRESH is non-nil, refresh existing
18816 images between BEG and END. This will create new image displays
18817 only if necessary. BEG and END default to the buffer
18818 boundaries."
18819 (interactive "P")
18820 (when (display-graphic-p)
18821 (unless refresh
18822 (org-remove-inline-images)
18823 (when (fboundp 'clear-image-cache) (clear-image-cache)))
18824 (org-with-wide-buffer
18825 (goto-char (or beg (point-min)))
18826 (let ((case-fold-search t)
18827 (file-extension-re (org-image-file-name-regexp)))
18829 (let ((link (save-match-data (org-element-context))))
18830 ;; Check if we're at an inline image.
18831 (when (and (equal (org-element-property :type link) "file")
18832 (or include-linked
18833 (not (org-element-property :contents-begin link)))
18834 (let ((parent (org-element-property :parent link)))
18835 (or (not (eq (org-element-type parent) 'link))
18836 (not (cdr (org-element-contents parent)))))
18837 (org-string-match-p file-extension-re
18838 (org-element-property :path link)))
18839 (let ((file (expand-file-name (org-element-property :path link))))
18840 (when (file-exists-p file)
18841 (let ((width
18842 ;; Apply `org-image-actual-width' specifications.
18843 (cond
18844 ((not (image-type-available-p 'imagemagick)) nil)
18845 ((eq org-image-actual-width t) nil)
18846 ((listp org-image-actual-width)
18847 (or
18848 ;; First try to find a width among
18849 ;; attributes associated to the paragraph
18850 ;; containing link.
18851 (let ((paragraph
18852 (let ((e link))
18853 (while (and (setq e (org-element-property
18854 :parent e))
18855 (not (eq (org-element-type e)
18856 'paragraph))))
18857 e)))
18858 (when paragraph
18859 (save-excursion
18860 (goto-char (org-element-property :begin paragraph))
18861 (when (save-match-data
18862 (re-search-forward
18864 (org-element-property
18865 :post-affiliated paragraph)
18866 t))
18867 (string-to-number (match-string 1))))))
18868 ;; Otherwise, fall-back to provided number.
18869 (car org-image-actual-width)))
18870 ((numberp org-image-actual-width)
18871 org-image-actual-width)))
18872 (old (get-char-property-and-overlay
18873 (org-element-property :begin link)
18874 'org-image-overlay)))
18875 (if (and (car-safe old) refresh)
18876 (image-refresh (overlay-get (cdr old) 'display))
18877 (let ((image (save-match-data
18878 (create-image file
18879 (and width 'imagemagick)
18880 nil
18881 :width width))))
18882 (when image
18883 (let* ((link
18884 ;; If inline image is the description
18885 ;; of another link, be sure to
18886 ;; consider the latter as the one to
18887 ;; apply the overlay on.
18888 (let ((parent
18889 (org-element-property :parent link)))
18890 (if (eq (org-element-type parent) 'link)
18891 parent
18892 link)))
18893 (ov (make-overlay
18894 (org-element-property :begin link)
18895 (progn
18896 (goto-char
18897 (org-element-property :end link))
18899 (point)))))
18900 (overlay-put ov 'display image)
18901 (overlay-put ov 'face 'default)
18902 (overlay-put ov 'org-image-overlay t)
18903 (overlay-put
18904 ov 'modification-hooks
18905 (list 'org-display-inline-remove-overlay))
18906 (push ov org-inline-image-overlays)))))))))))))))
18908 (define-obsolete-function-alias
18909 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18911 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18912 "Remove inline-display overlay if a corresponding region is modified."
18913 (let ((inhibit-modification-hooks t))
18914 (when (and ov after)
18915 (delete ov org-inline-image-overlays)
18916 (delete-overlay ov))))
18918 (defun org-remove-inline-images ()
18919 "Remove inline display of images."
18920 (interactive)
18921 (mapc 'delete-overlay org-inline-image-overlays)
18922 (setq org-inline-image-overlays nil))
18924 ;;;; Key bindings
18926 ;; Outline functions from `outline-mode-prefix-map'
18927 ;; that can be remapped in Org:
18928 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18929 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18930 (define-key org-mode-map [remap outline-forward-same-level]
18931 'org-forward-heading-same-level)
18932 (define-key org-mode-map [remap outline-backward-same-level]
18933 'org-backward-heading-same-level)
18934 (define-key org-mode-map [remap show-branches]
18935 'org-kill-note-or-show-branches)
18936 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18937 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18938 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18940 ;; Outline functions from `outline-mode-prefix-map' that can not
18941 ;; be remapped in Org:
18942 ;;
18943 ;; - the column "key binding" shows whether the Outline function is still
18944 ;; available in Org mode on the same key that it has been bound to in
18945 ;; Outline mode:
18946 ;; - "overridden": key used for a different functionality in Org mode
18947 ;; - else: key still bound to the same Outline function in Org mode
18948 ;;
18949 ;; | Outline function | key binding | Org replacement |
18950 ;; |------------------------------------+-------------+-----------------------|
18951 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18952 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18953 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18954 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18955 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18956 ;; | `show-entry' | overridden | no replacement |
18957 ;; | `show-children' | `C-c C-i' | visibility cycling |
18958 ;; | `show-branches' | `C-c C-k' | still same function |
18959 ;; | `show-subtree' | overridden | visibility cycling |
18960 ;; | `show-all' | overridden | no replacement |
18961 ;; | `hide-subtree' | overridden | visibility cycling |
18962 ;; | `hide-body' | overridden | no replacement |
18963 ;; | `hide-entry' | overridden | visibility cycling |
18964 ;; | `hide-leaves' | overridden | no replacement |
18965 ;; | `hide-sublevels' | overridden | no replacement |
18966 ;; | `hide-other' | overridden | no replacement |
18968 ;; Make `C-c C-x' a prefix key
18969 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18971 ;; TAB key with modifiers
18972 (org-defkey org-mode-map "\C-i" 'org-cycle)
18973 (org-defkey org-mode-map [(tab)] 'org-cycle)
18974 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18976 ;; The following line is necessary under Suse GNU/Linux
18977 (unless (featurep 'xemacs)
18978 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18979 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18980 (define-key org-mode-map [backtab] 'org-shifttab)
18982 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18983 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18984 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18986 ;; Cursor keys with modifiers
18987 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18988 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18989 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18990 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18992 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18993 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18994 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18995 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18997 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18998 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18999 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19000 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19002 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19003 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19004 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19005 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19007 ;; Babel keys
19008 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19009 (mapc (lambda (pair)
19010 (define-key org-babel-map (car pair) (cdr pair)))
19011 org-babel-key-bindings)
19013 ;;; Extra keys for tty access.
19014 ;; We only set them when really needed because otherwise the
19015 ;; menus don't show the simple keys
19017 (when (or org-use-extra-keys
19018 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19019 (not window-system))
19020 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19021 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19022 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19023 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19024 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19025 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19026 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19027 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19028 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19029 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19030 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19031 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19032 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19033 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19034 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19035 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19036 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19037 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19038 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19039 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19040 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19041 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19042 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19043 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19044 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19045 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19046 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19047 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19049 ;; All the other keys
19051 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19052 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19053 (if (boundp 'narrow-map)
19054 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19055 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19056 (if (boundp 'narrow-map)
19057 (org-defkey narrow-map "b" 'org-narrow-to-block)
19058 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19059 (if (boundp 'narrow-map)
19060 (org-defkey narrow-map "e" 'org-narrow-to-element)
19061 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19062 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19063 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19064 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19065 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19066 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19067 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19068 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19069 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19070 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19071 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19072 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19073 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19074 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19075 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19076 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19077 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19078 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19079 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19080 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19081 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19082 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19083 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19084 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19085 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19086 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19087 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19089 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19090 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19091 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19092 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19093 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19094 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19095 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19096 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19097 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19098 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19099 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19100 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19101 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19102 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19103 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19104 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19105 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19106 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19107 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19108 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19109 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19111 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19112 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19113 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19114 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19115 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19116 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19117 (org-defkey org-mode-map "\C-c^" 'org-sort)
19118 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19119 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19120 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19121 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19122 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19123 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19124 (org-defkey org-mode-map "\C-m" 'org-return)
19125 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19126 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19127 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19128 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19129 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19130 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19131 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19132 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19133 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19134 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19135 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19136 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19137 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19138 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19139 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19140 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19141 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19142 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19143 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19144 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19145 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19146 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19147 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19149 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19150 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19151 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19153 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19154 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19155 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19156 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19157 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19158 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19159 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19160 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19161 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19162 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19163 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19164 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19165 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19167 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19168 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19169 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19170 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19171 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19172 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19173 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19174 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19175 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19177 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19178 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19179 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19180 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19181 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19183 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19185 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19187 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19188 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19190 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19193 (when (featurep 'xemacs)
19194 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19197 (defconst org-speed-commands-default
19198 '(
19199 ("Outline Navigation")
19200 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19201 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19202 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19203 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19204 ("F" . org-next-block)
19205 ("B" . org-previous-block)
19206 ("u" . (org-speed-move-safe 'outline-up-heading))
19207 ("j" . org-goto)
19208 ("g" . (org-refile t))
19209 ("Outline Visibility")
19210 ("c" . org-cycle)
19211 ("C" . org-shifttab)
19212 (" " . org-display-outline-path)
19213 ("s" . org-narrow-to-subtree)
19214 ("=" . org-columns)
19215 ("Outline Structure Editing")
19216 ("U" . org-shiftmetaup)
19217 ("D" . org-shiftmetadown)
19218 ("r" . org-metaright)
19219 ("l" . org-metaleft)
19220 ("R" . org-shiftmetaright)
19221 ("L" . org-shiftmetaleft)
19222 ("i" . (progn (forward-char 1) (call-interactively
19223 'org-insert-heading-respect-content)))
19224 ("^" . org-sort)
19225 ("w" . org-refile)
19226 ("a" . org-archive-subtree-default-with-confirmation)
19227 ("@" . org-mark-subtree)
19228 ("#" . org-toggle-comment)
19229 ("Clock Commands")
19230 ("I" . org-clock-in)
19231 ("O" . org-clock-out)
19232 ("Meta Data Editing")
19233 ("t" . org-todo)
19234 ("," . (org-priority))
19235 ("0" . (org-priority ?\ ))
19236 ("1" . (org-priority ?A))
19237 ("2" . (org-priority ?B))
19238 ("3" . (org-priority ?C))
19239 (":" . org-set-tags-command)
19240 ("e" . org-set-effort)
19241 ("E" . org-inc-effort)
19242 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19243 (org-entry-put (point) "APPT_WARNTIME" m)))
19244 ("Agenda Views etc")
19245 ("v" . org-agenda)
19246 ("/" . org-sparse-tree)
19247 ("Misc")
19248 ("o" . org-open-at-point)
19249 ("?" . org-speed-command-help)
19250 ("<" . (org-agenda-set-restriction-lock 'subtree))
19251 (">" . (org-agenda-remove-restriction-lock))
19252 )
19253 "The default speed commands.")
19255 (defun org-print-speed-command (e)
19256 (if (> (length (car e)) 1)
19257 (progn
19259 (princ (car e))
19261 (princ (make-string (length (car e)) ?-))
19263 (princ (car e))
19264 (princ " ")
19265 (if (symbolp (cdr e))
19266 (princ (symbol-name (cdr e)))
19267 (prin1 (cdr e)))
19270 (defun org-speed-command-help ()
19271 "Show the available speed commands."
19272 (interactive)
19273 (if (not org-use-speed-commands)
19274 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19275 (with-output-to-temp-buffer "*Help*"
19277 (mapc 'org-print-speed-command org-speed-commands-user)
19280 (mapc 'org-print-speed-command org-speed-commands-default))
19281 (with-current-buffer "*Help*"
19282 (setq truncate-lines t))))
19284 (defun org-speed-move-safe (cmd)
19285 "Execute CMD, but make sure that the cursor always ends up in a headline.
19286 If not, return to the original position and throw an error."
19287 (interactive)
19288 (let ((pos (point)))
19289 (call-interactively cmd)
19290 (unless (and (bolp) (org-at-heading-p))
19291 (goto-char pos)
19292 (error "Boundary reached while executing %s" cmd))))
19294 (defvar org-self-insert-command-undo-counter 0)
19296 (defvar org-table-auto-blank-field) ; defined in org-table.el
19297 (defvar org-speed-command nil)
19299 (define-obsolete-function-alias
19300 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19302 (defun org-speed-command-activate (keys)
19303 "Hook for activating single-letter speed commands.
19304 `org-speed-commands-default' specifies a minimal command set.
19305 Use `org-speed-commands-user' for further customization."
19306 (when (or (and (bolp) (looking-at org-outline-regexp))
19307 (and (functionp org-use-speed-commands)
19308 (funcall org-use-speed-commands)))
19309 (cdr (assoc keys (append org-speed-commands-user
19310 org-speed-commands-default)))))
19312 (define-obsolete-function-alias
19313 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19315 (defun org-babel-speed-command-activate (keys)
19316 "Hook for activating single-letter code block commands."
19317 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19318 (cdr (assoc keys org-babel-key-bindings))))
19320 (defcustom org-speed-command-hook
19321 '(org-speed-command-default-hook org-babel-speed-command-hook)
19322 "Hook for activating speed commands at strategic locations.
19323 Hook functions are called in sequence until a valid handler is
19324 found.
19326 Each hook takes a single argument, a user-pressed command key
19327 which is also a `self-insert-command' from the global map.
19329 Within the hook, examine the cursor position and the command key
19330 and return nil or a valid handler as appropriate. Handler could
19331 be one of an interactive command, a function, or a form.
19333 Set `org-use-speed-commands' to non-nil value to enable this
19334 hook. The default setting is `org-speed-command-activate'."
19335 :group 'org-structure
19336 :version "24.1"
19337 :type 'hook)
19339 (defun org-self-insert-command (N)
19340 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19341 If the cursor is in a table looking at whitespace, the whitespace is
19342 overwritten, and the table is not marked as requiring realignment."
19343 (interactive "p")
19344 (org-check-before-invisible-edit 'insert)
19345 (cond
19346 ((and org-use-speed-commands
19347 (setq org-speed-command
19348 (run-hook-with-args-until-success
19349 'org-speed-command-hook (this-command-keys))))
19350 (cond
19351 ((commandp org-speed-command)
19352 (setq this-command org-speed-command)
19353 (call-interactively org-speed-command))
19354 ((functionp org-speed-command)
19355 (funcall org-speed-command))
19356 ((and org-speed-command (listp org-speed-command))
19357 (eval org-speed-command))
19358 (t (let (org-use-speed-commands)
19359 (call-interactively 'org-self-insert-command)))))
19360 ((and
19361 (org-table-p)
19362 (progn
19363 ;; check if we blank the field, and if that triggers align
19364 (and (featurep 'org-table) org-table-auto-blank-field
19365 (member last-command
19366 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19368 ;; got extra space, this field does not determine column width
19369 (let (org-table-may-need-update) (org-table-blank-field))
19370 ;; no extra space, this field may determine column width
19371 (org-table-blank-field)))
19372 t)
19373 (eq N 1)
19375 (let (org-table-may-need-update)
19376 (goto-char (1- (match-end 0)))
19377 (backward-delete-char 1)
19378 (goto-char (match-beginning 0))
19379 (self-insert-command N)))
19380 (t
19381 (setq org-table-may-need-update t)
19382 (self-insert-command N)
19383 (org-fix-tags-on-the-fly)
19384 (if org-self-insert-cluster-for-undo
19385 (if (not (eq last-command 'org-self-insert-command))
19386 (setq org-self-insert-command-undo-counter 1)
19387 (if (>= org-self-insert-command-undo-counter 20)
19388 (setq org-self-insert-command-undo-counter 1)
19389 (and (> org-self-insert-command-undo-counter 0)
19390 buffer-undo-list (listp buffer-undo-list)
19391 (not (cadr buffer-undo-list)) ; remove nil entry
19392 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19393 (setq org-self-insert-command-undo-counter
19394 (1+ org-self-insert-command-undo-counter))))))))
19396 (defun org-check-before-invisible-edit (kind)
19397 "Check is editing if kind KIND would be dangerous with invisible text around.
19398 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19399 ;; First, try to get out of here as quickly as possible, to reduce overhead
19400 (if (and org-catch-invisible-edits
19401 (or (not (boundp 'visible-mode)) (not visible-mode))
19402 (or (get-char-property (point) 'invisible)
19403 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19404 ;; OK, we need to take a closer look
19405 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19406 (invisible-before-point (if (bobp) nil (get-char-property
19407 (1- (point)) 'invisible)))
19408 (border-and-ok-direction
19409 (or
19410 ;; Check if we are acting predictably before invisible text
19411 (and invisible-at-point (not invisible-before-point)
19412 (memq kind '(insert delete-backward)))
19413 ;; Check if we are acting predictably after invisible text
19414 ;; This works not well, and I have turned it off. It seems
19415 ;; better to always show and stop after invisible text.
19416 ;; (and (not invisible-at-point) invisible-before-point
19417 ;; (memq kind '(insert delete)))
19418 )))
19419 (when (or (memq invisible-at-point '(outline org-hide-block t))
19420 (memq invisible-before-point '(outline org-hide-block t)))
19421 (if (eq org-catch-invisible-edits 'error)
19422 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19423 (if (and org-custom-properties-overlays
19424 (y-or-n-p "Display invisible properties in this buffer? "))
19425 (org-toggle-custom-properties-visibility)
19426 ;; Make the area visible
19427 (save-excursion
19428 (if invisible-before-point
19429 (goto-char (previous-single-char-property-change
19430 (point) 'invisible)))
19431 (org-cycle))
19432 (cond
19433 ((eq org-catch-invisible-edits 'show)
19434 ;; That's it, we do the edit after showing
19435 (message
19436 "Unfolding invisible region around point before editing")
19437 (sit-for 1))
19438 ((and (eq org-catch-invisible-edits 'smart)
19439 border-and-ok-direction)
19440 (message "Unfolding invisible region around point before editing"))
19441 (t
19442 ;; Don't do the edit, make the user repeat it in full visibility
19443 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19445 (defun org-fix-tags-on-the-fly ()
19446 (when (and (equal (char-after (point-at-bol)) ?*)
19447 (org-at-heading-p))
19448 (org-align-tags-here org-tags-column)))
19450 (defun org-delete-backward-char (N)
19451 "Like `delete-backward-char', insert whitespace at field end in tables.
19452 When deleting backwards, in tables this function will insert whitespace in
19454 still be marked for re-alignment if the field did fill the entire column,
19455 because, in this case the deletion might narrow the column."
19456 (interactive "p")
19457 (save-match-data
19458 (org-check-before-invisible-edit 'delete-backward)
19459 (if (and (org-table-p)
19460 (eq N 1)
19461 (string-match "|" (buffer-substring (point-at-bol) (point)))
19462 (looking-at ".*?|"))
19463 (let ((pos (point))
19465 (c org-table-may-need-update))
19466 (backward-delete-char N)
19467 (if (not overwrite-mode)
19468 (progn
19469 (skip-chars-forward "^|")
19470 (insert " ")
19471 (goto-char (1- pos))))
19472 ;; noalign: if there were two spaces at the end, this field
19473 ;; does not determine the width of the column.
19474 (if noalign (setq org-table-may-need-update c)))
19475 (backward-delete-char N)
19476 (org-fix-tags-on-the-fly))))
19478 (defun org-delete-char (N)
19479 "Like `delete-char', but insert whitespace at field end in tables.
19480 When deleting characters, in tables this function will insert whitespace in
19482 still be marked for re-alignment if the field did fill the entire column,
19483 because, in this case the deletion might narrow the column."
19484 (interactive "p")
19485 (save-match-data
19486 (org-check-before-invisible-edit 'delete)
19487 (if (and (org-table-p)
19488 (not (bolp))
19489 (not (= (char-after) ?|))
19490 (eq N 1))
19491 (if (looking-at ".*?|")
19492 (let ((pos (point))
19494 (c org-table-may-need-update))
19495 (replace-match
19496 (concat (substring (match-string 0) 1 -1) " |") nil t)
19497 (goto-char pos)
19498 ;; noalign: if there were two spaces at the end, this field
19499 ;; does not determine the width of the column.
19500 (if noalign (setq org-table-may-need-update c)))
19501 (delete-char N))
19502 (delete-char N)
19503 (org-fix-tags-on-the-fly))))
19505 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19506 (put 'org-self-insert-command 'delete-selection t)
19507 (put 'orgtbl-self-insert-command 'delete-selection t)
19508 (put 'org-delete-char 'delete-selection 'supersede)
19509 (put 'org-delete-backward-char 'delete-selection 'supersede)
19510 (put 'org-yank 'delete-selection 'yank)
19512 ;; Make `flyspell-mode' delay after some commands
19513 (put 'org-self-insert-command 'flyspell-delayed t)
19514 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19515 (put 'org-delete-char 'flyspell-delayed t)
19516 (put 'org-delete-backward-char 'flyspell-delayed t)
19518 ;; Make pabbrev-mode expand after org-mode commands
19519 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19520 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19522 ;; How to do this: Measure non-white length of current string
19523 ;; If equal to column width, we should realign.
19525 (defun org-remap (map &rest commands)
19526 "In MAP, remap the functions given in COMMANDS.
19527 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19528 (let (new old)
19529 (while commands
19530 (setq old (pop commands) new (pop commands))
19531 (if (fboundp 'command-remapping)
19532 (org-defkey map (vector 'remap old) new)
19533 (substitute-key-definition old new map global-map)))))
19535 (defun org-transpose-words ()
19536 "Transpose words for Org.
19537 This uses the `org-mode-transpose-word-syntax-table' syntax
19538 table, which interprets characters in `org-emphasis-alist' as
19539 word constituants."
19540 (interactive)
19541 (with-syntax-table org-mode-transpose-word-syntax-table
19542 (call-interactively 'transpose-words)))
19543 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19545 (when (eq org-enable-table-editor 'optimized)
19546 ;; If the user wants maximum table support, we need to hijack
19547 ;; some standard editing functions
19548 (org-remap org-mode-map
19549 'self-insert-command 'org-self-insert-command
19550 'delete-char 'org-delete-char
19551 'delete-backward-char 'org-delete-backward-char)
19552 (org-defkey org-mode-map "|" 'org-force-self-insert))
19554 (defvar org-ctrl-c-ctrl-c-hook nil
19555 "Hook for functions attaching themselves to `C-c C-c'.
19557 This can be used to add additional functionality to the C-c C-c
19558 key which executes context-dependent commands. This hook is run
19559 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19560 run after the last test.
19562 Each function will be called with no arguments. The function
19563 must check if the context is appropriate for it to act. If yes,
19564 it should do its thing and then return a non-nil value. If the
19565 context is wrong, just do nothing and return nil.")
19567 (defvar org-ctrl-c-ctrl-c-final-hook nil
19568 "Hook for functions attaching themselves to `C-c C-c'.
19570 This can be used to add additional functionality to the C-c C-c
19571 key which executes context-dependent commands. This hook is run
19572 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19573 before the first test.
19575 Each function will be called with no arguments. The function
19576 must check if the context is appropriate for it to act. If yes,
19577 it should do its thing and then return a non-nil value. If the
19578 context is wrong, just do nothing and return nil.")
19580 (defvar org-tab-first-hook nil
19581 "Hook for functions to attach themselves to TAB.
19582 See `org-ctrl-c-ctrl-c-hook' for more information.
19583 This hook runs as the first action when TAB is pressed, even before
19584 `org-cycle' messes around with the `outline-regexp' to cater for
19585 inline tasks and plain list item folding.
19586 If any function in this hook returns t, any other actions that
19587 would have been caused by TAB (such as table field motion or visibility
19588 cycling) will not occur.")
19590 (defvar org-tab-after-check-for-table-hook nil
19591 "Hook for functions to attach themselves to TAB.
19592 See `org-ctrl-c-ctrl-c-hook' for more information.
19593 This hook runs after it has been established that the cursor is not in a
19594 table, but before checking if the cursor is in a headline or if global cycling
19595 should be done.
19596 If any function in this hook returns t, not other actions like visibility
19597 cycling will be done.")
19599 (defvar org-tab-after-check-for-cycling-hook nil
19600 "Hook for functions to attach themselves to TAB.
19601 See `org-ctrl-c-ctrl-c-hook' for more information.
19602 This hook runs after it has been established that not table field motion and
19603 not visibility should be done because of current context. This is probably
19604 the place where a package like yasnippets can hook in.")
19606 (defvar org-tab-before-tab-emulation-hook nil
19607 "Hook for functions to attach themselves to TAB.
19608 See `org-ctrl-c-ctrl-c-hook' for more information.
19609 This hook runs after every other options for TAB have been exhausted, but
19612 (defvar org-metaleft-hook nil
19613 "Hook for functions attaching themselves to `M-left'.
19614 See `org-ctrl-c-ctrl-c-hook' for more information.")
19615 (defvar org-metaright-hook nil
19616 "Hook for functions attaching themselves to `M-right'.
19617 See `org-ctrl-c-ctrl-c-hook' for more information.")
19618 (defvar org-metaup-hook nil
19619 "Hook for functions attaching themselves to `M-up'.
19620 See `org-ctrl-c-ctrl-c-hook' for more information.")
19621 (defvar org-metadown-hook nil
19622 "Hook for functions attaching themselves to `M-down'.
19623 See `org-ctrl-c-ctrl-c-hook' for more information.")
19624 (defvar org-shiftmetaleft-hook nil
19625 "Hook for functions attaching themselves to `M-S-left'.
19626 See `org-ctrl-c-ctrl-c-hook' for more information.")
19627 (defvar org-shiftmetaright-hook nil
19628 "Hook for functions attaching themselves to `M-S-right'.
19629 See `org-ctrl-c-ctrl-c-hook' for more information.")
19630 (defvar org-shiftmetaup-hook nil
19631 "Hook for functions attaching themselves to `M-S-up'.
19632 See `org-ctrl-c-ctrl-c-hook' for more information.")
19633 (defvar org-shiftmetadown-hook nil
19634 "Hook for functions attaching themselves to `M-S-down'.
19635 See `org-ctrl-c-ctrl-c-hook' for more information.")
19636 (defvar org-metareturn-hook nil
19637 "Hook for functions attaching themselves to `M-RET'.
19638 See `org-ctrl-c-ctrl-c-hook' for more information.")
19639 (defvar org-shiftup-hook nil
19640 "Hook for functions attaching themselves to `S-up'.
19641 See `org-ctrl-c-ctrl-c-hook' for more information.")
19642 (defvar org-shiftup-final-hook nil
19643 "Hook for functions attaching themselves to `S-up'.
19644 This one runs after all other options except shift-select have been excluded.
19645 See `org-ctrl-c-ctrl-c-hook' for more information.")
19646 (defvar org-shiftdown-hook nil
19647 "Hook for functions attaching themselves to `S-down'.
19648 See `org-ctrl-c-ctrl-c-hook' for more information.")
19649 (defvar org-shiftdown-final-hook nil
19650 "Hook for functions attaching themselves to `S-down'.
19651 This one runs after all other options except shift-select have been excluded.
19652 See `org-ctrl-c-ctrl-c-hook' for more information.")
19653 (defvar org-shiftleft-hook nil
19654 "Hook for functions attaching themselves to `S-left'.
19655 See `org-ctrl-c-ctrl-c-hook' for more information.")
19656 (defvar org-shiftleft-final-hook nil
19657 "Hook for functions attaching themselves to `S-left'.
19658 This one runs after all other options except shift-select have been excluded.
19659 See `org-ctrl-c-ctrl-c-hook' for more information.")
19660 (defvar org-shiftright-hook nil
19661 "Hook for functions attaching themselves to `S-right'.
19662 See `org-ctrl-c-ctrl-c-hook' for more information.")
19663 (defvar org-shiftright-final-hook nil
19664 "Hook for functions attaching themselves to `S-right'.
19665 This one runs after all other options except shift-select have been excluded.
19666 See `org-ctrl-c-ctrl-c-hook' for more information.")
19668 (defun org-modifier-cursor-error ()
19669 "Throw an error, a modified cursor command was applied in wrong context."
19670 (user-error "This command is active in special context like tables, headlines or items"))
19672 (defun org-shiftselect-error ()
19673 "Throw an error because Shift-Cursor command was applied in wrong context."
19674 (if (and (boundp 'shift-select-mode) shift-select-mode)
19675 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19676 (user-error "This command works only in special context like headlines or timestamps")))
19678 (defun org-call-for-shift-select (cmd)
19679 (let ((this-command-keys-shift-translated t))
19680 (call-interactively cmd)))
19682 (defun org-shifttab (&optional arg)
19683 "Global visibility cycling or move to previous table field.
19684 Call `org-table-previous-field' within a table.
19685 When ARG is nil, cycle globally through visibility states.
19686 When ARG is a numeric prefix, show contents of this level."
19687 (interactive "P")
19688 (cond
19689 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19690 ((integerp arg)
19691 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19692 (message "Content view to level: %d" arg)
19693 (org-content (prefix-numeric-value arg2))
19694 (org-cycle-show-empty-lines t)
19695 (setq org-cycle-global-status 'overview)))
19696 (t (call-interactively 'org-global-cycle))))
19698 (defun org-shiftmetaleft ()
19699 "Promote subtree or delete table column.
19700 Calls `org-promote-subtree', `org-outdent-item-tree', or
19701 `org-table-delete-column', depending on context. See the
19702 individual commands for more information."
19703 (interactive)
19704 (cond
19705 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19706 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19707 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19708 ((if (not (org-region-active-p)) (org-at-item-p)
19709 (save-excursion (goto-char (region-beginning))
19710 (org-at-item-p)))
19711 (call-interactively 'org-outdent-item-tree))
19712 (t (org-modifier-cursor-error))))
19714 (defun org-shiftmetaright ()
19715 "Demote subtree or insert table column.
19716 Calls `org-demote-subtree', `org-indent-item-tree', or
19717 `org-table-insert-column', depending on context. See the
19718 individual commands for more information."
19719 (interactive)
19720 (cond
19721 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19722 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19723 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19724 ((if (not (org-region-active-p)) (org-at-item-p)
19725 (save-excursion (goto-char (region-beginning))
19726 (org-at-item-p)))
19727 (call-interactively 'org-indent-item-tree))
19728 (t (org-modifier-cursor-error))))
19730 (defun org-shiftmetaup (&optional arg)
19731 "Move subtree up or kill table row.
19732 Calls `org-move-subtree-up' or `org-table-kill-row' or
19733 `org-move-item-up' or `org-timestamp-up', depending on context.
19734 See the individual commands for more information."
19735 (interactive "P")
19736 (cond
19737 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19738 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19739 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19740 ((org-at-item-p) (call-interactively 'org-move-item-up))
19741 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19742 (call-interactively 'org-timestamp-up)))
19743 (t (call-interactively 'org-drag-line-backward))))
19745 (defun org-shiftmetadown (&optional arg)
19746 "Move subtree down or insert table row.
19747 Calls `org-move-subtree-down' or `org-table-insert-row' or
19748 `org-move-item-down' or `org-timestamp-up', depending on context.
19749 See the individual commands for more information."
19750 (interactive "P")
19751 (cond
19752 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19753 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19754 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19755 ((org-at-item-p) (call-interactively 'org-move-item-down))
19756 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19757 (call-interactively 'org-timestamp-down)))
19758 (t (call-interactively 'org-drag-line-forward))))
19760 (defsubst org-hidden-tree-error ()
19761 (user-error
19762 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19764 (defun org-metaleft (&optional arg)
19765 "Promote heading or move table column to left.
19766 Calls `org-do-promote' or `org-table-move-column', depending on context.
19767 With no specific context, calls the Emacs default `backward-word'.
19768 See the individual commands for more information."
19769 (interactive "P")
19770 (cond
19771 ((run-hook-with-args-until-success 'org-metaleft-hook))
19772 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19773 ((org-with-limited-levels
19774 (or (org-at-heading-p)
19775 (and (org-region-active-p)
19776 (save-excursion
19777 (goto-char (region-beginning))
19778 (org-at-heading-p)))))
19779 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19780 (call-interactively 'org-do-promote))
19781 ;; At an inline task.
19782 ((org-at-heading-p)
19783 (call-interactively 'org-inlinetask-promote))
19784 ((or (org-at-item-p)
19785 (and (org-region-active-p)
19786 (save-excursion
19787 (goto-char (region-beginning))
19788 (org-at-item-p))))
19789 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19790 (call-interactively 'org-outdent-item))
19791 (t (call-interactively 'backward-word))))
19793 (defun org-metaright (&optional arg)
19794 "Demote a subtree, a list item or move table column to right.
19795 In front of a drawer or a block keyword, indent it correctly.
19796 With no specific context, calls the Emacs default `forward-word'.
19797 See the individual commands for more information."
19798 (interactive "P")
19799 (cond
19800 ((run-hook-with-args-until-success 'org-metaright-hook))
19801 ((org-at-table-p) (call-interactively 'org-table-move-column))
19802 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19803 ((org-at-block-p) (call-interactively 'org-indent-block))
19804 ((org-with-limited-levels
19805 (or (org-at-heading-p)
19806 (and (org-region-active-p)
19807 (save-excursion
19808 (goto-char (region-beginning))
19809 (org-at-heading-p)))))
19810 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19811 (call-interactively 'org-do-demote))
19812 ;; At an inline task.
19813 ((org-at-heading-p)
19814 (call-interactively 'org-inlinetask-demote))
19815 ((or (org-at-item-p)
19816 (and (org-region-active-p)
19817 (save-excursion
19818 (goto-char (region-beginning))
19819 (org-at-item-p))))
19820 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19821 (call-interactively 'org-indent-item))
19822 (t (call-interactively 'forward-word))))
19824 (defun org-check-for-hidden (what)
19825 "Check if there are hidden headlines/items in the current visual line.
19826 WHAT can be either `headlines' or `items'. If the current line is
19827 an outline or item heading and it has a folded subtree below it,
19828 this function returns t, nil otherwise."
19829 (let ((re (cond
19830 ((eq what 'headlines) org-outline-regexp-bol)
19831 ((eq what 'items) (org-item-beginning-re))
19832 (t (error "This should not happen"))))
19833 beg end)
19834 (save-excursion
19835 (catch 'exit
19836 (unless (org-region-active-p)
19837 (setq beg (point-at-bol))
19838 (beginning-of-line 2)
19839 (while (and (not (eobp)) ;; this is like `next-line'
19840 (get-char-property (1- (point)) 'invisible))
19841 (beginning-of-line 2))
19842 (setq end (point))
19843 (goto-char beg)
19844 (goto-char (point-at-eol))
19845 (setq end (max end (point)))
19846 (while (re-search-forward re end t)
19847 (if (get-char-property (match-beginning 0) 'invisible)
19848 (throw 'exit t))))
19849 nil))))
19851 (defun org-metaup (&optional arg)
19852 "Move subtree up or move table row up.
19853 Calls `org-move-subtree-up' or `org-table-move-row' or
19854 `org-move-item-up', depending on context. See the individual commands
19855 for more information."
19856 (interactive "P")
19857 (cond
19858 ((run-hook-with-args-until-success 'org-metaup-hook))
19859 ((org-region-active-p)
19860 (let* ((a (min (region-beginning) (region-end)))
19861 (b (1- (max (region-beginning) (region-end))))
19862 (c (save-excursion (goto-char a)
19863 (move-beginning-of-line 0)))
19864 (d (save-excursion (goto-char a)
19865 (move-end-of-line 0) (point))))
19866 (transpose-regions a b c d)
19867 (goto-char c)))
19868 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19869 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19870 ((org-at-item-p) (call-interactively 'org-move-item-up))
19871 (t (org-drag-element-backward))))
19873 (defun org-metadown (&optional arg)
19874 "Move subtree down or move table row down.
19875 Calls `org-move-subtree-down' or `org-table-move-row' or
19876 `org-move-item-down', depending on context. See the individual
19877 commands for more information."
19878 (interactive "P")
19879 (cond
19880 ((run-hook-with-args-until-success 'org-metadown-hook))
19881 ((org-region-active-p)
19882 (let* ((a (min (region-beginning) (region-end)))
19883 (b (max (region-beginning) (region-end)))
19884 (c (save-excursion (goto-char b)
19885 (move-beginning-of-line 1)))
19886 (d (save-excursion (goto-char b)
19887 (move-end-of-line 1) (1+ (point)))))
19888 (transpose-regions a b c d)
19889 (goto-char d)))
19890 ((org-at-table-p) (call-interactively 'org-table-move-row))
19891 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19892 ((org-at-item-p) (call-interactively 'org-move-item-down))
19893 (t (org-drag-element-forward))))
19895 (defun org-shiftup (&optional arg)
19896 "Increase item in timestamp or increase priority of current headline.
19897 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19898 depending on context. See the individual commands for more information."
19899 (interactive "P")
19900 (cond
19901 ((run-hook-with-args-until-success 'org-shiftup-hook))
19902 ((and org-support-shift-select (org-region-active-p))
19903 (org-call-for-shift-select 'previous-line))
19904 ((org-at-timestamp-p t)
19905 (call-interactively (if org-edit-timestamp-down-means-later
19906 'org-timestamp-down 'org-timestamp-up)))
19907 ((and (not (eq org-support-shift-select 'always))
19908 org-enable-priority-commands
19909 (org-at-heading-p))
19910 (call-interactively 'org-priority-up))
19911 ((and (not org-support-shift-select) (org-at-item-p))
19912 (call-interactively 'org-previous-item))
19913 ((org-clocktable-try-shift 'up arg))
19914 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19915 (org-support-shift-select
19916 (org-call-for-shift-select 'previous-line))
19917 (t (org-shiftselect-error))))
19919 (defun org-shiftdown (&optional arg)
19920 "Decrease item in timestamp or decrease priority of current headline.
19921 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19922 depending on context. See the individual commands for more information."
19923 (interactive "P")
19924 (cond
19925 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19926 ((and org-support-shift-select (org-region-active-p))
19927 (org-call-for-shift-select 'next-line))
19928 ((org-at-timestamp-p t)
19929 (call-interactively (if org-edit-timestamp-down-means-later
19930 'org-timestamp-up 'org-timestamp-down)))
19931 ((and (not (eq org-support-shift-select 'always))
19932 org-enable-priority-commands
19933 (org-at-heading-p))
19934 (call-interactively 'org-priority-down))
19935 ((and (not org-support-shift-select) (org-at-item-p))
19936 (call-interactively 'org-next-item))
19937 ((org-clocktable-try-shift 'down arg))
19938 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19939 (org-support-shift-select
19940 (org-call-for-shift-select 'next-line))
19941 (t (org-shiftselect-error))))
19943 (defun org-shiftright (&optional arg)
19944 "Cycle the thing at point or in the current line, depending on context.
19945 Depending on context, this does one of the following:
19947 - switch a timestamp at point one day into the future
19948 - on a headline, switch to the next TODO keyword.
19949 - on an item, switch entire list to the next bullet type
19950 - on a property line, switch to the next allowed value
19951 - on a clocktable definition line, move time block into the future"
19952 (interactive "P")
19953 (cond
19954 ((run-hook-with-args-until-success 'org-shiftright-hook))
19955 ((and org-support-shift-select (org-region-active-p))
19956 (org-call-for-shift-select 'forward-char))
19957 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19958 ((and (not (eq org-support-shift-select 'always))
19959 (org-at-heading-p))
19960 (let ((org-inhibit-logging
19961 (not org-treat-S-cursor-todo-selection-as-state-change))
19962 (org-inhibit-blocking
19963 (not org-treat-S-cursor-todo-selection-as-state-change)))
19964 (org-call-with-arg 'org-todo 'right)))
19965 ((or (and org-support-shift-select
19966 (not (eq org-support-shift-select 'always))
19967 (org-at-item-bullet-p))
19968 (and (not org-support-shift-select) (org-at-item-p)))
19969 (org-call-with-arg 'org-cycle-list-bullet nil))
19970 ((and (not (eq org-support-shift-select 'always))
19971 (org-at-property-p))
19972 (call-interactively 'org-property-next-allowed-value))
19973 ((org-clocktable-try-shift 'right arg))
19974 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19975 (org-support-shift-select
19976 (org-call-for-shift-select 'forward-char))
19977 (t (org-shiftselect-error))))
19979 (defun org-shiftleft (&optional arg)
19980 "Cycle the thing at point or in the current line, depending on context.
19981 Depending on context, this does one of the following:
19983 - switch a timestamp at point one day into the past
19984 - on a headline, switch to the previous TODO keyword.
19985 - on an item, switch entire list to the previous bullet type
19986 - on a property line, switch to the previous allowed value
19987 - on a clocktable definition line, move time block into the past"
19988 (interactive "P")
19989 (cond
19990 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19991 ((and org-support-shift-select (org-region-active-p))
19992 (org-call-for-shift-select 'backward-char))
19993 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19994 ((and (not (eq org-support-shift-select 'always))
19995 (org-at-heading-p))
19996 (let ((org-inhibit-logging
19997 (not org-treat-S-cursor-todo-selection-as-state-change))
19998 (org-inhibit-blocking
19999 (not org-treat-S-cursor-todo-selection-as-state-change)))
20000 (org-call-with-arg 'org-todo 'left)))
20001 ((or (and org-support-shift-select
20002 (not (eq org-support-shift-select 'always))
20003 (org-at-item-bullet-p))
20004 (and (not org-support-shift-select) (org-at-item-p)))
20005 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20006 ((and (not (eq org-support-shift-select 'always))
20007 (org-at-property-p))
20008 (call-interactively 'org-property-previous-allowed-value))
20009 ((org-clocktable-try-shift 'left arg))
20010 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20011 (org-support-shift-select
20012 (org-call-for-shift-select 'backward-char))
20013 (t (org-shiftselect-error))))
20015 (defun org-shiftcontrolright ()
20016 "Switch to next TODO set."
20017 (interactive)
20018 (cond
20019 ((and org-support-shift-select (org-region-active-p))
20020 (org-call-for-shift-select 'forward-word))
20021 ((and (not (eq org-support-shift-select 'always))
20022 (org-at-heading-p))
20023 (org-call-with-arg 'org-todo 'nextset))
20024 (org-support-shift-select
20025 (org-call-for-shift-select 'forward-word))
20026 (t (org-shiftselect-error))))
20028 (defun org-shiftcontrolleft ()
20029 "Switch to previous TODO set."
20030 (interactive)
20031 (cond
20032 ((and org-support-shift-select (org-region-active-p))
20033 (org-call-for-shift-select 'backward-word))
20034 ((and (not (eq org-support-shift-select 'always))
20035 (org-at-heading-p))
20036 (org-call-with-arg 'org-todo 'previousset))
20037 (org-support-shift-select
20038 (org-call-for-shift-select 'backward-word))
20039 (t (org-shiftselect-error))))
20041 (defun org-shiftcontrolup (&optional n)
20042 "Change timestamps synchronously up in CLOCK log lines.
20043 Optional argument N tells to change by that many units."
20044 (interactive "P")
20045 (cond ((and (not org-support-shift-select)
20046 (org-at-clock-log-p)
20047 (org-at-timestamp-p t))
20048 (org-clock-timestamps-up n))
20049 (t (org-shiftselect-error))))
20051 (defun org-shiftcontroldown (&optional n)
20052 "Change timestamps synchronously down in CLOCK log lines.
20053 Optional argument N tells to change by that many units."
20054 (interactive "P")
20055 (cond ((and (not org-support-shift-select)
20056 (org-at-clock-log-p)
20057 (org-at-timestamp-p t))
20058 (org-clock-timestamps-down n))
20059 (t (org-shiftselect-error))))
20061 (defun org-ctrl-c-ret ()
20062 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20063 (interactive)
20064 (cond
20065 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20066 (t (call-interactively 'org-insert-heading))))
20068 (defun org-find-visible ()
20069 (let ((s (point)))
20070 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20071 (get-char-property s 'invisible)))
20072 s))
20073 (defun org-find-invisible ()
20074 (let ((s (point)))
20075 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20076 (not (get-char-property s 'invisible))))
20077 s))
20079 (defun org-copy-visible (beg end)
20080 "Copy the visible parts of the region."
20081 (interactive "r")
20082 (let (snippets s)
20083 (save-excursion
20084 (save-restriction
20085 (narrow-to-region beg end)
20086 (setq s (goto-char (point-min)))
20087 (while (not (= (point) (point-max)))
20088 (goto-char (org-find-invisible))
20089 (push (buffer-substring s (point)) snippets)
20090 (setq s (goto-char (org-find-visible))))))
20091 (kill-new (apply 'concat (nreverse snippets)))))
20093 (defun org-copy-special ()
20094 "Copy region in table or copy current subtree.
20095 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20096 See the individual commands for more information."
20097 (interactive)
20098 (call-interactively
20099 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20101 (defun org-cut-special ()
20102 "Cut region in table or cut current subtree.
20103 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20104 See the individual commands for more information."
20105 (interactive)
20106 (call-interactively
20107 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20109 (defun org-paste-special (arg)
20110 "Paste rectangular region into table, or past subtree relative to level.
20111 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20112 See the individual commands for more information."
20113 (interactive "P")
20114 (if (org-at-table-p)
20115 (org-table-paste-rectangle)
20116 (org-paste-subtree arg)))
20118 (defsubst org-in-fixed-width-region-p ()
20119 "Is point in a fixed-width region?"
20120 (save-match-data
20121 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20123 (defun org-edit-special (&optional arg)
20124 "Call a special editor for the element at point.
20125 When at a table, call the formula editor with `org-table-edit-formulas'.
20126 When in a source code block, call `org-edit-src-code'.
20127 When in a fixed-width region, call `org-edit-fixed-width-region'.
20128 When at an #+INCLUDE keyword, visit the included file.
20129 On a link, call `ffap' to visit the link at point.
20130 Otherwise, return a user error."
20131 (interactive "P")
20132 (let ((element (org-element-at-point)))
20133 (assert (not buffer-read-only) nil
20134 "Buffer is read-only: %s" (buffer-name))
20135 (case (org-element-type element)
20136 (src-block
20137 (if (not arg) (org-edit-src-code)
20138 (let* ((info (org-babel-get-src-block-info))
20139 (lang (nth 0 info))
20140 (params (nth 2 info))
20141 (session (cdr (assq :session params))))
20142 (if (not session) (org-edit-src-code)
20143 ;; At a src-block with a session and function called with
20144 ;; an ARG: switch to the buffer related to the inferior
20145 ;; process.
20146 (switch-to-buffer
20147 (funcall (intern (concat "org-babel-prep-session:" lang))
20148 session params))))))
20149 (keyword
20150 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20151 (find-file
20152 (org-remove-double-quotes
20153 (car (org-split-string (org-element-property :value element)))))
20154 (user-error "No special environment to edit here")))
20155 (table
20156 (if (eq (org-element-property :type element) 'table.el)
20157 (org-edit-src-code)
20158 (call-interactively 'org-table-edit-formulas)))
20159 ;; Only Org tables contain `table-row' type elements.
20160 (table-row (call-interactively 'org-table-edit-formulas))
20161 ((example-block export-block) (org-edit-src-code))
20162 (fixed-width (org-edit-fixed-width-region))
20163 (otherwise
20164 ;; No notable element at point. Though, we may be at a link,
20165 ;; which is an object. Thus, scan deeper.
20166 (if (eq (org-element-type (org-element-context element)) 'link)
20167 (call-interactively 'ffap)
20168 (user-error "No special environment to edit here"))))))
20170 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20171 (defun org-ctrl-c-ctrl-c (&optional arg)
20172 "Set tags in headline, or update according to changed information at point.
20174 This command does many different things, depending on context:
20176 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20177 this is what we do.
20179 - If the cursor is on a statistics cookie, update it.
20181 - If the cursor is in a headline, prompt for tags and insert them
20182 into the current line, aligned to `org-tags-column'. When called
20183 with prefix arg, realign all tags in the current buffer.
20185 - If the cursor is in one of the special #+KEYWORD lines, this
20186 triggers scanning the buffer for these lines and updating the
20187 information.
20189 - If the cursor is inside a table, realign the table. This command
20190 works even if the automatic table editor has been turned off.
20192 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20193 the entire table.
20195 - If the cursor is at a footnote reference or definition, jump to
20196 the corresponding definition or references, respectively.
20198 - If the cursor is a the beginning of a dynamic block, update it.
20200 - If the current buffer is a capture buffer, close note and file it.
20202 - If the cursor is on a <<<target>>>, update radio targets and
20203 corresponding links in this buffer.
20205 - If the cursor is on a numbered item in a plain list, renumber the
20206 ordered list.
20208 - If the cursor is on a checkbox, toggle it.
20210 - If the cursor is on a code block, evaluate it. The variable
20211 `org-confirm-babel-evaluate' can be used to control prompting
20212 before code block evaluation, by default every code block
20213 evaluation requires confirmation. Code block evaluation can be
20214 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20215 (interactive "P")
20216 (cond
20217 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20218 org-occur-highlights
20219 org-latex-fragment-image-overlays)
20220 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20221 (org-remove-occur-highlights)
20222 (org-remove-latex-fragment-image-overlays)
20223 (message "Temporary highlights/overlays removed from current buffer"))
20224 ((and (local-variable-p 'org-finish-function (current-buffer))
20225 (fboundp org-finish-function))
20226 (funcall org-finish-function))
20227 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20228 (t
20229 (let* ((context (org-element-context)) (type (org-element-type context)))
20230 ;; Test if point is within a blank line.
20232 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20233 (user-error "C-c C-c can do nothing useful at this location"))
20234 ;; When at a link, act according to the parent instead.
20235 (when (eq type 'link)
20236 (setq context (org-element-property :parent context))
20237 (setq type (org-element-type context)))
20238 ;; For convenience: at the first line of a paragraph on the
20239 ;; same line as an item, apply function on that item instead.
20240 (when (eq type 'paragraph)
20241 (let ((parent (org-element-property :parent context)))
20242 (when (and (eq (org-element-type parent) 'item)
20243 (= (point-at-bol) (org-element-property :begin parent)))
20244 (setq context parent type 'item))))
20245 ;; Act according to type of element or object at point.
20246 (case type
20247 (clock (org-clock-update-time-maybe))
20248 (dynamic-block
20249 (save-excursion
20250 (goto-char (org-element-property :post-affiliated context))
20251 (org-update-dblock)))
20252 (footnote-definition
20253 (goto-char (org-element-property :post-affiliated context))
20254 (call-interactively 'org-footnote-action))
20255 (footnote-reference (call-interactively 'org-footnote-action))
20256 ((headline inlinetask)
20257 (save-excursion (goto-char (org-element-property :begin context))
20258 (call-interactively 'org-set-tags)))
20259 (item
20260 ;; At an item: a double C-u set checkbox to "[-]"
20261 ;; unconditionally, whereas a single one will toggle its
20262 ;; presence. Without an universal argument, if the item
20263 ;; has a checkbox, toggle it. Otherwise repair the list.
20264 (let* ((box (org-element-property :checkbox context))
20265 (struct (org-element-property :structure context))
20266 (old-struct (copy-tree struct))
20267 (parents (org-list-parents-alist struct))
20268 (prevs (org-list-prevs-alist struct))
20269 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20270 (org-list-set-checkbox
20271 (org-element-property :begin context) struct
20272 (cond ((equal arg '(16)) "[-]")
20273 ((and (not box) (equal arg '(4))) "[ ]")
20274 ((or (not box) (equal arg '(4))) nil)
20275 ((eq box 'on) "[ ]")
20276 (t "[X]")))
20277 ;; Mimic `org-list-write-struct' but with grabbing
20278 ;; a return value from `org-list-struct-fix-box'.
20279 (org-list-struct-fix-ind struct parents 2)
20280 (org-list-struct-fix-item-end struct)
20281 (org-list-struct-fix-bul struct prevs)
20282 (org-list-struct-fix-ind struct parents)
20283 (let ((block-item
20284 (org-list-struct-fix-box struct parents prevs orderedp)))
20285 (if (and box (equal struct old-struct))
20286 (if (equal arg '(16))
20287 (message "Checkboxes already reset")
20288 (user-error "Cannot toggle this checkbox: %s"
20289 (if (eq box 'on)
20290 "all subitems checked"
20291 "unchecked subitems")))
20292 (org-list-struct-apply-struct struct old-struct)
20293 (org-update-checkbox-count-maybe))
20294 (when block-item
20295 (message "Checkboxes were removed due to empty box at line %d"
20296 (org-current-line block-item))))))
20297 (keyword
20298 (let ((org-inhibit-startup-visibility-stuff t)
20299 (org-startup-align-all-tables nil))
20300 (when (boundp 'org-table-coordinate-overlays)
20301 (mapc 'delete-overlay org-table-coordinate-overlays)
20302 (setq org-table-coordinate-overlays nil))
20303 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20304 (message "Local setup has been refreshed"))
20305 (plain-list
20306 ;; At a plain list, with a double C-u argument, set
20307 ;; checkboxes of each item to "[-]", whereas a single one
20308 ;; will toggle their presence according to the state of the
20309 ;; first item in the list. Without an argument, repair the
20310 ;; list.
20311 (let* ((begin (org-element-property :contents-begin context))
20312 (beginm (move-marker (make-marker) begin))
20313 (struct (org-element-property :structure context))
20314 (old-struct (copy-tree struct))
20315 (first-box (save-excursion
20316 (goto-char begin)
20317 (looking-at org-list-full-item-re)
20318 (match-string-no-properties 3)))
20319 (new-box (cond ((equal arg '(16)) "[-]")
20320 ((equal arg '(4)) (unless first-box "[ ]"))
20321 ((equal first-box "[X]") "[ ]")
20322 (t "[X]"))))
20323 (cond
20324 (arg
20325 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20326 (org-list-get-all-items
20327 begin struct (org-list-prevs-alist struct))))
20328 ((and first-box (eq (point) begin))
20329 ;; For convenience, when point is at bol on the first
20330 ;; item of the list and no argument is provided, simply
20331 ;; toggle checkbox of that item, if any.
20332 (org-list-set-checkbox begin struct new-box)))
20333 (org-list-write-struct
20334 struct (org-list-parents-alist struct) old-struct)
20335 (org-update-checkbox-count-maybe)
20336 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20337 ((property-drawer node-property)
20338 (call-interactively 'org-property-action))
20339 ((radio-target target)
20340 (call-interactively 'org-update-radio-target-regexp))
20341 (statistics-cookie
20342 (call-interactively 'org-update-statistics-cookies))
20343 ((table table-cell table-row)
20344 ;; At a table, recalculate every field and align it. Also
20345 ;; send the table if necessary. If the table has
20346 ;; a `table.el' type, just give up. At a table row or
20347 ;; cell, maybe recalculate line but always align table.
20348 (if (eq (org-element-property :type context) 'table.el)
20349 (message "Use C-c ' to edit table.el tables")
20350 (let ((org-enable-table-editor t))
20351 (if (or (eq type 'table)
20352 ;; Check if point is at a TBLFM line.
20353 (and (eq type 'table-row)
20354 (= (point) (org-element-property :end context))))
20355 (save-excursion
20356 (if (org-at-TBLFM-p)
20357 (progn (require 'org-table)
20358 (org-table-calc-current-TBLFM))
20359 (goto-char (org-element-property :contents-begin context))
20360 (org-call-with-arg 'org-table-recalculate (or arg t))
20361 (orgtbl-send-table 'maybe)))
20362 (org-table-maybe-eval-formula)
20363 (cond (arg (call-interactively 'org-table-recalculate))
20364 ((org-table-maybe-recalculate-line))
20365 (t (org-table-align)))))))
20366 (timestamp (org-timestamp-change 0 'day))
20367 (otherwise
20368 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20369 (user-error
20370 "C-c C-c can do nothing useful at this location")))))))))
20372 (defun org-mode-restart ()
20373 "Restart Org-mode, to scan again for special lines.
20374 Also updates the keyword regular expressions."
20375 (interactive)
20376 (org-mode)
20377 (message "Org-mode restarted"))
20379 (defun org-kill-note-or-show-branches ()
20380 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20381 (interactive)
20382 (if (not org-finish-function)
20383 (progn
20384 (hide-subtree)
20385 (call-interactively 'show-branches))
20386 (let ((org-note-abort t))
20387 (funcall org-finish-function))))
20389 (defun org-open-line (n)
20390 "Insert a new row in tables, call `open-line' elsewhere.
20391 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20392 (interactive "*p")
20393 (cond
20394 ((not org-special-ctrl-o)
20395 (open-line n))
20396 ((org-at-table-p)
20397 (org-table-insert-row))
20398 (t
20399 (open-line n))))
20401 (defun org-return (&optional indent)
20402 "Goto next table row or insert a newline.
20403 Calls `org-table-next-row' or `newline', depending on context.
20404 See the individual commands for more information."
20405 (interactive)
20406 (let (org-ts-what)
20407 (cond
20408 ((or (bobp) (org-in-src-block-p))
20409 (if indent (newline-and-indent) (newline)))
20410 ((org-at-table-p)
20411 (org-table-justify-field-maybe)
20412 (call-interactively 'org-table-next-row))
20413 ;; when `newline-and-indent' is called within a list, make sure
20414 ;; text moved stays inside the item.
20415 ((and (org-in-item-p) indent)
20416 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20417 (progn
20418 (save-match-data (newline))
20419 (org-indent-line-to (length (match-string 0))))
20420 (let ((ind (org-get-indentation)))
20421 (newline)
20422 (if (org-looking-back org-list-end-re)
20423 (org-indent-line)
20424 (org-indent-line-to ind)))))
20425 ((and org-return-follows-link
20426 (org-at-timestamp-p t)
20427 (not (eq org-ts-what 'after)))
20428 (org-follow-timestamp-link))
20429 ((and org-return-follows-link
20430 (let ((tprop (get-text-property (point) 'face)))
20431 (or (eq tprop 'org-link)
20432 (and (listp tprop) (memq 'org-link tprop)))))
20433 (call-interactively 'org-open-at-point))
20434 ((and (org-at-heading-p)
20435 (looking-at
20437 (org-show-entry)
20438 (end-of-line 1)
20439 (newline))
20440 (t (if indent (newline-and-indent) (newline))))))
20442 (defun org-return-indent ()
20443 "Goto next table row or insert a newline and indent.
20444 Calls `org-table-next-row' or `newline-and-indent', depending on
20445 context. See the individual commands for more information."
20446 (interactive)
20447 (org-return t))
20449 (defun org-ctrl-c-star ()
20450 "Compute table, or change heading status of lines.
20451 Calls `org-table-recalculate' or `org-toggle-heading',
20452 depending on context."
20453 (interactive)
20454 (cond
20455 ((org-at-table-p)
20456 (call-interactively 'org-table-recalculate))
20457 (t
20458 ;; Convert all lines in region to list items
20459 (call-interactively 'org-toggle-heading))))
20461 (defun org-ctrl-c-minus ()
20462 "Insert separator line in table or modify bullet status of line.
20463 Also turns a plain line or a region of lines into list items.
20464 Calls `org-table-insert-hline', `org-toggle-item', or
20465 `org-cycle-list-bullet', depending on context."
20466 (interactive)
20467 (cond
20468 ((org-at-table-p)
20469 (call-interactively 'org-table-insert-hline))
20470 ((org-region-active-p)
20471 (call-interactively 'org-toggle-item))
20472 ((org-in-item-p)
20473 (call-interactively 'org-cycle-list-bullet))
20474 (t
20475 (call-interactively 'org-toggle-item))))
20477 (defun org-toggle-item (arg)
20478 "Convert headings or normal lines to items, items to normal lines.
20479 If there is no active region, only the current line is considered.
20481 If the first non blank line in the region is a headline, convert
20482 all headlines to items, shifting text accordingly.
20484 If it is an item, convert all items to normal lines.
20486 If it is normal text, change region into a list of items.
20487 With a prefix argument ARG, change the region in a single item."
20488 (interactive "P")
20489 (let ((shift-text
20490 (function
20491 ;; Shift text in current section to IND, from point to END.
20492 ;; The function leaves point to END line.
20493 (lambda (ind end)
20494 (let ((min-i 1000) (end (copy-marker end)))
20495 ;; First determine the minimum indentation (MIN-I) of
20496 ;; the text.
20497 (save-excursion
20498 (catch 'exit
20499 (while (< (point) end)
20500 (let ((i (org-get-indentation)))
20501 (cond
20502 ;; Skip blank lines and inline tasks.
20504 ((looking-at org-outline-regexp-bol))
20505 ;; We can't find less than 0 indentation.
20506 ((zerop i) (throw 'exit (setq min-i 0)))
20507 ((< i min-i) (setq min-i i))))
20508 (forward-line))))
20509 ;; Then indent each line so that a line indented to
20510 ;; MIN-I becomes indented to IND. Ignore blank lines
20511 ;; and inline tasks in the process.
20512 (let ((delta (- ind min-i)))
20513 (while (< (point) end)
20515 (looking-at org-outline-regexp-bol))
20516 (org-indent-line-to (+ (org-get-indentation) delta)))
20517 (forward-line)))))))
20518 (skip-blanks
20519 (function
20520 ;; Return beginning of first non-blank line, starting from
20521 ;; line at POS.
20522 (lambda (pos)
20523 (save-excursion
20524 (goto-char pos)
20526 (point-at-bol)))))
20527 beg end)
20528 ;; Determine boundaries of changes.
20529 (if (org-region-active-p)
20530 (setq beg (funcall skip-blanks (region-beginning))
20531 end (copy-marker (region-end)))
20532 (setq beg (funcall skip-blanks (point-at-bol))
20533 end (copy-marker (point-at-eol))))
20534 ;; Depending on the starting line, choose an action on the text
20535 ;; between BEG and END.
20536 (org-with-limited-levels
20537 (save-excursion
20538 (goto-char beg)
20539 (cond
20540 ;; Case 1. Start at an item: de-itemize. Note that it only
20541 ;; happens when a region is active: `org-ctrl-c-minus'
20542 ;; would call `org-cycle-list-bullet' otherwise.
20543 ((org-at-item-p)
20544 (while (< (point) end)
20545 (when (org-at-item-p)
20547 (delete-region (point) (match-end 0)))
20548 (forward-line)))
20549 ;; Case 2. Start at an heading: convert to items.
20550 ((org-at-heading-p)
20551 (let* ((bul (org-list-bullet-string "-"))
20552 (bul-len (length bul))
20553 ;; Indentation of the first heading. It should be
20554 ;; relative to the indentation of its parent, if any.
20555 (start-ind (save-excursion
20556 (cond
20557 ((not org-adapt-indentation) 0)
20558 ((not (outline-previous-heading)) 0)
20559 (t (length (match-string 0))))))
20560 ;; Level of first heading. Further headings will be
20561 ;; compared to it to determine hierarchy in the list.
20562 (ref-level (org-reduced-level (org-outline-level))))
20563 (while (< (point) end)
20564 (let* ((level (org-reduced-level (org-outline-level)))
20565 (delta (max 0 (- level ref-level))))
20566 ;; If current headline is less indented than the first
20567 ;; one, set it as reference, in order to preserve
20568 ;; subtrees.
20569 (when (< level ref-level) (setq ref-level level))
20570 (replace-match bul t t)
20571 (org-indent-line-to (+ start-ind (* delta bul-len)))
20572 ;; Ensure all text down to END (or SECTION-END) belongs
20573 ;; to the newly created item.
20574 (let ((section-end (save-excursion
20575 (or (outline-next-heading) (point)))))
20576 (forward-line)
20577 (funcall shift-text
20578 (+ start-ind (* (1+ delta) bul-len))
20579 (min end section-end)))))))
20580 ;; Case 3. Normal line with ARG: make the first line of region
20581 ;; an item, and shift indentation of others lines to
20582 ;; set them as item's body.
20583 (arg (let* ((bul (org-list-bullet-string "-"))
20584 (bul-len (length bul))
20585 (ref-ind (org-get-indentation)))
20587 (insert bul)
20588 (forward-line)
20589 (while (< (point) end)
20590 ;; Ensure that lines less indented than first one
20591 ;; still get included in item body.
20592 (funcall shift-text
20593 (+ ref-ind bul-len)
20594 (min end (save-excursion (or (outline-next-heading)
20595 (point)))))
20596 (forward-line))))
20597 ;; Case 4. Normal line without ARG: turn each non-item line
20598 ;; into an item.
20599 (t
20600 (while (< (point) end)
20601 (unless (or (org-at-heading-p) (org-at-item-p))
20603 (replace-match
20605 (forward-line))))))))
20607 (defun org-toggle-heading (&optional nstars)
20608 "Convert headings to normal text, or items or text to headings.
20609 If there is no active region, only convert the current line.
20612 point into heading.
20614 In a region:
20616 - If the first non blank line is a headline, remove the stars
20617 from all headlines in the region.
20619 - If it is a normal line, turn each and every normal line (i.e.,
20620 not an heading or an item) in the region into headings. If you
20621 want to convert only the first line of this region, use one
20622 universal prefix argument.
20624 - If it is a plain list item, turn all plain list items into headings.
20626 When converting a line into a heading, the number of stars is chosen
20627 such that the lines become children of the current entry. However,
20628 when a numeric prefix argument is given, its value determines the
20629 number of stars to add."
20630 (interactive "P")
20631 (let ((skip-blanks
20632 (function
20633 ;; Return beginning of first non-blank line, starting from
20634 ;; line at POS.
20635 (lambda (pos)
20636 (save-excursion
20637 (goto-char pos)
20638 (while (org-at-comment-p) (forward-line))
20640 (point-at-bol)))))
20641 beg end toggled)
20642 ;; Determine boundaries of changes. If a universal prefix has
20643 ;; been given, put the list in a region. If region ends at a bol,
20644 ;; do not consider the last line to be in the region.
20646 (when (and current-prefix-arg (org-at-item-p))
20647 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20648 (org-mark-element))
20650 (if (org-region-active-p)
20651 (setq beg (funcall skip-blanks (region-beginning))
20652 end (copy-marker (save-excursion
20653 (goto-char (region-end))
20654 (if (bolp) (point) (point-at-eol)))))
20655 (setq beg (funcall skip-blanks (point-at-bol))
20656 end (copy-marker (point-at-eol))))
20657 ;; Ensure inline tasks don't count as headings.
20658 (org-with-limited-levels
20659 (save-excursion
20660 (goto-char beg)
20661 (cond
20662 ;; Case 1. Started at an heading: de-star headings.
20663 ((org-at-heading-p)
20664 (while (< (point) end)
20665 (when (org-at-heading-p t)
20666 (looking-at org-outline-regexp) (replace-match "")
20667 (setq toggled t))
20668 (forward-line)))
20669 ;; Case 2. Started at an item: change items into headlines.
20670 ;; One star will be added by `org-list-to-subtree'.
20671 ((org-at-item-p)
20672 (let* ((stars (make-string
20673 ;; subtract the star that will be added again by
20674 ;; `org-list-to-subtree'
20675 (if (numberp nstars) (1- nstars)
20676 (or (org-current-level) 0))
20677 ?*))
20678 (add-stars
20679 (cond (nstars "") ; stars from prefix only
20680 ((equal stars "") "") ; before first heading
20681 (org-odd-levels-only "*") ; inside heading, odd
20682 (t "")))) ; inside heading, oddeven
20683 (while (< (point) end)
20684 (when (org-at-item-p)
20685 ;; Pay attention to cases when region ends before list.
20686 (let* ((struct (org-list-struct))
20687 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20688 (save-restriction
20689 (narrow-to-region (point) list-end)
20690 (insert
20691 (org-list-to-subtree
20692 (org-list-parse-list t)
20693 '(:istart (concat stars add-stars (funcall get-stars depth))
20694 :icount (concat stars add-stars (funcall get-stars depth)))))))
20695 (setq toggled t))
20696 (forward-line))))
20697 ;; Case 3. Started at normal text: make every line an heading,
20698 ;; skipping headlines and items.
20699 (t (let* ((stars
20700 (make-string
20701 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20702 (add-stars
20703 (cond (nstars "") ; stars from prefix only
20704 ((equal stars "") "*") ; before first heading
20705 (org-odd-levels-only "**") ; inside heading, odd
20706 (t "*"))) ; inside heading, oddeven
20707 (rpl (concat stars add-stars " "))
20708 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20709 (while (< (point) (if (equal nstars '(4)) lend end))
20710 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20712 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20713 (forward-line)))))))
20714 (unless toggled (message "Cannot toggle heading from here"))))
20716 (defun org-meta-return (&optional arg)
20717 "Insert a new heading or wrap a region in a table.
20718 Calls `org-insert-heading' or `org-table-wrap-region', depending
20719 on context. See the individual commands for more information."
20720 (interactive "P")
20721 (org-check-before-invisible-edit 'insert)
20722 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20723 (let* ((element (org-element-at-point))
20724 (type (org-element-type element)))
20725 (when (eq type 'table-row)
20726 (setq element (org-element-property :parent element))
20727 (setq type 'table))
20728 (if (and (eq type 'table)
20729 (eq (org-element-property :type element) 'org)
20730 (>= (point) (org-element-property :contents-begin element))
20731 (< (point) (org-element-property :contents-end element)))
20732 (call-interactively 'org-table-wrap-region)
20733 (call-interactively 'org-insert-heading)))))
20735 ;;; Menu entries
20737 (defsubst org-in-subtree-not-table-p ()
20738 "Are we in a subtree and not in a table?"
20739 (and (not (org-before-first-heading-p))
20740 (not (org-at-table-p))))
20742 ;; Define the Org-mode menus
20743 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20744 '("Tbl"
20745 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20746 ["Next Field" org-cycle (org-at-table-p)]
20747 ["Previous Field" org-shifttab (org-at-table-p)]
20748 ["Next Row" org-return (org-at-table-p)]
20749 "--"
20750 ["Blank Field" org-table-blank-field (org-at-table-p)]
20751 ["Edit Field" org-table-edit-field (org-at-table-p)]
20752 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20753 "--"
20754 ("Column"
20755 ["Move Column Left" org-metaleft (org-at-table-p)]
20756 ["Move Column Right" org-metaright (org-at-table-p)]
20757 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20758 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20759 ("Row"
20760 ["Move Row Up" org-metaup (org-at-table-p)]
20761 ["Move Row Down" org-metadown (org-at-table-p)]
20762 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20763 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20764 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20765 "--"
20766 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20767 ("Rectangle"
20768 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20769 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20770 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20771 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20772 "--"
20773 ("Calculate"
20774 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20775 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20776 ["Edit Formulas" org-edit-special (org-at-table-p)]
20777 "--"
20778 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20779 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20780 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20781 "--"
20782 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20783 "--"
20784 ["Sum Column/Rectangle" org-table-sum
20785 (or (org-at-table-p) (org-region-active-p))]
20786 ["Which Column?" org-table-current-column (org-at-table-p)])
20787 ["Debug Formulas"
20788 org-table-toggle-formula-debugger
20789 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20790 ["Show Col/Row Numbers"
20791 org-table-toggle-coordinate-overlays
20792 :style toggle
20793 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20794 "--"
20795 ["Create" org-table-create (and (not (org-at-table-p))
20796 org-enable-table-editor)]
20797 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20798 ["Import from File" org-table-import (not (org-at-table-p))]
20799 ["Export to File" org-table-export (org-at-table-p)]
20800 "--"
20801 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20803 (easy-menu-define org-org-menu org-mode-map "Org menu"
20804 '("Org"
20805 ("Show/Hide"
20806 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20807 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20808 ["Sparse Tree..." org-sparse-tree t]
20809 ["Reveal Context" org-reveal t]
20810 ["Show All" show-all t]
20811 "--"
20812 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20813 "--"
20814 ["New Heading" org-insert-heading t]
20815 ("Navigate Headings"
20816 ["Up" outline-up-heading t]
20817 ["Next" outline-next-visible-heading t]
20818 ["Previous" outline-previous-visible-heading t]
20819 ["Next Same Level" outline-forward-same-level t]
20820 ["Previous Same Level" outline-backward-same-level t]
20821 "--"
20822 ["Jump" org-goto t])
20823 ("Edit Structure"
20824 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20825 "--"
20826 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20827 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20828 "--"
20829 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20830 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20831 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20832 "--"
20833 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20834 "--"
20835 ["Copy visible text" org-copy-visible t]
20836 "--"
20837 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20838 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20839 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20840 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20841 "--"
20842 ["Sort Region/Children" org-sort t]
20843 "--"
20844 ["Convert to odd levels" org-convert-to-odd-levels t]
20845 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20846 ("Editing"
20847 ["Emphasis..." org-emphasize t]
20848 ["Edit Source Example" org-edit-special t]
20849 "--"
20850 ["Footnote new/jump" org-footnote-action t]
20851 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20852 ("Archive"
20853 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20854 "--"
20855 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20856 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20857 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20858 )
20859 "--"
20860 ("Hyperlinks"
20861 ["Store Link (Global)" org-store-link t]
20862 ["Find existing link to here" org-occur-link-in-agenda-files t]
20863 ["Insert Link" org-insert-link t]
20864 ["Follow Link" org-open-at-point t]
20865 "--"
20866 ["Next link" org-next-link t]
20867 ["Previous link" org-previous-link t]
20868 "--"
20869 ["Descriptive Links"
20870 org-toggle-link-display
20871 :style radio
20872 :selected org-descriptive-links
20873 ]
20874 ["Literal Links"
20875 org-toggle-link-display
20876 :style radio
20877 :selected (not org-descriptive-links)])
20878 "--"
20879 ("TODO Lists"
20880 ["TODO/DONE/-" org-todo t]
20881 ("Select keyword"
20882 ["Next keyword" org-shiftright (org-at-heading-p)]
20883 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20884 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20885 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20886 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20887 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20888 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20889 "--"
20890 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20891 :selected org-enforce-todo-dependencies :style toggle :active t]
20892 "Settings for tree at point"
20893 ["Do Children sequentially" org-toggle-ordered-property :style radio
20894 :selected (org-entry-get nil "ORDERED")
20895 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20896 ["Do Children parallel" org-toggle-ordered-property :style radio
20897 :selected (not (org-entry-get nil "ORDERED"))
20898 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20899 "--"
20900 ["Set Priority" org-priority t]
20901 ["Priority Up" org-shiftup t]
20902 ["Priority Down" org-shiftdown t]
20903 "--"
20904 ["Get news from all feeds" org-feed-update-all t]
20905 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20906 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20907 ("TAGS and Properties"
20908 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20909 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20910 "--"
20911 ["Set property" org-set-property (not (org-before-first-heading-p))]
20912 ["Column view of properties" org-columns t]
20913 ["Insert Column View DBlock" org-insert-columns-dblock t])
20914 ("Dates and Scheduling"
20915 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20916 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20917 ("Change Date"
20918 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20919 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20920 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20921 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20922 ["Compute Time Range" org-evaluate-time-range t]
20923 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20924 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20925 "--"
20926 ["Custom time format" org-toggle-time-stamp-overlays
20927 :style radio :selected org-display-custom-times]
20928 "--"
20929 ["Goto Calendar" org-goto-calendar t]
20930 ["Date from Calendar" org-date-from-calendar t]
20931 "--"
20932 ["Start/Restart Timer" org-timer-start t]
20933 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20934 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20935 ["Insert Timer String" org-timer t]
20936 ["Insert Timer Item" org-timer-item t])
20937 ("Logging work"
20938 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20939 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20940 ["Clock out" org-clock-out t]
20941 ["Clock cancel" org-clock-cancel t]
20942 "--"
20943 ["Mark as default task" org-clock-mark-default-task t]
20944 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20945 ["Goto running clock" org-clock-goto t]
20946 "--"
20947 ["Display times" org-clock-display t]
20948 ["Create clock table" org-clock-report t]
20949 "--"
20950 ["Record DONE time"
20951 (progn (setq org-log-done (not org-log-done))
20952 (message "Switching to %s will %s record a timestamp"
20953 (car org-done-keywords)
20954 (if org-log-done "automatically" "not")))
20955 :style toggle :selected org-log-done])
20956 "--"
20957 ["Agenda Command..." org-agenda t]
20958 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20959 ("File List for Agenda")
20960 ("Special views current file"
20961 ["TODO Tree" org-show-todo-tree t]
20962 ["Check Deadlines" org-check-deadlines t]
20963 ["Timeline" org-timeline t]
20964 ["Tags/Property tree" org-match-sparse-tree t])
20965 "--"
20966 ["Export/Publish..." org-export-dispatch t]
20967 ("LaTeX"
20968 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20969 :selected org-cdlatex-mode]
20970 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20971 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20972 ["Modify math symbol" org-cdlatex-math-modify
20973 (org-inside-LaTeX-fragment-p)]
20974 ["Insert citation" org-reftex-citation t]
20975 "--"
20976 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20977 "--"
20978 ("MobileOrg"
20979 ["Push Files and Views" org-mobile-push t]
20980 ["Get Captured and Flagged" org-mobile-pull t]
20981 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20982 "--"
20983 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20984 "--"
20985 ("Documentation"
20986 ["Show Version" org-version t]
20987 ["Info Documentation" org-info t])
20988 ("Customize"
20989 ["Browse Org Group" org-customize t]
20990 "--"
20991 ["Expand This Menu" org-create-customize-menu
20992 (fboundp 'customize-menu-create)])
20993 ["Send bug report" org-submit-bug-report t]
20994 "--"
20995 ("Refresh/Reload"
20996 ["Refresh setup current buffer" org-mode-restart t]
20997 ["Reload Org (after update)" org-reload t]
20998 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20999 ))
21001 (defun org-info (&optional node)
21002 "Read documentation for Org-mode in the info system.
21003 With optional NODE, go directly to that node."
21004 (interactive)
21005 (info (format "(org)%s" (or node ""))))
21007 ;;;###autoload
21008 (defun org-submit-bug-report ()
21009 "Submit a bug report on Org-mode via mail.
21011 Don't hesitate to report any problems or inaccurate documentation.
21013 If you don't have setup sending mail from (X)Emacs, please copy the
21014 output buffer into your mail program, as it gives us important
21015 information about your Org-mode version and configuration."
21016 (interactive)
21017 (require 'reporter)
21018 (org-load-modules-maybe)
21019 (org-require-autoloaded-modules)
21020 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21021 (reporter-submit-bug-report
21022 "emacs-orgmode@gnu.org"
21023 (org-version nil 'full)
21024 (let (list)
21025 (save-window-excursion
21026 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21027 (delete-other-windows)
21028 (erase-buffer)
21029 (insert "You are about to submit a bug report to the Org-mode mailing list.
21031 We would like to add your full Org-mode and Outline configuration to the
21032 bug report. This greatly simplifies the work of the maintainer and
21033 other experts on the mailing list.
21035 HOWEVER, some variables you have customized may contain private
21036 information. The names of customers, colleagues, or friends, might
21037 appear in the form of file names, tags, todo states, or search strings.
21038 If you answer yes to the prompt, you might want to check and remove
21039 such private information before sending the email.")
21040 (add-text-properties (point-min) (point-max) '(face org-warning))
21041 (when (yes-or-no-p "Include your Org-mode configuration ")
21042 (mapatoms
21043 (lambda (v)
21044 (and (boundp v)
21046 (or (and (symbol-value v)
21048 (and
21049 (get v 'custom-type) (get v 'standard-value)
21050 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21051 (push v list)))))
21052 (kill-buffer (get-buffer "*Warn about privacy*"))
21053 list))
21054 nil nil
21055 "Remember to cover the basics, that is, what you expected to happen and
21056 what in fact did happen. You don't know how to make a good report? See
21058 http://orgmode.org/manual/Feedback.html#Feedback
21060 Your bug report will be posted to the Org-mode mailing list.
21061 ------------------------------------------------------------------------")
21062 (save-excursion
21067 (defun org-install-agenda-files-menu ()
21068 (let ((bl (buffer-list)))
21069 (save-excursion
21070 (while bl
21071 (set-buffer (pop bl))
21072 (if (derived-mode-p 'org-mode) (setq bl nil)))
21073 (when (derived-mode-p 'org-mode)
21074 (easy-menu-change
21075 '("Org") "File List for Agenda"
21076 (append
21077 (list
21078 ["Edit File List" (org-edit-agenda-file-list) t]
21079 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21080 ["Remove Current File from List" org-remove-file t]
21081 ["Cycle through agenda files" org-cycle-agenda-files t]
21082 ["Occur in all agenda files" org-occur-in-agenda-files t]
21083 "--")
21084 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21086 ;;;; Documentation
21088 (defun org-require-autoloaded-modules ()
21089 (interactive)
21090 (mapc 'require
21091 '(org-agenda org-archive org-attach org-clock org-colview org-id
21092 org-remember org-table org-timer)))
21094 ;;;###autoload
21095 (defun org-reload (&optional uncompiled)
21096 "Reload all org lisp files.
21097 With prefix arg UNCOMPILED, load the uncompiled versions."
21098 (interactive "P")
21099 (require 'loadhist)
21100 (let* ((org-dir (org-find-library-dir "org"))
21101 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21103 (remove-re (mapconcat 'identity
21104 (mapcar (lambda (f) (concat "^" f "$"))
21105 (list (if (featurep 'xemacs)
21106 "org-colview"
21107 "org-colview-xemacs")
21108 "org" "org-loaddefs" "org-version"))
21110 (feats (delete-dups
21111 (mapcar 'file-name-sans-extension
21112 (mapcar 'file-name-nondirectory
21113 (delq nil
21114 (mapcar 'feature-file
21115 features))))))
21116 (lfeat (append
21117 (sort
21118 (setq feats
21119 (delq nil (mapcar
21120 (lambda (f)
21121 (if (and (string-match feature-re f)
21122 (not (string-match remove-re f)))
21123 f nil))
21124 feats)))
21125 'string-lessp)
21126 (list "org-version" "org")))
21127 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21128 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21129 load-uncore load-misses)
21130 (setq load-misses
21131 (delq 't
21132 (mapcar (lambda (f)
21133 (or (org-load-noerror-mustsuffix (concat org-dir f))
21134 (and (string= org-dir contrib-dir)
21135 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21136 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21137 (add-to-list 'load-uncore f 'append)
21138 't)
21139 f))
21140 lfeat)))
21141 (if load-uncore
21143 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21144 (if load-misses
21146 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21149 ;;;###autoload
21150 (defun org-customize ()
21151 "Call the customize function with org as argument."
21152 (interactive)
21153 (org-load-modules-maybe)
21154 (org-require-autoloaded-modules)
21155 (customize-browse 'org))
21157 (defun org-create-customize-menu ()
21158 "Create a full customization menu for Org-mode, insert it into the menu."
21159 (interactive)
21160 (org-load-modules-maybe)
21161 (org-require-autoloaded-modules)
21162 (if (fboundp 'customize-menu-create)
21163 (progn
21164 (easy-menu-change
21165 '("Org") "Customize"
21166 `(["Browse Org group" org-customize t]
21167 "--"
21168 ,(customize-menu-create 'org)
21169 ["Set" Custom-set t]
21170 ["Save" Custom-save t]
21171 ["Reset to Current" Custom-reset-current t]
21172 ["Reset to Saved" Custom-reset-saved t]
21173 ["Reset to Standard Settings" Custom-reset-standard t]))
21175 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21177 ;;;; Miscellaneous stuff
21179 ;;; Generally useful functions
21181 (defun org-get-at-bol (property)
21182 "Get text property PROPERTY at beginning of line."
21183 (get-text-property (point-at-bol) property))
21185 (defun org-find-text-property-in-string (prop s)
21186 "Return the first non-nil value of property PROP in string S."
21187 (or (get-text-property 0 prop s)
21188 (get-text-property (or (next-single-property-change 0 prop s) 0)
21189 prop s)))
21191 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21192 "Display the given MESSAGE as a warning."
21193 (if (fboundp 'display-warning)
21194 (display-warning 'org message
21195 (if (featurep 'xemacs) 'warning :warning))
21196 (let ((buf (get-buffer-create "*Org warnings*")))
21197 (with-current-buffer buf
21198 (goto-char (point-max))
21199 (insert "Warning (Org): " message)
21200 (unless (bolp)
21201 (newline)))
21202 (display-buffer buf)
21203 (sit-for 0))))
21205 (defun org-eval (form)
21206 "Eval FORM and return result."
21207 (condition-case error
21208 (eval form)
21209 (error (format "%%![Error: %s]" error))))
21211 (defun org-in-clocktable-p ()
21212 "Check if the cursor is in a clocktable."
21213 (let ((pos (point)) start)
21214 (save-excursion
21215 (end-of-line 1)
21217 (setq start (match-beginning 0))
21219 (>= (match-end 0) pos)
21220 start))))
21222 (defun org-in-commented-line ()
21223 "Is point in a line starting with `#'?"
21224 (equal (char-after (point-at-bol)) ?#))
21226 (defun org-in-indented-comment-line ()
21227 "Is point in a line starting with `#' after some white space?"
21228 (save-excursion
21229 (save-match-data
21230 (goto-char (point-at-bol))
21233 (defun org-in-verbatim-emphasis ()
21234 (save-match-data
21235 (and (org-in-regexp org-emph-re 2)
21236 (>= (point) (match-beginning 3))
21237 (<= (point) (match-end 4))
21238 (member (match-string 3) '("=" "~")))))
21240 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21241 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21242 (if (and marker (marker-buffer marker)
21243 (buffer-live-p (marker-buffer marker)))
21244 (progn
21245 (org-pop-to-buffer-same-window (marker-buffer marker))
21246 (if (or (> marker (point-max)) (< marker (point-min)))
21247 (widen))
21248 (goto-char marker)
21249 (org-show-context 'org-goto))
21250 (if bookmark
21251 (bookmark-jump bookmark)
21252 (error "Cannot find location"))))
21254 (defun org-quote-csv-field (s)
21255 "Quote field for inclusion in CSV material."
21258 s))
21260 (defun org-force-self-insert (N)
21261 "Needed to enforce self-insert under remapping."
21262 (interactive "p")
21263 (self-insert-command N))
21265 (defun org-string-width (s)
21266 "Compute width of string, ignoring invisible characters.
21267 This ignores character with invisibility property `org-link', and also
21268 characters with property `org-cwidth', because these will become invisible
21269 upon the next fontification round."
21270 (let (b l)
21271 (when (or (eq t buffer-invisibility-spec)
21272 (assq 'org-link buffer-invisibility-spec))
21273 (while (setq b (text-property-any 0 (length s)
21274 'invisible 'org-link s))
21275 (setq s (concat (substring s 0 b)
21276 (substring s (or (next-single-property-change
21277 b 'invisible s) (length s)))))))
21278 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21279 (setq s (concat (substring s 0 b)
21280 (substring s (or (next-single-property-change
21281 b 'org-cwidth s) (length s))))))
21282 (setq l (string-width s) b -1)
21283 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21284 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21285 l))
21287 (defun org-shorten-string (s maxlength)
21288 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21289 If the string is shorter or has length MAXLENGTH, just return the
21290 original string. If it is longer, the functions finds a space in the
21291 string, breaks this string off at that locations and adds three dots
21292 as ellipsis. Including the ellipsis, the string will not be longer
21293 than MAXLENGTH. If finding a good breaking point in the string does
21294 not work, the string is just chopped off in the middle of a word
21295 if necessary."
21296 (if (<= (length s) maxlength)
21297 s
21298 (let* ((n (max (- maxlength 4) 1))
21300 (if (string-match re s)
21301 (concat (match-string 1 s) "...")
21302 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21304 (defun org-get-indentation (&optional line)
21305 "Get the indentation of the current line, interpreting tabs.
21306 When LINE is given, assume it represents a line and compute its indentation."
21307 (if line
21308 (if (string-match "^ *" (org-remove-tabs line))
21309 (match-end 0))
21310 (save-excursion
21311 (beginning-of-line 1)
21313 (current-column))))
21315 (defun org-get-string-indentation (s)
21316 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21317 (let ((n -1) (i 0) (w tab-width) c)
21318 (catch 'exit
21319 (while (< (setq n (1+ n)) (length s))
21320 (setq c (aref s n))
21321 (cond ((= c ?\ ) (setq i (1+ i)))
21323 (t (throw 'exit t)))))
21324 i))
21326 (defun org-remove-tabs (s &optional width)
21327 "Replace tabulators in S with spaces.
21328 Assumes that s is a single line, starting in column 0."
21329 (setq width (or width tab-width))
21331 (setq s (replace-match
21332 (make-string
21333 (- (* width (/ (+ (match-beginning 0) width) width))
21334 (match-beginning 0)) ?\ )
21335 t t s)))
21336 s)
21338 (defun org-fix-indentation (line ind)
21339 "Fix indentation in LINE.
21340 IND is a cons cell with target and minimum indentation.
21341 If the current indentation in LINE is smaller than the minimum,
21342 leave it alone. If it is larger than ind, set it to the target."
21343 (let* ((l (org-remove-tabs line))
21344 (i (org-get-indentation l))
21345 (i1 (car ind)) (i2 (cdr ind)))
21346 (if (>= i i2) (setq l (substring line i2)))
21347 (if (> i1 0)
21348 (concat (make-string i1 ?\ ) l)
21349 l)))
21351 (defun org-remove-indentation (code &optional n)
21352 "Remove the maximum common indentation from the lines in CODE.
21353 N may optionally be the number of spaces to remove."
21354 (with-temp-buffer
21355 (insert code)
21356 (org-do-remove-indentation n)
21357 (buffer-string)))
21359 (defun org-do-remove-indentation (&optional n)
21360 "Remove the maximum common indentation from the buffer."
21361 (untabify (point-min) (point-max))
21362 (let ((min 10000) re)
21363 (if n
21364 (setq min n)
21365 (goto-char (point-min))
21367 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21368 (unless (or (= min 0) (= min 10000))
21370 (goto-char (point-min))
21371 (while (re-search-forward re nil t)
21372 (replace-match "")
21373 (end-of-line 1))
21374 min)))
21376 (defun org-fill-template (template alist)
21377 "Find each %key of ALIST in TEMPLATE and replace it."
21378 (let ((case-fold-search nil)
21379 entry key value)
21380 (setq alist (sort (copy-sequence alist)
21381 (lambda (a b) (< (length (car a)) (length (car b))))))
21382 (while (setq entry (pop alist))
21383 (setq template
21384 (replace-regexp-in-string
21385 (concat "%" (regexp-quote (car entry)))
21386 (or (cdr entry) "") template t t)))
21387 template))
21389 (defun org-base-buffer (buffer)
21390 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21391 (if (not buffer)
21392 buffer
21393 (or (buffer-base-buffer buffer)
21394 buffer)))
21396 (defun org-trim (s)
21397 "Remove whitespace at beginning and end of string."
21400 s)
21402 (defun org-wrap (string &optional width lines)
21403 "Wrap string to either a number of lines, or a width in characters.
21404 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21405 that costs. If there is a word longer than WIDTH, the text is actually
21406 wrapped to the length of that word.
21407 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21408 many lines, whatever width that takes.
21409 The return value is a list of lines, without newlines at the end."
21411 (maxword (apply 'max (mapcar 'org-string-width words)))
21412 w ll)
21413 (cond (width
21414 (org-do-wrap words (max maxword width)))
21415 (lines
21416 (setq w maxword)
21417 (setq ll (org-do-wrap words maxword))
21418 (if (<= (length ll) lines)
21419 ll
21420 (setq ll words)
21421 (while (> (length ll) lines)
21422 (setq w (1+ w))
21423 (setq ll (org-do-wrap words w)))
21424 ll))
21425 (t (error "Cannot wrap this")))))
21427 (defun org-do-wrap (words width)
21428 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21429 (let (lines line)
21430 (while words
21431 (setq line (pop words))
21432 (while (and words (< (+ (length line) (length (car words))) width))
21433 (setq line (concat line " " (pop words))))
21434 (setq lines (push line lines)))
21435 (nreverse lines)))
21437 (defun org-split-string (string &optional separators)
21438 "Splits STRING into substrings at SEPARATORS.
21439 No empty strings are returned if there are matches at the beginning
21440 and end of string."
21442 (start 0)
21443 notfirst
21444 (list nil))
21445 (while (and (string-match rexp string
21446 (if (and notfirst
21447 (= start (match-beginning 0))
21448 (< start (length string)))
21449 (1+ start) start))
21450 (< (match-beginning 0) (length string)))
21451 (setq notfirst t)
21452 (or (eq (match-beginning 0) 0)
21453 (and (eq (match-beginning 0) (match-end 0))
21454 (eq (match-beginning 0) start))
21455 (setq list
21456 (cons (substring string start (match-beginning 0))
21457 list)))
21458 (setq start (match-end 0)))
21459 (or (eq start (length string))
21460 (setq list
21461 (cons (substring string start)
21462 list)))
21463 (nreverse list)))
21465 (defun org-quote-vert (s)
21467 (while (string-match "|" s)
21469 s)
21471 (defun org-uuidgen-p (s)
21472 "Is S an ID created by UUIDGEN?"
21473 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21475 (defun org-in-src-block-p (&optional inside)
21476 "Whether point is in a code source block.
21477 When INSIDE is non-nil, don't consider we are within a src block
21478 when point is at #+BEGIN_SRC or #+END_SRC."
21479 (let ((case-fold-search t) ov)
21480 (or (and (setq ov (overlays-at (point)))
21481 (memq 'org-block-background
21482 (overlay-properties (car ov))))
21483 (and (not inside)
21484 (save-match-data
21485 (save-excursion
21486 (beginning-of-line)
21489 (defun org-context ()
21490 "Return a list of contexts of the current cursor position.
21491 If several contexts apply, all are returned.
21492 Each context entry is a list with a symbol naming the context, and
21493 two positions indicating start and end of the context. Possible
21494 contexts are:
21496 :headline anywhere in a headline
21497 :headline-stars on the leading stars in a headline
21498 :todo-keyword on a TODO keyword (including DONE) in a headline
21499 :tags on the TAGS in a headline
21500 :priority on the priority cookie in a headline
21501 :item on the first line of a plain list item
21502 :item-bullet on the bullet/number of a plain list item
21503 :checkbox on the checkbox in a plain list item
21504 :table in an org-mode table
21505 :table-special on a special filed in a table
21506 :table-table in a table.el table
21507 :clocktable in a clocktable
21508 :src-block in a source block
21509 :link on a hyperlink
21510 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21511 :target on a <<target>>
21512 :radio-target on a <<<radio-target>>>
21513 :latex-fragment on a LaTeX fragment
21514 :latex-preview on a LaTeX fragment with overlaid preview image
21516 This function expects the position to be visible because it uses font-lock
21517 faces as a help to recognize the following contexts: :table-special, :link,
21518 and :keyword."
21519 (let* ((f (get-text-property (point) 'face))
21520 (faces (if (listp f) f (list f)))
21521 (case-fold-search t)
21522 (p (point)) clist o)
21523 ;; First the large context
21524 (cond
21525 ((org-at-heading-p t)
21526 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21527 (when (progn
21528 (beginning-of-line 1)
21529 (looking-at org-todo-line-tags-regexp))
21530 (push (org-point-in-group p 1 :headline-stars) clist)
21531 (push (org-point-in-group p 2 :todo-keyword) clist)
21532 (push (org-point-in-group p 4 :tags) clist))
21533 (goto-char p)
21536 (push (org-point-in-group p 0 :priority) clist)))
21538 ((org-at-item-p)
21539 (push (org-point-in-group p 2 :item-bullet) clist)
21540 (push (list :item (point-at-bol)
21541 (save-excursion (org-end-of-item) (point)))
21542 clist)
21543 (and (org-at-item-checkbox-p)
21544 (push (org-point-in-group p 0 :checkbox) clist)))
21546 ((org-at-table-p)
21547 (push (list :table (org-table-begin) (org-table-end)) clist)
21548 (if (memq 'org-formula faces)
21549 (push (list :table-special
21550 (previous-single-property-change p 'face)
21551 (next-single-property-change p 'face)) clist)))
21552 ((org-at-table-p 'any)
21553 (push (list :table-table) clist)))
21554 (goto-char p)
21556 (let ((case-fold-search t))
21557 ;; New the "medium" contexts: clocktables, source blocks
21558 (cond ((org-in-clocktable-p)
21559 (push (list :clocktable
21561 (search-backward "#+BEGIN: clocktable" nil t))
21562 (match-beginning 0))
21564 (match-end 0))) clist))
21565 ((org-in-src-block-p)
21566 (push (list :src-block
21568 (search-backward "#+BEGIN_SRC" nil t))
21569 (match-beginning 0))
21570 (and (search-forward "#+END_SRC" nil t)
21571 (match-beginning 0))) clist))))
21572 (goto-char p)
21574 ;; Now the small context
21575 (cond
21576 ((org-at-timestamp-p)
21577 (push (org-point-in-group p 0 :timestamp) clist))
21578 ((memq 'org-link faces)
21579 (push (list :link
21580 (previous-single-property-change p 'face)
21581 (next-single-property-change p 'face)) clist))
21582 ((memq 'org-special-keyword faces)
21583 (push (list :keyword
21584 (previous-single-property-change p 'face)
21585 (next-single-property-change p 'face)) clist))
21586 ((org-at-target-p)
21587 (push (org-point-in-group p 0 :target) clist)
21588 (goto-char (1- (match-beginning 0)))
21589 (if (looking-at org-radio-target-regexp)
21590 (push (org-point-in-group p 0 :radio-target) clist))
21591 (goto-char p))
21592 ((setq o (car (delq nil
21593 (mapcar
21594 (lambda (x)
21595 (if (memq x org-latex-fragment-image-overlays) x))
21596 (overlays-at (point))))))
21597 (push (list :latex-fragment
21598 (overlay-start o) (overlay-end o)) clist)
21599 (push (list :latex-preview
21600 (overlay-start o) (overlay-end o)) clist))
21601 ((org-inside-LaTeX-fragment-p)
21602 ;; FIXME: positions wrong.
21603 (push (list :latex-fragment (point) (point)) clist)))
21605 (setq clist (nreverse (delq nil clist)))
21606 clist))
21608 ;; FIXME: Compare with at-regexp-p Do we need both?
21609 (defun org-in-regexp (re &optional nlines visually)
21610 "Check if point is inside a match of regexp.
21611 Normally only the current line is checked, but you can include NLINES extra
21612 lines both before and after point into the search.
21613 If VISUALLY is set, require that the cursor is not after the match but
21614 really on, so that the block visually is on the match."
21615 (catch 'exit
21616 (let ((pos (point))
21617 (eol (point-at-eol (+ 1 (or nlines 0))))
21618 (inc (if visually 1 0)))
21619 (save-excursion
21620 (beginning-of-line (- 1 (or nlines 0)))
21621 (while (re-search-forward re eol t)
21622 (if (and (<= (match-beginning 0) pos)
21623 (>= (+ inc (match-end 0)) pos))
21624 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21626 (defun org-at-regexp-p (regexp)
21627 "Is point inside a match of REGEXP in the current line?"
21628 (catch 'exit
21629 (save-excursion
21630 (let ((pos (point)) (end (point-at-eol)))
21631 (beginning-of-line 1)
21632 (while (re-search-forward regexp end t)
21633 (if (and (<= (match-beginning 0) pos)
21634 (>= (match-end 0) pos))
21635 (throw 'exit t)))
21636 nil))))
21638 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21639 "Non-nil when point is between matches of START-RE and END-RE.
21641 Also return a non-nil value when point is on one of the matches.
21643 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21644 buffer positions. Default values are the positions of headlines
21645 surrounding the point.
21647 The functions returns a cons cell whose car (resp. cdr) is the
21648 position before START-RE (resp. after END-RE)."
21649 (save-match-data
21650 (let ((pos (point))
21651 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21652 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21653 beg end)
21654 (save-excursion
21655 ;; Point is on a block when on START-RE or if START-RE can be
21656 ;; found before it...
21657 (and (or (org-at-regexp-p start-re)
21658 (re-search-backward start-re limit-up t))
21659 (setq beg (match-beginning 0))
21660 ;; ... and END-RE after it...
21661 (goto-char (match-end 0))
21662 (re-search-forward end-re limit-down t)
21663 (> (setq end (match-end 0)) pos)
21664 ;; ... without another START-RE in-between.
21665 (goto-char (match-beginning 0))
21666 (not (re-search-backward start-re (1+ beg) t))
21667 ;; Return value.
21668 (cons beg end))))))
21670 (defun org-in-block-p (names)
21671 "Non-nil when point belongs to a block whose name belongs to NAMES.
21673 NAMES is a list of strings containing names of blocks.
21675 Return first block name matched, or nil. Beware that in case of
21676 nested blocks, the returned name may not belong to the closest
21677 block from point."
21678 (save-match-data
21679 (catch 'exit
21680 (let ((case-fold-search t)
21681 (lim-up (save-excursion (outline-previous-heading)))
21682 (lim-down (save-excursion (outline-next-heading))))
21683 (mapc (lambda (name)
21684 (let ((n (regexp-quote name)))
21685 (when (org-between-regexps-p
21688 lim-up lim-down)
21689 (throw 'exit n))))
21690 names))
21691 nil)))
21693 (defun org-in-drawer-p ()
21694 "Non-nil if point is within a drawer.
21695 If point is within a drawer, return it, as parsed data."
21696 (let ((element (save-match-data (org-element-at-point))))
21697 (while (and element (not (memq (org-element-type element)
21698 '(drawer property-drawer))))
21699 (setq element (org-element-property :parent element)))
21700 element))
21702 (defun org-occur-in-agenda-files (regexp &optional nlines)
21703 "Call `multi-occur' with buffers for all agenda files."
21705 (let* ((files (org-agenda-files))
21706 (tnames (mapcar 'file-truename files))
21707 (extra org-agenda-text-search-extra-files)
21708 f)
21709 (when (eq (car extra) 'agenda-archives)
21710 (setq extra (cdr extra))
21711 (setq files (org-add-archive-files files)))
21712 (while (setq f (pop extra))
21713 (unless (member (file-truename f) tnames)
21714 (add-to-list 'files f 'append)
21715 (add-to-list 'tnames (file-truename f) 'append)))
21716 (multi-occur
21717 (mapcar (lambda (x)
21718 (with-current-buffer
21719 (or (get-file-buffer x) (find-file-noselect x))
21720 (widen)
21721 (current-buffer)))
21722 files)
21723 regexp)))
21725 (if (boundp 'occur-mode-find-occurrence-hook)
21726 ;; Emacs 23
21727 (add-hook 'occur-mode-find-occurrence-hook
21728 (lambda ()
21729 (when (derived-mode-p 'org-mode)
21730 (org-reveal))))
21731 ;; Emacs 22
21732 (defadvice occur-mode-goto-occurrence
21733 (after org-occur-reveal activate)
21734 (and (derived-mode-p 'org-mode) (org-reveal)))
21735 (defadvice occur-mode-goto-occurrence-other-window
21736 (after org-occur-reveal activate)
21737 (and (derived-mode-p 'org-mode) (org-reveal)))
21738 (defadvice occur-mode-display-occurrence
21739 (after org-occur-reveal activate)
21740 (when (derived-mode-p 'org-mode)
21741 (let ((pos (occur-mode-find-occurrence)))
21742 (with-current-buffer (marker-buffer pos)
21743 (save-excursion
21744 (goto-char pos)
21745 (org-reveal)))))))
21747 (defun org-occur-link-in-agenda-files ()
21748 "Create a link and search for it in the agendas.
21749 The link is not stored in `org-stored-links', it is just created
21750 for the search purpose."
21751 (interactive)
21752 (let ((link (condition-case nil
21753 (org-store-link nil)
21754 (error "Unable to create a link to here"))))
21755 (org-occur-in-agenda-files (regexp-quote link))))
21757 (defun org-reverse-string (string)
21758 "Return the reverse of STRING."
21759 (apply 'string (reverse (string-to-list string))))
21761 (defsubst org-uniquify (list)
21762 "Non-destructively remove duplicate elements from LIST."
21763 (let ((res (copy-sequence list))) (delete-dups res)))
21765 (defun org-uniquify-alist (alist)
21766 "Merge elements of ALIST with the same key.
21768 For example, in this alist:
21770 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21771 => '((a 1 3) (b 2))
21773 merge (a 1) and (a 3) into (a 1 3).
21775 The function returns the new ALIST."
21776 (let (rtn)
21777 (mapc
21778 (lambda (e)
21779 (let (n)
21780 (if (not (assoc (car e) rtn))
21781 (push e rtn)
21782 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21783 (setq rtn (assq-delete-all (car e) rtn))
21784 (push n rtn))))
21785 alist)
21786 rtn))
21788 (defun org-delete-all (elts list)
21789 "Remove all elements in ELTS from LIST."
21790 (while elts
21791 (setq list (delete (pop elts) list)))
21792 list)
21794 (defun org-count (cl-item cl-seq)
21795 "Count the number of occurrences of ITEM in SEQ.
21796 Taken from `count' in cl-seq.el with all keyword arguments removed."
21797 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21798 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21799 (while (< cl-start cl-end)
21800 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21801 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21802 (setq cl-start (1+ cl-start)))
21803 cl-count))
21805 (defun org-remove-if (predicate seq)
21806 "Remove everything from SEQ that fulfills PREDICATE."
21807 (let (res e)
21808 (while seq
21809 (setq e (pop seq))
21810 (if (not (funcall predicate e)) (push e res)))
21811 (nreverse res)))
21813 (defun org-remove-if-not (predicate seq)
21814 "Remove everything from SEQ that does not fulfill PREDICATE."
21815 (let (res e)
21816 (while seq
21817 (setq e (pop seq))
21818 (if (funcall predicate e) (push e res)))
21819 (nreverse res)))
21821 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21822 "Reduce two-argument FUNCTION across SEQ.
21823 Taken from `reduce' in cl-seq.el with all keyword arguments but
21825 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21826 (cadr (memq :initial-value cl-keys)))
21827 (cl-seq (pop cl-seq))
21828 (t (funcall cl-func)))))
21829 (while cl-seq
21830 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21831 cl-accum))
21833 (defun org-every (pred seq)
21834 "Return true if PREDICATE is true of every element of SEQ.
21835 Adapted from `every' in cl.el."
21836 (catch 'org-every
21837 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21838 t))
21840 (defun org-some (pred seq)
21841 "Return true if PREDICATE is true of any element of SEQ.
21842 Adapted from `some' in cl.el."
21843 (catch 'org-some
21844 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21845 nil))
21847 (defun org-back-over-empty-lines ()
21848 "Move backwards over whitespace, to the beginning of the first empty line.
21849 Returns the number of empty lines passed."
21850 (let ((pos (point)))
21851 (if (cdr (assoc 'heading org-blank-before-new-entry))
21853 (unless (eobp)
21854 (forward-line -1)))
21855 (beginning-of-line 2)
21856 (goto-char (min (point) pos))
21857 (count-lines (point) pos)))
21859 (defun org-skip-whitespace ()
21862 (defun org-point-in-group (point group &optional context)
21863 "Check if POINT is in match-group GROUP.
21864 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21865 match. If the match group does not exist or point is not inside it,
21866 return nil."
21867 (and (match-beginning group)
21868 (>= point (match-beginning group))
21869 (<= point (match-end group))
21870 (if context
21871 (list context (match-beginning group) (match-end group))
21872 t)))
21874 (defun org-switch-to-buffer-other-window (&rest args)
21875 "Switch to buffer in a second window on the current frame.
21876 In particular, do not allow pop-up frames.
21877 Returns the newly created buffer."
21878 (org-no-popups
21879 (apply 'switch-to-buffer-other-window args)))
21881 (defun org-combine-plists (&rest plists)
21882 "Create a single property list from all plists in PLISTS.
21883 The process starts by copying the first list, and then setting properties
21884 from the other lists. Settings in the last list are the most significant
21885 ones and overrule settings in the other lists."
21886 (let ((rtn (copy-sequence (pop plists)))
21887 p v ls)
21888 (while plists
21889 (setq ls (pop plists))
21890 (while ls
21891 (setq p (pop ls) v (pop ls))
21892 (setq rtn (plist-put rtn p v))))
21893 rtn))
21895 (defun org-replace-escapes (string table)
21896 "Replace %-escapes in STRING with values in TABLE.
21898 The sequences in STRING may contain normal field width and padding information,
21900 so values can contain further %-escapes if they are define later in TABLE."
21901 (let ((tbl (copy-alist table))
21902 (case-fold-search nil)
21903 (pchg 0)
21904 e re rpl)
21905 (while (setq e (pop tbl))
21906 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21907 (when (and (cdr e) (string-match re (cdr e)))
21908 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21909 (safe "SREF"))
21910 (add-text-properties 0 3 (list 'sref sref) safe)
21911 (setcdr e (replace-match safe t t (cdr e)))))
21912 (while (string-match re string)
21913 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21914 (cdr e)))
21915 (setq string (replace-match rpl t t string))))
21916 (while (setq pchg (next-property-change pchg string))
21917 (let ((sref (get-text-property pchg 'sref string)))
21918 (when (and sref (string-match "SREF" string pchg))
21919 (setq string (replace-match sref t t string)))))
21920 string))
21922 (defun org-sublist (list start end)
21923 "Return a section of LIST, from START to END.
21924 Counting starts at 1."
21925 (let (rtn (c start))
21926 (setq list (nthcdr (1- start) list))
21927 (while (and list (<= c end))
21928 (push (pop list) rtn)
21929 (setq c (1+ c)))
21930 (nreverse rtn)))
21932 (defun org-find-base-buffer-visiting (file)
21933 "Like `find-buffer-visiting' but always return the base buffer and
21934 not an indirect buffer."
21935 (let ((buf (or (get-file-buffer file)
21936 (find-buffer-visiting file))))
21937 (if buf
21938 (or (buffer-base-buffer buf) buf)
21939 nil)))
21941 (defun org-image-file-name-regexp (&optional extensions)
21942 "Return regexp matching the file names of images.
21943 If EXTENSIONS is given, only match these."
21944 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21945 (image-file-name-regexp)
21946 (let ((image-file-name-extensions
21947 (or extensions
21948 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21949 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21951 (regexp-opt (nconc (mapcar 'upcase
21952 image-file-name-extensions)
21953 image-file-name-extensions)
21954 t)
21957 (defun org-file-image-p (file &optional extensions)
21958 "Return non-nil if FILE is an image."
21959 (save-match-data
21960 (string-match (org-image-file-name-regexp extensions) file)))
21962 (defun org-get-cursor-date (&optional with-time)
21963 "Return the date at cursor in as a time.
21964 This works in the calendar and in the agenda, anywhere else it just
21965 returns the current time.
21966 If WITH-TIME is non-nil, returns the time of the event at point (in
21967 the agenda) or the current time of the day."
21968 (let (date day defd tp tm hod mod)
21969 (when with-time
21970 (setq tp (get-text-property (point) 'time))
21972 (setq hod (string-to-number (match-string 1 tp))
21973 mod (string-to-number (match-string 2 tp))))
21974 (or tp (setq hod (nth 2 (decode-time (current-time)))
21975 mod (nth 1 (decode-time (current-time))))))
21976 (cond
21977 ((eq major-mode 'calendar-mode)
21978 (setq date (calendar-cursor-to-date)
21979 defd (encode-time 0 (or mod 0) (or hod 0)
21980 (nth 1 date) (nth 0 date) (nth 2 date))))
21981 ((eq major-mode 'org-agenda-mode)
21982 (setq day (get-text-property (point) 'day))
21983 (if day
21984 (setq date (calendar-gregorian-from-absolute day)
21985 defd (encode-time 0 (or mod 0) (or hod 0)
21986 (nth 1 date) (nth 0 date) (nth 2 date))))))
21987 (or defd (current-time))))
21989 (defun org-mark-subtree (&optional up)
21990 "Mark the current subtree.
21991 This puts point at the start of the current subtree, and mark at
21992 the end. If a numeric prefix UP is given, move up into the
21993 hierarchy of headlines by UP levels before marking the subtree."
21994 (interactive "P")
21995 (org-with-limited-levels
21996 (cond ((org-at-heading-p) (beginning-of-line))
21997 ((org-before-first-heading-p) (user-error "Not in a subtree"))
21998 (t (outline-previous-visible-heading 1))))
21999 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22000 (if (org-called-interactively-p 'any)
22001 (call-interactively 'org-mark-element)
22002 (org-mark-element)))
22005 ;;; Indentation
22007 (defun org-indent-line ()
22008 "Indent line depending on context."
22009 (interactive)
22010 (let* ((pos (point))
22011 (itemp (org-at-item-p))
22012 (case-fold-search t)
22014 (inline-task-p (and (featurep 'org-inlinetask)
22015 (org-inlinetask-in-task-p)))
22016 (inline-re (and inline-task-p
22017 (org-inlinetask-outline-regexp)))
22018 column)
22019 (if (and orgstruct-is-++ (eq pos (point)))
22020 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22021 (indent-according-to-mode))
22022 (beginning-of-line 1)
22023 (cond
22024 ;; Headings
22025 ((looking-at org-outline-regexp) (setq column 0))
22026 ;; Footnote definition
22027 ((looking-at org-footnote-definition-re) (setq column 0))
22028 ;; Literal examples
22030 (setq column (org-get-indentation))) ; do nothing
22031 ;; Lists
22032 ((ignore-errors (goto-char (org-in-item-p)))
22033 (setq column (if itemp
22034 (org-get-indentation)
22035 (org-list-item-body-column (point))))
22036 (goto-char pos))
22037 ;; Drawers
22039 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22040 (save-excursion
22041 (goto-char (1- (match-beginning 1)))
22042 (setq column (current-column))))
22043 ;; Special blocks
22045 (save-excursion
22046 (re-search-backward
22048 (setq column (org-get-indentation (match-string 0))))
22051 (save-excursion
22053 (setq column
22054 (cond ((equal (downcase (match-string 1)) "src")
22055 ;; src blocks: let `org-edit-src-exit' handle them
22056 (org-get-indentation))
22057 ((equal (downcase (match-string 1)) "example")
22058 (max (org-get-indentation)
22059 (org-get-indentation (match-string 0))))
22060 (t
22061 (org-get-indentation (match-string 0))))))
22062 ;; This line has nothing special, look at the previous relevant
22063 ;; line to compute indentation
22064 (t
22065 (beginning-of-line 0)
22066 (while (and (not (bobp))
22067 (not (looking-at org-table-line-regexp))
22068 (not (looking-at org-drawer-regexp))
22069 ;; When point started in an inline task, do not move
22070 ;; above task starting line.
22071 (not (and inline-task-p (looking-at inline-re)))
22072 ;; Skip drawers, blocks, empty lines, verbatim,
22073 ;; comments, tables, footnotes definitions, lists,
22074 ;; inline tasks.
22076 (re-search-backward org-drawer-regexp nil t))
22080 (looking-at org-footnote-definition-re)
22081 (and (not inline-task-p)
22082 (featurep 'org-inlinetask)
22083 (org-inlinetask-in-task-p)
22084 (or (org-inlinetask-goto-beginning) t))))
22085 (beginning-of-line 0))
22086 (cond
22087 ;; There was a list item above.
22088 ((ignore-errors (goto-char (org-in-item-p)))
22089 (goto-char (org-list-get-top-point (org-list-struct)))
22090 (setq column (org-get-indentation)))
22091 ;; There was an heading above.
22093 (if (not org-adapt-indentation)
22094 (setq column 0)
22095 (goto-char (match-end 0))
22096 (setq column (current-column))))
22097 ;; A drawer had started and is unfinished
22098 ((looking-at org-drawer-regexp)
22099 (goto-char (1- (match-beginning 1)))
22100 (setq column (current-column)))
22101 ;; Else, nothing noticeable found: get indentation and go on.
22102 (t (setq column (org-get-indentation))))))
22103 ;; Now apply indentation and move cursor accordingly
22104 (goto-char pos)
22105 (if (<= (current-column) (current-indentation))
22106 (org-indent-line-to column)
22107 (save-excursion (org-indent-line-to column)))
22108 ;; Special polishing for properties, see `org-property-format'
22109 (setq column (current-column))
22110 (beginning-of-line 1)
22111 (if (looking-at org-property-re)
22112 (replace-match (concat (match-string 4)
22113 (format org-property-format
22114 (match-string 1) (match-string 3)))
22115 t t))
22116 (org-move-to-column column))))
22118 (defun org-indent-drawer ()
22119 "Indent the drawer at point."
22120 (interactive)
22121 (let ((p (point))
22122 (e (and (save-excursion (re-search-forward ":END:" nil t))
22123 (match-end 0)))
22124 (folded
22125 (save-excursion
22126 (end-of-line)
22127 (when (overlays-at (point))
22128 (member 'invisible (overlay-properties
22129 (car (overlays-at (point)))))))))
22130 (when folded (org-cycle))
22131 (indent-for-tab-command)
22132 (while (and (move-beginning-of-line 2) (< (point) e))
22133 (indent-for-tab-command))
22134 (goto-char p)
22135 (when folded (org-cycle)))
22136 (message "Drawer at point indented"))
22138 (defun org-indent-block ()
22139 "Indent the block at point."
22140 (interactive)
22141 (let ((p (point))
22142 (case-fold-search t)
22144 (match-end 0)))
22145 (folded
22146 (save-excursion
22147 (end-of-line)
22148 (when (overlays-at (point))
22149 (member 'invisible (overlay-properties
22150 (car (overlays-at (point)))))))))
22151 (when folded (org-cycle))
22152 (indent-for-tab-command)
22153 (while (and (move-beginning-of-line 2) (< (point) e))
22154 (indent-for-tab-command))
22155 (goto-char p)
22156 (when folded (org-cycle)))
22157 (message "Block at point indented"))
22159 (defun org-indent-region (start end)
22160 "Indent region."
22161 (interactive "r")
22162 (save-excursion
22163 (let ((line-end (org-current-line end)))
22164 (goto-char start)
22165 (while (< (org-current-line) line-end)
22166 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22167 (t (call-interactively 'org-indent-line)))
22168 (move-beginning-of-line 2)))))
22171 ;;; Filling
22173 ;; We use our own fill-paragraph and auto-fill functions.
22175 ;; `org-fill-paragraph' relies on adaptive filling and context
22176 ;; checking. Appropriate `fill-prefix' is computed with
22177 ;; `org-adaptive-fill-function'.
22179 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22180 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22181 ;; `org-adaptive-fill-function' value. Internally,
22182 ;; `org-comment-line-break-function' breaks the line.
22184 ;; `org-setup-filling' installs filling and auto-filling related
22185 ;; variables during `org-mode' initialization.
22187 (defvar org-element-paragraph-separate) ; org-element.el
22188 (defun org-setup-filling ()
22189 (require 'org-element)
22190 ;; Prevent auto-fill from inserting unwanted new items.
22191 (when (boundp 'fill-nobreak-predicate)
22192 (org-set-local
22193 'fill-nobreak-predicate
22194 (org-uniquify
22195 (append fill-nobreak-predicate
22196 '(org-fill-line-break-nobreak-p
22197 org-fill-paragraph-with-timestamp-nobreak-p)))))
22198 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22199 (org-set-local 'paragraph-start paragraph-ending)
22200 (org-set-local 'paragraph-separate paragraph-ending))
22201 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22202 (org-set-local 'auto-fill-inhibit-regexp nil)
22203 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22204 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22205 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22207 (defun org-fill-line-break-nobreak-p ()
22208 "Non-nil when a new line at point would create an Org line break."
22209 (save-excursion
22214 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22215 "Non-nil when a new line at point would split a timestamp."
22216 (and (org-at-timestamp-p t)
22217 (not (looking-at org-ts-regexp-both))))
22219 (declare-function message-in-body-p "message" ())
22220 (defvar orgtbl-line-start-regexp) ; From org-table.el
22221 (defun org-adaptive-fill-function ()
22222 "Compute a fill prefix for the current line.
22223 Return fill prefix, as a string, or nil if current line isn't
22224 meant to be filled. For convenience, if `adaptive-fill-regexp'
22225 matches in paragraphs or comments, use it."
22226 (catch 'exit
22227 (when (derived-mode-p 'message-mode)
22228 (save-excursion
22229 (beginning-of-line)
22230 (cond ((or (not (message-in-body-p))
22231 (looking-at orgtbl-line-start-regexp))
22232 (throw 'exit nil))
22233 ((looking-at message-cite-prefix-regexp)
22234 (throw 'exit (match-string-no-properties 0)))
22235 ((looking-at org-outline-regexp)
22236 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22237 (org-with-wide-buffer
22238 (let* ((p (line-beginning-position))
22239 (element (save-excursion
22240 (beginning-of-line)
22241 (or (ignore-errors (org-element-at-point))
22242 (user-error "An element cannot be parsed line %d"
22243 (line-number-at-pos (point))))))
22244 (type (org-element-type element))
22245 (post-affiliated (org-element-property :post-affiliated element)))
22246 (unless (and post-affiliated (< p post-affiliated))
22247 (case type
22248 (comment
22249 (save-excursion
22250 (beginning-of-line)
22252 (concat (match-string 0) "# ")))
22253 (footnote-definition "")
22254 ((item plain-list)
22255 (make-string (org-list-item-body-column
22256 (or post-affiliated
22257 (org-element-property :begin element)))
22258 ? ))
22259 (paragraph
22260 ;; Fill prefix is usually the same as the current line,
22261 ;; unless the paragraph is at the beginning of an item.
22262 (let ((parent (org-element-property :parent element)))
22263 (save-excursion
22264 (beginning-of-line)
22265 (cond ((eq (org-element-type parent) 'item)
22266 (make-string (org-list-item-body-column
22267 (org-element-property :begin parent))
22268 ? ))
22269 ((and adaptive-fill-regexp
22270 ;; Locally disable
22271 ;; `adaptive-fill-function' to let
22272 ;; `fill-context-prefix' handle
22273 ;; `adaptive-fill-regexp' variable.
22274 (let (adaptive-fill-function)
22275 (fill-context-prefix
22276 post-affiliated
22277 (org-element-property :end element)))))
22279 (t "")))))
22280 (comment-block
22281 ;; Only fill contents if P is within block boundaries.
22282 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22283 (forward-line)
22284 (point)))
22285 (cend (save-excursion
22286 (goto-char (org-element-property :end element))
22288 (line-beginning-position))))
22289 (when (and (>= p cbeg) (< p cend))
22291 (match-string 0)
22292 ""))))))))))
22294 (declare-function message-goto-body "message" ())
22295 (defvar message-cite-prefix-regexp) ; From message.el
22296 (defun org-fill-paragraph (&optional justify)
22297 "Fill element at point, when applicable.
22299 This function only applies to comment blocks, comments, example
22300 blocks and paragraphs. Also, as a special case, re-align table
22301 when point is at one.
22303 If JUSTIFY is non-nil (interactively, with prefix argument),
22304 justify as well. If `sentence-end-double-space' is non-nil, then
22305 period followed by one space does not end a sentence, so don't
22306 break a line there. The variable `fill-column' controls the
22307 width for filling.
22309 For convenience, when point is at a plain list, an item or
22310 a footnote definition, try to fill the first paragraph within."
22311 (interactive)
22312 (if (and (derived-mode-p 'message-mode)
22313 (or (not (message-in-body-p))
22314 (save-excursion (move-beginning-of-line 1)
22315 (looking-at message-cite-prefix-regexp))))
22316 ;; First ensure filling is correct in message-mode.
22317 (let ((fill-paragraph-function
22318 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22319 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22320 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22321 (paragraph-separate
22322 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22323 (fill-paragraph nil))
22324 (with-syntax-table org-mode-transpose-word-syntax-table
22325 ;; Move to end of line in order to get the first paragraph
22326 ;; within a plain list or a footnote definition.
22327 (let ((element (save-excursion
22328 (end-of-line)
22329 (or (ignore-errors (org-element-at-point))
22330 (user-error "An element cannot be parsed line %d"
22331 (line-number-at-pos (point)))))))
22332 ;; First check if point is in a blank line at the beginning of
22333 ;; the buffer. In that case, ignore filling.
22334 (case (org-element-type element)
22335 ;; Use major mode filling function is src blocks.
22336 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22337 ;; Align Org tables, leave table.el tables as-is.
22338 (table-row (org-table-align) t)
22339 (table
22340 (when (eq (org-element-property :type element) 'org)
22341 (save-excursion
22342 (goto-char (org-element-property :post-affiliated element))
22343 (org-table-align)))
22344 t)
22345 (paragraph
22346 ;; Paragraphs may contain `line-break' type objects.
22347 (let ((beg (max (point-min)
22348 (org-element-property :contents-begin element)))
22349 (end (min (point-max)
22350 (org-element-property :contents-end element))))
22351 ;; Do nothing if point is at an affiliated keyword.
22352 (if (< (line-end-position) beg) t
22353 (when (derived-mode-p 'message-mode)
22354 ;; In `message-mode', do not fill following citation
22355 ;; in current paragraph nor text before message body.
22356 (let ((body-start (save-excursion (message-goto-body))))
22357 (when body-start (setq beg (max body-start beg))))
22358 (when (save-excursion
22359 (re-search-forward
22360 (concat "^" message-cite-prefix-regexp) end t))
22361 (setq end (match-beginning 0))))
22362 ;; Fill paragraph, taking line breaks into account.
22363 ;; For that, slice the paragraph using line breaks as
22364 ;; separators, and fill the parts in reverse order to
22365 ;; avoid messing with markers.
22366 (save-excursion
22367 (goto-char end)
22368 (mapc
22369 (lambda (pos)
22370 (fill-region-as-paragraph pos (point) justify)
22371 (goto-char pos))
22372 ;; Find the list of ending positions for line breaks
22373 ;; in the current paragraph. Add paragraph
22374 ;; beginning to include first slice.
22375 (nreverse
22376 (cons beg
22377 (org-element-map
22378 (org-element--parse-objects
22379 beg end nil (org-element-restriction 'paragraph))
22380 'line-break
22381 (lambda (lb) (org-element-property :end lb)))))))
22382 t)))
22383 ;; Contents of `comment-block' type elements should be
22384 ;; filled as plain text, but only if point is within block
22385 ;; markers.
22386 (comment-block
22387 (let* ((case-fold-search t)
22388 (beg (save-excursion
22389 (goto-char (org-element-property :begin element))
22391 (forward-line)
22392 (point)))
22393 (end (save-excursion
22394 (goto-char (org-element-property :end element))
22396 (line-beginning-position))))
22397 (if (or (< (point) beg) (> (point) end)) t
22398 (fill-region-as-paragraph
22399 (save-excursion (end-of-line)
22401 (line-beginning-position))
22402 (save-excursion (beginning-of-line)
22404 (line-beginning-position))
22405 justify))))
22406 ;; Fill comments.
22407 (comment
22408 (let ((begin (org-element-property :post-affiliated element))
22409 (end (org-element-property :end element)))
22410 (when (and (>= (point) begin) (<= (point) end))
22411 (let ((begin (save-excursion
22412 (end-of-line)
22414 (progn (forward-line) (point))
22415 begin)))
22416 (end (save-excursion
22417 (end-of-line)
22419 (1- (line-beginning-position))
22421 (line-end-position)))))
22422 ;; Do not fill comments when at a blank line.
22423 (when (> end begin)
22424 (let ((fill-prefix
22425 (save-excursion
22426 (beginning-of-line)
22428 (let ((comment-prefix (match-string 0)))
22429 (goto-char (match-end 0))
22430 (if (looking-at adaptive-fill-regexp)
22431 (concat comment-prefix (match-string 0))
22432 (concat comment-prefix " "))))))
22433 (save-excursion
22434 (fill-region-as-paragraph begin end justify))))))
22435 t))
22436 ;; Ignore every other element.
22437 (otherwise t))))))
22439 (defun org-auto-fill-function ()
22440 "Auto-fill function."
22441 ;; Check if auto-filling is meaningful.
22442 (let ((fc (current-fill-column)))
22443 (when (and fc (> (current-column) fc))
22444 (let* ((fill-prefix (org-adaptive-fill-function))
22445 ;; Enforce empty fill prefix, if required. Otherwise, it
22446 ;; will be computed again.
22447 (adaptive-fill-mode (not (equal fill-prefix ""))))
22448 (when fill-prefix (do-auto-fill))))))
22450 (defun org-comment-line-break-function (&optional soft)
22451 "Break line at point and indent, continuing comment if within one.
22452 The inserted newline is marked hard if variable
22453 `use-hard-newlines' is true, unless optional argument SOFT is
22454 non-nil."
22456 (save-excursion (forward-char -1) (delete-horizontal-space))
22457 (delete-horizontal-space)
22458 (indent-to-left-margin)
22459 (insert-before-markers-and-inherit fill-prefix))
22462 ;;; Comments
22464 ;; Org comments syntax is quite complex. It requires the entire line
22465 ;; to be just a comment. Also, even with the right syntax at the
22466 ;; beginning of line, some some elements (i.e. verse-block or
22467 ;; example-block) don't accept comments. Usual Emacs comment commands
22468 ;; cannot cope with those requirements. Therefore, Org replaces them.
22470 ;; Org still relies on `comment-dwim', but cannot trust
22471 ;; `comment-only-p'. So, `comment-region-function' and
22472 ;; `uncomment-region-function' both point
22473 ;; to`org-comment-or-uncomment-region'. Eventually,
22474 ;; `org-insert-comment' takes care of insertion of comments at the
22475 ;; beginning of line.
22477 ;; `org-setup-comments-handling' install comments related variables
22478 ;; during `org-mode' initialization.
22480 (defun org-setup-comments-handling ()
22481 (interactive)
22482 (org-set-local 'comment-use-syntax nil)
22483 (org-set-local 'comment-start "# ")
22485 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22486 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22487 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22489 (defun org-insert-comment ()
22490 "Insert an empty comment above current line.
22491 If the line is empty, insert comment at its beginning."
22492 (beginning-of-line)
22494 (org-indent-line)
22495 (insert "# "))
22497 (defvar comment-empty-lines) ; From newcomment.el.
22498 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22499 "Comment or uncomment each non-blank line in the region.
22500 Uncomment each non-blank line between BEG and END if it only
22501 contains commented lines. Otherwise, comment them."
22502 (save-restriction
22503 ;; Restrict region
22504 (narrow-to-region (save-excursion (goto-char beg)
22506 (line-beginning-position))
22507 (save-excursion (goto-char end)
22509 (line-end-position)))
22510 (let ((uncommentp
22511 ;; UNCOMMENTP is non-nil when every non blank line between
22512 ;; BEG and END is a comment.
22513 (save-excursion
22514 (goto-char (point-min))
22515 (while (and (not (eobp))
22516 (let ((element (org-element-at-point)))
22517 (and (eq (org-element-type element) 'comment)
22518 (goto-char (min (point-max)
22519 (org-element-property
22520 :end element)))))))
22521 (eobp))))
22522 (if uncommentp
22523 ;; Only blank lines and comments in region: uncomment it.
22524 (save-excursion
22525 (goto-char (point-min))
22526 (while (not (eobp))
22528 (replace-match "" nil nil nil 1))
22529 (forward-line)))
22530 ;; Comment each line in region.
22531 (let ((min-indent (point-max)))
22532 ;; First find the minimum indentation across all lines.
22533 (save-excursion
22534 (goto-char (point-min))
22535 (while (and (not (eobp)) (not (zerop min-indent)))
22537 (setq min-indent (min min-indent (current-indentation))))
22538 (forward-line)))
22539 ;; Then loop over all lines.
22540 (save-excursion
22541 (goto-char (point-min))
22542 (while (not (eobp))
22544 ;; Don't get fooled by invisible text (e.g. link path)
22545 ;; when moving to column MIN-INDENT.
22546 (let ((buffer-invisibility-spec nil))
22547 (org-move-to-column min-indent t))
22548 (insert comment-start))
22549 (forward-line))))))))
22552 ;;; Planning
22554 ;; This section contains tools to operate on timestamp objects, as
22555 ;; returned by, e.g. `org-element-context'.
22557 (defun org-timestamp-has-time-p (timestamp)
22558 "Non-nil when TIMESTAMP has a time specified."
22559 (org-element-property :hour-start timestamp))
22561 (defun org-timestamp-format (timestamp format &optional end utc)
22562 "Format a TIMESTAMP element into a string.
22564 FORMAT is a format specifier to be passed to
22565 `format-time-string'.
22567 When optional argument END is non-nil, use end of date-range or
22568 time-range, if possible.
22570 When optional argument UTC is non-nil, time will be expressed as
22571 Universal Time."
22572 (format-time-string
22573 format
22574 (apply 'encode-time
22575 (cons 0
22576 (mapcar
22577 (lambda (prop) (or (org-element-property prop timestamp) 0))
22578 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22579 '(:minute-start :hour-start :day-start :month-start
22580 :year-start)))))
22581 utc))
22583 (defun org-timestamp-split-range (timestamp &optional end)
22584 "Extract a timestamp object from a date or time range.
22586 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22587 the end of the range. Otherwise, extract its start.
22589 Return a new timestamp object sharing the same parent as
22590 TIMESTAMP."
22591 (let ((type (org-element-property :type timestamp)))
22592 (if (memq type '(active inactive diary)) timestamp
22593 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22594 ;; Set new type.
22595 (org-element-put-property
22596 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22597 ;; Copy start properties over end properties if END is
22598 ;; non-nil. Otherwise, copy end properties over `start' ones.
22599 (let ((p-alist '((:minute-start . :minute-end)
22600 (:hour-start . :hour-end)
22601 (:day-start . :day-end)
22602 (:month-start . :month-end)
22603 (:year-start . :year-end))))
22604 (dolist (p-cell p-alist)
22605 (org-element-put-property
22606 split-ts
22607 (funcall (if end 'car 'cdr) p-cell)
22608 (org-element-property
22609 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22610 ;; Eventually refresh `:raw-value'.
22611 (org-element-put-property split-ts :raw-value nil)
22612 (org-element-put-property
22613 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22615 (defun org-timestamp-translate (timestamp &optional boundary)
22616 "Apply `org-translate-time' on a TIMESTAMP object.
22617 When optional argument BOUNDARY is non-nil, it is either the
22618 symbol `start' or `end'. In this case, only translate the
22619 starting or ending part of TIMESTAMP if it is a date or time
22620 range. Otherwise, translate both parts."
22621 (if (and (not boundary)
22622 (memq (org-element-property :type timestamp)
22623 '(active-range inactive-range)))
22624 (concat
22625 (org-translate-time
22626 (org-element-property :raw-value
22627 (org-timestamp-split-range timestamp)))
22628 "--"
22629 (org-translate-time
22630 (org-element-property :raw-value
22631 (org-timestamp-split-range timestamp t))))
22632 (org-translate-time
22633 (org-element-property
22634 :raw-value
22635 (if (not boundary) timestamp
22636 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22640 ;;; Other stuff.
22642 (defun org-toggle-fixed-width-section (arg)
22643 "Toggle the fixed-width export.
22644 If there is no active region, the QUOTE keyword at the current headline is
22645 inserted or removed. When present, it causes the text between this headline
22646 and the next to be exported as fixed-width text, and unmodified.
22647 If there is an active region, this command adds or removes a colon as the
22648 first character of this line. If the first character of a line is a colon,
22649 this line is also exported in fixed-width font."
22650 (interactive "P")
22651 (let* ((cc 0)
22652 (regionp (org-region-active-p))
22653 (beg (if regionp (region-beginning) (point)))
22654 (end (if regionp (region-end)))
22655 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22656 (case-fold-search nil)
22658 off)
22659 (if regionp
22660 (save-excursion
22661 (goto-char beg)
22662 (setq cc (current-column))
22663 (beginning-of-line 1)
22664 (setq off (looking-at re))
22665 (while (> nlines 0)
22666 (setq nlines (1- nlines))
22667 (beginning-of-line 1)
22668 (cond
22669 (arg
22670 (org-move-to-column cc t)
22672 (forward-line -1))
22673 ((and off (looking-at re))
22674 (replace-match "" t t nil 1))
22675 ((not off) (org-move-to-column cc t) (insert ": ")))
22676 (forward-line 1)))
22677 (save-excursion
22678 (org-back-to-heading)
22679 (cond
22680 ((looking-at (format org-heading-keyword-regexp-format
22681 org-quote-string))
22682 (goto-char (match-end 1))
22683 (looking-at (concat " +" org-quote-string))
22684 (replace-match "" t t)
22685 (when (eolp) (insert " ")))
22686 ((looking-at org-outline-regexp)
22687 (goto-char (match-end 0))
22688 (insert org-quote-string " ")))))))
22690 (defun org-reftex-citation ()
22691 "Use reftex-citation to insert a citation into the buffer.
22692 This looks for a line like
22694 #+BIBLIOGRAPHY: foo plain option:-d
22696 and derives from it that foo.bib is the bibliography file relevant
22697 for this document. It then installs the necessary environment for RefTeX
22698 to work in this buffer and calls `reftex-citation' to insert a citation
22699 into the buffer.
22701 Export of such citations to both LaTeX and HTML is handled by the contributed
22702 package ox-bibtex by Taru Karttunen."
22703 (interactive)
22704 (let ((reftex-docstruct-symbol 'rds)
22706 rds bib)
22707 (save-excursion
22708 (save-restriction
22709 (widen)
22710 (let ((case-fold-search t)
22712 (if (not (save-excursion
22713 (or (re-search-forward re nil t)
22714 (re-search-backward re nil t))))
22715 (error "No bibliography defined in file")
22716 (setq bib (concat (match-string 1) ".bib")
22717 rds (list (list 'bib bib)))))))
22718 (call-interactively 'reftex-citation)))
22720 ;;;; Functions extending outline functionality
22722 (defun org-beginning-of-line (&optional arg)
22723 "Go to the beginning of the current line. If that is invisible, continue
22724 to a visible line beginning. This makes the function of C-a more intuitive.
22725 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22726 first attempt, and only move to after the tags when the cursor is already
22727 beyond the end of the headline."
22728 (interactive "P")
22729 (let ((pos (point))
22730 (special (if (consp org-special-ctrl-a/e)
22731 (car org-special-ctrl-a/e)
22732 org-special-ctrl-a/e))
22733 deactivate-mark refpos)
22734 (if (org-bound-and-true-p visual-line-mode)
22735 (beginning-of-visual-line 1)
22736 (beginning-of-line 1))
22737 (if (and arg (fboundp 'move-beginning-of-line))
22738 (call-interactively 'move-beginning-of-line)
22739 (if (bobp)
22740 nil
22741 (backward-char 1)
22742 (if (org-truely-invisible-p)
22743 (while (and (not (bobp)) (org-truely-invisible-p))
22744 (backward-char 1)
22745 (beginning-of-line 1))
22746 (forward-char 1))))
22747 (when special
22748 (cond
22749 ((and (looking-at org-complex-heading-regexp)
22750 (= (char-after (match-end 1)) ?\ ))
22751 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22752 (point-at-eol)))
22753 (goto-char
22754 (if (eq special t)
22755 (cond ((> pos refpos) refpos)
22756 ((= pos (point)) refpos)
22757 (t (point)))
22758 (cond ((> pos (point)) (point))
22759 ((not (eq last-command this-command)) (point))
22760 (t refpos)))))
22761 ((org-at-item-p)
22762 ;; Being at an item and not looking at an the item means point
22763 ;; was previously moved to beginning of a visual line, which
22764 ;; doesn't contain the item. Therefore, do nothing special,
22765 ;; just stay here.
22766 (when (looking-at org-list-full-item-re)
22767 ;; Set special position at first white space character after
22768 ;; bullet, and check-box, if any.
22769 (let ((after-bullet
22770 (let ((box (match-end 3)))
22771 (if (not box) (match-end 1)
22772 (let ((after (char-after box)))
22773 (if (and after (= after ? )) (1+ box) box))))))
22774 ;; Special case: Move point to special position when
22775 ;; currently after it or at beginning of line.
22776 (if (eq special t)
22777 (when (or (> pos after-bullet) (= (point) pos))
22778 (goto-char after-bullet))
22779 ;; Reversed case: Move point to special position when
22780 ;; point was already at beginning of line and command is
22781 ;; repeated.
22782 (when (and (= (point) pos) (eq last-command this-command))
22783 (goto-char after-bullet))))))))
22784 (org-no-warnings
22785 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22786 (setq disable-point-adjustment
22787 (or (not (invisible-p (point)))
22788 (not (invisible-p (max (point-min) (1- (point))))))))
22790 (defun org-end-of-line (&optional arg)
22791 "Go to the end of the line.
22792 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22793 tags on the first attempt, and only move to after the tags when
22794 the cursor is already beyond the end of the headline."
22795 (interactive "P")
22796 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22797 org-special-ctrl-a/e))
22798 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22799 'end-of-visual-line)
22800 ((fboundp 'move-end-of-line) 'move-end-of-line)
22801 (t 'end-of-line)))
22802 deactivate-mark)
22803 (if (or (not special) arg) (call-interactively move-fun)
22804 (let* ((element (save-excursion (beginning-of-line)
22805 (org-element-at-point)))
22806 (type (org-element-type element)))
22807 (cond
22808 ((memq type '(headline inlinetask))
22809 (let ((pos (point)))
22810 (beginning-of-line 1)
22812 (if (eq special t)
22813 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22814 (goto-char (match-beginning 1))
22815 (goto-char (match-end 0)))
22816 (if (or (< pos (match-end 0))
22817 (not (eq this-command last-command)))
22818 (goto-char (match-end 0))
22819 (goto-char (match-beginning 1))))
22820 (call-interactively move-fun))))
22821 ((outline-invisible-p (line-end-position))
22822 ;; If element is hidden, `move-end-of-line' would put point
22823 ;; after it. Use `end-of-line' to stay on current line.
22824 (call-interactively 'end-of-line))
22825 (t (call-interactively move-fun)))))
22826 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22827 (setq disable-point-adjustment
22828 (or (not (invisible-p (point)))
22829 (not (invisible-p (max (point-min) (1- (point))))))))
22831 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22832 (define-key org-mode-map "\C-e" 'org-end-of-line)
22834 (defun org-backward-sentence (&optional arg)
22835 "Go to beginning of sentence, or beginning of table field.
22836 This will call `backward-sentence' or `org-table-beginning-of-field',
22837 depending on context."
22838 (interactive "P")
22839 (cond
22840 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22841 (t (call-interactively 'backward-sentence))))
22843 (defun org-forward-sentence (&optional arg)
22844 "Go to end of sentence, or end of table field.
22845 This will call `forward-sentence' or `org-table-end-of-field',
22846 depending on context."
22847 (interactive "P")
22848 (cond
22849 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22850 (t (call-interactively 'forward-sentence))))
22852 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22853 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22855 (defun org-kill-line (&optional arg)
22856 "Kill line, to tags or end of line."
22857 (interactive "P")
22858 (cond
22859 ((or (not org-special-ctrl-k)
22860 (bolp)
22861 (not (org-at-heading-p)))
22862 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22863 org-ctrl-k-protect-subtree)
22864 (if (or (eq org-ctrl-k-protect-subtree 'error)
22865 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22866 (user-error "C-k aborted as it would kill a hidden subtree")))
22867 (call-interactively
22868 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22870 (kill-region (point) (match-beginning 1))
22871 (org-set-tags nil t))
22872 (t (kill-region (point) (point-at-eol)))))
22874 (define-key org-mode-map "\C-k" 'org-kill-line)
22876 (defun org-yank (&optional arg)
22877 "Yank. If the kill is a subtree, treat it specially.
22878 This command will look at the current kill and check if is a single
22879 subtree, or a series of subtrees[1]. If it passes the test, and if the
22880 cursor is at the beginning of a line or after the stars of a currently
22881 empty headline, then the yank is handled specially. How exactly depends
22882 on the value of the following variables, both set by default.
22884 org-yank-folded-subtrees
22885 When set, the subtree(s) will be folded after insertion, but only
22886 if doing so would now swallow text after the yanked text.
22888 org-yank-adjusted-subtrees
22889 When set, the subtree will be promoted or demoted in order to
22890 fit into the local outline tree structure, which means that the level
22891 will be adjusted so that it becomes the smaller one of the two
22892 *visible* surrounding headings.
22894 Any prefix to this command will cause `yank' to be called directly with
22896 will just
22897 plainly yank the text as it is.
22899 \[1] The test checks if the first non-white line is a heading
22900 and if there are no other headings with fewer stars."
22901 (interactive "P")
22902 (org-yank-generic 'yank arg))
22904 (defun org-yank-generic (command arg)
22905 "Perform some yank-like command.
22907 This function implements the behavior described in the `org-yank'
22908 documentation. However, it has been generalized to work for any
22909 interactive command with similar behavior."
22911 ;; pretend to be command COMMAND
22912 (setq this-command command)
22914 (if arg
22915 (call-interactively command)
22917 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22918 (and (org-kill-is-subtree-p)
22919 (or (bolp)
22921 (string-match
22923 (buffer-substring (point-at-bol) (point)))))))
22924 swallowp)
22925 (cond
22926 ((and subtreep org-yank-folded-subtrees)
22927 (let ((beg (point))
22928 end)
22929 (if (and subtreep org-yank-adjusted-subtrees)
22930 (org-paste-subtree nil nil 'for-yank)
22931 (call-interactively command))
22933 (setq end (point))
22934 (goto-char beg)
22935 (when (and (bolp) subtreep
22936 (not (setq swallowp
22937 (org-yank-folding-would-swallow-text beg end))))
22938 (org-with-limited-levels
22939 (or (looking-at org-outline-regexp)
22940 (re-search-forward org-outline-regexp-bol end t))
22941 (while (and (< (point) end) (looking-at org-outline-regexp))
22942 (hide-subtree)
22943 (org-cycle-show-empty-lines 'folded)
22944 (condition-case nil
22945 (outline-forward-same-level 1)
22946 (error (goto-char end))))))
22947 (when swallowp
22948 (message
22949 "Inserted text not folded because that would swallow text"))
22951 (goto-char end)
22953 (beginning-of-line 1)
22954 (push-mark beg 'nomsg)))
22955 ((and subtreep org-yank-adjusted-subtrees)
22956 (let ((beg (point-at-bol)))
22957 (org-paste-subtree nil nil 'for-yank)
22958 (push-mark beg 'nomsg)))
22959 (t
22960 (call-interactively command))))))
22962 (defun org-yank-folding-would-swallow-text (beg end)
22963 "Would hide-subtree at BEG swallow any text after END?"
22964 (let (level)
22965 (org-with-limited-levels
22966 (save-excursion
22967 (goto-char beg)
22968 (when (or (looking-at org-outline-regexp)
22969 (re-search-forward org-outline-regexp-bol end t))
22970 (setq level (org-outline-level)))
22971 (goto-char end)
22973 (if (or (eobp)
22974 (and (bolp) (looking-at org-outline-regexp)
22975 (<= (org-outline-level) level)))
22976 nil ; Nothing would be swallowed
22977 t))))) ; something would swallow
22979 (define-key org-mode-map "\C-y" 'org-yank)
22981 (defun org-truely-invisible-p ()
22982 "Check if point is at a character currently not visible.
22983 This version does not only check the character property, but also
22984 `visible-mode'."
22985 ;; Early versions of noutline don't have `outline-invisible-p'.
22986 (if (org-bound-and-true-p visible-mode)
22987 nil
22988 (outline-invisible-p)))
22990 (defun org-invisible-p2 ()
22991 "Check if point is at a character currently not visible."
22992 (save-excursion
22993 (if (and (eolp) (not (bobp))) (backward-char 1))
22994 ;; Early versions of noutline don't have `outline-invisible-p'.
22995 (outline-invisible-p)))
22997 (defun org-back-to-heading (&optional invisible-ok)
22998 "Call `outline-back-to-heading', but provide a better error message."
22999 (condition-case nil
23000 (outline-back-to-heading invisible-ok)
23001 (error (error "Before first headline at position %d in buffer %s"
23002 (point) (current-buffer)))))
23004 (defun org-before-first-heading-p ()
23005 "Before first heading?"
23006 (save-excursion
23007 (end-of-line)
23008 (null (re-search-backward org-outline-regexp-bol nil t))))
23010 (defun org-at-heading-p (&optional ignored)
23011 (outline-on-heading-p t))
23012 ;; Compatibility alias with Org versions < 7.8.03
23013 (defalias 'org-on-heading-p 'org-at-heading-p)
23015 (defun org-at-comment-p nil
23016 "Is cursor in a line starting with a # character?"
23017 (save-excursion
23018 (beginning-of-line)
23019 (looking-at "^#")))
23021 (defun org-at-drawer-p nil
23022 "Is cursor at a drawer keyword?"
23023 (save-excursion
23024 (move-beginning-of-line 1)
23025 (looking-at org-drawer-regexp)))
23027 (defun org-at-block-p nil
23028 "Is cursor at a block keyword?"
23029 (save-excursion
23030 (move-beginning-of-line 1)
23031 (looking-at org-block-regexp)))
23033 (defun org-point-at-end-of-empty-headline ()
23034 "If point is at the end of an empty headline, return t, else nil.
23035 If the heading only contains a TODO keyword, it is still still considered
23036 empty."
23038 (when org-todo-line-regexp
23039 (save-excursion
23040 (beginning-of-line 1)
23041 (let ((case-fold-search nil))
23042 (looking-at org-todo-line-regexp)
23043 (string= (match-string 3) ""))))))
23045 (defun org-at-heading-or-item-p ()
23046 (or (org-at-heading-p) (org-at-item-p)))
23048 (defun org-at-target-p ()
23049 (or (org-in-regexp org-radio-target-regexp)
23050 (org-in-regexp org-target-regexp)))
23051 ;; Compatibility alias with Org versions < 7.8.03
23052 (defalias 'org-on-target-p 'org-at-target-p)
23054 (defun org-up-heading-all (arg)
23055 "Move to the heading line of which the present line is a subheading.
23056 This function considers both visible and invisible heading lines.
23057 With argument, move up ARG levels."
23058 (if (fboundp 'outline-up-heading-all)
23059 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23060 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23062 (defun org-up-heading-safe ()
23063 "Move to the heading line of which the present line is a subheading.
23064 This version will not throw an error. It will return the level of the
23065 headline found, or nil if no higher level is found.
23067 Also, this function will be a lot faster than `outline-up-heading',
23068 because it relies on stars being the outline starters. This can really
23069 make a significant difference in outlines with very many siblings."
23070 (let (start-level re)
23071 (org-back-to-heading t)
23072 (setq start-level (funcall outline-level))
23073 (if (equal start-level 1)
23074 nil
23076 (if (re-search-backward re nil t)
23077 (funcall outline-level)))))
23079 (defun org-first-sibling-p ()
23080 "Is this heading the first child of its parents?"
23081 (interactive)
23082 (let ((re org-outline-regexp-bol)
23083 level l)
23084 (unless (org-at-heading-p t)
23085 (user-error "Not at a heading"))
23086 (setq level (funcall outline-level))
23087 (save-excursion
23088 (if (not (re-search-backward re nil t))
23089 t
23090 (setq l (funcall outline-level))
23091 (< l level)))))
23093 (defun org-goto-sibling (&optional previous)
23094 "Goto the next sibling, even if it is invisible.
23095 When PREVIOUS is set, go to the previous sibling instead. Returns t
23096 when a sibling was found. When none is found, return nil and don't
23097 move point."
23098 (let ((fun (if previous 're-search-backward 're-search-forward))
23099 (pos (point))
23100 (re org-outline-regexp-bol)
23101 level l)
23102 (when (condition-case nil (org-back-to-heading t) (error nil))
23103 (setq level (funcall outline-level))
23104 (catch 'exit
23105 (or previous (forward-char 1))
23106 (while (funcall fun re nil t)
23107 (setq l (funcall outline-level))
23108 (when (< l level) (goto-char pos) (throw 'exit nil))
23109 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23110 (goto-char pos)
23111 nil))))
23113 (defun org-show-siblings ()
23114 "Show all siblings of the current headline."
23115 (save-excursion
23116 (while (org-goto-sibling) (org-flag-heading nil)))
23117 (save-excursion
23118 (while (org-goto-sibling 'previous)
23119 (org-flag-heading nil))))
23121 (defun org-goto-first-child ()
23122 "Goto the first child, even if it is invisible.
23123 Return t when a child was found. Otherwise don't move point and
23124 return nil."
23125 (let (level (pos (point)) (re org-outline-regexp-bol))
23126 (when (condition-case nil (org-back-to-heading t) (error nil))
23127 (setq level (outline-level))
23128 (forward-char 1)
23129 (if (and (re-search-forward re nil t) (> (outline-level) level))
23130 (progn (goto-char (match-beginning 0)) t)
23131 (goto-char pos) nil))))
23133 (defun org-show-hidden-entry ()
23134 "Show an entry where even the heading is hidden."
23135 (save-excursion
23136 (org-show-entry)))
23138 (defun org-flag-heading (flag &optional entry)
23139 "Flag the current heading. FLAG non-nil means make invisible.
23140 When ENTRY is non-nil, show the entire entry."
23141 (save-excursion
23142 (org-back-to-heading t)
23143 ;; Check if we should show the entire entry
23144 (if entry
23145 (progn
23146 (org-show-entry)
23147 (save-excursion
23148 (and (outline-next-heading)
23149 (org-flag-heading nil))))
23150 (outline-flag-region (max (point-min) (1- (point)))
23151 (save-excursion (outline-end-of-heading) (point))
23152 flag))))
23154 (defun org-get-next-sibling ()
23155 "Move to next heading of the same level, and return point.
23156 If there is no such heading, return nil.
23157 This is like outline-next-sibling, but invisible headings are ok."
23158 (let ((level (funcall outline-level)))
23159 (outline-next-heading)
23160 (while (and (not (eobp)) (> (funcall outline-level) level))
23161 (outline-next-heading))
23162 (if (or (eobp) (< (funcall outline-level) level))
23163 nil
23164 (point))))
23166 (defun org-get-last-sibling ()
23167 "Move to previous heading of the same level, and return point.
23168 If there is no such heading, return nil."
23169 (let ((opoint (point))
23170 (level (funcall outline-level)))
23171 (outline-previous-heading)
23172 (when (and (/= (point) opoint) (outline-on-heading-p t))
23173 (while (and (> (funcall outline-level) level)
23174 (not (bobp)))
23175 (outline-previous-heading))
23176 (if (< (funcall outline-level) level)
23177 nil
23178 (point)))))
23180 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23181 "Goto to the end of a subtree."
23182 ;; This contains an exact copy of the original function, but it uses
23183 ;; `org-back-to-heading', to make it work also in invisible
23184 ;; trees. And is uses an invisible-ok argument.
23185 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23186 ;; Furthermore, when used inside Org, finding the end of a large subtree
23187 ;; with many children and grandchildren etc, this can be much faster
23188 ;; than the outline version.
23189 (org-back-to-heading invisible-ok)
23190 (let ((first t)
23191 (level (funcall outline-level)))
23192 (if (and (derived-mode-p 'org-mode) (< level 1000))
23193 ;; A true heading (not a plain list item), in Org-mode
23194 ;; This means we can easily find the end by looking
23195 ;; only for the right number of stars. Using a regexp to do
23196 ;; this is so much faster than using a Lisp loop.
23198 (forward-char 1)
23199 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23200 ;; something else, do it the slow way
23201 (while (and (not (eobp))
23202 (or first (> (funcall outline-level) level)))
23203 (setq first nil)
23204 (outline-next-heading)))
23205 (unless to-heading
23207 (progn
23208 ;; Go to end of line before heading
23209 (forward-char -1)
23211 ;; leave blank line before heading
23212 (forward-char -1))))))
23213 (point))
23215 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23216 "Use Org version in org-mode, for dramatic speed-up."
23217 (if (derived-mode-p 'org-mode)
23218 (progn
23219 (org-end-of-subtree nil t)
23220 (unless (eobp) (backward-char 1)))
23221 ad-do-it))
23223 (defun org-end-of-meta-data-and-drawers ()
23224 "Jump to the first text after meta data and drawers in the current entry.
23225 This will move over empty lines, lines with planning time stamps,
23226 clocking lines, and drawers."
23227 (org-back-to-heading t)
23228 (let ((end (save-excursion (outline-next-heading) (point)))
23231 (forward-line 1)
23232 (while (re-search-forward re end t)
23233 (if (not (match-end 1))
23234 ;; empty or planning line
23235 (forward-line 1)
23236 ;; a drawer, find the end
23238 (forward-line 1)))
23240 (point)))
23242 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23243 "Move forward to the ARG'th subheading at same level as this one.
23244 Stop at the first and last subheadings of a superior heading.
23245 Normally this only looks at visible headings, but when INVISIBLE-OK is
23246 non-nil it will also look at invisible ones."
23247 (interactive "p")
23248 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23249 (if (and arg (< arg 0))
23250 (goto-char (point-min))
23251 (outline-next-heading))
23252 (org-at-heading-p)
23253 (let ((level (- (match-end 0) (match-beginning 0) 1))
23254 (f (if (and arg (< arg 0))
23255 're-search-backward
23256 're-search-forward))
23257 (count (if arg (abs arg) 1))
23258 (result (point)))
23259 (while (and (prog1 (> count 0)
23260 (forward-char (if (and arg (< arg 0)) -1 1)))
23261 (funcall f org-outline-regexp-bol nil 'move))
23262 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23263 (cond ((< l level) (setq count 0))
23264 ((and (= l level)
23265 (or invisible-ok
23266 (progn
23267 (goto-char (line-beginning-position))
23268 (not (outline-invisible-p)))))
23269 (setq count (1- count))
23270 (when (eq l level)
23271 (setq result (point)))))))
23272 (goto-char result))
23273 (beginning-of-line 1)))
23275 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23276 "Move backward to the ARG'th subheading at same level as this one.
23277 Stop at the first and last subheadings of a superior heading."
23278 (interactive "p")
23279 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23281 (defun org-next-block (arg &optional backward block-regexp)
23282 "Jump to the next block.
23283 With a prefix argument ARG, jump forward ARG many source blocks.
23284 When BACKWARD is non-nil, jump to the previous block.
23285 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23286 (interactive "p")
23287 (let ((re (or block-regexp org-block-regexp))
23288 (re-search-fn (or (and backward 're-search-backward)
23289 're-search-forward)))
23290 (if (looking-at re) (forward-char 1))
23291 (condition-case nil
23292 (funcall re-search-fn re nil nil arg)
23293 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23294 (goto-char (match-beginning 0)) (org-show-context)))
23296 (defun org-previous-block (arg &optional block-regexp)
23297 "Jump to the previous block.
23298 With a prefix argument ARG, jump backward ARG many source blocks.
23299 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23300 (interactive "p")
23301 (org-next-block arg t block-regexp))
23303 (defun org-forward-paragraph ()
23304 "Move forward to beginning of next paragraph or equivalent.
23306 The function moves point to the beginning of the next visible
23307 structural element, which can be a paragraph, a table, a list
23308 item, etc. It also provides some special moves for convenience:
23310 - On an affiliated keyword, jump to the beginning of the
23311 relative element.
23312 - On an item or a footnote definition, move to the second
23313 element inside, if any.
23314 - On a table or a property drawer, jump after it.
23315 - On a verse or source block, stop after blank lines."
23316 (interactive)
23317 (when (eobp) (user-error "Cannot move further down"))
23318 (let* ((deactivate-mark nil)
23319 (element (org-element-at-point))
23320 (type (org-element-type element))
23321 (post-affiliated (org-element-property :post-affiliated element))
23322 (contents-begin (org-element-property :contents-begin element))
23323 (contents-end (org-element-property :contents-end element))
23324 (end (let ((end (org-element-property :end element)) (parent element))
23325 (while (and (setq parent (org-element-property :parent parent))
23326 (= (org-element-property :contents-end parent) end))
23327 (setq end (org-element-property :end parent)))
23328 end)))
23329 (cond ((not element)
23331 (or (eobp) (beginning-of-line)))
23332 ;; On affiliated keywords, move to element's beginning.
23333 ((and post-affiliated (< (point) post-affiliated))
23334 (goto-char post-affiliated))
23335 ;; At a table row, move to the end of the table. Similarly,
23336 ;; at a node property, move to the end of the property
23337 ;; drawer.
23338 ((memq type '(node-property table-row))
23339 (goto-char (org-element-property
23340 :end (org-element-property :parent element))))
23341 ((memq type '(property-drawer table)) (goto-char end))
23342 ;; Consider blank lines as separators in verse and source
23343 ;; blocks to ease editing.
23344 ((memq type '(src-block verse-block))
23345 (when (eq type 'src-block)
23346 (setq contents-end
23347 (save-excursion (goto-char end)
23349 (line-beginning-position))))
23350 (beginning-of-line)
23353 (goto-char end)
23355 (if (= (point) contents-end) (goto-char end)
23356 (beginning-of-line))))
23357 ;; With no contents, just skip element.
23358 ((not contents-begin) (goto-char end))
23359 ;; If contents are invisible, skip the element altogether.
23360 ((outline-invisible-p (line-end-position))
23361 (case type
23362 (headline
23363 (org-with-limited-levels (outline-next-visible-heading 1)))
23364 ;; At a plain list, make sure we move to the next item
23365 ;; instead of skipping the whole list.
23366 (plain-list (forward-char)
23367 (org-forward-paragraph))
23368 (otherwise (goto-char end))))
23369 ((>= (point) contents-end) (goto-char end))
23370 ((>= (point) contents-begin)
23371 ;; This can only happen on paragraphs and plain lists.
23372 (case type
23373 (paragraph (goto-char end))
23374 ;; At a plain list, try to move to second element in
23375 ;; first item, if possible.
23376 (plain-list (end-of-line)
23377 (org-forward-paragraph))))
23378 ;; When contents start on the middle of a line (e.g. in
23379 ;; items and footnote definitions), try to reach first
23380 ;; element starting after current line.
23381 ((> (line-end-position) contents-begin)
23382 (end-of-line)
23383 (org-forward-paragraph))
23384 (t (goto-char contents-begin)))))
23386 (defun org-backward-paragraph ()
23387 "Move backward to start of previous paragraph or equivalent.
23389 The function moves point to the beginning of the current
23390 structural element, which can be a paragraph, a table, a list
23391 item, etc., or to the beginning of the previous visible one if
23392 point is already there. It also provides some special moves for
23393 convenience:
23395 - On an affiliated keyword, jump to the first one.
23396 - On a table or a property drawer, move to its beginning.
23397 - On a verse or source block, stop before blank lines."
23398 (interactive)
23399 (when (bobp) (user-error "Cannot move further up"))
23400 (let* ((deactivate-mark nil)
23401 (element (org-element-at-point))
23402 (type (org-element-type element))
23403 (contents-begin (org-element-property :contents-begin element))
23404 (contents-end (org-element-property :contents-end element))
23405 (post-affiliated (org-element-property :post-affiliated element))
23406 (begin (org-element-property :begin element)))
23407 (cond
23408 ((not element) (goto-char (point-min)))
23409 ((= (point) begin)
23410 (backward-char)
23411 (org-backward-paragraph))
23412 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23413 ((memq type '(node-property table-row))
23414 (goto-char (org-element-property
23415 :post-affiliated (org-element-property :parent element))))
23416 ((memq type '(property-drawer table)) (goto-char begin))
23417 ((memq type '(src-block verse-block))
23418 (when (eq type 'src-block)
23419 (setq contents-begin
23420 (save-excursion (goto-char begin) (forward-line) (point))))
23421 (if (= (point) contents-begin) (goto-char post-affiliated)
23422 ;; Inside a verse block, see blank lines as paragraph
23423 ;; separators.
23424 (let ((origin (point)))
23428 (if (= (point) origin) (goto-char contents-begin)
23429 (beginning-of-line))))))
23430 ((not contents-begin) (goto-char (or post-affiliated begin)))
23431 ((eq type 'paragraph)
23432 (goto-char contents-begin)
23433 ;; When at first paragraph in an item or a footnote definition,
23434 ;; move directly to beginning of line.
23435 (let ((parent-contents
23436 (org-element-property
23437 :contents-begin (org-element-property :parent element))))
23438 (when (and parent-contents (= parent-contents contents-begin))
23439 (beginning-of-line))))
23440 ;; At the end of a greater element, move to the beginning of the
23441 ;; last element within.
23442 ((>= (point) contents-end)
23443 (goto-char (1- contents-end))
23444 (org-backward-paragraph))
23445 (t (goto-char (or post-affiliated begin))))
23446 ;; Ensure we never leave point invisible.
23447 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23449 (defun org-forward-element ()
23450 "Move forward by one element.
23451 Move to the next element at the same level, when possible."
23452 (interactive)
23453 (cond ((eobp) (user-error "Cannot move further down"))
23454 ((org-with-limited-levels (org-at-heading-p))
23455 (let ((origin (point)))
23456 (goto-char (org-end-of-subtree nil t))
23457 (unless (org-with-limited-levels (org-at-heading-p))
23458 (goto-char origin)
23459 (user-error "Cannot move further down"))))
23460 (t
23461 (let* ((elem (org-element-at-point))
23462 (end (org-element-property :end elem))
23463 (parent (org-element-property :parent elem)))
23464 (cond ((and parent (= (org-element-property :contents-end parent) end))
23465 (goto-char (org-element-property :end parent)))
23466 ((integer-or-marker-p end) (goto-char end))
23467 (t (message "No element at point")))))))
23469 (defun org-backward-element ()
23470 "Move backward by one element.
23471 Move to the previous element at the same level, when possible."
23472 (interactive)
23473 (cond ((bobp) (user-error "Cannot move further up"))
23474 ((org-with-limited-levels (org-at-heading-p))
23475 ;; At a headline, move to the previous one, if any, or stay
23476 ;; here.
23477 (let ((origin (point)))
23478 (org-with-limited-levels (org-backward-heading-same-level 1))
23479 ;; When current headline has no sibling above, move to its
23480 ;; parent.
23481 (when (= (point) origin)
23482 (or (org-with-limited-levels (org-up-heading-safe))
23483 (progn (goto-char origin)
23484 (user-error "Cannot move further up"))))))
23485 (t
23486 (let* ((trail (org-element-at-point 'keep-trail))
23487 (elem (car trail))
23488 (prev-elem (nth 1 trail))
23489 (beg (org-element-property :begin elem)))
23490 (cond
23491 ;; Move to beginning of current element if point isn't
23492 ;; there already.
23493 ((null beg) (message "No element at point"))
23494 ((/= (point) beg) (goto-char beg))
23495 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23496 ((org-before-first-heading-p) (goto-char (point-min)))
23497 (t (org-back-to-heading)))))))
23499 (defun org-up-element ()
23500 "Move to upper element."
23501 (interactive)
23502 (if (org-with-limited-levels (org-at-heading-p))
23503 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23504 (let* ((elem (org-element-at-point))
23505 (parent (org-element-property :parent elem)))
23506 (if parent (goto-char (org-element-property :begin parent))
23507 (if (org-with-limited-levels (org-before-first-heading-p))
23508 (user-error "No surrounding element")
23509 (org-with-limited-levels (org-back-to-heading)))))))
23511 (defvar org-element-greater-elements)
23512 (defun org-down-element ()
23513 "Move to inner element."
23514 (interactive)
23515 (let ((element (org-element-at-point)))
23516 (cond
23517 ((memq (org-element-type element) '(plain-list table))
23518 (goto-char (org-element-property :contents-begin element))
23519 (forward-char))
23520 ((memq (org-element-type element) org-element-greater-elements)
23521 ;; If contents are hidden, first disclose them.
23522 (when (outline-invisible-p (line-end-position)) (org-cycle))
23523 (goto-char (or (org-element-property :contents-begin element)
23524 (user-error "No content for this element"))))
23525 (t (user-error "No inner element")))))
23527 (defun org-drag-element-backward ()
23528 "Move backward element at point."
23529 (interactive)
23530 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23531 (let* ((trail (org-element-at-point 'keep-trail))
23532 (elem (car trail))
23533 (prev-elem (nth 1 trail)))
23534 ;; Error out if no previous element or previous element is
23535 ;; a parent of the current one.
23536 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23537 (user-error "Cannot drag element backward")
23538 (let ((pos (point)))
23539 (org-element-swap-A-B prev-elem elem)
23540 (goto-char (+ (org-element-property :begin prev-elem)
23541 (- pos (org-element-property :begin elem)))))))))
23543 (defun org-drag-element-forward ()
23544 "Move forward element at point."
23545 (interactive)
23546 (let* ((pos (point))
23547 (elem (org-element-at-point)))
23548 (when (= (point-max) (org-element-property :end elem))
23549 (user-error "Cannot drag element forward"))
23550 (goto-char (org-element-property :end elem))
23551 (let ((next-elem (org-element-at-point)))
23552 (when (or (org-element-nested-p elem next-elem)
23553 (and (eq (org-element-type next-elem) 'headline)
23554 (not (eq (org-element-type elem) 'headline))))
23555 (goto-char pos)
23556 (user-error "Cannot drag element forward"))
23557 ;; Compute new position of point: it's shifted by NEXT-ELEM
23558 ;; body's length (without final blanks) and by the length of
23559 ;; blanks between ELEM and NEXT-ELEM.
23560 (let ((size-next (- (save-excursion
23561 (goto-char (org-element-property :end next-elem))
23563 (forward-line)
23564 ;; Small correction if buffer doesn't end
23565 ;; with a newline character.
23566 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23567 (org-element-property :begin next-elem)))
23568 (size-blank (- (org-element-property :end elem)
23569 (save-excursion
23570 (goto-char (org-element-property :end elem))
23572 (forward-line)
23573 (point)))))
23574 (org-element-swap-A-B elem next-elem)
23575 (goto-char (+ pos size-next size-blank))))))
23577 (defun org-drag-line-forward (arg)
23578 "Drag the line at point ARG lines forward."
23579 (interactive "p")
23580 (dotimes (n (abs arg))
23581 (let ((c (current-column)))
23582 (if (< 0 arg)
23583 (progn
23584 (beginning-of-line 2)
23585 (transpose-lines 1)
23586 (beginning-of-line 0))
23587 (transpose-lines 1)
23588 (beginning-of-line -1))
23589 (org-move-to-column c))))
23591 (defun org-drag-line-backward (arg)
23592 "Drag the line at point ARG lines backward."
23593 (interactive "p")
23594 (org-drag-line-forward (- arg)))
23596 (defun org-mark-element ()
23597 "Put point at beginning of this element, mark at end.
23599 Interactively, if this command is repeated or (in Transient Mark
23600 mode) if the mark is active, it marks the next element after the
23601 ones already marked."
23602 (interactive)
23603 (let (deactivate-mark)
23604 (if (and (org-called-interactively-p 'any)
23605 (or (and (eq last-command this-command) (mark t))
23606 (and transient-mark-mode mark-active)))
23607 (set-mark
23608 (save-excursion
23609 (goto-char (mark))
23610 (goto-char (org-element-property :end (org-element-at-point)))))
23611 (let ((element (org-element-at-point)))
23612 (end-of-line)
23613 (push-mark (org-element-property :end element) t t)
23614 (goto-char (org-element-property :begin element))))))
23616 (defun org-narrow-to-element ()
23617 "Narrow buffer to current element."
23618 (interactive)
23619 (let ((elem (org-element-at-point)))
23620 (cond
23621 ((eq (car elem) 'headline)
23622 (narrow-to-region
23623 (org-element-property :begin elem)
23624 (org-element-property :end elem)))
23625 ((memq (car elem) org-element-greater-elements)
23626 (narrow-to-region
23627 (org-element-property :contents-begin elem)
23628 (org-element-property :contents-end elem)))
23629 (t
23630 (narrow-to-region
23631 (org-element-property :begin elem)
23632 (org-element-property :end elem))))))
23634 (defun org-transpose-element ()
23635 "Transpose current and previous elements, keeping blank lines between.
23636 Point is moved after both elements."
23637 (interactive)
23638 (org-skip-whitespace)
23639 (let ((end (org-element-property :end (org-element-at-point))))
23640 (org-drag-element-backward)
23641 (goto-char end)))
23643 (defun org-unindent-buffer ()
23644 "Un-indent the visible part of the buffer.
23645 Relative indentation (between items, inside blocks, etc.) isn't
23646 modified."
23647 (interactive)
23648 (unless (eq major-mode 'org-mode)
23649 (user-error "Cannot un-indent a buffer not in Org mode"))
23650 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23651 unindent-tree ; For byte-compiler.
23652 (unindent-tree
23653 (function
23654 (lambda (contents)
23655 (mapc
23656 (lambda (element)
23657 (if (memq (org-element-type element) '(headline section))
23658 (funcall unindent-tree (org-element-contents element))
23659 (save-excursion
23660 (save-restriction
23661 (narrow-to-region
23662 (org-element-property :begin element)
23663 (org-element-property :end element))
23664 (org-do-remove-indentation)))))
23665 (reverse contents))))))
23666 (funcall unindent-tree (org-element-contents parse-tree))))
23668 (defun org-show-subtree ()
23669 "Show everything after this heading at deeper levels."
23670 (interactive)
23671 (outline-flag-region
23672 (point)
23673 (save-excursion
23674 (org-end-of-subtree t t))
23675 nil))
23677 (defun org-show-entry ()
23678 "Show the body directly following this heading.
23679 Show the heading too, if it is currently invisible."
23680 (interactive)
23681 (save-excursion
23682 (condition-case nil
23683 (progn
23684 (org-back-to-heading t)
23685 (outline-flag-region
23686 (max (point-min) (1- (point)))
23687 (save-excursion
23688 (if (re-search-forward
23690 (match-beginning 1)
23691 (point-max)))
23692 nil)
23693 (org-cycle-hide-drawers 'children))
23694 (error nil))))
23696 (defun org-make-options-regexp (kwds &optional extra)
23697 "Make a regular expression for keyword lines."
23698 (concat
23704 ;; Make isearch reveal the necessary context
23705 (defun org-isearch-end ()
23706 "Reveal context after isearch exits."
23707 (when isearch-success ; only if search was successful
23708 (if (featurep 'xemacs)
23709 ;; Under XEmacs, the hook is run in the correct place,
23710 ;; we directly show the context.
23711 (org-show-context 'isearch)
23712 ;; In Emacs the hook runs *before* restoring the overlays.
23713 ;; So we have to use a one-time post-command-hook to do this.
23714 ;; (Emacs 22 has a special variable, see function `org-mode')
23715 (unless (and (boundp 'isearch-mode-end-hook-quit)
23716 isearch-mode-end-hook-quit)
23717 ;; Only when the isearch was not quitted.
23718 (org-add-hook 'post-command-hook 'org-isearch-post-command
23719 'append 'local)))
23720 (org-fix-ellipsis-at-bol)))
23722 (defun org-isearch-post-command ()
23723 "Remove self from hook, and show context."
23724 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23725 (org-show-context 'isearch))
23728 ;;;; Integration with and fixes for other packages
23730 ;;; Imenu support
23732 (defvar org-imenu-markers nil
23733 "All markers currently used by Imenu.")
23734 (make-variable-buffer-local 'org-imenu-markers)
23736 (defun org-imenu-new-marker (&optional pos)
23737 "Return a new marker for use by Imenu, and remember the marker."
23738 (let ((m (make-marker)))
23739 (move-marker m (or pos (point)))
23740 (push m org-imenu-markers)
23741 m))
23743 (defun org-imenu-get-tree ()
23744 "Produce the index for Imenu."
23745 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23746 (setq org-imenu-markers nil)
23747 (let* ((n org-imenu-depth)
23748 (re (concat "^" (org-get-limited-outline-regexp)))
23749 (subs (make-vector (1+ n) nil))
23750 (last-level 0)
23751 m level head0 head)
23752 (save-excursion
23753 (save-restriction
23754 (widen)
23755 (goto-char (point-max))
23756 (while (re-search-backward re nil t)
23757 (setq level (org-reduced-level (funcall outline-level)))
23758 (when (and (<= level n)
23759 (looking-at org-complex-heading-regexp)
23760 (setq head0 (org-match-string-no-properties 4)))
23761 (setq head (org-link-display-format head0)
23762 m (org-imenu-new-marker))
23763 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23764 (if (>= level last-level)
23765 (push (cons head m) (aref subs level))
23766 (push (cons head (aref subs (1+ level))) (aref subs level))
23767 (loop for i from (1+ level) to n do (aset subs i nil)))
23768 (setq last-level level)))))
23769 (aref subs 1)))
23771 (eval-after-load "imenu"
23772 '(progn
23773 (add-hook 'imenu-after-jump-hook
23774 (lambda ()
23775 (if (derived-mode-p 'org-mode)
23776 (org-show-context 'org-goto))))))
23778 (defun org-link-display-format (link)
23779 "Replace a link with its the description.
23780 If there is no description, use the link target."
23781 (save-match-data
23782 (if (string-match org-bracket-link-analytic-regexp link)
23783 (replace-match (if (match-end 5)
23784 (match-string 5 link)
23785 (concat (match-string 1 link)
23786 (match-string 3 link)))
23787 nil t link)
23788 link)))
23790 (defun org-toggle-link-display ()
23791 "Toggle the literal or descriptive display of links."
23792 (interactive)
23793 (if org-descriptive-links
23794 (progn (org-remove-from-invisibility-spec '(org-link))
23795 (org-restart-font-lock)
23796 (setq org-descriptive-links nil))
23797 (progn (add-to-invisibility-spec '(org-link))
23798 (org-restart-font-lock)
23799 (setq org-descriptive-links t))))
23801 ;; Speedbar support
23803 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23804 "Overlay marking the agenda restriction line in speedbar.")
23805 (overlay-put org-speedbar-restriction-lock-overlay
23806 'face 'org-agenda-restriction-lock)
23807 (overlay-put org-speedbar-restriction-lock-overlay
23808 'help-echo "Agendas are currently limited to this item.")
23809 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23811 (defun org-speedbar-set-agenda-restriction ()
23812 "Restrict future agenda commands to the location at point in speedbar.
23814 (interactive)
23815 (require 'org-agenda)
23816 (let (p m tp np dir txt)
23817 (cond
23818 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23819 'org-imenu t))
23820 (setq m (get-text-property p 'org-imenu-marker))
23821 (with-current-buffer (marker-buffer m)
23822 (goto-char m)
23823 (org-agenda-set-restriction-lock 'subtree)))
23824 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23825 'speedbar-function 'speedbar-find-file))
23826 (setq tp (previous-single-property-change
23827 (1+ p) 'speedbar-function)
23828 np (next-single-property-change
23829 tp 'speedbar-function)
23830 dir (speedbar-line-directory)
23831 txt (buffer-substring-no-properties (or tp (point-min))
23832 (or np (point-max))))
23833 (with-current-buffer (find-file-noselect
23834 (let ((default-directory dir))
23835 (expand-file-name txt)))
23836 (unless (derived-mode-p 'org-mode)
23837 (user-error "Cannot restrict to non-Org-mode file"))
23838 (org-agenda-set-restriction-lock 'file)))
23839 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23840 (move-overlay org-speedbar-restriction-lock-overlay
23841 (point-at-bol) (point-at-eol))
23842 (setq current-prefix-arg nil)
23843 (org-agenda-maybe-redo)))
23845 (defvar speedbar-file-key-map)
23846 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23847 (eval-after-load "speedbar"
23848 '(progn
23849 (speedbar-add-supported-extension ".org")
23850 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23851 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23852 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23853 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23854 (add-hook 'speedbar-visiting-tag-hook
23855 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23857 ;;; Fixes and Hacks for problems with other packages
23859 ;; Make flyspell not check words in links, to not mess up our keymap
23860 (defvar org-element-affiliated-keywords) ; From org-element.el
23861 (defvar org-element-block-name-alist) ; From org-element.el
23862 (defun org-mode-flyspell-verify ()
23863 "Don't let flyspell put overlays at active buttons, or on
23864 {todo,all-time,additional-option-like}-keywords."
23865 (require 'org-element) ; For `org-element-affiliated-keywords'
23866 (let ((pos (max (1- (point)) (point-min)))
23867 (word (thing-at-point 'word)))
23868 (and (not (get-text-property pos 'keymap))
23869 (not (get-text-property pos 'org-no-flyspell))
23870 (not (member word org-todo-keywords-1))
23871 (not (member word org-all-time-keywords))
23872 (not (member word org-options-keywords))
23873 (not (member word (mapcar 'car org-startup-options)))
23874 (not (member-ignore-case word org-element-affiliated-keywords))
23875 (not (member-ignore-case word (org-get-export-keywords)))
23876 (not (member-ignore-case
23877 word (mapcar 'car org-element-block-name-alist)))
23878 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23879 (not (org-in-src-block-p)))))
23881 (defun org-remove-flyspell-overlays-in (beg end)
23882 "Remove flyspell overlays in region."
23883 (and (org-bound-and-true-p flyspell-mode)
23884 (fboundp 'flyspell-delete-region-overlays)
23885 (flyspell-delete-region-overlays beg end))
23886 (add-text-properties beg end '(org-no-flyspell t)))
23888 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23889 (eval-after-load "bookmark"
23890 '(if (boundp 'bookmark-after-jump-hook)
23891 ;; We can use the hook
23892 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23893 ;; Hook not available, use advice
23894 (defadvice bookmark-jump (after org-make-visible activate)
23895 "Make the position visible."
23896 (org-bookmark-jump-unhide))))
23898 ;; Make sure saveplace shows the location if it was hidden
23899 (eval-after-load "saveplace"
23900 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23901 "Make the position visible."
23902 (org-bookmark-jump-unhide)))
23904 ;; Make sure ecb shows the location if it was hidden
23905 (eval-after-load "ecb"
23906 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23907 "Make hierarchy visible when jumping into location from ECB tree buffer."
23908 (if (derived-mode-p 'org-mode)
23909 (org-show-context))))
23911 (defun org-bookmark-jump-unhide ()
23912 "Unhide the current position, to show the bookmark location."
23913 (and (derived-mode-p 'org-mode)
23914 (or (outline-invisible-p)
23915 (save-excursion (goto-char (max (point-min) (1- (point))))
23916 (outline-invisible-p)))
23917 (org-show-context 'bookmark-jump)))
23919 ;; Make session.el ignore our circular variable
23920 (defvar session-globals-exclude)
23921 (eval-after-load "session"
23922 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23924 ;;;; Finish up
23926 (provide 'org)
23928 (run-hooks 'org-load-hook)
23930 ;;; org.el ends here