| blob | e750ba0360c0cbed2c99ddcce340e46d18908c76 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;
26 ;;; Commentary:
27 ;;
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
30 ;;
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
45 ;;
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
49 ;;
50 ;; http://orgmode.org/org.html#Installation
51 ;;
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
59 ;;
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
62 ;;
63 ;;; Code:
70 ;;;; Require other packages
85 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
86 ;; some places -- e.g. see the macro `org-with-limited-levels'.
87 ;;
88 ;; In Org buffers, the value of `outline-regexp' is that of
89 ;; `org-outline-regexp'. The only function still directly relying on
90 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
91 ;; job when `orgstruct-mode' is active.
96 "Regexp to match Org headlines.
97 This is similar to `org-outline-regexp' but additionally makes
101 "Matches a headline, putting stars and text into groups.
104 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
117 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
163 ;; load languages based on value of `org-babel-load-languages'
166 ;;;###autoload
168 "Load the languages defined in `org-babel-load-languages'."
180 org-babel-load-languages))
182 ;;;###autoload
184 "Load Emacs Lisp source code blocks in the Org-mode FILE.
185 This function exports the source code using `org-babel-tangle'
186 and then loads the resulting file using `load-file'. With prefix
187 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
188 file to byte-code before it is loaded."
198 ;; tangle if the org-mode file is newer than the elisp file
207 exported-file)))
210 "Languages which can be evaluated in Org-mode buffers.
211 This list can be used to load support for any of the languages
212 below, note that each language will depend on a different set of
213 system executables and/or Emacs modes. When a language is
215 with `org-babel-execute-src-block' bound by default to C-c
216 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
217 be set to remove code block evaluation from the C-c C-c
218 keybinding. By default only Emacs Lisp (which has no
219 requirements) is loaded."
224 :key-type
268 ;;;; Customization variables
270 "Remove ID property of clones of a subtree.
271 When non-nil, clones of a subtree don't inherit the ID property.
272 Otherwise they inherit the ID property with a new unique
273 identifier."
278 ;;; Version
281 ;;;###autoload
283 "Show the org-mode version in the echo area.
284 With prefix argument HERE, insert it at point.
285 When FULL is non-nil, use a verbose version string.
286 When MESSAGE is non-nil, display a message with the version."
299 org-version
300 git-version
303 org-install-dir
312 _version)))
316 ;;; Compatibility constants
318 ;;; The custom variables
321 "Outline-based notes management and organizer."
327 "Mode hook for Org-mode, run after the mode was turned on."
332 "Hook that is run after org.el has been loaded."
337 "Hook that is run after an Org log buffer is created."
347 "Load all extensions listed in `org-modules'."
352 org-modules)
356 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
361 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
362 "Modules that should always be loaded together with org.el.
364 If a description starts with <C>, the file is not part of Emacs
365 and loading it will require that you have downloaded and properly
366 installed the Org mode distribution.
368 You can also use this system to load external packages (i.e. neither Org
369 core modules, nor modules from the CONTRIB directory). Just add symbols
370 to the end of the list. If the package is called org-xyz.el, then you need
371 to add the symbol `xyz', and the package must have a call to:
373 \(provide 'org-xyz)
375 For export specific modules, see also `org-export-backends'."
380 :type
405 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
414 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
442 "List of export back-ends that should be always available.
444 If a description starts with <C>, the file is not part of Emacs
445 and loading it will require that you have downloaded and properly
446 installed the Org mode distribution.
448 Unlike to `org-modules', libraries in this list will not be
449 loaded along with Org, but only once the export framework is
450 needed.
452 This variable needs to be set before org.el is loaded. If you
453 need to make a change while Emacs is running, use the customize
454 interface or run the following code, where VAL stands for the new
455 value of the variable, after updating it:
457 \(progn
458 \(setq org-export--registered-backends
459 \(org-remove-if-not
460 \(lambda (backend)
461 \(let ((name (org-export-backend-name backend)))
462 \(or (memq name val)
463 \(catch 'parentp
464 \(dolist (b val)
465 \(and (org-export-derived-backend-p b name)
466 \(throw 'parentp t)))))))
467 org-export--registered-backends))
468 \(let ((new-list (mapcar 'org-export-backend-name
469 org-export--registered-backends)))
470 \(dolist (backend val)
471 \(cond
474 backend))
475 \((not (memq backend new-list)) (push backend new-list))))
476 \(set-default 'org-export-backends new-list)))
478 Adding a back-end to this list will also pull the back-end it
479 depends on, if any."
487 ;; Any back-end not required anymore (not present in VAL and not
488 ;; a parent of any back-end in the new value) is removed from the
489 ;; list of registered back-ends.
499 org-export--registered-backends))
500 ;; Now build NEW-LIST of both new back-ends and required
501 ;; parents.
503 org-export--registered-backends)))
508 backend))
510 ;; Set VAR to that list with fixed dependencies.
537 backend))))
538 org-export-backends))
541 "Non-nil means make shift-cursor commands select text when possible.
543 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
544 start selecting a region, or enlarge regions started in this way.
545 In Org-mode, in special contexts, these same keys are used for
546 other purposes, important enough to compete with shift selection.
547 Org tries to balance these needs by supporting `shift-select-mode'
548 outside these special contexts, under control of this variable.
550 The default of this variable is nil, to avoid confusing behavior. Shifted
551 cursor keys will then execute Org commands in the following contexts:
552 - on a headline, changing TODO state (left/right) and priority (up/down)
553 - on a time stamp, changing the time
554 - in a plain list item, changing the bullet type
555 - in a property definition line, switching between allowed values
556 - in the BEGIN line of a clock table (changing the time block).
557 Outside these contexts, the commands will throw an error.
559 When this variable is t and the cursor is not in a special
560 context, Org-mode will support shift-selection for making and
561 enlarging regions. To make this more effective, the bullet
562 cycling will no longer happen anywhere in an item line, but only
563 if the cursor is exactly on the bullet.
565 If you set this variable to the symbol `always', then the keys
566 will not be special in headlines, property lines, and item lines,
567 to make shift selection work there as well. If this is what you
568 want, you can use the following alternative commands: `C-c C-t'
569 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
570 can be used to switch TODO sets, `C-c -' to cycle item bullet
571 types, and properties can be edited by hand or in column view.
573 However, when the cursor is on a timestamp, shift-cursor commands
574 will still edit the time stamp - this is just too good to give up.
576 XEmacs user should have this variable set to nil, because
577 `shift-select-mode' is in Emacs 23 or later only."
585 "Shall some commands act upon headlines in the active region?
587 When set to `t', some commands will be performed in all headlines
588 within the active region.
590 When set to `start-level', some commands will be performed in all
591 headlines within the active region, provided that these headlines
592 are of the same level than the first one.
594 When set to a string, those commands will be performed on the
595 matching headlines within the active region. Such string must be
596 a tags/property/todo match as it is used in the agenda tags view.
598 The list of commands is: `org-schedule', `org-deadline',
599 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
600 `org-archive-to-archive-sibling'. The archiving commands skip
601 already archived entries."
611 "Options concerning startup of Org-mode."
616 "Non-nil means entering Org-mode will switch to OVERVIEW.
617 This can also be configured on a per-file basis by adding one of
618 the following lines anywhere in the buffer:
620 #+STARTUP: fold (or `overview', this is equivalent)
621 #+STARTUP: nofold (or `showall', this is equivalent)
622 #+STARTUP: content
623 #+STARTUP: showeverything
625 By default, this option is ignored when Org opens agenda files
626 for the first time. If you want the agenda to honor the startup
627 option, set `org-agenda-inhibit-startup' to nil."
636 "Non-nil means entering Org-mode will set `truncate-lines'.
637 This is useful since some lines containing links can be very long and
638 uninteresting. Also tables look terrible when wrapped."
643 "Non-nil means turn on `org-indent-mode' on startup.
644 This can also be configured on a per-file basis by adding one of
645 the following lines anywhere in the buffer:
647 #+STARTUP: indent
648 #+STARTUP: noindent"
656 When this option is turned on, you can use TeX-like syntax for sub- and
658 considered as a single item - so grouping with {} is normally not
659 needed. For example, the following things will be parsed as single
660 sub- or superscripts.
662 10^24 or 10^tau several digits will be considered 1 item.
663 10^-12 or 10^-tau a leading sign with digits or a word
664 x^2-y^3 will be read as x^2 - y^3, because items are
665 terminated by almost any nonword/nondigit char.
666 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
668 Still, ambiguity is possible - so when in doubt use {} to enclose
669 the sub/superscript. If you set this variable to the symbol
670 `{}', the braces are *required* in order to trigger
671 interpretations as sub/superscript. This can be helpful in
681 "Non-nil means turn on `org-beamer-mode' on startup.
682 This can also be configured on a per-file basis by adding one of
683 the following lines anywhere in the buffer:
685 #+STARTUP: beamer"
691 "Non-nil means align all tables when visiting a file.
692 This is useful when the column width in tables is forced with <N> cookies
693 in table fields. Such tables will look correct only after the first re-align.
694 This can also be configured on a per-file basis by adding one of
695 the following lines anywhere in the buffer:
696 #+STARTUP: align
697 #+STARTUP: noalign"
702 "Non-nil means show inline images when loading a new Org file.
703 This can also be configured on a per-file basis by adding one of
704 the following lines anywhere in the buffer:
705 #+STARTUP: inlineimages
706 #+STARTUP: noinlineimages"
712 "Non-nil means preview LaTeX fragments when loading a new Org file.
714 This can also be configured on a per-file basis by adding one of
715 the followinglines anywhere in the buffer:
716 #+STARTUP: latexpreview
717 #+STARTUP: nolatexpreview"
724 "Non-nil means insert the first line setting Org-mode in empty files.
725 When the function `org-mode' is called interactively in an empty file, this
726 normally means that the file name does not automatically trigger Org-mode.
727 To ensure that the file will always be in Org-mode in the future, a
728 line enforcing Org-mode will be inserted into the buffer, if this option
729 has been set."
734 "Non-nil means use alternative key bindings for some keys.
735 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
736 These keys are also used by other packages like shift-selection-mode'
737 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
738 If you want to use Org-mode together with one of these other modes,
739 or more generally if you would like to move some Org-mode commands to
740 other keys, set this variable and configure the keys with the variable
741 `org-disputed-keys'.
743 This option is only relevant at load-time of Org-mode, and must be set
744 *before* org.el is loaded. Changing it requires a restart of Emacs to
745 become effective."
750 "Non-nil means use extra key sequence definitions for certain commands.
751 This happens automatically if you run XEmacs or if `window-system'
752 is nil. This variable lets you do the same manually. You must
753 set it before loading org.
755 Example: on Carbon Emacs 22 running graphically, with an external
756 keyboard on a Powerbook, the default way of setting M-left might
757 not work for either Alt or ESC. Setting this variable will make
758 it work for ESC."
771 "Keys for which Org-mode and other modes compete.
772 This is an alist, cars are the default keys, second element specifies
773 the alternative to use when `org-replace-disputed-keys' is t.
775 Keys can be specified in any syntax supported by `define-key'.
776 The value of this option takes effect only at Org-mode's startup,
777 therefore you'll have to restart Emacs to apply it after changing."
782 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
783 Or return the original if not disputed.
784 Also apply the translations defined in `org-xemacs-key-equivalents'."
789 org-disputed-keys)))
793 key)
803 "Define a key, possibly translated, as returned by `org-key'."
807 "The ellipsis to use in the Org-mode outline.
808 When nil, just use the standard three dots. When a string, use that instead,
809 When a face, use the standard 3 dots, but with the specified face.
810 The change affects only Org-mode (which will then use its own display table).
811 Changing this requires executing `M-x org-mode' in a buffer to become
812 effective."
822 "Keywords in Org-mode."
827 "String to mark deadline entries.
828 A deadline is this string, followed by a time stamp. Should be a word,
829 terminated by a colon. You can insert a schedule keyword and
831 Changes become only effective after restarting Emacs."
836 "String to mark scheduled TODO entries.
837 A schedule is this string, followed by a time stamp. Should be a word,
838 terminated by a colon. You can insert a schedule keyword and
840 Changes become only effective after restarting Emacs."
845 "String used as the prefix for timestamps logging closing a TODO entry."
850 "String used as prefix for timestamps clocking work hours on an item."
855 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
870 "Entries starting with this keyword will never be exported.
871 An entry can be toggled between COMMENT and normal with
873 Changes become only effective after restarting Emacs."
878 "Entries starting with this keyword will be exported in fixed-width font.
879 Quoting applies only to the text in the entry following the headline, and does
880 not extend beyond the next headline, even if that is lower level.
881 An entry can be toggled between QUOTE and normal with
888 "Regular expression for specifying repeated events.
892 "Options concerning the general structure of Org-mode files."
897 "Options about how to make context of a location visible."
921 "Non-nil means show full hierarchy when revealing a location.
922 Org-mode often shows locations in an org-mode file which might have
923 been invisible before. When this is set, the hierarchy of headings
924 above the exposed location is shown.
925 Turning this off for example for sparse trees makes them very compact.
926 Instead of t, this can also be an alist specifying this option for different
927 contexts. Valid contexts are
928 agenda when exposing an entry from the agenda
929 org-goto when using the command `org-goto' on key C-c C-j
930 occur-tree when using the command `org-occur' on key C-c /
931 tags-tree when constructing a sparse tree based on tags matches
932 link-search when exposing search matches associated with a link
933 mark-goto when exposing the jump goal of a mark
934 bookmark-jump when exposing a bookmark location
935 isearch when exiting from an incremental search
936 default default for all contexts not set explicitly"
941 "Non-nil means show following heading when revealing a location.
942 Org-mode often shows locations in an org-mode file which might have
943 been invisible before. When this is set, the heading following the
944 match is shown.
945 Turning this off for example for sparse trees makes them very compact,
946 but makes it harder to edit the location of the match. In such a case,
948 Instead of t, this can also be an alist specifying this option for different
949 contexts. See `org-show-hierarchy-above' for valid contexts."
954 "Non-nil means show all sibling heading when revealing a location.
955 Org-mode often shows locations in an org-mode file which might have
956 been invisible before. When this is set, the sibling of the current entry
957 heading are all made visible. If `org-show-hierarchy-above' is t,
958 the same happens on each level of the hierarchy above the current entry.
960 By default this is on for the isearch context, off for all other contexts.
961 Turning this off for example for sparse trees makes them very compact,
962 but makes it harder to edit the location of the match. In such a case,
964 Instead of t, this can also be an alist specifying this option for different
965 contexts. See `org-show-hierarchy-above' for valid contexts."
967 :type org-context-choice
972 "Non-nil means show the entry below a headline when revealing a location.
973 Org-mode often shows locations in an org-mode file which might have
974 been invisible before. When this is set, the text below the headline that is
975 exposed is also shown.
977 By default this is off for all contexts.
978 Instead of t, this can also be an alist specifying this option for different
979 contexts. See `org-show-hierarchy-above' for valid contexts."
984 "How should indirect tree buffers be displayed?
985 This applies to indirect buffers created with the commands
987 Valid values are:
988 current-window Display in the current window
989 other-window Just display in another window.
990 dedicated-frame Create one new frame, and re-use it each time.
991 new-frame Make a new frame each time. Note that in this case
992 previously-made indirect buffers are kept, and you need to
993 kill these buffers yourself."
1003 "Non-nil means activate single letter commands at beginning of a headline.
1004 This may also be a function to test for appropriate locations where speed
1005 commands should be active."
1013 "Alist of additional speed commands.
1014 This list will be checked before `org-speed-commands-default'
1015 when the variable `org-use-speed-commands' is non-nil
1016 and when the cursor is at the beginning of a headline.
1017 The car if each entry is a string with a single letter, which must
1018 be assigned to `self-insert-command' in the global map.
1019 The cdr is either a command to be called interactively, a function
1020 to be called, or a form to be evaluated.
1021 An entry that is just a list with a single string will be interpreted
1022 as a descriptive headline that will be added when listing the speed
1023 commands in the Help buffer using the `?' speed command."
1038 "Names for bookmarks automatically set by some Org commands.
1039 This can provide strings as names for a number of bookmakrs Org sets
1040 automatically. The following keys are currently implemented:
1041 :last-capture
1042 :last-capture-marker
1043 :last-refile
1044 When a key does not show up in the property list, the corresponding bookmark
1045 is not set."
1050 "Options concerning visibility cycling in Org-mode."
1055 "Non-nil means skip CHILDREN state in entries that don't have any."
1060 "Maximum level which should still be subject to visibility cycling.
1061 Levels higher than this will, for cycling, be treated as text, not a headline.
1062 When `org-odd-levels-only' is set, a value of N in this variable actually
1063 means 2N-1 stars as the limiting headline.
1064 When nil, cycle all levels.
1065 Note that the limiting level of cycling is also influenced by
1066 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1067 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1068 than its value."
1075 "Names of drawers. Drawers are not opened by cycling on the headline above.
1076 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1077 this:
1078 :DRAWERNAME:
1079 .....
1080 :END:
1082 the property API.
1084 Drawers can be defined on the per-file basis with a line like:
1086 #+DRAWERS: HIDDEN STATE PROPERTIES"
1092 "Non-nil means entering Org-mode will fold all blocks.
1093 This can also be set in on a per-file basis with
1095 #+STARTUP: hideblocks
1096 #+STARTUP: showblocks"
1102 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1103 This makes it possible to do global cycling without having to use S-TAB or
1105 of the buffer must not be a headline -- it may be empty or some other text.
1106 When used in this way, `org-cycle-hook' is disabled temporarily to make
1107 sure the cursor stays at the beginning of the buffer. When this option is
1108 nil, don't do anything special at the beginning of the buffer."
1113 "Non-nil means cycle entry level or item indentation in new empty entries.
1115 When the cursor is at the end of an empty headline, i.e., with only stars
1116 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1117 and then all possible ancestor states, before returning to the original state.
1118 This makes data entry extremely fast: M-RET to create a new headline,
1119 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1121 When the cursor is at the end of an empty plain list item, one TAB will
1122 make it a subitem, two or more tabs will back up to make this an item
1123 higher up in the item hierarchy."
1128 "Where should `org-cycle' emulate TAB.
1129 nil Never
1130 white Only in completely white lines
1131 whitestart Only at the beginning of lines, before the first non-white char
1132 t Everywhere except in headlines
1133 exc-hl-bol Everywhere except at the start of a headline
1134 If TAB is used in a place where it does not emulate TAB, the current subtree
1135 visibility is cycled."
1144 "Number of empty lines needed to keep an empty line between collapsed trees.
1145 If you leave an empty line between the end of a subtree and the following
1146 headline, this empty line is hidden when the subtree is folded.
1147 Org-mode will leave (exactly) one empty line visible if the number of
1148 empty lines is equal or larger to the number given in this variable.
1149 So the default 2 means at least 2 empty lines after the end of a subtree
1150 are needed to produce free space between a collapsed subtree and the
1151 following headline.
1153 If the number is negative, and the number of empty lines is at least -N,
1154 all empty lines are shown.
1156 Special case: when 0, never leave empty lines in collapsed view."
1162 "Hook that is run before visibility cycling is happening.
1163 The function(s) in this hook must accept a single argument which indicates
1164 the new state that will be set right after running this hook. The
1165 argument is a symbol. Before a global state change, it can have the values
1166 `overview', `content', or `all'. Before a local state change, it can have
1167 the values `folded', `children', or `subtree'."
1172 org-cycle-hide-drawers
1173 org-cycle-hide-inline-tasks
1174 org-cycle-show-empty-lines
1175 org-optimize-window-after-visibility-change)
1176 "Hook that is run after `org-cycle' has changed the buffer visibility.
1177 The function(s) in this hook must accept a single argument which indicates
1178 the new state that was set by the most recent `org-cycle' command. The
1179 argument is a symbol. After a global state change, it can have the values
1180 `overview', `contents', or `all'. After a local state change, it can have
1181 the values `folded', `children', or `subtree'."
1186 "Options concerning structure editing in Org-mode."
1191 "Non-nil means skip even levels and only use odd levels for the outline.
1192 This has the effect that two stars are being added/taken away in
1193 promotion/demotion commands. It also influences how levels are
1194 handled by the exporters.
1195 Changing it requires restart of `font-lock-mode' to become effective
1196 for fontification also in regions already fontified.
1197 You may also set this on a per-file basis by adding one of the following
1198 lines to the buffer:
1200 #+STARTUP: odd
1201 #+STARTUP: oddeven"
1207 "Non-nil means adapt indentation to outline node level.
1209 When this variable is set, Org assumes that you write outlines by
1210 indenting text in each node to align with the headline (after the stars).
1211 The following issues are influenced by this variable:
1213 - When this is set and the *entire* text in an entry is indented, the
1214 indentation is increased by one space in a demotion command, and
1215 decreased by one in a promotion command. If any line in the entry
1216 body starts with text at column 0, indentation is not changed at all.
1218 - Property drawers and planning information is inserted indented when
1219 this variable s set. When nil, they will not be indented.
1221 - TAB indents a line relative to context. The lines below a headline
1222 will be indented when this variable is set.
1224 Note that this is all about true indentation, by adding and removing
1225 space characters. See also `org-indent.el' which does level-dependent
1226 indentation in a virtual way, i.e. at display time in Emacs."
1231 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1233 When t, `C-a' will bring back the cursor to the beginning of the
1234 headline text, i.e. after the stars and after a possible TODO
1235 keyword. In an item, this will be the position after bullet and
1236 check-box, if any. When the cursor is already at that position,
1237 another `C-a' will bring it to the beginning of the line.
1239 `C-e' will jump to the end of the headline, ignoring the presence
1240 of tags in the headline. A second `C-e' will then jump to the
1241 true end of the line, after any tags. This also means that, when
1242 this variable is non-nil, `C-e' also will never jump beyond the
1243 end of the heading of a folded section, i.e. not after the
1244 ellipses.
1246 When set to the symbol `reversed', the first `C-a' or `C-e' works
1247 normally, going to the true line boundary first. Only a directly
1248 following, identical keypress will bring the cursor to the
1249 special positions.
1251 This may also be a cons cell where the behavior for `C-a' and
1252 `C-e' is set separately."
1270 "Non-nil means `C-k' will behave specially in headlines.
1271 When nil, `C-k' will call the default `kill-line' command.
1272 When t, the following will happen while the cursor is in the headline:
1274 - When the cursor is at the beginning of a headline, kill the entire
1275 line and possible the folded subtree below the line.
1276 - When in the middle of the headline text, kill the headline up to the tags.
1277 - When after the headline text, kill the tags."
1282 "Non-nil means, do not delete a hidden subtree with C-k.
1283 When set to the symbol `error', simply throw an error when C-k is
1284 used to kill (part-of) a headline that has hidden text behind it.
1285 Any other non-nil value will result in a query to the user, if it is
1286 OK to kill that hidden subtree. When nil, kill without remorse."
1295 "Non-nil means, make `C-o' insert a row in tables."
1300 "Check if in invisible region before inserting or deleting a character.
1301 Valid values are:
1303 nil Do not check, so just do invisible edits.
1304 error Throw an error and do nothing.
1305 show Make point visible, and do the requested edit.
1306 show-and-error Make point visible, then throw an error and abort the edit.
1307 smart Make point visible, and do insertion/deletion if it is
1308 adjacent to visible text and the change feels predictable.
1309 Never delete a previously invisible character or add in the
1310 middle or right after an invisible region. Basically, this
1311 allows insertion and backward-delete right before ellipses.
1312 FIXME: maybe in this case we should not even show?"
1323 "Non-nil means when yanking subtrees, fold them.
1324 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1325 it starts with a heading and all other headings in it are either children
1326 or siblings, then fold all the subtrees. However, do this only if no
1327 text after the yank would be swallowed into a folded tree by this action."
1332 "Non-nil means when yanking subtrees, adjust the level.
1333 With this setting, `org-paste-subtree' is used to insert the subtree, see
1334 this function for details."
1339 "Non-nil means M-RET will split the line at the cursor position.
1340 When nil, it will go to the end of the line before making a
1341 new line.
1342 You may also set this option in a different way for different
1343 contexts. Valid contexts are:
1345 headline when creating a new headline
1346 item when creating a new item
1347 table in a table field
1348 default the value to be used for all contexts not explicitly
1349 customized"
1366 "Non-nil means insert new headings after the current subtree.
1367 When nil, the new heading is created directly after the current line.
1368 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1369 this variable on for the duration of the command."
1375 "Should `org-insert-heading' leave a blank line before new heading/item?
1376 The value is an alist, with `heading' and `plain-list-item' as CAR,
1377 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1378 which case Org will look at the surrounding headings/items and try to
1379 make an intelligent decision whether to insert a blank line or not.
1381 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1382 the setting here is ignored and no empty line is inserted to avoid breaking
1383 the list structure."
1396 "Hook being run after inserting a new heading."
1402 This currently only means they are never auto-wrapped.
1403 When nil, such lines will be treated like ordinary lines.
1404 See also the QUOTE keyword."
1409 "Non-nil means typing characters in `org-goto' starts incremental search.
1410 When nil, you can use these keybindings to navigate the buffer:
1412 q Quit the org-goto interface
1413 n Go to the next visible heading
1414 p Go to the previous visible heading
1415 f Go one heading forward on same level
1416 b Go one heading backward on same level
1417 u Go one heading up"
1422 "Options concerning sparse trees in Org-mode."
1427 "Non-nil means highlight all matches that define a sparse tree.
1428 The highlights will automatically disappear the next time the buffer is
1429 changed by an edit command."
1434 "Non-nil means any change to the buffer will remove temporary highlights.
1435 Such highlights are created by `org-occur' and `org-clock-display'.
1436 When nil, `C-c C-c needs to be used to get rid of the highlights.
1437 The highlights created by `org-preview-latex-fragment' always need
1438 `C-c C-c' to be removed."
1445 "Hook that is run after `org-occur' has constructed a sparse tree.
1446 This can be used to recenter the window to show as much of the structure
1447 as possible."
1452 "Options concerning imenu and speedbar in Org-mode."
1457 "The maximum level for Imenu access to Org-mode headlines.
1458 This also applied for speedbar access."
1463 "Options concerning tables in Org-mode."
1469 When nil, such lines will be treated like ordinary lines.
1471 When equal to the symbol `optimized', the table editor will be optimized to
1472 do the following:
1473 - Automatic overwrite mode in front of whitespace in table fields.
1474 This makes the structure of the table stay in tact as long as the edited
1475 field does not exceed the column width.
1476 - Minimize the number of realigns. Normally, the table is aligned each time
1477 TAB or RET are pressed to move to another field. With optimization this
1478 happens only if changes to a field might have changed the column width.
1479 Optimization requires replacing the functions `self-insert-command',
1480 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1481 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1482 very good at guessing when a re-align will be necessary, but you can always
1485 If you would like to use the optimized version in Org-mode, but the
1486 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1488 This variable can be used to turn on and off the table editor during a session,
1489 but in order to toggle optimization, a restart is required.
1491 See also the variable `org-table-auto-blank-field'."
1500 "Non-nil means cluster self-insert commands for undo when possible.
1501 If this is set, then, like in the Emacs command loop, 20 consecutive
1502 characters will be undone together.
1503 This is configurable, because there is some impact on typing performance."
1508 "Non-nil means TAB will automatically notice a table.el table.
1509 When it sees such a table, it moves point into it and - if necessary -
1510 calls `table-recognize-table'."
1515 "Options concerning links in Org-mode."
1520 "Buffer-local version of `org-link-abbrev-alist', which see.
1525 "Alist of link abbreviations.
1526 The car of each element is a string, to be replaced at the start of a link.
1528 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1530 [[linkkey:tag][description]]
1532 The 'linkkey' must be a word word, starting with a letter, followed
1533 by letters, numbers, '-' or '_'.
1535 If REPLACE is a string, the tag will simply be appended to create the link.
1538 at that point (see the function `url-hexify-string'). If the string contains
1540 be invoked: this function takes the tag as its only argument and must return
1541 a string.
1543 REPLACE may also be a function that will be called with the tag as the
1544 only argument to create the link, which should be returned as a string.
1546 See the manual for examples."
1556 "Non-nil means Org will display descriptive links.
1557 E.g. [[http://orgmode.org][Org website]] will be displayed as
1559 description. When set to `nil', Org will display the full links
1560 literally.
1562 You can interactively set the value of this variable by calling
1563 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1568 "How the path name in file links should be stored.
1569 Valid values are:
1571 relative Relative to the current directory, i.e. the directory of the file
1572 into which the link is being inserted.
1573 absolute Absolute path, if possible with ~ for home directory.
1574 noabbrev Absolute path, no abbreviation of home directory.
1575 adaptive Use relative path for files in the current directory and sub-
1576 directories of it. For other files, use an absolute path."
1585 "Types of links that should be activated in Org-mode files.
1586 This is a list of symbols, each leading to the activation of a certain link
1587 type. In principle, it does not hurt to turn on most link types - there may
1588 be a small gain when turning off unused link types. The types are:
1590 bracket The recommended [[link][description]] or [[link]] links with hiding.
1591 angle Links in angular brackets that may contain whitespace like
1592 <bbdb:Carsten Dominik>.
1593 plain Plain links in normal text, no whitespace, like http://google.com.
1594 radio Text that is matched by a radio target, see manual for details.
1595 tag Tag settings in a headline (link to tag search).
1596 date Time stamps (link to calendar).
1597 footnote Footnote labels.
1599 Changing this variable requires a restart of Emacs to become effective."
1611 "Function to use for generating link descriptions from links.
1612 When nil, the link location will be used. This function must take
1613 two parameters: the first one is the link, the second one is the
1614 description generated by `org-insert-link'. The function should
1615 return the description to use."
1620 "Options concerning storing links in Org-mode."
1625 "When non-nil, hexify URL when creating a link."
1631 "Format of the description part of a link to an email or usenet message.
1632 The following %-escapes will be replaced by corresponding information:
1640 %s subject
1641 %d date
1642 %m message-id.
1644 You may use normal field width specification between the % and the letter.
1645 This is for example useful to limit the length of the subject.
1659 It should match if the message is from the user him/herself."
1664 "Non-nil means file links from `org-store-link' contain context.
1665 A search string will be added to the file name with :: as separator and
1666 used to find the context when the link is activated by the command
1667 `org-open-at-point'. When this option is t, the entire active region
1668 will be placed in the search string of the file link. If set to a
1669 positive integer, only the first n lines of context will be stored.
1672 negates this setting for the duration of the command."
1677 "Non-nil means keep link in list for entire session.
1679 The command `org-store-link' adds a link pointing to the current
1680 location to an internal list. These links accumulate during a session.
1681 The command `org-insert-link' can be used to insert links into any
1682 Org-mode file (offering completion for all stored links). When this
1684 will be removed from the list, to make completing the unused links
1685 more efficient."
1690 "Options concerning following links in Org-mode."
1695 "Function to translate links with different syntax to Org syntax.
1696 This can be used to translate links created for example by the Planner
1697 or emacs-wiki packages to Org syntax.
1698 The function must accept two parameters, a TYPE containing the link
1700 which is everything after the link protocol. It should return a cons
1701 with possibly modified values of type and path.
1702 Org contains a function for this, so if you set this variable to
1703 `org-translate-link-from-planner', you should be able follow many
1704 links created by planner."
1709 "Hook that is run after a link has been followed."
1714 "Non-nil means on links TAB will follow the link.
1715 Needs to be set before org.el is loaded.
1716 This really should not be used, it does not make sense, and the
1717 implementation is bad."
1722 "Non-nil means on links RET will follow the link.
1723 In tables, the special behavior of RET has precedence."
1729 "Non-nil means mouse-1 on a link will follow the link.
1730 A longer mouse click will still set point. Does not work on XEmacs.
1731 Needs to be set before org.el is loaded."
1736 "Number of different positions to be recorded in the ring.
1737 Changing this requires a restart of Emacs to work correctly."
1742 "Non-nil means internal links in Org files must exactly match a headline.
1743 When nil, the link search tries to match a phrase with all words
1744 in the search text."
1751 query-to-create)))
1759 "Setup the frame configuration for following links.
1760 When following a link with Emacs, it may often be useful to display
1761 this link in another window or frame. This variable can be used to
1762 set this up for the different types of links.
1763 For VM, use any of
1764 `vm-visit-folder'
1765 `vm-visit-folder-other-window'
1766 `vm-visit-folder-other-frame'
1767 For Gnus, use any of
1768 `gnus'
1769 `gnus-other-frame'
1770 `org-gnus-no-new-news'
1771 For FILE, use any of
1772 `find-file'
1773 `find-file-other-window'
1774 `find-file-other-frame'
1775 For Wanderlust use any of
1776 `wl'
1777 `wl-other-frame'
1778 For the calendar, use the variable `calendar-setup'.
1779 For BBDB, it is currently only possible to display the matches in
1780 another window."
1809 "Non-nil means use indirect buffer to display infile links.
1810 Activating internal links (from one location in a file to another location
1811 in the same file) normally just jumps to the location. When the link is
1813 is displayed in
1814 another window. When this option is set, the other window actually displays
1815 an indirect buffer clone of the current buffer, to avoid any visibility
1816 changes to the current buffer."
1821 "Non-nil means `org-open-file' will open non-existing files.
1822 When nil, an error will be generated.
1823 This variable applies only to external applications because they
1824 might choke on non-existing files. If the link is to a file that
1825 will be opened in Emacs, the variable is ignored."
1830 "Non-nil means a link to a directory really means to index.org.
1831 When nil, following a directory link will run dired or open a finder/explorer
1832 window on that directory."
1837 "Function and arguments to call for following mailto links.
1838 This is a list with the first element being a Lisp function, and the
1839 remaining elements being arguments to the function. In string arguments,
1840 %a will be replaced by the address, and %s will be replaced by the subject
1841 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1850 "Non-nil means ask for confirmation before executing shell links.
1851 Shell links can be dangerous: just think about a link
1853 [[shell:rm -rf ~/*][Google Search]]
1856 but really it would remove your entire home directory.
1857 Therefore we advise against setting this variable to nil.
1858 Just change it to `y-or-n-p' if you want to confirm with a
1866 'safe-local-variable
1870 "A regexp to skip confirmation for shell links."
1876 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1877 Elisp links can be dangerous: just think about a link
1882 but really it would remove your entire home directory.
1883 Therefore we advise against setting this variable to nil.
1884 Just change it to `y-or-n-p' if you want to confirm with a
1892 'safe-local-variable
1896 "A regexp to skip confirmation for Elisp links."
1905 "Default file applications on a UNIX or GNU/Linux system.
1916 "Default file applications on a MacOS X system.
1918 for some files for which the OS does not have a good default.
1926 'mswindows-shell-execute
1931 'mswindows-shell-execute
1934 "Default file applications on a Windows NT system.
1943 "External applications for opening `file:path' items in a document.
1944 Org-mode uses system defaults for different file types, but
1945 you can use this variable to set the application for a given file
1946 extension. The entries in this list are cons cells where the car identifies
1947 files and the cdr the corresponding command. Possible values for the
1948 file identifier are
1950 ways, depending on its contents:
1952 - Alphanumeric characters only:
1953 Match links with this file extension.
1955 to open PDFs with evince.
1957 - Regular expression: Match links where the
1958 filename matches the regexp. If you want to
1959 use groups here, use shy groups.
1963 to open *.html and *.xhtml with firefox.
1965 - Regular expression which contains (non-shy) groups:
1967 anything after that, matches the regexp.
1968 In a custom command string, %1, %2, etc. are replaced with
1969 the parts of the link that were matched by the groups.
1970 For backwards compatibility, if a command string is given
1971 that does not use any of the group matches, this case is
1972 handled identically to the second one (i.e. match against
1973 file name only).
1974 In a custom lisp form, you can access the group matches with
1975 (match-string n link).
1978 to open [[file:document.pdf::5]] with evince at page 5.
1980 `directory' Matches a directory
1981 `remote' Matches a remote file, accessible through tramp or efs.
1982 Remote files most likely should be visited through Emacs
1983 because external applications cannot handle such paths.
1984 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1985 so all files Emacs knows how to handle. Using this with
1986 command `emacs' will open most files in Emacs. Beware that this
1987 will also open html files inside Emacs, unless you add
1989 t Default for files not matched by any of the other options.
1990 `system' The system command to open files, like `open' on Windows
1991 and Mac OS X, and mailcap under GNU/Linux. This is the command
1992 that will be selected if you call `C-c C-o' with a double
1995 Possible values for the command are:
1996 `emacs' The file will be visited by the current Emacs process.
1997 `default' Use the default application for this file type, which is the
1998 association for t in the list, most likely in the system-specific
1999 part.
2000 This can be used to overrule an unwanted setting in the
2001 system-specific variable.
2003 This command is specified by the entry whose car is `system'.
2004 Most likely, the system-specific version of this variable
2005 does define this command, but you can overrule/replace it
2006 here.
2007 string A command to be executed by a shell; %s will be replaced
2008 by the path to the file.
2009 sexp A Lisp form which will be evaluated. The file path will
2010 be available in the Lisp variable `file'.
2011 For more examples, see the system specific constants
2012 `org-file-apps-defaults-macosx'
2013 `org-file-apps-defaults-windowsnt'
2014 `org-file-apps-defaults-gnu'."
2024 auto-mode))
2033 "The URL of the DOI server."
2039 "Options concerning refiling entries in Org-mode."
2044 "Directory with org files.
2045 This is just a default location to look for Org files. There is no need
2046 at all to put your files into this directory. It is only used in the
2047 following situations:
2049 1. When a capture template specifies a target file that is not an
2050 absolute path. The path will then be interpreted relative to
2051 `org-directory'
2052 2. When a capture note is filed away in an interactive way (when exiting the
2053 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2054 with `org-directory' as the default path."
2061 "Default target for storing notes.
2062 Used as a fall back file for org-remember.el and org-capture.el, for
2063 templates that do not specify a target file."
2069 file))
2072 "The default interface to be used for `org-goto'.
2073 Allowed values are:
2074 outline The interface shows an outline of the relevant file
2075 and the correct heading is found by moving through
2076 the outline or by searching with incremental search.
2077 outline-path-completion Headlines in the current buffer are offered via
2078 completion. This is the interface also used by
2079 the refile command."
2086 "Maximum target level when running `org-goto' with refile interface."
2091 "Non-nil means store new notes at the beginning of a file or entry.
2092 When nil, new notes will be filed to the end of a file or entry.
2093 This can also be a list with cons cells of regular expressions that
2094 are matched against file names, and values."
2105 "Information to record when a task is refiled.
2107 Possible values are:
2109 nil Don't add anything
2110 time Add a time stamp to the task
2111 note Prompt for a note and add it with template `org-log-note-headings'
2113 This option can also be set with on a per-file-basis with
2115 #+STARTUP: nologrefile
2116 #+STARTUP: logrefile
2117 #+STARTUP: lognoterefile
2119 You can have local logging settings for a subtree by setting the LOGGING
2120 property to one or more of these keywords.
2122 When bulk-refiling from the agenda, the value `note' is forbidden and
2123 will temporarily be changed to `time'."
2134 This is a list of cons cells. Each cell contains:
2135 - a specification of the files to be considered, either a list of files,
2136 or a symbol whose function or variable value will be used to retrieve
2137 a file name or a list of file names. If you use `org-agenda-files' for
2138 that, all agenda files will be scanned for targets. Nil means consider
2139 headings in the current buffer.
2140 - A specification of how to find candidate refile targets. This may be
2141 any of:
2143 This tag has to be present in all target headlines, inheritance will
2144 not be considered.
2146 todo keyword.
2148 headlines that are refiling targets.
2149 - a cons cell (:level . N). Any headline of level N is considered a target.
2150 Note that, when `org-odd-levels-only' is set, level corresponds to
2151 order in hierarchy, not to the number of stars.
2152 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2153 Note that, when `org-odd-levels-only' is set, level corresponds to
2154 order in hierarchy, not to the number of stars.
2156 Each element of this list generates a set of possible targets.
2157 The union of these sets is presented (with completion) to
2158 the user by `org-refile'.
2160 You can set the variable `org-refile-target-verify-function' to a function
2161 to verify each headline found by the simple criteria above.
2163 When this variable is nil, all top-level headlines in the current buffer
2164 are used, equivalent to the value `((nil . (:level . 1))'."
2180 "Function to verify if the headline at point should be a refile target.
2181 The function will be called without arguments, with point at the
2182 beginning of the headline. It should return t and leave point
2183 where it is if the headline is a valid target for refiling.
2185 If the target should not be selected, the function must return nil.
2186 In addition to this, it may move point to a place from where the search
2187 should be continued. For example, the function may decide that the entire
2188 subtree of the current entry should be excluded and move point to the end
2189 of the subtree."
2196 "Non-nil means cache refile targets to speed up the process.
2197 The cache for a particular file will be updated automatically when
2198 the buffer has been killed, or when any of the marker used for flagging
2199 refile targets no longer points at a live buffer.
2200 If you have added new entries to a buffer that might themselves be targets,
2201 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2202 find that easier, `C-u C-u C-u C-c C-w'."
2208 "Non-nil means provide refile targets as paths.
2209 So a level 3 headline will be available as level1/level2/level3.
2211 When the value is `file', also include the file name (without directory)
2212 into the path. In this case, you can also stop the completion after
2213 the file name, to get entries inserted as top level in the file.
2215 When `full-file-path', include the full file path."
2224 "Non-nil means complete the outline path in hierarchical steps.
2225 When Org-mode uses the refile interface to select an outline path
2226 \(see variable `org-refile-use-outline-path'), the completion of
2227 the path can be done is a single go, or if can be done in steps down
2228 the headline hierarchy. Going in steps is probably the best if you
2229 do not use a special completion package like `ido' or `icicles'.
2230 However, when using these packages, going in one step can be very
2231 fast, while still showing the whole path to the entry."
2236 "Non-nil means allow to create new nodes as refile targets.
2238 of an existing node. When the value of this variable is `confirm',
2239 new node creation must be confirmed by the user (recommended)
2240 When nil, the completion must match an existing entry.
2242 Note that, if the new heading is not seen by the criteria
2243 listed in `org-refile-targets', multiple instances of the same
2244 heading would be created by trying again to file under the new
2245 heading."
2253 "Non-nil means also refile active region within a subtree.
2255 By default `org-refile' doesn't allow refiling regions if they
2256 don't contain a set of subtrees, but it might be convenient to
2257 do so sometimes: in that case, the first line of the region is
2258 converted to a headline before refiling."
2264 "Options concerning TODO items in Org-mode."
2269 "Options concerning Progress logging in Org-mode."
2276 "The available interpretation symbols for customizing `org-todo-keywords'.
2280 "List of TODO entry keyword sequences and their interpretation.
2283 Each sequence starts with a symbol, either `sequence' or `type',
2284 indicating if the keywords should be interpreted as a sequence of
2285 action steps, or as different types of TODO items. The first
2286 keywords are states requiring action - these states will select a headline
2287 for inclusion into the global TODO list Org-mode produces. If one of
2290 the last keyword is treated as the only DONE state of the sequence.
2293 additional state where no keyword is present. For details about this
2294 cycling, see the manual.
2296 TODO keywords and interpretation can also be set on a per-file basis with
2297 the special #+SEQ_TODO and #+TYP_TODO lines.
2299 Each keyword can optionally specify a character for fast state selection
2300 \(in combination with the variable `org-use-fast-todo-selection')
2301 and specifiers for state change logging, using the same syntax that
2304 indicates to record a time stamp each time this state is selected.
2306 Each keyword may also specify if a timestamp or a note should be
2307 recorded when entering or leaving the state, by adding additional
2308 characters in the parenthesis after the keyword. This looks like this:
2310 record only the time of the state change. With X and Y being either
2312 Y when leaving the state if and only if the *target* state does not
2313 define X. You may omit any of the fast-selection key or X or /Y,
2314 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2316 For backward compatibility, this variable may also be just a list
2317 of keywords. In this case the interpretation (sequence or type) will be
2318 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2328 ;;Quick and dirty way to see
2329 ;;`org-todo-interpretations'. This takes the
2330 ;;place of item arguments
2331 :convert-widget
2338 org-todo-interpretation-widgets))
2339 widget))
2375 "Controls how TODO keywords are interpreted.
2376 This variable is in principle obsolete and is only used for
2377 backward compatibility, if the interpretation of todo keywords is
2378 not given already in `org-todo-keywords'. See that variable for
2379 more information."
2386 "Non-nil means use the fast todo selection scheme with C-c C-t.
2387 This variable describes if and under what circumstances the cycling
2388 mechanism for TODO keywords will be replaced by a single-key, direct
2389 selection scheme.
2391 When nil, fast selection is never used.
2393 When the symbol `prefix', it will be used when `org-todo' is called
2394 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2395 `C-u t' in an agenda buffer.
2397 When t, fast selection is used by default. In this case, the prefix
2398 argument forces cycling instead.
2400 In all cases, the special interface is only used if access keys have
2401 actually been assigned by the user, i.e. if keywords in the configuration
2402 are followed by a letter in parenthesis, like TODO(t)."
2410 "Non-nil means update todo statistics after insert and toggle.
2411 ALL-HEADLINES means update todo statistics by including headlines
2412 with no TODO keyword as well, counting them as not done.
2413 A list of TODO keywords means the same, but skip keywords that are
2414 not in this list.
2416 When this is set, todo statistics is updated in the parent of the
2417 current entry each time a todo state is changed."
2427 "Non-nil means TODO statistics covers just direct children.
2428 When nil, all entries in the subtree are considered.
2429 This has only an effect if `org-provide-todo-statistics' is set.
2430 To set this to nil for only a single subtree, use a COOKIE_DATA
2436 "Hook which is run after the state of a TODO item was changed.
2437 The new state (a string with a TODO keyword, or nil) is available in the
2438 Lisp variable `org-state'."
2443 "Hook for functions that are allowed to block a state change.
2445 Functions in this hook should not modify the buffer.
2446 Each function gets as its single argument a property list,
2447 see `org-trigger-hook' for more information about this list.
2449 If any of the functions in this hook returns nil, the state change
2453 "Hook for functions that are triggered by a state change.
2455 Each function gets as its single argument a property list with at
2456 least the following elements:
2458 (:type type-of-change :position pos-at-entry-start
2459 :from old-state :to new-state)
2461 Depending on the type, more properties may be present.
2463 This mechanism is currently implemented for:
2465 TODO state changes
2466 ------------------
2467 :type todo-state-change
2468 :from previous state (keyword as a string), or nil, or a symbol
2469 'todo' or 'done', to indicate the general type of state.
2473 "Non-nil means undone TODO entries will block switching the parent to DONE.
2474 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2475 be blocked if any prior sibling is not yet done.
2476 Finally, if the parent is blocked because of ordered siblings of its own,
2477 the child will also be blocked."
2489 "Non-nil means unchecked boxes will block switching the parent to DONE.
2490 When this is nil, checkboxes have no influence on switching TODO states.
2491 When non-nil, you first need to check off all check boxes before the TODO
2492 entry can be switched to DONE.
2493 This variable needs to be set before org.el is loaded, and you need to
2494 restart Emacs after a change to make the change effective. The only way
2495 to change is while Emacs is running is through the customize interface."
2507 "Non-nil means inserting a TODO heading is treated as state change.
2509 logging will apply if appropriate. When nil, the new TODO item will
2510 be inserted directly, and no logging will take place."
2515 "Non-nil means switching TODO states with S-cursor counts as state change.
2516 This is the default behavior. However, setting this to nil allows a
2517 convenient way to select a TODO state and bypass any logging associated
2518 with that."
2523 "Tag changes that should be triggered by TODO state changes.
2524 This is a list. Each entry is
2526 (state-change (tag . flag) .......)
2528 State-change can be a string with a state, and empty string to indicate the
2529 state that has no TODO keyword, or it can be one of the symbols `todo'
2530 or `done', meaning any not-done or done state, respectively."
2544 "Information to record when a task moves to the DONE state.
2546 Possible values are:
2548 nil Don't add anything, just change the keyword
2549 time Add a time stamp to the task
2550 note Prompt for a note and add it with template `org-log-note-headings'
2552 This option can also be set with on a per-file-basis with
2554 #+STARTUP: nologdone
2555 #+STARTUP: logdone
2556 #+STARTUP: lognotedone
2558 You can have local logging settings for a subtree by setting the LOGGING
2559 property to one or more of these keywords."
2567 ;; Normalize old uses of org-log-done.
2574 "Information to record when the scheduling date of a tasks is modified.
2576 Possible values are:
2578 nil Don't add anything, just change the date
2579 time Add a time stamp to the task
2580 note Prompt for a note and add it with template `org-log-note-headings'
2582 This option can also be set with on a per-file-basis with
2584 #+STARTUP: nologreschedule
2585 #+STARTUP: logreschedule
2586 #+STARTUP: lognotereschedule"
2595 "Information to record when the deadline date of a tasks is modified.
2597 Possible values are:
2599 nil Don't add anything, just change the date
2600 time Add a time stamp to the task
2601 note Prompt for a note and add it with template `org-log-note-headings'
2603 This option can also be set with on a per-file-basis with
2605 #+STARTUP: nologredeadline
2606 #+STARTUP: logredeadline
2607 #+STARTUP: lognoteredeadline
2609 You can have local logging settings for a subtree by setting the LOGGING
2610 property to one or more of these keywords."
2619 "Non-nil means record a note when clocking out of an item.
2620 This can also be configured on a per-file basis by adding one of
2621 the following lines anywhere in the buffer:
2623 #+STARTUP: lognoteclock-out
2624 #+STARTUP: nolognoteclock-out"
2630 "Non-nil means the CLOSED time stamp will contain date and time.
2631 When nil, only the date will be recorded."
2645 "Headings for notes added to entries.
2646 The value is an alist, with the car being a symbol indicating the note
2647 context, and the cdr is the heading to be used. The heading may also be the
2648 empty string.
2649 %t in the heading will be replaced by a time stamp.
2650 %T will be an active time stamp instead the default inactive one
2651 %d will be replaced by a short-format time stamp.
2652 %D will be replaced by an active short-format time stamp.
2653 %s will be replaced by the new TODO state, in double quotes.
2654 %S will be replaced by the old TODO state, in double quotes.
2655 %u will be replaced by the user name.
2656 %U will be replaced by the full user name.
2658 In fact, it is not a good idea to change the `state' entry, because
2659 agenda log mode depends on the format of these entries."
2665 "Heading when changing todo state (todo sequence only)"
2679 "Non-nil means insert state change notes and time stamps into a drawer.
2680 When nil, state changes notes will be inserted after the headline and
2681 any scheduling and clock lines, but not inside a drawer.
2683 The value of this variable should be the name of the drawer to use.
2684 LOGBOOK is proposed as the default drawer for this purpose, you can
2685 also set this to a string to define the drawer of your choice.
2689 A value of t or nil can also be set with on a per-file-basis with
2691 #+STARTUP: logdrawer
2692 #+STARTUP: nologdrawer
2694 If this variable is set, `org-log-state-notes-insert-after-drawers'
2695 will be ignored.
2697 You can set the property LOG_INTO_DRAWER to overrule this setting for
2698 a subtree."
2709 "Return the value of `org-log-into-drawer', but let properties overrule.
2710 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2711 used instead of the default value."
2720 "Non-nil means insert state change notes after any drawers in entry.
2721 Only the drawers that *immediately* follow the headline and the
2722 deadline/scheduled line are skipped.
2723 When nil, insert notes right after the heading and perhaps the line
2724 with deadline/scheduling if present.
2726 This variable will have no effect if `org-log-into-drawer' is
2727 set."
2733 "Non-nil means the latest state note will be directly after heading.
2734 When nil, the state change notes will be ordered according to time.
2736 This option can also be set with on a per-file-basis with
2738 #+STARTUP: logstatesreversed
2739 #+STARTUP: nologstatesreversed"
2745 "The TODO state to which a repeater should return the repeating task.
2746 By default this is the first task in a TODO sequence, or the previous state
2747 in a TODO_TYP set. But you can specify another task here.
2748 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2755 "Non-nil means record moving through the DONE state when triggering repeat.
2756 An auto-repeating task is immediately switched back to TODO when
2759 record a closing note, there will be no record of the task moving
2760 through DONE. This variable forces taking a note anyway.
2762 nil Don't force a record
2763 time Record a time stamp
2764 note Prompt for a note and add it with template `org-log-note-headings'
2766 This option can also be set with on a per-file-basis with
2768 #+STARTUP: nologrepeat
2769 #+STARTUP: logrepeat
2770 #+STARTUP: lognoterepeat
2772 You can have local logging settings for a subtree by setting the LOGGING
2773 property to one or more of these keywords."
2783 "Priorities in Org-mode."
2788 "Non-nil means priority commands are active.
2789 When nil, these commands will be disabled, so that you never accidentally
2790 set a priority."
2795 "The highest priority of TODO items. A character like ?A, ?B etc.
2796 Must have a smaller ASCII number than `org-lowest-priority'."
2801 "The lowest priority of TODO items. A character like ?A, ?B etc.
2802 Must have a larger ASCII number than `org-highest-priority'."
2807 "The default priority of TODO items.
2808 This is the priority an item gets if no explicit priority is given.
2809 When starting to cycle on an empty priority the first step in the cycle
2810 depends on `org-priority-start-cycle-with-default'. The resulting first
2811 step priority must not exceed the range from `org-highest-priority' to
2812 `org-lowest-priority' which means that `org-default-priority' has to be
2813 in this range exclusive or inclusive the range boundaries. Else the
2814 first step refuses to set the default and the second will fall back
2815 to (depending on the command used) the highest or lowest priority."
2820 "Non-nil means start with default priority when starting to cycle.
2821 When this is nil, the first step in the cycle will be (depending on the
2822 command used) one higher or lower than the default priority.
2823 See also `org-default-priority'."
2828 "Function to extract the priority from a string.
2829 The string is normally the headline. If this is nil Org computes the
2830 priority from the priority cookie like [#A] in the headline. It returns
2831 an integer, increasing by 1000 for each priority level.
2832 The user can set a different function here, which should take a string
2833 as an argument and return the numeric priority."
2841 "Options concerning time stamps and deadlines in Org-mode."
2846 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2847 When nil, these labeled time stamps are forces into the second line of an
2848 entry, just after the headline. When scheduling from the global TODO list,
2849 the time stamp will always be forced into the second line."
2854 "Formats for `format-time-string' which are used for time stamps.
2858 "Number of minutes to round time stamps to.
2859 These are two values, the first applies when first creating a time stamp.
2860 The second applies when changing it with the commands `S-up' and `S-down'.
2861 When changing the time stamp, this means that it will change in steps
2862 of N minutes, as given by the second value.
2864 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2865 numbers should be factors of 60, so for example 5, 10, 15.
2867 When this is larger than 1, you can still force an exact time stamp by using
2868 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2869 and by using a prefix arg to `S-up/down' to specify the exact number
2870 of minutes to shift."
2880 ;; Normalize old customizations of this variable.
2884 org-time-stamp-rounding-minutes)))
2887 "Non-nil means overlay custom formats over all time stamps.
2888 The formats are defined through the variable `org-time-stamp-custom-formats'.
2889 To turn this on on a per-file basis, insert anywhere in the file:
2890 #+STARTUP: customtime"
2898 "Custom formats for time stamps. See `format-time-string' for the syntax.
2899 These are overlaid over the default ISO format if the variable
2900 `org-display-custom-times' is set. Time like %H:%M should be at the
2901 end of the second format. The custom formats are also honored by export
2902 commands, if custom time display is turned on at the time of export."
2907 "Get the right format for a time string."
2912 f)))
2916 "The format string used when creating CLOCKSUM lines.
2917 This is also used when Org mode generates a time duration.
2919 The value can be a single format string containing two
2920 %-sequences, which will be filled with the number of hours and
2921 minutes in that order.
2923 Alternatively, the value can be a plist associating any of the
2924 keys :years, :months, :weeks, :days, :hours or :minutes with
2925 format strings. The time duration is formatted using only the
2926 time components that are needed and concatenating the results.
2927 If a time unit in absent, it falls back to the next smallest
2928 unit.
2930 The keys :require-years, :require-months, :require-days,
2931 :require-weeks, :require-hours, :require-minutes are also
2932 meaningful. A non-nil value for these keys indicates that the
2933 corresponding time component should always be included, even if
2934 its value is 0.
2937 For example,
2940 :require-minutes t)
2942 means durations longer than a day will be expressed in days,
2943 hours and minutes, and durations less than a day will always be
2944 expressed in hours and minutes (even for durations less than an
2945 hour).
2947 The value
2951 means durations longer than a day will be expressed in days and
2952 minutes, and durations less than a day will be expressed entirely
2953 in minutes (even for durations longer than an hour)."
2993 See `org-time-clocksum-format' for more on time clock formats."
3001 E.g. by default, one day is considered to be a 8 hours effort,
3002 so a task that has been clocked for 16 hours will be displayed
3003 as during 2 days in the clock display or in the clocktable.
3005 See `org-effort-durations' on how to set effort durations
3006 and `org-time-clocksum-format' for more on time clock formats."
3014 "The format string used when creating CLOCKSUM lines,
3015 or when Org mode generates a time duration, if
3016 `org-time-clocksum-use-fractional' is enabled.
3018 The value can be a single format string containing one
3019 %-sequence, which will be filled with the number of hours as
3020 a float.
3022 Alternatively, the value can be a plist associating any of the
3023 keys :years, :months, :weeks, :days, :hours or :minutes with
3024 a format string. The time duration is formatted using the
3025 largest time unit which gives a non-zero integer part. If all
3026 specified formats have zero integer part, the smallest time unit
3027 is used."
3044 "Number of days before expiration during which a deadline becomes active.
3045 This variable governs the display in sparse trees and in the agenda.
3046 When 0 or negative, it means use this number (the absolute value of it)
3047 even if a deadline has a different individual lead time specified.
3049 Custom commands can set this variable in the options section."
3055 "Number of days before a scheduled item becomes active.
3056 This variable governs the display in sparse trees and in the agenda.
3057 The default value (i.e. 0) means: don't delay scheduled item.
3058 When negative, it means use this number (the absolute value of it)
3059 even if a scheduled item has a different individual delay time
3060 specified.
3062 Custom commands can set this variable in the options section."
3070 "Non-nil means assume future for incomplete date input from user.
3071 This affects the following situations:
3072 1. The user gives a month but not a year.
3075 2. The user gives a day, but no month.
3078 it will be considered as *this* month.
3080 If you set this variable to the symbol `time', then also the following
3081 will work:
3083 3. If the user gives a time.
3084 If the time is before now, it will be interpreted as tomorrow.
3086 Currently none of this works for ISO week specifications.
3088 When this option is nil, the current day, month and year will always be
3089 used as defaults.
3091 See also `org-agenda-jump-prefer-future'."
3099 "Should the agenda jump command prefer the future for incomplete dates?
3100 The default is to do the same as configured in `org-read-date-prefer-future'.
3101 But you can also set a deviating value here.
3102 This may t or nil, or the symbol `org-read-date-prefer-future'."
3108 org-read-date-prefer-future)
3113 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3115 Depending on the system Emacs is running on, certain dates cannot
3116 be represented with the type used internally to represent time.
3117 Dates between 1970-1-1 and 2038-1-1 can always be represented
3118 correctly. Some systems allow for earlier dates, some for later,
3119 some for both. One way to find out it to insert any date into an
3120 Org buffer, putting the cursor on the year and hitting S-up and
3121 S-down to test the range.
3123 When this variable is set to t, the date/time prompt will not let
3124 you specify dates outside the 1970-2037 range, so it is certain that
3125 these dates will work in whatever version of Emacs you are
3126 running, and also that you can move a file from one Emacs implementation
3127 to another. WHenever Org is forcing the year for you, it will display
3128 a message and beep.
3130 When this variable is nil, Org will check if the date is
3131 representable in the specific Emacs implementation you are using.
3132 If not, it will force a year, usually the current year, and beep
3133 to remind you. Currently this setting is not recommended because
3134 the likelihood that you will open your Org files in an Emacs that
3135 has limited date range is not negligible.
3137 A workaround for this problem is to use diary sexp dates for time
3138 stamps outside of this range."
3144 "Non-nil means display current interpretation of date prompt live.
3145 This display will be in an overlay, in the minibuffer."
3150 "Non-nil means pop up a calendar when prompting for a date.
3151 In the calendar, the date can be selected with mouse-1. However, the
3152 minibuffer will also be active, and you can simply enter the date as well.
3153 When nil, only the minibuffer will be available."
3160 'org-read-date-minibuffer-setup-hook
3163 "Hook to be used to set up keys for the date/time interface.
3164 Add key definitions to `minibuffer-local-map', which will be a
3165 temporary copy.
3167 WARNING: This option is obsolete, you should use
3168 `org-read-date-minibuffer-local-map' to set up keys."
3173 "The hour when your day really ends. Must be an integer.
3174 This has influence for the following applications:
3176 the time given here, the day recognized as TODAY is actually yesterday.
3177 - When a date is read from the user and it is still before the time given
3178 here, the current date and time will be assumed to be yesterday, 23:59.
3179 Also, timestamps inserted in capture templates follow this rule.
3181 IMPORTANT: This is a feature whose implementation is and likely will
3182 remain incomplete. Really, it is only here because past midnight seems to
3183 be the favorite working time of John Wiegley :-)"
3188 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3189 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3191 23:59 of the previous day."
3197 "When non-nil, use the last clock out time for `org-todo'.
3198 Note that this option has precedence over the combined use of
3199 `org-use-effective-time' and `org-extend-today-until'."
3206 "Non-nil means S-down will increase the time in a time stamp.
3207 When nil, S-up will increase."
3212 "Non-nil means make the calendar window follow timestamp changes.
3213 When a timestamp is modified and the calendar window is visible, it will be
3214 moved to the new date."
3219 "Options concerning tags in Org-mode."
3224 "List of tags allowed in Org-mode files.
3225 When this list is nil, Org-mode will base TAG input on what is already in the
3226 buffer.
3227 The value of this variable is an alist, the car of each entry must be a
3228 keyword as a string, the cdr may be a character that is used to select
3229 that tag through the fast-tag-selection interface.
3230 See the manual for details."
3247 "List of tags that will always appear in all Org-mode files.
3248 This is in addition to any in buffer settings or customizations
3249 of `org-tag-alist'.
3250 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3251 The value of this variable is an alist, the car of each entry must be a
3252 keyword as a string, the cdr may be a character that is used to select
3253 that tag through the fast-tag-selection interface.
3254 See the manual for details.
3255 To disable these tags on a per-file basis, insert anywhere in the file:
3256 #+STARTUP: noptag"
3268 "If non-nil, always offer completion for all tags of all agenda files.
3269 Instead of customizing this variable directly, you might want to
3270 set it locally for capture buffers, because there no list of
3271 tags in that file can be created dynamically (there are none).
3273 (add-hook 'org-capture-mode-hook
3274 (lambda ()
3275 (set (make-local-variable
3276 'org-complete-tags-always-offer-all-agenda-tags)
3277 t)))"
3283 "List of tags that can be inherited by all entries in the file.
3284 The tags will be inherited if the variable `org-use-tag-inheritance'
3285 says they should be.
3289 "Non-nil means use fast tag selection scheme.
3290 This is a special interface to select and deselect tags with single keys.
3291 When nil, fast selection is never used.
3292 When the symbol `auto', fast selection is used if and only if selection
3293 characters for tags have been configured, either through the variable
3294 `org-tag-alist' or through a #+TAGS line in the buffer.
3295 When t, fast selection is always used and selection keys are assigned
3296 automatically if necessary."
3304 "Non-nil means fast tag selection exits after first change.
3305 When nil, you have to press RET to exit it.
3306 During fast tag selection, you can toggle this flag with `C-c'.
3307 This variable can also have the value `expert'. In this case, the window
3308 displaying the tags menu is not even shown, until you press C-c again."
3316 "Non-nil means fast tags selection interface will also offer TODO states.
3320 "The column to which tags should be indented in a headline.
3321 If this number is positive, it specifies the column. If it is negative,
3322 it means that the tags should be flushright to that column. For example,
3323 -80 works well for a normal 80 character screen.
3324 When 0, place tags directly after headline text, with only one space in
3325 between."
3330 "Non-nil keeps tags aligned when modifying headlines.
3331 Some operations (i.e. demoting) change the length of a headline and
3332 therefore shift the tags around. With this option turned on, after
3333 each such operation the tags are again aligned to `org-tags-column'."
3338 "Non-nil means tags in levels apply also for sublevels.
3339 When nil, only the tags directly given in a specific line apply there.
3340 This may also be a list of tags that should be inherited, or a regexp that
3341 matches tags that should be inherited. Additional control is possible
3342 with the variable `org-tags-exclude-from-inheritance' which gives an
3343 explicit list of tags to be excluded from inheritance, even if the value of
3344 `org-use-tag-inheritance' would select it for inheritance.
3346 If this option is t, a match early-on in a tree can lead to a large
3347 number of matches in the subtree when constructing the agenda or creating
3348 a sparse tree. If you only want to see the first match in a tree during
3349 a search, check out the variable `org-tags-match-list-sublevels'."
3358 "List of tags that should never be inherited.
3359 This is a way to exclude a few tags from inheritance. For way to do
3360 the opposite, to actively allow inheritance for selected tags,
3361 see the variable `org-use-tag-inheritance'."
3366 "Check if TAG is one that should be inherited."
3378 "Non-nil means list also sublevels of headlines matching a search.
3379 This variable applies to tags/property searches, and also to stuck
3380 projects because this search is based on a tags match as well.
3382 When set to the symbol `indented', sublevels are indented with
3383 leading dots.
3385 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3386 the sublevels of a headline matching a tag search often also match
3387 the same search. Listing all of them can create very long lists.
3388 Setting this variable to nil causes subtrees of a match to be skipped.
3390 This variable is semi-obsolete and probably should always be true. It
3391 is better to limit inheritance to certain tags using the variables
3392 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3400 "When set, tags are sorted using this function as a comparator."
3416 "Options concerning properties in Org-mode."
3421 "How property key/value pairs should be formatted by `indent-line'.
3422 When `indent-line' hits a property definition, it will format the line
3423 according to this format, mainly to make sure that the values are
3424 lined-up with respect to each other."
3429 "Alist of properties and functions to adjust inserted values.
3430 Elements of this alist must be of the form
3432 ([string] [function])
3434 where [string] must be a property name and [function] must be a
3435 lambda expression: this lambda expression must take one argument,
3436 the value to adjust, and return the new value as a string.
3440 and the clock summary:
3443 (let ((clocksum (org-clock-sum-current-item))
3444 (effort (org-duration-string-to-minutes
3446 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3453 "Non-nil means properties apply also for sublevels.
3455 This setting is chiefly used during property searches. Turning it on can
3456 cause significant overhead when doing a search, which is why it is not
3457 on by default.
3459 When nil, only the properties directly given in the current entry count.
3460 When t, every property is inherited. The value may also be a list of
3461 properties that should have inheritance, or a regular expression matching
3462 properties that should be inherited.
3464 However, note that some special properties use inheritance under special
3465 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3467 for valid values of a property.
3469 Note for programmers:
3470 When querying an entry with `org-entry-get', you can control if inheritance
3471 should be used. By default, `org-entry-get' looks only at the local
3472 properties. You can request inheritance by setting the inherit argument
3473 to t (to force inheritance) or to `selective' (to respect the setting
3474 in this variable)."
3483 "Check if PROPERTY is one that should be inherited."
3494 "The default column format, if no other format has been defined.
3495 This variable can be set on the per-file basis by inserting a line
3497 #+COLUMNS: %25ITEM ....."
3502 "The ellipses to be used when a field in column view is truncated.
3503 When this is the empty string, as many characters as possible are shown,
3504 but then there will be no visual indication that the field has been truncated.
3505 When this is a string of length N, the last N characters of a truncated
3506 field are replaced by this string. If the column is narrower than the
3507 ellipses string, only part of the ellipses string will be shown."
3512 "Function that modifies values for display in column view.
3513 For example, it can be used to cut out a certain part from a time stamp.
3514 The function must take 2 arguments:
3516 column-title The title of the column (*not* the property name)
3517 value The value that should be modified.
3519 The function should return the value that should be displayed,
3520 or nil if the normal value should be used."
3525 "The property that is being used to keep track of effort estimates.
3526 Effort estimates given in this property need to have the format H:MM."
3534 "List of property/value pairs that can be inherited by any entry.
3536 These are fixed values, for the preset properties. The user variable
3537 that can be used to add to this list is `org-global-properties'.
3539 The entries in this list are cons cells where the car is a property
3540 name and cdr is a string with the value. If the value represents
3545 "List of property/value pairs that can be inherited by any entry.
3547 This list will be combined with the constant `org-global-properties-fixed'.
3549 The entries in this list are cons cells where the car is a property
3550 name and cdr is a string with the value.
3552 You can set buffer-local values for the same purpose in the variable
3553 `org-file-properties' this by adding lines like
3555 #+PROPERTY: NAME VALUE"
3562 "List of property/value pairs that can be inherited by any entry.
3563 Valid for the current buffer.
3568 "Options concerning agenda views in Org-mode."
3573 "Variable used by org files to set a category for agenda display.
3574 Such files should use a file variable to set it, for example
3578 or contain a special line
3580 #+CATEGORY: ELisp
3582 If the file does not specify a category, then file's base name
3588 "The files to be used for agenda display.
3592 If an entry is a directory, all files in that directory that are matched by
3593 `org-agenda-file-regexp' will be part of the file list.
3595 If the value of the variable is not a list but a single file name, then
3596 the list of agenda files is actually stored and maintained in that file, one
3597 agenda file per line. In this file paths can be given relative to
3598 `org-directory'. Tilde expansion and environment variable substitution
3599 are also made."
3606 "Regular expression to match files for `org-agenda-files'.
3607 If any element in the list in that variable contains a directory instead
3608 of a normal file, all files in that directory that are matched by this
3609 regular expression will be included."
3614 "List of extra files to be searched by text search commands.
3615 These files will be searched in addition to the agenda files by the
3616 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3617 Note that these files will only be searched for text search commands,
3618 not for the other agenda views like todo lists, tag searches or the weekly
3619 agenda. This variable is intended to list notes and possibly archive files
3620 that should also be searched by these two commands.
3621 In fact, if the first element in the list is the symbol `agenda-archives',
3622 then all archive files of all agenda files will be added to the search
3623 scope."
3633 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3634 A nil value means to remove them, after a query, from the list."
3639 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3640 The command `org-calendar-goto-agenda' will be bound to this key. The
3641 default is the character `c' because then `c' can be used to switch back and
3642 forth between agenda and calendar."
3647 "The key to be installed in `calendar-mode-map' for adding diary entries.
3648 This option is irrelevant until `org-agenda-diary-file' has been configured
3649 to point to an Org-mode file. When that is the case, the command
3650 `org-agenda-diary-entry' will be bound to the key given here, by default
3651 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3652 if you want to continue doing this, you need to change this to a different
3653 key."
3658 "File to which to add new entries with the `i' key in agenda and calendar.
3659 When this is the symbol `diary-file', the functionality in the Emacs
3660 calendar will be used to add entries to the `diary-file'. But when this
3661 points to a file, `org-agenda-diary-entry' will be used instead."
3675 org-calendar-insert-diary-entry-key
3679 "Options for embedding LaTeX code into Org-mode."
3687 "Options for creating images from LaTeX fragments.
3688 This is a property list with the following properties:
3690 `default' means use the foreground of the default face.
3691 `auto' means use the foreground from the text face.
3693 `default' means use the background of the default face.
3694 `auto' means use the background from the text face.
3695 :scale a scaling factor for the size of the images, to get more pixels
3696 :html-foreground, :html-background, :html-scale
3697 the same numbers for HTML export.
3698 :matchers a list indicating which matchers should be used to
3699 find LaTeX fragments. Valid members of this list are:
3710 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3711 When nil, just push out a message."
3718 Use this to specify additional executable file say a jar file.
3720 When using MathToWeb as the converter, specify the full-path to
3721 your mathtoweb.jar file."
3729 "Command to convert LaTeX fragments to MathML.
3730 Replace format-specifiers in the command as noted below and use
3731 `shell-command' to convert LaTeX to MathML.
3732 %j: Executable file in fully expanded form as specified by
3733 `org-latex-to-mathml-jar-file'.
3734 %I: Input LaTeX file in fully expanded form
3735 %o: Output MathML file
3736 This command is used by `org-create-math-formula'.
3738 When using MathToWeb as the converter, set this to
3747 "Program to convert LaTeX fragments with.
3749 dvipng Process the LaTeX fragments to dvi file, then convert
3750 dvi files to png files using dvipng.
3751 This will also include processing of non-math environments.
3752 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3753 to convert pdf files to png files"
3761 "Path to store latex preview images.
3762 A relative path here creates many directories relative to the
3763 processed org files paths. An absolute path puts all preview
3764 images at the same place."
3770 "Return t if `org-latex-to-mathml-convert-command' is usable."
3773 org-latex-to-mathml-convert-command)
3775 org-latex-to-mathml-convert-command))))
3780 t))))))
3784 \[PACKAGES]
3785 \[DEFAULT-PACKAGES]
3787 % The settings below are copied from fullpage.sty
3800 "The document header used for processing LaTeX fragments.
3801 It is imperative that this header make sure that no page number
3802 appears on the page. The package defined in the variables
3803 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3805 header, or they will be appended."
3810 "Set the packages alist and make sure it has 3 elements per entry."
3814 x))
3815 val)))
3818 "Get the packages alist and make sure it has 3 elements per entry."
3822 x))
3842 "Alist of default packages to be inserted in the header.
3844 Change this only if one of the packages here causes an
3845 incompatibility with another package you are using.
3847 The packages in this list are needed by one part or another of
3848 Org mode to function properly:
3850 - inputenc, fontenc: for basic font and character selection
3851 - fixltx2e: Important patches of LaTeX itself
3852 - graphicx: for including images
3853 - longtable: For multipage tables
3854 - float, wrapfig: for figure placement
3855 - rotating: for sideways figures and tables
3856 - ulem: for underline and strike-through
3857 - amsmath: for subscript and superscript and math environments
3858 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
3859 for interpreting the entities in `org-entities'. You can skip
3860 some of these packages if you don't use any of their symbols.
3861 - hyperref: for cross references
3863 Therefore you should not modify this variable unless you know
3864 what you are doing. The one reason to change it anyway is that
3865 you might be loading some other package that conflicts with one
3866 of the default packages. Each cell is of the format
3868 the package also needs to be included when compiling LaTeX
3869 snippets into images for inclusion into non-LaTeX output."
3884 "Alist of packages to be inserted in every LaTeX header.
3886 These will be inserted after `org-latex-default-packages-alist'.
3887 Each cell is of the format:
3891 SNIPPET-FLAG, when t, indicates that this package is also needed
3892 when turning LaTeX snippets into images for inclusion into
3893 non-LaTeX output.
3895 Make sure that you only list packages here which:
3897 - you want in every file
3898 - do not conflict with the setup in `org-format-latex-header'.
3899 - do not conflict with the default packages in
3900 `org-latex-default-packages-alist'."
3914 "Settings for Org-mode appearance."
3919 "Non-nil means fontify only the stars in each headline.
3920 When nil, the entire headline is fontified.
3921 Changing it requires restart of `font-lock-mode' to become effective
3922 also in regions already fontified."
3927 "Non-nil means hide the first N-1 stars in a headline.
3928 This works by using the face `org-hide' for these stars. This
3929 face is white for a light background, and black for a dark
3930 background. You may have to customize the face `org-hide' to
3931 make this work.
3932 Changing it requires restart of `font-lock-mode' to become effective
3933 also in regions already fontified.
3934 You may also set this on a per-file basis by adding one of the following
3935 lines to the buffer:
3937 #+STARTUP: hidestars
3938 #+STARTUP: showstars"
3943 "List of symbols corresponding to keywords to be hidden the org buffer.
3944 For example, a value '(title) for this list will make the document's title
3945 appear in the buffer without the initial #+TITLE: keyword."
3954 "List of properties (as strings) with a special meaning.
3955 The default use of these custom properties is to let the user
3956 hide them with `org-toggle-custom-properties-visibility'."
3963 "Non-nil means change the face of a headline if it is marked DONE.
3964 Normally, only the TODO/DONE keyword indicates the state of a headline.
3965 When this is non-nil, the headline after the keyword is set to the
3966 `org-headline-done' as an additional indication."
3971 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3972 Changing this variable requires a restart of Emacs to take effect."
3977 "Non-nil means fontify the whole line for headings.
3978 This is useful when setting a background color for the
3979 org-level-* faces."
3984 "Non-nil means highlight LaTeX related syntax in the buffer.
3985 When non nil, the value should be a list containing any of the
3986 following symbols:
3987 `latex' Highlight LaTeX snippets and environments.
3988 `script' Highlight subscript and superscript.
3989 `entities' Highlight entities."
4001 "Non-nil mean font-lock should hide the emphasis marker characters."
4006 "Non-nil means show entities as UTF8 characters.
4013 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4019 "Regular expression for matching emphasis.
4020 After a match, the match groups contain these elements:
4021 0 The match of the full regular expression, including the characters
4022 before and after the proper match
4023 1 The character before the proper match, or empty at beginning of line
4024 2 The proper match, including the leading and trailing markers
4025 3 The leading marker like * or /, indicating the type of highlighting
4026 4 The text between the emphasis markers, not including the markers
4033 "Set variable and compute the emphasis regular expression."
4037 org-emphasis-alist org-emphasis-regexp-components)
4049 ;; make sure special characters appear at the right position in the class
4061 ;; Make the regexp
4069 body1
4081 body1
4087 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4088 ;; set this option proved cumbersome. See this message/thread:
4089 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4092 "Components used to build the regular expression for emphasis.
4093 This is a list with five entries. Terminology: In an emphasis string
4097 specify what is allowed/forbidden in each part:
4099 pre Chars allowed as prematch. Beginning of line will be allowed too.
4100 post Chars allowed as postmatch. End of line will be allowed too.
4101 border The chars *forbidden* as border characters.
4103 non-shy groups here, and don't allow newline here.
4104 newline The maximum number of newlines allowed in an emphasis exp.
4115 "Alist of characters and faces to emphasize text.
4116 Text starting and ending with a special character will be emphasized,
4117 for example *bold*, _underlined_ and /italic/. This variable sets the
4118 marker characters and the face to be used by font-lock for highlighting
4119 in Org-mode Emacs buffers.
4121 You need to reload Org or to restart Emacs after customizing this."
4136 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4139 ;;; Miscellaneous options
4142 "Completion in Org-mode."
4147 "Non-nil means use ido completion wherever possible.
4148 Note that `ido-mode' must be active for this variable to be relevant.
4149 If you decide to turn this variable on, you might well want to turn off
4150 `org-outline-path-complete-in-steps'.
4151 See also `org-completion-use-iswitchb'."
4156 "Non-nil means use iswitchb completion wherever possible.
4157 Note that `iswitchb-mode' must be active for this variable to be relevant.
4158 If you decide to turn this variable on, you might well want to turn off
4159 `org-outline-path-complete-in-steps'.
4160 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4166 Normal means, no org-mode-specific context."
4170 ;;; Functions and variables from their packages
4171 ;; Declared here to avoid compiler warnings
4173 ;; XEmacs only
4179 ;; Emacs only
4182 ;; Various packages
4201 org-agenda-format-item "org-agenda"
4228 ;;; Autoload and prepare some org modules
4230 ;; Some table stuff that needs to be defined here, because it is used
4231 ;; by the functions setting up org-mode or checking for table context.
4244 "Detect the first line outside a table when searching from within it.
4247 ;; Autoload the functions in org-table.el that are needed by functions here.
4256 ;;;###autoload
4258 "Unconditionally turn on `orgtbl-mode'."
4263 "Return t if the cursor is inside an org-type table.
4264 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4269 org-table-line-regexp)))
4270 nil))
4274 "Return t if and only if we are at a table.el table."
4281 "If there is a table.el table nearby, recognize it and move into it."
4287 nil
4297 t
4302 t)
4303 nil)
4304 nil))
4307 "Return t if the cursor is inside a hline in a table."
4312 nil))
4315 "Apply FUNCTION to the start of all tables in the buffer."
4325 ;; Exclude tables in src/example/verbatim/clocktable blocks
4333 ;; Declare and autoload functions from org-agenda.el
4345 "Return t when point (or POS) is in #+TBLFM line."
4360 "Return the buffer where the clock is currently running.
4361 Return nil if no clock is running."
4366 org-clock-update-time-maybe
4367 org-clocktable-shift)))
4370 "Check if the current buffer contains the running clock.
4371 If yes, offer to stop it and to save the buffer with the changes."
4380 "Check if this line starts a clock table, if yes, shift the time block."
4384 ;;;###autoload
4386 "Set up hooks for clock persistence."
4391 ;; Define the variable already here, to make sure we have it.
4393 "Non-nil if Org-Indent mode is enabled.
4396 ;; Autoload archiving code
4397 ;; The stuff that is needed for cycling and tags has to be defined here.
4400 "Options concerning archiving in Org-mode."
4405 "The location where subtrees should be archived.
4407 The value of this variable is a string, consisting of two parts,
4408 separated by a double-colon. The first part is a filename and
4409 the second part is a headline.
4411 When the filename is omitted, archiving happens in the same file.
4412 %s in the filename will be replaced by the current file
4413 name (without the directory part). Archiving to a different file
4414 is useful to keep archived entries from contributing to the
4415 Org-mode Agenda.
4417 The archived entries will be filed as subtrees of the specified
4418 headline. When the headline is omitted, the subtrees are simply
4419 filed away at the end of the file, as top-level entries. Also in
4420 the heading you can use %s to represent the file name, this can be
4421 useful when using the same archive for a number of different files.
4423 Here are a few examples:
4425 If the current file is Projects.org, archive in file
4426 Projects.org_archive, as top-level trees. This is the default.
4429 Archive in the current file, under the top-level headline
4433 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4436 Archive in file ~/org/archive.org (absolute path), under headlines
4441 items to the datetree. Items are placed in either the CLOSED
4442 date of the item, or the current date if there is no CLOSED date.
4443 The heading will be a subentry to the current date. There doesn't
4444 need to be a heading, but there always needs to be a slash after
4445 datetree. For example, to store archived items directly in the
4449 Archive in file ./basement (relative path), as level 3 trees
4452 You may set this option on a per-file basis by adding to the buffer a
4453 line like
4455 #+ARCHIVE: basement::** Finished Tasks
4457 You may also define it locally for a subtree by setting an ARCHIVE property
4458 in the entry. If such a property is found in an entry, or anywhere up
4459 the hierarchy, it will be used."
4464 "The tag that marks a subtree as archived.
4465 An archived subtree does not open during visibility cycling, and does
4466 not contribute to the agenda listings.
4467 After changing this, font-lock must be restarted in the relevant buffers to
4468 get the proper fontification."
4474 "Non-nil means the agenda will skip any items located in archived trees.
4475 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4476 variable is no longer recommended, you should leave it at the value t.
4477 Instead, use the key `v' to cycle the archives-mode in the agenda."
4483 "Non-nil means ignore archived trees when creating column view."
4489 "Non-nil means `org-cycle' will open archived trees.
4490 An archived tree is a tree marked with the tag ARCHIVE.
4491 When nil, archived trees will stay folded. You can still open them with
4492 normal outline commands like `show-all', but not with the cycling commands."
4498 "Non-nil means sparse tree construction shows matches in archived trees.
4499 When nil, matches in these trees are highlighted, but the trees are kept in
4500 collapsed state."
4506 "The default date type when building a sparse tree.
4507 When this is nil, a date is a scheduled or a deadline timestamp.
4508 Otherwise, these types are allowed:
4510 all: all timestamps
4511 active: only active timestamps (<...>)
4512 inactive: only inactive timestamps (<...)
4513 scheduled: only scheduled timestamps
4514 deadline: only deadline timestamps"
4526 "Re-hide all archived subtrees after a visibility state change."
4537 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4540 "Cycle subtree even if it is archived."
4547 "Re-hide all archived subtrees after a visibility state change."
4564 flag)))
4572 ;; Autoload Column View Code
4580 org-columns-get-format-and-top-level
4581 org-columns-compute
4582 org-columns-remove-overlays))
4584 ;; Autoload ID code
4592 org-id-copy
4593 org-id-get-with-outline-path-completion
4594 org-id-get-with-outline-drilling))
4596 ;;; Variables for pre-computed regular expressions, all buffer local
4614 "Matches a headline and puts everything into groups:
4615 group 1: the stars
4616 group 2: The todo keyword, maybe
4617 group 3: Priority cookie
4618 group 4: True headline
4622 "Printf format to make regexp to match an exact headline.
4623 This regexp will match the headline of any node which has the
4624 exact headline text that is put into the format, but may have any
4628 "Matches a headline and puts TODO state into group 2 if present.
4680 "Regular expression to match a plain time or time range.
4681 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4682 groups carry important information:
4683 0 the full match
4684 1 the first time, range or not
4692 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4693 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4694 groups carry important information:
4695 0 the full match
4696 7 hours of duration
4705 "Regular expression to match a timestamp time or time range.
4706 After a match, the following groups carry important information:
4707 0 the full match
4708 1 date plus weekday, for back referencing to make sure both times are on the same day
4709 2 the first time, range or not
4770 "Variable associated with STARTUP options for org-mode.
4771 Each element is a list of three items: the startup options (as written
4772 in the #+STARTUP line), the corresponding variable, and the value to set
4773 this variable to if the option is found. An optional forth element PUSH
4777 "Update PROPS with KEY and VAL."
4791 "Printf format for a regexp matching a headline with some keyword.
4792 This regexp will match the headline of any node which has the
4793 exact keyword that is put into the format. The keyword isn't in
4797 "Printf format for a regexp matching a headline, possibly with some keyword.
4798 This regexp can match any headline with the specified keyword, or
4799 without a keyword. The keyword isn't in any group by default,
4803 "When non-nil (the default), use group tags.
4804 This can be turned on/off through `org-toggle-tags-groups'."
4810 "Toggle support for group tags.
4811 Support for group tags is controlled by the option
4812 `org-group-tags', which is non-nil by default."
4816 org-group-tags)
4824 "Precompute variables used for tags."
4830 tags ftags key value)
4847 ftags
4851 ;; Process the file tags.
4855 ;; Process the tags.
4866 org-tag-alist)))
4875 org-tag-groups-alist)
4898 ;; Return a list with tag variables
4903 "Precompute regular expressions used in the current buffer."
4921 kwds kws0 kwsa key log value cat arch const links hw dws
4922 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4930 ext-setup-or-nil
4938 ;; Append setupfile tags to existing tags
4942 org-tag-alist
4944 org-tag-groups-alist
4962 ;; general TODO-like setup
4971 links)))
4978 props))))
4985 l var val)
5003 ;; Prevent checking in Gnus messages
5015 ;; search for property blocks
5024 props)))))))
5039 ;; Process the TODO keywords
5041 ;; Use the global values as if they had been given locally.
5053 kws)))
5056 kwsa nil
5059 ;; 1 2
5067 kw)
5069 kws0)
5086 ;; Compute the regular expressions and other local variables.
5087 ;; Using `org-outline-regexp-bol' would complicate them much,
5088 ;; because of the fixed white space at the end of that string.
5096 org-drawer-regexp
5100 org-not-done-keywords
5102 org-todo-regexp
5106 org-not-done-regexp
5110 org-not-done-heading-regexp
5112 org-todo-line-regexp
5114 org-complex-heading-regexp
5121 org-complex-heading-regexp-format
5126 ;; Stats cookies can be stuck to body.
5133 org-todo-line-tags-regexp
5140 org-deadline-time-regexp
5142 org-deadline-time-hour-regexp
5145 org-deadline-line-regexp
5147 org-scheduled-regexp
5149 org-scheduled-time-regexp
5151 org-scheduled-time-hour-regexp
5154 org-closed-time-regexp
5156 org-keyword-time-regexp
5162 org-keyword-time-not-clock-regexp
5168 org-maybe-keyword-time-regexp
5174 org-all-time-keywords
5177 org-clock-string org-closed-string)))
5182 "Return the contents of FILE, as a string."
5193 "Extract the log state setting from a TODO keyword string.
5207 "Remove a pair of parenthesis at the end of each string in LIST."
5211 x))
5212 list))
5215 "Assign fast keys to a keyword-key alist.
5216 Respect keys that are already there."
5234 ;;; Some variables used in various places
5241 "Function to be called when `C-c C-c' is used.
5245 ;; FIXME: Occasionally check by commenting these, to make sure
5246 ;; no other functions uses these, forgetting to let-bind them.
5251 ;; Defined somewhere in this file, but used before definition.
5257 ;;;; Define the Org-mode
5259 ;; We use a before-change function to check if a table might need
5260 ;; an update.
5262 "Indicates that a table might need an update.
5263 This variable is set by `org-before-change-function'.
5266 "Every change indicates that a table might need an update."
5281 (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"))
5284 ;; Other stuff we need.
5290 ;; (require 'org-macs) moved higher up in the file before it is first used
5292 ;; (require 'org-compat) moved higher up in the file before it is first used
5300 ;; babel
5303 ;;;###autoload
5305 "Outline-based notes management and organizer, alias
5308 Org-mode develops organizational tasks around a NOTES file which
5309 contains information about projects as plain text. Org-mode is
5310 implemented on top of outline-mode, which is ideal to keep the content
5311 of large files well structured. It supports ToDo items, deadlines and
5312 time stamps, which magically appear in the diary listing of the Emacs
5313 calendar. Tables are easily created with a built-in table editor.
5314 Plain text URL-like links connect to websites, emails (VM), Usenet
5315 messages (Gnus), BBDB entries, and any files related to the project.
5316 For printing and sharing of notes, an Org-mode file (or a part of it)
5317 can be exported as a structured ASCII or HTML file.
5319 The following commands are available:
5323 ;; Get rid of Outline menus, they are not needed
5324 ;; Need to do this here because define-derived-mode sets up
5325 ;; the keymap so late. Still, it is a waste to call this each time
5326 ;; we switch another buffer into org-mode.
5329 ;; Assume this is Greg's port, it uses easymenu
5355 org-display-table 4
5358 org-ellipsis)))
5365 ;; tag faces set outside customize.... force initialization.
5367 ;; Calc embedded
5369 ;; Modify a few syntax entries
5376 ;; Activate before-change-function
5380 ;; Check for running clock before killing a buffer
5382 ;; Initialize macros templates.
5384 ;; Initialize radio targets.
5386 ;; Indentation.
5389 ;; Filling and auto-filling.
5391 ;; Comments.
5393 ;; Beginning/end of defun
5396 ;; Next error for sparse trees
5398 ;; Make sure dependence stuff works reliably, even for users who set it
5399 ;; too late :-(
5411 ;; Align options lines
5413 'align-mode-rules-list
5418 ;; Imenu
5422 ;; Make isearch reveal context
5425 ;; Emacs 21 and XEmacs make use of the hook
5427 ;; Emacs 22 deals with this through a special variable
5432 ;; Setup the pcomplete hooks
5445 ;; If empty file that did not turn on org-mode automatically, make it to.
5461 ;; Try to set org-hide correctly
5464 ;; Update `customize-package-emacs-version-alist'
5474 org-emphasis-alist)
5475 st))
5488 "unspecified-bg"
5501 "Current time, possibly rounded to ROUNDING-MINUTES.
5502 When ROUNDING-MINUTES is not an integer, fall back on the car of
5503 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5504 the rounding returns a past time."
5516 res))))
5519 "Return today date, considering `org-extend-today-until'."
5524 ;;;; Font-Lock stuff, including the activators
5555 "Regular expression used to analyze links.
5556 Here is what the match groups contain after a match:
5557 1: http:
5558 2: http
5559 3: path
5560 4: [desc]
5571 "Create a regular expression which will match a balanced sexp.
5572 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5573 as single character strings.
5574 The regexp returned will match the entire expression including the
5575 delimiters. It will also define a single group which contains the
5576 match except for the outermost delimiters. The maximum depth of
5577 stacked delimiters is N. Escaping delimiters is not possible."
5606 "Update the link regular expressions.
5607 This should be called after the variable `org-link-types' has changed."
5611 org-link-re-with-space
5617 org-link-re-with-space2
5623 org-link-re-with-space3
5628 org-angle-link-re
5634 org-plain-link-re
5638 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5639 org-bracket-link-regexp
5641 org-bracket-link-analytic-regexp
5649 org-bracket-link-analytic-regexp++
5657 org-any-link-re
5666 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5669 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5670 "Regular expression matching time strings for analysis.
5671 This one does not require the space after the date, so it can be used
5673 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5690 "Regular expression matching a time stamp or time stamp range.
5696 "Run through the buffer and add overlays to emphasized strings."
5705 'face
5718 rtn))
5721 "Insert or change an emphasis, i.e. a font like bold or italic.
5722 If there is an active region, change that region to a new emphasis.
5723 If there is no region, just insert the marker characters and position
5724 the cursor between them.
5725 CHAR should be the marker character. If it is a space, it means to
5726 remove the emphasis of the selected region.
5727 If CHAR is not given (for example in an interactive call) it will be
5728 prompted for."
5771 "Run through the buffer and add overlays to links."
5780 nil
5787 t)))
5795 t)))
5798 "When non-nil, fontify code in code blocks."
5805 "When non-nil, allow promoting a top level subtree.
5806 The leading star of the top level headline will be replaced
5807 by a #."
5818 "Fontify #+ lines and blocks."
5821 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5822 limit t)
5830 end end1 quoting block-type ovl)
5833 ;; a single line of backend-specific content
5841 ; for backend-specific code
5842 t)
5844 ;; Truly a block
5857 beg end
5865 ;; remove old background overlays
5870 ;; add a background overlay
5885 t))
5905 t)
5911 ;; just any other in-buffer setting, but not indented
5915 t)
5919 "Run through the buffer and add overlays to links."
5928 t)))
5931 "Run through the buffer and add overlays to footnotes."
5938 'keymap org-mouse-map
5939 'help-echo
5941 "Footnote definition"
5943 'font-lock-fontified t
5944 'font-lock-multiline t
5948 "Run through the buffer and add overlays to bracketed links."
5961 ;; We need to remove the invisible property here. Table narrowing
5962 ;; may have made some of this invisible.
5980 t)))
5983 "Run through the buffer and add overlays to dates."
5996 t)))
6005 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
6009 "Run through the buffer and add overlays to target matches."
6017 'keymap org-mouse-map
6021 t)))))
6024 "Find all radio targets in this file and update the regular expression."
6039 t)))
6047 "Compute regular expression for LaTeX, entities and sub/superscript.
6048 Result depends on variable `org-highlight-latex-and-related'."
6050 'org-latex-and-related-regexp
6062 org-latex-regexps)))))
6069 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6070 LIMIT bounds the search for syntax to highlight. Stop at first
6071 highlighted object, if any. Return t if some highlighting was
6072 done, nil otherwise."
6081 1
6089 nil)))
6092 "Restart `font-lock-mode', to force refontification."
6098 "Return a list of all targets in this file.
6099 When optional argument RADIO is non-nil, only find radio
6100 targets."
6105 ;; Make sure point is really within the object.
6110 rtn)))
6113 "Make regular expression matching all strings in TARGETS.
6114 The regular expression finds the targets also if there is a line break
6115 between words."
6124 x)
6125 targets
6137 t)))
6140 "Compute the outline level of the heading at point.
6141 If this is called at a normal headline, the level is the number of stars.
6142 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6147 0
6154 "Return a regexp matching a PROPERTY line.
6155 Match group 3 will be set to the value if it exists."
6162 "Regular expression matching a property line.
6163 There are four matching groups:
6164 1: :PROPKEY: including the leading and trailing colon,
6165 2: PROPKEY without the leading and trailing colon,
6166 3: PROPVAL without leading or trailing spaces,
6167 4: the indentation of the current line,
6174 "Functions that can manipulate `org-font-lock-extra-keywords'.
6175 This is called after `org-font-lock-extra-keywords' is defined, but before
6176 it is installed to be used by font lock. This can be useful if something
6180 "Run `org-font-lock-hook' within LIMIT."
6184 "Set font lock defaults for the current buffer."
6189 ;; Call the hook
6191 ;; Headlines
6198 ;; Table lines
6201 ;; Table internals
6206 ;; Drawers
6209 ;; Properties
6213 ;; Links
6221 ;; Targets.
6223 ;; Diary sexps.
6225 ;; Macro
6228 ;; TODO keyword
6230 org-todo-regexp)
6232 ;; DONE
6240 nil)
6241 ;; Priorities
6243 ;; Tags
6245 ;; Tags groups
6251 ;; Special keywords
6256 ;; Emphasis
6261 ;; Checkboxes
6262 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6267 ;; Description list items
6270 ;; ARCHIVEd headings
6272 org-outline-regexp-bol
6275 ;; Specials
6279 ;; Code
6281 ;; COMMENT
6287 ;; Blocks and meta lines
6291 ;; Now set the full font-lock-keywords
6298 "Toggle the composition display of entities as UTF8 characters."
6314 "Display or hide properties in `org-custom-properties'."
6331 org-custom-properties)))))))
6334 "Find an entity to fontify."
6340 limit t)
6355 nil))))
6358 "Fontify string S like in Org-mode."
6370 "Get the right face for match N in font-lock matching of headlines."
6383 "Get the right face for a TODO keyword KWD.
6384 If KWD is a number, get the corresponding match group."
6392 "Create a face list that inherits INHERIT, but sets the foreground color.
6393 When FACE-OR-COLOR is not a string, just return it."
6397 face-or-color)
6398 face-or-color))
6401 "Add the special tag faces."
6410 "Add the special priority faces."
6418 org-priority-faces)))
6423 "Get the right face for a TODO keyword KWD.
6424 If KWD is a number, get the corresponding match group."
6431 "Remove fontification and activation overlays from links."
6436 deactivate-mark buffer-file-name buffer-file-truename)
6440 invisible t intangible t
6441 org-no-flyspell t org-emphasis t))
6451 "Remove specific display properties that have been added by font lock.
6452 The will remove the raise properties that are used to show superscripts
6453 and subscripts."
6463 "Add raise properties to sub/superscripts."
6467 org-match-substring-regexp
6468 org-match-substring-with-braces-regexp)
6469 limit t)
6479 ;; Handle a_b^c
6482 t
6484 'display
6500 t)))))
6502 ;;;; Visibility cycling, including org-goto and indirect buffer
6504 ;;; Cycling
6516 "Display a message, but avoid logging it in the *Messages* buffer."
6520 ;;;###autoload
6522 "TAB-action and visibility cycling for Org-mode.
6524 This is the command invoked in Org-mode by the TAB key. Its main purpose
6525 is outline visibility cycling, but it also invokes other actions
6526 in special contexts.
6528 - When this function is called with a prefix argument, rotate the entire
6529 buffer through 3 states (global cycling)
6530 1. OVERVIEW: Show only top-level headlines.
6531 2. CONTENTS: Show all headlines of all levels, but no body text.
6532 3. SHOW ALL: Show everything.
6533 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6534 determined by the variable `org-startup-folded', and by any VISIBILITY
6535 properties in the buffer.
6536 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6537 including any drawers.
6539 - When inside a table, re-align the table and move to the next field.
6541 - When point is at the beginning of a headline, rotate the subtree started
6542 by this line through 3 different states (local cycling)
6543 1. FOLDED: Only the main headline is shown.
6544 2. CHILDREN: The main headline and the direct children are shown.
6545 From this state, you can move to one of the children
6546 and zoom in further.
6547 3. SUBTREE: Show the entire subtree, including body text.
6548 If there is no subtree, switch directly from CHILDREN to FOLDED.
6550 - When point is at the beginning of an empty headline and the variable
6551 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6552 of the headline by demoting and promoting it to likely levels. This
6553 speeds up creation document structure by pressing TAB once or several
6554 times right after creating a new headline.
6556 - When there is a numeric prefix, go up to a heading with level ARG, do
6557 a `show-subtree' and return to the previous cursor position. If ARG
6558 is negative, go up that many levels.
6560 - When point is not at the beginning of a headline, execute the global
6561 binding for TAB, which is re-indenting the line. See the option
6562 `org-cycle-emulate-tab' for details.
6564 - Special case: if point is at the beginning of the buffer and there is
6565 no headline in line 1, this function will act as if called with prefix arg
6566 (C-u TAB, same as S-TAB) also when called without prefix arg.
6567 But only if also the variable `org-cycle-global-at-bob' is t."
6577 org-inlinetask-min-level
6582 limit-level)))
6585 outline-regexp
6593 org-cycle-hook))
6597 ;; special case: use global cycling
6611 ;; Table: enter it or move to the next field.
6622 ;; Global cycling: delegate to `org-cycle-internal-global'.
6625 ;; Drawers: delegate to `org-flag-drawer'.
6633 ;; Show-subtree, ARG levels up from here.
6641 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6649 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6656 ;; From there: TAB emulation and template completion.
6678 t
6687 "Do the global cycling action."
6688 ;; Hack to avoid display of messages for .org attachments in Gnus
6693 ;; We just created the overview - now do table of contents
6694 ;; This can be slow in very large buffers, so indicate action
6704 ;; We just showed the table of contents - now show everything
6712 ;; Default action: go to overview
6720 "Do the local cycling action."
6722 ;; First, determine end of headline (EOH), end of subtree or item
6723 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6743 ;; Determine end invisible part of buffer (EOL)
6745 ;; XEmacs doesn't have `next-single-char-property-change'
6755 ;; Find out what to do next and set `this-command'
6758 ;; Nothing is hidden behind this heading
6771 org-cycle-skip-children-state-if-no-children))))
6772 ;; Entire subtree is hidden in one line: children view
6779 ;; FIXME: This slows down the func way too much.
6780 ;; How keep drawers hidden in subtree anyway?
6781 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6782 ;; (org-cycle-hide-drawers 'subtree))
6784 ;; Fold every list in subtree to top-level items.
6807 ;; We just showed the children, or no children are there,
6808 ;; now show everything.
6818 ;; Default action: hide the subtree.
6826 ;;;###autoload
6828 "Cycle the global visibility. For details see `org-cycle'.
6830 With a numeric prefix, show all headlines up to that level."
6846 "Set the visibility required by startup options and properties."
6861 "Switch subtree visibilities according to :VISIBILITY: property."
6868 nil t)
6892 ;; This function uses outline-regexp instead of the more fundamental
6893 ;; org-outline-regexp so that org-cycle-global works outside of Org
6894 ;; buffers, where outline-regexp is needed.
6896 "Switch to overview mode, showing only top-level headlines.
6897 Really, this shows all headlines with level equal or greater than the level
6898 of the first headline in the buffer. This is important, because if the
6899 first headline is not level one, then (hide-sublevels 1) gives confusing
6900 results."
6914 "Show all headlines in the buffer, like a table of contents.
6915 With numerical argument N, show content up to level N."
6918 ;; Visit all headings and show their offspring
6925 t)
6934 "Adjust the window after a change in outline visibility.
6935 This function is the default value of the hook `org-cycle-hook'."
6945 "Remove outline overlays that do not contain non-white stuff."
6955 "Fix visibility issues after moving a subtree."
6956 ;; First, find a reasonable region to look at:
6957 ;; Start two siblings above, end three below
6975 ;; Properly fold already folded siblings
6986 "Show empty lines above all visible headlines.
6987 The region to be covered depends on STATE when called through
6988 `org-cycle-hook'. Lisp program can use t for STATE to get the
6989 entire buffer covered. Note that an empty line is only shown if there
6990 are at least `org-cycle-separator-lines' empty lines before the headline."
7000 beg end b e)
7024 ;; Never hide empty lines at the end of the file.
7034 "Move to the parent and re-show empty lines before visible headlines."
7040 "Return `org-agenda-files' list, plus all open org-mode files.
7041 This is useful for operations that need to scan all of a user's
7042 open and agenda-wise Org files."
7050 files))
7053 "Return the beginning position of the current entry."
7057 "Return the end position of the current entry."
7061 "Re-hide all drawers after a visibility state change."
7076 "Re-hide inline task when switching to 'contents visibility state."
7079 org-inlinetask-min-level)
7083 "When FLAG is non-nil, hide the drawer we are within.
7084 Otherwise make it visible."
7096 "Is the end of the current subtree visible?"
7101 "Move cursor to the first headline and recenter the headline.
7102 Optional argument N means put the headline into the Nth line of the window."
7108 ;;; Saving and restoring visibility
7111 "Return a list of the locations of all outline overlays.
7112 These are overlays with the `invisible' property value `outline'.
7113 The return value is a list of cons cells, with start and stop
7114 positions for each overlay.
7115 If USE-MARKERS is set, return the positions as markers."
7133 "Create visibility overlays for all positions in DATA.
7134 DATA should have been made by `org-outline-overlay-data'."
7142 data)))))
7144 ;;; Folding of blocks
7151 "Call FUNCTION at the head of all source blocks in the current buffer.
7152 Optional arguments START and END can be used to limit the range."
7164 "Toggle the visibility of all blocks in the current buffer."
7168 "Fold all blocks in the current buffer."
7174 "Unfold all blocks in the current buffer."
7180 "Toggle visibility of block at point."
7191 "Toggle the visibility of the current block."
7198 ov)
7214 ;; make the block accessible to isearch
7216 ov 'isearch-open-invisible
7227 ;; org-tab-after-check-for-cycling-hook
7229 ;; Remove overlays when changing major mode
7234 ;;; Org-goto
7240 "Set the keymap `org-goto'."
7244 mouse-drag-region universal-argument org-occur))
7245 cmd)
7261 nil)
7262 (org-defkey map "q" 'org-goto-quit)
7263 (org-defkey map "n" 'outline-next-visible-heading)
7264 (org-defkey map "p" 'outline-previous-visible-heading)
7265 (org-defkey map "f" 'outline-forward-same-level)
7266 (org-defkey map "b" 'outline-backward-same-level)
7267 (org-defkey map "u" 'outline-up-heading))
7268 (org-defkey map "/" 'org-occur)
7269 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7270 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7271 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7272 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7273 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7274 map)))
7276 (defconst org-goto-help
7277 "Browse buffer copy, to find location or copy text.%s
7278 RET=jump to location C-g=quit and return to previous location
7279 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7281 (defvar org-goto-start-pos) ; dynamically scoped parameter
7283 (defun org-goto (&optional alternative-interface)
7284 "Look up a different location in the current file, keeping current visibility.
7286 When you want look-up or go to a different location in a
7287 document, the fastest way is often to fold the entire buffer and
7288 then dive into the tree. This method has the disadvantage, that
7289 the previous location will be folded, which may not be what you
7290 want.
7292 This command works around this by showing a copy of the current
7293 buffer in an indirect buffer, in overview mode. You can dive
7294 into the tree in that copy, use org-occur and incremental search
7295 to find a location. When pressing RET or `Q', the command
7296 returns to the original buffer in which the visibility is still
7297 unchanged. After RET it will also jump to the location selected
7298 in the indirect buffer and expose the headline hierarchy above.
7300 With a prefix argument, use the alternative interface: e.g. if
7301 `org-goto-interface' is 'outline use 'outline-path-completion."
7302 (interactive "P")
7303 (org-goto-map)
7304 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7305 (org-refile-use-outline-path t)
7306 (org-refile-target-verify-function nil)
7307 (interface
7308 (if (not alternative-interface)
7309 org-goto-interface
7310 (if (eq org-goto-interface 'outline)
7311 'outline-path-completion
7312 'outline)))
7313 (org-goto-start-pos (point))
7314 (selected-point
7315 (if (eq interface 'outline)
7316 (car (org-get-location (current-buffer) org-goto-help))
7317 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7318 (org-refile-check-position pa)
7319 (nth 3 pa)))))
7320 (if selected-point
7321 (progn
7322 (org-mark-ring-push org-goto-start-pos)
7323 (goto-char selected-point)
7324 (if (or (outline-invisible-p) (org-invisible-p2))
7325 (org-show-context 'org-goto)))
7326 (message "Quit"))))
7328 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7329 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7330 (defvar org-goto-local-auto-isearch-map) ; defined below
7332 (defun org-get-location (buf help)
7333 "Let the user select a location in the Org-mode buffer BUF.
7334 This function uses a recursive edit. It returns the selected position
7335 or nil."
7336 (org-no-popups
7337 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7338 (isearch-hide-immediately nil)
7339 (isearch-search-fun-function
7340 (lambda () 'org-goto-local-search-headings))
7341 (org-goto-selected-point org-goto-exit-command))
7342 (save-excursion
7343 (save-window-excursion
7344 (delete-other-windows)
7345 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7346 (org-pop-to-buffer-same-window
7347 (condition-case nil
7348 (make-indirect-buffer (current-buffer) "*org-goto*")
7349 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7350 (with-output-to-temp-buffer "*Org Help*"
7351 (princ (format help (if org-goto-auto-isearch
7352 " Just type for auto-isearch."
7353 " n/p/f/b/u to navigate, q to quit."))))
7354 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7355 (setq buffer-read-only nil)
7356 (let ((org-startup-truncated t)
7357 (org-startup-folded nil)
7358 (org-startup-align-all-tables nil))
7359 (org-mode)
7360 (org-overview))
7361 (setq buffer-read-only t)
7362 (if (and (boundp 'org-goto-start-pos)
7363 (integer-or-marker-p org-goto-start-pos))
7364 (let ((org-show-hierarchy-above t)
7365 (org-show-siblings t)
7366 (org-show-following-heading t))
7367 (goto-char org-goto-start-pos)
7368 (and (outline-invisible-p) (org-show-context)))
7369 (goto-char (point-min)))
7370 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7371 (message "Select location and press RET")
7372 (use-local-map org-goto-map)
7373 (recursive-edit)))
7374 (kill-buffer "*org-goto*")
7375 (cons org-goto-selected-point org-goto-exit-command))))
7377 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7378 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7379 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7380 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7382 (defun org-goto-local-search-headings (string bound noerror)
7383 "Search and make sure that any matches are in headlines."
7384 (catch 'return
7385 (while (if isearch-forward
7386 (search-forward string bound noerror)
7387 (search-backward string bound noerror))
7388 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7389 (and (member :headline context)
7390 (not (member :tags context))))
7391 (throw 'return (point))))))
7393 (defun org-goto-local-auto-isearch ()
7394 "Start isearch."
7395 (interactive)
7396 (goto-char (point-min))
7397 (let ((keys (this-command-keys)))
7398 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7399 (isearch-mode t)
7400 (isearch-process-search-char (string-to-char keys)))))
7402 (defun org-goto-ret (&optional arg)
7403 "Finish `org-goto' by going to the new location."
7404 (interactive "P")
7405 (setq org-goto-selected-point (point)
7406 org-goto-exit-command 'return)
7407 (throw 'exit nil))
7409 (defun org-goto-left ()
7410 "Finish `org-goto' by going to the new location."
7411 (interactive)
7412 (if (org-at-heading-p)
7413 (progn
7414 (beginning-of-line 1)
7415 (setq org-goto-selected-point (point)
7416 org-goto-exit-command 'left)
7417 (throw 'exit nil))
7418 (user-error "Not on a heading")))
7420 (defun org-goto-right ()
7421 "Finish `org-goto' by going to the new location."
7422 (interactive)
7423 (if (org-at-heading-p)
7424 (progn
7425 (setq org-goto-selected-point (point)
7426 org-goto-exit-command 'right)
7427 (throw 'exit nil))
7428 (user-error "Not on a heading")))
7430 (defun org-goto-quit ()
7431 "Finish `org-goto' without cursor motion."
7432 (interactive)
7433 (setq org-goto-selected-point nil)
7434 (setq org-goto-exit-command 'quit)
7435 (throw 'exit nil))
7437 ;;; Indirect buffer display of subtrees
7439 (defvar org-indirect-dedicated-frame nil
7440 "This is the frame being used for indirect tree display.")
7441 (defvar org-last-indirect-buffer nil)
7443 (defun org-tree-to-indirect-buffer (&optional arg)
7444 "Create indirect buffer and narrow it to current subtree.
7445 With a numerical prefix ARG, go up to this level and then take that tree.
7446 If ARG is negative, go up that many levels.
7448 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7449 indirect buffer previously made with this command, to avoid proliferation of
7450 indirect buffers. However, when you call the command with a \
7452 when `org-indirect-buffer-display' is `new-frame', the last buffer
7453 is kept so that you can work with several indirect buffers at the same time.
7454 If `org-indirect-buffer-display' is `dedicated-frame', the \
7456 requests that a new frame be made for the new buffer, so that the dedicated
7457 frame is not changed."
7458 (interactive "P")
7459 (let ((cbuf (current-buffer))
7460 (cwin (selected-window))
7461 (pos (point))
7462 beg end level heading ibuf)
7463 (save-excursion
7464 (org-back-to-heading t)
7465 (when (numberp arg)
7466 (setq level (org-outline-level))
7467 (if (< arg 0) (setq arg (+ level arg)))
7468 (while (> (setq level (org-outline-level)) arg)
7469 (org-up-heading-safe)))
7470 (setq beg (point)
7471 heading (org-get-heading))
7472 (org-end-of-subtree t t)
7473 (if (org-at-heading-p) (backward-char 1))
7474 (setq end (point)))
7475 (if (and (buffer-live-p org-last-indirect-buffer)
7476 (not (eq org-indirect-buffer-display 'new-frame))
7477 (not arg))
7478 (kill-buffer org-last-indirect-buffer))
7479 (setq ibuf (org-get-indirect-buffer cbuf)
7480 org-last-indirect-buffer ibuf)
7481 (cond
7482 ((or (eq org-indirect-buffer-display 'new-frame)
7483 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7484 (select-frame (make-frame))
7485 (delete-other-windows)
7486 (org-pop-to-buffer-same-window ibuf)
7487 (org-set-frame-title heading))
7488 ((eq org-indirect-buffer-display 'dedicated-frame)
7489 (raise-frame
7490 (select-frame (or (and org-indirect-dedicated-frame
7491 (frame-live-p org-indirect-dedicated-frame)
7492 org-indirect-dedicated-frame)
7493 (setq org-indirect-dedicated-frame (make-frame)))))
7494 (delete-other-windows)
7495 (org-pop-to-buffer-same-window ibuf)
7496 (org-set-frame-title (concat "Indirect: " heading)))
7497 ((eq org-indirect-buffer-display 'current-window)
7498 (org-pop-to-buffer-same-window ibuf))
7499 ((eq org-indirect-buffer-display 'other-window)
7500 (pop-to-buffer ibuf))
7501 (t (error "Invalid value")))
7502 (if (featurep 'xemacs)
7503 (save-excursion (org-mode) (turn-on-font-lock)))
7504 (narrow-to-region beg end)
7505 (show-all)
7506 (goto-char pos)
7507 (run-hook-with-args 'org-cycle-hook 'all)
7508 (and (window-live-p cwin) (select-window cwin))))
7510 (defun org-get-indirect-buffer (&optional buffer)
7511 (setq buffer (or buffer (current-buffer)))
7512 (let ((n 1) (base (buffer-name buffer)) bname)
7513 (while (buffer-live-p
7514 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7515 (setq n (1+ n)))
7516 (condition-case nil
7517 (make-indirect-buffer buffer bname 'clone)
7518 (error (make-indirect-buffer buffer bname)))))
7520 (defun org-set-frame-title (title)
7521 "Set the title of the current frame to the string TITLE."
7522 ;; FIXME: how to name a single frame in XEmacs???
7523 (unless (featurep 'xemacs)
7524 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7526 ;;;; Structure editing
7528 ;;; Inserting headlines
7530 (defun org-previous-line-empty-p (&optional next)
7531 "Is the previous line a blank line?
7532 When NEXT is non-nil, check the next line instead."
7533 (save-excursion
7534 (and (not (bobp))
7535 (or (beginning-of-line (if next 2 0)) t)
7536 (save-match-data
7539 (defun org-insert-heading (&optional arg invisible-ok)
7540 "Insert a new heading or item with same depth at point.
7541 If point is in a plain list and ARG is nil, create a new list item.
7542 With one universal prefix argument, insert a heading even in lists.
7543 With two universal prefix arguments, insert the heading at the end
7544 of the parent subtree.
7546 If point is at the beginning of a headline, insert a sibling before
7547 the current headline. If point is not at the beginning, split the line
7548 and create a new headline with the text in the current line after point
7549 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7551 If point is at the beginning of a normal line, turn this line into
7552 a heading.
7554 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7555 This is important for non-interactive uses of the command."
7556 (interactive "P")
7557 (if (org-called-interactively-p 'any) (org-reveal))
7558 (let ((itemp (org-in-item-p))
7559 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7560 (respect-content (or org-insert-heading-respect-content
7561 (equal arg '(16))))
7562 (initial-content "")
7563 (adjust-empty-lines t))
7565 (cond
7567 ((or (= (buffer-size) 0)
7568 (and (not (save-excursion
7569 (and (ignore-errors (org-back-to-heading invisible-ok))
7570 (org-at-heading-p))))
7571 (or arg (not itemp))))
7572 ;; At beginning of buffer or so high up that only a heading
7573 ;; makes sense.
7574 (insert
7576 (if (org-in-src-block-p) ",* " "* "))
7577 (run-hooks 'org-insert-heading-hook))
7579 ((and itemp (not (equal arg '(4))))
7580 ;; Insert an item
7581 (org-insert-item))
7583 (t
7584 ;; Insert a heading
7585 (save-restriction
7586 (widen)
7587 (let* ((level nil)
7588 (on-heading (org-at-heading-p))
7589 (empty-line-p (if on-heading
7590 (org-previous-line-empty-p)
7591 ;; We will decide later
7592 nil))
7593 ;; Get a level string to fall back on
7594 (fix-level
7595 (save-excursion
7596 (org-back-to-heading t)
7597 (if (org-previous-line-empty-p) (setq empty-line-p t))
7598 (looking-at org-outline-regexp)
7599 (make-string (1- (length (match-string 0))) ?*)))
7600 (stars
7601 (save-excursion
7602 (condition-case nil
7603 (progn
7604 (org-back-to-heading invisible-ok)
7605 (when (and (not on-heading)
7606 (featurep 'org-inlinetask)
7607 (integerp org-inlinetask-min-level)
7608 (>= (length (match-string 0))
7609 org-inlinetask-min-level))
7610 ;; Find a heading level before the inline task
7611 (while (and (setq level (org-up-heading-safe))
7612 (>= level org-inlinetask-min-level)))
7613 (if (org-at-heading-p)
7614 (org-back-to-heading invisible-ok)
7615 (error "This should not happen")))
7616 (unless (and (save-excursion
7617 (save-match-data
7618 (org-backward-heading-same-level
7619 1 invisible-ok))
7620 (= (point) (match-beginning 0)))
7621 (not (org-previous-line-empty-p t)))
7622 (setq empty-line-p (or empty-line-p
7623 (org-previous-line-empty-p))))
7624 (match-string 0))
7625 (error (or fix-level "* ")))))
7626 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7627 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7628 pos hide-previous previous-pos)
7630 ;; If we insert after content, move there and clean up whitespace
7631 (when respect-content
7632 (org-end-of-subtree nil t)
7635 (unless (eobp) (forward-char 1))
7637 (unless (bobp) (backward-char 1))
7640 ;; If we are splitting, grab the text that should be moved to the new headline
7641 (when may-split
7642 (if (org-on-heading-p)
7643 ;; This is a heading, we split intelligently (keeping tags)
7644 (let ((pos (point)))
7645 (goto-char (point-at-bol))
7646 (unless (looking-at org-complex-heading-regexp)
7647 (error "This should not happen"))
7648 (when (and (match-beginning 4)
7649 (> pos (match-beginning 4))
7650 (< pos (match-end 4)))
7651 (setq initial-content (buffer-substring pos (match-end 4)))
7652 (goto-char pos)
7653 (delete-region (point) (match-end 4))
7655 (replace-match "")
7656 (insert (make-string (length initial-content) ?\ )))
7657 (setq initial-content (org-trim initial-content)))
7658 (goto-char pos))
7659 ;; a normal line
7660 (unless (bolp)
7661 (setq initial-content (buffer-substring (point) (point-at-eol)))
7662 (delete-region (point) (point-at-eol))
7663 (setq initial-content (org-trim initial-content)))))
7665 ;; If we are at the beginning of the line, insert before it. Else after
7666 (cond
7669 (open-line 1))
7670 (t
7671 (goto-char (point-at-eol))
7674 ;; Insert the new heading
7675 (insert stars)
7676 (just-one-space)
7677 (insert initial-content)
7678 (when adjust-empty-lines
7679 (if (or (not blank)
7680 (and blank (not (org-previous-line-empty-p))))
7681 (org-N-empty-lines-before-current (if blank 1 0))))
7682 (run-hooks 'org-insert-heading-hook)))))))
7684 (defun org-N-empty-lines-before-current (N)
7685 "Make the number of empty lines before current exactly N.
7686 So this will delete or add empty lines."
7687 (save-excursion
7688 (goto-char (point-at-bol))
7690 (replace-match ""))
7692 (while (> N 0)
7694 (setq N (1- N)))))
7696 (defun org-get-heading (&optional no-tags no-todo)
7697 "Return the heading of the current entry, without the stars.
7698 When NO-TAGS is non-nil, don't include tags.
7699 When NO-TODO is non-nil, don't include TODO keywords."
7700 (save-excursion
7701 (org-back-to-heading t)
7702 (cond
7703 ((and no-tags no-todo)
7704 (looking-at org-complex-heading-regexp)
7705 (match-string 4))
7706 (no-tags
7707 (looking-at (concat org-outline-regexp
7710 (match-string 1))
7711 (no-todo
7712 (looking-at org-todo-line-regexp)
7713 (match-string 3))
7714 (t (looking-at org-heading-regexp)
7715 (match-string 2)))))
7717 (defvar orgstruct-mode) ; defined below
7719 (defun org-heading-components ()
7720 "Return the components of the current heading.
7721 This is a list with the following elements:
7722 - the level as an integer
7723 - the reduced level, different if `org-odd-levels-only' is set.
7724 - the TODO keyword, or nil
7725 - the priority character, like ?A, or nil if no priority is given
7726 - the headline text itself, or the tags string if no headline text
7727 - the tags string, or nil."
7728 (save-excursion
7729 (org-back-to-heading t)
7730 (if (let (case-fold-search)
7731 (looking-at
7732 (if orgstruct-mode
7733 org-heading-regexp
7734 org-complex-heading-regexp)))
7735 (if orgstruct-mode
7736 (list (length (match-string 1))
7737 (org-reduced-level (length (match-string 1)))
7738 nil
7739 nil
7740 (match-string 2)
7741 nil)
7742 (list (length (match-string 1))
7743 (org-reduced-level (length (match-string 1)))
7744 (org-match-string-no-properties 2)
7745 (and (match-end 3) (aref (match-string 3) 2))
7746 (org-match-string-no-properties 4)
7747 (org-match-string-no-properties 5))))))
7749 (defun org-get-entry ()
7750 "Get the entry text, after heading, entire subtree."
7751 (save-excursion
7752 (org-back-to-heading t)
7753 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7755 (defun org-insert-heading-after-current ()
7756 "Insert a new heading with same level as current, after current subtree."
7757 (interactive)
7758 (org-back-to-heading)
7759 (org-insert-heading)
7760 (org-move-subtree-down)
7761 (end-of-line 1))
7763 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7764 "Insert heading with `org-insert-heading-respect-content' set to t."
7765 (interactive "P")
7766 (let ((org-insert-heading-respect-content t))
7767 (org-insert-heading '(4) invisible-ok)))
7769 (defun org-insert-todo-heading-respect-content (&optional force-state)
7770 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7771 (interactive "P")
7772 (let ((org-insert-heading-respect-content t))
7773 (org-insert-todo-heading force-state '(4))))
7775 (defun org-insert-todo-heading (arg &optional force-heading)
7776 "Insert a new heading with the same level and TODO state as current heading.
7777 If the heading has no TODO state, or if the state is DONE, use the first
7778 state (TODO by default). Also one prefix arg, force first state. With two
7779 prefix args, force inserting at the end of the parent subtree."
7780 (interactive "P")
7781 (when (or force-heading (not (org-insert-item 'checkbox)))
7782 (org-insert-heading (or (and (equal arg '(16)) '(16))
7783 force-heading))
7784 (save-excursion
7785 (org-back-to-heading)
7786 (outline-previous-heading)
7787 (looking-at org-todo-line-regexp))
7788 (let*
7789 ((new-mark-x
7790 (if (or arg
7791 (not (match-beginning 2))
7792 (member (match-string 2) org-done-keywords))
7793 (car org-todo-keywords-1)
7794 (match-string 2)))
7795 (new-mark
7796 (or
7797 (run-hook-with-args-until-success
7798 'org-todo-get-default-hook new-mark-x nil)
7799 new-mark-x)))
7800 (beginning-of-line 1)
7801 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7802 (if org-treat-insert-todo-heading-as-state-change
7803 (org-todo new-mark)
7804 (insert new-mark " "))))
7805 (when org-provide-todo-statistics
7806 (org-update-parent-todo-statistics))))
7808 (defun org-insert-subheading (arg)
7809 "Insert a new subheading and demote it.
7810 Works for outline headings and for plain lists alike."
7811 (interactive "P")
7812 (org-insert-heading arg)
7813 (cond
7814 ((org-at-heading-p) (org-do-demote))
7815 ((org-at-item-p) (org-indent-item))))
7817 (defun org-insert-todo-subheading (arg)
7818 "Insert a new subheading with TODO keyword or checkbox and demote it.
7819 Works for outline headings and for plain lists alike."
7820 (interactive "P")
7821 (org-insert-todo-heading arg)
7822 (cond
7823 ((org-at-heading-p) (org-do-demote))
7824 ((org-at-item-p) (org-indent-item))))
7826 ;;; Promotion and Demotion
7828 (defvar org-after-demote-entry-hook nil
7829 "Hook run after an entry has been demoted.
7830 The cursor will be at the beginning of the entry.
7831 When a subtree is being demoted, the hook will be called for each node.")
7833 (defvar org-after-promote-entry-hook nil
7834 "Hook run after an entry has been promoted.
7835 The cursor will be at the beginning of the entry.
7836 When a subtree is being promoted, the hook will be called for each node.")
7838 (defun org-promote-subtree ()
7839 "Promote the entire subtree.
7840 See also `org-promote'."
7841 (interactive)
7842 (save-excursion
7843 (org-with-limited-levels (org-map-tree 'org-promote)))
7844 (org-fix-position-after-promote))
7846 (defun org-demote-subtree ()
7847 "Demote the entire subtree. See `org-demote'.
7848 See also `org-promote'."
7849 (interactive)
7850 (save-excursion
7851 (org-with-limited-levels (org-map-tree 'org-demote)))
7852 (org-fix-position-after-promote))
7855 (defun org-do-promote ()
7856 "Promote the current heading higher up the tree.
7857 If the region is active in `transient-mark-mode', promote all headings
7858 in the region."
7859 (interactive)
7860 (save-excursion
7861 (if (org-region-active-p)
7862 (org-map-region 'org-promote (region-beginning) (region-end))
7863 (org-promote)))
7864 (org-fix-position-after-promote))
7866 (defun org-do-demote ()
7867 "Demote the current heading lower down the tree.
7868 If the region is active in `transient-mark-mode', demote all headings
7869 in the region."
7870 (interactive)
7871 (save-excursion
7872 (if (org-region-active-p)
7873 (org-map-region 'org-demote (region-beginning) (region-end))
7874 (org-demote)))
7875 (org-fix-position-after-promote))
7877 (defun org-fix-position-after-promote ()
7878 "Make sure that after pro/demotion cursor position is right."
7879 (let ((pos (point)))
7880 (when (save-excursion
7881 (beginning-of-line 1)
7882 (looking-at org-todo-line-regexp)
7883 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7884 (cond ((eobp) (insert " "))
7885 ((eolp) (insert " "))
7886 ((equal (char-after) ?\ ) (forward-char 1))))))
7888 (defun org-current-level ()
7889 "Return the level of the current entry, or nil if before the first headline.
7890 The level is the number of stars at the beginning of the headline."
7891 (save-excursion
7892 (org-with-limited-levels
7893 (if (ignore-errors (org-back-to-heading t))
7894 (funcall outline-level)))))
7896 (defun org-get-previous-line-level ()
7897 "Return the outline depth of the last headline before the current line.
7898 Returns 0 for the first headline in the buffer, and nil if before the
7899 first headline."
7900 (let ((current-level (org-current-level))
7901 (prev-level (when (> (line-number-at-pos) 1)
7902 (save-excursion
7903 (beginning-of-line 0)
7904 (org-current-level)))))
7905 (cond ((null current-level) nil) ; Before first headline
7906 ((null prev-level) 0) ; At first headline
7907 (prev-level))))
7909 (defun org-reduced-level (l)
7910 "Compute the effective level of a heading.
7911 This takes into account the setting of `org-odd-levels-only'."
7912 (cond
7913 ((zerop l) 0)
7914 (org-odd-levels-only (1+ (floor (/ l 2))))
7915 (t l)))
7917 (defun org-level-increment ()
7918 "Return the number of stars that will be added or removed at a
7919 time to headlines when structure editing, based on the value of
7920 `org-odd-levels-only'."
7921 (if org-odd-levels-only 2 1))
7923 (defun org-get-valid-level (level &optional change)
7924 "Rectify a level change under the influence of `org-odd-levels-only'
7925 LEVEL is a current level, CHANGE is by how much the level should be
7926 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7927 even level numbers will become the next higher odd number."
7928 (if org-odd-levels-only
7929 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7930 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7931 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7932 (max 1 (+ level (or change 0)))))
7934 (if (boundp 'define-obsolete-function-alias)
7935 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7936 (define-obsolete-function-alias 'org-get-legal-level
7937 'org-get-valid-level)
7938 (define-obsolete-function-alias 'org-get-legal-level
7939 'org-get-valid-level "23.1")))
7941 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7942 ;; ̀org-with-limited-levels'
7943 (defun org-promote ()
7944 "Promote the current heading higher up the tree.
7945 If the region is active in `transient-mark-mode', promote all headings
7946 in the region."
7947 (org-back-to-heading t)
7948 (let* ((level (save-match-data (funcall outline-level)))
7949 (after-change-functions (remove 'flyspell-after-change-function
7950 after-change-functions))
7951 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7952 (diff (abs (- level (length up-head) -1))))
7953 (cond ((and (= level 1) org-called-with-limited-levels
7954 org-allow-promoting-top-level-subtree)
7955 (replace-match "# " nil t))
7956 ((= level 1)
7957 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7958 (t (replace-match up-head nil t)))
7959 ;; Fixup tag positioning
7960 (unless (= level 1)
7961 (and org-auto-align-tags (org-set-tags nil t))
7962 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7963 (run-hooks 'org-after-promote-entry-hook)))
7965 (defun org-demote ()
7966 "Demote the current heading lower down the tree.
7967 If the region is active in `transient-mark-mode', demote all headings
7968 in the region."
7969 (org-back-to-heading t)
7970 (let* ((level (save-match-data (funcall outline-level)))
7971 (after-change-functions (remove 'flyspell-after-change-function
7972 after-change-functions))
7973 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7974 (diff (abs (- level (length down-head) -1))))
7975 (replace-match down-head nil t)
7976 ;; Fixup tag positioning
7977 (and org-auto-align-tags (org-set-tags nil t))
7978 (if org-adapt-indentation (org-fixup-indentation diff))
7979 (run-hooks 'org-after-demote-entry-hook)))
7981 (defun org-cycle-level ()
7982 "Cycle the level of an empty headline through possible states.
7983 This goes first to child, then to parent, level, then up the hierarchy.
7984 After top level, it switches back to sibling level."
7985 (interactive)
7986 (let ((org-adapt-indentation nil))
7987 (when (org-point-at-end-of-empty-headline)
7988 (setq this-command 'org-cycle-level) ; Only needed for caching
7989 (let ((cur-level (org-current-level))
7990 (prev-level (org-get-previous-line-level)))
7991 (cond
7992 ;; If first headline in file, promote to top-level.
7993 ((= prev-level 0)
7994 (loop repeat (/ (- cur-level 1) (org-level-increment))
7995 do (org-do-promote)))
7996 ;; If same level as prev, demote one.
7997 ((= prev-level cur-level)
7998 (org-do-demote))
7999 ;; If parent is top-level, promote to top level if not already.
8000 ((= prev-level 1)
8001 (loop repeat (/ (- cur-level 1) (org-level-increment))
8002 do (org-do-promote)))
8003 ;; If top-level, return to prev-level.
8004 ((= cur-level 1)
8005 (loop repeat (/ (- prev-level 1) (org-level-increment))
8006 do (org-do-demote)))
8007 ;; If less than prev-level, promote one.
8008 ((< cur-level prev-level)
8009 (org-do-promote))
8010 ;; If deeper than prev-level, promote until higher than
8011 ;; prev-level.
8012 ((> cur-level prev-level)
8013 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8014 do (org-do-promote))))
8015 t))))
8017 (defun org-map-tree (fun)
8018 "Call FUN for every heading underneath the current one."
8019 (org-back-to-heading)
8020 (let ((level (funcall outline-level)))
8021 (save-excursion
8022 (funcall fun)
8023 (while (and (progn
8024 (outline-next-heading)
8025 (> (funcall outline-level) level))
8026 (not (eobp)))
8027 (funcall fun)))))
8029 (defun org-map-region (fun beg end)
8030 "Call FUN for every heading between BEG and END."
8031 (let ((org-ignore-region t))
8032 (save-excursion
8033 (setq end (copy-marker end))
8034 (goto-char beg)
8035 (if (and (re-search-forward org-outline-regexp-bol nil t)
8036 (< (point) end))
8037 (funcall fun))
8038 (while (and (progn
8039 (outline-next-heading)
8040 (< (point) end))
8041 (not (eobp)))
8042 (funcall fun)))))
8044 (defvar org-property-end-re) ; silence byte-compiler
8045 (defun org-fixup-indentation (diff)
8046 "Change the indentation in the current entry by DIFF.
8047 However, if any line in the current entry has no indentation, or if it
8048 would end up with no indentation after the change, nothing at all is done."
8049 (save-excursion
8050 (let ((end (save-excursion (outline-next-heading)
8051 (point-marker)))
8052 (prohibit (if (> diff 0)
8055 col)
8056 (unless (save-excursion (end-of-line 1)
8057 (re-search-forward prohibit end t))
8058 (while (and (< (point) end)
8060 (goto-char (match-end 0))
8061 (setq col (current-column))
8062 (if (< diff 0) (replace-match ""))
8063 (org-indent-to-column (+ diff col))))
8064 (move-marker end nil))))
8066 (defun org-convert-to-odd-levels ()
8067 "Convert an org-mode file with all levels allowed to one with odd levels.
8068 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8069 level 5 etc."
8070 (interactive)
8071 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8072 (let ((outline-level 'org-outline-level)
8073 (org-odd-levels-only nil) n)
8074 (save-excursion
8075 (goto-char (point-min))
8077 (setq n (- (length (match-string 0)) 2))
8078 (while (>= (setq n (1- n)) 0)
8079 (org-demote))
8080 (end-of-line 1))))))
8082 (defun org-convert-to-oddeven-levels ()
8083 "Convert an org-mode file with only odd levels to one with odd/even levels.
8084 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8085 file contains a section with an even level, conversion would
8086 destroy the structure of the file. An error is signaled in this
8087 case."
8088 (interactive)
8089 (goto-char (point-min))
8090 ;; First check if there are no even levels
8092 (org-show-context t)
8093 (error "Not all levels are odd in this file. Conversion not possible"))
8094 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8095 (let ((outline-regexp org-outline-regexp)
8096 (outline-level 'org-outline-level)
8097 (org-odd-levels-only nil) n)
8098 (save-excursion
8099 (goto-char (point-min))
8101 (setq n (/ (1- (length (match-string 0))) 2))
8102 (while (>= (setq n (1- n)) 0)
8103 (org-promote))
8104 (end-of-line 1))))))
8106 (defun org-tr-level (n)
8107 "Make N odd if required."
8108 (if org-odd-levels-only (1+ (/ n 2)) n))
8110 ;;; Vertical tree motion, cutting and pasting of subtrees
8112 (defun org-move-subtree-up (&optional arg)
8113 "Move the current subtree up past ARG headlines of the same level."
8114 (interactive "p")
8115 (org-move-subtree-down (- (prefix-numeric-value arg))))
8117 (defun org-move-subtree-down (&optional arg)
8118 "Move the current subtree down past ARG headlines of the same level."
8119 (interactive "p")
8120 (setq arg (prefix-numeric-value arg))
8121 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8122 'org-get-last-sibling))
8123 (ins-point (make-marker))
8124 (cnt (abs arg))
8125 (col (current-column))
8126 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8127 ;; Select the tree
8128 (org-back-to-heading)
8129 (setq beg0 (point))
8130 (save-excursion
8131 (setq ne-beg (org-back-over-empty-lines))
8132 (setq beg (point)))
8133 (save-match-data
8134 (save-excursion (outline-end-of-heading)
8135 (setq folded (outline-invisible-p)))
8136 (outline-end-of-subtree))
8137 (outline-next-heading)
8138 (setq ne-end (org-back-over-empty-lines))
8139 (setq end (point))
8140 (goto-char beg0)
8141 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8142 ;; include less whitespace
8143 (save-excursion
8144 (goto-char beg)
8145 (forward-line (- ne-beg ne-end))
8146 (setq beg (point))))
8147 ;; Find insertion point, with error handling
8148 (while (> cnt 0)
8149 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8150 (progn (goto-char beg0)
8151 (user-error "Cannot move past superior level or buffer limit")))
8152 (setq cnt (1- cnt)))
8153 (if (> arg 0)
8154 ;; Moving forward - still need to move over subtree
8155 (progn (org-end-of-subtree t t)
8156 (save-excursion
8157 (org-back-over-empty-lines)
8158 (or (bolp) (newline)))))
8159 (setq ne-ins (org-back-over-empty-lines))
8160 (move-marker ins-point (point))
8161 (setq txt (buffer-substring beg end))
8162 (org-save-markers-in-region beg end)
8163 (delete-region beg end)
8164 (org-remove-empty-overlays-at beg)
8165 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8166 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8168 (let ((bbb (point)))
8169 (insert-before-markers txt)
8170 (org-reinstall-markers-in-region bbb)
8171 (move-marker ins-point bbb))
8173 (setq ins-end (point))
8174 (goto-char ins-point)
8175 (org-skip-whitespace)
8176 (when (and (< arg 0)
8177 (org-first-sibling-p)
8178 (> ne-ins ne-beg))
8179 ;; Move whitespace back to beginning
8180 (save-excursion
8181 (goto-char ins-end)
8182 (let ((kill-whole-line t))
8183 (kill-line (- ne-ins ne-beg)) (point)))
8185 (move-marker ins-point nil)
8186 (if folded
8187 (hide-subtree)
8188 (org-show-entry)
8189 (show-children)
8190 (org-cycle-hide-drawers 'children))
8191 (org-clean-visibility-after-subtree-move)
8192 ;; move back to the initial column we were at
8193 (move-to-column col)))
8195 (defvar org-subtree-clip ""
8196 "Clipboard for cut and paste of subtrees.
8197 This is actually only a copy of the kill, because we use the normal kill
8198 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8200 (defvar org-subtree-clip-folded nil
8201 "Was the last copied subtree folded?
8202 This is used to fold the tree back after pasting.")
8204 (defun org-cut-subtree (&optional n)
8205 "Cut the current subtree into the clipboard.
8206 With prefix arg N, cut this many sequential subtrees.
8207 This is a short-hand for marking the subtree and then cutting it."
8208 (interactive "p")
8209 (org-copy-subtree n 'cut))
8211 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8212 "Copy the current subtree it in the clipboard.
8213 With prefix arg N, copy this many sequential subtrees.
8214 This is a short-hand for marking the subtree and then copying it.
8215 If CUT is non-nil, actually cut the subtree.
8216 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8217 of some markers in the region, even if CUT is non-nil. This is
8218 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8219 (interactive "p")
8220 (let (beg end folded (beg0 (point)))
8221 (if (org-called-interactively-p 'any)
8222 (org-back-to-heading nil) ; take what looks like a subtree
8223 (org-back-to-heading t)) ; take what is really there
8224 (setq beg (point))
8226 (save-match-data
8227 (if nosubtrees
8228 (outline-next-heading)
8229 (save-excursion (outline-end-of-heading)
8230 (setq folded (outline-invisible-p)))
8231 (condition-case nil
8232 (org-forward-heading-same-level (1- n) t)
8233 (error nil))
8234 (org-end-of-subtree t t)))
8235 (setq end (point))
8236 (goto-char beg0)
8237 (when (> end beg)
8238 (setq org-subtree-clip-folded folded)
8239 (when (or cut force-store-markers)
8240 (org-save-markers-in-region beg end))
8241 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8242 (setq org-subtree-clip (current-kill 0))
8243 (message "%s: Subtree(s) with %d characters"
8244 (if cut "Cut" "Copied")
8245 (length org-subtree-clip)))))
8247 (defun org-paste-subtree (&optional level tree for-yank)
8248 "Paste the clipboard as a subtree, with modification of headline level.
8249 The entire subtree is promoted or demoted in order to match a new headline
8250 level.
8252 If the cursor is at the beginning of a headline, the same level as
8253 that headline is used to paste the tree.
8255 If not, the new level is derived from the *visible* headings
8256 before and after the insertion point, and taken to be the inferior headline
8257 level of the two. So if the previous visible heading is level 3 and the
8258 next is level 4 (or vice versa), level 4 will be used for insertion.
8259 This makes sure that the subtree remains an independent subtree and does
8260 not swallow low level entries.
8262 You can also force a different level, either by using a numeric prefix
8263 argument, or by inserting the heading marker by hand. For example, if the
8266 If optional TREE is given, use this text instead of the kill ring.
8268 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8269 move back over whitespace before inserting, and move point to the end of
8270 the inserted text when done."
8271 (interactive "P")
8272 (setq tree (or tree (and kill-ring (current-kill 0))))
8273 (unless (org-kill-is-subtree-p tree)
8274 (user-error "%s"
8275 (substitute-command-keys
8277 (org-with-limited-levels
8278 (let* ((visp (not (outline-invisible-p)))
8279 (txt tree)
8281 (old-level (if (string-match org-outline-regexp-bol txt)
8282 (- (match-end 0) (match-beginning 0) 1)
8283 -1))
8284 (force-level (cond (level (prefix-numeric-value level))
8286 (string-match
8288 (point-at-bol) (point))))
8289 (- (match-end 1) (match-beginning 1)))
8290 ((and (bolp)
8291 (looking-at org-outline-regexp))
8292 (- (match-end 0) (point) 1))))
8293 (previous-level (save-excursion
8294 (condition-case nil
8295 (progn
8296 (outline-previous-visible-heading 1)
8297 (if (looking-at ^re_)
8298 (- (match-end 0) (match-beginning 0) 1)
8299 1))
8300 (error 1))))
8301 (next-level (save-excursion
8302 (condition-case nil
8303 (progn
8304 (or (looking-at org-outline-regexp)
8305 (outline-next-visible-heading 1))
8306 (if (looking-at ^re_)
8307 (- (match-end 0) (match-beginning 0) 1)
8308 1))
8309 (error 1))))
8310 (new-level (or force-level (max previous-level next-level)))
8311 (shift (if (or (= old-level -1)
8312 (= new-level -1)
8313 (= old-level new-level))
8314 0
8315 (- new-level old-level)))
8316 (delta (if (> shift 0) -1 1))
8317 (func (if (> shift 0) 'org-demote 'org-promote))
8318 (org-odd-levels-only nil)
8319 beg end newend)
8320 ;; Remove the forced level indicator
8321 (if force-level
8322 (delete-region (point-at-bol) (point)))
8323 ;; Paste
8324 (beginning-of-line (if (bolp) 1 2))
8325 (setq beg (point))
8326 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8327 (insert-before-markers txt)
8329 (setq newend (point))
8330 (org-reinstall-markers-in-region beg)
8331 (setq end (point))
8332 (goto-char beg)
8334 (setq beg (point))
8335 (if (and (outline-invisible-p) visp)
8336 (save-excursion (outline-show-heading)))
8337 ;; Shift if necessary
8338 (unless (= shift 0)
8339 (save-restriction
8340 (narrow-to-region beg end)
8341 (while (not (= shift 0))
8342 (org-map-region func (point-min) (point-max))
8343 (setq shift (+ delta shift)))
8344 (goto-char (point-min))
8345 (setq newend (point-max))))
8346 (when (or (org-called-interactively-p 'interactive) for-yank)
8347 (message "Clipboard pasted as level %d subtree" new-level))
8348 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8349 kill-ring
8350 (eq org-subtree-clip (current-kill 0))
8351 org-subtree-clip-folded)
8352 ;; The tree was folded before it was killed/copied
8353 (hide-subtree))
8354 (and for-yank (goto-char newend)))))
8356 (defun org-kill-is-subtree-p (&optional txt)
8357 "Check if the current kill is an outline subtree, or a set of trees.
8358 Returns nil if kill does not start with a headline, or if the first
8359 headline level is not the largest headline level in the tree.
8360 So this will actually accept several entries of equal levels as well,
8361 which is OK for `org-paste-subtree'.
8362 If optional TXT is given, check this string instead of the current kill."
8363 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8364 (re (org-get-limited-outline-regexp))
8365 (^re (concat "^" re))
8366 (start-level (and kill
8367 (string-match
8369 kill)
8370 (- (match-end 2) (match-beginning 2) 1)))
8371 (start (1+ (or (match-beginning 2) -1))))
8372 (if (not start-level)
8373 (progn
8374 nil) ;; does not even start with a heading
8375 (catch 'exit
8376 (while (setq start (string-match ^re kill (1+ start)))
8377 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8378 (throw 'exit nil)))
8379 t))))
8381 (defvar org-markers-to-move nil
8382 "Markers that should be moved with a cut-and-paste operation.
8383 Those markers are stored together with their positions relative to
8384 the start of the region.")
8386 (defun org-save-markers-in-region (beg end)
8387 "Check markers in region.
8388 If these markers are between BEG and END, record their position relative
8389 to BEG, so that after moving the block of text, we can put the markers back
8390 into place.
8391 This function gets called just before an entry or tree gets cut from the
8392 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8393 called immediately, to move the markers with the entries."
8394 (setq org-markers-to-move nil)
8395 (when (featurep 'org-clock)
8396 (org-clock-save-markers-for-cut-and-paste beg end))
8397 (when (featurep 'org-agenda)
8398 (org-agenda-save-markers-for-cut-and-paste beg end)))
8400 (defun org-check-and-save-marker (marker beg end)
8401 "Check if MARKER is between BEG and END.
8402 If yes, remember the marker and the distance to BEG."
8403 (when (and (marker-buffer marker)
8404 (equal (marker-buffer marker) (current-buffer)))
8405 (if (and (>= marker beg) (< marker end))
8406 (push (cons marker (- marker beg)) org-markers-to-move))))
8408 (defun org-reinstall-markers-in-region (beg)
8409 "Move all remembered markers to their position relative to BEG."
8410 (mapc (lambda (x)
8411 (move-marker (car x) (+ beg (cdr x))))
8412 org-markers-to-move)
8413 (setq org-markers-to-move nil))
8415 (defun org-narrow-to-subtree ()
8416 "Narrow buffer to the current subtree."
8417 (interactive)
8418 (save-excursion
8419 (save-match-data
8420 (org-with-limited-levels
8421 (narrow-to-region
8422 (progn (org-back-to-heading t) (point))
8423 (progn (org-end-of-subtree t t)
8424 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8425 (point)))))))
8427 (defun org-narrow-to-block ()
8428 "Narrow buffer to the current block."
8429 (interactive)
8430 (let* ((case-fold-search t)
8433 (if blockp
8434 (narrow-to-region (car blockp) (cdr blockp))
8435 (user-error "Not in a block"))))
8437 (eval-when-compile
8438 (defvar org-property-drawer-re))
8440 (defvar org-property-start-re) ;; defined below
8441 (defun org-clone-subtree-with-time-shift (n &optional shift)
8442 "Clone the task (subtree) at point N times.
8443 The clones will be inserted as siblings.
8445 In interactive use, the user will be prompted for the number of
8446 clones to be produced. If the entry has a timestamp, the user
8447 will also be prompted for a time shift, which may be a repeater
8448 as used in time stamps, for example `+3d'. To disable this,
8449 you can call the function with a universal prefix argument.
8451 When a valid repeater is given and the entry contains any time
8452 stamps, the clones will become a sequence in time, with time
8453 stamps in the subtree shifted for each clone produced. If SHIFT
8454 is nil or the empty string, time stamps will be left alone. The
8455 ID property of the original subtree is removed.
8457 If the original subtree did contain time stamps with a repeater,
8458 the following will happen:
8459 - the repeater will be removed in each clone
8460 - an additional clone will be produced, with the current, unshifted
8461 date(s) in the entry.
8462 - the original entry will be placed *after* all the clones, with
8463 repeater intact.
8464 - the start days in the repeater in the original entry will be shifted
8465 to past the last clone.
8466 In this way you can spell out a number of instances of a repeating task,
8467 and still retain the repeater to cover future instances of the task."
8468 (interactive "nNumber of clones to produce: ")
8469 (let ((shift
8470 (or shift
8471 (if (and (not (equal current-prefix-arg '(4)))
8472 (save-excursion
8473 (re-search-forward org-ts-regexp-both
8474 (save-excursion
8475 (org-end-of-subtree t)
8476 (point)) t)))
8477 (read-from-minibuffer
8478 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8479 ""))) ;; No time shift
8480 (n-no-remove -1)
8481 (drawer-re org-drawer-regexp)
8482 beg end template task idprop
8483 shift-n shift-what doshift nmin nmax)
8484 (if (not (and (integerp n) (> n 0)))
8485 (error "Invalid number of replications %s" n))
8488 shift)))
8489 (error "Invalid shift specification %s" shift))
8490 (when doshift
8491 (setq shift-n (string-to-number (match-string 1 shift))
8492 shift-what (cdr (assoc (match-string 2 shift)
8493 '(("d" . day) ("w" . week)
8494 ("m" . month) ("y" . year))))))
8495 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8496 (setq nmin 1 nmax n)
8497 (org-back-to-heading t)
8498 (setq beg (point))
8499 (setq idprop (org-entry-get nil "ID"))
8500 (org-end-of-subtree t t)
8502 (setq end (point))
8503 (setq template (buffer-substring beg end))
8504 (when (and doshift
8506 (delete-region beg end)
8507 (setq end beg)
8508 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8509 (goto-char end)
8510 (loop for n from nmin to nmax do
8511 ;; prepare clone
8512 (with-temp-buffer
8513 (insert template)
8514 (org-mode)
8515 (goto-char (point-min))
8516 (org-show-subtree)
8517 (and idprop (if org-clone-delete-id
8518 (org-entry-delete nil "ID")
8519 (org-id-get-create t)))
8520 (unless (= n 0)
8522 (kill-whole-line))
8523 (goto-char (point-min))
8524 (while (re-search-forward drawer-re nil t)
8525 (mapc (lambda (d)
8526 (org-remove-empty-drawer-at d (point))) org-drawers)))
8527 (goto-char (point-min))
8528 (when doshift
8529 (while (re-search-forward org-ts-regexp-both nil t)
8530 (org-timestamp-change (* n shift-n) shift-what))
8531 (unless (= n n-no-remove)
8532 (goto-char (point-min))
8533 (while (re-search-forward org-ts-regexp nil t)
8534 (save-excursion
8535 (goto-char (match-beginning 0))
8537 (delete-region (match-beginning 1) (match-end 1)))))))
8538 (setq task (buffer-string)))
8539 (insert task))
8540 (goto-char beg)))
8542 ;;; Outline Sorting
8544 (defun org-sort (with-case)
8545 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8546 Optional argument WITH-CASE means sort case-sensitively."
8547 (interactive "P")
8548 (cond
8549 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8550 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8551 (t
8552 (org-call-with-arg 'org-sort-entries with-case))))
8554 (defun org-sort-remove-invisible (s)
8555 "Remove invisible links from string S."
8556 (remove-text-properties 0 (length s) org-rm-props s)
8557 (while (string-match org-bracket-link-regexp s)
8558 (setq s (replace-match (if (match-end 2)
8559 (match-string 3 s)
8560 (match-string 1 s)) t t s)))
8561 (let ((st (format " %s " s)))
8562 (while (string-match org-emph-re st)
8563 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8564 (setq s (substring st 1 -1)))
8565 s)
8567 (defvar org-priority-regexp) ; defined later in the file
8569 (defvar org-after-sorting-entries-or-items-hook nil
8570 "Hook that is run after a bunch of entries or items have been sorted.
8571 When children are sorted, the cursor is in the parent line when this
8572 hook gets called. When a region or a plain list is sorted, the cursor
8573 will be in the first entry of the sorted region/list.")
8575 (defun org-sort-entries
8576 (&optional with-case sorting-type getkey-func compare-func property)
8577 "Sort entries on a certain level of an outline tree.
8578 If there is an active region, the entries in the region are sorted.
8579 Else, if the cursor is before the first entry, sort the top-level items.
8580 Else, the children of the entry at point are sorted.
8582 Sorting can be alphabetically, numerically, by date/time as given by
8583 a time stamp, by a property, by priority order, or by a custom function.
8585 The command prompts for the sorting type unless it has been given to the
8586 function through the SORTING-TYPE argument, which needs to be a character,
8587 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8588 precise meaning of each character:
8590 n Numerically, by converting the beginning of the entry/item to a number.
8591 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8592 o By order of TODO keywords.
8593 t By date/time, either the first active time stamp in the entry, or, if
8594 none exist, by the first inactive one.
8595 s By the scheduled date/time.
8596 d By deadline date/time.
8597 c By creation time, which is assumed to be the first inactive time stamp
8598 at the beginning of a line.
8599 p By priority according to the cookie.
8600 r By the value of a property.
8602 Capital letters will reverse the sort order.
8604 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8605 called with point at the beginning of the record. It must return either
8606 a string or a number that should serve as the sorting key for that record.
8608 Comparing entries ignores case by default. However, with an optional argument
8609 WITH-CASE, the sorting considers case as well.
8611 Sorting is done against the visible part of the headlines, it ignores hidden
8612 links."
8613 (interactive "P")
8614 (let ((case-func (if with-case 'identity 'downcase))
8615 (cmstr
8616 ;; The clock marker is lost when using `sort-subr', let's
8617 ;; store the clocking string.
8618 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8619 (save-excursion
8620 (goto-char org-clock-marker)
8621 (looking-back "^.*") (match-string-no-properties 0))))
8622 start beg end stars re re2
8623 txt what tmp)
8624 ;; Find beginning and end of region to sort
8625 (cond
8626 ((org-region-active-p)
8627 ;; we will sort the region
8628 (setq end (region-end)
8629 what "region")
8630 (goto-char (region-beginning))
8631 (if (not (org-at-heading-p)) (outline-next-heading))
8632 (setq start (point)))
8633 ((or (org-at-heading-p)
8634 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8635 ;; we will sort the children of the current headline
8636 (org-back-to-heading)
8637 (setq start (point)
8638 end (progn (org-end-of-subtree t t)
8640 (org-back-over-empty-lines)
8641 (point))
8642 what "children")
8643 (goto-char start)
8644 (show-subtree)
8645 (outline-next-heading))
8646 (t
8647 ;; we will sort the top-level entries in this file
8648 (goto-char (point-min))
8649 (or (org-at-heading-p) (outline-next-heading))
8650 (setq start (point))
8651 (goto-char (point-max))
8652 (beginning-of-line 1)
8654 ;; File ends in a non-white line
8655 (end-of-line 1)
8657 (setq end (point-max))
8658 (setq what "top-level")
8659 (goto-char start)
8660 (show-all)))
8662 (setq beg (point))
8663 (if (>= beg end) (user-error "Nothing to sort"))
8666 (setq stars (match-string 1)
8667 re (concat "^" (regexp-quote stars) " +")
8669 txt (buffer-substring beg end))
8671 (if (and (not (equal stars "*")) (string-match re2 txt))
8672 (user-error "Region to sort contains a level above the first entry"))
8674 (unless sorting-type
8675 (message
8676 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8678 A/N/P/R/O/F/T/S/D/C means reversed:"
8679 what)
8680 (setq sorting-type (read-char-exclusive))
8682 (unless getkey-func
8683 (and (= (downcase sorting-type) ?f)
8684 (setq getkey-func
8685 (org-icompleting-read "Sort using function: "
8686 obarray 'fboundp t nil nil))
8687 (setq getkey-func (intern getkey-func))))
8689 (and (= (downcase sorting-type) ?r)
8690 (not property)
8691 (setq property
8692 (org-icompleting-read "Property: "
8693 (mapcar 'list (org-buffer-property-keys t))
8694 nil t))))
8696 (message "Sorting entries...")
8698 (save-restriction
8699 (narrow-to-region start end)
8700 (let ((dcst (downcase sorting-type))
8701 (case-fold-search nil)
8702 (now (current-time)))
8703 (sort-subr
8704 (/= dcst sorting-type)
8705 ;; This function moves to the beginning character of the "record" to
8706 ;; be sorted.
8707 (lambda nil
8708 (if (re-search-forward re nil t)
8709 (goto-char (match-beginning 0))
8710 (goto-char (point-max))))
8711 ;; This function moves to the last character of the "record" being
8712 ;; sorted.
8713 (lambda nil
8714 (save-match-data
8715 (condition-case nil
8716 (outline-forward-same-level 1)
8717 (error
8718 (goto-char (point-max))))))
8719 ;; This function returns the value that gets sorted against.
8720 (lambda nil
8721 (cond
8722 ((= dcst ?n)
8723 (if (looking-at org-complex-heading-regexp)
8724 (string-to-number (org-sort-remove-invisible (match-string 4)))
8725 nil))
8726 ((= dcst ?a)
8727 (if (looking-at org-complex-heading-regexp)
8728 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8729 nil))
8730 ((= dcst ?t)
8731 (let ((end (save-excursion (outline-next-heading) (point))))
8732 (if (or (re-search-forward org-ts-regexp end t)
8733 (re-search-forward org-ts-regexp-both end t))
8734 (org-time-string-to-seconds (match-string 0))
8735 (org-float-time now))))
8736 ((= dcst ?c)
8737 (let ((end (save-excursion (outline-next-heading) (point))))
8738 (if (re-search-forward
8740 end t)
8741 (org-time-string-to-seconds (match-string 0))
8742 (org-float-time now))))
8743 ((= dcst ?s)
8744 (let ((end (save-excursion (outline-next-heading) (point))))
8745 (if (re-search-forward org-scheduled-time-regexp end t)
8746 (org-time-string-to-seconds (match-string 1))
8747 (org-float-time now))))
8748 ((= dcst ?d)
8749 (let ((end (save-excursion (outline-next-heading) (point))))
8750 (if (re-search-forward org-deadline-time-regexp end t)
8751 (org-time-string-to-seconds (match-string 1))
8752 (org-float-time now))))
8753 ((= dcst ?p)
8754 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8755 (string-to-char (match-string 2))
8756 org-default-priority))
8757 ((= dcst ?r)
8758 (or (org-entry-get nil property) ""))
8759 ((= dcst ?o)
8760 (if (looking-at org-complex-heading-regexp)
8761 (- 9999 (length (member (match-string 2)
8762 org-todo-keywords-1)))))
8763 ((= dcst ?f)
8764 (if getkey-func
8765 (progn
8766 (setq tmp (funcall getkey-func))
8767 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8768 tmp)
8769 (error "Invalid key function `%s'" getkey-func)))
8770 (t (error "Invalid sorting type `%c'" sorting-type))))
8771 nil
8772 (cond
8773 ((= dcst ?a) 'string<)
8774 ((= dcst ?f) compare-func)
8775 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8776 (run-hooks 'org-after-sorting-entries-or-items-hook)
8777 ;; Reset the clock marker if needed
8778 (when cmstr
8779 (save-excursion
8780 (goto-char start)
8781 (search-forward cmstr nil t)
8782 (move-marker org-clock-marker (point))))
8783 (message "Sorting entries...done")))
8785 (defun org-do-sort (table what &optional with-case sorting-type)
8786 "Sort TABLE of WHAT according to SORTING-TYPE.
8787 The user will be prompted for the SORTING-TYPE if the call to this
8788 function does not specify it. WHAT is only for the prompt, to indicate
8789 what is being sorted. The sorting key will be extracted from
8790 the car of the elements of the table.
8791 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8792 (unless sorting-type
8793 (message
8794 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8795 what)
8796 (setq sorting-type (read-char-exclusive)))
8797 (let ((dcst (downcase sorting-type))
8798 extractfun comparefun)
8799 ;; Define the appropriate functions
8800 (cond
8801 ((= dcst ?n)
8802 (setq extractfun 'string-to-number
8803 comparefun (if (= dcst sorting-type) '< '>)))
8804 ((= dcst ?a)
8805 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8806 (lambda(x) (downcase (org-sort-remove-invisible x))))
8807 comparefun (if (= dcst sorting-type)
8808 'string<
8809 (lambda (a b) (and (not (string< a b))
8810 (not (string= a b)))))))
8811 ((= dcst ?t)
8812 (setq extractfun
8813 (lambda (x)
8814 (if (or (string-match org-ts-regexp x)
8815 (string-match org-ts-regexp-both x))
8816 (org-float-time
8817 (org-time-string-to-time (match-string 0 x)))
8818 0))
8819 comparefun (if (= dcst sorting-type) '< '>)))
8820 (t (error "Invalid sorting type `%c'" sorting-type)))
8822 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8823 table)
8824 (lambda (a b) (funcall comparefun (car a) (car b))))))
8827 ;;; The orgstruct minor mode
8829 ;; Define a minor mode which can be used in other modes in order to
8830 ;; integrate the org-mode structure editing commands.
8832 ;; This is really a hack, because the org-mode structure commands use
8833 ;; keys which normally belong to the major mode. Here is how it
8834 ;; works: The minor mode defines all the keys necessary to operate the
8835 ;; structure commands, but wraps the commands into a function which
8836 ;; tests if the cursor is currently at a headline or a plain list
8837 ;; item. If that is the case, the structure command is used,
8838 ;; temporarily setting many Org-mode variables like regular
8839 ;; expressions for filling etc. However, when any of those keys is
8840 ;; used at a different location, function uses `key-binding' to look
8841 ;; up if the key has an associated command in another currently active
8842 ;; keymap (minor modes, major mode, global), and executes that
8843 ;; command. There might be problems if any of the keys is otherwise
8844 ;; used as a prefix key.
8846 (defcustom orgstruct-heading-prefix-regexp nil
8847 "Regexp that matches the custom prefix of Org headlines in
8848 orgstruct(++)-mode."
8849 :group 'org
8850 :version "24.4"
8851 :package-version '(Org . "8.0")
8852 :type 'string)
8853 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8855 (defcustom orgstruct-setup-hook nil
8856 "Hook run after orgstruct-mode-map is filled."
8857 :group 'org
8858 :version "24.4"
8859 :package-version '(Org . "8.0")
8860 :type 'hook)
8862 (defvar orgstruct-initialized nil)
8864 (defvar org-local-vars nil
8865 "List of local variables, for use by `orgstruct-mode'.")
8867 ;;;###autoload
8868 (define-minor-mode orgstruct-mode
8869 "Toggle the minor mode `orgstruct-mode'.
8870 This mode is for using Org-mode structure commands in other
8871 modes. The following keys behave as if Org-mode were active, if
8872 the cursor is on a headline, or on a plain list item (both as
8873 defined by Org-mode)."
8874 nil " OrgStruct" (make-sparse-keymap)
8875 (funcall (if orgstruct-mode
8876 'add-to-invisibility-spec
8877 'remove-from-invisibility-spec)
8878 '(outline . t))
8879 (when orgstruct-mode
8880 (org-load-modules-maybe)
8881 (unless orgstruct-initialized
8882 (orgstruct-setup)
8883 (setq orgstruct-initialized t))))
8885 ;;;###autoload
8886 (defun turn-on-orgstruct ()
8887 "Unconditionally turn on `orgstruct-mode'."
8888 (orgstruct-mode 1))
8890 (defvar org-fb-vars nil)
8891 (make-variable-buffer-local 'org-fb-vars)
8892 (defun orgstruct++-mode (&optional arg)
8893 "Toggle `orgstruct-mode', the enhanced version of it.
8894 In addition to setting orgstruct-mode, this also exports all
8895 indentation and autofilling variables from org-mode into the
8896 buffer. It will also recognize item context in multiline items."
8897 (interactive "P")
8898 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8899 (if (< arg 1)
8900 (progn (orgstruct-mode -1)
8901 (mapc (lambda(v)
8902 (org-set-local (car v)
8903 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8904 org-fb-vars))
8905 (orgstruct-mode 1)
8906 (setq org-fb-vars nil)
8907 (unless org-local-vars
8908 (setq org-local-vars (org-get-local-variables)))
8909 (let (var val)
8910 (mapc
8911 (lambda (x)
8912 (when (string-match
8914 (symbol-name (car x)))
8915 (setq var (car x) val (nth 1 x))
8916 (push (list var `(quote ,(eval var))) org-fb-vars)
8917 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8918 org-local-vars)
8919 (org-set-local 'orgstruct-is-++ t))))
8921 (defvar orgstruct-is-++ nil
8922 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8923 (make-variable-buffer-local 'orgstruct-is-++)
8925 ;;;###autoload
8926 (defun turn-on-orgstruct++ ()
8927 "Unconditionally turn on `orgstruct++-mode'."
8928 (orgstruct++-mode 1))
8930 (defun orgstruct-error ()
8931 "Error when there is no default binding for a structure key."
8932 (interactive)
8933 (funcall (if (fboundp 'user-error)
8934 'user-error
8935 'error)
8936 "This key has no function outside structure elements"))
8938 (defun orgstruct-setup ()
8939 "Setup orgstruct keymap."
8940 (dolist (cell '((org-demote . t)
8941 (org-metaleft . t)
8942 (org-metaright . t)
8943 (org-promote . t)
8944 (org-shiftmetaleft . t)
8945 (org-shiftmetaright . t)
8946 org-backward-element
8947 org-backward-heading-same-level
8948 org-ctrl-c-ret
8949 org-ctrl-c-minus
8950 org-ctrl-c-star
8951 org-cycle
8952 org-forward-heading-same-level
8953 org-insert-heading
8954 org-insert-heading-respect-content
8955 org-kill-note-or-show-branches
8956 org-mark-subtree
8957 org-meta-return
8958 org-metadown
8959 org-metaup
8960 org-narrow-to-subtree
8961 org-promote-subtree
8962 org-reveal
8963 org-shiftdown
8964 org-shiftleft
8965 org-shiftmetadown
8966 org-shiftmetaup
8967 org-shiftright
8968 org-shifttab
8969 org-shifttab
8970 org-shiftup
8971 org-show-subtree
8972 org-sort
8973 org-up-element
8974 outline-demote
8975 outline-next-visible-heading
8976 outline-previous-visible-heading
8977 outline-promote
8978 outline-up-heading
8979 show-children))
8980 (let ((f (or (car-safe cell) cell))
8981 (disable-when-heading-prefix (cdr-safe cell)))
8982 (when (fboundp f)
8983 (let ((new-bindings))
8984 (dolist (binding (nconc (where-is-internal f org-mode-map)
8985 (where-is-internal f outline-mode-map)))
8986 (push binding new-bindings)
8987 ;; TODO use local-function-key-map
8988 (dolist (rep '(("<tab>" . "TAB")
8989 ("<return>" . "RET")
8990 ("<escape>" . "ESC")
8991 ("<delete>" . "DEL")))
8992 (setq binding (read-kbd-macro
8993 (let ((case-fold-search))
8994 (replace-regexp-in-string
8995 (regexp-quote (cdr rep))
8996 (car rep)
8997 (key-description binding)))))
8998 (pushnew binding new-bindings :test 'equal)))
8999 (dolist (binding new-bindings)
9000 (let ((key (lookup-key orgstruct-mode-map binding)))
9001 (when (or (not key) (numberp key))
9002 (condition-case nil
9003 (org-defkey orgstruct-mode-map
9004 binding
9005 (orgstruct-make-binding f binding disable-when-heading-prefix))
9006 (error nil)))))))))
9007 (run-hooks 'orgstruct-setup-hook))
9009 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9010 "Create a function for binding in the structure minor mode.
9011 FUN is the command to call inside a table. KEY is the key that
9012 should be checked in for a command to execute outside of tables.
9013 Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
9014 if `orgstruct-heading-prefix-regexp' is non-nil."
9015 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9016 (let ((nname name)
9017 (i 0))
9018 (while (fboundp (intern nname))
9019 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9020 (setq name (intern nname)))
9021 (eval
9022 (let ((bindings '((org-heading-regexp
9023 (concat "^"
9024 orgstruct-heading-prefix-regexp
9026 (org-outline-regexp
9028 (org-outline-regexp-bol
9029 (concat "^" org-outline-regexp))
9030 (outline-regexp org-outline-regexp)
9032 (outline-level 'org-outline-level)
9033 (outline-heading-alist))))
9034 `(defun ,name (arg)
9036 "Outside of structure, run the binding of `"
9037 (key-description key) "'."
9038 (when disable-when-heading-prefix
9039 (concat
9042 "`" (symbol-name fun) "'.")))
9043 (interactive "p")
9044 (let* ((disable
9045 ,(when disable-when-heading-prefix
9046 '(and orgstruct-heading-prefix-regexp
9047 (not (string= orgstruct-heading-prefix-regexp "")))))
9048 (fallback
9049 (or disable
9050 (not
9051 (let* ,bindings
9052 (org-context-p 'headline 'item
9053 ,(when (memq fun
9054 '(org-insert-heading
9055 org-insert-heading-respect-content
9056 org-meta-return))
9057 '(when orgstruct-is-++
9058 'item-body))))))))
9059 (if fallback
9060 (let* ((orgstruct-mode)
9061 (binding
9062 (loop with key = ,key
9063 for rep in
9064 '(nil
9069 do
9070 (when rep
9071 (setq key (read-kbd-macro
9072 (let ((case-fold-search))
9073 (replace-regexp-in-string
9074 (car rep)
9075 (cdr rep)
9076 (key-description key))))))
9077 thereis (key-binding key))))
9078 (if (keymapp binding)
9079 (set-temporary-overlay-map binding)
9080 (let ((func (or binding
9081 (unless disable
9082 'orgstruct-error))))
9083 (when func
9084 (call-interactively func)))))
9085 (org-run-like-in-org-mode
9086 (lambda ()
9087 (interactive)
9088 (let* ,bindings
9089 (call-interactively ',fun)))))))))
9090 name))
9092 (defun org-contextualize-keys (alist contexts)
9093 "Return valid elements in ALIST depending on CONTEXTS.
9095 `org-agenda-custom-commands' or `org-capture-templates' are the
9096 values used for ALIST, and `org-agenda-custom-commands-contexts'
9097 or `org-capture-templates-contexts' are the associated contexts
9098 definitions."
9099 (let ((contexts
9100 ;; normalize contexts
9101 (mapcar
9102 (lambda(c) (cond ((listp (cadr c))
9103 (list (car c) (car c) (cadr c)))
9104 ((string= "" (cadr c))
9105 (list (car c) (car c) (caddr c)))
9106 (t c))) contexts))
9107 (a alist) c r s)
9108 ;; loop over all commands or templates
9109 (while (setq c (pop a))
9110 (let (vrules repl)
9111 (cond
9112 ((not (assoc (car c) contexts))
9113 (push c r))
9114 ((and (assoc (car c) contexts)
9115 (setq vrules (org-contextualize-validate-key
9116 (car c) contexts)))
9117 (mapc (lambda (vr)
9118 (when (not (equal (car vr) (cadr vr)))
9119 (setq repl vr))) vrules)
9120 (if (not repl) (push c r)
9121 (push (cadr repl) s)
9122 (push
9123 (cons (car c)
9124 (cdr (or (assoc (cadr repl) alist)
9125 (error "Undefined key `%s' as contextual replacement for `%s'"
9126 (cadr repl) (car c)))))
9127 r))))))
9128 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9129 (delq
9130 nil
9131 (delete-dups
9132 (mapcar (lambda (x)
9133 (let ((tpl (car x)))
9134 (when (not (delq
9135 nil
9136 (mapcar (lambda(y)
9137 (equal y tpl)) s))) x)))
9138 (reverse r))))))
9140 (defun org-contextualize-validate-key (key contexts)
9141 "Check CONTEXTS for agenda or capture KEY."
9142 (let (r rr res)
9143 (while (setq r (pop contexts))
9144 (mapc
9145 (lambda (rr)
9146 (when
9147 (and (equal key (car r))
9148 (if (functionp rr) (funcall rr)
9149 (or (and (eq (car rr) 'in-file)
9150 (buffer-file-name)
9151 (string-match (cdr rr) (buffer-file-name)))
9152 (and (eq (car rr) 'in-mode)
9153 (string-match (cdr rr) (symbol-name major-mode)))
9154 (and (eq (car rr) 'in-buffer)
9155 (string-match (cdr rr) (buffer-name)))
9156 (when (and (eq (car rr) 'not-in-file)
9157 (buffer-file-name))
9158 (not (string-match (cdr rr) (buffer-file-name))))
9159 (when (eq (car rr) 'not-in-mode)
9160 (not (string-match (cdr rr) (symbol-name major-mode))))
9161 (when (eq (car rr) 'not-in-buffer)
9162 (not (string-match (cdr rr) (buffer-name)))))))
9163 (push r res)))
9164 (car (last r))))
9165 (delete-dups (delq nil res))))
9167 (defun org-context-p (&rest contexts)
9168 "Check if local context is any of CONTEXTS.
9169 Possible values in the list of contexts are `table', `headline', and `item'."
9170 (let ((pos (point)))
9171 (goto-char (point-at-bol))
9172 (prog1 (or (and (memq 'table contexts)
9174 (and (memq 'headline contexts)
9175 (looking-at org-outline-regexp))
9176 (and (memq 'item contexts)
9178 (and (memq 'item-body contexts)
9179 (org-in-item-p)))
9180 (goto-char pos))))
9182 (defun org-get-local-variables ()
9183 "Return a list of all local variables in an Org mode buffer."
9184 (let (varlist)
9185 (with-current-buffer (get-buffer-create "*Org tmp*")
9186 (erase-buffer)
9187 (org-mode)
9188 (setq varlist (buffer-local-variables)))
9189 (kill-buffer "*Org tmp*")
9190 (delq nil
9191 (mapcar
9192 (lambda (x)
9193 (setq x
9194 (if (symbolp x)
9195 (list x)
9196 (list (car x) (cdr x))))
9197 (if (and (not (get (car x) 'org-state))
9198 (string-match
9199 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9200 (symbol-name (car x))))
9201 x nil))
9202 varlist))))
9204 (defun org-clone-local-variables (from-buffer &optional regexp)
9205 "Clone local variables from FROM-BUFFER.
9206 Optional argument REGEXP selects variables to clone."
9207 (mapc
9208 (lambda (pair)
9209 (and (symbolp (car pair))
9210 (or (null regexp)
9211 (string-match regexp (symbol-name (car pair))))
9212 (set (make-local-variable (car pair))
9213 (cdr pair))))
9214 (buffer-local-variables from-buffer)))
9216 ;;;###autoload
9217 (defun org-run-like-in-org-mode (cmd)
9218 "Run a command, pretending that the current buffer is in Org-mode.
9219 This will temporarily bind local variables that are typically bound in
9220 Org-mode to the values they have in Org-mode, and then interactively
9221 call CMD."
9222 (org-load-modules-maybe)
9223 (unless org-local-vars
9224 (setq org-local-vars (org-get-local-variables)))
9225 (let (binds)
9226 (dolist (var org-local-vars)
9227 (when (or (not (boundp (car var)))
9228 (eq (symbol-value (car var))
9229 (default-value (car var))))
9230 (push (list (car var) `(quote ,(cadr var))) binds)))
9231 (eval `(let ,binds
9232 (call-interactively (quote ,cmd))))))
9234 ;;;; Archiving
9236 (defun org-get-category (&optional pos force-refresh)
9237 "Get the category applying to position POS."
9238 (save-match-data
9239 (if force-refresh (org-refresh-category-properties))
9240 (let ((pos (or pos (point))))
9241 (or (get-text-property pos 'org-category)
9242 (progn (org-refresh-category-properties)
9243 (get-text-property pos 'org-category))))))
9245 (defun org-refresh-category-properties ()
9246 "Refresh category text properties in the buffer."
9247 (let ((case-fold-search t)
9248 (inhibit-read-only t)
9249 (def-cat (cond
9250 ((null org-category)
9251 (if buffer-file-name
9252 (file-name-sans-extension
9253 (file-name-nondirectory buffer-file-name))
9254 "???"))
9255 ((symbolp org-category) (symbol-name org-category))
9256 (t org-category)))
9257 beg end cat pos optionp)
9258 (org-with-silent-modifications
9259 (save-excursion
9260 (save-restriction
9261 (widen)
9262 (goto-char (point-min))
9263 (put-text-property (point) (point-max) 'org-category def-cat)
9264 (while (re-search-forward
9266 (setq pos (match-end 0)
9267 optionp (equal (char-after (match-beginning 0)) ?#)
9268 cat (org-trim (match-string 2)))
9269 (if optionp
9270 (setq beg (point-at-bol) end (point-max))
9271 (org-back-to-heading t)
9272 (setq beg (point) end (org-end-of-subtree t t)))
9273 (put-text-property beg end 'org-category cat)
9274 (put-text-property beg end 'org-category-position beg)
9275 (goto-char pos)))))))
9277 (defun org-refresh-properties (dprop tprop)
9278 "Refresh buffer text properties.
9279 DPROP is the drawer property and TPROP is the corresponding text
9280 property to set."
9281 (let ((case-fold-search t)
9282 (inhibit-read-only t) p)
9283 (org-with-silent-modifications
9284 (save-excursion
9285 (save-restriction
9286 (widen)
9287 (goto-char (point-min))
9289 (setq p (org-match-string-no-properties 1))
9290 (save-excursion
9291 (org-back-to-heading t)
9292 (put-text-property
9293 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9296 ;;;; Link Stuff
9298 ;;; Link abbreviations
9300 (defun org-link-expand-abbrev (link)
9301 "Apply replacements as defined in `org-link-abbrev-alist'."
9303 (let* ((key (match-string 1 link))
9304 (as (or (assoc key org-link-abbrev-alist-local)
9305 (assoc key org-link-abbrev-alist)))
9306 (tag (and (match-end 2) (match-string 3 link)))
9307 rpl)
9308 (if (not as)
9309 link
9310 (setq rpl (cdr as))
9311 (cond
9312 ((symbolp rpl) (funcall rpl tag))
9314 (replace-match
9315 (save-match-data
9316 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9317 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9318 ((string-match "%h" rpl)
9319 (replace-match (url-hexify-string (or tag "")) t t rpl))
9320 (t (concat rpl tag)))))
9321 link))
9323 ;;; Storing and inserting links
9325 (defvar org-insert-link-history nil
9326 "Minibuffer history for links inserted with `org-insert-link'.")
9328 (defvar org-stored-links nil
9329 "Contains the links stored with `org-store-link'.")
9331 (defvar org-store-link-plist nil
9332 "Plist with info about the most recently link created with `org-store-link'.")
9334 (defvar org-link-protocols nil
9335 "Link protocols added to Org-mode using `org-add-link-type'.")
9337 (defvar org-store-link-functions nil
9338 "List of functions that are called to create and store a link.
9339 Each function will be called in turn until one returns a non-nil
9340 value. Each function should check if it is responsible for creating
9341 this link (for example by looking at the major mode).
9342 If not, it must exit and return nil.
9343 If yes, it should return a non-nil value after a calling
9344 `org-store-link-props' with a list of properties and values.
9345 Special properties are:
9349 This is obligatory as well.
9350 :description Optional default description for the second pair
9351 of brackets in an Org-mode link. The user can still change
9352 this when inserting this link into an Org-mode buffer.
9354 In addition to these, any additional properties can be specified
9355 and then used in capture templates.")
9357 (defun org-add-link-type (type &optional follow export)
9358 "Add TYPE to the list of `org-link-types'.
9359 Re-compute all regular expressions depending on `org-link-types'
9361 FOLLOW and EXPORT are two functions.
9363 FOLLOW should take the link path as the single argument and do whatever
9364 is necessary to follow the link, for example find a file or display
9365 a mail message.
9367 EXPORT should format the link path for export to one of the export formats.
9368 It should be a function accepting three arguments:
9371 desc the description of the link, if any, or a description added by
9372 org-export-normalize-links if there is none
9373 format the export format, a symbol like `html' or `latex' or `ascii'..
9375 The function may use the FORMAT information to return different values
9376 depending on the format. The return value will be put literally into
9377 the exported file. If the return value is nil, this means Org should
9378 do what it normally does with links which do not have EXPORT defined.
9380 Org-mode has a built-in default for exporting links. If you are happy with
9381 this default, there is no need to define an export function for the link
9382 type. For a simple example of an export function, see `org-bbdb.el'."
9383 (add-to-list 'org-link-types type t)
9384 (org-make-link-regexps)
9385 (if (assoc type org-link-protocols)
9386 (setcdr (assoc type org-link-protocols) (list follow export))
9387 (push (list type follow export) org-link-protocols)))
9389 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9390 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9392 ;;;###autoload
9393 (defun org-store-link (arg)
9395 This link is added to `org-stored-links' and can later be inserted
9398 For some link types, a prefix arg is interpreted.
9399 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9400 For file links, arg negates `org-context-in-file-links'.
9402 A double prefix arg force skipping storing functions that are not
9403 part of Org's core.
9405 A triple prefix arg force storing a link for each line in the
9406 active region."
9407 (interactive "P")
9408 (org-load-modules-maybe)
9409 (if (and (equal arg '(64)) (org-region-active-p))
9410 (save-excursion
9411 (let ((end (region-end)))
9412 (goto-char (region-beginning))
9413 (set-mark (point))
9414 (while (< (point-at-eol) end)
9415 (move-end-of-line 1) (activate-mark)
9416 (let (current-prefix-arg)
9417 (call-interactively 'org-store-link))
9418 (move-beginning-of-line 2)
9419 (set-mark (point)))))
9420 (org-with-limited-levels
9421 (setq org-store-link-plist nil)
9422 (let (link cpltxt desc description search
9423 txt custom-id agenda-link sfuns sfunsn)
9424 (cond
9426 ;; Store a link using an external link type
9427 ((and (not (equal arg '(16)))
9428 (setq sfuns
9429 (delq
9430 nil (mapcar (lambda (f)
9431 (let (fs) (if (funcall f) (push f fs))))
9432 org-store-link-functions))
9433 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9434 (or (and (cdr sfuns)
9435 (funcall (intern
9436 (completing-read
9437 "Which function for creating the link? "
9438 sfunsn t (car sfunsn)))))
9439 (funcall (caar sfuns)))
9440 (setq link (plist-get org-store-link-plist :link)
9441 desc (or (plist-get org-store-link-plist
9442 :description) link))))
9444 ;; Store a link from a source code buffer
9445 ((org-src-edit-buffer-p)
9446 (let (label gc)
9447 (while (or (not label)
9448 (save-excursion
9449 (save-restriction
9450 (widen)
9451 (goto-char (point-min))
9452 (re-search-forward
9453 (regexp-quote (format org-coderef-label-format label))
9454 nil t))))
9455 (when label (message "Label exists already") (sit-for 2))
9456 (setq label (read-string "Code line label: " label)))
9457 (end-of-line 1)
9458 (setq link (format org-coderef-label-format label))
9459 (setq gc (- 79 (length link)))
9460 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9461 (insert link)
9462 (setq link (concat "(" label ")") desc nil)))
9464 ;; We are in the agenda, link to referenced location
9465 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9466 (let ((m (or (get-text-property (point) 'org-hd-marker)
9467 (get-text-property (point) 'org-marker))))
9468 (when m
9469 (org-with-point-at m
9470 (setq agenda-link
9471 (if (org-called-interactively-p 'any)
9472 (call-interactively 'org-store-link)
9473 (org-store-link nil)))))))
9475 ((eq major-mode 'calendar-mode)
9476 (let ((cd (calendar-cursor-to-date)))
9477 (setq link
9478 (format-time-string
9479 (car org-time-stamp-formats)
9480 (apply 'encode-time
9481 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9482 nil nil nil))))
9483 (org-store-link-props :type "calendar" :date cd)))
9485 ((eq major-mode 'help-mode)
9486 (setq link (concat "help:" (save-excursion
9487 (goto-char (point-min))
9488 (looking-at "^[^ ]+")
9489 (match-string 0))))
9490 (org-store-link-props :type "help"))
9492 ((eq major-mode 'w3-mode)
9493 (setq cpltxt (if (and (buffer-name)
9494 (not (string-match "Untitled" (buffer-name))))
9495 (buffer-name)
9496 (url-view-url t))
9497 link (url-view-url t))
9498 (org-store-link-props :type "w3" :url (url-view-url t)))
9500 ((eq major-mode 'image-mode)
9501 (setq cpltxt (concat "file:"
9502 (abbreviate-file-name buffer-file-name))
9503 link cpltxt)
9504 (org-store-link-props :type "image" :file buffer-file-name))
9506 ;; In dired, store a link to the file of the current line
9507 ((eq major-mode 'dired-mode)
9508 (let ((file (dired-get-filename nil t)))
9509 (setq file (if file
9510 (abbreviate-file-name
9511 (expand-file-name (dired-get-filename nil t)))
9512 ;; otherwise, no file so use current directory.
9513 default-directory))
9514 (setq cpltxt (concat "file:" file)
9515 link cpltxt)))
9517 ((setq search (run-hook-with-args-until-success
9518 'org-create-file-search-functions))
9519 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9520 "::" search))
9521 (setq cpltxt (or description link)))
9523 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9524 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9525 (cond
9526 ;; Store a link using the target at point
9528 (setq cpltxt
9529 (concat "file:"
9530 (abbreviate-file-name
9531 (buffer-file-name (buffer-base-buffer)))
9532 "::" (match-string 1))
9533 link cpltxt))
9534 ((and (featurep 'org-id)
9535 (or (eq org-id-link-to-org-use-id t)
9536 (and (org-called-interactively-p 'any)
9537 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9538 (and (eq org-id-link-to-org-use-id
9539 'create-if-interactive-and-no-custom-id)
9540 (not custom-id))))
9541 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9542 ;; Store a link using the ID at point
9543 (setq link (condition-case nil
9544 (prog1 (org-id-store-link)
9545 (setq desc (plist-get org-store-link-plist
9546 :description)))
9547 (error
9548 ;; Probably before first headline, link only to file
9549 (concat "file:"
9550 (abbreviate-file-name
9551 (buffer-file-name (buffer-base-buffer))))))))
9552 (t
9553 ;; Just link to current headline
9554 (setq cpltxt (concat "file:"
9555 (abbreviate-file-name
9556 (buffer-file-name (buffer-base-buffer)))))
9557 ;; Add a context search string
9558 (when (org-xor org-context-in-file-links arg)
9559 (let* ((ee (org-element-at-point))
9560 (et (org-element-type ee))
9561 (ev (plist-get (cadr ee) :value))
9562 (ek (plist-get (cadr ee) :key))
9563 (eok (and (stringp ek) (string-match "name" ek))))
9564 (setq txt (cond
9565 ((org-at-heading-p) nil)
9566 ((and (eq et 'keyword) eok) ev)
9567 ((org-region-active-p)
9568 (buffer-substring (region-beginning) (region-end)))))
9570 (setq cpltxt
9571 (concat cpltxt "::"
9572 (condition-case nil
9573 (org-make-org-heading-search-string txt)
9574 (error "")))
9575 desc (or (and (eq et 'keyword) eok ev)
9576 (nth 4 (ignore-errors (org-heading-components)))
9577 "NONE")))))
9579 (setq cpltxt (substring cpltxt 0 -2)))
9580 (setq link cpltxt))))
9582 ((buffer-file-name (buffer-base-buffer))
9583 ;; Just link to this file here.
9584 (setq cpltxt (concat "file:"
9585 (abbreviate-file-name
9586 (buffer-file-name (buffer-base-buffer)))))
9587 ;; Add a context string.
9588 (when (org-xor org-context-in-file-links arg)
9589 (setq txt (if (org-region-active-p)
9590 (buffer-substring (region-beginning) (region-end))
9591 (buffer-substring (point-at-bol) (point-at-eol))))
9592 ;; Only use search option if there is some text.
9594 (setq cpltxt
9595 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9596 desc "NONE")))
9597 (setq link cpltxt))
9599 ((org-called-interactively-p 'interactive)
9600 (user-error "No method for storing a link from this buffer"))
9602 (t (setq link nil)))
9604 ;; We're done setting link and desc, clean up
9605 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9606 (setq link (or link cpltxt)
9607 desc (or desc cpltxt))
9608 (cond ((equal desc "NONE") (setq desc nil))
9609 ((string-match org-bracket-link-analytic-regexp desc)
9610 (let ((d0 (match-string 3 desc))
9611 (p0 (match-string 5 desc)))
9612 (setq desc
9613 (replace-regexp-in-string
9614 org-bracket-link-regexp
9615 (concat (or p0 d0)
9616 (if (equal (length (match-string 0 desc))
9617 (length desc)) "*" "")) desc)))))
9619 ;; Return the link
9620 (if (not (and (or (org-called-interactively-p 'any)
9621 executing-kbd-macro) link))
9622 (or agenda-link (and link (org-make-link-string link desc)))
9623 (push (list link desc) org-stored-links)
9624 (message "Stored: %s" (or desc link))
9625 (when custom-id
9626 (setq link (concat "file:" (abbreviate-file-name
9627 (buffer-file-name)) "::#" custom-id))
9628 (push (list link desc) org-stored-links)))))))
9630 (defun org-store-link-props (&rest plist)
9631 "Store link properties, extract names and addresses."
9632 (let (x adr)
9633 (when (setq x (plist-get plist :from))
9634 (setq adr (mail-extract-address-components x))
9635 (setq plist (plist-put plist :fromname (car adr)))
9636 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9637 (when (setq x (plist-get plist :to))
9638 (setq adr (mail-extract-address-components x))
9639 (setq plist (plist-put plist :toname (car adr)))
9640 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9641 (let ((from (plist-get plist :from))
9642 (to (plist-get plist :to)))
9643 (when (and from to org-from-is-user-regexp)
9644 (setq plist
9645 (plist-put plist :fromto
9646 (if (string-match org-from-is-user-regexp from)
9647 (concat "to %t")
9648 (concat "from %f"))))))
9649 (setq org-store-link-plist plist))
9651 (defun org-add-link-props (&rest plist)
9652 "Add these properties to the link property list."
9653 (let (key value)
9654 (while plist
9655 (setq key (pop plist) value (pop plist))
9656 (setq org-store-link-plist
9657 (plist-put org-store-link-plist key value)))))
9659 (defun org-email-link-description (&optional fmt)
9660 "Return the description part of an email link.
9661 This takes information from `org-store-link-plist' and formats it
9662 according to FMT (default from `org-email-link-description-format')."
9663 (setq fmt (or fmt org-email-link-description-format))
9664 (let* ((p org-store-link-plist)
9665 (to (plist-get p :toaddress))
9666 (from (plist-get p :fromaddress))
9667 (table
9668 (list
9669 (cons "%c" (plist-get p :fromto))
9670 (cons "%F" (plist-get p :from))
9671 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9672 (cons "%T" (plist-get p :to))
9673 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9674 (cons "%s" (plist-get p :subject))
9675 (cons "%d" (plist-get p :date))
9676 (cons "%m" (plist-get p :message-id)))))
9677 (when (string-match "%c" fmt)
9678 ;; Check if the user wrote this message
9679 (if (and org-from-is-user-regexp from to
9680 (save-match-data (string-match org-from-is-user-regexp from)))
9681 (setq fmt (replace-match "to %t" t t fmt))
9682 (setq fmt (replace-match "from %f" t t fmt))))
9683 (org-replace-escapes fmt table)))
9685 (defun org-make-org-heading-search-string (&optional string)
9686 "Make search string for the current headline or STRING."
9687 (let ((s (or string
9688 (and (derived-mode-p 'org-mode)
9689 (save-excursion
9690 (org-back-to-heading t)
9691 (org-element-property :raw-value (org-element-at-point))))))
9692 (lines org-context-in-file-links))
9693 (or string (setq s (concat "*" s))) ; Add * for headlines
9695 (when (and string (integerp lines) (> lines 0))
9697 (when (< lines (length slines))
9698 (setq s (mapconcat
9699 'identity
9700 (reverse (nthcdr (- (length slines) lines)
9704 (defun org-make-link-string (link &optional description)
9705 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9707 (error "Empty link"))
9708 (when (and description
9709 (stringp description)
9711 (setq description nil))
9712 (when (stringp description)
9713 ;; Remove brackets from the description, they are fatal.
9715 (setq description (replace-match "{" t t description)))
9717 (setq description (replace-match "}" t t description))))
9718 (when (equal link description)
9719 ;; No description needed, it is identical
9720 (setq description nil))
9721 (when (and (not description)
9722 (not (string-match (org-image-file-name-regexp) link))
9723 (not (equal link (org-link-escape link))))
9724 (setq description (org-extract-attributes link)))
9725 (setq link
9726 (cond ((string-match (org-image-file-name-regexp) link) link)
9727 ((string-match org-link-types-re link)
9728 (concat (match-string 1 link)
9729 (org-link-escape (substring link (match-end 1)))))
9730 (t (org-link-escape link))))
9731 (concat "[[" link "]"
9732 (if description (concat "[" description "]") "")
9733 "]"))
9735 (defconst org-link-escape-chars
9736 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9737 "List of characters that should be escaped in link.
9738 This is the list that is used for internal purposes.")
9740 (defconst org-link-escape-chars-browser
9742 "List of escapes for characters that are problematic in links.
9743 This is the list that is used before handing over to the browser.")
9745 (defun org-link-escape (text &optional table merge)
9746 "Return percent escaped representation of TEXT.
9747 TEXT is a string with the text to escape.
9748 Optional argument TABLE is a list with characters that should be
9749 escaped. When nil, `org-link-escape-chars' is used.
9750 If optional argument MERGE is set, merge TABLE into
9751 `org-link-escape-chars'."
9752 (cond
9753 ((and table merge)
9754 (mapc (lambda (defchr)
9755 (unless (member defchr table)
9756 (setq table (cons defchr table)))) org-link-escape-chars))
9757 ((null table)
9758 (setq table org-link-escape-chars)))
9759 (mapconcat
9760 (lambda (char)
9761 (if (or (member char table)
9762 (and (or (< char 32) (= char 37) (> char 126))
9763 org-url-hexify-p))
9764 (mapconcat (lambda (sequence-element)
9765 (format "%%%.2X" sequence-element))
9766 (or (encode-coding-char char 'utf-8)
9767 (error "Unable to percent escape character: %s"
9768 (char-to-string char))) "")
9769 (char-to-string char))) text ""))
9771 (defun org-link-unescape (str)
9772 "Unhex hexified Unicode strings as returned from the JavaScript function
9773 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9774 (unless (and (null str) (string= "" str))
9775 (let ((pos 0) (case-fold-search t) unhexed)
9777 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9778 (setq str (replace-match unhexed t t str))
9779 (setq pos (+ pos (length unhexed))))))
9780 str)
9782 (defun org-link-unescape-compound (hex)
9783 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9784 Note: this function also decodes single byte encodings like
9785 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9786 (save-match-data
9787 (let* ((bytes (cdr (split-string hex "%")))
9788 (ret "")
9789 (eat 0)
9790 (sum 0))
9791 (while bytes
9792 (let* ((val (string-to-number (pop bytes) 16))
9793 (shift-xor
9794 (if (= 0 eat)
9795 (cond
9796 ((>= val 252) (cons 6 252))
9797 ((>= val 248) (cons 5 248))
9798 ((>= val 240) (cons 4 240))
9799 ((>= val 224) (cons 3 224))
9800 ((>= val 192) (cons 2 192))
9801 (t (cons 0 0)))
9802 (cons 6 128))))
9803 (if (>= val 192) (setq eat (car shift-xor)))
9804 (setq val (logxor val (cdr shift-xor)))
9805 (setq sum (+ (lsh sum (car shift-xor)) val))
9806 (if (> eat 0) (setq eat (- eat 1)))
9807 (cond
9808 ((= 0 eat) ;multi byte
9809 (setq ret (concat ret (org-char-to-string sum)))
9810 (setq sum 0))
9811 ((not bytes) ; single byte(s)
9812 (setq ret (org-link-unescape-single-byte-sequence hex))))
9813 )) ;; end (while bytes
9814 ret )))
9816 (defun org-link-unescape-single-byte-sequence (hex)
9817 "Unhexify hex-encoded single byte character sequences."
9818 (mapconcat (lambda (byte)
9819 (char-to-string (string-to-number byte 16)))
9820 (cdr (split-string hex "%")) ""))
9822 (defun org-xor (a b)
9823 "Exclusive or."
9824 (if a (not b) b))
9826 (defun org-fixup-message-id-for-http (s)
9827 "Replace special characters in a message id, so it can be used in an http query."
9828 (when (string-match "%" s)
9829 (setq s (mapconcat (lambda (c)
9830 (if (eq c ?%)
9831 "%25"
9832 (char-to-string c)))
9833 s "")))
9834 (while (string-match "<" s)
9835 (setq s (replace-match "%3C" t t s)))
9836 (while (string-match ">" s)
9837 (setq s (replace-match "%3E" t t s)))
9838 (while (string-match "@" s)
9839 (setq s (replace-match "%40" t t s)))
9840 s)
9842 (defun org-link-prettify (link)
9843 "Return a human-readable representation of LINK.
9844 The car of LINK must be a raw link the cdr of LINK must be either
9845 a link description or nil."
9846 (let ((desc (or (cadr link) "<no description>")))
9847 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9848 "<" (car link) ">")))
9850 ;;;###autoload
9851 (defun org-insert-link-global ()
9852 "Insert a link like Org-mode does.
9853 This command can be called in any mode to insert a link in Org-mode syntax."
9854 (interactive)
9855 (org-load-modules-maybe)
9856 (org-run-like-in-org-mode 'org-insert-link))
9858 (defun org-insert-all-links (&optional keep)
9859 "Insert all links in `org-stored-links'."
9860 (interactive "P")
9861 (let ((links (copy-sequence org-stored-links)) l)
9862 (while (setq l (if keep (pop links) (pop org-stored-links)))
9863 (insert "- ")
9864 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9867 (defun org-link-fontify-links-to-this-file ()
9868 "Fontify links to the current file in `org-stored-links'."
9869 (let ((f (buffer-file-name)) a b)
9870 (setq a (mapcar (lambda(l)
9871 (let ((ll (car l)))
9873 (equal f (expand-file-name (match-string 1 ll))))
9874 ll)))
9875 org-stored-links))
9876 (when (featurep 'org-id)
9877 (setq b (mapcar (lambda(l)
9878 (let ((ll (car l)))
9880 (equal f (expand-file-name
9881 (or (org-id-find-id-file
9882 (match-string 1 ll)) ""))))
9883 ll)))
9884 org-stored-links)))
9885 (mapcar (lambda(l)
9886 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9887 (delq nil (append a b)))))
9889 (defvar org-link-links-in-this-file nil)
9890 (defun org-insert-link (&optional complete-file link-location default-description)
9891 "Insert a link. At the prompt, enter the link.
9893 Completion can be used to insert any of the link protocol prefixes like
9894 http or ftp in use.
9896 The history can be used to select a link previously stored with
9897 `org-store-link'. When the empty string is entered (i.e. if you just
9898 press RET at the prompt), the link defaults to the most recently
9899 stored link. As SPC triggers completion in the minibuffer, you need to
9900 use M-SPC or C-q SPC to force the insertion of a space character.
9902 You will also be prompted for a description, and if one is given, it will
9903 be displayed in the buffer instead of the link.
9905 If there is already a link at point, this command will allow you to edit link
9906 and description parts.
9909 be selected using completion. The path to the file will be relative to the
9910 current directory if the file is in the current directory or a subdirectory.
9911 Otherwise, the link will be the absolute path as completed in the minibuffer
9912 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9913 option `org-link-file-path-type'.
9916 the current directory or below.
9919 `org-keep-stored-link-after-insertion'.
9921 If `org-make-link-description-function' is non-nil, this function will be
9922 called with the link target, and the result will be the default
9923 link description.
9925 If the LINK-LOCATION parameter is non-nil, this value will be
9926 used as the link location instead of reading one interactively.
9928 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9929 be used as the default description."
9930 (interactive "P")
9931 (let* ((wcf (current-window-configuration))
9932 (origbuf (current-buffer))
9933 (region (if (org-region-active-p)
9934 (buffer-substring (region-beginning) (region-end))))
9935 (remove (and region (list (region-beginning) (region-end))))
9936 (desc region)
9937 tmphist ; byte-compile incorrectly complains about this
9938 (link link-location)
9939 (abbrevs org-link-abbrev-alist-local)
9940 entry file all-prefixes auto-desc)
9941 (cond
9942 (link-location) ; specified by arg, just use it.
9943 ((org-in-regexp org-bracket-link-regexp 1)
9944 ;; We do have a link at point, and we are going to edit it.
9945 (setq remove (list (match-beginning 0) (match-end 0)))
9946 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9947 (setq link (read-string "Link: "
9948 (org-link-unescape
9949 (org-match-string-no-properties 1)))))
9950 ((or (org-in-regexp org-angle-link-re)
9951 (org-in-regexp org-plain-link-re))
9952 ;; Convert to bracket link
9953 (setq remove (list (match-beginning 0) (match-end 0))
9954 link (read-string "Link: "
9955 (org-remove-angle-brackets (match-string 0)))))
9956 ((member complete-file '((4) (16)))
9957 ;; Completing read for file names.
9958 (setq link (org-file-complete-link complete-file)))
9959 (t
9960 ;; Read link, with completion for stored links.
9961 (org-link-fontify-links-to-this-file)
9962 (org-switch-to-buffer-other-window "*Org Links*")
9963 (with-current-buffer "*Org Links*"
9964 (erase-buffer)
9965 (insert "Insert a link.
9967 (when org-stored-links
9969 (insert (mapconcat 'org-link-prettify
9971 (goto-char (point-min)))
9972 (let ((cw (selected-window)))
9973 (select-window (get-buffer-window "*Org Links*" 'visible))
9974 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9975 (unless (pos-visible-in-window-p (point-max))
9976 (org-fit-window-to-buffer))
9977 (and (window-live-p cw) (select-window cw)))
9978 ;; Fake a link history, containing the stored links.
9979 (setq tmphist (append (mapcar 'car org-stored-links)
9980 org-insert-link-history))
9981 (setq all-prefixes (append (mapcar 'car abbrevs)
9982 (mapcar 'car org-link-abbrev-alist)
9983 org-link-types))
9984 (unwind-protect
9985 (progn
9986 (setq link
9987 (org-completing-read
9988 "Link: "
9989 (append
9990 (mapcar (lambda (x) (concat x ":"))
9991 all-prefixes)
9992 (mapcar 'car org-stored-links))
9993 nil nil nil
9994 'tmphist
9995 (caar org-stored-links)))
9997 (user-error "No link selected"))
9998 (mapc (lambda(l)
9999 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10000 org-stored-links)
10001 (if (or (member link all-prefixes)
10002 (and (equal ":" (substring link -1))
10003 (member (substring link 0 -1) all-prefixes)
10004 (setq link (substring link 0 -1))))
10005 (setq link (with-current-buffer origbuf
10006 (org-link-try-special-completion link)))))
10007 (set-window-configuration wcf)
10008 (kill-buffer "*Org Links*"))
10009 (setq entry (assoc link org-stored-links))
10010 (or entry (push link org-insert-link-history))
10011 (setq desc (or desc (nth 1 entry)))))
10013 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10014 (not org-keep-stored-link-after-insertion))
10015 (setq org-stored-links (delq (assoc link org-stored-links)
10016 org-stored-links)))
10018 (if (string-match org-plain-link-re link)
10019 ;; URL-like link, normalize the use of angular brackets.
10020 (setq link (org-remove-angle-brackets link)))
10022 ;; Check if we are linking to the current file with a search
10023 ;; option If yes, simplify the link by using only the search
10024 ;; option.
10025 (when (and buffer-file-name
10027 (let* ((path (match-string 1 link))
10028 (case-fold-search nil)
10029 (search (match-string 2 link)))
10030 (save-match-data
10031 (if (equal (file-truename buffer-file-name) (file-truename path))
10032 ;; We are linking to this same file, with a search option
10033 (setq link search)))))
10035 ;; Check if we can/should use a relative path. If yes, simplify the link
10037 (let* ((type (match-string 1 link))
10038 (path (match-string 2 link))
10039 (origpath path)
10040 (case-fold-search nil))
10041 (cond
10042 ((or (eq org-link-file-path-type 'absolute)
10043 (equal complete-file '(16)))
10044 (setq path (abbreviate-file-name (expand-file-name path))))
10045 ((eq org-link-file-path-type 'noabbrev)
10046 (setq path (expand-file-name path)))
10047 ((eq org-link-file-path-type 'relative)
10048 (setq path (file-relative-name path)))
10049 (t
10050 (save-match-data
10051 (if (string-match (concat "^" (regexp-quote
10052 (expand-file-name
10053 (file-name-as-directory
10054 default-directory))))
10055 (expand-file-name path))
10056 ;; We are linking a file with relative path name.
10057 (setq path (substring (expand-file-name path)
10058 (match-end 0)))
10059 (setq path (abbreviate-file-name (expand-file-name path)))))))
10060 (setq link (concat type path))
10061 (if (equal desc origpath)
10062 (setq desc path))))
10064 (if org-make-link-description-function
10065 (setq desc
10066 (or (condition-case nil
10067 (funcall org-make-link-description-function link desc)
10068 (error (progn (message "Can't get link description from `%s'"
10069 (symbol-name org-make-link-description-function))
10070 (sit-for 2) nil)))
10071 (read-string "Description: " default-description)))
10072 (if default-description (setq desc default-description)
10073 (setq desc (or (and auto-desc desc)
10074 (read-string "Description: " desc)))))
10077 (if remove (apply 'delete-region remove))
10078 (insert (org-make-link-string link desc))))
10080 (defun org-link-try-special-completion (type)
10081 "If there is completion support for link type TYPE, offer it."
10082 (let ((fun (intern (concat "org-" type "-complete-link"))))
10083 (if (functionp fun)
10084 (funcall fun)
10085 (read-string "Link (no completion support): " (concat type ":")))))
10087 (defun org-file-complete-link (&optional arg)
10088 "Create a file link using completion."
10089 (let (file link)
10090 (setq file (org-iread-file-name "File: "))
10091 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10092 (pwd1 (file-name-as-directory (abbreviate-file-name
10093 (expand-file-name ".")))))
10094 (cond
10095 ((equal arg '(16))
10096 (setq link (concat
10097 "file:"
10098 (abbreviate-file-name (expand-file-name file)))))
10100 (setq link (concat "file:" (match-string 1 file))))
10102 (expand-file-name file))
10103 (setq link (concat
10104 "file:" (match-string 1 (expand-file-name file)))))
10105 (t (setq link (concat "file:" file)))))
10106 link))
10108 (defun org-iread-file-name (&rest args)
10109 "Read-file-name using `ido-mode' speedup if available.
10110 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10111 See `read-file-name' for a description of parameters."
10112 (org-without-partial-completion
10113 (if (and org-completion-use-ido
10114 (fboundp 'ido-read-file-name)
10115 (boundp 'ido-mode) ido-mode
10116 (listp (second args)))
10117 (let ((ido-enter-matching-directory nil))
10118 (apply 'ido-read-file-name args))
10119 (apply 'read-file-name args))))
10121 (defun org-completing-read (&rest args)
10122 "Completing-read with SPACE being a normal character."
10123 (let ((enable-recursive-minibuffers t)
10124 (minibuffer-local-completion-map
10125 (copy-keymap minibuffer-local-completion-map)))
10126 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10127 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10128 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10129 (apply 'org-icompleting-read args)))
10131 (defun org-completing-read-no-i (&rest args)
10132 (let (org-completion-use-ido org-completion-use-iswitchb)
10133 (apply 'org-completing-read args)))
10135 (defun org-iswitchb-completing-read (prompt choices &rest args)
10136 "Use iswitch as a completing-read replacement to choose from choices.
10137 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10138 from."
10139 (let* ((iswitchb-use-virtual-buffers nil)
10140 (iswitchb-make-buflist-hook
10141 (lambda ()
10142 (setq iswitchb-temp-buflist choices))))
10143 (iswitchb-read-buffer prompt)))
10145 (defun org-icompleting-read (&rest args)
10146 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10147 (org-without-partial-completion
10148 (if (and org-completion-use-ido
10149 (fboundp 'ido-completing-read)
10150 (boundp 'ido-mode) ido-mode
10151 (listp (second args)))
10152 (let ((ido-enter-matching-directory nil))
10153 (apply 'ido-completing-read (concat (car args))
10154 (if (consp (car (nth 1 args)))
10155 (mapcar 'car (nth 1 args))
10156 (nth 1 args))
10157 (cddr args)))
10158 (if (and org-completion-use-iswitchb
10159 (boundp 'iswitchb-mode) iswitchb-mode
10160 (listp (second args)))
10161 (apply 'org-iswitchb-completing-read (concat (car args))
10162 (if (consp (car (nth 1 args)))
10163 (mapcar 'car (nth 1 args))
10164 (nth 1 args))
10165 (cddr args))
10166 (apply 'completing-read args)))))
10168 (defun org-extract-attributes (s)
10169 "Extract the attributes cookie from a string and set as text property."
10170 (let (a attr (start 0) key value)
10171 (save-match-data
10173 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10175 (setq key (match-string 1 a) value (match-string 2 a)
10176 start (match-end 0)
10177 attr (plist-put attr (intern key) value))))
10178 (org-add-props s nil 'org-attr attr))
10179 s))
10181 ;;; Opening/following a link
10183 (defvar org-link-search-failed nil)
10185 (defvar org-open-link-functions nil
10186 "Hook for functions finding a plain text link.
10187 These functions must take a single argument, the link content.
10188 They will be called for links that look like [[link text][description]]
10192 These functions will be called *before* Org attempts to resolve the
10193 link by doing text searches in the current buffer - so if you want a
10195 handle this as a special case.
10197 When the function does handle the link, it must return a non-nil value.
10198 If it decides that it is not responsible for this link, it must return
10199 nil to indicate that that Org-mode can continue with other options
10200 like exact and fuzzy text search.")
10202 (defun org-next-link (&optional search-backward)
10203 "Move forward to the next link.
10204 If the link is in hidden text, expose it."
10205 (interactive "P")
10206 (when (and org-link-search-failed (eq this-command last-command))
10207 (goto-char (point-min))
10208 (message "Link search wrapped back to beginning of buffer"))
10209 (setq org-link-search-failed nil)
10210 (let* ((pos (point))
10211 (ct (org-context))
10212 (a (assoc :link ct))
10213 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10214 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10215 ((looking-at org-any-link-re)
10216 ;; Don't stay stuck at link without an org-link face
10217 (forward-char (if search-backward -1 1))))
10218 (if (funcall srch-fun org-any-link-re nil t)
10219 (progn
10220 (goto-char (match-beginning 0))
10221 (if (outline-invisible-p) (org-show-context)))
10222 (goto-char pos)
10223 (setq org-link-search-failed t)
10224 (message "No further link found"))))
10226 (defun org-previous-link ()
10227 "Move backward to the previous link.
10228 If the link is in hidden text, expose it."
10229 (interactive)
10230 (funcall 'org-next-link t))
10232 (defun org-translate-link (s)
10233 "Translate a link string if a translation function has been defined."
10234 (if (and org-link-translation-function
10235 (fboundp org-link-translation-function)
10237 (progn
10238 (setq s (funcall org-link-translation-function
10239 (match-string 1 s) (match-string 2 s)))
10240 (concat (car s) ":" (cdr s)))
10241 s))
10243 (defun org-translate-link-from-planner (type path)
10244 "Translate a link from Emacs Planner syntax so that Org can follow it.
10245 This is still an experimental function, your mileage may vary."
10246 (cond
10247 ((member type '("http" "https" "news" "ftp"))
10248 ;; standard Internet links are the same.
10249 nil)
10250 ((and (equal type "irc") (string-match "^//" path))
10251 ;; Planner has two / at the beginning of an irc link, we have 1.
10252 ;; We should have zero, actually....
10253 (setq path (substring path 1)))
10254 ((and (equal type "lisp") (string-match "^/" path))
10255 ;; Planner has a slash, we do not.
10256 (setq type "elisp" path (substring path 1)))
10258 ;; A typical message link. Planner has the id after the final slash,
10259 ;; we separate it with a hash mark
10260 (setq path (concat (match-string 1 path) "#"
10261 (org-remove-angle-brackets (match-string 2 path))))))
10262 (cons type path))
10264 (defun org-find-file-at-mouse (ev)
10265 "Open file link or URL at mouse."
10266 (interactive "e")
10267 (mouse-set-point ev)
10268 (org-open-at-point 'in-emacs))
10270 (defun org-open-at-mouse (ev)
10271 "Open file link or URL at mouse.
10272 See the docstring of `org-open-file' for details."
10273 (interactive "e")
10274 (mouse-set-point ev)
10275 (if (eq major-mode 'org-agenda-mode)
10276 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10277 (org-open-at-point))
10279 (defvar org-window-config-before-follow-link nil
10280 "The window configuration before following a link.
10281 This is saved in case the need arises to restore it.")
10283 (defvar org-open-link-marker (make-marker)
10284 "Marker pointing to the location where `org-open-at-point; was called.")
10286 ;;;###autoload
10287 (defun org-open-at-point-global ()
10288 "Follow a link like Org-mode does.
10289 This command can be called in any mode to follow a link that has
10290 Org-mode syntax."
10291 (interactive)
10292 (org-run-like-in-org-mode 'org-open-at-point))
10294 ;;;###autoload
10295 (defun org-open-link-from-string (s &optional arg reference-buffer)
10296 "Open a link in the string S, as if it was in Org-mode."
10298 (let ((reference-buffer (or reference-buffer (current-buffer))))
10299 (with-temp-buffer
10300 (let ((org-inhibit-startup (not reference-buffer)))
10301 (org-mode)
10302 (insert s)
10303 (goto-char (point-min))
10304 (when reference-buffer
10305 (setq org-link-abbrev-alist-local
10306 (with-current-buffer reference-buffer
10307 org-link-abbrev-alist-local)))
10308 (org-open-at-point arg reference-buffer)))))
10310 (defvar org-open-at-point-functions nil
10311 "Hook that is run when following a link at point.
10313 Functions in this hook must return t if they identify and follow
10314 a link at point. If they don't find anything interesting at point,
10315 they must return nil.")
10317 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10318 (defun org-open-at-point (&optional arg reference-buffer)
10319 "Open link at or after point.
10320 If there is no link at point, this function will search forward up to
10321 the end of the current line.
10322 Normally, files will be opened by an appropriate application. If the
10323 optional prefix argument ARG is non-nil, Emacs will visit the file.
10324 With a double prefix argument, try to open outside of Emacs, in the
10325 application the system uses for this file type."
10326 (interactive "P")
10327 ;; if in a code block, then open the block's results
10328 (unless (call-interactively #'org-babel-open-src-block-result)
10329 (org-load-modules-maybe)
10330 (move-marker org-open-link-marker (point))
10331 (setq org-window-config-before-follow-link (current-window-configuration))
10332 (org-remove-occur-highlights nil nil t)
10333 (cond
10334 ((and (org-at-heading-p)
10335 (not (org-at-timestamp-p t))
10336 (not (org-in-regexp
10341 (not (get-text-property (point) 'org-linked-text)))
10342 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10343 (lk0 (car lkall))
10344 (lk (if (stringp lk0) (list lk0) lk0))
10345 (lkend (cdr lkall)))
10346 (mapcar (lambda(l)
10347 (search-forward l nil lkend)
10348 (goto-char (match-beginning 0))
10349 (org-open-at-point))
10350 lk))
10351 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10352 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10353 ((and (org-at-timestamp-p t)
10354 (not (org-in-regexp org-bracket-link-regexp)))
10355 (org-follow-timestamp-link))
10356 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10357 (not (org-in-regexp org-any-link-re)))
10358 (org-footnote-action))
10359 (t
10360 (let (type path link line search (pos (point)))
10361 (catch 'match
10362 (save-excursion
10364 (when (org-in-regexp org-bracket-link-regexp 1)
10365 (setq link (org-extract-attributes
10366 (org-link-unescape (org-match-string-no-properties 1))))
10368 (setq link (replace-match " " t t link)))
10369 (setq link (org-link-expand-abbrev link))
10370 (cond
10371 ((or (file-name-absolute-p link)
10373 (setq type "file" path link))
10374 ((string-match org-link-re-with-space3 link)
10375 (setq type (match-string 1 link) path (match-string 2 link)))
10377 (setq type "help" path (match-string 1 link)))
10378 (t (setq type "thisfile" path link)))
10379 (throw 'match t)))
10381 (when (get-text-property (point) 'org-linked-text)
10382 (setq type "thisfile"
10383 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10384 (1+ (point)) (point))
10385 path (buffer-substring
10386 (or (previous-single-property-change pos 'org-linked-text)
10387 (point-min))
10388 (or (next-single-property-change pos 'org-linked-text)
10389 (point-max)))
10390 ;; Ensure we will search for a <<<radio>>> link, not
10391 ;; a simple reference like <<ref>>
10392 path (concat "<" path))
10393 (throw 'match t))
10395 (save-excursion
10396 (when (or (org-in-regexp org-angle-link-re)
10397 (let ((match (org-in-regexp org-plain-link-re)))
10398 ;; Check a plain link is not within a bracket link
10399 (and match
10400 (save-excursion
10401 (progn
10402 (goto-char (car match))
10403 (not (org-in-regexp org-bracket-link-regexp))))))
10404 (let ((line_ending (save-excursion (end-of-line) (point))))
10405 ;; We are in a line before a plain or bracket link
10406 (or (re-search-forward org-plain-link-re line_ending t)
10407 (re-search-forward org-bracket-link-regexp line_ending t))))
10408 (setq type (match-string 1)
10409 path (org-link-unescape (match-string 2)))
10410 (throw 'match t)))
10411 (save-excursion
10413 (setq type "tags"
10414 path (match-string 1))
10415 (while (string-match ":" path)
10416 (setq path (replace-match "+" t t path)))
10417 (throw 'match t)))
10419 (setq type "tree-match"
10420 path (match-string 1))
10421 (throw 'match t)))
10422 (unless path
10423 (user-error "No link found"))
10425 ;; switch back to reference buffer
10426 ;; needed when if called in a temporary buffer through
10427 ;; org-open-link-from-string
10428 (with-current-buffer (or reference-buffer (current-buffer))
10430 ;; Remove any trailing spaces in path
10432 (setq path (replace-match "" t t path)))
10433 (if (and org-link-translation-function
10434 (fboundp org-link-translation-function))
10435 ;; Check if we need to translate the link
10436 (let ((tmp (funcall org-link-translation-function type path)))
10437 (setq type (car tmp) path (cdr tmp))))
10439 (cond
10441 ((assoc type org-link-protocols)
10442 (funcall (nth 1 (assoc type org-link-protocols)) path))
10444 ((equal type "help")
10445 (let ((f-or-v (intern path)))
10446 (cond ((fboundp f-or-v)
10447 (describe-function f-or-v))
10448 ((boundp f-or-v)
10449 (describe-variable f-or-v))
10450 (t (error "Not a known function or variable")))))
10452 ((equal type "mailto")
10453 (let ((cmd (car org-link-mailto-program))
10454 (args (cdr org-link-mailto-program)) args1
10455 (address path) (subject "") a)
10457 (setq address (match-string 1 path)
10458 subject (org-link-escape (match-string 2 path))))
10459 (while args
10460 (cond
10461 ((not (stringp (car args))) (push (pop args) args1))
10462 (t (setq a (pop args))
10463 (if (string-match "%a" a)
10464 (setq a (replace-match address t t a)))
10465 (if (string-match "%s" a)
10466 (setq a (replace-match subject t t a)))
10467 (push a args1))))
10468 (apply cmd (nreverse args1))))
10470 ((member type '("http" "https" "ftp" "news"))
10471 (browse-url
10472 (concat type ":"
10473 (if (org-string-match-p
10474 (concat "[[:nonascii:]"
10475 org-link-escape-chars-browser "]")
10476 path)
10477 (org-link-escape path org-link-escape-chars-browser)
10478 path))))
10480 ((string= type "doi")
10481 (browse-url
10482 (concat org-doi-server-url
10483 (if (org-string-match-p
10484 (concat "[[:nonascii:]"
10485 org-link-escape-chars-browser "]")
10486 path)
10487 (org-link-escape path org-link-escape-chars-browser)
10488 path))))
10490 ((member type '("message"))
10491 (browse-url (concat type ":" path)))
10493 ((string= type "tags")
10494 (org-tags-view arg path))
10496 ((string= type "tree-match")
10499 ((string= type "file")
10501 (setq line (string-to-number (match-string 1 path))
10502 path (substring path 0 (match-beginning 0)))
10504 (setq search (match-string 1 path)
10505 path (substring path 0 (match-beginning 0)))))
10506 (if (string-match "[*?{]" (file-name-nondirectory path))
10507 (dired path)
10508 (org-open-file path arg line search)))
10510 ((string= type "shell")
10511 (let ((buf (generate-new-buffer "*Org Shell Output"))
10512 (cmd path))
10513 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10514 (string-match org-confirm-shell-link-not-regexp cmd))
10515 (not org-confirm-shell-link-function)
10516 (funcall org-confirm-shell-link-function
10518 (org-add-props cmd nil
10519 'face 'org-warning))))
10520 (progn
10521 (message "Executing %s" cmd)
10522 (shell-command cmd buf)
10523 (if (featurep 'midnight)
10524 (setq clean-buffer-list-kill-buffer-names
10525 (cons buf clean-buffer-list-kill-buffer-names))))
10526 (error "Abort"))))
10528 ((string= type "elisp")
10529 (let ((cmd path))
10530 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10531 (string-match org-confirm-elisp-link-not-regexp cmd))
10532 (not org-confirm-elisp-link-function)
10533 (funcall org-confirm-elisp-link-function
10535 (org-add-props cmd nil
10536 'face 'org-warning))))
10537 (message "%s => %s" cmd
10538 (if (equal (string-to-char cmd) ?\()
10539 (eval (read cmd))
10540 (call-interactively (read cmd))))
10541 (error "Abort"))))
10543 ((and (string= type "thisfile")
10544 (or (run-hook-with-args-until-success
10545 'org-open-link-functions path)
10546 (and link
10547 (string-match "^id:" link)
10548 (or (featurep 'org-id) (require 'org-id))
10549 (progn
10550 (funcall (nth 1 (assoc "id" org-link-protocols))
10551 (substring path 3))
10552 t)))))
10554 ((string= type "thisfile")
10555 (if arg
10556 (switch-to-buffer-other-window
10557 (org-get-buffer-for-internal-link (current-buffer)))
10558 (org-mark-ring-push))
10559 (let ((cmd `(org-link-search
10560 ,path
10561 ,(cond ((equal arg '(4)) ''occur)
10562 ((equal arg '(16)) ''org-occur))
10563 ,pos)))
10564 (condition-case nil (let ((org-link-search-inhibit-query t))
10565 (eval cmd))
10566 (error (progn (widen) (eval cmd))))))
10568 (t (browse-url-at-point)))))))
10569 (move-marker org-open-link-marker nil)
10570 (run-hook-with-args 'org-follow-link-hook)))
10572 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10573 "Offer links in the current entry and return the selected link.
10574 If there is only one link, return it.
10575 If NTH is an integer, return the NTH link found.
10576 If ZERO is a string, check also this string for a link, and if
10577 there is one, return it."
10578 (with-current-buffer buffer
10579 (save-excursion
10580 (save-restriction
10581 (widen)
10582 (goto-char marker)
10586 (cnt ?0)
10587 (in-emacs (if (integerp nth) nil nth))
10588 have-zero end links link c)
10589 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10590 (push (match-string 0 zero) links)
10591 (setq cnt (1- cnt) have-zero t))
10592 (save-excursion
10593 (org-back-to-heading t)
10594 (setq end (save-excursion (outline-next-heading) (point)))
10595 (while (re-search-forward re end t)
10596 (push (match-string 0) links))
10597 (setq links (org-uniquify (reverse links))))
10598 (cond
10599 ((null links)
10600 (message "No links"))
10601 ((equal (length links) 1)
10602 (setq link (car links)))
10603 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10604 (setq link (nth (if have-zero nth (1- nth)) links)))
10605 (t ; we have to select a link
10606 (save-excursion
10607 (save-window-excursion
10608 (delete-other-windows)
10609 (with-output-to-temp-buffer "*Select Link*"
10610 (mapc (lambda (l)
10611 (if (not (string-match org-bracket-link-regexp l))
10613 (org-remove-angle-brackets l)))
10614 (if (match-end 3)
10616 (match-string 3 l) (match-string 1 l)))
10618 (match-string 1 l))))))
10619 links))
10620 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10621 (message "Select link to open, RET to open all:")
10622 (setq c (read-char-exclusive))
10623 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10624 (when (equal c ?q) (error "Abort"))
10625 (if (equal c ?\C-m)
10626 (setq link links)
10627 (setq nth (- c ?0))
10628 (if have-zero (setq nth (1+ nth)))
10629 (unless (and (integerp nth) (>= (length links) nth))
10630 (user-error "Invalid link selection"))
10631 (setq link (nth (1- nth) links)))))
10632 (cons link end))))))
10634 ;; Add special file links that specify the way of opening
10636 (org-add-link-type "file+sys" 'org-open-file-with-system)
10637 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10638 (defun org-open-file-with-system (path)
10639 "Open file at PATH using the system way of opening it."
10640 (org-open-file path 'system))
10641 (defun org-open-file-with-emacs (path)
10642 "Open file at PATH in Emacs."
10643 (org-open-file path 'emacs))
10646 ;;; File search
10648 (defvar org-create-file-search-functions nil
10649 "List of functions to construct the right search string for a file link.
10650 These functions are called in turn with point at the location to
10651 which the link should point.
10653 A function in the hook should first test if it would like to
10654 handle this file type, for example by checking the `major-mode'
10655 or the file extension. If it decides not to handle this file, it
10656 should just return nil to give other functions a chance. If it
10657 does handle the file, it must return the search string to be used
10658 when following the link. The search string will be part of the
10659 file link, given after a double colon, and `org-open-at-point'
10660 will automatically search for it. If special measures must be
10661 taken to make the search successful, another function should be
10662 added to the companion hook `org-execute-file-search-functions',
10663 which see.
10665 A function in this hook may also use `setq' to set the variable
10666 `description' to provide a suggestion for the descriptive text to
10667 be used for this link when it gets inserted into an Org-mode
10670 (defvar org-execute-file-search-functions nil
10671 "List of functions to execute a file search triggered by a link.
10673 Functions added to this hook must accept a single argument, the
10674 search string that was part of the file link, the part after the
10675 double colon. The function must first check if it would like to
10676 handle this search, for example by checking the `major-mode' or
10677 the file extension. If it decides not to handle this search, it
10678 should just return nil to give other functions a chance. If it
10679 does handle the search, it must return a non-nil value to keep
10680 other functions from trying.
10682 Each function can access the current prefix argument through the
10683 variable `current-prefix-arg'. Note that a single prefix is used
10684 to force opening a link in Emacs, so it may be good to only use a
10685 numeric or double prefix to guide the search function.
10687 In case this is needed, a function in this hook can also restore
10688 the window configuration before `org-open-at-point' was called using:
10690 (set-window-configuration org-window-config-before-follow-link)")
10692 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10693 (defun org-link-search (s &optional type avoid-pos stealth)
10694 "Search for a link search option.
10695 If S is surrounded by forward slashes, it is interpreted as a
10696 regular expression. In org-mode files, this will create an `org-occur'
10697 sparse tree. In ordinary files, `occur' will be used to list matches.
10698 If the current buffer is in `dired-mode', grep will be used to search
10699 in all files. If AVOID-POS is given, ignore matches near that position.
10701 When optional argument STEALTH is non-nil, do not modify
10702 visibility around point, thus ignoring
10703 `org-show-hierarchy-above', `org-show-following-heading' and
10704 `org-show-siblings' variables."
10705 (let ((case-fold-search t)
10709 org-emphasis-alist)
10711 (pos (point))
10712 (pre nil) (post nil)
10713 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10714 (cond
10715 ;; First check if there are any special search functions
10716 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10717 ;; Now try the builtin stuff
10718 ((and (equal (string-to-char s0) ?#)
10719 (> (length s0) 1)
10720 (save-excursion
10721 (goto-char (point-min))
10722 (and
10723 (re-search-forward
10726 (setq type 'dedicated
10727 pos (match-beginning 0))))
10728 ;; There is an exact target for this
10729 (goto-char pos)
10730 (org-back-to-heading t)))
10731 ((save-excursion
10732 (goto-char (point-min))
10733 (and
10734 (re-search-forward
10735 (concat "<<" (regexp-quote s0) ">>") nil t)
10736 (setq type 'dedicated
10737 pos (match-beginning 0))))
10738 ;; There is an exact target for this
10739 (goto-char pos))
10740 ((save-excursion
10741 (goto-char (point-min))
10742 (and
10743 (re-search-forward
10745 (setq type 'dedicated pos (match-beginning 0))))
10746 ;; Found an element with a matching #+name affiliated keyword.
10747 (goto-char pos))
10749 (save-excursion
10750 (goto-char (point-min))
10751 (and
10752 (re-search-forward
10753 (concat "[^[]" (regexp-quote
10754 (format org-coderef-label-format
10755 (match-string 1 s0))))
10756 nil t)
10757 (setq type 'dedicated
10758 pos (1+ (match-beginning 0))))))
10759 ;; There is a coderef target for this
10760 (goto-char pos))
10762 ;; A regular expression
10763 (cond
10764 ((derived-mode-p 'org-mode)
10765 (org-occur (match-string 1 s)))
10766 (t (org-do-occur (match-string 1 s)))))
10767 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10768 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10769 (goto-char (point-min))
10770 (cond
10771 ((let (case-fold-search)
10772 (re-search-forward (format org-complex-heading-regexp-format
10773 (regexp-quote s))
10774 nil t))
10775 ;; OK, found a match
10776 (setq type 'dedicated)
10777 (goto-char (match-beginning 0)))
10778 ((and (not org-link-search-inhibit-query)
10779 (eq org-link-search-must-match-exact-headline 'query-to-create)
10780 (y-or-n-p "No match - create this as a new heading? "))
10781 (goto-char (point-max))
10782 (or (bolp) (newline))
10784 (beginning-of-line 0))
10785 (t
10786 (goto-char pos)
10787 (error "No match"))))
10788 (t
10789 ;; A normal search string
10790 (when (equal (string-to-char s) ?*)
10791 ;; Anchor on headlines, post may include tags.
10794 s (substring s 1)))
10795 (remove-text-properties
10796 0 (length s)
10797 '(face nil mouse-face nil keymap nil fontified nil) s)
10798 ;; Make a series of regular expressions to find a match
10809 re4 (concat "[^a-zA-Z_]" re4_)
10811 re1 (concat pre re2 post)
10812 re3 (concat pre (if pre re4_ re4) post)
10813 re5 (concat pre ".*" re4)
10814 re2 (concat pre re2)
10815 re2a (concat pre (if pre re2a_ re2a))
10816 re4 (concat pre (if pre re4_ re4))
10820 (cond
10821 ((eq type 'org-occur) (org-occur reall))
10822 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10823 (t (goto-char (point-min))
10824 (setq type 'fuzzy)
10825 (if (or (and (org-search-not-self 1 re0 nil t)
10826 (setq type 'dedicated))
10827 (org-search-not-self 1 re1 nil t)
10828 (org-search-not-self 1 re2 nil t)
10829 (org-search-not-self 1 re2a nil t)
10830 (org-search-not-self 1 re3 nil t)
10831 (org-search-not-self 1 re4 nil t)
10832 (org-search-not-self 1 re5 nil t))
10833 (goto-char (match-beginning 1))
10834 (goto-char pos)
10835 (error "No match"))))))
10836 (and (derived-mode-p 'org-mode)
10837 (not stealth)
10838 (org-show-context 'link-search))
10839 type))
10841 (defun org-search-not-self (group &rest args)
10842 "Execute `re-search-forward', but only accept matches that do not
10843 enclose the position of `org-open-link-marker'."
10844 (let ((m org-open-link-marker))
10845 (catch 'exit
10846 (while (apply 're-search-forward args)
10847 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10848 (goto-char (match-end group))
10849 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10850 (> (match-beginning 0) (marker-position m))
10851 (< (match-end 0) (marker-position m)))
10852 (save-match-data
10853 (or (not (org-in-regexp
10854 org-bracket-link-analytic-regexp 1))
10855 (not (match-end 4)) ; no description
10856 (and (<= (match-beginning 4) (point))
10857 (>= (match-end 4) (point))))))
10858 (throw 'exit (point))))))))
10860 (defun org-get-buffer-for-internal-link (buffer)
10861 "Return a buffer to be used for displaying the link target of internal links."
10862 (cond
10863 ((not org-display-internal-link-with-indirect-buffer)
10864 buffer)
10865 ((string-match "(Clone)$" (buffer-name buffer))
10866 (message "Buffer is already a clone, not making another one")
10867 ;; we also do not modify visibility in this case
10868 buffer)
10869 (t ; make a new indirect buffer for displaying the link
10870 (let* ((bn (buffer-name buffer))
10871 (ibn (concat bn "(Clone)"))
10872 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10873 (with-current-buffer ib (org-overview))
10874 ib))))
10876 (defun org-do-occur (regexp &optional cleanup)
10877 "Call the Emacs command `occur'.
10878 If CLEANUP is non-nil, remove the printout of the regular expression
10879 in the *Occur* buffer. This is useful if the regex is long and not useful
10880 to read."
10881 (occur regexp)
10882 (when cleanup
10883 (let ((cwin (selected-window)) win beg end)
10884 (when (setq win (get-buffer-window "*Occur*"))
10885 (select-window win))
10886 (goto-char (point-min))
10887 (when (re-search-forward "match[a-z]+" nil t)
10888 (setq beg (match-end 0))
10890 (setq end (1- (match-beginning 0)))))
10891 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10892 (goto-char (point-min))
10893 (select-window cwin))))
10895 ;;; The mark ring for links jumps
10897 (defvar org-mark-ring nil
10898 "Mark ring for positions before jumps in Org-mode.")
10899 (defvar org-mark-ring-last-goto nil
10900 "Last position in the mark ring used to go back.")
10901 ;; Fill and close the ring
10902 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10903 (loop for i from 1 to org-mark-ring-length do
10904 (push (make-marker) org-mark-ring))
10905 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10906 org-mark-ring)
10908 (defun org-mark-ring-push (&optional pos buffer)
10909 "Put the current position or POS into the mark ring and rotate it."
10910 (interactive)
10911 (setq pos (or pos (point)))
10912 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10913 (move-marker (car org-mark-ring)
10914 (or pos (point))
10915 (or buffer (current-buffer)))
10916 (message "%s"
10917 (substitute-command-keys
10920 (defun org-mark-ring-goto (&optional n)
10921 "Jump to the previous position in the mark ring.
10922 With prefix arg N, jump back that many stored positions. When
10923 called several times in succession, walk through the entire ring.
10924 Org-mode commands jumping to a different position in the current file,
10925 or to another Org-mode file, automatically push the old position
10926 onto the ring."
10927 (interactive "p")
10928 (let (p m)
10929 (if (eq last-command this-command)
10930 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10931 (setq p org-mark-ring))
10932 (setq org-mark-ring-last-goto p)
10933 (setq m (car p))
10934 (org-pop-to-buffer-same-window (marker-buffer m))
10935 (goto-char m)
10936 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10938 (defun org-remove-angle-brackets (s)
10939 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10940 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10941 s)
10942 (defun org-add-angle-brackets (s)
10943 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10944 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10945 s)
10946 (defun org-remove-double-quotes (s)
10949 s)
10951 ;;; Following specific links
10953 (defun org-follow-timestamp-link ()
10954 "Open an agenda view for the time-stamp date/range at point."
10955 (cond
10956 ((org-at-date-range-p t)
10957 (let ((org-agenda-start-on-weekday)
10958 (t1 (match-string 1))
10959 (t2 (match-string 2)) tt1 tt2)
10960 (setq tt1 (time-to-days (org-time-string-to-time t1))
10961 tt2 (time-to-days (org-time-string-to-time t2)))
10962 (let ((org-agenda-buffer-tmp-name
10963 (format "*Org Agenda(a:%s)"
10964 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10965 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10966 ((org-at-timestamp-p t)
10967 (let ((org-agenda-buffer-tmp-name
10968 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10969 (org-agenda-list nil (time-to-days (org-time-string-to-time
10970 (substring (match-string 1) 0 10)))
10971 1)))
10972 (t (error "This should not happen"))))
10975 ;;; Following file links
10976 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10977 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10978 (declare-function mailcap-mime-info
10979 "mailcap" (string &optional request no-decode))
10980 (defvar org-wait nil)
10981 (defun org-open-file (path &optional in-emacs line search)
10982 "Open the file at PATH.
10983 First, this expands any special file name abbreviations. Then the
10984 configuration variable `org-file-apps' is checked if it contains an
10985 entry for this file type, and if yes, the corresponding command is launched.
10987 If no application is found, Emacs simply visits the file.
10989 With optional prefix argument IN-EMACS, Emacs will visit the file.
10991 prefix arg, Org tries to avoid opening in Emacs
10992 and to use an external application to visit the file.
10994 Optional LINE specifies a line to go to, optional SEARCH a string
10995 to search for. If LINE or SEARCH is given, the file will be
10996 opened in Emacs, unless an entry from org-file-apps that makes
10997 use of groups in a regexp matches.
10999 If you want to change the way frames are used when following a
11000 link, please customize `org-link-frame-setup'.
11002 If the file does not exist, an error is thrown."
11003 (let* ((file (if (equal path "")
11004 buffer-file-name
11005 (substitute-in-file-name (expand-file-name path))))
11006 (file-apps (append org-file-apps (org-default-apps)))
11007 (apps (org-remove-if
11008 'org-file-apps-entry-match-against-dlink-p file-apps))
11009 (apps-dlink (org-remove-if-not
11010 'org-file-apps-entry-match-against-dlink-p file-apps))
11011 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11012 (dirp (if remp nil (file-directory-p file)))
11013 (file (if (and dirp org-open-directory-means-index-dot-org)
11014 (concat (file-name-as-directory file) "index.org")
11015 file))
11016 (a-m-a-p (assq 'auto-mode apps))
11017 (dfile (downcase file))
11018 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11019 (link (cond ((and (eq line nil)
11020 (eq search nil))
11021 file)
11022 (line
11023 (concat file "::" (number-to-string line)))
11024 (search
11025 (concat file "::" search))))
11026 (dlink (downcase link))
11027 (old-buffer (current-buffer))
11028 (old-pos (point))
11029 (old-mode major-mode)
11030 ext cmd link-match-data)
11032 (setq ext (match-string 1 dfile))
11034 (setq ext (match-string 1 dfile))))
11035 (cond
11036 ((member in-emacs '((16) system))
11037 (setq cmd (cdr (assoc 'system apps))))
11038 (in-emacs (setq cmd 'emacs))
11039 (t
11040 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11041 (and dirp (cdr (assoc 'directory apps)))
11042 ; first, try matching against apps-dlink
11043 ; if we get a match here, store the match data for later
11044 (let ((match (assoc-default dlink apps-dlink
11045 'string-match)))
11046 (if match
11047 (progn (setq link-match-data (match-data))
11048 match)
11049 (progn (setq in-emacs (or in-emacs line search))
11050 nil))) ; if we have no match in apps-dlink,
11051 ; always open the file in emacs if line or search
11052 ; is given (for backwards compatibility)
11053 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11054 'string-match)
11055 (cdr (assoc ext apps))
11056 (cdr (assoc t apps))))))
11057 (when (eq cmd 'system)
11058 (setq cmd (cdr (assoc 'system apps))))
11059 (when (eq cmd 'default)
11060 (setq cmd (cdr (assoc t apps))))
11061 (when (eq cmd 'mailcap)
11062 (require 'mailcap)
11063 (mailcap-parse-mailcaps)
11064 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11065 (command (mailcap-mime-info mime-type)))
11066 (if (stringp command)
11067 (setq cmd command)
11068 (setq cmd 'emacs))))
11069 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11070 (not (file-exists-p file))
11071 (not org-open-non-existing-files))
11072 (user-error "No such file: %s" file))
11073 (cond
11075 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11077 (setq cmd (replace-match "%s" t t cmd)))
11078 (while (string-match "%s" cmd)
11079 (setq cmd (replace-match
11080 (save-match-data
11081 (shell-quote-argument
11082 (convert-standard-filename file)))
11083 t t cmd)))
11085 ;; Replace "%1", "%2" etc. in command with group matches from regex
11086 (save-match-data
11087 (let ((match-index 1)
11088 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11089 (set-match-data link-match-data)
11090 (while (<= match-index number-of-groups)
11091 (let ((regex (concat "%" (number-to-string match-index)))
11092 (replace-with (match-string match-index dlink)))
11093 (while (string-match regex cmd)
11094 (setq cmd (replace-match replace-with t t cmd))))
11095 (setq match-index (+ match-index 1)))))
11097 (save-window-excursion
11098 (message "Running %s...done" cmd)
11099 (start-process-shell-command cmd nil cmd)
11100 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11101 ((or (stringp cmd)
11102 (eq cmd 'emacs))
11103 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11104 (widen)
11105 (if line (org-goto-line line)
11106 (if search (org-link-search search))))
11107 ((consp cmd)
11108 (let ((file (convert-standard-filename file)))
11109 (save-match-data
11110 (set-match-data link-match-data)
11111 (eval cmd))))
11112 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11113 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11114 (or (not (equal old-buffer (current-buffer)))
11115 (not (equal old-pos (point))))
11116 (org-mark-ring-push old-pos old-buffer))))
11118 (defun org-file-apps-entry-match-against-dlink-p (entry)
11119 "This function returns non-nil if `entry' uses a regular
11120 expression which should be matched against the whole link by
11121 org-open-file.
11123 It assumes that is the case when the entry uses a regular
11124 expression which has at least one grouping construct and the
11125 action is either a lisp form or a command string containing
11126 '%1', i.e. using at least one subexpression match as a
11127 parameter."
11128 (let ((selector (car entry))
11129 (action (cdr entry)))
11130 (if (stringp selector)
11131 (and (> (regexp-opt-depth selector) 0)
11132 (or (and (stringp action)
11133 (string-match "%[0-9]" action))
11134 (consp action)))
11135 nil)))
11137 (defun org-default-apps ()
11138 "Return the default applications for this operating system."
11139 (cond
11140 ((eq system-type 'darwin)
11141 org-file-apps-defaults-macosx)
11142 ((eq system-type 'windows-nt)
11143 org-file-apps-defaults-windowsnt)
11144 (t org-file-apps-defaults-gnu)))
11146 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11147 "Convert extensions to regular expressions in the cars of LIST.
11148 Also, weed out any non-string entries, because the return value is used
11149 only for regexp matching.
11150 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11151 point to the symbol `emacs', indicating that the file should
11152 be opened in Emacs."
11153 (append
11154 (delq nil
11155 (mapcar (lambda (x)
11156 (if (not (stringp (car x)))
11157 nil
11159 x
11161 list))
11162 (if add-auto-mode
11163 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11165 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11166 (defun org-file-remote-p (file)
11167 "Test whether FILE specifies a location on a remote system.
11168 Return non-nil if the location is indeed remote.
11172 (cond ((fboundp 'file-remote-p)
11173 (file-remote-p file))
11174 ((fboundp 'tramp-handle-file-remote-p)
11175 (tramp-handle-file-remote-p file))
11176 ((and (boundp 'ange-ftp-name-format)
11177 (string-match (car ange-ftp-name-format) file))
11178 t)))
11181 ;;;; Refiling
11183 (defun org-get-org-file ()
11184 "Read a filename, with default directory `org-directory'."
11185 (let ((default (or org-default-notes-file remember-data-file)))
11186 (read-file-name (format "File name [%s]: " default)
11187 (file-name-as-directory org-directory)
11188 default)))
11190 (defun org-notes-order-reversed-p ()
11191 "Check if the current file should receive notes in reversed order."
11192 (cond
11193 ((not org-reverse-note-order) nil)
11194 ((eq t org-reverse-note-order) t)
11195 ((not (listp org-reverse-note-order)) nil)
11196 (t (catch 'exit
11197 (let ((all org-reverse-note-order)
11198 entry)
11199 (while (setq entry (pop all))
11200 (if (string-match (car entry) buffer-file-name)
11201 (throw 'exit (cdr entry))))
11202 nil)))))
11204 (defvar org-refile-target-table nil
11205 "The list of refile targets, created by `org-refile'.")
11207 (defvar org-agenda-new-buffers nil
11208 "Buffers created to visit agenda files.")
11210 (defvar org-refile-cache nil
11211 "Cache for refile targets.")
11213 (defvar org-refile-markers nil
11214 "All the markers used for caching refile locations.")
11216 (defun org-refile-marker (pos)
11217 "Get a new refile marker, but only if caching is in use."
11218 (if (not org-refile-use-cache)
11219 pos
11220 (let ((m (make-marker)))
11221 (move-marker m pos)
11222 (push m org-refile-markers)
11223 m)))
11225 (defun org-refile-cache-clear ()
11226 "Clear the refile cache and disable all the markers."
11227 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11228 (setq org-refile-markers nil)
11229 (setq org-refile-cache nil)
11230 (message "Refile cache has been cleared"))
11232 (defun org-refile-cache-check-set (set)
11233 "Check if all the markers in the cache still have live buffers."
11234 (let (marker)
11235 (catch 'exit
11236 (while (and set (setq marker (nth 3 (pop set))))
11237 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11238 (when (and marker (null (marker-buffer marker)))
11239 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11240 (sit-for 3)
11241 (throw 'exit nil)))
11242 t)))
11244 (defun org-refile-cache-put (set &rest identifiers)
11245 "Push the refile targets SET into the cache, under IDENTIFIERS."
11246 (let* ((key (sha1 (prin1-to-string identifiers)))
11247 (entry (assoc key org-refile-cache)))
11248 (if entry
11249 (setcdr entry set)
11250 (push (cons key set) org-refile-cache))))
11252 (defun org-refile-cache-get (&rest identifiers)
11253 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11254 (cond
11255 ((not org-refile-cache) nil)
11256 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11257 (t
11258 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11259 org-refile-cache))))
11260 (and set (org-refile-cache-check-set set) set)))))
11262 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11263 "Produce a table with refile targets."
11264 (let ((case-fold-search nil)
11265 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11266 (entries (or org-refile-targets '((nil . (:level . 1)))))
11267 targets tgs txt re files f desc descre fast-path-p level pos0)
11268 (message "Getting targets...")
11269 (with-current-buffer (or default-buffer (current-buffer))
11270 (while (setq entry (pop entries))
11271 (setq files (car entry) desc (cdr entry))
11272 (setq fast-path-p nil)
11273 (cond
11274 ((null files) (setq files (list (current-buffer))))
11275 ((eq files 'org-agenda-files)
11276 (setq files (org-agenda-files 'unrestricted)))
11277 ((and (symbolp files) (fboundp files))
11278 (setq files (funcall files)))
11279 ((and (symbolp files) (boundp files))
11280 (setq files (symbol-value files))))
11281 (if (stringp files) (setq files (list files)))
11282 (cond
11283 ((eq (car desc) :tag)
11285 ((eq (car desc) :todo)
11287 ((eq (car desc) :regexp)
11288 (setq descre (cdr desc)))
11289 ((eq (car desc) :level)
11291 (if org-odd-levels-only
11292 (1- (* 2 (cdr desc)))
11293 (cdr desc)))
11295 ((eq (car desc) :maxlevel)
11296 (setq fast-path-p t)
11298 (if org-odd-levels-only
11299 (1- (* 2 (cdr desc)))
11300 (cdr desc)))
11302 (t (error "Bad refiling target description %s" desc)))
11303 (while (setq f (pop files))
11304 (with-current-buffer
11305 (if (bufferp f) f (org-get-agenda-file-buffer f))
11306 (or
11307 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11308 (progn
11309 (if (bufferp f) (setq f (buffer-file-name
11310 (buffer-base-buffer f))))
11311 (setq f (and f (expand-file-name f)))
11312 (if (eq org-refile-use-outline-path 'file)
11313 (push (list (file-name-nondirectory f) f nil nil) tgs))
11314 (save-excursion
11315 (save-restriction
11316 (widen)
11317 (goto-char (point-min))
11318 (while (re-search-forward descre nil t)
11319 (goto-char (setq pos0 (point-at-bol)))
11320 (catch 'next
11321 (when org-refile-target-verify-function
11322 (save-match-data
11323 (or (funcall org-refile-target-verify-function)
11324 (throw 'next t))))
11325 (when (and (looking-at org-complex-heading-regexp)
11326 (not (member (match-string 4) excluded-entries))
11327 (match-string 4))
11328 (setq level (org-reduced-level
11329 (- (match-end 1) (match-beginning 1)))
11330 txt (org-link-display-format (match-string 4))
11332 re (format org-complex-heading-regexp-format
11333 (regexp-quote (match-string 4))))
11334 (when org-refile-use-outline-path
11335 (setq txt (mapconcat
11336 'org-protect-slash
11337 (append
11338 (if (eq org-refile-use-outline-path
11339 'file)
11340 (list (file-name-nondirectory
11341 (buffer-file-name
11342 (buffer-base-buffer))))
11343 (if (eq org-refile-use-outline-path
11344 'full-file-path)
11345 (list (buffer-file-name
11346 (buffer-base-buffer)))))
11347 (org-get-outline-path fast-path-p
11348 level txt)
11349 (list txt))
11350 "/")))
11351 (push (list txt f re (org-refile-marker (point)))
11352 tgs)))
11353 (when (= (point) pos0)
11354 ;; verification function has not moved point
11355 (goto-char (point-at-eol))))))))
11356 (when org-refile-use-cache
11357 (org-refile-cache-put tgs (buffer-file-name) descre))
11358 (setq targets (append tgs targets))))))
11359 (message "Getting targets...done")
11360 (nreverse targets)))
11362 (defun org-protect-slash (s)
11363 (while (string-match "/" s)
11365 s)
11367 (defvar org-olpa (make-vector 20 nil))
11369 (defun org-get-outline-path (&optional fastp level heading)
11370 "Return the outline path to the current entry, as a list.
11372 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11373 routine which makes outline path derivations for an entire file,
11374 avoiding backtracing. Refile target collection makes use of that."
11375 (if fastp
11376 (progn
11377 (if (> level 19)
11378 (error "Outline path failure, more than 19 levels"))
11379 (loop for i from level upto 19 do
11380 (aset org-olpa i nil))
11381 (prog1
11382 (delq nil (append org-olpa nil))
11383 (aset org-olpa level heading)))
11384 (let (rtn case-fold-search)
11385 (save-excursion
11386 (save-restriction
11387 (widen)
11388 (while (org-up-heading-safe)
11389 (when (looking-at org-complex-heading-regexp)
11390 (push (org-trim
11391 (replace-regexp-in-string
11392 ;; Remove statistical/checkboxes cookies
11394 (org-match-string-no-properties 4)))
11395 rtn)))
11396 rtn)))))
11398 (defun org-format-outline-path (path &optional width prefix separator)
11399 "Format the outline path PATH for display.
11400 WIDTH is the maximum number of characters that is available.
11401 PREFIX is a prefix to be included in the returned string,
11402 such as the file name.
11403 SEPARATOR is inserted between the different parts of the path,
11405 (setq width (or width 79))
11406 (if prefix (setq width (- width (length prefix))))
11407 (if (not path)
11408 (or prefix "")
11409 (let* ((nsteps (length path))
11410 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11411 (maxwidth (if (<= total-width width)
11412 10000 ;; everything fits
11413 ;; we need to shorten the level headings
11414 (/ (- width nsteps) nsteps)))
11415 (org-odd-levels-only nil)
11416 (n 0)
11417 (total (1+ (length prefix))))
11418 (setq maxwidth (max maxwidth 10))
11419 (concat prefix
11420 (if prefix (or separator "/"))
11421 (mapconcat
11422 (lambda (h)
11423 (setq n (1+ n))
11424 (if (and (= n nsteps) (< maxwidth 10000))
11425 (setq maxwidth (- total-width total)))
11426 (if (< (length h) maxwidth)
11427 (progn (setq total (+ total (length h) 1)) h)
11428 (setq h (substring h 0 (- maxwidth 2))
11429 total (+ total maxwidth 1))
11431 (setq h (substring h 0 (match-beginning 0))))
11432 (setq h (concat h "..")))
11433 (org-add-props h nil 'face
11434 (nth (% (1- n) org-n-level-faces)
11435 org-level-faces))
11436 h)
11437 path (or separator "/"))))))
11439 (defun org-display-outline-path (&optional file current separator just-return-string)
11440 "Display the current outline path in the echo area.
11442 If FILE is non-nil, prepend the output with the file name.
11443 If CURRENT is non-nil, append the current heading to the output.
11444 SEPARATOR is passed through to `org-format-outline-path'. It separates
11446 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11447 (interactive "P")
11448 (let* (case-fold-search
11449 (bfn (buffer-file-name (buffer-base-buffer)))
11450 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11451 res)
11452 (if current (setq path (append path
11453 (save-excursion
11454 (org-back-to-heading t)
11455 (if (looking-at org-complex-heading-regexp)
11456 (list (match-string 4)))))))
11457 (setq res
11458 (org-format-outline-path
11459 path
11460 (1- (frame-width))
11461 (and file bfn (concat (file-name-nondirectory bfn) separator))
11462 separator))
11463 (if just-return-string
11464 (org-no-properties res)
11465 (org-unlogged-message "%s" res))))
11467 (defvar org-refile-history nil
11468 "History for refiling operations.")
11470 (defvar org-after-refile-insert-hook nil
11471 "Hook run after `org-refile' has inserted its stuff at the new location.
11472 Note that this is still *before* the stuff will be removed from
11473 the *old* location.")
11475 (defvar org-capture-last-stored-marker)
11476 (defvar org-refile-keep nil
11477 "Non-nil means `org-refile' will copy instead of refile.")
11479 (defun org-copy ()
11480 "Like `org-refile', but copy."
11481 (interactive)
11482 (let ((org-refile-keep t))
11483 (funcall 'org-refile nil nil nil "Copy")))
11485 (defun org-refile (&optional goto default-buffer rfloc msg)
11486 "Move the entry or entries at point to another heading.
11487 The list of target headings is compiled using the information in
11488 `org-refile-targets', which see.
11490 At the target location, the entry is filed as a subitem of the target
11491 heading. Depending on `org-reverse-note-order', the new subitem will
11492 either be the first or the last subitem.
11494 If there is an active region, all entries in that region will be moved.
11495 However, the region must fulfill the requirement that the first heading
11496 is the first one sets the top-level of the moved text - at most siblings
11497 below it are allowed.
11499 With prefix arg GOTO, the command will only visit the target location
11500 and not actually move anything.
11503 go to the location where the last refiling operation has put the subtree.
11505 With a numeric prefix argument of `2', refile to the running clock.
11507 With a numeric prefix argument of `3', emulate `org-refile-keep'
11508 being set to `t' and copy to the target location, don't move it.
11509 Beware that keeping refiled entries may result in duplicated ID
11510 properties.
11512 RFLOC can be a refile location obtained in a different way.
11517 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11519 If you are using target caching (see `org-refile-use-cache'),
11520 you have to clear the target cache in order to find new targets.
11521 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11522 prefix argument (`C-u C-u C-u C-c C-w')."
11524 (interactive "P")
11525 (if (member goto '(0 (64)))
11526 (org-refile-cache-clear)
11527 (let* ((actionmsg (or msg "Refile"))
11528 (cbuf (current-buffer))
11529 (regionp (org-region-active-p))
11530 (region-start (and regionp (region-beginning)))
11531 (region-end (and regionp (region-end)))
11532 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11533 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11534 pos it nbuf file re level reversed)
11535 (setq last-command nil)
11536 (when regionp
11537 (goto-char region-start)
11538 (or (bolp) (goto-char (point-at-bol)))
11539 (setq region-start (point))
11540 (unless (or (org-kill-is-subtree-p
11541 (buffer-substring region-start region-end))
11542 (prog1 org-refile-active-region-within-subtree
11543 (let ((s (point-at-eol)))
11544 (org-toggle-heading)
11545 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11546 (user-error "The region is not a (sequence of) subtree(s)")))
11547 (if (equal goto '(16))
11548 (org-refile-goto-last-stored)
11549 (when (or
11550 (and (equal goto 2)
11551 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11552 (prog1
11553 (setq it (list (or org-clock-heading "running clock")
11554 (buffer-file-name
11555 (marker-buffer org-clock-hd-marker))
11556 ""
11557 (marker-position org-clock-hd-marker)))
11558 (setq goto nil)))
11559 (setq it (or rfloc
11560 (let (heading-text)
11561 (save-excursion
11562 (unless goto
11563 (org-back-to-heading t)
11564 (setq heading-text
11565 (nth 4 (org-heading-components))))
11567 (org-refile-get-location
11568 (cond (goto "Goto")
11569 (regionp (concat actionmsg " region to"))
11572 default-buffer
11573 (and (not (equal '(4) goto))
11574 org-refile-allow-creating-parent-nodes)
11575 goto))))))
11576 (setq file (nth 1 it)
11577 re (nth 2 it)
11578 pos (nth 3 it))
11579 (if (and (not goto)
11580 pos
11581 (equal (buffer-file-name) file)
11582 (if regionp
11583 (and (>= pos region-start)
11584 (<= pos region-end))
11585 (and (>= pos (point))
11586 (< pos (save-excursion
11587 (org-end-of-subtree t t))))))
11588 (error "Cannot refile to position inside the tree or region"))
11590 (setq nbuf (or (find-buffer-visiting file)
11591 (find-file-noselect file)))
11592 (if (and goto (not (equal goto 3)))
11593 (progn
11594 (org-pop-to-buffer-same-window nbuf)
11595 (goto-char pos)
11596 (org-show-context 'org-goto))
11597 (if regionp
11598 (progn
11599 (org-kill-new (buffer-substring region-start region-end))
11600 (org-save-markers-in-region region-start region-end))
11601 (org-copy-subtree 1 nil t))
11602 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11603 (find-file-noselect file)))
11604 (setq reversed (org-notes-order-reversed-p))
11605 (save-excursion
11606 (save-restriction
11607 (widen)
11608 (if pos
11609 (progn
11610 (goto-char pos)
11611 (looking-at org-outline-regexp)
11612 (setq level (org-get-valid-level (funcall outline-level) 1))
11613 (goto-char
11614 (if reversed
11615 (or (outline-next-heading) (point-max))
11616 (or (save-excursion (org-get-next-sibling))
11617 (org-end-of-subtree t t)
11618 (point-max)))))
11619 (setq level 1)
11620 (if (not reversed)
11621 (goto-char (point-max))
11622 (goto-char (point-min))
11623 (or (outline-next-heading) (goto-char (point-max)))))
11624 (if (not (bolp)) (newline))
11625 (org-paste-subtree level)
11626 (when org-log-refile
11627 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11628 (unless (eq org-log-refile 'note)
11629 (save-excursion (org-add-log-note))))
11630 (and org-auto-align-tags
11631 (let ((org-loop-over-headlines-in-active-region nil))
11632 (org-set-tags nil t)))
11633 (let ((bookmark-name (plist-get org-bookmark-names-plist
11634 :last-refile)))
11635 (when bookmark-name
11636 (with-demoted-errors
11637 (bookmark-set bookmark-name))))
11638 ;; If we are refiling for capture, make sure that the
11639 ;; last-capture pointers point here
11640 (when (org-bound-and-true-p org-refile-for-capture)
11641 (let ((bookmark-name (plist-get org-bookmark-names-plist
11642 :last-capture-marker)))
11643 (when bookmark-name
11644 (with-demoted-errors
11645 (bookmark-set bookmark-name))))
11646 (move-marker org-capture-last-stored-marker (point)))
11647 (if (fboundp 'deactivate-mark) (deactivate-mark))
11648 (run-hooks 'org-after-refile-insert-hook))))
11649 (unless org-refile-keep
11650 (if regionp
11651 (delete-region (point) (+ (point) (- region-end region-start)))
11652 (delete-region
11653 (and (org-back-to-heading t) (point))
11654 (min (buffer-size) (org-end-of-subtree t t) (point)))))
11655 (when (featurep 'org-inlinetask)
11656 (org-inlinetask-remove-END-maybe))
11657 (setq org-markers-to-move nil)
11660 (defun org-refile-goto-last-stored ()
11661 "Go to the location where the last refile was stored."
11662 (interactive)
11663 (bookmark-jump "org-refile-last-stored")
11664 (message "This is the location of the last refile"))
11666 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11667 no-exclude)
11668 "Prompt the user for a refile location, using PROMPT.
11669 PROMPT should not be suffixed with a colon and a space, because
11670 this function appends the default value from
11671 `org-refile-history' automatically, if that is not empty.
11672 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11673 this is used for the GOTO interface."
11674 (let ((org-refile-targets org-refile-targets)
11675 (org-refile-use-outline-path org-refile-use-outline-path)
11676 excluded-entries)
11677 (when (and (derived-mode-p 'org-mode)
11678 (not org-refile-use-cache)
11679 (not no-exclude))
11680 (org-map-tree
11681 (lambda()
11682 (setq excluded-entries
11683 (append excluded-entries (list (org-get-heading t t)))))))
11684 (setq org-refile-target-table
11685 (org-refile-get-targets default-buffer excluded-entries)))
11686 (unless org-refile-target-table
11687 (user-error "No refile targets"))
11688 (let* ((cbuf (current-buffer))
11689 (partial-completion-mode nil)
11690 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11691 (cfunc (if (and org-refile-use-outline-path
11692 org-outline-path-complete-in-steps)
11693 'org-olpath-completing-read
11694 'org-icompleting-read))
11695 (extra (if org-refile-use-outline-path "/" ""))
11696 (cbnex (concat (buffer-name) extra))
11697 (filename (and cfn (expand-file-name cfn)))
11698 (tbl (mapcar
11699 (lambda (x)
11700 (if (and (not (member org-refile-use-outline-path
11701 '(file full-file-path)))
11702 (not (equal filename (nth 1 x))))
11703 (cons (concat (car x) extra " ("
11704 (file-name-nondirectory (nth 1 x)) ")")
11705 (cdr x))
11706 (cons (concat (car x) extra) (cdr x))))
11707 org-refile-target-table))
11708 (completion-ignore-case t)
11709 cdef
11710 (prompt (concat prompt
11711 (or (and (car org-refile-history)
11712 (concat " (default " (car org-refile-history) ")"))
11713 (and (assoc cbnex tbl) (setq cdef cbnex)
11714 (concat " (default " cbnex ")"))) ": "))
11715 pa answ parent-target child parent old-hist)
11716 (setq old-hist org-refile-history)
11717 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11718 nil 'org-refile-history (or cdef (car org-refile-history))))
11719 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11720 (org-refile-check-position pa)
11721 (if pa
11722 (progn
11723 (when (or (not org-refile-history)
11724 (not (eq old-hist org-refile-history))
11725 (not (equal (car pa) (car org-refile-history))))
11726 (setq org-refile-history
11727 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11728 org-refile-history
11729 (cdr org-refile-history))))
11730 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11731 (pop org-refile-history)))
11732 pa)
11734 (progn
11735 (setq parent (match-string 1 answ)
11736 child (match-string 2 answ))
11737 (setq parent-target (or (assoc parent tbl)
11738 (assoc (concat parent "/") tbl)))
11739 (when (and parent-target
11740 (or (eq new-nodes t)
11741 (and (eq new-nodes 'confirm)
11743 child)))))
11744 (org-refile-new-child parent-target child)))
11745 (user-error "Invalid target location")))))
11747 (declare-function org-string-nw-p "org-macs" (s))
11748 (defun org-refile-check-position (refile-pointer)
11749 "Check if the refile pointer matches the headline to which it points."
11750 (let* ((file (nth 1 refile-pointer))
11751 (re (nth 2 refile-pointer))
11752 (pos (nth 3 refile-pointer))
11753 buffer)
11754 (if (and (not (markerp pos)) (not file))
11755 (user-error "Please save the buffer to a file before refiling")
11756 (when (org-string-nw-p re)
11757 (setq buffer (if (markerp pos)
11758 (marker-buffer pos)
11759 (or (find-buffer-visiting file)
11760 (find-file-noselect file))))
11761 (with-current-buffer buffer
11762 (save-excursion
11763 (save-restriction
11764 (widen)
11765 (goto-char pos)
11766 (beginning-of-line 1)
11767 (unless (org-looking-at-p re)
11768 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11770 (defun org-refile-new-child (parent-target child)
11771 "Use refile target PARENT-TARGET to add new CHILD below it."
11772 (unless parent-target
11773 (error "Cannot find parent for new node"))
11774 (let ((file (nth 1 parent-target))
11775 (pos (nth 3 parent-target))
11776 level)
11777 (with-current-buffer (or (find-buffer-visiting file)
11778 (find-file-noselect file))
11779 (save-excursion
11780 (save-restriction
11781 (widen)
11782 (if pos
11783 (goto-char pos)
11784 (goto-char (point-max))
11785 (if (not (bolp)) (newline)))
11786 (when (looking-at org-outline-regexp)
11787 (setq level (funcall outline-level))
11788 (org-end-of-subtree t t))
11789 (org-back-over-empty-lines)
11791 (if pos (org-get-valid-level level 1) 1) ?*)
11793 (beginning-of-line 0)
11794 (list (concat (car parent-target) "/" child) file "" (point)))))))
11796 (defun org-olpath-completing-read (prompt collection &rest args)
11797 "Read an outline path like a file name."
11798 (let ((thetable collection)
11799 (org-completion-use-ido nil) ; does not work with ido.
11800 (org-completion-use-iswitchb nil)) ; or iswitchb
11801 (apply
11802 'org-icompleting-read prompt
11803 (lambda (string predicate &optional flag)
11804 (let (rtn r f (l (length string)))
11805 (cond
11806 ((eq flag nil)
11807 ;; try completion
11808 (try-completion string thetable))
11809 ((eq flag t)
11810 ;; all-completions
11811 (setq rtn (all-completions string thetable predicate))
11812 (mapcar
11813 (lambda (x)
11814 (setq r (substring x l))
11815 (if (string-match " ([^)]*)$" x)
11816 (setq f (match-string 0 x))
11817 (setq f ""))
11818 (if (string-match "/" r)
11819 (concat string (substring r 0 (match-end 0)) f)
11820 x))
11821 rtn))
11822 ((eq flag 'lambda)
11823 ;; exact match?
11824 (assoc string thetable)))))
11825 args)))
11827 ;;;; Dynamic blocks
11829 (defun org-find-dblock (name)
11830 "Find the first dynamic block with name NAME in the buffer.
11831 If not found, stay at current position and return nil."
11832 (let ((case-fold-search t) pos)
11833 (save-excursion
11834 (goto-char (point-min))
11835 (setq pos (and (re-search-forward
11837 (match-beginning 0))))
11838 (if pos (goto-char pos))
11839 pos))
11841 (defconst org-dblock-start-re
11843 "Matches the start line of a dynamic block, with parameters.")
11846 "Matches the end of a dynamic block.")
11848 (defun org-create-dblock (plist)
11849 "Create a dynamic block section, with parameters taken from PLIST.
11850 PLIST must contain a :name entry which is used as name of the block."
11852 (end-of-line 1)
11853 (newline))
11854 (let ((col (current-column))
11855 (name (plist-get plist :name)))
11856 (insert "#+BEGIN: " name)
11857 (while plist
11858 (if (eq (car plist) :name)
11859 (setq plist (cddr plist))
11860 (insert " " (prin1-to-string (pop plist)))))
11862 (beginning-of-line -2)))
11864 (defun org-prepare-dblock ()
11865 "Prepare dynamic block for refresh.
11866 This empties the block, puts the cursor at the insert position and returns
11867 the property list including an extra property :name with the block name."
11868 (unless (looking-at org-dblock-start-re)
11869 (user-error "Not at a dynamic block"))
11870 (let* ((begdel (1+ (match-end 0)))
11871 (name (org-no-properties (match-string 1)))
11872 (params (append (list :name name)
11873 (read (concat "(" (match-string 3) ")")))))
11874 (save-excursion
11875 (beginning-of-line 1)
11877 (setq params (plist-put params :indentation-column (current-column))))
11878 (unless (re-search-forward org-dblock-end-re nil t)
11879 (error "Dynamic block not terminated"))
11880 (setq params
11881 (append params
11882 (list :content (buffer-substring
11883 begdel (match-beginning 0)))))
11884 (delete-region begdel (match-beginning 0))
11885 (goto-char begdel)
11886 (open-line 1)
11887 params))
11889 (defun org-map-dblocks (&optional command)
11890 "Apply COMMAND to all dynamic blocks in the current buffer.
11891 If COMMAND is not given, use `org-update-dblock'."
11892 (let ((cmd (or command 'org-update-dblock)))
11893 (save-excursion
11894 (goto-char (point-min))
11895 (while (re-search-forward org-dblock-start-re nil t)
11896 (goto-char (match-beginning 0))
11897 (save-excursion
11898 (condition-case nil
11899 (funcall cmd)
11900 (error (message "Error during update of dynamic block"))))
11901 (unless (re-search-forward org-dblock-end-re nil t)
11902 (error "Dynamic block not terminated"))))))
11904 (defun org-dblock-update (&optional arg)
11905 "User command for updating dynamic blocks.
11906 Update the dynamic block at point. With prefix ARG, update all dynamic
11907 blocks in the buffer."
11908 (interactive "P")
11909 (if arg
11910 (org-update-all-dblocks)
11911 (or (looking-at org-dblock-start-re)
11912 (org-beginning-of-dblock))
11913 (org-update-dblock)))
11915 (defun org-update-dblock ()
11916 "Update the dynamic block at point.
11917 This means to empty the block, parse for parameters and then call
11918 the correct writing function."
11919 (interactive)
11920 (save-window-excursion
11921 (let* ((pos (point))
11922 (line (org-current-line))
11923 (params (org-prepare-dblock))
11924 (name (plist-get params :name))
11925 (indent (plist-get params :indentation-column))
11926 (cmd (intern (concat "org-dblock-write:" name))))
11927 (message "Updating dynamic block `%s' at line %d..." name line)
11928 (funcall cmd params)
11929 (message "Updating dynamic block `%s' at line %d...done" name line)
11930 (goto-char pos)
11931 (when (and indent (> indent 0))
11932 (setq indent (make-string indent ?\ ))
11933 (save-excursion
11934 (org-beginning-of-dblock)
11935 (forward-line 1)
11936 (while (not (looking-at org-dblock-end-re))
11937 (insert indent)
11938 (beginning-of-line 2))
11939 (when (looking-at org-dblock-end-re)
11941 (replace-match ""))
11942 (insert indent)))))))
11944 (defun org-beginning-of-dblock ()
11945 "Find the beginning of the dynamic block at point.
11946 Error if there is no such block at point."
11947 (let ((pos (point))
11948 beg)
11949 (end-of-line 1)
11950 (if (and (re-search-backward org-dblock-start-re nil t)
11951 (setq beg (match-beginning 0))
11952 (re-search-forward org-dblock-end-re nil t)
11953 (> (match-end 0) pos))
11954 (goto-char beg)
11955 (goto-char pos)
11956 (error "Not in a dynamic block"))))
11958 (defun org-update-all-dblocks ()
11959 "Update all dynamic blocks in the buffer.
11960 This function can be used in a hook."
11961 (interactive)
11962 (when (derived-mode-p 'org-mode)
11963 (org-map-dblocks 'org-update-dblock)))
11966 ;;;; Completion
11968 (declare-function org-export-backend-name "org-export" (cl-x))
11969 (declare-function org-export-backend-options "org-export" (cl-x))
11970 (defun org-get-export-keywords ()
11971 "Return a list of all currently understood export keywords.
11972 Export keywords include options, block names, attributes and
11973 keywords relative to each registered export back-end."
11974 (let (keywords)
11975 (dolist (backend
11976 (org-bound-and-true-p org-export--registered-backends)
11977 (delq nil keywords))
11978 ;; Back-end name (for keywords, like #+LATEX:)
11979 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
11980 (dolist (option-entry (org-export-backend-options backend))
11981 ;; Back-end options.
11982 (push (nth 1 option-entry) keywords)))))
11984 (defconst org-options-keywords
11985 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11986 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11987 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11988 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11989 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11991 (defcustom org-structure-template-alist
12005 ("A" "#+ASCII: " "")
12006 ("i" "#+INDEX: ?" "#+INDEX: ?")
12007 ("I" "#+INCLUDE: %file ?"
12009 "Structure completion elements.
12010 This is a list of abbreviation keys and values. The value gets inserted
12011 if you type `<' followed by the key and then press the completion key,
12012 usually `M-TAB'. %file will be replaced by a file name after prompting
12013 for the file using completion. The cursor will be placed at the position
12014 of the `?` in the template.
12015 There are two templates for each key, the first uses the original Org syntax,
12016 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12017 the default when the /org-mtags.el/ module has been loaded. See also the
12018 variable `org-mtags-prefer-muse-templates'."
12019 :group 'org-completion
12020 :type '(repeat
12021 (list
12022 (string :tag "Key")
12023 (string :tag "Template")
12024 (string :tag "Muse Template"))))
12026 (defun org-try-structure-completion ()
12027 "Try to complete a structure template before point.
12029 expands them."
12030 (let ((l (buffer-substring (point-at-bol) (point)))
12031 a)
12034 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12035 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12036 (match-beginning 1)) a)
12037 t)))
12039 (defun org-complete-expand-structure-template (start cell)
12040 "Expand a structure template."
12041 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12042 (rpl (nth (if musep 2 1) cell))
12043 (ind ""))
12044 (delete-region start (point))
12046 (cond
12047 ((bolp))
12049 (setq ind (buffer-substring (point-at-bol) (point))))
12050 (t (newline))))
12051 (setq start (point))
12052 (if (string-match "%file" rpl)
12053 (setq rpl (replace-match
12054 (concat
12056 (save-match-data
12057 (abbreviate-file-name (read-file-name "Include file: ")))
12059 t t rpl)))
12062 (insert rpl)
12065 ;;;; TODO, DEADLINE, Comments
12067 (defun org-toggle-comment ()
12068 "Change the COMMENT state of an entry."
12069 (interactive)
12070 (save-excursion
12071 (org-back-to-heading)
12072 (let (case-fold-search)
12073 (cond
12074 ((looking-at (format org-heading-keyword-regexp-format
12075 org-comment-string))
12076 (goto-char (match-end 1))
12077 (looking-at (concat " +" org-comment-string))
12078 (replace-match "" t t)
12079 (when (eolp) (insert " ")))
12080 ((looking-at org-outline-regexp)
12081 (goto-char (match-end 0))
12082 (insert org-comment-string " "))))))
12084 (defvar org-last-todo-state-is-todo nil
12085 "This is non-nil when the last TODO state change led to a TODO state.
12086 If the last change removed the TODO tag or switched to DONE, then
12087 this is nil.")
12089 (defvar org-setting-tags nil) ; dynamically skipped
12091 (defvar org-todo-setup-filter-hook nil
12092 "Hook for functions that pre-filter todo specs.
12093 Each function takes a todo spec and returns either nil or the spec
12094 transformed into canonical form." )
12096 (defvar org-todo-get-default-hook nil
12097 "Hook for functions that get a default item for todo.
12098 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12099 nil or a string to be used for the todo mark." )
12101 (defvar org-agenda-headline-snapshot-before-repeat)
12103 (defun org-current-effective-time ()
12104 "Return current time adjusted for `org-extend-today-until' variable."
12105 (let* ((ct (org-current-time))
12106 (dct (decode-time ct))
12107 (ct1
12108 (cond
12109 (org-use-last-clock-out-time-as-effective-time
12110 (or (org-clock-get-last-clock-out-time) ct))
12111 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12112 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12113 (t ct))))
12114 ct1))
12116 (defun org-todo-yesterday (&optional arg)
12117 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12118 (interactive "P")
12119 (if (eq major-mode 'org-agenda-mode)
12120 (apply 'org-agenda-todo-yesterday arg)
12121 (let* ((hour (third (decode-time
12122 (org-current-time))))
12123 (org-extend-today-until (1+ hour)))
12124 (org-todo arg))))
12126 (defvar org-block-entry-blocking ""
12127 "First entry preventing the TODO state change.")
12129 (defun org-todo (&optional arg)
12130 "Change the TODO state of an item.
12131 The state of an item is given by a keyword at the start of the heading,
12132 like
12133 *** TODO Write paper
12134 *** DONE Call mom
12136 The different keywords are specified in the variable `org-todo-keywords'.
12138 So for this example: when the item starts with TODO, it is changed to DONE.
12139 When it starts with DONE, the DONE is removed. And when neither TODO nor
12140 DONE are present, add TODO at the beginning of the heading.
12143 state.
12144 With numeric prefix arg, switch to that state.
12146 keywords (nextset).
12148 With a numeric prefix arg of 0, inhibit note taking for the change.
12150 For calling through lisp, arg is also interpreted in the following way:
12151 'none -> empty state
12153 'done -> switch to DONE
12154 'nextset -> switch to the next set of keywords
12155 'previousset -> switch to the previous set of keywords
12157 really is a member of `org-todo-keywords'."
12158 (interactive "P")
12159 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12160 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12161 'region-start-level 'region))
12162 org-loop-over-headlines-in-active-region)
12163 (org-map-entries
12164 `(org-todo ,arg)
12165 org-loop-over-headlines-in-active-region
12166 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12167 (if (equal arg '(16)) (setq arg 'nextset))
12168 (let ((org-blocker-hook org-blocker-hook)
12169 commentp
12170 case-fold-search)
12171 (when (equal arg '(64))
12172 (setq arg nil org-blocker-hook nil))
12173 (when (and org-blocker-hook
12174 (or org-inhibit-blocking
12175 (org-entry-get nil "NOBLOCKING")))
12176 (setq org-blocker-hook nil))
12177 (save-excursion
12178 (catch 'exit
12179 (org-back-to-heading t)
12181 (org-toggle-comment)
12182 (setq commentp t))
12183 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12186 (let* ((match-data (match-data))
12187 (startpos (point-at-bol))
12188 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12189 (org-log-done org-log-done)
12190 (org-log-repeat org-log-repeat)
12191 (org-todo-log-states org-todo-log-states)
12192 (org-inhibit-logging
12193 (if (equal arg 0)
12194 (progn (setq arg nil) 'note) org-inhibit-logging))
12195 (this (match-string 1))
12196 (hl-pos (match-beginning 0))
12197 (head (org-get-todo-sequence-head this))
12198 (ass (assoc head org-todo-kwd-alist))
12199 (interpret (nth 1 ass))
12200 (done-word (nth 3 ass))
12201 (final-done-word (nth 4 ass))
12202 (org-last-state (or this ""))
12203 (completion-ignore-case t)
12204 (member (member this org-todo-keywords-1))
12205 (tail (cdr member))
12206 (org-state (cond
12207 ((and org-todo-key-trigger
12208 (or (and (equal arg '(4))
12209 (eq org-use-fast-todo-selection 'prefix))
12210 (and (not arg) org-use-fast-todo-selection
12211 (not (eq org-use-fast-todo-selection
12212 'prefix)))))
12213 ;; Use fast selection
12214 (org-fast-todo-selection))
12215 ((and (equal arg '(4))
12216 (or (not org-use-fast-todo-selection)
12217 (not org-todo-key-trigger)))
12218 ;; Read a state with completion
12219 (org-icompleting-read
12220 "State: " (mapcar 'list org-todo-keywords-1)
12221 nil t))
12222 ((eq arg 'right)
12223 (if this
12224 (if tail (car tail) nil)
12225 (car org-todo-keywords-1)))
12226 ((eq arg 'left)
12227 (if (equal member org-todo-keywords-1)
12228 nil
12229 (if this
12230 (nth (- (length org-todo-keywords-1)
12231 (length tail) 2)
12232 org-todo-keywords-1)
12233 (org-last org-todo-keywords-1))))
12234 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12235 (setq arg nil))) ; hack to fall back to cycling
12236 (arg
12237 ;; user or caller requests a specific state
12238 (cond
12239 ((equal arg "") nil)
12240 ((eq arg 'none) nil)
12241 ((eq arg 'done) (or done-word (car org-done-keywords)))
12242 ((eq arg 'nextset)
12243 (or (car (cdr (member head org-todo-heads)))
12244 (car org-todo-heads)))
12245 ((eq arg 'previousset)
12246 (let ((org-todo-heads (reverse org-todo-heads)))
12247 (or (car (cdr (member head org-todo-heads)))
12248 (car org-todo-heads))))
12249 ((car (member arg org-todo-keywords-1)))
12250 ((stringp arg)
12251 (user-error "State `%s' not valid in this file" arg))
12252 ((nth (1- (prefix-numeric-value arg))
12253 org-todo-keywords-1))))
12254 ((null member) (or head (car org-todo-keywords-1)))
12255 ((equal this final-done-word) nil) ;; -> make empty
12256 ((null tail) nil) ;; -> first entry
12257 ((memq interpret '(type priority))
12258 (if (eq this-command last-command)
12259 (car tail)
12260 (if (> (length tail) 0)
12261 (or done-word (car org-done-keywords))
12262 nil)))
12263 (t
12264 (car tail))))
12265 (org-state (or
12266 (run-hook-with-args-until-success
12267 'org-todo-get-default-hook org-state org-last-state)
12268 org-state))
12269 (next (if org-state (concat " " org-state " ") " "))
12270 (change-plist (list :type 'todo-state-change :from this :to org-state
12271 :position startpos))
12272 dolog now-done-p)
12273 (when org-blocker-hook
12274 (setq org-last-todo-state-is-todo
12275 (not (member this org-done-keywords)))
12276 (unless (save-excursion
12277 (save-match-data
12278 (org-with-wide-buffer
12279 (run-hook-with-args-until-failure
12280 'org-blocker-hook change-plist))))
12281 (if (org-called-interactively-p 'interactive)
12283 this org-state org-block-entry-blocking)
12284 ;; fail silently
12286 this org-state org-block-entry-blocking)
12287 (throw 'exit nil))))
12288 (store-match-data match-data)
12289 (replace-match next t t)
12290 (unless (pos-visible-in-window-p hl-pos)
12291 (message "TODO state changed to %s" (org-trim next)))
12292 (unless head
12293 (setq head (org-get-todo-sequence-head org-state)
12294 ass (assoc head org-todo-kwd-alist)
12295 interpret (nth 1 ass)
12296 done-word (nth 3 ass)
12297 final-done-word (nth 4 ass)))
12298 (when (memq arg '(nextset previousset))
12299 (message "Keyword-Set %d/%d: %s"
12300 (- (length org-todo-sets) -1
12301 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12302 (length org-todo-sets)
12303 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12304 (setq org-last-todo-state-is-todo
12305 (not (member org-state org-done-keywords)))
12306 (setq now-done-p (and (member org-state org-done-keywords)
12307 (not (member this org-done-keywords))))
12308 (and logging (org-local-logging logging))
12309 (when (and (or org-todo-log-states org-log-done)
12310 (not (eq org-inhibit-logging t))
12311 (not (memq arg '(nextset previousset))))
12312 ;; we need to look at recording a time and note
12313 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12314 (nth 2 (assoc this org-todo-log-states))))
12315 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12316 (setq dolog 'time))
12317 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12318 (and org-state
12319 (member org-state org-not-done-keywords)
12320 (not (member this org-not-done-keywords))))
12321 ;; This is now a todo state and was not one before
12322 ;; If there was a CLOSED time stamp, get rid of it.
12323 (org-add-planning-info nil nil 'closed))
12324 (when (and now-done-p org-log-done)
12325 ;; It is now done, and it was not done before
12326 (org-add-planning-info 'closed (org-current-effective-time))
12327 (if (and (not dolog) (eq 'note org-log-done))
12328 (org-add-log-setup 'done org-state this 'findpos 'note)))
12329 (when (and org-state dolog)
12330 ;; This is a non-nil state, and we need to log it
12331 (org-add-log-setup 'state org-state this 'findpos dolog)))
12332 ;; Fixup tag positioning
12333 (org-todo-trigger-tag-changes org-state)
12334 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12335 (when org-provide-todo-statistics
12336 (org-update-parent-todo-statistics))
12337 (run-hooks 'org-after-todo-state-change-hook)
12338 (if (and arg (not (member org-state org-done-keywords)))
12339 (setq head (org-get-todo-sequence-head org-state)))
12340 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12341 ;; Do we need to trigger a repeat?
12342 (when now-done-p
12343 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12344 ;; This is for the agenda, take a snapshot of the headline.
12345 (save-match-data
12346 (setq org-agenda-headline-snapshot-before-repeat
12347 (org-get-heading))))
12348 (org-auto-repeat-maybe org-state))
12349 ;; Fixup cursor location if close to the keyword
12350 (if (and (outline-on-heading-p)
12351 (not (bolp))
12352 (save-excursion (beginning-of-line 1)
12353 (looking-at org-todo-line-regexp))
12354 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12355 (progn
12356 (goto-char (or (match-end 2) (match-end 1)))
12357 (and (looking-at " ") (just-one-space))))
12358 (when org-trigger-hook
12359 (save-excursion
12360 (run-hook-with-args 'org-trigger-hook change-plist)))
12361 (when commentp (org-toggle-comment))))))))
12363 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12364 "Block turning an entry into a TODO, using the hierarchy.
12365 This checks whether the current task should be blocked from state
12366 changes. Such blocking occurs when:
12368 1. The task has children which are not all in a completed state.
12370 2. A task has a parent with the property :ORDERED:, and there
12371 are siblings prior to the current task with incomplete
12372 status.
12374 3. The parent of the task is blocked because it has siblings that should
12375 be done first, or is child of a block grandparent TODO entry."
12377 (if (not org-enforce-todo-dependencies)
12378 t ; if locally turned off don't block
12379 (catch 'dont-block
12380 ;; If this is not a todo state change, or if this entry is already DONE,
12381 ;; do not block
12382 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12383 (member (plist-get change-plist :from)
12384 (cons 'done org-done-keywords))
12385 (member (plist-get change-plist :to)
12386 (cons 'todo org-not-done-keywords))
12387 (not (plist-get change-plist :to)))
12388 (throw 'dont-block t))
12389 ;; If this task has children, and any are undone, it's blocked
12390 (save-excursion
12391 (org-back-to-heading t)
12392 (let ((this-level (funcall outline-level)))
12393 (outline-next-heading)
12394 (let ((child-level (funcall outline-level)))
12395 (while (and (not (eobp))
12396 (> child-level this-level))
12397 ;; this todo has children, check whether they are all
12398 ;; completed
12399 (if (and (not (org-entry-is-done-p))
12400 (org-entry-is-todo-p))
12401 (progn (setq org-block-entry-blocking (org-get-heading))
12402 (throw 'dont-block nil)))
12403 (outline-next-heading)
12404 (setq child-level (funcall outline-level))))))
12405 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12406 ;; any previous siblings are undone, it's blocked
12407 (save-excursion
12408 (org-back-to-heading t)
12409 (let* ((pos (point))
12410 (parent-pos (and (org-up-heading-safe) (point))))
12411 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12412 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12413 (forward-line 1)
12414 (re-search-forward org-not-done-heading-regexp pos t))
12415 (setq org-block-entry-blocking (match-string 0))
12416 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12417 ;; Search further up the hierarchy, to see if an ancestor is blocked
12418 (while t
12419 (goto-char parent-pos)
12420 (if (not (looking-at org-not-done-heading-regexp))
12421 (throw 'dont-block t)) ; do not block, parent is not a TODO
12422 (setq pos (point))
12423 (setq parent-pos (and (org-up-heading-safe) (point)))
12424 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12425 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12426 (forward-line 1)
12427 (re-search-forward org-not-done-heading-regexp pos t)
12428 (setq org-block-entry-blocking (org-get-heading)))
12429 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12431 (defcustom org-track-ordered-property-with-tag nil
12432 "Should the ORDERED property also be shown as a tag?
12433 The ORDERED property decides if an entry should require subtasks to be
12434 completed in sequence. Since a property is not very visible, setting
12435 this option means that toggling the ORDERED property with the command
12436 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12437 not relevant for the behavior, but it makes things more visible.
12439 Note that toggling the tag with tags commands will not change the property
12440 and therefore not influence behavior!
12442 This can be t, meaning the tag ORDERED should be used, It can also be a
12443 string to select a different tag for this task."
12444 :group 'org-todo
12445 :type '(choice
12446 (const :tag "No tracking" nil)
12447 (const :tag "Track with ORDERED tag" t)
12448 (string :tag "Use other tag")))
12450 (defun org-toggle-ordered-property ()
12451 "Toggle the ORDERED property of the current entry.
12452 For better visibility, you can track the value of this property with a tag.
12453 See variable `org-track-ordered-property-with-tag'."
12454 (interactive)
12455 (let* ((t1 org-track-ordered-property-with-tag)
12456 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12457 (save-excursion
12458 (org-back-to-heading)
12459 (if (org-entry-get nil "ORDERED")
12460 (progn
12461 (org-delete-property "ORDERED" "PROPERTIES")
12462 (and tag (org-toggle-tag tag 'off))
12463 (message "Subtasks can be completed in arbitrary order"))
12464 (org-entry-put nil "ORDERED" "t")
12465 (and tag (org-toggle-tag tag 'on))
12466 (message "Subtasks must be completed in sequence")))))
12468 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12469 (defun org-block-todo-from-checkboxes (change-plist)
12470 "Block turning an entry into a TODO, using checkboxes.
12471 This checks whether the current task should be blocked from state
12472 changes because there are unchecked boxes in this entry."
12473 (if (not org-enforce-todo-checkbox-dependencies)
12474 t ; if locally turned off don't block
12475 (catch 'dont-block
12476 ;; If this is not a todo state change, or if this entry is already DONE,
12477 ;; do not block
12478 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12479 (member (plist-get change-plist :from)
12480 (cons 'done org-done-keywords))
12481 (member (plist-get change-plist :to)
12482 (cons 'todo org-not-done-keywords))
12483 (not (plist-get change-plist :to)))
12484 (throw 'dont-block t))
12485 ;; If this task has checkboxes that are not checked, it's blocked
12486 (save-excursion
12487 (org-back-to-heading t)
12488 (let ((beg (point)) end)
12489 (outline-next-heading)
12490 (setq end (point))
12491 (goto-char beg)
12492 (if (org-list-search-forward
12493 (concat (org-item-beginning-re)
12496 end t)
12497 (progn
12498 (if (boundp 'org-blocked-by-checkboxes)
12499 (setq org-blocked-by-checkboxes t))
12500 (throw 'dont-block nil)))))
12501 t))) ; do not block
12503 (defun org-entry-blocked-p ()
12504 "Is the current entry blocked?"
12505 (org-with-silent-modifications
12506 (if (org-entry-get nil "NOBLOCKING")
12507 nil ;; Never block this entry
12508 (not (run-hook-with-args-until-failure
12509 'org-blocker-hook
12510 (list :type 'todo-state-change
12511 :position (point)
12512 :from 'todo
12513 :to 'done))))))
12515 (defun org-update-statistics-cookies (all)
12516 "Update the statistics cookie, either from TODO or from checkboxes.
12517 This should be called with the cursor in a line with a statistics cookie."
12518 (interactive "P")
12519 (if all
12520 (progn
12521 (org-update-checkbox-count 'all)
12522 (org-map-entries 'org-update-parent-todo-statistics))
12523 (if (not (org-at-heading-p))
12524 (org-update-checkbox-count)
12525 (let ((pos (point-marker))
12526 end l1 l2)
12527 (ignore-errors (org-back-to-heading t))
12528 (if (not (org-at-heading-p))
12529 (org-update-checkbox-count)
12530 (setq l1 (org-outline-level))
12531 (setq end (save-excursion
12532 (outline-next-heading)
12533 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12534 (point)))
12535 (if (and (save-excursion
12536 (re-search-forward
12538 (not (save-excursion (re-search-forward
12540 (org-update-checkbox-count)
12541 (if (and l2 (> l2 l1))
12542 (progn
12543 (goto-char end)
12544 (org-update-parent-todo-statistics))
12545 (goto-char pos)
12546 (beginning-of-line 1)
12547 (while (re-search-forward
12549 (point-at-eol) t)
12550 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12551 (goto-char pos)
12552 (move-marker pos nil)))))
12554 (defvar org-entry-property-inherited-from) ;; defined below
12555 (defun org-update-parent-todo-statistics ()
12556 "Update any statistics cookie in the parent of the current headline.
12557 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12558 the entire subtree and this will travel up the hierarchy and update
12559 statistics everywhere."
12560 (let* ((prop (save-excursion (org-up-heading-safe)
12561 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12562 (recursive (or (not org-hierarchical-todo-statistics)
12564 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12565 0))
12566 (first t)
12568 level ltoggle l1 new ndel
12569 (cnt-all 0) (cnt-done 0) is-percent kwd
12570 checkbox-beg ov ovs ove cookie-present)
12571 (catch 'exit
12572 (save-excursion
12573 (beginning-of-line 1)
12574 (setq ltoggle (funcall outline-level))
12575 ;; Three situations are to consider:
12577 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12578 ;; to the top-level ancestor on the headline;
12580 ;; 2. If parent has "recursive" property, repeat up to the
12581 ;; headline setting that property, taking inheritance into
12582 ;; account;
12584 ;; 3. Else, move up to direct parent and proceed only once.
12585 (while (and (setq level (org-up-heading-safe))
12586 (or recursive first)
12587 (>= (point) lim))
12588 (setq first nil cookie-present nil)
12589 (unless (and level
12590 (not (string-match
12592 (downcase (or (org-entry-get nil "COOKIE_DATA")
12593 "")))))
12594 (throw 'exit nil))
12595 (while (re-search-forward box-re (point-at-eol) t)
12596 (setq cnt-all 0 cnt-done 0 cookie-present t)
12597 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12598 (save-match-data
12599 (unless (outline-next-heading) (throw 'exit nil))
12600 (while (and (looking-at org-complex-heading-regexp)
12601 (> (setq l1 (length (match-string 1))) level))
12602 (setq kwd (and (or recursive (= l1 ltoggle))
12603 (match-string 2)))
12604 (if (or (eq org-provide-todo-statistics 'all-headlines)
12605 (and (listp org-provide-todo-statistics)
12606 (or (member kwd org-provide-todo-statistics)
12607 (member kwd org-done-keywords))))
12608 (setq cnt-all (1+ cnt-all))
12609 (if (eq org-provide-todo-statistics t)
12610 (and kwd (setq cnt-all (1+ cnt-all)))))
12611 (and (member kwd org-done-keywords)
12612 (setq cnt-done (1+ cnt-done)))
12613 (outline-next-heading)))
12614 (setq new
12615 (if is-percent
12616 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12617 (format "[%d/%d]" cnt-done cnt-all))
12618 ndel (- (match-end 0) checkbox-beg))
12619 ;; handle overlays when updating cookie from column view
12620 (when (setq ov (car (overlays-at checkbox-beg)))
12621 (setq ovs (overlay-start ov) ove (overlay-end ov))
12622 (delete-overlay ov))
12623 (goto-char checkbox-beg)
12624 (insert new)
12625 (delete-region (point) (+ (point) ndel))
12626 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12627 (when ov (move-overlay ov ovs ove)))
12628 (when cookie-present
12629 (run-hook-with-args 'org-after-todo-statistics-hook
12630 cnt-done (- cnt-all cnt-done))))))
12631 (run-hooks 'org-todo-statistics-hook)))
12633 (defvar org-after-todo-statistics-hook nil
12634 "Hook that is called after a TODO statistics cookie has been updated.
12635 Each function is called with two arguments: the number of not-done entries
12636 and the number of done entries.
12638 For example, the following function, when added to this hook, will switch
12639 an entry to DONE when all children are done, and back to TODO when new
12640 entries are set to a TODO status. Note that this hook is only called
12641 when there is a statistics cookie in the headline!
12643 (defun org-summary-todo (n-done n-not-done)
12645 (let (org-log-done org-log-states) ; turn off logging
12647 ")
12649 (defvar org-todo-statistics-hook nil
12650 "Hook that is run whenever Org thinks TODO statistics should be updated.
12651 This hook runs even if there is no statistics cookie present, in which case
12652 `org-after-todo-statistics-hook' would not run.")
12654 (defun org-todo-trigger-tag-changes (state)
12655 "Apply the changes defined in `org-todo-state-tags-triggers'."
12656 (let ((l org-todo-state-tags-triggers)
12657 changes)
12658 (when (or (not state) (equal state ""))
12659 (setq changes (append changes (cdr (assoc "" l)))))
12660 (when (and (stringp state) (> (length state) 0))
12661 (setq changes (append changes (cdr (assoc state l)))))
12662 (when (member state org-not-done-keywords)
12663 (setq changes (append changes (cdr (assoc 'todo l)))))
12664 (when (member state org-done-keywords)
12665 (setq changes (append changes (cdr (assoc 'done l)))))
12666 (dolist (c changes)
12667 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12669 (defun org-local-logging (value)
12670 "Get logging settings from a property VALUE."
12671 (let* (words w a)
12672 ;; directly set the variables, they are already local.
12673 (setq org-log-done nil
12674 org-log-repeat nil
12675 org-todo-log-states nil)
12676 (setq words (org-split-string value))
12677 (while (setq w (pop words))
12678 (cond
12679 ((setq a (assoc w org-startup-options))
12680 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12681 (set (nth 1 a) (nth 2 a))))
12682 ((setq a (org-extract-log-state-settings w))
12683 (and (member (car a) org-todo-keywords-1)
12684 (push a org-todo-log-states)))))))
12686 (defun org-get-todo-sequence-head (kwd)
12687 "Return the head of the TODO sequence to which KWD belongs.
12688 If KWD is not set, check if there is a text property remembering the
12689 right sequence."
12690 (let (p)
12691 (cond
12692 ((not kwd)
12693 (or (get-text-property (point-at-bol) 'org-todo-head)
12694 (progn
12695 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12696 nil (point-at-eol)))
12697 (get-text-property p 'org-todo-head))))
12698 ((not (member kwd org-todo-keywords-1))
12699 (car org-todo-keywords-1))
12700 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12702 (defun org-fast-todo-selection ()
12703 "Fast TODO keyword selection with single keys.
12704 Returns the new TODO keyword, or nil if no state change should occur."
12705 (let* ((fulltable org-todo-key-alist)
12706 (done-keywords org-done-keywords) ;; needed for the faces.
12707 (maxlen (apply 'max (mapcar
12708 (lambda (x)
12709 (if (stringp (car x)) (string-width (car x)) 0))
12710 fulltable)))
12711 (expert nil)
12712 (fwidth (+ maxlen 3 1 3))
12713 (ncol (/ (- (window-width) 4) fwidth))
12714 tg cnt e c tbl
12715 groups ingroup)
12716 (save-excursion
12717 (save-window-excursion
12718 (if expert
12719 (set-buffer (get-buffer-create " *Org todo*"))
12720 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12721 (erase-buffer)
12722 (org-set-local 'org-done-keywords done-keywords)
12723 (setq tbl fulltable cnt 0)
12724 (while (setq e (pop tbl))
12725 (cond
12726 ((equal e '(:startgroup))
12727 (push '() groups) (setq ingroup t)
12728 (when (not (= cnt 0))
12729 (setq cnt 0)
12731 (insert "{ "))
12732 ((equal e '(:endgroup))
12733 (setq ingroup nil cnt 0)
12735 ((equal e '(:newline))
12736 (when (not (= cnt 0))
12737 (setq cnt 0)
12739 (setq e (car tbl))
12740 (while (equal (car tbl) '(:newline))
12742 (setq tbl (cdr tbl)))))
12743 (t
12744 (setq tg (car e) c (cdr e))
12745 (if ingroup (push tg (car groups)))
12746 (setq tg (org-add-props tg nil 'face
12747 (org-get-todo-face tg)))
12748 (if (and (= cnt 0) (not ingroup)) (insert " "))
12749 (insert "[" c "] " tg (make-string
12750 (- fwidth 4 (length tg)) ?\ ))
12751 (when (= (setq cnt (1+ cnt)) ncol)
12753 (if ingroup (insert " "))
12754 (setq cnt 0)))))
12756 (goto-char (point-min))
12757 (if (not expert) (org-fit-window-to-buffer))
12758 (message "[a-z..]:Set [SPC]:clear")
12759 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12760 (cond
12761 ((or (= c ?\C-g)
12762 (and (= c ?q) (not (rassoc c fulltable))))
12763 (setq quit-flag t))
12764 ((= c ?\ ) nil)
12765 ((setq e (rassoc c fulltable) tg (car e))
12766 tg)
12767 (t (setq quit-flag t)))))))
12769 (defun org-entry-is-todo-p ()
12770 (member (org-get-todo-state) org-not-done-keywords))
12772 (defun org-entry-is-done-p ()
12773 (member (org-get-todo-state) org-done-keywords))
12775 (defun org-get-todo-state ()
12776 "Return the TODO keyword of the current subtree."
12777 (save-excursion
12778 (org-back-to-heading t)
12779 (and (looking-at org-todo-line-regexp)
12780 (match-end 2)
12781 (match-string 2))))
12783 (defun org-at-date-range-p (&optional inactive-ok)
12784 "Is the cursor inside a date range?"
12785 (interactive)
12786 (save-excursion
12787 (catch 'exit
12788 (let ((pos (point)))
12790 (skip-chars-backward "<[")
12791 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12792 (>= (match-end 0) pos)
12793 (throw 'exit t))
12795 (skip-chars-backward "<[")
12796 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12797 (>= (match-end 0) pos)
12798 (throw 'exit t)))
12799 nil)))
12801 (defun org-get-repeat (&optional tagline)
12802 "Check if there is a deadline/schedule with repeater in this entry."
12803 (save-match-data
12804 (save-excursion
12805 (org-back-to-heading t)
12806 (and (re-search-forward (if tagline
12808 org-repeat-re)
12809 (org-entry-end-position) t)
12810 (match-string-no-properties 1)))))
12812 (defvar org-last-changed-timestamp)
12813 (defvar org-last-inserted-timestamp)
12814 (defvar org-log-post-message)
12815 (defvar org-log-note-purpose)
12816 (defvar org-log-note-how)
12817 (defvar org-log-note-extra)
12818 (defun org-auto-repeat-maybe (done-word)
12819 "Check if the current headline contains a repeated deadline/schedule.
12820 If yes, set TODO state back to what it was and change the base date
12821 of repeating deadline/scheduled time stamps to new date.
12822 This function is run automatically after each state change to a DONE state."
12823 ;; last-state is dynamically scoped into this function
12824 (let* ((repeat (org-get-repeat))
12825 (aa (assoc org-last-state org-todo-kwd-alist))
12826 (interpret (nth 1 aa))
12827 (head (nth 2 aa))
12828 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12829 (msg "Entry repeats: ")
12830 (org-log-done nil)
12831 (org-todo-log-states nil)
12832 re type n what ts time to-state)
12833 (when repeat
12834 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12835 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12836 org-todo-repeat-to-state))
12837 (unless (and to-state (member to-state org-todo-keywords-1))
12838 (setq to-state (if (eq interpret 'type) org-last-state head)))
12839 (org-todo to-state)
12840 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12841 (org-entry-put nil "LAST_REPEAT" (format-time-string
12842 (org-time-stamp-format t t))))
12843 (when org-log-repeat
12844 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12845 (memq 'org-add-log-note post-command-hook))
12846 ;; OK, we are already setup for some record
12847 (if (eq org-log-repeat 'note)
12848 ;; make sure we take a note, not only a time stamp
12849 (setq org-log-note-how 'note))
12850 ;; Set up for taking a record
12851 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12852 org-last-state
12853 'findpos org-log-repeat)))
12854 (org-back-to-heading t)
12855 (org-add-planning-info nil nil 'closed)
12859 (while (re-search-forward
12860 re (save-excursion (outline-next-heading) (point)) t)
12861 (setq type (if (match-end 1) org-scheduled-string
12862 (if (match-end 3) org-deadline-string "Plain:"))
12863 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12865 (setq n (string-to-number (match-string 2 ts))
12866 what (match-string 3 ts))
12867 (if (equal what "w") (setq n (* n 7) what "d"))
12869 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12870 ;; Preparation, see if we need to modify the start date for the change
12871 (when (match-end 1)
12872 (setq time (save-match-data (org-time-string-to-time ts)))
12873 (cond
12874 ((equal (match-string 1 ts) ".")
12875 ;; Shift starting date to today
12876 (org-timestamp-change
12877 (- (org-today) (time-to-days time))
12878 'day))
12879 ((equal (match-string 1 ts) "+")
12880 (let ((nshiftmax 10) (nshift 0))
12881 (while (or (= nshift 0)
12882 (<= (time-to-days time)
12883 (time-to-days (current-time))))
12884 (when (= (incf nshift) nshiftmax)
12885 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12886 (error "Abort")))
12887 (org-timestamp-change n (cdr (assoc what whata)))
12888 (org-at-timestamp-p t)
12889 (setq ts (match-string 1))
12890 (setq time (save-match-data (org-time-string-to-time ts)))))
12891 (org-timestamp-change (- n) (cdr (assoc what whata)))
12892 ;; rematch, so that we have everything in place for the real shift
12893 (org-at-timestamp-p t)
12894 (setq ts (match-string 1))
12896 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12897 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12898 (setq org-log-post-message msg)
12899 (message "%s" msg))))
12901 (defun org-show-todo-tree (arg)
12902 "Make a compact tree which shows all headlines marked with TODO.
12903 The tree will show the lines where the regexp matches, and all higher
12904 headlines above the match.
12906 With a numeric prefix N, construct a sparse tree for the Nth element
12907 of `org-todo-keywords-1'."
12908 (interactive "P")
12909 (let ((case-fold-search nil)
12910 (kwd-re
12911 (cond ((null arg) org-not-done-regexp)
12912 ((equal arg '(4))
12913 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12914 (mapcar 'list org-todo-keywords-1))))
12918 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12919 (regexp-quote (nth (1- (prefix-numeric-value arg))
12920 org-todo-keywords-1)))
12921 (t (user-error "Invalid prefix argument: %s" arg)))))
12922 (message "%d TODO entries found"
12923 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12925 (defun org-deadline (arg &optional time)
12927 With one universal prefix argument, remove any deadline from the item.
12928 With two universal prefix arguments, prompt for a warning delay.
12929 With argument TIME, set the deadline at the corresponding date. TIME
12931 (interactive "P")
12932 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12933 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12934 'region-start-level 'region))
12935 org-loop-over-headlines-in-active-region)
12936 (org-map-entries
12937 `(org-deadline ',arg ,time)
12938 org-loop-over-headlines-in-active-region
12939 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12940 (let* ((old-date (org-entry-get nil "DEADLINE"))
12941 (old-date-time (if old-date (org-time-string-to-time old-date)))
12942 (repeater (and old-date
12943 (string-match
12945 old-date)
12946 (match-string 1 old-date))))
12947 (cond
12948 ((equal arg '(4))
12949 (when (and old-date org-log-redeadline)
12950 (org-add-log-setup 'deldeadline nil old-date 'findpos
12951 org-log-redeadline))
12952 (org-remove-timestamp-with-keyword org-deadline-string)
12953 (message "Item no longer has a deadline."))
12954 ((equal arg '(16))
12955 (save-excursion
12956 (if (re-search-forward
12957 org-deadline-time-regexp
12958 (save-excursion (outline-next-heading) (point)) t)
12959 (let* ((rpl0 (match-string 1))
12960 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12961 (replace-match
12962 (concat org-deadline-string
12963 " <" rpl
12964 (format " -%dd"
12965 (abs
12966 (- (time-to-days
12967 (save-match-data
12968 (org-read-date nil t nil "Warn starting from" old-date-time)))
12969 (time-to-days old-date-time))))
12970 ">") t t))
12971 (user-error "No deadline information to update"))))
12972 (t
12973 (org-add-planning-info 'deadline time 'closed)
12974 (when (and old-date org-log-redeadline
12975 (not (equal old-date
12976 (substring org-last-inserted-timestamp 1 -1))))
12977 (org-add-log-setup 'redeadline nil old-date 'findpos
12978 org-log-redeadline))
12979 (when repeater
12980 (save-excursion
12981 (org-back-to-heading t)
12982 (when (re-search-forward (concat org-deadline-string " "
12983 org-last-inserted-timestamp)
12984 (save-excursion
12985 (outline-next-heading) (point)) t)
12986 (goto-char (1- (match-end 0)))
12987 (insert " " repeater)
12988 (setq org-last-inserted-timestamp
12989 (concat (substring org-last-inserted-timestamp 0 -1)
12990 " " repeater
12991 (substring org-last-inserted-timestamp -1))))))
12992 (message "Deadline on %s" org-last-inserted-timestamp))))))
12994 (defun org-schedule (arg &optional time)
12995 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12996 With one universal prefix argument, remove any scheduling date from the item.
12997 With two universal prefix arguments, prompt for a delay cookie.
12998 With argument TIME, scheduled at the corresponding date. TIME can
13000 (interactive "P")
13001 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13002 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13003 'region-start-level 'region))
13004 org-loop-over-headlines-in-active-region)
13005 (org-map-entries
13006 `(org-schedule ',arg ,time)
13007 org-loop-over-headlines-in-active-region
13008 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13009 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13010 (old-date-time (if old-date (org-time-string-to-time old-date)))
13011 (repeater (and old-date
13012 (string-match
13014 old-date)
13015 (match-string 1 old-date))))
13016 (cond
13017 ((equal arg '(4))
13018 (progn
13019 (when (and old-date org-log-reschedule)
13020 (org-add-log-setup 'delschedule nil old-date 'findpos
13021 org-log-reschedule))
13022 (org-remove-timestamp-with-keyword org-scheduled-string)
13023 (message "Item is no longer scheduled.")))
13024 ((equal arg '(16))
13025 (save-excursion
13026 (if (re-search-forward
13027 org-scheduled-time-regexp
13028 (save-excursion (outline-next-heading) (point)) t)
13029 (let* ((rpl0 (match-string 1))
13030 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13031 (replace-match
13032 (concat org-scheduled-string
13033 " <" rpl
13034 (format " -%dd"
13035 (abs
13036 (- (time-to-days
13037 (save-match-data
13038 (org-read-date nil t nil "Delay until" old-date-time)))
13039 (time-to-days old-date-time))))
13040 ">") t t))
13041 (user-error "No scheduled information to update"))))
13042 (t
13043 (org-add-planning-info 'scheduled time 'closed)
13044 (when (and old-date org-log-reschedule
13045 (not (equal old-date
13046 (substring org-last-inserted-timestamp 1 -1))))
13047 (org-add-log-setup 'reschedule nil old-date 'findpos
13048 org-log-reschedule))
13049 (when repeater
13050 (save-excursion
13051 (org-back-to-heading t)
13052 (when (re-search-forward (concat org-scheduled-string " "
13053 org-last-inserted-timestamp)
13054 (save-excursion
13055 (outline-next-heading) (point)) t)
13056 (goto-char (1- (match-end 0)))
13057 (insert " " repeater)
13058 (setq org-last-inserted-timestamp
13059 (concat (substring org-last-inserted-timestamp 0 -1)
13060 " " repeater
13061 (substring org-last-inserted-timestamp -1))))))
13062 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13064 (defun org-get-scheduled-time (pom &optional inherit)
13065 "Get the scheduled time as a time tuple, of a format suitable
13066 for calling org-schedule with, or if there is no scheduling,
13067 returns nil."
13068 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13069 (when time
13070 (apply 'encode-time (org-parse-time-string time)))))
13072 (defun org-get-deadline-time (pom &optional inherit)
13073 "Get the deadline as a time tuple, of a format suitable for
13074 calling org-deadline with, or if there is no scheduling, returns
13075 nil."
13076 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13077 (when time
13078 (apply 'encode-time (org-parse-time-string time)))))
13080 (defun org-remove-timestamp-with-keyword (keyword)
13081 "Remove all time stamps with KEYWORD in the current entry."
13083 beg)
13084 (save-excursion
13085 (org-back-to-heading t)
13086 (setq beg (point))
13087 (outline-next-heading)
13088 (while (re-search-backward re beg t)
13089 (replace-match "")
13091 (equal (char-before) ?\ ))
13092 (backward-delete-char 1)
13094 (point-at-bol) (point-at-eol)))
13095 (delete-region (point-at-bol)
13096 (min (point-max) (1+ (point-at-eol))))))))))
13098 (defun org-add-planning-info (what &optional time &rest remove)
13099 "Insert new timestamp with keyword in the line directly after the headline.
13100 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13101 If non is given, the user is prompted for a date.
13102 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13103 be removed."
13104 (interactive)
13105 (let (org-time-was-given org-end-time-was-given ts
13106 end default-time default-input)
13108 (catch 'exit
13109 (when (and (memq what '(scheduled deadline))
13110 (or (not time)
13111 (and (stringp time)
13112 (string-match "^[-+]+[0-9]" time))))
13113 ;; Try to get a default date/time from existing timestamp
13114 (save-excursion
13115 (org-back-to-heading t)
13116 (setq end (save-excursion (outline-next-heading) (point)))
13117 (when (re-search-forward (if (eq what 'scheduled)
13118 org-scheduled-time-regexp
13119 org-deadline-time-regexp)
13120 end t)
13121 (setq ts (match-string 1)
13122 default-time
13123 (apply 'encode-time (org-parse-time-string ts))
13124 default-input (and ts (org-get-compact-tod ts))))))
13125 (when what
13126 (setq time
13127 (if (stringp time)
13128 ;; This is a string (relative or absolute), set proper date
13129 (apply 'encode-time
13130 (org-read-date-analyze
13131 time default-time (decode-time default-time)))
13132 ;; If necessary, get the time from the user
13133 (or time (org-read-date nil 'to-time nil nil
13134 default-time default-input)))))
13136 (when (and org-insert-labeled-timestamps-at-point
13137 (member what '(scheduled deadline)))
13138 (insert
13139 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13140 (org-insert-time-stamp time org-time-was-given
13141 nil nil nil (list org-end-time-was-given))
13142 (setq what nil))
13143 (save-excursion
13144 (save-restriction
13145 (let (col list elt ts buffer-invisibility-spec)
13146 (org-back-to-heading t)
13148 (goto-char (match-end 1))
13149 (setq col (current-column))
13150 (goto-char (match-end 0))
13152 (when (and (not what)
13153 (not (looking-at
13155 org-keyword-time-not-clock-regexp))))
13156 ;; Nothing to add, nothing to remove...... :-)
13157 (throw 'exit nil))
13158 (if (and (not (looking-at org-outline-regexp))
13161 (not (equal (match-string 1) org-clock-string)))
13162 (narrow-to-region (match-beginning 0) (match-end 0))
13164 (backward-char 1)
13165 (narrow-to-region (point) (point))
13166 (and org-adapt-indentation (org-indent-to-column col)))
13167 ;; Check if we have to remove something.
13168 (setq list (cons what remove))
13169 (while list
13170 (setq elt (pop list))
13171 (when (or (and (eq elt 'scheduled)
13172 (re-search-forward org-scheduled-time-regexp nil t))
13173 (and (eq elt 'deadline)
13174 (re-search-forward org-deadline-time-regexp nil t))
13175 (and (eq elt 'closed)
13176 (re-search-forward org-closed-time-regexp nil t)))
13177 (replace-match "")
13178 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13180 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13181 (when what
13182 (insert
13183 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13184 (cond ((eq what 'scheduled) org-scheduled-string)
13185 ((eq what 'deadline) org-deadline-string)
13186 ((eq what 'closed) org-closed-string))
13187 " ")
13188 (setq ts (org-insert-time-stamp
13189 time
13190 (or org-time-was-given
13191 (and (eq what 'closed) org-log-done-with-time))
13192 (eq what 'closed)
13193 nil nil (list org-end-time-was-given)))
13194 (insert
13195 (if (not (or (bolp) (eq (char-before) ?\ )
13196 (memq (char-after) '(32 10))
13197 (eobp))) " " ""))
13198 (end-of-line 1))
13199 (goto-char (point-min))
13200 (widen)
13203 (delete-region (1- (point)) (point-at-eol)))
13204 ts))))))
13206 (defvar org-log-note-marker (make-marker))
13207 (defvar org-log-note-purpose nil)
13208 (defvar org-log-note-state nil)
13209 (defvar org-log-note-previous-state nil)
13210 (defvar org-log-note-how nil)
13211 (defvar org-log-note-extra nil)
13212 (defvar org-log-note-window-configuration nil)
13213 (defvar org-log-note-return-to (make-marker))
13214 (defvar org-log-note-effective-time nil
13215 "Remembered current time so that dynamically scoped
13216 `org-extend-today-until' affects tha timestamps in state change
13217 log")
13219 (defvar org-log-post-message nil
13220 "Message to be displayed after a log note has been stored.
13221 The auto-repeater uses this.")
13223 (defun org-add-note ()
13224 "Add a note to the current entry.
13225 This is done in the same way as adding a state change note."
13226 (interactive)
13227 (org-add-log-setup 'note nil nil 'findpos nil))
13229 (defvar org-property-end-re)
13230 (defun org-add-log-setup (&optional purpose state prev-state
13231 findpos how extra)
13232 "Set up the post command hook to take a note.
13233 If this is about to TODO state change, the new state is expected in STATE.
13234 When FINDPOS is non-nil, find the correct position for the note in
13235 the current entry. If not, assume that it can be inserted at point.
13236 HOW is an indicator what kind of note should be created.
13237 EXTRA is additional text that will be inserted into the notes buffer."
13238 (let* ((org-log-into-drawer (org-log-into-drawer))
13239 (drawer (cond ((stringp org-log-into-drawer)
13240 org-log-into-drawer)
13241 (org-log-into-drawer "LOGBOOK"))))
13242 (save-restriction
13243 (save-excursion
13244 (when findpos
13245 (org-back-to-heading t)
13246 (narrow-to-region (point) (save-excursion
13247 (outline-next-heading) (point)))
13251 (goto-char (match-end 0))
13252 (cond
13253 (drawer
13255 nil t)
13256 (progn
13257 (goto-char (match-end 0))
13258 (or org-log-states-order-reversed
13259 (and (re-search-forward org-property-end-re nil t)
13260 (goto-char (1- (match-beginning 0))))))
13262 (beginning-of-line 0)
13263 (org-indent-line)
13264 (beginning-of-line 2)
13265 (org-indent-line)
13266 (end-of-line 0)))
13267 ((and org-log-state-notes-insert-after-drawers
13268 (save-excursion
13269 (forward-line) (looking-at org-drawer-regexp)))
13270 (forward-line)
13271 (while (looking-at org-drawer-regexp)
13272 (goto-char (match-end 0))
13273 (re-search-forward org-property-end-re (point-max) t)
13274 (forward-line))
13275 (forward-line -1)))
13276 (unless org-log-states-order-reversed
13278 (org-skip-over-state-notes)
13280 (move-marker org-log-note-marker (point))
13281 (setq org-log-note-purpose purpose
13282 org-log-note-state state
13283 org-log-note-previous-state prev-state
13284 org-log-note-how how
13285 org-log-note-extra extra
13286 org-log-note-effective-time (org-current-effective-time))
13287 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13289 (defun org-skip-over-state-notes ()
13290 "Skip past the list of State notes in an entry."
13292 (when (ignore-errors (goto-char (org-in-item-p)))
13293 (let* ((struct (org-list-struct))
13294 (prevs (org-list-prevs-alist struct)))
13296 (goto-char (or (org-list-get-next-item (point) struct prevs)
13297 (org-list-get-item-end (point) struct)))))))
13299 (defun org-add-log-note (&optional purpose)
13300 "Pop up a window for taking a note, and add this note later at point."
13301 (remove-hook 'post-command-hook 'org-add-log-note)
13302 (setq org-log-note-window-configuration (current-window-configuration))
13303 (delete-other-windows)
13304 (move-marker org-log-note-return-to (point))
13305 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13306 (goto-char org-log-note-marker)
13307 (org-switch-to-buffer-other-window "*Org Note*")
13308 (erase-buffer)
13309 (if (memq org-log-note-how '(time state))
13310 (let (current-prefix-arg) (org-store-log-note))
13311 (let ((org-inhibit-startup t)) (org-mode))
13312 (insert (format "# Insert note for %s.
13314 (cond
13315 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13316 ((eq org-log-note-purpose 'done) "closed todo item")
13317 ((eq org-log-note-purpose 'state)
13319 (or org-log-note-previous-state "")
13320 (or org-log-note-state "")))
13321 ((eq org-log-note-purpose 'reschedule)
13322 "rescheduling")
13323 ((eq org-log-note-purpose 'delschedule)
13324 "no longer scheduled")
13325 ((eq org-log-note-purpose 'redeadline)
13326 "changing deadline")
13327 ((eq org-log-note-purpose 'deldeadline)
13328 "removing deadline")
13329 ((eq org-log-note-purpose 'refile)
13330 "refiling")
13331 ((eq org-log-note-purpose 'note)
13332 "this entry")
13333 (t (error "This should not happen")))))
13334 (if org-log-note-extra (insert org-log-note-extra))
13335 (org-set-local 'org-finish-function 'org-store-log-note)
13336 (run-hooks 'org-log-buffer-setup-hook)))
13338 (defvar org-note-abort nil) ; dynamically scoped
13339 (defun org-store-log-note ()
13340 "Finish taking a log note, and insert it to where it belongs."
13341 (let ((txt (buffer-string)))
13342 (kill-buffer (current-buffer))
13343 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13344 lines ind bul)
13346 (setq txt (replace-match "" t t txt)))
13348 (setq txt (replace-match "" t t txt)))
13351 (setq note
13352 (org-replace-escapes
13353 note
13354 (list (cons "%u" (user-login-name))
13355 (cons "%U" user-full-name)
13356 (cons "%t" (format-time-string
13357 (org-time-stamp-format 'long 'inactive)
13358 org-log-note-effective-time))
13359 (cons "%T" (format-time-string
13360 (org-time-stamp-format 'long nil)
13361 org-log-note-effective-time))
13362 (cons "%d" (format-time-string
13363 (org-time-stamp-format nil 'inactive)
13364 org-log-note-effective-time))
13365 (cons "%D" (format-time-string
13366 (org-time-stamp-format nil nil)
13367 org-log-note-effective-time))
13368 (cons "%s" (if org-log-note-state
13370 ""))
13371 (cons "%S" (if org-log-note-previous-state
13375 (push note lines))
13376 (when (or current-prefix-arg org-note-abort)
13377 (when org-log-into-drawer
13378 (org-remove-empty-drawer-at
13379 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13380 org-log-note-marker))
13381 (setq lines nil))
13382 (when lines
13383 (with-current-buffer (marker-buffer org-log-note-marker)
13384 (save-excursion
13385 (goto-char org-log-note-marker)
13386 (move-marker org-log-note-marker nil)
13387 (end-of-line 1)
13389 (setq ind (save-excursion
13390 (if (ignore-errors (goto-char (org-in-item-p)))
13391 (let ((struct (org-list-struct)))
13392 (org-list-get-ind
13393 (org-list-get-top-point struct) struct))
13395 (cond
13396 ((and (org-at-heading-p)
13397 org-adapt-indentation)
13398 (1+ (org-current-level)))
13399 ((org-at-heading-p) 0)
13400 (t (org-get-indentation))))))
13401 (setq bul (org-list-bullet-string "-"))
13402 (org-indent-line-to ind)
13403 (insert bul (pop lines))
13404 (let ((ind-body (+ (length bul) ind)))
13405 (while lines
13407 (org-indent-line-to ind-body)
13408 (insert (pop lines))))
13409 (message "Note stored")
13410 (org-back-to-heading t)
13411 (org-cycle-hide-drawers 'children))
13412 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13413 ;; from within `org-add-log-note' because `buffer-undo-list'
13414 ;; is then modified outside of `org-with-remote-undo'.
13415 (when (eq this-command 'org-agenda-todo)
13416 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13417 ;; Don't add undo information when called from `org-agenda-todo'
13418 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13419 (set-window-configuration org-log-note-window-configuration)
13420 (with-current-buffer (marker-buffer org-log-note-return-to)
13421 (goto-char org-log-note-return-to))
13422 (move-marker org-log-note-return-to nil)
13423 (and org-log-post-message (message "%s" org-log-post-message))))
13425 (defun org-remove-empty-drawer-at (drawer pos)
13426 "Remove an empty drawer DRAWER at position POS.
13427 POS may also be a marker."
13428 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13429 (save-excursion
13430 (save-restriction
13431 (widen)
13432 (goto-char pos)
13433 (if (org-in-regexp
13435 (replace-match ""))))))
13437 (defvar org-ts-type nil)
13438 (defun org-sparse-tree (&optional arg type)
13439 "Create a sparse tree, prompt for the details.
13440 This command can create sparse trees. You first need to select the type
13441 of match used to create the tree:
13443 t Show all TODO entries.
13444 T Show entries with a specific TODO keyword.
13445 m Show entries selected by a tags/property match.
13446 p Enter a property name and its value (both with completion on existing
13447 names/values) and show entries with that property.
13448 r Show entries matching a regular expression (`/' can be used as well).
13449 b Show deadlines and scheduled items before a date.
13450 a Show deadlines and scheduled items after a date.
13451 d Show deadlines due within `org-deadline-warning-days'.
13452 D Show deadlines and scheduled items between a date range."
13453 (interactive "P")
13454 (let (ans kwd value ts-type)
13455 (setq type (or type org-sparse-tree-default-date-type))
13456 (setq org-ts-type type)
13457 (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"
13458 (cond ((eq type 'all) "all timestamps")
13459 ((eq type 'scheduled) "only scheduled")
13460 ((eq type 'deadline) "only deadline")
13461 ((eq type 'active) "only active timestamps")
13462 ((eq type 'inactive) "only inactive timestamps")
13463 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13464 ((eq type 'closed) "with a closed time-stamp")
13465 (t "scheduled/deadline")))
13466 (setq ans (read-char-exclusive))
13467 (cond
13468 ((equal ans ?c)
13469 (org-sparse-tree
13470 arg (cadr (member type '(scheduled-or-deadline
13471 all scheduled deadline active inactive closed)))))
13472 ((equal ans ?d)
13473 (call-interactively 'org-check-deadlines))
13474 ((equal ans ?b)
13475 (call-interactively 'org-check-before-date))
13476 ((equal ans ?a)
13477 (call-interactively 'org-check-after-date))
13478 ((equal ans ?D)
13479 (call-interactively 'org-check-dates-range))
13480 ((equal ans ?t)
13481 (call-interactively 'org-show-todo-tree))
13482 ((equal ans ?T)
13483 (org-show-todo-tree '(4)))
13484 ((member ans '(?T ?m))
13485 (call-interactively 'org-match-sparse-tree))
13486 ((member ans '(?p ?P))
13487 (setq kwd (org-icompleting-read "Property: "
13488 (mapcar 'list (org-buffer-property-keys))))
13489 (setq value (org-icompleting-read "Value: "
13490 (mapcar 'list (org-property-values kwd))))
13493 (org-match-sparse-tree arg (concat kwd "=" value)))
13494 ((member ans '(?r ?R ?/))
13495 (call-interactively 'org-occur))
13498 (defvar org-occur-highlights nil
13499 "List of overlays used for occur matches.")
13500 (make-variable-buffer-local 'org-occur-highlights)
13501 (defvar org-occur-parameters nil
13502 "Parameters of the active org-occur calls.
13503 This is a list, each call to org-occur pushes as cons cell,
13504 containing the regular expression and the callback, onto the list.
13505 The list can contain several entries if `org-occur' has been called
13506 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13507 will only contain one set of parameters. When the highlights are
13508 removed (for example with `C-c C-c', or with the next edit (depending
13509 on `org-remove-highlights-with-change'), this variable is emptied
13510 as well.")
13511 (make-variable-buffer-local 'org-occur-parameters)
13513 (defun org-occur (regexp &optional keep-previous callback)
13514 "Make a compact tree which shows all matches of REGEXP.
13515 The tree will show the lines where the regexp matches, and all higher
13516 headlines above the match. It will also show the heading after the match,
13517 to make sure editing the matching entry is easy.
13518 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13519 call to `org-occur' will be kept, to allow stacking of calls to this
13520 command.
13521 If CALLBACK is non-nil, it is a function which is called to confirm
13522 that the match should indeed be shown."
13524 (when (equal regexp "")
13525 (user-error "Regexp cannot be empty"))
13526 (unless keep-previous
13527 (org-remove-occur-highlights nil nil t))
13528 (push (cons regexp callback) org-occur-parameters)
13529 (let ((cnt 0))
13530 (save-excursion
13531 (goto-char (point-min))
13532 (if (or (not keep-previous) ; do not want to keep
13533 (not org-occur-highlights)) ; no previous matches
13534 ;; hide everything
13535 (org-overview))
13536 (while (re-search-forward regexp nil t)
13537 (when (or (not callback)
13538 (save-match-data (funcall callback)))
13539 (setq cnt (1+ cnt))
13540 (when org-highlight-sparse-tree-matches
13541 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13542 (org-show-context 'occur-tree))))
13543 (when org-remove-highlights-with-change
13544 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13545 nil 'local))
13546 (unless org-sparse-tree-open-archived-trees
13547 (org-hide-archived-subtrees (point-min) (point-max)))
13548 (run-hooks 'org-occur-hook)
13549 (if (org-called-interactively-p 'interactive)
13550 (message "%d match(es) for regexp %s" cnt regexp))
13551 cnt))
13553 (defun org-occur-next-match (&optional n reset)
13554 "Function for `next-error-function' to find sparse tree matches.
13555 N is the number of matches to move, when negative move backwards.
13556 RESET is entirely ignored - this function always goes back to the
13557 starting point when no match is found."
13558 (let* ((limit (if (< n 0) (point-min) (point-max)))
13559 (search-func (if (< n 0)
13560 'previous-single-char-property-change
13561 'next-single-char-property-change))
13562 (n (abs n))
13563 (pos (point))
13564 p1)
13565 (catch 'exit
13566 (while (setq p1 (funcall search-func (point) 'org-type))
13567 (when (equal p1 limit)
13568 (goto-char pos)
13569 (error "No more matches"))
13570 (when (equal (get-char-property p1 'org-type) 'org-occur)
13571 (setq n (1- n))
13572 (when (= n 0)
13573 (goto-char p1)
13574 (throw 'exit (point))))
13575 (goto-char p1))
13576 (goto-char p1)
13577 (error "No more matches"))))
13579 (defun org-show-context (&optional key)
13580 "Make sure point and context are visible.
13581 How much context is shown depends upon the variables
13582 `org-show-hierarchy-above', `org-show-following-heading',
13583 `org-show-entry-below' and `org-show-siblings'."
13584 (let ((heading-p (org-at-heading-p t))
13585 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13586 (following-p (org-get-alist-option org-show-following-heading key))
13587 (entry-p (org-get-alist-option org-show-entry-below key))
13588 (siblings-p (org-get-alist-option org-show-siblings key)))
13589 ;; Show heading or entry text
13590 (if (and heading-p (not entry-p))
13591 (org-flag-heading nil) ; only show the heading
13592 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13593 (org-show-hidden-entry))) ; show entire entry
13594 (when following-p
13595 ;; Show next sibling, or heading below text
13596 (save-excursion
13597 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13598 (org-flag-heading nil))))
13599 (when siblings-p (org-show-siblings))
13600 (when hierarchy-p
13601 ;; show all higher headings, possibly with siblings
13602 (save-excursion
13603 (while (and (condition-case nil
13604 (progn (org-up-heading-all 1) t)
13605 (error nil))
13606 (not (bobp)))
13607 (org-flag-heading nil)
13608 (when siblings-p (org-show-siblings)))))
13609 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13611 (defvar org-reveal-start-hook nil
13612 "Hook run before revealing a location.")
13614 (defun org-reveal (&optional siblings)
13615 "Show current entry, hierarchy above it, and the following headline.
13616 This can be used to show a consistent set of context around locations
13617 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13618 not t for the search context.
13620 With optional argument SIBLINGS, on each level of the hierarchy all
13621 siblings are shown. This repairs the tree structure to what it would
13622 look like when opened with hierarchical calls to `org-cycle'.
13624 go to the parent and show the
13625 entire tree."
13626 (interactive "P")
13627 (run-hooks 'org-reveal-start-hook)
13628 (let ((org-show-hierarchy-above t)
13629 (org-show-following-heading t)
13630 (org-show-siblings (if siblings t org-show-siblings)))
13631 (org-show-context nil))
13632 (when (equal siblings '(16))
13633 (save-excursion
13634 (when (org-up-heading-safe)
13635 (org-show-subtree)
13636 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13638 (defun org-highlight-new-match (beg end)
13639 "Highlight from BEG to END and mark the highlight is an occur headline."
13640 (let ((ov (make-overlay beg end)))
13641 (overlay-put ov 'face 'secondary-selection)
13642 (overlay-put ov 'org-type 'org-occur)
13643 (push ov org-occur-highlights)))
13645 (defun org-remove-occur-highlights (&optional beg end noremove)
13646 "Remove the occur highlights from the buffer.
13647 BEG and END are ignored. If NOREMOVE is nil, remove this function
13648 from the `before-change-functions' in the current buffer."
13649 (interactive)
13650 (unless org-inhibit-highlight-removal
13651 (mapc 'delete-overlay org-occur-highlights)
13652 (setq org-occur-highlights nil)
13653 (setq org-occur-parameters nil)
13654 (unless noremove
13655 (remove-hook 'before-change-functions
13656 'org-remove-occur-highlights 'local))))
13658 ;;;; Priorities
13661 "Regular expression matching the priority indicator.")
13663 (defvar org-remove-priority-next-time nil)
13665 (defun org-priority-up ()
13666 "Increase the priority of the current item."
13667 (interactive)
13668 (org-priority 'up))
13670 (defun org-priority-down ()
13671 "Decrease the priority of the current item."
13672 (interactive)
13673 (org-priority 'down))
13675 (defun org-priority (&optional action show)
13676 "Change the priority of an item.
13677 ACTION can be `set', `up', `down', or a character."
13678 (interactive "P")
13679 (if (equal action '(4))
13680 (org-show-priority)
13681 (unless org-enable-priority-commands
13682 (user-error "Priority commands are disabled"))
13683 (setq action (or action 'set))
13684 (let (current new news have remove)
13685 (save-excursion
13686 (org-back-to-heading t)
13687 (if (looking-at org-priority-regexp)
13688 (setq current (string-to-char (match-string 2))
13689 have t))
13690 (cond
13691 ((eq action 'remove)
13692 (setq remove t new ?\ ))
13693 ((or (eq action 'set)
13694 (if (featurep 'xemacs) (characterp action) (integerp action)))
13695 (if (not (eq action 'set))
13696 (setq new action)
13697 (message "Priority %c-%c, SPC to remove: "
13698 org-highest-priority org-lowest-priority)
13699 (save-match-data
13700 (setq new (read-char-exclusive))))
13701 (if (and (= (upcase org-highest-priority) org-highest-priority)
13702 (= (upcase org-lowest-priority) org-lowest-priority))
13703 (setq new (upcase new)))
13704 (cond ((equal new ?\ ) (setq remove t))
13705 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13706 (user-error "Priority must be between `%c' and `%c'"
13707 org-highest-priority org-lowest-priority))))
13708 ((eq action 'up)
13709 (setq new (if have
13710 (1- current) ; normal cycling
13711 ;; last priority was empty
13712 (if (eq last-command this-command)
13713 org-lowest-priority ; wrap around empty to lowest
13714 ;; default
13715 (if org-priority-start-cycle-with-default
13716 org-default-priority
13717 (1- org-default-priority))))))
13718 ((eq action 'down)
13719 (setq new (if have
13720 (1+ current) ; normal cycling
13721 ;; last priority was empty
13722 (if (eq last-command this-command)
13723 org-highest-priority ; wrap around empty to highest
13724 ;; default
13725 (if org-priority-start-cycle-with-default
13726 org-default-priority
13727 (1+ org-default-priority))))))
13728 (t (user-error "Invalid action")))
13729 (if (or (< (upcase new) org-highest-priority)
13730 (> (upcase new) org-lowest-priority))
13731 (if (and (memq action '(up down))
13732 (not have) (not (eq last-command this-command)))
13733 ;; `new' is from default priority
13734 (error
13735 "The default can not be set, see `org-default-priority' why")
13736 ;; normal cycling: `new' is beyond highest/lowest priority
13737 ;; and is wrapped around to the empty priority
13738 (setq remove t)))
13739 (setq news (format "%c" new))
13740 (if have
13741 (if remove
13742 (replace-match "" t t nil 1)
13743 (replace-match news t t nil 2))
13744 (if remove
13745 (user-error "No priority cookie found in line")
13746 (let ((case-fold-search nil))
13747 (looking-at org-todo-line-regexp))
13748 (if (match-end 2)
13749 (progn
13750 (goto-char (match-end 2))
13751 (insert " [#" news "]"))
13752 (goto-char (match-beginning 3))
13753 (insert "[#" news "] "))))
13754 (org-preserve-lc (org-set-tags nil 'align)))
13755 (if remove
13756 (message "Priority removed")
13757 (message "Priority of current item set to %s" news)))))
13759 (defun org-show-priority ()
13760 "Show the priority of the current item.
13761 This priority is composed of the main priority given with the [#A] cookies,
13762 and by additional input from the age of a schedules or deadline entry."
13763 (interactive)
13764 (let ((pri (if (eq major-mode 'org-agenda-mode)
13765 (org-get-at-bol 'priority)
13766 (save-excursion
13767 (save-match-data
13768 (beginning-of-line)
13769 (and (looking-at org-heading-regexp)
13770 (org-get-priority (match-string 0))))))))
13771 (message "Priority is %d" (if pri pri -1000))))
13773 (defun org-get-priority (s)
13774 "Find priority cookie and return priority."
13775 (save-match-data
13776 (if (functionp org-get-priority-function)
13777 (funcall org-get-priority-function)
13778 (if (not (string-match org-priority-regexp s))
13779 (* 1000 (- org-lowest-priority org-default-priority))
13780 (* 1000 (- org-lowest-priority
13781 (string-to-char (match-string 2 s))))))))
13783 ;;;; Tags
13785 (defvar org-agenda-archives-mode)
13786 (defvar org-map-continue-from nil
13787 "Position from where mapping should continue.
13788 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13790 (defvar org-scanner-tags nil
13791 "The current tag list while the tags scanner is running.")
13792 (defvar org-trust-scanner-tags nil
13793 "Should `org-get-tags-at' use the tags for the scanner.
13794 This is for internal dynamical scoping only.
13795 When this is non-nil, the function `org-get-tags-at' will return the value
13796 of `org-scanner-tags' instead of building the list by itself. This
13797 can lead to large speed-ups when the tags scanner is used in a file with
13798 many entries, and when the list of tags is retrieved, for example to
13799 obtain a list of properties. Building the tags list for each entry in such
13800 a file becomes an N^2 operation - but with this variable set, it scales
13801 as N.")
13803 (defun org-scan-tags (action matcher todo-only &optional start-level)
13804 "Sca headline tags with inheritance and produce output ACTION.
13806 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13807 or `agenda' to produce an entry list for an agenda view. It can also be
13808 a Lisp form or a function that should be called at each matched headline, in
13809 this case the return value is a list of all return values from these calls.
13811 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13812 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13813 only lines with a not-done TODO keyword are included in the output.
13814 This should be the same variable that was scoped into
13815 and set by `org-make-tags-matcher' when it constructed MATCHER.
13817 START-LEVEL can be a string with asterisks, reducing the scope to
13818 headlines matching this string."
13819 (require 'org-agenda)
13820 (let* ((re (concat "^"
13821 (if start-level
13822 ;; Get the correct level to match
13824 org-outline-regexp)
13828 (props (list 'face 'default
13829 'done-face 'org-agenda-done
13830 'undone-face 'default
13831 'mouse-face 'highlight
13832 'org-not-done-regexp org-not-done-regexp
13833 'org-todo-regexp org-todo-regexp
13834 'org-complex-heading-regexp org-complex-heading-regexp
13835 'help-echo
13836 (format "mouse-2 or RET jump to org file %s"
13837 (abbreviate-file-name
13838 (or (buffer-file-name (buffer-base-buffer))
13839 (buffer-name (buffer-base-buffer)))))))
13840 (org-map-continue-from nil)
13841 lspos tags tags-list
13842 (tags-alist (list (cons 0 org-file-tags)))
13843 (llast 0) rtn rtn1 level category i txt
13844 todo marker entry priority)
13845 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13846 (setq action (list 'lambda nil action)))
13847 (save-excursion
13848 (goto-char (point-min))
13849 (when (eq action 'sparse-tree)
13850 (org-overview)
13851 (org-remove-occur-highlights))
13852 (while (let (case-fold-search)
13853 (re-search-forward re nil t))
13854 (setq org-map-continue-from nil)
13855 (catch :skip
13856 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13857 tags (if (match-end 4) (org-match-string-no-properties 4)))
13858 (goto-char (setq lspos (match-beginning 0)))
13859 (setq level (org-reduced-level (org-outline-level))
13860 category (org-get-category))
13861 (setq i llast llast level)
13862 ;; remove tag lists from same and sublevels
13863 (while (>= i level)
13864 (when (setq entry (assoc i tags-alist))
13865 (setq tags-alist (delete entry tags-alist)))
13866 (setq i (1- i)))
13867 ;; add the next tags
13868 (when tags
13869 (setq tags (org-split-string tags ":")
13870 tags-alist
13871 (cons (cons level tags) tags-alist)))
13872 ;; compile tags for current headline
13873 (setq tags-list
13874 (if org-use-tag-inheritance
13875 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13876 tags)
13877 org-scanner-tags tags-list)
13878 (when org-use-tag-inheritance
13879 (setcdr (car tags-alist)
13880 (mapcar (lambda (x)
13881 (setq x (copy-sequence x))
13882 (org-add-prop-inherited x))
13883 (cdar tags-alist))))
13884 (when (and tags org-use-tag-inheritance
13885 (or (not (eq t org-use-tag-inheritance))
13886 org-tags-exclude-from-inheritance))
13887 ;; selective inheritance, remove uninherited ones
13888 (setcdr (car tags-alist)
13889 (org-remove-uninherited-tags (cdar tags-alist))))
13890 (when (and
13892 ;; eval matcher only when the todo condition is OK
13893 (and (or (not todo-only) (member todo org-not-done-keywords))
13894 (let ((case-fold-search t) (org-trust-scanner-tags t))
13895 (eval matcher)))
13897 ;; Call the skipper, but return t if it does not skip,
13898 ;; so that the `and' form continues evaluating
13899 (progn
13900 (unless (eq action 'sparse-tree) (org-agenda-skip))
13901 t)
13903 ;; Check if timestamps are deselecting this entry
13904 (or (not todo-only)
13905 (and (member todo org-not-done-keywords)
13906 (or (not org-agenda-tags-todo-honor-ignore-options)
13907 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13909 ;; select this headline
13910 (cond
13911 ((eq action 'sparse-tree)
13912 (and org-highlight-sparse-tree-matches
13913 (org-get-heading) (match-end 0)
13914 (org-highlight-new-match
13915 (match-beginning 1) (match-end 1)))
13916 (org-show-context 'tags-tree))
13917 ((eq action 'agenda)
13918 (setq txt (org-agenda-format-item
13919 ""
13920 (concat
13921 (if (eq org-tags-match-list-sublevels 'indented)
13922 (make-string (1- level) ?.) "")
13923 (org-get-heading))
13924 level category
13925 tags-list)
13926 priority (org-get-priority txt))
13927 (goto-char lspos)
13928 (setq marker (org-agenda-new-marker))
13929 (org-add-props txt props
13930 'org-marker marker 'org-hd-marker marker 'org-category category
13931 'todo-state todo
13932 'priority priority 'type "tagsmatch")
13933 (push txt rtn))
13934 ((functionp action)
13935 (setq org-map-continue-from nil)
13936 (save-excursion
13937 (setq rtn1 (funcall action))
13938 (push rtn1 rtn)))
13939 (t (user-error "Invalid action")))
13941 ;; if we are to skip sublevels, jump to end of subtree
13942 (unless org-tags-match-list-sublevels
13943 (org-end-of-subtree t)
13944 (backward-char 1))))
13945 ;; Get the correct position from where to continue
13946 (if org-map-continue-from
13947 (goto-char org-map-continue-from)
13948 (and (= (point) lspos) (end-of-line 1)))))
13949 (when (and (eq action 'sparse-tree)
13950 (not org-sparse-tree-open-archived-trees))
13951 (org-hide-archived-subtrees (point-min) (point-max)))
13952 (nreverse rtn)))
13954 (defun org-remove-uninherited-tags (tags)
13955 "Remove all tags that are not inherited from the list TAGS."
13956 (cond
13957 ((eq org-use-tag-inheritance t)
13958 (if org-tags-exclude-from-inheritance
13959 (org-delete-all org-tags-exclude-from-inheritance tags)
13960 tags))
13961 ((not org-use-tag-inheritance) nil)
13962 ((stringp org-use-tag-inheritance)
13963 (delq nil (mapcar
13964 (lambda (x)
13965 (if (and (string-match org-use-tag-inheritance x)
13966 (not (member x org-tags-exclude-from-inheritance)))
13967 x nil))
13968 tags)))
13969 ((listp org-use-tag-inheritance)
13970 (delq nil (mapcar
13971 (lambda (x)
13972 (if (member x org-use-tag-inheritance) x nil))
13973 tags)))))
13975 (defun org-match-sparse-tree (&optional todo-only match)
13976 "Create a sparse tree according to tags string MATCH.
13977 MATCH can contain positive and negative selection of tags, like
13979 If optional argument TODO-ONLY is non-nil, only select lines that are
13980 also TODO lines."
13981 (interactive "P")
13982 (org-agenda-prepare-buffers (list (current-buffer)))
13983 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13985 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13987 (defvar org-cached-props nil)
13988 (defun org-cached-entry-get (pom property)
13989 (if (or (eq t org-use-property-inheritance)
13990 (and (stringp org-use-property-inheritance)
13991 (string-match org-use-property-inheritance property))
13992 (and (listp org-use-property-inheritance)
13993 (member property org-use-property-inheritance)))
13994 ;; Caching is not possible, check it directly
13995 (org-entry-get pom property 'inherit)
13996 ;; Get all properties, so that we can do complicated checks easily
13997 (cdr (assoc property (or org-cached-props
13998 (setq org-cached-props
13999 (org-entry-properties pom)))))))
14001 (defun org-global-tags-completion-table (&optional files)
14002 "Return the list of all tags in all agenda buffer/files.
14003 Optional FILES argument is a list of files which can be used
14004 instead of the agenda files."
14005 (save-excursion
14006 (org-uniquify
14007 (delq nil
14008 (apply 'append
14009 (mapcar
14010 (lambda (file)
14011 (set-buffer (find-file-noselect file))
14012 (append (org-get-buffer-tags)
14013 (mapcar (lambda (x) (if (stringp (car-safe x))
14014 (list (car-safe x)) nil))
14015 org-tag-alist)))
14016 (if (and files (car files))
14017 files
14018 (org-agenda-files))))))))
14020 (defun org-make-tags-matcher (match)
14021 "Create the TAGS/TODO matcher form for the selection string MATCH.
14023 The variable `todo-only' is scoped dynamically into this function.
14024 It will be set to t if the matcher restricts matching to TODO entries,
14025 otherwise will not be touched.
14027 Returns a cons of the selection string MATCH and the constructed
14028 lisp form implementing the matcher. The matcher is to be evaluated
14029 at an Org entry, with point on the headline, and returns t if the
14030 entry matches the selection string MATCH. The returned lisp form
14031 references two variables with information about the entry, which
14032 must be bound around the form's evaluation: todo, the TODO keyword
14033 at the entry (or nil of none); and tags-list, the list of all tags
14034 at the entry including inherited ones. Additionally, the category
14035 of the entry (if any) must be specified as the text property
14036 'org-category on the headline.
14038 See also `org-scan-tags'.
14039 "
14040 (declare (special todo-only))
14041 (unless (boundp 'todo-only)
14042 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14043 (unless match
14044 ;; Get a new match request, with completion against the global
14045 ;; tags table and the local tags in current buffer
14046 (let ((org-last-tags-completion-table
14047 (org-uniquify
14048 (delq nil (append (org-get-buffer-tags)
14049 (org-global-tags-completion-table))))))
14050 (setq match (org-completing-read-no-i
14051 "Match: " 'org-tags-completion-function nil nil nil
14052 'org-tags-history))))
14054 ;; Parse the string and create a lisp form
14055 (let ((match0 match)
14056 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14057 minus tag mm
14058 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14059 orterms term orlist re-p str-p level-p level-op time-p
14060 prop-p pn pv po gv rest (start 0) (ss 0))
14061 ;; Expand group tags
14062 (setq match (org-tags-expand match))
14064 ;; Check if there is a TODO part of this match, which would be the
14065 ;; part after a "/". TO make sure that this slash is not part of
14066 ;; a property value to be matched against, we also check that there
14067 ;; is no " after that slash.
14068 ;; First, find the last slash
14069 (while (string-match "/+" match ss)
14070 (setq start (match-beginning 0) ss (match-end 0)))
14071 (if (and (string-match "/+" match start)
14073 ;; match contains also a todo-matching request
14074 (progn
14075 (setq tagsmatch (substring match 0 (match-beginning 0))
14076 todomatch (substring match (match-end 0)))
14077 (if (string-match "^!" todomatch)
14078 (setq todo-only t todomatch (substring todomatch 1)))
14080 (setq todomatch nil)))
14081 ;; only matching tags
14082 (setq tagsmatch match todomatch nil))
14084 ;; Make the tags matcher
14086 (setq tagsmatcher t)
14087 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14088 (while (setq term (pop orterms))
14090 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14091 (while (string-match re term)
14092 (setq rest (substring term (match-end 0))
14093 minus (and (match-end 1)
14094 (equal (match-string 1 term) "-"))
14095 tag (save-match-data (replace-regexp-in-string
14097 (match-string 2 term)))
14098 re-p (equal (string-to-char tag) ?{)
14099 level-p (match-end 4)
14100 prop-p (match-end 5)
14101 mm (cond
14102 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14103 (level-p
14104 (setq level-op (org-op-to-function (match-string 3 term)))
14105 `(,level-op level ,(string-to-number
14106 (match-string 4 term))))
14107 (prop-p
14108 (setq pn (match-string 5 term)
14109 po (match-string 6 term)
14110 pv (match-string 7 term)
14111 re-p (equal (string-to-char pv) ?{)
14113 time-p (save-match-data
14115 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14116 (if time-p (setq pv (org-matcher-time pv)))
14117 (setq po (org-op-to-function po (if time-p 'time str-p)))
14118 (cond
14119 ((equal pn "CATEGORY")
14120 (setq gv '(get-text-property (point) 'org-category)))
14121 ((equal pn "TODO")
14122 (setq gv 'todo))
14123 (t
14124 (setq gv `(org-cached-entry-get nil ,pn))))
14125 (if re-p
14126 (if (eq po 'org<>)
14127 `(not (string-match ,pv (or ,gv "")))
14128 `(string-match ,pv (or ,gv "")))
14129 (if str-p
14130 `(,po (or ,gv "") ,pv)
14131 `(,po (string-to-number (or ,gv ""))
14132 ,(string-to-number pv) ))))
14133 (t `(member ,tag tags-list)))
14134 mm (if minus (list 'not mm) mm)
14135 term rest)
14136 (push mm tagsmatcher))
14137 (push (if (> (length tagsmatcher) 1)
14138 (cons 'and tagsmatcher)
14139 (car tagsmatcher))
14140 orlist)
14141 (setq tagsmatcher nil))
14142 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14143 (setq tagsmatcher
14144 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14145 ;; Make the todo matcher
14147 (setq todomatcher t)
14148 (setq orterms (org-split-string todomatch "|") orlist nil)
14149 (while (setq term (pop orterms))
14150 (while (string-match re term)
14151 (setq minus (and (match-end 1)
14152 (equal (match-string 1 term) "-"))
14153 kwd (match-string 2 term)
14154 re-p (equal (string-to-char kwd) ?{)
14155 term (substring term (match-end 0))
14156 mm (if re-p
14157 `(string-match ,(substring kwd 1 -1) todo)
14158 (list 'equal 'todo kwd))
14159 mm (if minus (list 'not mm) mm))
14160 (push mm todomatcher))
14161 (push (if (> (length todomatcher) 1)
14162 (cons 'and todomatcher)
14163 (car todomatcher))
14164 orlist)
14165 (setq todomatcher nil))
14166 (setq todomatcher (if (> (length orlist) 1)
14167 (cons 'or orlist) (car orlist))))
14169 ;; Return the string and lisp forms of the matcher
14170 (setq matcher (if todomatcher
14171 (list 'and tagsmatcher todomatcher)
14172 tagsmatcher))
14173 (when todo-only
14174 (setq matcher (list 'and '(member todo org-not-done-keywords)
14175 matcher)))
14176 (cons match0 matcher)))
14178 (defun org-tags-expand (match &optional single-as-list downcased)
14179 "Expand group tags in MATCH.
14181 This replaces every group tag in MATCH with a regexp tag search.
14183 will be replaced like this:
14189 Replacing by a regexp preserves the structure of the match.
14190 E.g., this expansion
14197 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14198 assumed to be a single group tag, and the function will return
14199 the list of tags in this group.
14201 When DOWNCASE is non-nil, expand downcased TAGS."
14202 (if org-group-tags
14203 (let* ((case-fold-search t)
14204 (stable org-mode-syntax-table)
14205 (tal (or org-tag-groups-alist-for-agenda
14206 org-tag-groups-alist))
14207 (tal (if downcased
14208 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14209 (tml (mapcar 'car tal))
14210 (rtnmatch match) rpl)
14211 ;; @ and _ are allowed as word-components in tags
14212 (modify-syntax-entry ?@ "w" stable)
14213 (modify-syntax-entry ?_ "w" stable)
14214 (while (and tml
14215 (with-syntax-table stable
14216 (string-match
14219 (let* ((dir (match-string 1 rtnmatch))
14220 (tag (match-string 2 rtnmatch))
14221 (tag (if downcased (downcase tag) tag)))
14222 (setq tml (delete tag tml))
14223 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14224 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14226 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14227 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14228 (if single-as-list
14229 (or (reverse rpl) (list rtnmatch))
14230 rtnmatch))
14231 (if single-as-list (list (if downcased (downcase match) match))
14232 match)))
14234 (defun org-op-to-function (op &optional stringp)
14235 "Turn an operator into the appropriate function."
14236 (setq op
14237 (cond
14238 ((equal op "<" ) '(< string< org-time<))
14239 ((equal op ">" ) '(> org-string> org-time>))
14240 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14241 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14242 ((member op '("=" "==")) '(= string= org-time=))
14243 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14244 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14246 (defun org<> (a b) (not (= a b)))
14247 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14248 (defun org-string>= (a b) (not (string< a b)))
14249 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14250 (defun org-string<> (a b) (not (string= a b)))
14251 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14252 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14253 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14254 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14255 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14256 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14257 (defun org-2ft (s)
14258 "Convert S to a floating point time.
14259 If S is already a number, just return it. If it is a string, parse
14260 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14261 (cond
14262 ((numberp s) s)
14263 ((stringp s)
14264 (condition-case nil
14265 (float-time (apply 'encode-time (org-parse-time-string s)))
14266 (error 0.)))
14267 (t 0.)))
14269 (defun org-time-today ()
14270 "Time in seconds today at 0:00.
14271 Returns the float number of seconds since the beginning of the
14272 epoch to the beginning of today (00:00)."
14273 (float-time (apply 'encode-time
14274 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14276 (defun org-matcher-time (s)
14277 "Interpret a time comparison value."
14278 (save-match-data
14279 (cond
14280 ((string= s "<now>") (float-time))
14281 ((string= s "<today>") (org-time-today))
14282 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14283 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14285 (+ (org-time-today)
14286 (* (string-to-number (match-string 1 s))
14287 (cdr (assoc (match-string 2 s)
14288 '(("d" . 86400.0) ("w" . 604800.0)
14289 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14290 (t (org-2ft s)))))
14292 (defun org-match-any-p (re list)
14293 "Does re match any element of list?"
14294 (setq list (mapcar (lambda (x) (string-match re x)) list))
14295 (delq nil list))
14297 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14298 (defvar org-tags-overlay (make-overlay 1 1))
14299 (org-detach-overlay org-tags-overlay)
14301 (defun org-get-local-tags-at (&optional pos)
14302 "Get a list of tags defined in the current headline."
14303 (org-get-tags-at pos 'local))
14305 (defun org-get-local-tags ()
14306 "Get a list of tags defined in the current headline."
14307 (org-get-tags-at nil 'local))
14309 (defun org-get-tags-at (&optional pos local)
14310 "Get a list of all headline tags applicable at POS.
14311 POS defaults to point. If tags are inherited, the list contains
14312 the targets in the same sequence as the headlines appear, i.e.
14313 the tags of the current headline come last.
14314 When LOCAL is non-nil, only return tags from the current headline,
14315 ignore inherited ones."
14316 (interactive)
14317 (if (and org-trust-scanner-tags
14318 (or (not pos) (equal pos (point)))
14319 (not local))
14320 org-scanner-tags
14321 (let (tags ltags lastpos parent)
14322 (save-excursion
14323 (save-restriction
14324 (widen)
14325 (goto-char (or pos (point)))
14326 (save-match-data
14327 (catch 'done
14328 (condition-case nil
14329 (progn
14330 (org-back-to-heading t)
14331 (while (not (equal lastpos (point)))
14332 (setq lastpos (point))
14333 (when (looking-at
14335 (setq ltags (org-split-string
14336 (org-match-string-no-properties 1) ":"))
14337 (when parent
14338 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14339 (setq tags (append
14340 (if parent
14341 (org-remove-uninherited-tags ltags)
14342 ltags)
14343 tags)))
14344 (or org-use-tag-inheritance (throw 'done t))
14345 (if local (throw 'done t))
14346 (or (org-up-heading-safe) (error nil))
14347 (setq parent t)))
14348 (error nil)))))
14349 (if local
14350 tags
14351 (reverse (delete-dups
14352 (reverse (append
14353 (org-remove-uninherited-tags
14354 org-file-tags) tags)))))))))
14356 (defun org-add-prop-inherited (s)
14357 (add-text-properties 0 (length s) '(inherited t) s)
14358 s)
14360 (defun org-toggle-tag (tag &optional onoff)
14361 "Toggle the tag TAG for the current line.
14362 If ONOFF is `on' or `off', don't toggle but set to this state."
14363 (let (res current)
14364 (save-excursion
14365 (org-back-to-heading t)
14367 (point-at-eol) t)
14368 (progn
14369 (setq current (match-string 1))
14370 (replace-match ""))
14371 (setq current ""))
14372 (setq current (nreverse (org-split-string current ":")))
14373 (cond
14374 ((eq onoff 'on)
14375 (setq res t)
14376 (or (member tag current) (push tag current)))
14377 ((eq onoff 'off)
14378 (or (not (member tag current)) (setq current (delete tag current))))
14379 (t (if (member tag current)
14380 (setq current (delete tag current))
14381 (setq res t)
14382 (push tag current))))
14383 (end-of-line 1)
14384 (if current
14385 (progn
14386 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14387 (org-set-tags nil t))
14388 (delete-horizontal-space))
14389 (run-hooks 'org-after-tags-change-hook))
14390 res))
14392 (defun org-align-tags-here (to-col)
14393 ;; Assumes that this is a headline
14394 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14395 (beginning-of-line 1)
14397 (< pos (match-beginning 2)))
14398 (progn
14399 (setq tags-l (- (match-end 2) (match-beginning 2)))
14400 (goto-char (match-beginning 1))
14401 (insert " ")
14402 (delete-region (point) (1+ (match-beginning 2)))
14403 (setq ncol (max (current-column)
14404 (1+ col)
14405 (if (> to-col 0)
14406 to-col
14407 (- (abs to-col) tags-l))))
14408 (setq p (point))
14409 (insert (make-string (- ncol (current-column)) ?\ ))
14410 (setq ncol (current-column))
14411 (when indent-tabs-mode (tabify p (point-at-eol)))
14412 (org-move-to-column (min ncol col) t))
14413 (goto-char pos))))
14415 (defun org-set-tags-command (&optional arg just-align)
14416 "Call the set-tags command for the current entry."
14417 (interactive "P")
14418 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14419 (org-set-tags arg just-align)
14420 (save-excursion
14421 (unless (and (org-region-active-p)
14422 org-loop-over-headlines-in-active-region)
14423 (org-back-to-heading t))
14424 (org-set-tags arg just-align))))
14426 (defun org-set-tags-to (data)
14427 "Set the tags of the current entry to DATA, replacing the current tags.
14428 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14429 If DATA is nil or the empty string, any tags will be removed."
14430 (interactive "sTags: ")
14431 (setq data
14432 (cond
14433 ((eq data nil) "")
14434 ((equal data "") "")
14435 ((stringp data)
14436 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14437 ":"))
14438 ((listp data)
14439 (concat ":" (mapconcat 'identity data ":") ":"))))
14440 (when data
14441 (save-excursion
14442 (org-back-to-heading t)
14443 (when (looking-at org-complex-heading-regexp)
14444 (if (match-end 5)
14445 (progn
14446 (goto-char (match-beginning 5))
14447 (insert data)
14448 (delete-region (point) (point-at-eol))
14449 (org-set-tags nil 'align))
14450 (goto-char (point-at-eol))
14451 (insert " " data)
14452 (org-set-tags nil 'align)))
14453 (beginning-of-line 1)
14455 (delete-region (match-beginning 1) (match-end 1))))))
14457 (defun org-align-all-tags ()
14458 "Align the tags i all headings."
14459 (interactive)
14460 (save-excursion
14461 (or (ignore-errors (org-back-to-heading t))
14462 (outline-next-heading))
14463 (if (org-at-heading-p)
14464 (org-set-tags t)
14465 (message "No headings"))))
14467 (defvar org-indent-indentation-per-level)
14468 (defun org-set-tags (&optional arg just-align)
14469 "Set the tags for the current headline.
14470 With prefix ARG, realign all tags in headings in the current buffer."
14471 (interactive "P")
14472 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14473 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14474 'region-start-level 'region))
14475 org-loop-over-headlines-in-active-region)
14476 (org-map-entries
14477 ;; We don't use ARG and JUST-ALIGN here these args are not
14478 ;; useful when looping over headlines
14479 `(org-set-tags)
14480 org-loop-over-headlines-in-active-region
14481 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14482 (let* ((re org-outline-regexp-bol)
14483 (current (unless arg (org-get-tags-string)))
14484 (col (current-column))
14485 (org-setting-tags t)
14486 table current-tags inherited-tags ; computed below when needed
14487 tags p0 c0 c1 rpl di tc level)
14488 (if arg
14489 (save-excursion
14490 (goto-char (point-min))
14491 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14492 (while (re-search-forward re nil t)
14493 (org-set-tags nil t)
14494 (end-of-line 1)))
14495 (message "All tags realigned to column %d" org-tags-column))
14496 (if just-align
14497 (setq tags current)
14498 ;; Get a new set of tags from the user
14499 (save-excursion
14500 (setq table (append org-tag-persistent-alist
14501 (or org-tag-alist (org-get-buffer-tags))
14502 (and
14503 org-complete-tags-always-offer-all-agenda-tags
14504 (org-global-tags-completion-table
14505 (org-agenda-files))))
14506 org-last-tags-completion-table table
14507 current-tags (org-split-string current ":")
14508 inherited-tags (nreverse
14509 (nthcdr (length current-tags)
14510 (nreverse (org-get-tags-at))))
14511 tags
14512 (if (or (eq t org-use-fast-tag-selection)
14513 (and org-use-fast-tag-selection
14514 (delq nil (mapcar 'cdr table))))
14515 (org-fast-tag-selection
14516 current-tags inherited-tags table
14517 (if org-fast-tag-selection-include-todo
14518 org-todo-key-alist))
14519 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14520 (org-trim
14521 (org-icompleting-read "Tags: "
14522 'org-tags-completion-function
14523 nil nil current 'org-tags-history))))))
14524 (while (string-match "[-+&]+" tags)
14525 ;; No boolean logic, just a list
14526 (setq tags (replace-match ":" t t tags))))
14528 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14530 (if org-tags-sort-function
14531 (setq tags (mapconcat 'identity
14532 (sort (org-split-string
14533 tags (org-re "[^[:alnum:]_@#%]+"))
14534 org-tags-sort-function) ":")))
14537 (setq tags "")
14538 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14539 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14541 ;; Insert new tags at the correct column
14542 (beginning-of-line 1)
14543 (setq level (or (and (looking-at org-outline-regexp)
14544 (- (match-end 0) (point) 1))
14545 1))
14546 (cond
14547 ((and (equal current "") (equal tags "")))
14548 ((re-search-forward
14550 (point-at-eol) t)
14551 (if (equal tags "")
14552 (setq rpl "")
14553 (goto-char (match-beginning 0))
14554 (setq c0 (current-column)
14555 ;; compute offset for the case of org-indent-mode active
14556 di (if org-indent-mode
14557 (* (1- org-indent-indentation-per-level) (1- level))
14558 0)
14559 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14560 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14561 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14562 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14563 (replace-match rpl t t)
14564 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14565 tags)
14566 (t (error "Tags alignment failed")))
14567 (org-move-to-column col)
14568 (unless just-align
14569 (run-hooks 'org-after-tags-change-hook))))))
14571 (defun org-change-tag-in-region (beg end tag off)
14572 "Add or remove TAG for each entry in the region.
14573 This works in the agenda, and also in an org-mode buffer."
14574 (interactive
14575 (list (region-beginning) (region-end)
14576 (let ((org-last-tags-completion-table
14577 (if (derived-mode-p 'org-mode)
14578 (org-uniquify
14579 (delq nil (append (org-get-buffer-tags)
14580 (org-global-tags-completion-table))))
14581 (org-global-tags-completion-table))))
14582 (org-icompleting-read
14583 "Tag: " 'org-tags-completion-function nil nil nil
14584 'org-tags-history))
14585 (progn
14587 (equal (read-char-exclusive) ?r))))
14588 (if (fboundp 'deactivate-mark) (deactivate-mark))
14589 (let ((agendap (equal major-mode 'org-agenda-mode))
14590 l1 l2 m buf pos newhead (cnt 0))
14591 (goto-char end)
14592 (setq l2 (1- (org-current-line)))
14593 (goto-char beg)
14594 (setq l1 (org-current-line))
14595 (loop for l from l1 to l2 do
14596 (org-goto-line l)
14597 (setq m (get-text-property (point) 'org-hd-marker))
14598 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14599 (and agendap m))
14600 (setq buf (if agendap (marker-buffer m) (current-buffer))
14601 pos (if agendap m (point)))
14602 (with-current-buffer buf
14603 (save-excursion
14604 (save-restriction
14605 (goto-char pos)
14606 (setq cnt (1+ cnt))
14607 (org-toggle-tag tag (if off 'off 'on))
14608 (setq newhead (org-get-heading)))))
14609 (and agendap (org-agenda-change-all-lines newhead m))))
14610 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14612 (defun org-tags-completion-function (string predicate &optional flag)
14613 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14614 (confirm (lambda (x) (stringp (car x)))))
14616 (setq s1 (match-string 1 string)
14617 s2 (match-string 2 string))
14618 (setq s1 "" s2 string))
14619 (cond
14620 ((eq flag nil)
14621 ;; try completion
14622 (setq rtn (try-completion s2 ctable confirm))
14623 (if (stringp rtn)
14624 (setq rtn
14625 (concat s1 s2 (substring rtn (length s2))
14626 (if (and org-add-colon-after-tag-completion
14627 (assoc rtn ctable))
14628 ":" ""))))
14629 rtn)
14630 ((eq flag t)
14631 ;; all-completions
14632 (all-completions s2 ctable confirm))
14633 ((eq flag 'lambda)
14634 ;; exact match?
14635 (assoc s2 ctable)))))
14637 (defun org-fast-tag-insert (kwd tags face &optional end)
14638 "Insert KDW, and the TAGS, the latter with face FACE.
14639 Also insert END."
14640 (insert (format "%-12s" (concat kwd ":"))
14641 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14642 (or end "")))
14644 (defun org-fast-tag-show-exit (flag)
14645 (save-excursion
14646 (org-goto-line 3)
14648 (replace-match ""))
14649 (when flag
14650 (end-of-line 1)
14651 (org-move-to-column (- (window-width) 19) t)
14652 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14654 (defun org-set-current-tags-overlay (current prefix)
14655 "Add an overlay to CURRENT tag with PREFIX."
14656 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14657 (if (featurep 'xemacs)
14658 (org-overlay-display org-tags-overlay (concat prefix s)
14659 'secondary-selection)
14660 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14661 (org-overlay-display org-tags-overlay (concat prefix s)))))
14663 (defvar org-last-tag-selection-key nil)
14664 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14665 "Fast tag selection with single keys.
14666 CURRENT is the current list of tags in the headline, INHERITED is the
14667 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14668 possibly with grouping information. TODO-TABLE is a similar table with
14669 TODO keywords, should these have keys assigned to them.
14670 If the keys are nil, a-z are automatically assigned.
14671 Returns the new tags string, or nil to not change the current settings."
14672 (let* ((fulltable (append table todo-table))
14673 (maxlen (apply 'max (mapcar
14674 (lambda (x)
14675 (if (stringp (car x)) (string-width (car x)) 0))
14676 fulltable)))
14677 (buf (current-buffer))
14678 (expert (eq org-fast-tag-selection-single-key 'expert))
14679 (buffer-tags nil)
14680 (fwidth (+ maxlen 3 1 3))
14681 (ncol (/ (- (window-width) 4) fwidth))
14682 (i-face 'org-done)
14683 (c-face 'org-todo)
14684 tg cnt e c char c1 c2 ntable tbl rtn
14685 ov-start ov-end ov-prefix
14686 (exit-after-next org-fast-tag-selection-single-key)
14687 (done-keywords org-done-keywords)
14688 groups ingroup)
14689 (save-excursion
14690 (beginning-of-line 1)
14691 (if (looking-at
14693 (setq ov-start (match-beginning 1)
14694 ov-end (match-end 1)
14695 ov-prefix "")
14696 (setq ov-start (1- (point-at-eol))
14697 ov-end (1+ ov-start))
14699 (setq ov-prefix
14700 (concat
14701 (buffer-substring (1- (point)) (point))
14702 (if (> (current-column) org-tags-column)
14703 " "
14704 (make-string (- org-tags-column (current-column)) ?\ ))))))
14705 (move-overlay org-tags-overlay ov-start ov-end)
14706 (save-window-excursion
14707 (if expert
14708 (set-buffer (get-buffer-create " *Org tags*"))
14709 (delete-other-windows)
14710 (split-window-vertically)
14711 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14712 (erase-buffer)
14713 (org-set-local 'org-done-keywords done-keywords)
14716 (org-fast-tag-show-exit exit-after-next)
14717 (org-set-current-tags-overlay current ov-prefix)
14718 (setq tbl fulltable char ?a cnt 0)
14719 (while (setq e (pop tbl))
14720 (cond
14721 ((equal (car e) :startgroup)
14722 (push '() groups) (setq ingroup t)
14723 (when (not (= cnt 0))
14724 (setq cnt 0)
14726 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14727 ((equal (car e) :endgroup)
14728 (setq ingroup nil cnt 0)
14730 ((equal e '(:newline))
14731 (when (not (= cnt 0))
14732 (setq cnt 0)
14734 (setq e (car tbl))
14735 (while (equal (car tbl) '(:newline))
14737 (setq tbl (cdr tbl)))))
14738 ((equal e '(:grouptags)) nil)
14739 (t
14740 (setq tg (copy-sequence (car e)) c2 nil)
14741 (if (cdr e)
14742 (setq c (cdr e))
14743 ;; automatically assign a character.
14744 (setq c1 (string-to-char
14745 (downcase (substring
14746 tg (if (= (string-to-char tg) ?@) 1 0)))))
14747 (if (or (rassoc c1 ntable) (rassoc c1 table))
14748 (while (or (rassoc char ntable) (rassoc char table))
14749 (setq char (1+ char)))
14750 (setq c2 c1))
14751 (setq c (or c2 char)))
14752 (if ingroup (push tg (car groups)))
14753 (setq tg (org-add-props tg nil 'face
14754 (cond
14755 ((not (assoc tg table))
14756 (org-get-todo-face tg))
14757 ((member tg current) c-face)
14758 ((member tg inherited) i-face))))
14759 (if (equal (caar tbl) :grouptags)
14760 (org-add-props tg nil 'face 'org-tag-group))
14761 (if (and (= cnt 0) (not ingroup)) (insert " "))
14762 (insert "[" c "] " tg (make-string
14763 (- fwidth 4 (length tg)) ?\ ))
14764 (push (cons tg c) ntable)
14765 (when (= (setq cnt (1+ cnt)) ncol)
14767 (if ingroup (insert " "))
14768 (setq cnt 0)))))
14769 (setq ntable (nreverse ntable))
14771 (goto-char (point-min))
14772 (if (not expert) (org-fit-window-to-buffer))
14773 (setq rtn
14774 (catch 'exit
14775 (while t
14776 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14777 (if (not groups) "no " "")
14778 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14779 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14780 (setq org-last-tag-selection-key c)
14781 (cond
14783 ((= c ?!)
14784 (setq groups (not groups))
14785 (goto-char (point-min))
14786 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14787 ((= c ?\C-c)
14788 (if (not expert)
14789 (org-fast-tag-show-exit
14790 (setq exit-after-next (not exit-after-next)))
14791 (setq expert nil)
14792 (delete-other-windows)
14793 (set-window-buffer (split-window-vertically) " *Org tags*")
14794 (org-switch-to-buffer-other-window " *Org tags*")
14795 (org-fit-window-to-buffer)))
14796 ((or (= c ?\C-g)
14797 (and (= c ?q) (not (rassoc c ntable))))
14798 (org-detach-overlay org-tags-overlay)
14799 (setq quit-flag t))
14800 ((= c ?\ )
14801 (setq current nil)
14802 (if exit-after-next (setq exit-after-next 'now)))
14804 (condition-case nil
14805 (setq tg (org-icompleting-read
14806 "Tag: "
14807 (or buffer-tags
14808 (with-current-buffer buf
14809 (org-get-buffer-tags)))))
14810 (quit (setq tg "")))
14812 (add-to-list 'buffer-tags (list tg))
14813 (if (member tg current)
14814 (setq current (delete tg current))
14815 (push tg current)))
14816 (if exit-after-next (setq exit-after-next 'now)))
14817 ((setq e (rassoc c todo-table) tg (car e))
14818 (with-current-buffer buf
14819 (save-excursion (org-todo tg)))
14820 (if exit-after-next (setq exit-after-next 'now)))
14821 ((setq e (rassoc c ntable) tg (car e))
14822 (if (member tg current)
14823 (setq current (delete tg current))
14824 (loop for g in groups do
14825 (if (member tg g)
14826 (mapc (lambda (x)
14827 (setq current (delete x current)))
14828 g)))
14829 (push tg current))
14830 (if exit-after-next (setq exit-after-next 'now))))
14832 ;; Create a sorted list
14833 (setq current
14834 (sort current
14835 (lambda (a b)
14836 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14837 (if (eq exit-after-next 'now) (throw 'exit t))
14838 (goto-char (point-min))
14839 (beginning-of-line 2)
14840 (delete-region (point) (point-at-eol))
14841 (org-fast-tag-insert "Current" current c-face)
14842 (org-set-current-tags-overlay current ov-prefix)
14843 (while (re-search-forward
14845 (setq tg (match-string 1))
14846 (add-text-properties
14847 (match-beginning 1) (match-end 1)
14848 (list 'face
14849 (cond
14850 ((member tg current) c-face)
14851 ((member tg inherited) i-face)
14852 (t (get-text-property (match-beginning 1) 'face))))))
14853 (goto-char (point-min)))))
14854 (org-detach-overlay org-tags-overlay)
14855 (if rtn
14856 (mapconcat 'identity current ":")
14857 nil))))
14859 (defun org-get-tags-string ()
14860 "Get the TAGS string in the current headline."
14861 (unless (org-at-heading-p t)
14862 (user-error "Not on a heading"))
14863 (save-excursion
14864 (beginning-of-line 1)
14866 (org-match-string-no-properties 1)
14867 "")))
14869 (defun org-get-tags ()
14870 "Get the list of tags specified in the current headline."
14871 (org-split-string (org-get-tags-string) ":"))
14873 (defun org-get-buffer-tags ()
14874 "Get a table of all tags used in the buffer, for completion."
14875 (let (tags)
14876 (save-excursion
14877 (goto-char (point-min))
14878 (while (re-search-forward
14880 (when (equal (char-after (point-at-bol 0)) ?*)
14881 (mapc (lambda (x) (add-to-list 'tags x))
14882 (org-split-string (org-match-string-no-properties 1) ":")))))
14883 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14884 (mapcar 'list tags)))
14886 ;;;; The mapping API
14888 (defun org-map-entries (func &optional match scope &rest skip)
14889 "Call FUNC at each headline selected by MATCH in SCOPE.
14891 FUNC is a function or a lisp form. The function will be called without
14892 arguments, with the cursor positioned at the beginning of the headline.
14893 The return values of all calls to the function will be collected and
14894 returned as a list.
14896 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14897 does not need to preserve point. After evaluation, the cursor will be
14898 moved to the end of the line (presumably of the headline of the
14899 processed entry) and search continues from there. Under some
14900 circumstances, this may not produce the wanted results. For example,
14901 if you have removed (e.g. archived) the current (sub)tree it could
14902 mean that the next entry will be skipped entirely. In such cases, you
14903 can specify the position from where search should continue by making
14904 FUNC set the variable `org-map-continue-from' to the desired buffer
14905 position.
14907 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14908 Only headlines that are matched by this query will be considered during
14909 the iteration. When MATCH is nil or t, all headlines will be
14910 visited by the iteration.
14912 SCOPE determines the scope of this command. It can be any of:
14914 nil The current buffer, respecting the restriction if any
14915 tree The subtree started with the entry at point
14916 region The entries within the active region, if any
14917 region-start-level
14918 The entries within the active region, but only those at
14919 the same level than the first one.
14920 file The current buffer, without restriction
14921 file-with-archives
14922 The current buffer, and any archives associated with it
14923 agenda All agenda files
14924 agenda-with-archives
14925 All agenda files with any archive files associated with them
14926 \(file1 file2 ...)
14927 If this is a list, all files in the list will be scanned
14929 The remaining args are treated as settings for the skipping facilities of
14930 the scanner. The following items can be given here:
14932 archive skip trees with the archive tag
14933 comment skip trees with the COMMENT keyword
14934 function or Emacs Lisp form:
14935 will be used as value for `org-agenda-skip-function', so
14936 whenever the function returns a position, FUNC will not be
14937 called for that entry and search will continue from the
14938 position returned
14940 If your function needs to retrieve the tags including inherited tags
14941 at the *current* entry, you can use the value of the variable
14942 `org-scanner-tags' which will be much faster than getting the value
14943 with `org-get-tags-at'. If your function gets properties with
14944 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14945 to t around the call to `org-entry-properties' to get the same speedup.
14946 Note that if your function moves around to retrieve tags and properties at
14947 a *different* entry, you cannot use these techniques."
14948 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14949 (not (org-region-active-p)))
14950 (let* ((org-agenda-archives-mode nil) ; just to make sure
14951 (org-agenda-skip-archived-trees (memq 'archive skip))
14952 (org-agenda-skip-comment-trees (memq 'comment skip))
14953 (org-agenda-skip-function
14954 (car (org-delete-all '(comment archive) skip)))
14955 (org-tags-match-list-sublevels t)
14956 (start-level (eq scope 'region-start-level))
14957 matcher file res
14958 org-todo-keywords-for-agenda
14959 org-done-keywords-for-agenda
14960 org-todo-keyword-alist-for-agenda
14961 org-drawers-for-agenda
14962 org-tag-alist-for-agenda
14963 todo-only)
14965 (cond
14966 ((eq match t) (setq matcher t))
14967 ((eq match nil) (setq matcher t))
14968 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14970 (save-window-excursion
14971 (save-restriction
14972 (cond ((eq scope 'tree)
14973 (org-back-to-heading t)
14974 (org-narrow-to-subtree)
14975 (setq scope nil))
14976 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14977 (org-region-active-p))
14978 ;; If needed, set start-level to a string like "2"
14979 (when start-level
14980 (save-excursion
14981 (goto-char (region-beginning))
14982 (unless (org-at-heading-p) (outline-next-heading))
14983 (setq start-level (org-current-level))))
14984 (narrow-to-region (region-beginning)
14985 (save-excursion
14986 (goto-char (region-end))
14987 (unless (and (bolp) (org-at-heading-p))
14988 (outline-next-heading))
14989 (point)))
14990 (setq scope nil)))
14992 (if (not scope)
14993 (progn
14994 (org-agenda-prepare-buffers
14995 (list (buffer-file-name (current-buffer))))
14996 (setq res (org-scan-tags func matcher todo-only start-level)))
14997 ;; Get the right scope
14998 (cond
14999 ((and scope (listp scope) (symbolp (car scope)))
15000 (setq scope (eval scope)))
15001 ((eq scope 'agenda)
15002 (setq scope (org-agenda-files t)))
15003 ((eq scope 'agenda-with-archives)
15004 (setq scope (org-agenda-files t))
15005 (setq scope (org-add-archive-files scope)))
15006 ((eq scope 'file)
15007 (setq scope (list (buffer-file-name))))
15008 ((eq scope 'file-with-archives)
15009 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15010 (org-agenda-prepare-buffers scope)
15011 (while (setq file (pop scope))
15012 (with-current-buffer (org-find-base-buffer-visiting file)
15013 (save-excursion
15014 (save-restriction
15015 (widen)
15016 (goto-char (point-min))
15017 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15018 res)))
15020 ;;;; Properties
15022 ;;; Setting and retrieving properties
15024 (defconst org-special-properties
15025 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15026 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15027 "The special properties valid in Org-mode.
15029 These are properties that are not defined in the property drawer,
15030 but in some other way.")
15032 (defconst org-default-properties
15033 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15034 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15035 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15036 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15037 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15038 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15039 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15040 "Some properties that are used by Org-mode for various purposes.
15041 Being in this list makes sure that they are offered for completion.")
15044 "Regular expression matching the first line of a property drawer.")
15047 "Regular expression matching the last line of a property drawer.")
15050 "Regular expression matching the first line of a property drawer.")
15053 "Regular expression matching the first line of a property drawer.")
15055 (defconst org-property-drawer-re
15058 "Matches an entire property drawer.")
15060 (defconst org-clock-drawer-re
15063 "Matches an entire clock drawer.")
15065 (defun org-property-action ()
15066 "Do an action on properties."
15067 (interactive)
15068 (let (c)
15069 (org-at-property-p)
15070 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15071 (setq c (read-char-exclusive))
15072 (cond
15073 ((equal c ?s)
15074 (call-interactively 'org-set-property))
15075 ((equal c ?d)
15076 (call-interactively 'org-delete-property))
15077 ((equal c ?D)
15078 (call-interactively 'org-delete-property-globally))
15079 ((equal c ?c)
15080 (call-interactively 'org-compute-property-at-point))
15081 (t (user-error "No such property action %c" c)))))
15083 (defun org-inc-effort ()
15084 "Increment the value of the effort property in the current entry."
15085 (interactive)
15086 (org-set-effort nil t))
15088 (defvar org-clock-effort) ;; Defined in org-clock.el
15089 (defvar org-clock-current-task) ;; Defined in org-clock.el
15090 (defun org-set-effort (&optional value increment)
15091 "Set the effort property of the current entry.
15092 With numerical prefix arg, use the nth allowed value, 0 stands for the
15093 10th allowed value.
15095 When INCREMENT is non-nil, set the property to the next allowed value."
15096 (interactive "P")
15097 (if (equal value 0) (setq value 10))
15098 (let* ((completion-ignore-case t)
15099 (prop org-effort-property)
15100 (cur (org-entry-get nil prop))
15101 (allowed (org-property-get-allowed-values nil prop 'table))
15102 (existing (mapcar 'list (org-property-values prop)))
15103 (heading (nth 4 (org-heading-components)))
15104 rpl
15105 (val (cond
15106 ((stringp value) value)
15107 ((and allowed (integerp value))
15108 (or (car (nth (1- value) allowed))
15109 (car (org-last allowed))))
15110 ((and allowed increment)
15111 (or (caadr (member (list cur) allowed))
15112 (user-error "Allowed effort values are not set")))
15113 (allowed
15114 (message "Select 1-9,0, [RET%s]: %s"
15115 (if cur (concat "=" cur) "")
15116 (mapconcat 'car allowed " "))
15117 (setq rpl (read-char-exclusive))
15119 cur
15120 (setq rpl (- rpl ?0))
15121 (if (equal rpl 0) (setq rpl 10))
15122 (if (and (> rpl 0) (<= rpl (length allowed)))
15123 (car (nth (1- rpl) allowed))
15124 (org-completing-read "Effort: " allowed nil))))
15125 (t
15126 (let (org-completion-use-ido org-completion-use-iswitchb)
15127 (org-completing-read
15129 (concat "[" cur "]") "")
15130 ": ")
15131 existing nil nil "" nil cur))))))
15132 (unless (equal (org-entry-get nil prop) val)
15133 (org-entry-put nil prop val))
15134 (save-excursion
15135 (org-back-to-heading t)
15136 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15137 (when (string= heading org-clock-current-task)
15138 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15139 (org-clock-update-mode-line))
15140 (message "%s is now %s" prop val)))
15142 (defun org-at-property-p ()
15143 "Is cursor inside a property drawer?"
15144 (save-excursion
15145 (when (equal 'node-property (car (org-element-at-point)))
15146 (beginning-of-line 1)
15147 (looking-at org-property-re))))
15149 (defun org-get-property-block (&optional beg end force)
15150 "Return the (beg . end) range of the body of the property drawer.
15151 BEG and END are the beginning and end of the current subtree, or of
15152 the part before the first headline. If they are not given, they will
15153 be found. If the drawer does not exist and FORCE is non-nil, create
15154 the drawer."
15155 (catch 'exit
15156 (save-excursion
15157 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15158 (progn (org-back-to-heading t) (point))))
15159 (end (or end (and (not (outline-next-heading)) (point-max))
15160 (point))))
15161 (goto-char beg)
15162 (if (re-search-forward org-property-start-re end t)
15163 (setq beg (1+ (match-end 0)))
15164 (if force
15165 (save-excursion
15166 (org-insert-property-drawer)
15167 (setq end (progn (outline-next-heading) (point))))
15168 (throw 'exit nil))
15169 (goto-char beg)
15170 (if (re-search-forward org-property-start-re end t)
15171 (setq beg (1+ (match-end 0)))))
15172 (if (re-search-forward org-property-end-re end t)
15173 (setq end (match-beginning 0))
15174 (or force (throw 'exit nil))
15175 (goto-char beg)
15176 (setq end beg)
15177 (org-indent-line)
15179 (cons beg end)))))
15181 (defun org-entry-properties (&optional pom which specific)
15182 "Get all properties of the entry at point-or-marker POM.
15183 This includes the TODO keyword, the tags, time strings for deadline,
15184 scheduled, and clocking, and any additional properties defined in the
15185 entry. The return value is an alist, keys may occur multiple times
15186 if the property key was used several times.
15187 POM may also be nil, in which case the current entry is used.
15188 If WHICH is nil or `all', get all properties. If WHICH is
15189 `special' or `standard', only get that subclass. If WHICH
15190 is a string only get exactly this property. SPECIFIC can be a string, the
15191 specific property we are interested in. Specifying it can speed
15192 things up because then unnecessary parsing is avoided."
15193 (setq which (or which 'all))
15194 (org-with-point-at pom
15195 (let ((clockstr (substring org-clock-string 0 -1))
15196 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15197 (case-fold-search nil)
15198 beg end range props sum-props key key1 value string clocksum clocksumt)
15199 (save-excursion
15200 (when (condition-case nil
15201 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15202 (error nil))
15203 (setq beg (point))
15204 (setq sum-props (get-text-property (point) 'org-summaries))
15205 (setq clocksum (get-text-property (point) :org-clock-minutes)
15206 clocksumt (get-text-property (point) :org-clock-minutes-today))
15207 (outline-next-heading)
15208 (setq end (point))
15209 (when (memq which '(all special))
15210 ;; Get the special properties, like TODO and tags
15211 (goto-char beg)
15212 (when (and (or (not specific) (string= specific "TODO"))
15213 (looking-at org-todo-line-regexp) (match-end 2))
15214 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15215 (when (and (or (not specific) (string= specific "PRIORITY"))
15216 (looking-at org-priority-regexp))
15217 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15218 (when (or (not specific) (string= specific "FILE"))
15219 (push (cons "FILE" buffer-file-name) props))
15220 (when (and (or (not specific) (string= specific "TAGS"))
15221 (setq value (org-get-tags-string))
15223 (push (cons "TAGS" value) props))
15224 (when (and (or (not specific) (string= specific "ALLTAGS"))
15225 (setq value (org-get-tags-at)))
15226 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15227 ":"))
15228 props))
15229 (when (or (not specific) (string= specific "BLOCKED"))
15230 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15231 (when (or (not specific)
15232 (member specific
15233 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15234 "TIMESTAMP" "TIMESTAMP_IA")))
15235 (catch 'match
15236 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15237 (setq key (if (match-end 1)
15238 (substring (org-match-string-no-properties 1)
15239 0 -1))
15240 string (if (equal key clockstr)
15241 (org-trim
15242 (buffer-substring-no-properties
15243 (match-beginning 3) (goto-char
15244 (point-at-eol))))
15245 (substring (org-match-string-no-properties 3)
15246 1 -1)))
15247 ;; Get the correct property name from the key. This is
15248 ;; necessary if the user has configured time keywords.
15249 (setq key1 (concat key ":"))
15250 (cond
15251 ((not key)
15252 (setq key
15253 (if (= (char-after (match-beginning 3)) ?\[)
15254 "TIMESTAMP_IA" "TIMESTAMP")))
15255 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15256 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15257 ((equal key1 org-closed-string) (setq key "CLOSED"))
15258 ((equal key1 org-clock-string) (setq key "CLOCK")))
15259 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15260 (progn
15261 (push (cons key string) props)
15262 ;; no need to search further if match is found
15263 (throw 'match t))
15264 (when (or (equal key "CLOCK") (not (assoc key props)))
15265 (push (cons key string) props)))))))
15267 (when (memq which '(all standard))
15268 ;; Get the standard properties, like :PROP: ...
15269 (setq range (org-get-property-block beg end))
15270 (when range
15271 (goto-char (car range))
15272 (while (re-search-forward org-property-re
15273 (cdr range) t)
15274 (setq key (org-match-string-no-properties 2)
15275 value (org-trim (or (org-match-string-no-properties 3) "")))
15276 (unless (member key excluded)
15277 (push (cons key (or value "")) props)))))
15278 (if clocksum
15279 (push (cons "CLOCKSUM"
15280 (org-columns-number-to-string (/ (float clocksum) 60.)
15281 'add_times))
15282 props))
15283 (if clocksumt
15284 (push (cons "CLOCKSUM_T"
15285 (org-columns-number-to-string (/ (float clocksumt) 60.)
15286 'add_times))
15287 props))
15288 (unless (assoc "CATEGORY" props)
15289 (push (cons "CATEGORY" (org-get-category)) props))
15290 (append sum-props (nreverse props)))))))
15292 (defun org-entry-get (pom property &optional inherit literal-nil)
15293 "Get value of PROPERTY for entry or content at point-or-marker POM.
15294 If INHERIT is non-nil and the entry does not have the property,
15295 then also check higher levels of the hierarchy.
15296 If INHERIT is the symbol `selective', use inheritance only if the setting
15297 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15298 If the property is present but empty, the return value is the empty string.
15299 If the property is not present at all, nil is returned.
15302 do not interpret it as the list atom nil. This is used for inheritance
15304 (org-with-point-at pom
15305 (if (and inherit (if (eq inherit 'selective)
15306 (org-property-inherit-p property)
15307 t))
15308 (org-entry-get-with-inheritance property literal-nil)
15309 (if (member property org-special-properties)
15310 ;; We need a special property. Use `org-entry-properties' to
15311 ;; retrieve it, but specify the wanted property
15312 (cdr (assoc property (org-entry-properties nil 'special property)))
15313 (let ((range (org-get-property-block)))
15314 (when (and range (not (eq (car range) (cdr range))))
15315 (let* ((props (list (or (assoc property org-file-properties)
15316 (assoc property org-global-properties)
15317 (assoc property org-global-properties-fixed))))
15318 (ap (lambda (key)
15319 (when (re-search-forward
15320 (org-re-property key) (cdr range) t)
15321 (setq props
15322 (org-update-property-plist
15323 key
15324 (if (match-end 3)
15325 (org-match-string-no-properties 3) "")
15326 props)))))
15327 val)
15328 (goto-char (car range))
15329 (funcall ap property)
15330 (goto-char (car range))
15331 (while (funcall ap (concat property "+")))
15332 (setq val (cdr (assoc property props)))
15333 (when val (if literal-nil val (org-not-nil val))))))))))
15335 (defun org-property-or-variable-value (var &optional inherit)
15336 "Check if there is a property fixing the value of VAR.
15337 If yes, return this value. If not, return the current value of the variable."
15338 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15340 (read prop)
15341 (symbol-value var))))
15343 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15344 "Delete the property PROPERTY from entry at point-or-marker POM.
15345 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15346 an empty drawer to delete."
15347 (org-with-point-at pom
15348 (if (member property org-special-properties)
15349 nil ; cannot delete these properties.
15350 (let ((range (org-get-property-block)))
15351 (if (and range
15352 (goto-char (car range))
15353 (re-search-forward
15354 (org-re-property property)
15355 (cdr range) t))
15356 (progn
15357 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15358 (and delete-empty-drawer
15359 (org-remove-empty-drawer-at
15360 delete-empty-drawer (car range)))
15361 t)
15362 nil)))))
15364 ;; Multi-values properties are properties that contain multiple values
15365 ;; These values are assumed to be single words, separated by whitespace.
15366 (defun org-entry-add-to-multivalued-property (pom property value)
15367 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15368 (let* ((old (org-entry-get pom property))
15370 (setq value (org-entry-protect-space value))
15371 (unless (member value values)
15372 (setq values (append values (list value)))
15373 (org-entry-put pom property
15374 (mapconcat 'identity values " ")))))
15376 (defun org-entry-remove-from-multivalued-property (pom property value)
15377 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15378 (let* ((old (org-entry-get pom property))
15380 (setq value (org-entry-protect-space value))
15381 (when (member value values)
15382 (setq values (delete value values))
15383 (org-entry-put pom property
15384 (mapconcat 'identity values " ")))))
15386 (defun org-entry-member-in-multivalued-property (pom property value)
15387 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15388 (let* ((old (org-entry-get pom property))
15390 (setq value (org-entry-protect-space value))
15391 (member value values)))
15393 (defun org-entry-get-multivalued-property (pom property)
15394 "Return a list of values in a multivalued property."
15395 (let* ((value (org-entry-get pom property))
15397 (mapcar 'org-entry-restore-space values)))
15399 (defun org-entry-put-multivalued-property (pom property &rest values)
15400 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15401 VALUES should be a list of strings. Spaces will be protected."
15402 (org-entry-put pom property
15403 (mapconcat 'org-entry-protect-space values " "))
15404 (let* ((value (org-entry-get pom property))
15406 (mapcar 'org-entry-restore-space values)))
15408 (defun org-entry-protect-space (s)
15409 "Protect spaces and newline in string S."
15410 (while (string-match " " s)
15411 (setq s (replace-match "%20" t t s)))
15413 (setq s (replace-match "%0A" t t s)))
15414 s)
15416 (defun org-entry-restore-space (s)
15417 "Restore spaces and newline in string S."
15418 (while (string-match "%20" s)
15419 (setq s (replace-match " " t t s)))
15420 (while (string-match "%0A" s)
15422 s)
15424 (defvar org-entry-property-inherited-from (make-marker)
15425 "Marker pointing to the entry from where a property was inherited.
15426 Each call to `org-entry-get-with-inheritance' will set this marker to the
15427 location of the entry where the inheritance search matched. If there was
15428 no match, the marker will point nowhere.
15429 Note that also `org-entry-get' calls this function, if the INHERIT flag
15430 is set.")
15432 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15433 "Get PROPERTY of entry or content at point, search higher levels if needed.
15434 The search will stop at the first ancestor which has the property defined.
15436 should be considered as undefined (this is the meaning of nil here).
15438 (move-marker org-entry-property-inherited-from nil)
15439 (let (tmp)
15440 (save-excursion
15441 (save-restriction
15442 (widen)
15443 (catch 'ex
15444 (while t
15445 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15446 (or (ignore-errors (org-back-to-heading t))
15447 (goto-char (point-min)))
15448 (move-marker org-entry-property-inherited-from (point))
15449 (throw 'ex tmp))
15450 (or (ignore-errors (org-up-heading-safe))
15451 (throw 'ex nil))))))
15452 (setq tmp (or tmp
15453 (cdr (assoc property org-file-properties))
15454 (cdr (assoc property org-global-properties))
15455 (cdr (assoc property org-global-properties-fixed))))
15456 (if literal-nil tmp (org-not-nil tmp))))
15458 (defvar org-property-changed-functions nil
15459 "Hook called when the value of a property has changed.
15460 Each hook function should accept two arguments, the name of the property
15461 and the new value.")
15463 (defun org-entry-put (pom property value)
15464 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15465 (org-with-point-at pom
15466 (org-back-to-heading t)
15467 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15468 range)
15469 (cond
15470 ((equal property "TODO")
15472 (not (member value org-todo-keywords-1)))
15474 (if (or (not value)
15476 (setq value 'none))
15477 (org-todo value)
15478 (org-set-tags nil 'align))
15479 ((equal property "PRIORITY")
15481 (string-to-char value) ?\ ))
15482 (org-set-tags nil 'align))
15483 ((equal property "CLOCKSUM")
15484 (if (not (re-search-forward
15486 (error "Cannot find a clock log")
15487 (goto-char (- (match-end 1) 2))
15488 (cond
15489 ((eq value 'earlier) (org-timestamp-down))
15490 ((eq value 'later) (org-timestamp-up)))
15491 (org-clock-sum-current-item)))
15492 ((equal property "SCHEDULED")
15493 (if (re-search-forward org-scheduled-time-regexp end t)
15494 (cond
15495 ((eq value 'earlier) (org-timestamp-change -1 'day))
15496 ((eq value 'later) (org-timestamp-change 1 'day))
15497 (t (call-interactively 'org-schedule)))
15498 (call-interactively 'org-schedule)))
15499 ((equal property "DEADLINE")
15500 (if (re-search-forward org-deadline-time-regexp end t)
15501 (cond
15502 ((eq value 'earlier) (org-timestamp-change -1 'day))
15503 ((eq value 'later) (org-timestamp-change 1 'day))
15504 (t (call-interactively 'org-deadline)))
15505 (call-interactively 'org-deadline)))
15506 ((member property org-special-properties)
15507 (error "The %s property can not yet be set with `org-entry-put'"
15508 property))
15509 (t ; a non-special property
15510 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15511 (setq range (org-get-property-block beg end 'force))
15512 (goto-char (car range))
15513 (if (re-search-forward
15514 (org-re-property property) (cdr range) t)
15515 (progn
15516 (delete-region (match-beginning 0) (match-end 0))
15517 (goto-char (match-beginning 0)))
15518 (goto-char (cdr range))
15520 (backward-char 1)
15521 (org-indent-line))
15522 (insert ":" property ":")
15523 (and value (insert " " value))
15524 (org-indent-line)))))
15525 (run-hook-with-args 'org-property-changed-functions property value)))
15527 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15528 "Get all property keys in the current buffer.
15529 With INCLUDE-SPECIALS, also list the special properties that reflect things
15530 like tags and TODO state.
15531 With INCLUDE-DEFAULTS, also include properties that has special meaning
15532 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15533 and others.
15534 With INCLUDE-COLUMNS, also include property names given in COLUMN
15535 formats in the current buffer."
15536 (let (rtn range cfmt s p)
15537 (save-excursion
15538 (save-restriction
15539 (widen)
15540 (goto-char (point-min))
15541 (while (re-search-forward org-property-start-re nil t)
15542 (setq range (org-get-property-block))
15543 (goto-char (car range))
15544 (while (re-search-forward org-property-re
15545 (cdr range) t)
15546 (add-to-list 'rtn (org-match-string-no-properties 2)))
15547 (outline-next-heading))))
15549 (when include-specials
15550 (setq rtn (append org-special-properties rtn)))
15552 (when include-defaults
15553 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15554 (add-to-list 'rtn org-effort-property))
15556 (when include-columns
15557 (save-excursion
15558 (save-restriction
15559 (widen)
15560 (goto-char (point-min))
15561 (while (re-search-forward
15563 nil t)
15564 (setq cfmt (match-string 2) s 0)
15566 cfmt s)
15567 (setq s (match-end 0)
15568 p (match-string 1 cfmt))
15569 (unless (or (equal p "ITEM")
15570 (member p org-special-properties))
15571 (add-to-list 'rtn (match-string 1 cfmt))))))))
15573 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15575 (defun org-property-values (key)
15576 "Return a list of all values of property KEY in the current buffer."
15577 (save-excursion
15578 (save-restriction
15579 (widen)
15580 (goto-char (point-min))
15581 (let ((re (org-re-property key))
15582 values)
15583 (while (re-search-forward re nil t)
15584 (add-to-list 'values (org-trim (match-string 3))))
15585 (delete "" values)))))
15587 (defun org-insert-property-drawer ()
15588 "Insert a property drawer into the current entry."
15589 (org-back-to-heading t)
15590 (looking-at org-outline-regexp)
15591 (let ((indent (if org-adapt-indentation
15592 (- (match-end 0) (match-beginning 0))
15593 0))
15594 (beg (point))
15596 end hiddenp)
15597 (outline-next-heading)
15598 (setq end (point))
15599 (goto-char beg)
15600 (while (re-search-forward re end t))
15601 (setq hiddenp (outline-invisible-p))
15602 (end-of-line 1)
15605 (if (member (match-string 1) '("CLOCK:" ":END:"))
15606 ;; just skip this line
15607 (beginning-of-line 2)
15608 ;; Drawer start, find the end
15610 (beginning-of-line 1)))
15611 (org-skip-over-state-notes)
15614 (forward-char 1))
15615 (goto-char (point-at-eol))
15617 (beginning-of-line 0)
15618 (org-indent-to-column indent)
15619 (beginning-of-line 2)
15620 (org-indent-to-column indent)
15621 (beginning-of-line 0)
15622 (if hiddenp
15623 (save-excursion
15624 (org-back-to-heading t)
15625 (hide-entry))
15626 (org-flag-drawer t))))
15628 (defun org-insert-drawer (&optional arg drawer)
15629 "Insert a drawer at point.
15631 Optional argument DRAWER, when non-nil, is a string representing
15632 drawer's name. Otherwise, the user is prompted for a name.
15634 If a region is active, insert the drawer around that region
15635 instead.
15637 Point is left between drawer's boundaries."
15638 (interactive "P")
15639 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15640 "LOGBOOK"))
15641 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15642 ;; internally by Org. They are meant to be inserted
15643 ;; automatically.
15644 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15645 ;; Remove system drawers from list. Note: For some reason,
15646 ;; `org-completing-read' ignores the predicate while
15647 ;; `completing-read' handles it fine.
15648 (drawer (if arg "PROPERTIES"
15649 (or drawer
15650 (completing-read
15651 "Drawer: " org-drawers
15652 (lambda (d) (not (member d system-drawers))))))))
15653 (cond
15654 ;; With C-u, fall back on `org-insert-property-drawer'
15655 (arg (org-insert-property-drawer))
15656 ;; With an active region, insert a drawer at point.
15657 ((not (org-region-active-p))
15658 (progn
15661 (forward-line -2)))
15662 ;; Otherwise, insert the drawer at point
15663 (t
15664 (let ((rbeg (region-beginning))
15665 (rend (copy-marker (region-end))))
15666 (unwind-protect
15667 (progn
15668 (goto-char rbeg)
15669 (beginning-of-line)
15670 (when (save-excursion
15671 (re-search-forward org-outline-regexp-bol rend t))
15672 (user-error "Drawers cannot contain headlines"))
15673 ;; Position point at the beginning of the first
15674 ;; non-blank line in region. Insert drawer's opening
15675 ;; there, then indent it.
15676 (org-skip-whitespace)
15677 (beginning-of-line)
15679 (forward-line -1)
15680 (indent-for-tab-command)
15681 ;; Move point to the beginning of the first blank line
15682 ;; after the last non-blank line in region. Insert
15683 ;; drawer's closing, then indent it.
15684 (goto-char rend)
15687 (deactivate-mark t)
15688 (indent-for-tab-command)
15690 ;; Clear marker, whatever the outcome of insertion is.
15691 (set-marker rend nil)))))))
15693 (defvar org-property-set-functions-alist nil
15694 "Property set function alist.
15695 Each entry should have the following format:
15697 (PROPERTY . READ-FUNCTION)
15699 The read function will be called with the same argument as
15700 `org-completing-read'.")
15702 (defun org-set-property-function (property)
15703 "Get the function that should be used to set PROPERTY.
15704 This is computed according to `org-property-set-functions-alist'."
15705 (or (cdr (assoc property org-property-set-functions-alist))
15706 'org-completing-read))
15708 (defun org-read-property-value (property)
15709 "Read PROPERTY value from user."
15710 (let* ((completion-ignore-case t)
15711 (allowed (org-property-get-allowed-values nil property 'table))
15712 (cur (org-entry-get nil property))
15713 (prompt (concat property " value"
15715 (concat " [" cur "]") "") ": "))
15716 (set-function (org-set-property-function property))
15717 (val (if allowed
15718 (funcall set-function prompt allowed nil
15719 (not (get-text-property 0 'org-unrestricted
15720 (caar allowed))))
15721 (let (org-completion-use-ido org-completion-use-iswitchb)
15722 (funcall set-function prompt
15723 (mapcar 'list (org-property-values property))
15724 nil nil "" nil cur)))))
15725 (if (equal val "")
15726 cur
15727 val)))
15729 (defvar org-last-set-property nil)
15730 (defvar org-last-set-property-value nil)
15731 (defun org-read-property-name ()
15732 "Read a property name."
15733 (let* ((completion-ignore-case t)
15734 (keys (org-buffer-property-keys nil t t))
15735 (default-prop (or (save-excursion
15736 (save-match-data
15737 (beginning-of-line)
15739 (null (string= (match-string 1) "END"))
15740 (match-string 1))))
15741 org-last-set-property))
15742 (property (org-icompleting-read
15743 (concat "Property"
15744 (if default-prop (concat " [" default-prop "]") "")
15745 ": ")
15746 (mapcar 'list keys)
15747 nil nil nil nil
15748 default-prop)))
15749 (if (member property keys)
15750 property
15751 (or (cdr (assoc (downcase property)
15752 (mapcar (lambda (x) (cons (downcase x) x))
15753 keys)))
15754 property))))
15756 (defun org-set-property-and-value (use-last)
15757 "Allow to set [PROPERTY]: [value] direction from prompt.
15758 When use-default, don't even ask, just use the last
15760 (interactive "P")
15761 (let* ((completion-ignore-case t)
15762 (pv (or (and use-last org-last-set-property-value)
15763 (org-completing-read
15765 nil nil nil nil nil
15766 org-last-set-property-value)))
15767 prop val)
15769 (setq prop (match-string 1 pv)
15770 val (match-string 2 pv))
15771 (org-set-property prop val))))
15773 (defun org-set-property (property value)
15774 "In the current entry, set PROPERTY to VALUE.
15775 When called interactively, this will prompt for a property name, offering
15776 completion on existing and default properties. And then it will prompt
15777 for a value, offering completion either on allowed values (via an inherited
15778 xxx_ALL property) or on existing values in other instances of this property
15779 in the current file."
15780 (interactive (list nil nil))
15781 (let* ((property (or property (org-read-property-name)))
15782 (value (or value (org-read-property-value property)))
15783 (fn (cdr (assoc property org-properties-postprocess-alist))))
15784 (setq org-last-set-property property)
15785 (setq org-last-set-property-value (concat property ": " value))
15786 ;; Possibly postprocess the inserted value:
15787 (when fn (setq value (funcall fn value)))
15788 (unless (equal (org-entry-get nil property) value)
15789 (org-entry-put nil property value))))
15791 (defun org-delete-property (property &optional delete-empty-drawer)
15792 "In the current entry, delete PROPERTY.
15793 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15794 an empty drawer to delete."
15795 (interactive
15796 (let* ((completion-ignore-case t)
15797 (prop (org-icompleting-read "Property: "
15798 (org-entry-properties nil 'standard))))
15799 (list prop)))
15800 (message "Property %s %s" property
15801 (if (org-entry-delete nil property delete-empty-drawer)
15802 "deleted"
15803 "was not present in the entry")))
15805 (defun org-delete-property-globally (property)
15806 "Remove PROPERTY globally, from all entries."
15807 (interactive
15808 (let* ((completion-ignore-case t)
15809 (prop (org-icompleting-read
15810 "Globally remove property: "
15811 (mapcar 'list (org-buffer-property-keys)))))
15812 (list prop)))
15813 (save-excursion
15814 (save-restriction
15815 (widen)
15816 (goto-char (point-min))
15817 (let ((cnt 0))
15818 (while (re-search-forward
15819 (org-re-property property)
15820 nil t)
15821 (setq cnt (1+ cnt))
15822 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15825 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15827 (defun org-compute-property-at-point ()
15828 "Compute the property at point.
15829 This looks for an enclosing column format, extracts the operator and
15830 then applies it to the property in the column format's scope."
15831 (interactive)
15832 (unless (org-at-property-p)
15833 (user-error "Not at a property"))
15834 (let ((prop (org-match-string-no-properties 2)))
15835 (org-columns-get-format-and-top-level)
15836 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15837 (user-error "No operator defined for property %s" prop))
15838 (org-columns-compute prop)))
15840 (defvar org-property-allowed-value-functions nil
15841 "Hook for functions supplying allowed values for a specific property.
15842 The functions must take a single argument, the name of the property, and
15844 the values, this means that these values are intended as defaults for
15845 completion, but that other values should be allowed too.
15846 The functions must return nil if they are not responsible for this
15847 property.")
15849 (defun org-property-get-allowed-values (pom property &optional table)
15850 "Get allowed values for the property PROPERTY.
15851 When TABLE is non-nil, return an alist that can directly be used for
15852 completion."
15853 (let (vals)
15854 (cond
15855 ((equal property "TODO")
15856 (setq vals (org-with-point-at pom
15857 (append org-todo-keywords-1 '("")))))
15858 ((equal property "PRIORITY")
15859 (let ((n org-lowest-priority))
15860 (while (>= n org-highest-priority)
15861 (push (char-to-string n) vals)
15862 (setq n (1- n)))))
15863 ((member property org-special-properties))
15864 ((setq vals (run-hook-with-args-until-success
15865 'org-property-allowed-value-functions property)))
15866 (t
15867 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15869 (setq vals (car (read-from-string (concat "(" vals ")"))))
15870 (setq vals (mapcar (lambda (x)
15871 (cond ((stringp x) x)
15872 ((numberp x) (number-to-string x))
15873 ((symbolp x) (symbol-name x))
15874 (t "???")))
15875 vals)))))
15876 (when (member ":ETC" vals)
15877 (setq vals (remove ":ETC" vals))
15878 (org-add-props (car vals) '(org-unrestricted t)))
15879 (if table (mapcar 'list vals) vals)))
15881 (defun org-property-previous-allowed-value (&optional previous)
15882 "Switch to the next allowed value for this property."
15883 (interactive)
15884 (org-property-next-allowed-value t))
15886 (defun org-property-next-allowed-value (&optional previous)
15887 "Switch to the next allowed value for this property."
15888 (interactive)
15889 (unless (org-at-property-p)
15890 (user-error "Not at a property"))
15891 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15892 (key (match-string 2))
15893 (value (match-string 3))
15894 (allowed (or (org-property-get-allowed-values (point) key)
15895 (and (member value '("[ ]" "[-]" "[X]"))
15896 '("[ ]" "[X]"))))
15897 (heading (save-match-data (nth 4 (org-heading-components))))
15898 nval)
15899 (unless allowed
15900 (user-error "Allowed values for this property have not been defined"))
15901 (if previous (setq allowed (reverse allowed)))
15902 (if (member value allowed)
15903 (setq nval (car (cdr (member value allowed)))))
15904 (setq nval (or nval (car allowed)))
15905 (if (equal nval value)
15906 (user-error "Only one allowed value for this property"))
15907 (org-at-property-p)
15908 (replace-match (concat " :" key ": " nval) t t)
15909 (org-indent-line)
15910 (beginning-of-line 1)
15912 (when (equal prop org-effort-property)
15913 (save-excursion
15914 (org-back-to-heading t)
15915 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15916 (when (string= org-clock-current-task heading)
15917 (setq org-clock-effort nval)
15918 (org-clock-update-mode-line)))
15919 (run-hook-with-args 'org-property-changed-functions key nval)))
15921 (defun org-find-olp (path &optional this-buffer)
15922 "Return a marker pointing to the entry at outline path OLP.
15923 If anything goes wrong, throw an error.
15924 You can wrap this call to catch the error like this:
15926 (condition-case msg
15927 (org-mobile-locate-entry (match-string 4))
15928 (error (nth 1 msg)))
15930 The return value will then be either a string with the error message,
15931 or a marker if everything is OK.
15933 If THIS-BUFFER is set, the outline path does not contain a file,
15934 only headings."
15935 (let* ((file (if this-buffer buffer-file-name (pop path)))
15936 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15937 (level 1)
15938 (lmin 1)
15939 (lmax 1)
15940 limit re end found pos heading cnt flevel)
15941 (unless buffer (error "File not found :%s" file))
15942 (with-current-buffer buffer
15943 (save-excursion
15944 (save-restriction
15945 (widen)
15946 (setq limit (point-max))
15947 (goto-char (point-min))
15948 (while (setq heading (pop path))
15949 (setq re (format org-complex-heading-regexp-format
15950 (regexp-quote heading)))
15951 (setq cnt 0 pos (point))
15952 (while (re-search-forward re end t)
15953 (setq level (- (match-end 1) (match-beginning 1)))
15954 (if (and (>= level lmin) (<= level lmax))
15955 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15956 (when (= cnt 0) (error "Heading not found on level %d: %s"
15957 lmax heading))
15958 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15959 lmax heading))
15960 (goto-char found)
15961 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15962 (setq end (save-excursion (org-end-of-subtree t t))))
15963 (when (org-at-heading-p)
15964 (point-marker)))))))
15966 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15967 "Find node HEADING in BUFFER.
15968 Return a marker to the heading if it was found, or nil if not.
15969 If POS-ONLY is set, return just the position instead of a marker.
15971 The heading text must match exact, but it may have a TODO keyword,
15972 a priority cookie and tags in the standard locations."
15973 (with-current-buffer (or buffer (current-buffer))
15974 (save-excursion
15975 (save-restriction
15976 (widen)
15977 (goto-char (point-min))
15978 (let (case-fold-search)
15979 (if (re-search-forward
15980 (format org-complex-heading-regexp-format
15981 (regexp-quote heading)) nil t)
15982 (if pos-only
15983 (match-beginning 0)
15984 (move-marker (make-marker) (match-beginning 0)))))))))
15986 (defun org-find-exact-heading-in-directory (heading &optional dir)
15987 "Find Org node headline HEADING in all .org files in directory DIR.
15988 When the target headline is found, return a marker to this location."
15989 (let ((files (directory-files (or dir default-directory)
15991 file visiting m buffer)
15992 (catch 'found
15993 (while (setq file (pop files))
15994 (message "trying %s" file)
15995 (setq visiting (org-find-base-buffer-visiting file))
15996 (setq buffer (or visiting (find-file-noselect file)))
15997 (setq m (org-find-exact-headline-in-buffer
15998 heading buffer))
15999 (when (and (not m) (not visiting)) (kill-buffer buffer))
16000 (and m (throw 'found m))))))
16002 (defun org-find-entry-with-id (ident)
16003 "Locate the entry that contains the ID property with exact value IDENT.
16004 IDENT can be a string, a symbol or a number, this function will search for
16005 the string representation of it.
16006 Return the position where this entry starts, or nil if there is no such entry."
16007 (interactive "sID: ")
16008 (let ((id (cond
16009 ((stringp ident) ident)
16010 ((symbol-name ident) (symbol-name ident))
16011 ((numberp ident) (number-to-string ident))
16012 (t (error "IDENT %s must be a string, symbol or number" ident))))
16013 (case-fold-search nil))
16014 (save-excursion
16015 (save-restriction
16016 (widen)
16017 (goto-char (point-min))
16018 (when (re-search-forward
16020 nil t)
16021 (org-back-to-heading t)
16022 (point))))))
16024 ;;;; Timestamps
16026 (defvar org-last-changed-timestamp nil)
16027 (defvar org-last-inserted-timestamp nil
16028 "The last time stamp inserted with `org-insert-time-stamp'.")
16029 (defvar org-time-was-given) ; dynamically scoped parameter
16030 (defvar org-end-time-was-given) ; dynamically scoped parameter
16031 (defvar org-ts-what) ; dynamically scoped parameter
16033 (defun org-time-stamp (arg &optional inactive)
16034 "Prompt for a date/time and insert a time stamp.
16035 If the user specifies a time like HH:MM or if this command is
16036 called with at least one prefix argument, the time stamp contains
16037 the date and the time. Otherwise, only the date is be included.
16039 All parts of a date not specified by the user is filled in from
16040 the current date/time. So if you just press return without
16041 typing anything, the time stamp will represent the current
16042 date/time.
16044 If there is already a timestamp at the cursor, it will be
16045 modified.
16047 With two universal prefix arguments, insert an active timestamp
16048 with the current time without prompting the user.
16050 When called from lisp, the timestamp is inactive if INACTIVE is
16051 non-nil."
16052 (interactive "P")
16053 (let* ((ts nil)
16054 (default-time
16055 ;; Default time is either today, or, when entering a range,
16056 ;; the range start.
16057 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16058 (save-excursion
16059 (re-search-backward
16061 (- (point) 20) t)))
16062 (apply 'encode-time (org-parse-time-string (match-string 1)))
16063 (current-time)))
16064 (default-input (and ts (org-get-compact-tod ts)))
16065 (repeater (save-excursion
16066 (save-match-data
16067 (beginning-of-line)
16068 (when (re-search-forward
16070 (save-excursion (progn (end-of-line) (point))) t)
16071 (match-string 0)))))
16072 org-time-was-given org-end-time-was-given time)
16073 (cond
16074 ((and (org-at-timestamp-p t)
16075 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16076 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16077 (insert "--")
16078 (setq time (let ((this-command this-command))
16079 (org-read-date arg 'totime nil nil
16080 default-time default-input inactive)))
16081 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16082 ((org-at-timestamp-p t)
16083 (setq time (let ((this-command this-command))
16084 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16085 (when (org-at-timestamp-p t) ; just to get the match data
16086 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16087 (replace-match "")
16088 (setq org-last-changed-timestamp
16089 (org-insert-time-stamp
16090 time (or org-time-was-given arg)
16091 inactive nil nil (list org-end-time-was-given)))
16092 (when repeater (goto-char (1- (point))) (insert " " repeater)
16093 (setq org-last-changed-timestamp
16094 (concat (substring org-last-inserted-timestamp 0 -1)
16095 " " repeater ">"))))
16096 (message "Timestamp updated"))
16097 ((equal arg '(16))
16098 (org-insert-time-stamp (current-time) t inactive))
16099 (t
16100 (setq time (let ((this-command this-command))
16101 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16102 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16103 nil nil (list org-end-time-was-given))))))
16105 ;; FIXME: can we use this for something else, like computing time differences?
16106 (defun org-get-compact-tod (s)
16107 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16108 (let* ((t1 (match-string 1 s))
16109 (h1 (string-to-number (match-string 2 s)))
16110 (m1 (string-to-number (match-string 3 s)))
16111 (t2 (and (match-end 4) (match-string 5 s)))
16112 (h2 (and t2 (string-to-number (match-string 6 s))))
16113 (m2 (and t2 (string-to-number (match-string 7 s))))
16114 dh dm)
16115 (if (not t2)
16116 t1
16117 (setq dh (- h2 h1) dm (- m2 m1))
16118 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16119 (concat t1 "+" (number-to-string dh)
16120 (and (/= 0 dm) (format ":%02d" dm)))))))
16122 (defun org-time-stamp-inactive (&optional arg)
16123 "Insert an inactive time stamp.
16124 An inactive time stamp is enclosed in square brackets instead of angle
16125 brackets. It is inactive in the sense that it does not trigger agenda entries,
16126 does not link to the calendar and cannot be changed with the S-cursor keys.
16127 So these are more for recording a certain time/date."
16128 (interactive "P")
16129 (org-time-stamp arg 'inactive))
16131 (defvar org-date-ovl (make-overlay 1 1))
16132 (overlay-put org-date-ovl 'face 'org-date-selected)
16133 (org-detach-overlay org-date-ovl)
16135 (defvar org-ans1) ; dynamically scoped parameter
16136 (defvar org-ans2) ; dynamically scoped parameter
16138 (defvar org-plain-time-of-day-regexp) ; defined below
16140 (defvar org-overriding-default-time nil) ; dynamically scoped
16141 (defvar org-read-date-overlay nil)
16142 (defvar org-dcst nil) ; dynamically scoped
16143 (defvar org-read-date-history nil)
16144 (defvar org-read-date-final-answer nil)
16145 (defvar org-read-date-analyze-futurep nil)
16146 (defvar org-read-date-analyze-forced-year nil)
16147 (defvar org-read-date-inactive)
16149 (defvar org-read-date-minibuffer-local-map
16150 (let* ((org-replace-disputed-keys nil)
16151 (map (make-sparse-keymap)))
16152 (set-keymap-parent map minibuffer-local-map)
16153 (org-defkey map (kbd ".")
16154 (lambda () (interactive)
16155 ;; Are we at the beginning of the prompt?
16156 (if (looking-back "^[^:]+: ")
16157 (org-eval-in-calendar '(calendar-goto-today))
16158 (insert "."))))
16159 (org-defkey map (kbd "C-.")
16160 (lambda () (interactive)
16161 (org-eval-in-calendar '(calendar-goto-today))))
16162 (org-defkey map [(meta shift left)]
16163 (lambda () (interactive)
16164 (org-eval-in-calendar '(calendar-backward-month 1))))
16165 (org-defkey map [(meta shift right)]
16166 (lambda () (interactive)
16167 (org-eval-in-calendar '(calendar-forward-month 1))))
16168 (org-defkey map [(meta shift up)]
16169 (lambda () (interactive)
16170 (org-eval-in-calendar '(calendar-backward-year 1))))
16171 (org-defkey map [(meta shift down)]
16172 (lambda () (interactive)
16173 (org-eval-in-calendar '(calendar-forward-year 1))))
16174 (org-defkey map [?\e (shift left)]
16175 (lambda () (interactive)
16176 (org-eval-in-calendar '(calendar-backward-month 1))))
16177 (org-defkey map [?\e (shift right)]
16178 (lambda () (interactive)
16179 (org-eval-in-calendar '(calendar-forward-month 1))))
16180 (org-defkey map [?\e (shift up)]
16181 (lambda () (interactive)
16182 (org-eval-in-calendar '(calendar-backward-year 1))))
16183 (org-defkey map [?\e (shift down)]
16184 (lambda () (interactive)
16185 (org-eval-in-calendar '(calendar-forward-year 1))))
16186 (org-defkey map [(shift up)]
16187 (lambda () (interactive)
16188 (org-eval-in-calendar '(calendar-backward-week 1))))
16189 (org-defkey map [(shift down)]
16190 (lambda () (interactive)
16191 (org-eval-in-calendar '(calendar-forward-week 1))))
16192 (org-defkey map [(shift left)]
16193 (lambda () (interactive)
16194 (org-eval-in-calendar '(calendar-backward-day 1))))
16195 (org-defkey map [(shift right)]
16196 (lambda () (interactive)
16197 (org-eval-in-calendar '(calendar-forward-day 1))))
16198 (org-defkey map "!"
16199 (lambda () (interactive)
16200 (org-eval-in-calendar '(diary-view-entries))
16201 (message "")))
16202 (org-defkey map ">"
16203 (lambda () (interactive)
16204 (org-eval-in-calendar '(scroll-calendar-left 1))))
16205 (org-defkey map "<"
16206 (lambda () (interactive)
16207 (org-eval-in-calendar '(scroll-calendar-right 1))))
16208 (org-defkey map "\C-v"
16209 (lambda () (interactive)
16210 (org-eval-in-calendar
16211 '(calendar-scroll-left-three-months 1))))
16212 (org-defkey map "\M-v"
16213 (lambda () (interactive)
16214 (org-eval-in-calendar
16215 '(calendar-scroll-right-three-months 1))))
16216 map)
16217 "Keymap for minibuffer commands when using `org-read-date'.")
16219 (defun org-read-date (&optional org-with-time to-time from-string prompt
16220 default-time default-input inactive)
16221 "Read a date, possibly a time, and make things smooth for the user.
16222 The prompt will suggest to enter an ISO date, but you can also enter anything
16223 which will at least partially be understood by `parse-time-string'.
16224 Unrecognized parts of the date will default to the current day, month, year,
16225 hour and minute. If this command is called to replace a timestamp at point,
16226 or to enter the second timestamp of a range, the default time is taken
16227 from the existing stamp. Furthermore, the command prefers the future,
16228 so if you are giving a date where the year is not given, and the day-month
16229 combination is already past in the current year, it will assume you
16230 mean next year. For details, see the manual. A few examples:
16232 3-2-5 --> 2003-02-05
16233 feb 15 --> currentyear-02-15
16234 2/15 --> currentyear-02-15
16235 sep 12 9 --> 2009-09-12
16236 12:45 --> today 12:45
16237 22 sept 0:34 --> currentyear-09-22 0:34
16238 12 --> currentyear-currentmonth-12
16239 Fri --> nearest Friday after today
16240 -Tue --> last Tuesday
16241 etc.
16243 Furthermore you can specify a relative date by giving, as the *first* thing
16244 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16245 change in days weeks, months, years.
16246 With a single plus or minus, the date is relative to today. With a double
16247 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16248 +4d --> four days from today
16249 +4 --> same as above
16250 +2w --> two weeks from today
16251 ++5 --> five days from default date
16253 The function understands only English month and weekday abbreviations.
16255 While prompting, a calendar is popped up - you can also select the
16256 date with the mouse (button 1). The calendar shows a period of three
16257 months. To scroll it to other months, use the keys `>' and `<'.
16258 If you don't like the calendar, turn it off with
16259 \(setq org-read-date-popup-calendar nil)
16261 With optional argument TO-TIME, the date will immediately be converted
16262 to an internal time.
16263 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16264 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16265 still enter a time, and this function will inform the calling routine
16266 about this change. The calling routine may then choose to change the
16267 format used to insert the time stamp into the buffer to include the time.
16268 With optional argument FROM-STRING, read from this string instead from
16269 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16270 the time/date that is used for everything that is not specified by the
16271 user."
16272 (require 'parse-time)
16273 (let* ((org-time-stamp-rounding-minutes
16274 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16275 (org-dcst org-display-custom-times)
16276 (ct (org-current-time))
16277 (org-def (or org-overriding-default-time default-time ct))
16278 (org-defdecode (decode-time org-def))
16279 (dummy (progn
16280 (when (< (nth 2 org-defdecode) org-extend-today-until)
16281 (setcar (nthcdr 2 org-defdecode) -1)
16282 (setcar (nthcdr 1 org-defdecode) 59)
16283 (setq org-def (apply 'encode-time org-defdecode)
16284 org-defdecode (decode-time org-def)))))
16285 (mouse-autoselect-window nil) ; Don't let the mouse jump
16286 (calendar-frame-setup nil)
16287 (calendar-setup nil)
16288 (calendar-move-hook nil)
16289 (calendar-view-diary-initially-flag nil)
16290 (calendar-view-holidays-initially-flag nil)
16291 (timestr (format-time-string
16292 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16293 (prompt (concat (if prompt (concat prompt " ") "")
16294 (format "Date+time [%s]: " timestr)))
16295 ans (org-ans0 "") org-ans1 org-ans2 final)
16297 (cond
16298 (from-string (setq ans from-string))
16299 (org-read-date-popup-calendar
16300 (save-excursion
16301 (save-window-excursion
16302 (calendar)
16303 (org-eval-in-calendar '(setq cursor-type nil) t)
16304 (unwind-protect
16305 (progn
16306 (calendar-forward-day (- (time-to-days org-def)
16307 (calendar-absolute-from-gregorian
16308 (calendar-current-date))))
16309 (org-eval-in-calendar nil t)
16310 (let* ((old-map (current-local-map))
16311 (map (copy-keymap calendar-mode-map))
16312 (minibuffer-local-map
16313 (copy-keymap org-read-date-minibuffer-local-map)))
16314 (org-defkey map (kbd "RET") 'org-calendar-select)
16315 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16316 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16317 (unwind-protect
16318 (progn
16319 (use-local-map map)
16320 (setq org-read-date-inactive inactive)
16321 (add-hook 'post-command-hook 'org-read-date-display)
16322 (setq org-ans0 (read-string prompt default-input
16323 'org-read-date-history nil))
16324 ;; org-ans0: from prompt
16325 ;; org-ans1: from mouse click
16326 ;; org-ans2: from calendar motion
16327 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16328 (remove-hook 'post-command-hook 'org-read-date-display)
16329 (use-local-map old-map)
16330 (when org-read-date-overlay
16331 (delete-overlay org-read-date-overlay)
16332 (setq org-read-date-overlay nil)))))
16333 (bury-buffer "*Calendar*")))))
16335 (t ; Naked prompt only
16336 (unwind-protect
16337 (setq ans (read-string prompt default-input
16338 'org-read-date-history timestr))
16339 (when org-read-date-overlay
16340 (delete-overlay org-read-date-overlay)
16341 (setq org-read-date-overlay nil)))))
16343 (setq final (org-read-date-analyze ans org-def org-defdecode))
16345 (when org-read-date-analyze-forced-year
16346 (message "Year was forced into %s"
16347 (if org-read-date-force-compatible-dates
16348 "compatible range (1970-2037)"
16349 "range representable on this machine"))
16350 (ding))
16352 ;; One round trip to get rid of 34th of August and stuff like that....
16353 (setq final (decode-time (apply 'encode-time final)))
16355 (setq org-read-date-final-answer ans)
16357 (if to-time
16358 (apply 'encode-time final)
16359 (if (and (boundp 'org-time-was-given) org-time-was-given)
16360 (format "%04d-%02d-%02d %02d:%02d"
16361 (nth 5 final) (nth 4 final) (nth 3 final)
16362 (nth 2 final) (nth 1 final))
16363 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16365 (defvar org-def)
16366 (defvar org-defdecode)
16367 (defvar org-with-time)
16368 (defun org-read-date-display ()
16369 "Display the current date prompt interpretation in the minibuffer."
16370 (when org-read-date-display-live
16371 (when org-read-date-overlay
16372 (delete-overlay org-read-date-overlay))
16373 (when (minibufferp (current-buffer))
16374 (save-excursion
16375 (end-of-line 1)
16376 (while (not (equal (buffer-substring
16377 (max (point-min) (- (point) 4)) (point))
16378 " "))
16379 (insert " ")))
16380 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16381 " " (or org-ans1 org-ans2)))
16382 (org-end-time-was-given nil)
16383 (f (org-read-date-analyze ans org-def org-defdecode))
16384 (fmts (if org-dcst
16385 org-time-stamp-custom-formats
16386 org-time-stamp-formats))
16387 (fmt (if (or org-with-time
16388 (and (boundp 'org-time-was-given) org-time-was-given))
16389 (cdr fmts)
16390 (car fmts)))
16391 (txt (format-time-string fmt (apply 'encode-time f)))
16392 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16393 (txt (concat "=> " txt)))
16394 (when (and org-end-time-was-given
16395 (string-match org-plain-time-of-day-regexp txt))
16396 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16397 org-end-time-was-given
16398 (substring txt (match-end 0)))))
16399 (when org-read-date-analyze-futurep
16400 (setq txt (concat txt " (=>F)")))
16401 (setq org-read-date-overlay
16402 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16403 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16405 (defun org-read-date-analyze (ans org-def org-defdecode)
16406 "Analyze the combined answer of the date prompt."
16407 ;; FIXME: cleanup and comment
16408 (let ((nowdecode (decode-time (current-time)))
16409 delta deltan deltaw deltadef year month day
16410 hour minute second wday pm h2 m2 tl wday1
16411 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16412 (setq org-read-date-analyze-futurep nil
16413 org-read-date-analyze-forced-year nil)
16415 (setq ans "+0"))
16417 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16418 (setq ans (replace-match "" t t ans)
16419 deltan (car delta)
16420 deltaw (nth 1 delta)
16421 deltadef (nth 2 delta)))
16423 ;; Check if there is an iso week date in there. If yes, store the
16424 ;; info and postpone interpreting it until the rest of the parsing
16425 ;; is done.
16426 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16427 (setq iso-year (if (match-end 1)
16428 (org-small-year-to-year
16429 (string-to-number (match-string 1 ans))))
16430 iso-weekday (if (match-end 3)
16431 (string-to-number (match-string 3 ans)))
16432 iso-week (string-to-number (match-string 2 ans)))
16433 (setq ans (replace-match "" t t ans)))
16435 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16436 (when (string-match
16438 (setq year (if (match-end 2)
16439 (string-to-number (match-string 2 ans))
16440 (progn (setq kill-year t)
16441 (string-to-number (format-time-string "%Y"))))
16442 month (string-to-number (match-string 3 ans))
16443 day (string-to-number (match-string 4 ans)))
16444 (if (< year 100) (setq year (+ 2000 year)))
16446 t nil ans)))
16448 ;; Help matching dotted european dates
16449 (when (string-match
16450 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16451 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16452 (setq kill-year t)
16453 (string-to-number (format-time-string "%Y")))
16454 day (string-to-number (match-string 1 ans))
16455 month (string-to-number (match-string 2 ans))
16456 ans (replace-match (format "%04d-%02d-%02d" year month day)
16457 t nil ans)))
16459 ;; Help matching american dates, like 5/30 or 5/30/7
16460 (when (string-match
16461 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16462 (setq year (if (match-end 4)
16463 (string-to-number (match-string 4 ans))
16464 (progn (setq kill-year t)
16465 (string-to-number (format-time-string "%Y"))))
16466 month (string-to-number (match-string 1 ans))
16467 day (string-to-number (match-string 2 ans)))
16468 (if (< year 100) (setq year (+ 2000 year)))
16470 t nil ans)))
16471 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16472 ;; If there is a time with am/pm, and *no* time without it, we convert
16473 ;; so that matching will be successful.
16474 (loop for i from 1 to 2 do ; twice, for end time as well
16477 (setq hour (string-to-number (match-string 1 ans))
16478 minute (if (match-end 3)
16479 (string-to-number (match-string 3 ans))
16480 0)
16481 pm (equal ?p
16482 (string-to-char (downcase (match-string 4 ans)))))
16483 (if (and (= hour 12) (not pm))
16484 (setq hour 0)
16485 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16486 (setq ans (replace-match (format "%02d:%02d" hour minute)
16487 t t ans))))
16489 ;; Check if a time range is given as a duration
16490 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16491 (setq hour (string-to-number (match-string 1 ans))
16492 h2 (+ hour (string-to-number (match-string 3 ans)))
16493 minute (string-to-number (match-string 2 ans))
16494 m2 (+ minute (if (match-end 5) (string-to-number
16495 (match-string 5 ans))0)))
16496 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16497 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16498 t t ans)))
16500 ;; Check if there is a time range
16501 (when (boundp 'org-end-time-was-given)
16502 (setq org-time-was-given nil)
16503 (when (and (string-match org-plain-time-of-day-regexp ans)
16504 (match-end 8))
16505 (setq org-end-time-was-given (match-string 8 ans))
16506 (setq ans (concat (substring ans 0 (match-beginning 7))
16507 (substring ans (match-end 7))))))
16509 (setq tl (parse-time-string ans)
16510 day (or (nth 3 tl) (nth 3 org-defdecode))
16511 month (or (nth 4 tl)
16512 (if (and org-read-date-prefer-future
16513 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16514 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16515 (nth 4 org-defdecode)))
16516 year (or (and (not kill-year) (nth 5 tl))
16517 (if (and org-read-date-prefer-future
16518 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16519 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16520 (nth 5 org-defdecode)))
16521 hour (or (nth 2 tl) (nth 2 org-defdecode))
16522 minute (or (nth 1 tl) (nth 1 org-defdecode))
16523 second (or (nth 0 tl) 0)
16524 wday (nth 6 tl))
16526 (when (and (eq org-read-date-prefer-future 'time)
16527 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16528 (equal day (nth 3 nowdecode))
16529 (equal month (nth 4 nowdecode))
16530 (equal year (nth 5 nowdecode))
16531 (nth 2 tl)
16532 (or (< (nth 2 tl) (nth 2 nowdecode))
16533 (and (= (nth 2 tl) (nth 2 nowdecode))
16534 (nth 1 tl)
16535 (< (nth 1 tl) (nth 1 nowdecode)))))
16536 (setq day (1+ day)
16537 futurep t))
16539 ;; Special date definitions below
16540 (cond
16541 (iso-week
16542 ;; There was an iso week
16543 (require 'cal-iso)
16544 (setq futurep nil)
16545 (setq year (or iso-year year)
16546 day (or iso-weekday wday 1)
16547 wday nil ; to make sure that the trigger below does not match
16548 iso-date (calendar-gregorian-from-absolute
16549 (calendar-absolute-from-iso
16550 (list iso-week day year))))
16551 ; FIXME: Should we also push ISO weeks into the future?
16552 ; (when (and org-read-date-prefer-future
16553 ; (not iso-year)
16554 ; (< (calendar-absolute-from-gregorian iso-date)
16555 ; (time-to-days (current-time))))
16556 ; (setq year (1+ year)
16557 ; iso-date (calendar-gregorian-from-absolute
16558 ; (calendar-absolute-from-iso
16559 ; (list iso-week day year)))))
16560 (setq month (car iso-date)
16561 year (nth 2 iso-date)
16562 day (nth 1 iso-date)))
16563 (deltan
16564 (setq futurep nil)
16565 (unless deltadef
16566 (let ((now (decode-time (current-time))))
16567 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16568 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16569 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16570 ((equal deltaw "m") (setq month (+ month deltan)))
16571 ((equal deltaw "y") (setq year (+ year deltan)))))
16572 ((and wday (not (nth 3 tl)))
16573 ;; Weekday was given, but no day, so pick that day in the week
16574 ;; on or after the derived date.
16575 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16576 (unless (equal wday wday1)
16577 (setq day (+ day (% (- wday wday1 -7) 7))))))
16578 (if (and (boundp 'org-time-was-given)
16579 (nth 2 tl))
16580 (setq org-time-was-given t))
16581 (if (< year 100) (setq year (+ 2000 year)))
16582 ;; Check of the date is representable
16583 (if org-read-date-force-compatible-dates
16584 (progn
16585 (if (< year 1970)
16586 (setq year 1970 org-read-date-analyze-forced-year t))
16587 (if (> year 2037)
16588 (setq year 2037 org-read-date-analyze-forced-year t)))
16589 (condition-case nil
16590 (ignore (encode-time second minute hour day month year))
16591 (error
16592 (setq year (nth 5 org-defdecode))
16593 (setq org-read-date-analyze-forced-year t))))
16594 (setq org-read-date-analyze-futurep futurep)
16595 (list second minute hour day month year)))
16597 (defvar parse-time-weekdays)
16598 (defun org-read-date-get-relative (s today default)
16599 "Check string S for special relative date string.
16600 TODAY and DEFAULT are internal times, for today and for a default.
16601 Return shift list (N what def-flag)
16603 N is the number of WHATs to shift.
16604 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16605 the DEFAULT date rather than TODAY."
16606 (require 'parse-time)
16607 (when (and
16608 (string-match
16609 (concat
16614 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16615 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16616 (string-to-char (substring (match-string 1 s) -1))
16617 ?+))
16618 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16619 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16620 (what (if (match-end 3) (match-string 3 s) "d"))
16621 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16622 (date (if rel default today))
16623 (wday (nth 6 (decode-time date)))
16624 delta)
16625 (if wday1
16626 (progn
16627 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16628 (if (= delta 0) (setq delta 7))
16629 (if (= dir ?-)
16630 (progn
16631 (setq delta (- delta 7))
16632 (if (= delta 0) (setq delta -7))))
16633 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16634 (list delta "d" rel))
16635 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16637 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16638 "Turn a user-specified date into the internal representation.
16639 The internal representation needed by the calendar is (month day year).
16640 This is a wrapper to handle the brain-dead convention in calendar that
16641 user function argument order change dependent on argument order."
16642 (if (boundp 'calendar-date-style)
16643 (cond
16644 ((eq calendar-date-style 'american)
16645 (list arg1 arg2 arg3))
16646 ((eq calendar-date-style 'european)
16647 (list arg2 arg1 arg3))
16648 ((eq calendar-date-style 'iso)
16649 (list arg2 arg3 arg1)))
16650 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16651 (if (org-bound-and-true-p european-calendar-style)
16652 (list arg2 arg1 arg3)
16653 (list arg1 arg2 arg3)))))
16655 (defun org-eval-in-calendar (form &optional keepdate)
16656 "Eval FORM in the calendar window and return to current window.
16657 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16658 otherwise stick to the current value of `org-ans2'."
16659 (let ((sf (selected-frame))
16660 (sw (selected-window)))
16661 (select-window (get-buffer-window "*Calendar*" t))
16662 (eval form)
16663 (when (and (not keepdate) (calendar-cursor-to-date))
16664 (let* ((date (calendar-cursor-to-date))
16665 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16666 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16667 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16668 (select-window sw)
16669 (org-select-frame-set-input-focus sf)))
16671 (defun org-calendar-select ()
16672 "Return to `org-read-date' with the date currently selected.
16673 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16674 (interactive)
16675 (when (calendar-cursor-to-date)
16676 (let* ((date (calendar-cursor-to-date))
16677 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16678 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16679 (if (active-minibuffer-window) (exit-minibuffer))))
16681 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16682 "Insert a date stamp for the date given by the internal TIME.
16683 WITH-HM means use the stamp format that includes the time of the day.
16684 INACTIVE means use square brackets instead of angular ones, so that the
16685 stamp will not contribute to the agenda.
16686 PRE and POST are optional strings to be inserted before and after the
16687 stamp.
16688 The command returns the inserted time stamp."
16689 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16690 stamp)
16691 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16692 (insert-before-markers (or pre ""))
16693 (when (listp extra)
16694 (setq extra (car extra))
16695 (if (and (stringp extra)
16697 (setq extra (format "-%02d:%02d"
16698 (string-to-number (match-string 1 extra))
16699 (string-to-number (match-string 2 extra))))
16700 (setq extra nil)))
16701 (when extra
16702 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16703 (insert-before-markers (setq stamp (format-time-string fmt time)))
16704 (insert-before-markers (or post ""))
16705 (setq org-last-inserted-timestamp stamp)))
16707 (defun org-toggle-time-stamp-overlays ()
16708 "Toggle the use of custom time stamp formats."
16709 (interactive)
16710 (setq org-display-custom-times (not org-display-custom-times))
16711 (unless org-display-custom-times
16712 (let ((p (point-min)) (bmp (buffer-modified-p)))
16713 (while (setq p (next-single-property-change p 'display))
16714 (if (and (get-text-property p 'display)
16715 (eq (get-text-property p 'face) 'org-date))
16716 (remove-text-properties
16717 p (setq p (next-single-property-change p 'display))
16718 '(display t))))
16719 (set-buffer-modified-p bmp)))
16720 (if (featurep 'xemacs)
16721 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16722 (org-restart-font-lock)
16723 (setq org-table-may-need-update t)
16724 (if org-display-custom-times
16725 (message "Time stamps are overlaid with custom format")
16726 (message "Time stamp overlays removed")))
16728 (defun org-display-custom-time (beg end)
16729 "Overlay modified time stamp format over timestamp between BEG and END."
16730 (let* ((ts (buffer-substring beg end))
16731 t1 w1 with-hm tf time str w2 (off 0))
16732 (save-match-data
16733 (setq t1 (org-parse-time-string ts t))
16734 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16735 (setq off (- (match-end 0) (match-beginning 0)))))
16736 (setq end (- end off))
16737 (setq w1 (- end beg)
16738 with-hm (and (nth 1 t1) (nth 2 t1))
16739 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16740 time (org-fix-decoded-time t1)
16741 str (org-add-props
16742 (format-time-string
16743 (substring tf 1 -1) (apply 'encode-time time))
16744 nil 'mouse-face 'highlight)
16745 w2 (length str))
16746 (if (not (= w2 w1))
16747 (add-text-properties (1+ beg) (+ 2 beg)
16748 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16749 (if (featurep 'xemacs)
16750 (progn
16751 (put-text-property beg end 'invisible t)
16752 (put-text-property beg end 'end-glyph (make-glyph str)))
16753 (put-text-property beg end 'display str))))
16755 (defun org-translate-time (string)
16756 "Translate all timestamps in STRING to custom format.
16757 But do this only if the variable `org-display-custom-times' is set."
16758 (when org-display-custom-times
16759 (save-match-data
16760 (let* ((start 0)
16761 (re org-ts-regexp-both)
16762 t1 with-hm inactive tf time str beg end)
16763 (while (setq start (string-match re string start))
16764 (setq beg (match-beginning 0)
16765 end (match-end 0)
16766 t1 (save-match-data
16767 (org-parse-time-string (substring string beg end) t))
16768 with-hm (and (nth 1 t1) (nth 2 t1))
16769 inactive (equal (substring string beg (1+ beg)) "[")
16770 tf (funcall (if with-hm 'cdr 'car)
16771 org-time-stamp-custom-formats)
16772 time (org-fix-decoded-time t1)
16773 str (format-time-string
16774 (concat
16775 (if inactive "[" "<") (substring tf 1 -1)
16776 (if inactive "]" ">"))
16777 (apply 'encode-time time))
16778 string (replace-match str t t string)
16779 start (+ start (length str)))))))
16780 string)
16782 (defun org-fix-decoded-time (time)
16783 "Set 0 instead of nil for the first 6 elements of time.
16784 Don't touch the rest."
16785 (let ((n 0))
16786 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16788 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16790 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16791 "Difference between TIMESTAMP-STRING and now in days.
16792 If SECONDS is non-nil, return the difference in seconds."
16793 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16794 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16795 (funcall fdiff (current-time)))))
16797 (defun org-deadline-close (timestamp-string &optional ndays)
16798 "Is the time in TIMESTAMP-STRING close to the current date?"
16799 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16800 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16801 (not (org-entry-is-done-p))))
16803 (defun org-get-wdays (ts &optional delay zero-delay)
16804 "Get the deadline lead time appropriate for timestring TS.
16805 When DELAY is non-nil, get the delay time for scheduled items
16806 instead of the deadline lead time. When ZERO-DELAY is non-nil
16807 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16808 don't try to find the delay cookie in the scheduled timestamp."
16809 (let ((tv (if delay org-scheduled-delay-days
16810 org-deadline-warning-days)))
16811 (cond
16812 ((or (and delay (< tv 0))
16813 (and delay zero-delay (<= tv 0))
16814 (and (not delay) (<= tv 0)))
16815 ;; Enforce this value no matter what
16816 (- tv))
16818 ;; lead time is specified.
16819 (floor (* (string-to-number (match-string 1 ts))
16820 (cdr (assoc (match-string 2 ts)
16821 '(("d" . 1) ("w" . 7)
16822 ("m" . 30.4) ("y" . 365.25)
16823 ("h" . 0.041667)))))))
16824 ;; go for the default.
16825 (t tv))))
16827 (defun org-calendar-select-mouse (ev)
16828 "Return to `org-read-date' with the date currently selected.
16829 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16830 (interactive "e")
16831 (mouse-set-point ev)
16832 (when (calendar-cursor-to-date)
16833 (let* ((date (calendar-cursor-to-date))
16834 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16835 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16836 (if (active-minibuffer-window) (exit-minibuffer))))
16838 (defun org-check-deadlines (ndays)
16839 "Check if there are any deadlines due or past due.
16840 A deadline is considered due if it happens within `org-deadline-warning-days'
16841 days from today's date. If the deadline appears in an entry marked DONE,
16842 it is not shown. The prefix arg NDAYS can be used to test that many
16844 (interactive "P")
16845 (let* ((org-warn-days
16846 (cond
16847 ((equal ndays '(4)) 100000)
16848 (ndays (prefix-numeric-value ndays))
16849 (t (abs org-deadline-warning-days))))
16850 (case-fold-search nil)
16852 (callback
16853 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16855 (message "%d deadlines past-due or due within %d days"
16856 (org-occur regexp nil callback)
16857 org-warn-days)))
16859 (defsubst org-re-timestamp (type)
16860 "Return a regexp for timestamp TYPE.
16861 Allowed values for TYPE are:
16863 all: all timestamps
16864 active: only active timestamps (<...>)
16865 inactive: only inactive timestamps ([...])
16866 scheduled: only scheduled timestamps
16867 deadline: only deadline timestamps
16868 closed: only closed time-stamps
16870 When TYPE is nil, fall back on returning a regexp that matches
16871 both scheduled and deadline timestamps."
16872 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16873 ((eq type 'active) org-ts-regexp)
16877 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16878 ((eq type 'scheduled-or-deadline)
16881 (defun org-check-before-date (date)
16882 "Check if there are deadlines or scheduled entries before DATE."
16883 (interactive (list (org-read-date)))
16884 (let ((case-fold-search nil)
16885 (regexp (org-re-timestamp org-ts-type))
16886 (callback
16887 (lambda () (time-less-p
16888 (org-time-string-to-time (match-string 1))
16889 (org-time-string-to-time date)))))
16890 (message "%d entries before %s"
16891 (org-occur regexp nil callback) date)))
16893 (defun org-check-after-date (date)
16894 "Check if there are deadlines or scheduled entries after DATE."
16895 (interactive (list (org-read-date)))
16896 (let ((case-fold-search nil)
16897 (regexp (org-re-timestamp org-ts-type))
16898 (callback
16899 (lambda () (not
16900 (time-less-p
16901 (org-time-string-to-time (match-string 1))
16902 (org-time-string-to-time date))))))
16903 (message "%d entries after %s"
16904 (org-occur regexp nil callback) date)))
16906 (defun org-check-dates-range (start-date end-date)
16907 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16908 (interactive (list (org-read-date nil nil nil "Range starts")
16909 (org-read-date nil nil nil "Range end")))
16910 (let ((case-fold-search nil)
16911 (regexp (org-re-timestamp org-ts-type))
16912 (callback
16913 (lambda ()
16914 (let ((match (match-string 1)))
16915 (and
16916 (not (time-less-p
16917 (org-time-string-to-time match)
16918 (org-time-string-to-time start-date)))
16919 (time-less-p
16920 (org-time-string-to-time match)
16921 (org-time-string-to-time end-date)))))))
16922 (message "%d entries between %s and %s"
16923 (org-occur regexp nil callback) start-date end-date)))
16925 (defun org-evaluate-time-range (&optional to-buffer)
16926 "Evaluate a time range by computing the difference between start and end.
16927 Normally the result is just printed in the echo area, but with prefix arg
16928 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16929 If the time range is actually in a table, the result is inserted into the
16930 next column.
16931 For time difference computation, a year is assumed to be exactly 365
16932 days in order to avoid rounding problems."
16933 (interactive "P")
16934 (or
16935 (org-clock-update-time-maybe)
16936 (save-excursion
16937 (unless (org-at-date-range-p t)
16938 (goto-char (point-at-bol))
16939 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16940 (if (not (org-at-date-range-p t))
16941 (user-error "Not at a time-stamp range, and none found in current line")))
16942 (let* ((ts1 (match-string 1))
16943 (ts2 (match-string 2))
16944 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16945 (match-end (match-end 0))
16946 (time1 (org-time-string-to-time ts1))
16947 (time2 (org-time-string-to-time ts2))
16948 (t1 (org-float-time time1))
16949 (t2 (org-float-time time2))
16950 (diff (abs (- t2 t1)))
16951 (negative (< (- t2 t1) 0))
16952 ;; (ys (floor (* 365 24 60 60)))
16953 (ds (* 24 60 60))
16954 (hs (* 60 60))
16955 (fy "%dy %dd %02d:%02d")
16956 (fy1 "%dy %dd")
16957 (fd "%dd %02d:%02d")
16958 (fd1 "%dd")
16959 (fh "%02d:%02d")
16960 y d h m align)
16961 (if havetime
16962 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16963 y 0
16964 d (floor (/ diff ds)) diff (mod diff ds)
16965 h (floor (/ diff hs)) diff (mod diff hs)
16966 m (floor (/ diff 60)))
16967 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16968 y 0
16969 d (floor (+ (/ diff ds) 0.5))
16970 h 0 m 0))
16971 (if (not to-buffer)
16972 (message "%s" (org-make-tdiff-string y d h m))
16973 (if (org-at-table-p)
16974 (progn
16975 (goto-char match-end)
16976 (setq align t)
16977 (and (looking-at " *|") (goto-char (match-end 0))))
16978 (goto-char match-end))
16979 (if (looking-at
16981 (replace-match ""))
16982 (if negative (insert " -"))
16983 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16984 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16985 (insert " " (format fh h m))))
16986 (if align (org-table-align))
16987 (message "Time difference inserted")))))
16989 (defun org-make-tdiff-string (y d h m)
16990 (let ((fmt "")
16991 (l nil))
16992 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16993 l (push y l)))
16994 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16995 l (push d l)))
16996 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16997 l (push h l)))
16998 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16999 l (push m l)))
17000 (apply 'format fmt (nreverse l))))
17002 (defun org-time-string-to-time (s &optional buffer pos)
17003 "Convert a timestamp string into internal time."
17004 (condition-case errdata
17005 (apply 'encode-time (org-parse-time-string s))
17007 s (if (not (and buffer pos))
17008 ""
17009 (format " at %d in buffer `%s'" pos buffer))
17010 (cdr errdata)))))
17012 (defun org-time-string-to-seconds (s)
17013 "Convert a timestamp string to a number of seconds."
17014 (org-float-time (org-time-string-to-time s)))
17016 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17017 "Convert a time stamp to an absolute day number.
17018 If there is a specifier for a cyclic time stamp, get the closest
17019 date to DAYNR.
17020 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17021 The variable `date' is bound by the calendar when this is called."
17022 (cond
17024 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17025 daynr
17026 (+ daynr 1000)))
17028 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17029 (time-to-days (current-time))) (match-string 0 s)
17030 prefer show-all))
17031 (t (time-to-days
17032 (condition-case errdata
17033 (apply 'encode-time (org-parse-time-string s))
17035 s (if (not (and buffer pos))
17036 ""
17037 (format " at %d in buffer `%s'" pos buffer))
17038 (cdr errdata))))))))
17040 (defun org-days-to-iso-week (days)
17041 "Return the iso week number."
17042 (require 'cal-iso)
17043 (car (calendar-iso-from-absolute days)))
17045 (defun org-small-year-to-year (year)
17046 "Convert 2-digit years into 4-digit years.
17047 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17048 The year 2000 cannot be abbreviated. Any year larger than 99
17049 is returned unchanged."
17050 (if (< year 38)
17051 (setq year (+ 2000 year))
17052 (if (< year 100)
17053 (setq year (+ 1900 year))))
17054 year)
17056 (defun org-time-from-absolute (d)
17057 "Return the time corresponding to date D.
17058 D may be an absolute day number, or a calendar-type list (month day year)."
17059 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17060 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17062 (defun org-calendar-holiday ()
17063 "List of holidays, for Diary display in Org-mode."
17064 (require 'holidays)
17065 (let ((hl (funcall
17066 (if (fboundp 'calendar-check-holidays)
17067 'calendar-check-holidays 'check-calendar-holidays) date)))
17068 (if hl (mapconcat 'identity hl "; "))))
17070 (defun org-diary-sexp-entry (sexp entry date)
17071 "Process a SEXP diary ENTRY for DATE."
17072 (require 'diary-lib)
17073 (let ((result (if calendar-debug-sexp
17074 (let ((stack-trace-on-error t))
17075 (eval (car (read-from-string sexp))))
17076 (condition-case nil
17077 (eval (car (read-from-string sexp)))
17078 (error
17079 (beep)
17080 (message "Bad sexp at line %d in %s: %s"
17081 (org-current-line)
17082 (buffer-file-name) sexp)
17083 (sleep-for 2))))))
17084 (cond ((stringp result) (split-string result "; "))
17085 ((and (consp result)
17086 (not (consp (cdr result)))
17087 (stringp (cdr result))) (cdr result))
17088 ((and (consp result)
17089 (stringp (car result))) result)
17090 (result entry))))
17092 (defun org-diary-to-ical-string (frombuf)
17093 "Get iCalendar entries from diary entries in buffer FROMBUF.
17094 This uses the icalendar.el library."
17095 (let* ((tmpdir (if (featurep 'xemacs)
17096 (temp-directory)
17097 temporary-file-directory))
17098 (tmpfile (make-temp-name
17099 (expand-file-name "orgics" tmpdir)))
17100 buf rtn b e)
17101 (with-current-buffer frombuf
17102 (icalendar-export-region (point-min) (point-max) tmpfile)
17103 (setq buf (find-buffer-visiting tmpfile))
17104 (set-buffer buf)
17105 (goto-char (point-min))
17106 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17107 (setq b (match-beginning 0)))
17108 (goto-char (point-max))
17109 (if (re-search-backward "^END:VEVENT" nil t)
17110 (setq e (match-end 0)))
17112 (kill-buffer buf)
17113 (delete-file tmpfile)
17114 rtn))
17116 (defun org-closest-date (start current change prefer show-all)
17117 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17118 When PREFER is `past', return a date that is either CURRENT or past.
17119 When PREFER is `future', return a date that is either CURRENT or future.
17120 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17121 ;; Make the proper lists from the dates
17122 (catch 'exit
17123 (let ((a1 '(("h" . hour)
17124 ("d" . day)
17125 ("w" . week)
17126 ("m" . month)
17127 ("y" . year)))
17128 (shour (nth 2 (org-parse-time-string start)))
17129 dn dw sday cday n1 n2 n0
17130 d m y y1 y2 date1 date2 nmonths nm ny m2)
17132 (setq start (org-date-to-gregorian start)
17133 current (org-date-to-gregorian
17134 (if show-all
17135 current
17136 (time-to-days (current-time))))
17137 sday (calendar-absolute-from-gregorian start)
17138 cday (calendar-absolute-from-gregorian current))
17140 (if (<= cday sday) (throw 'exit sday))
17143 (setq dn (string-to-number (match-string 1 change))
17144 dw (cdr (assoc (match-string 2 change) a1)))
17145 (user-error "Invalid change specifier: %s" change))
17146 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17147 (cond
17148 ((eq dw 'hour)
17149 (let ((missing-hours
17150 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17151 dn)))
17152 (setq n1 (if (zerop missing-hours) cday
17153 (- cday (1+ (floor (/ missing-hours 24)))))
17154 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17155 ((eq dw 'day)
17156 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17157 n2 (+ n1 dn)))
17158 ((eq dw 'year)
17159 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17160 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17161 (setq date1 (list m d y1)
17162 n1 (calendar-absolute-from-gregorian date1)
17163 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17164 n2 (calendar-absolute-from-gregorian date2)))
17165 ((eq dw 'month)
17166 ;; approx number of month between the two dates
17167 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17168 ;; How often does dn fit in there?
17169 (setq d (nth 1 start) m (car start) y (nth 2 start)
17170 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17171 m (+ m nm)
17172 ny (floor (/ m 12))
17173 y (+ y ny)
17174 m (- m (* ny 12)))
17175 (while (> m 12) (setq m (- m 12) y (1+ y)))
17176 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17177 (setq m2 (+ m dn) y2 y)
17178 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17179 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17180 (while (<= n2 cday)
17181 (setq n1 n2 m m2 y y2)
17182 (setq m2 (+ m dn) y2 y)
17183 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17184 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17185 ;; Make sure n1 is the earlier date
17186 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17187 (if show-all
17188 (cond
17189 ((eq prefer 'past) (if (= cday n2) n2 n1))
17190 ((eq prefer 'future) (if (= cday n1) n1 n2))
17191 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17192 (cond
17193 ((eq prefer 'past) (if (= cday n2) n2 n1))
17194 ((eq prefer 'future) (if (= cday n1) n1 n2))
17195 (t (if (= cday n1) n1 n2)))))))
17197 (defun org-date-to-gregorian (date)
17198 "Turn any specification of DATE into a Gregorian date for the calendar."
17199 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17200 ((and (listp date) (= (length date) 3)) date)
17201 ((stringp date)
17202 (setq date (org-parse-time-string date))
17203 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17204 ((listp date)
17205 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17207 (defun org-parse-time-string (s &optional nodefault)
17208 "Parse the standard Org-mode time string.
17209 This should be a lot faster than the normal `parse-time-string'.
17210 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17211 hour and minute fields will be nil if not given."
17212 (cond ((string-match org-ts-regexp0 s)
17213 (list 0
17214 (if (or (match-beginning 8) (not nodefault))
17215 (string-to-number (or (match-string 8 s) "0")))
17216 (if (or (match-beginning 7) (not nodefault))
17217 (string-to-number (or (match-string 7 s) "0")))
17218 (string-to-number (match-string 4 s))
17219 (string-to-number (match-string 3 s))
17220 (string-to-number (match-string 2 s))
17221 nil nil nil))
17222 ((string-match "^<[^>]+>$" s)
17223 (decode-time (seconds-to-time (org-matcher-time s))))
17224 (t (error "Not a standard Org-mode time string: %s" s))))
17226 (defun org-timestamp-up (&optional arg)
17227 "Increase the date item at the cursor by one.
17228 If the cursor is on the year, change the year. If it is on the month,
17229 the day or the time, change that.
17230 With prefix ARG, change by that many units."
17231 (interactive "p")
17232 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17234 (defun org-timestamp-down (&optional arg)
17235 "Decrease the date item at the cursor by one.
17236 If the cursor is on the year, change the year. If it is on the month,
17237 the day or the time, change that.
17238 With prefix ARG, change by that many units."
17239 (interactive "p")
17240 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17242 (defun org-timestamp-up-day (&optional arg)
17243 "Increase the date in the time stamp by one day.
17244 With prefix ARG, change that many days."
17245 (interactive "p")
17246 (if (and (not (org-at-timestamp-p t))
17247 (org-at-heading-p))
17248 (org-todo 'up)
17249 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17251 (defun org-timestamp-down-day (&optional arg)
17252 "Decrease the date in the time stamp by one day.
17253 With prefix ARG, change that many days."
17254 (interactive "p")
17255 (if (and (not (org-at-timestamp-p t))
17256 (org-at-heading-p))
17257 (org-todo 'down)
17258 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17260 (defun org-at-timestamp-p (&optional inactive-ok)
17261 "Determine if the cursor is in or at a timestamp."
17262 (interactive)
17263 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17264 (pos (point))
17265 (ans (or (looking-at tsr)
17266 (save-excursion
17268 (if (> (point) (point-min)) (backward-char 1))
17269 (and (looking-at tsr)
17270 (> (- (match-end 0) pos) -1))))))
17271 (and ans
17272 (boundp 'org-ts-what)
17273 (setq org-ts-what
17274 (cond
17275 ((= pos (match-beginning 0)) 'bracket)
17276 ;; Point is considered to be "on the bracket" whether
17277 ;; it's really on it or right after it.
17278 ((= pos (1- (match-end 0))) 'bracket)
17279 ((= pos (match-end 0)) 'after)
17280 ((org-pos-in-match-range pos 2) 'year)
17281 ((org-pos-in-match-range pos 3) 'month)
17282 ((org-pos-in-match-range pos 7) 'hour)
17283 ((org-pos-in-match-range pos 8) 'minute)
17284 ((or (org-pos-in-match-range pos 4)
17285 (org-pos-in-match-range pos 5)) 'day)
17286 ((and (> pos (or (match-end 8) (match-end 5)))
17287 (< pos (match-end 0)))
17288 (- pos (or (match-end 8) (match-end 5))))
17289 (t 'day))))
17290 ans))
17292 (defun org-toggle-timestamp-type ()
17293 "Toggle the type (<active> or [inactive]) of a time stamp."
17294 (interactive)
17295 (when (org-at-timestamp-p t)
17296 (let ((beg (match-beginning 0)) (end (match-end 0))
17297 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17298 (save-excursion
17299 (goto-char beg)
17300 (while (re-search-forward "[][<>]" end t)
17301 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17302 t t)))
17303 (message "Timestamp is now %sactive"
17304 (if (equal (char-after beg) ?<) "" "in")))))
17306 (defun org-at-clock-log-p nil
17307 "Is the cursor on the clock log line?"
17308 (save-excursion
17309 (move-beginning-of-line 1)
17312 (defvar org-clock-history) ; defined in org-clock.el
17313 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17314 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17315 "Change the date in the time stamp at point.
17316 The date will be changed by N times WHAT. WHAT can be `day', `month',
17317 `year', `minute', `second'. If WHAT is not given, the cursor position
17318 in the timestamp determines what will be changed.
17320 (let ((origin (point)) origin-cat
17321 with-hm inactive
17322 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17323 org-ts-what
17324 extra rem
17325 ts time time0 fixnext clrgx)
17326 (if (not (org-at-timestamp-p t))
17327 (user-error "Not at a timestamp"))
17328 (if (and (not what) (eq org-ts-what 'bracket))
17329 (org-toggle-timestamp-type)
17330 ;; Point isn't on brackets. Remember the part of the time-stamp
17331 ;; the point was in. Indeed, size of time-stamps may change,
17332 ;; but point must be kept in the same category nonetheless.
17333 (setq origin-cat org-ts-what)
17334 (if (and (not what) (not (eq org-ts-what 'day))
17335 org-display-custom-times
17336 (get-text-property (point) 'display)
17337 (not (get-text-property (1- (point)) 'display)))
17338 (setq org-ts-what 'day))
17339 (setq org-ts-what (or what org-ts-what)
17340 inactive (= (char-after (match-beginning 0)) ?\[)
17341 ts (match-string 0))
17342 (replace-match "")
17343 (when (string-match
17344 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17345 ts)
17346 (setq extra (match-string 1 ts))
17347 (if suppress-tmp-delay
17348 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17350 (setq with-hm t))
17351 (setq time0 (org-parse-time-string ts))
17352 (when (and updown
17353 (eq org-ts-what 'minute)
17354 (not current-prefix-arg))
17355 ;; This looks like s-up and s-down. Change by one rounding step.
17356 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17357 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17358 (setcar (cdr time0) (+ (nth 1 time0)
17359 (if (> n 0) (- rem) (- dm rem))))))
17360 (setq time
17361 (encode-time (or (car time0) 0)
17362 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17363 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17364 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17365 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17366 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17367 (nthcdr 6 time0)))
17368 (when (and (member org-ts-what '(hour minute))
17369 extra
17371 (setq extra (org-modify-ts-extra
17372 extra
17373 (if (eq org-ts-what 'hour) 2 5)
17374 n dm)))
17375 (when (integerp org-ts-what)
17376 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17377 (if (eq what 'calendar)
17378 (let ((cal-date (org-get-date-from-calendar)))
17379 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17380 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17381 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17382 (setcar time0 (or (car time0) 0))
17383 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17384 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17385 (setq time (apply 'encode-time time0))))
17386 ;; Insert the new time-stamp, and ensure point stays in the same
17387 ;; category as before (i.e. not after the last position in that
17388 ;; category).
17389 (let ((pos (point)))
17390 ;; Stay before inserted string. `save-excursion' is of no use.
17391 (setq org-last-changed-timestamp
17392 (org-insert-time-stamp time with-hm inactive nil nil extra))
17393 (goto-char pos))
17394 (save-match-data
17395 (looking-at org-ts-regexp3)
17396 (goto-char (cond
17397 ;; `day' category ends before `hour' if any, or at
17398 ;; the end of the day name.
17399 ((eq origin-cat 'day)
17400 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17401 ((eq origin-cat 'hour) (min (match-end 7) origin))
17402 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17403 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17404 ;; `year' and `month' have both fixed size: point
17405 ;; couldn't have moved into another part.
17406 (t origin))))
17407 ;; Update clock if on a CLOCK line.
17408 (org-clock-update-time-maybe)
17409 ;; Maybe adjust the closest clock in `org-clock-history'
17410 (when org-clock-adjust-closest
17411 (if (not (and (org-at-clock-log-p)
17412 (< 1 (length (delq nil (mapcar 'marker-position
17413 org-clock-history))))))
17414 (message "No clock to adjust")
17415 (cond ((save-excursion ; fix previous clock?
17416 (re-search-backward org-ts-regexp0 nil t)
17419 ((save-excursion ; fix next clock?
17420 (re-search-backward org-ts-regexp0 nil t)
17423 (save-window-excursion
17424 ;; Find closest clock to point, adjust the previous/next one in history
17425 (let* ((p (save-excursion (org-back-to-heading t)))
17426 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17427 (clfixnth
17428 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17429 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17430 (if (not clfixpos)
17431 (message "No clock to adjust")
17432 (save-excursion
17433 (org-goto-marker-or-bmk clfixpos)
17434 (org-show-subtree)
17435 (when (re-search-forward clrgx nil t)
17436 (goto-char (match-beginning 1))
17437 (let (org-clock-adjust-closest)
17438 (org-timestamp-change n org-ts-what updown))
17439 (message "Clock adjusted in %s for heading: %s"
17440 (file-name-nondirectory (buffer-file-name))
17441 (org-get-heading t t)))))))))
17442 ;; Try to recenter the calendar window, if any.
17443 (if (and org-calendar-follow-timestamp-change
17444 (get-buffer-window "*Calendar*" t)
17445 (memq org-ts-what '(day month year)))
17446 (org-recenter-calendar (time-to-days time))))))
17448 (defun org-modify-ts-extra (s pos n dm)
17449 "Change the different parts of the lead-time and repeat fields in timestamp."
17450 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17451 ng h m new rem)
17452 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17453 (cond
17454 ((or (org-pos-in-match-range pos 2)
17455 (org-pos-in-match-range pos 3))
17456 (setq m (string-to-number (match-string 3 s))
17457 h (string-to-number (match-string 2 s)))
17458 (if (org-pos-in-match-range pos 2)
17459 (setq h (+ h n))
17460 (setq n (* dm (org-no-warnings (signum n))))
17461 (when (not (= 0 (setq rem (% m dm))))
17462 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17463 (setq m (+ m n)))
17464 (if (< m 0) (setq m (+ m 60) h (1- h)))
17465 (if (> m 59) (setq m (- m 60) h (1+ h)))
17466 (setq h (min 24 (max 0 h)))
17467 (setq ng 1 new (format "-%02d:%02d" h m)))
17468 ((org-pos-in-match-range pos 6)
17469 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17470 ((org-pos-in-match-range pos 5)
17471 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17473 ((org-pos-in-match-range pos 9)
17474 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17475 ((org-pos-in-match-range pos 8)
17476 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17478 (when ng
17479 (setq s (concat
17480 (substring s 0 (match-beginning ng))
17481 new
17482 (substring s (match-end ng))))))
17483 s))
17485 (defun org-recenter-calendar (date)
17486 "If the calendar is visible, recenter it to DATE."
17487 (let ((cwin (get-buffer-window "*Calendar*" t)))
17488 (when cwin
17489 (let ((calendar-move-hook nil))
17490 (with-selected-window cwin
17491 (calendar-goto-date (if (listp date) date
17492 (calendar-gregorian-from-absolute date))))))))
17494 (defun org-goto-calendar (&optional arg)
17495 "Go to the Emacs calendar at the current date.
17496 If there is a time stamp in the current line, go to that date.
17497 A prefix ARG can be used to force the current date."
17498 (interactive "P")
17499 (let ((tsr org-ts-regexp) diff
17500 (calendar-move-hook nil)
17501 (calendar-view-holidays-initially-flag nil)
17502 (calendar-view-diary-initially-flag nil))
17503 (if (or (org-at-timestamp-p)
17504 (save-excursion
17505 (beginning-of-line 1)
17506 (looking-at (concat ".*" tsr))))
17507 (let ((d1 (time-to-days (current-time)))
17508 (d2 (time-to-days
17509 (org-time-string-to-time (match-string 1)))))
17510 (setq diff (- d2 d1))))
17511 (calendar)
17512 (calendar-goto-today)
17513 (if (and diff (not arg)) (calendar-forward-day diff))))
17515 (defun org-get-date-from-calendar ()
17516 "Return a list (month day year) of date at point in calendar."
17517 (with-current-buffer "*Calendar*"
17518 (save-match-data
17519 (calendar-cursor-to-date))))
17521 (defun org-date-from-calendar ()
17522 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17523 If there is already a time stamp at the cursor position, update it."
17524 (interactive)
17525 (if (org-at-timestamp-p t)
17526 (org-timestamp-change 0 'calendar)
17527 (let ((cal-date (org-get-date-from-calendar)))
17528 (org-insert-time-stamp
17529 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17531 (defcustom org-effort-durations
17532 `(("h" . 60)
17533 ("d" . ,(* 60 8))
17534 ("w" . ,(* 60 8 5))
17535 ("m" . ,(* 60 8 5 4))
17536 ("y" . ,(* 60 8 5 40)))
17537 "Conversion factor to minutes for an effort modifier.
17539 Each entry has the form (MODIFIER . MINUTES).
17541 In an effort string, a number followed by MODIFIER is multiplied
17542 by the specified number of MINUTES to obtain an effort in
17543 minutes.
17547 :group 'org-agenda
17548 :version "24.1"
17549 :type '(alist :key-type (string :tag "Modifier")
17550 :value-type (number :tag "Minutes")))
17552 (defun org-minutes-to-clocksum-string (m)
17553 "Format number of minutes as a clocksum string.
17554 The format is determined by `org-time-clocksum-format',
17555 `org-time-clocksum-use-fractional' and
17556 `org-time-clocksum-fractional-format' and
17557 `org-time-clocksum-use-effort-durations'."
17558 (let ((clocksum "")
17559 (m (round m)) ; Don't allow fractions of minutes
17560 h d w mo y fmt n)
17561 (setq h (if org-time-clocksum-use-effort-durations
17562 (cdr (assoc "h" org-effort-durations)) 60)
17563 d (if org-time-clocksum-use-effort-durations
17564 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17565 w (if org-time-clocksum-use-effort-durations
17566 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17567 mo (if org-time-clocksum-use-effort-durations
17568 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17569 y (if org-time-clocksum-use-effort-durations
17570 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17571 ;; fractional format
17572 (if org-time-clocksum-use-fractional
17573 (cond
17574 ;; single format string
17575 ((stringp org-time-clocksum-fractional-format)
17576 (format org-time-clocksum-fractional-format (/ m (float h))))
17577 ;; choice of fractional formats for different time units
17578 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17579 (> (/ (truncate m) (* y d h)) 0))
17580 (format fmt (/ m (* y d (float h)))))
17581 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17582 (> (/ (truncate m) (* mo d h)) 0))
17583 (format fmt (/ m (* mo d (float h)))))
17584 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17585 (> (/ (truncate m) (* w d h)) 0))
17586 (format fmt (/ m (* w d (float h)))))
17587 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17588 (> (/ (truncate m) (* d h)) 0))
17589 (format fmt (/ m (* d (float h)))))
17590 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17591 (> (/ (truncate m) h) 0))
17592 (format fmt (/ m (float h))))
17593 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17594 (format fmt m))
17595 ;; fall back to smallest time unit with a format
17596 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17597 (format fmt (/ m (float h))))
17598 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17599 (format fmt (/ m (* d (float h)))))
17600 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17601 (format fmt (/ m (* w d (float h)))))
17602 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17603 (format fmt (/ m (* mo d (float h)))))
17604 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17605 (format fmt (/ m (* y d (float h))))))
17606 ;; standard (non-fractional) format, with single format string
17607 (if (stringp org-time-clocksum-format)
17608 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17609 ;; separate formats components
17610 (and (setq fmt (plist-get org-time-clocksum-format :years))
17611 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17612 (plist-get org-time-clocksum-format :require-years))
17613 (setq clocksum (concat clocksum (format fmt n))
17614 m (- m (* n y d h))))
17615 (and (setq fmt (plist-get org-time-clocksum-format :months))
17616 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17617 (plist-get org-time-clocksum-format :require-months))
17618 (setq clocksum (concat clocksum (format fmt n))
17619 m (- m (* n mo d h))))
17620 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17621 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17622 (plist-get org-time-clocksum-format :require-weeks))
17623 (setq clocksum (concat clocksum (format fmt n))
17624 m (- m (* n w d h))))
17625 (and (setq fmt (plist-get org-time-clocksum-format :days))
17626 (or (> (setq n (/ (truncate m) (* d h))) 0)
17627 (plist-get org-time-clocksum-format :require-days))
17628 (setq clocksum (concat clocksum (format fmt n))
17629 m (- m (* n d h))))
17630 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17631 (or (> (setq n (/ (truncate m) h)) 0)
17632 (plist-get org-time-clocksum-format :require-hours))
17633 (setq clocksum (concat clocksum (format fmt n))
17634 m (- m (* n h))))
17635 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17636 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17637 (setq clocksum (concat clocksum (format fmt m))))
17638 ;; return formatted time duration
17639 clocksum))))
17641 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17642 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17643 "Org mode version 8.0")
17645 (defun org-hours-to-clocksum-string (n)
17646 (org-minutes-to-clocksum-string (* n 60)))
17648 (defun org-hh:mm-string-to-minutes (s)
17649 "Convert a string H:MM to a number of minutes.
17650 If the string is just a number, interpret it as minutes.
17651 In fact, the first hh:mm or number in the string will be taken,
17652 there can be extra stuff in the string.
17653 If no number is found, the return value is 0."
17654 (cond
17655 ((integerp s) s)
17657 (+ (* (string-to-number (match-string 1 s)) 60)
17658 (string-to-number (match-string 2 s))))
17660 (string-to-number (match-string 1 s)))
17661 (t 0)))
17663 (defcustom org-image-actual-width t
17664 "Should we use the actual width of images when inlining them?
17666 When set to `t', always use the image width.
17668 When set to a number, use imagemagick (when available) to set
17669 the image's width to this value.
17671 When set to a number in a list, try to get the width from any
17672 #+ATTR.* keyword if it matches a width specification like
17674 #+ATTR_HTML: :width 300px
17676 and fall back on that number if none is found.
17678 When set to nil, try to get the width from an #+ATTR.* keyword
17679 and fall back on the original width if none is found.
17681 This requires Emacs >= 24.1, build with imagemagick support."
17682 :group 'org-appearance
17683 :version "24.4"
17684 :package-version '(Org . "8.0")
17685 :type '(choice
17686 (const :tag "Use the image width" t)
17687 (integer :tag "Use a number of pixels")
17688 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17689 (const :tag "Use #+ATTR* or don't resize" nil)))
17691 (defcustom org-agenda-inhibit-startup nil
17692 "Inhibit startup when preparing agenda buffers.
17693 When this variable is `t' (the default), the initialization of
17694 the Org agenda buffers is inhibited: e.g. the visibility state
17695 is not set, the tables are not re-aligned, etc."
17696 :type 'boolean
17697 :version "24.3"
17698 :group 'org-agenda)
17700 (defcustom org-agenda-ignore-drawer-properties nil
17701 "Avoid updating text properties when building the agenda.
17702 Properties are used to prepare buffers for effort estimates, appointments,
17703 and subtree-local categories.
17704 If you don't use these in the agenda, you can add them to this list and
17705 agenda building will be a bit faster.
17706 The value is a list, with zero or more of the symbols `effort', `appt',
17707 or `category'."
17708 :type '(set :greedy t
17709 (const effort)
17710 (const appt)
17711 (const category))
17712 :version "24.3"
17713 :group 'org-agenda)
17715 (defun org-duration-string-to-minutes (s &optional output-to-string)
17716 "Convert a duration string S to minutes.
17718 A bare number is interpreted as minutes, modifiers can be set by
17719 customizing `org-effort-durations' (which see).
17721 Entries containing a colon are interpreted as H:MM by
17722 `org-hh:mm-string-to-minutes'."
17723 (let ((result 0)
17725 (regexp-opt (mapcar 'car org-effort-durations))
17727 (while (string-match re s)
17728 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17729 (string-to-number (match-string 1 s))))
17730 (setq s (replace-match "" nil t s)))
17731 (setq result (floor result))
17732 (incf result (org-hh:mm-string-to-minutes s))
17733 (if output-to-string (number-to-string result) result)))
17735 ;;;; Files
17737 (defun org-save-all-org-buffers ()
17738 "Save all Org-mode buffers without user confirmation."
17739 (interactive)
17740 (message "Saving all Org-mode buffers...")
17741 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17742 (when (featurep 'org-id) (org-id-locations-save))
17743 (message "Saving all Org-mode buffers... done"))
17745 (defun org-revert-all-org-buffers ()
17746 "Revert all Org-mode buffers.
17747 Prompt for confirmation when there are unsaved changes.
17748 Be sure you know what you are doing before letting this function
17749 overwrite your changes.
17751 This function is useful in a setup where one tracks org files
17752 with a version control system, to revert on one machine after pulling
17753 changes from another. I believe the procedure must be like this:
17755 1. M-x org-save-all-org-buffers
17756 2. Pull changes from the other machine, resolve conflicts
17757 3. M-x org-revert-all-org-buffers"
17758 (interactive)
17759 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17760 (user-error "Abort"))
17761 (save-excursion
17762 (save-window-excursion
17763 (mapc
17764 (lambda (b)
17765 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17766 (with-current-buffer b buffer-file-name))
17767 (org-pop-to-buffer-same-window b)
17768 (revert-buffer t 'no-confirm)))
17769 (buffer-list))
17770 (when (and (featurep 'org-id) org-id-track-globally)
17771 (org-id-locations-load)))))
17773 ;;;; Agenda files
17775 ;;;###autoload
17776 (defun org-switchb (&optional arg)
17777 "Switch between Org buffers.
17778 With one prefix argument, restrict available buffers to files.
17779 With two prefix arguments, restrict available buffers to agenda files.
17781 Defaults to `iswitchb' for buffer name completion.
17782 Set `org-completion-use-ido' to make it use ido instead."
17783 (interactive "P")
17784 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17785 ((equal arg '(16)) (org-buffer-list 'agenda))
17786 (t (org-buffer-list))))
17787 (org-completion-use-iswitchb org-completion-use-iswitchb)
17788 (org-completion-use-ido org-completion-use-ido))
17789 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17790 (setq org-completion-use-iswitchb t))
17791 (org-pop-to-buffer-same-window
17792 (org-icompleting-read "Org buffer: "
17793 (mapcar 'list (mapcar 'buffer-name blist))
17794 nil t))))
17796 ;;; Define some older names previously used for this functionality
17797 ;;;###autoload
17798 (defalias 'org-ido-switchb 'org-switchb)
17799 ;;;###autoload
17800 (defalias 'org-iswitchb 'org-switchb)
17802 (defun org-buffer-list (&optional predicate exclude-tmp)
17803 "Return a list of Org buffers.
17804 PREDICATE can be `export', `files' or `agenda'.
17806 export restrict the list to Export buffers.
17807 files restrict the list to buffers visiting Org files.
17808 agenda restrict the list to buffers visiting agenda files.
17810 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17811 (let* ((bfn nil)
17812 (agenda-files (and (eq predicate 'agenda)
17813 (mapcar 'file-truename (org-agenda-files t))))
17814 (filter
17815 (cond
17816 ((eq predicate 'files)
17817 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17818 ((eq predicate 'export)
17819 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17820 ((eq predicate 'agenda)
17821 (lambda (b)
17822 (with-current-buffer b
17823 (and (derived-mode-p 'org-mode)
17824 (setq bfn (buffer-file-name b))
17825 (member (file-truename bfn) agenda-files)))))
17826 (t (lambda (b) (with-current-buffer b
17827 (or (derived-mode-p 'org-mode)
17828 (string-match "\*Org .*Export"
17829 (buffer-name b)))))))))
17830 (delq nil
17831 (mapcar
17832 (lambda(b)
17833 (if (and (funcall filter b)
17834 (or (not exclude-tmp)
17835 (not (string-match "tmp" (buffer-name b)))))
17836 b
17837 nil))
17838 (buffer-list)))))
17840 (defun org-agenda-files (&optional unrestricted archives)
17841 "Get the list of agenda files.
17842 Optional UNRESTRICTED means return the full list even if a restriction
17843 is currently in place.
17844 When ARCHIVES is t, include all archive files that are really being
17845 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17846 `org-agenda-archives-mode' is t."
17847 (let ((files
17848 (cond
17849 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17850 ((stringp org-agenda-files) (org-read-agenda-file-list))
17851 ((listp org-agenda-files) org-agenda-files)
17852 (t (error "Invalid value of `org-agenda-files'")))))
17853 (setq files (apply 'append
17854 (mapcar (lambda (f)
17855 (if (file-directory-p f)
17856 (directory-files
17857 f t org-agenda-file-regexp)
17858 (list f)))
17859 files)))
17860 (when org-agenda-skip-unavailable-files
17861 (setq files (delq nil
17862 (mapcar (function
17863 (lambda (file)
17864 (and (file-readable-p file) file)))
17865 files))))
17866 (when (or (eq archives t)
17867 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17868 (setq files (org-add-archive-files files)))
17869 files))
17871 (defun org-agenda-file-p (&optional file)
17872 "Return non-nil, if FILE is an agenda file.
17873 If FILE is omitted, use the file associated with the current
17874 buffer."
17875 (member (or file (buffer-file-name))
17876 (org-agenda-files t)))
17878 (defun org-edit-agenda-file-list ()
17879 "Edit the list of agenda files.
17880 Depending on setup, this either uses customize to edit the variable
17881 `org-agenda-files', or it visits the file that is holding the list. In the
17882 latter case, the buffer is set up in a way that saving it automatically kills
17883 the buffer and restores the previous window configuration."
17884 (interactive)
17885 (if (stringp org-agenda-files)
17886 (let ((cw (current-window-configuration)))
17887 (find-file org-agenda-files)
17888 (org-set-local 'org-window-configuration cw)
17889 (org-add-hook 'after-save-hook
17890 (lambda ()
17891 (set-window-configuration
17892 (prog1 org-window-configuration
17893 (kill-buffer (current-buffer))))
17894 (org-install-agenda-files-menu)
17895 (message "New agenda file list installed"))
17896 nil 'local)
17897 (message "%s" (substitute-command-keys
17899 (customize-variable 'org-agenda-files)))
17901 (defun org-store-new-agenda-file-list (list)
17902 "Set new value for the agenda file list and save it correctly."
17903 (if (stringp org-agenda-files)
17904 (let ((fe (org-read-agenda-file-list t)) b u)
17905 (while (setq b (find-buffer-visiting org-agenda-files))
17906 (kill-buffer b))
17907 (with-temp-file org-agenda-files
17908 (insert
17909 (mapconcat
17910 (lambda (f) ;; Keep un-expanded entries.
17911 (if (setq u (assoc f fe))
17912 (cdr u)
17913 f))
17916 (let ((org-mode-hook nil) (org-inhibit-startup t)
17917 (org-insert-mode-line-in-empty-file nil))
17918 (setq org-agenda-files list)
17919 (customize-save-variable 'org-agenda-files org-agenda-files))))
17921 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17922 "Read the list of agenda files from a file.
17923 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17924 filenames, used by `org-store-new-agenda-file-list' to write back
17925 un-expanded file names."
17926 (when (file-directory-p org-agenda-files)
17927 (error "`org-agenda-files' cannot be a single directory"))
17928 (when (stringp org-agenda-files)
17929 (with-temp-buffer
17930 (insert-file-contents org-agenda-files)
17931 (mapcar
17932 (lambda (f)
17933 (let ((e (expand-file-name (substitute-in-file-name f)
17934 org-directory)))
17935 (if pair-with-expansion
17936 (cons e f)
17937 e)))
17940 ;;;###autoload
17941 (defun org-cycle-agenda-files ()
17942 "Cycle through the files in `org-agenda-files'.
17943 If the current buffer visits an agenda file, find the next one in the list.
17944 If the current buffer does not, find the first agenda file."
17945 (interactive)
17946 (let* ((fs (org-agenda-files t))
17947 (files (append fs (list (car fs))))
17948 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17949 file)
17950 (unless files (user-error "No agenda files"))
17951 (catch 'exit
17952 (while (setq file (pop files))
17953 (if (equal (file-truename file) tcf)
17954 (when (car files)
17955 (find-file (car files))
17956 (throw 'exit t))))
17957 (find-file (car fs)))
17958 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17960 (defun org-agenda-file-to-front (&optional to-end)
17961 "Move/add the current file to the top of the agenda file list.
17962 If the file is not present in the list, it is added to the front. If it is
17963 present, it is moved there. With optional argument TO-END, add/move to the
17964 end of the list."
17965 (interactive "P")
17966 (let ((org-agenda-skip-unavailable-files nil)
17967 (file-alist (mapcar (lambda (x)
17968 (cons (file-truename x) x))
17969 (org-agenda-files t)))
17970 (ctf (file-truename
17971 (or buffer-file-name
17972 (user-error "Please save the current buffer to a file"))))
17973 x had)
17974 (setq x (assoc ctf file-alist) had x)
17976 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17977 (if to-end
17978 (setq file-alist (append (delq x file-alist) (list x)))
17979 (setq file-alist (cons x (delq x file-alist))))
17980 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17981 (org-install-agenda-files-menu)
17982 (message "File %s to %s of agenda file list"
17983 (if had "moved" "added") (if to-end "end" "front"))))
17985 (defun org-remove-file (&optional file)
17986 "Remove current file from the list of files in variable `org-agenda-files'.
17987 These are the files which are being checked for agenda entries.
17988 Optional argument FILE means use this file instead of the current."
17989 (interactive)
17990 (let* ((org-agenda-skip-unavailable-files nil)
17991 (file (or file buffer-file-name
17992 (user-error "Current buffer does not visit a file")))
17993 (true-file (file-truename file))
17994 (afile (abbreviate-file-name file))
17995 (files (delq nil (mapcar
17996 (lambda (x)
17997 (if (equal true-file
17998 (file-truename x))
17999 nil x))
18000 (org-agenda-files t)))))
18001 (if (not (= (length files) (length (org-agenda-files t))))
18002 (progn
18003 (org-store-new-agenda-file-list files)
18004 (org-install-agenda-files-menu)
18005 (message "Removed file: %s" afile))
18006 (message "File was not in list: %s (not removed)" afile))))
18008 (defun org-file-menu-entry (file)
18009 (vector file (list 'find-file file) t))
18011 (defun org-check-agenda-file (file)
18012 "Make sure FILE exists. If not, ask user what to do."
18013 (when (not (file-exists-p file))
18014 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18015 (abbreviate-file-name file))
18016 (let ((r (downcase (read-char-exclusive))))
18017 (cond
18018 ((equal r ?r)
18019 (org-remove-file file)
18020 (throw 'nextfile t))
18021 (t (error "Abort"))))))
18023 (defun org-get-agenda-file-buffer (file)
18024 "Get a buffer visiting FILE. If the buffer needs to be created, add
18025 it to the list of buffers which might be released later."
18026 (let ((buf (org-find-base-buffer-visiting file)))
18027 (if buf
18028 buf ; just return it
18029 ;; Make a new buffer and remember it
18030 (setq buf (find-file-noselect file))
18031 (if buf (push buf org-agenda-new-buffers))
18032 buf)))
18034 (defun org-release-buffers (blist)
18035 "Release all buffers in list, asking the user for confirmation when needed.
18036 When a buffer is unmodified, it is just killed. When modified, it is saved
18037 \(if the user agrees) and then killed."
18038 (let (buf file)
18039 (while (setq buf (pop blist))
18040 (setq file (buffer-file-name buf))
18041 (when (and (buffer-modified-p buf)
18042 file
18043 (y-or-n-p (format "Save file %s? " file)))
18044 (with-current-buffer buf (save-buffer)))
18045 (kill-buffer buf))))
18047 (defun org-agenda-prepare-buffers (files)
18048 "Create buffers for all agenda files, protect archived trees and comments."
18049 (interactive)
18050 (let ((pa '(:org-archived t))
18051 (pc '(:org-comment t))
18052 (pall '(:org-archived t :org-comment t))
18053 (inhibit-read-only t)
18054 (org-inhibit-startup org-agenda-inhibit-startup)
18055 (rea (concat ":" org-archive-tag ":"))
18056 file re)
18057 (setq org-tag-alist-for-agenda nil
18058 org-tag-groups-alist-for-agenda nil)
18059 (save-excursion
18060 (save-restriction
18061 (while (setq file (pop files))
18062 (catch 'nextfile
18063 (if (bufferp file)
18064 (set-buffer file)
18065 (org-check-agenda-file file)
18066 (set-buffer (org-get-agenda-file-buffer file)))
18067 (widen)
18068 (org-set-regexps-and-options-for-tags)
18069 (goto-char (point-min))
18070 (let ((case-fold-search t))
18071 (when (search-forward "#+setupfile" nil t)
18072 ;; Don't set all regexps and options systematically as
18073 ;; this is only run for setting agenda tags from setup
18074 ;; file
18075 (org-set-regexps-and-options)))
18076 (or (memq 'category org-agenda-ignore-drawer-properties)
18077 (org-refresh-category-properties))
18078 (or (memq 'effort org-agenda-ignore-drawer-properties)
18079 (org-refresh-properties org-effort-property 'org-effort))
18080 (or (memq 'appt org-agenda-ignore-drawer-properties)
18081 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18082 (setq org-todo-keywords-for-agenda
18083 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18084 (setq org-done-keywords-for-agenda
18085 (append org-done-keywords-for-agenda org-done-keywords))
18086 (setq org-todo-keyword-alist-for-agenda
18087 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18088 (setq org-drawers-for-agenda
18089 (append org-drawers-for-agenda org-drawers))
18090 (setq org-tag-alist-for-agenda
18091 (org-uniquify
18092 (append org-tag-alist-for-agenda
18093 org-tag-alist
18094 org-tag-persistent-alist)))
18095 (if org-group-tags
18096 (setq org-tag-groups-alist-for-agenda
18097 (org-uniquify-alist
18098 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18099 (org-with-silent-modifications
18100 (save-excursion
18101 (remove-text-properties (point-min) (point-max) pall)
18102 (when org-agenda-skip-archived-trees
18103 (goto-char (point-min))
18104 (while (re-search-forward rea nil t)
18105 (if (org-at-heading-p t)
18106 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18107 (goto-char (point-min))
18108 (setq re (format org-heading-keyword-regexp-format
18109 org-comment-string))
18110 (while (re-search-forward re nil t)
18111 (add-text-properties
18112 (match-beginning 0) (org-end-of-subtree t) pc))))))))
18113 (setq org-todo-keywords-for-agenda
18114 (org-uniquify org-todo-keywords-for-agenda))
18115 (setq org-todo-keyword-alist-for-agenda
18116 (org-uniquify org-todo-keyword-alist-for-agenda))))
18118 \f
18119 ;;;; CDLaTeX minor mode
18121 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18122 "Keymap for the minor `org-cdlatex-mode'.")
18124 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18125 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18126 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18127 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18128 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18130 (defvar org-cdlatex-texmathp-advice-is-done nil
18131 "Flag remembering if we have applied the advice to texmathp already.")
18133 (define-minor-mode org-cdlatex-mode
18134 "Toggle the minor `org-cdlatex-mode'.
18135 This mode supports entering LaTeX environment and math in LaTeX fragments
18136 in Org-mode.
18138 nil " OCDL" nil
18139 (when org-cdlatex-mode
18140 (require 'cdlatex)
18141 (run-hooks 'cdlatex-mode-hook)
18142 (cdlatex-compute-tables))
18143 (unless org-cdlatex-texmathp-advice-is-done
18144 (setq org-cdlatex-texmathp-advice-is-done t)
18145 (defadvice texmathp (around org-math-always-on activate)
18146 "Always return t in org-mode buffers.
18147 This is because we want to insert math symbols without dollars even outside
18148 the LaTeX math segments. If Orgmode thinks that point is actually inside
18149 an embedded LaTeX fragment, let texmathp do its job.
18151 (interactive)
18152 (let (p)
18153 (cond
18154 ((not (derived-mode-p 'org-mode)) ad-do-it)
18155 ((eq this-command 'cdlatex-math-symbol)
18156 (setq ad-return-value t
18157 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18158 (t
18159 (let ((p (org-inside-LaTeX-fragment-p)))
18160 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18161 (setq ad-return-value t
18162 texmathp-why '("Org-mode embedded math" . 0))
18163 (if p ad-do-it)))))))))
18165 (defun turn-on-org-cdlatex ()
18166 "Unconditionally turn on `org-cdlatex-mode'."
18167 (org-cdlatex-mode 1))
18169 (defun org-try-cdlatex-tab ()
18170 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18171 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18172 - inside a LaTeX fragment, or
18173 - after the first word in a line, where an abbreviation expansion could
18174 insert a LaTeX environment."
18175 (when org-cdlatex-mode
18176 (cond
18177 ;; Before any word on the line: No expansion possible.
18179 ;; Just after first word on the line: Expand it. Make sure it
18180 ;; cannot happen on headlines, though.
18181 ((save-excursion
18182 (skip-chars-backward "a-zA-Z0-9*")
18184 (and (bolp) (not (org-at-heading-p))))
18185 (cdlatex-tab) t)
18186 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18188 (defun org-cdlatex-underscore-caret (&optional arg)
18189 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18190 Revert to the normal definition outside of these fragments."
18191 (interactive "P")
18192 (if (org-inside-LaTeX-fragment-p)
18193 (call-interactively 'cdlatex-sub-superscript)
18194 (let (org-cdlatex-mode)
18195 (call-interactively (key-binding (vector last-input-event))))))
18197 (defun org-cdlatex-math-modify (&optional arg)
18198 "Execute `cdlatex-math-modify' in LaTeX fragments.
18199 Revert to the normal definition outside of these fragments."
18200 (interactive "P")
18201 (if (org-inside-LaTeX-fragment-p)
18202 (call-interactively 'cdlatex-math-modify)
18203 (let (org-cdlatex-mode)
18204 (call-interactively (key-binding (vector last-input-event))))))
18207 \f
18208 ;;;; LaTeX fragments
18210 (defvar org-latex-regexps
18212 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18215 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18219 "Regular expressions for matching embedded LaTeX.")
18221 (defun org-inside-LaTeX-fragment-p ()
18222 "Test if point is inside a LaTeX fragment.
18224 sequence appearing also before point.
18225 Even though the matchers for math are configurable, this function assumes
18227 delimiters are skipped when they have been removed by customization.
18228 The return value is nil, or a cons cell with the delimiter and the
18229 position of this delimiter.
18231 This function does a reasonably good job, but can locally be fooled by
18232 for example currency specifications. For example it will assume being in
18234 fragments that are properly closed, but during editing, we have to live
18235 with the uncertainty caused by missing closing delimiters. This function
18236 looks only before point, not after."
18237 (catch 'exit
18238 (let ((pos (point))
18239 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18240 (lim (progn
18242 (point)))
18243 dd-on str (start 0) m re)
18244 (goto-char pos)
18245 (when dodollar
18247 re (nth 1 (assoc "$" org-latex-regexps)))
18248 (while (string-match re str start)
18249 (cond
18250 ((= (match-end 0) (length str))
18251 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18252 ((= (match-end 0) (- (length str) 5))
18253 (throw 'exit nil))
18254 (t (setq start (match-end 0))))))
18255 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18256 (goto-char pos)
18257 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18258 (and (match-beginning 2) (throw 'exit nil))
18259 ;; count $$
18261 (setq dd-on (not dd-on)))
18262 (goto-char pos)
18263 (if dd-on (cons "$$" m))))))
18265 (defun org-inside-latex-macro-p ()
18266 "Is point inside a LaTeX macro or its arguments?"
18267 (save-match-data
18268 (org-in-regexp
18271 (defvar org-latex-fragment-image-overlays nil
18272 "List of overlays carrying the images of latex fragments.")
18273 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18275 (defun org-remove-latex-fragment-image-overlays ()
18276 "Remove all overlays with LaTeX fragment images in current buffer."
18277 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18278 (setq org-latex-fragment-image-overlays nil))
18280 (defun org-preview-latex-fragment (&optional subtree)
18281 "Preview the LaTeX fragment at point, or all locally or globally.
18282 If the cursor is in a LaTeX fragment, create the image and overlay
18283 it over the source code. If there is no fragment at point, display
18284 all fragments in the current text, from one headline to the next. With
18285 prefix SUBTREE, display all fragments in the current subtree. With a
18287 the cursor is before the first headline,
18288 display all fragments in the buffer.
18290 (interactive "P")
18291 (unless buffer-file-name
18292 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18293 (when (display-graphic-p)
18294 (org-remove-latex-fragment-image-overlays)
18295 (save-excursion
18296 (save-restriction
18297 (let (beg end at msg)
18298 (cond
18299 ((or (equal subtree '(16))
18300 (not (save-excursion
18301 (re-search-backward org-outline-regexp-bol nil t))))
18302 (setq beg (point-min) end (point-max)
18303 msg "Creating images for buffer...%s"))
18304 ((equal subtree '(4))
18305 (org-back-to-heading)
18306 (setq beg (point) end (org-end-of-subtree t)
18307 msg "Creating images for subtree...%s"))
18308 (t
18309 (if (setq at (org-inside-LaTeX-fragment-p))
18310 (goto-char (max (point-min) (- (cdr at) 2)))
18311 (org-back-to-heading))
18312 (setq beg (point) end (progn (outline-next-heading) (point))
18313 msg (if at "Creating image...%s"
18314 "Creating images for entry...%s"))))
18315 (message msg "")
18316 (narrow-to-region beg end)
18317 (goto-char beg)
18318 (org-format-latex
18319 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18320 (file-name-nondirectory
18321 buffer-file-name)))
18322 default-directory 'overlays msg at 'forbuffer
18323 org-latex-create-formula-image-program)
18324 (message msg "done. Use `C-c C-c' to remove images."))))))
18326 (defun org-format-latex (prefix &optional dir overlays msg at
18327 forbuffer processing-type)
18328 "Replace LaTeX fragments with links to an image, and produce images.
18329 Some of the options can be changed using the variable
18330 `org-format-latex-options'."
18331 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18332 (let* ((prefixnodir (file-name-nondirectory prefix))
18333 (absprefix (expand-file-name prefix dir))
18334 (todir (file-name-directory absprefix))
18335 (opt org-format-latex-options)
18336 (optnew org-format-latex-options)
18337 (matchers (plist-get opt :matchers))
18338 (re-list org-latex-regexps)
18339 (cnt 0) txt hash link beg end re e checkdir
18340 string
18341 m n block-type block linkfile movefile ov)
18342 ;; Check the different regular expressions
18343 (while (setq e (pop re-list))
18344 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18346 (when (member m matchers)
18347 (goto-char (point-min))
18348 (while (re-search-forward re nil t)
18349 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18350 (or (not overlays)
18351 (not (eq (get-char-property (match-beginning n)
18352 'org-overlay-type)
18353 'org-latex-overlay))))
18354 (cond
18355 ((eq processing-type 'verbatim))
18356 ((eq processing-type 'mathjax)
18357 ;; Prepare for MathJax processing.
18358 (setq string (match-string n))
18359 (when (member m '("$" "$1"))
18360 (save-excursion
18361 (delete-region (match-beginning n) (match-end n))
18362 (goto-char (match-beginning n))
18364 ((or (eq processing-type 'dvipng)
18365 (eq processing-type 'imagemagick))
18366 ;; Process to an image.
18367 (setq txt (match-string n)
18368 beg (match-beginning n) end (match-end n)
18369 cnt (1+ cnt))
18370 (let ((face (face-at-point))
18371 (fg (plist-get opt :foreground))
18372 (bg (plist-get opt :background))
18373 ;; Ensure full list is printed.
18374 print-length print-level)
18375 (when forbuffer
18376 ;; Get the colors from the face at point.
18377 (goto-char beg)
18378 (when (eq fg 'auto)
18379 (setq fg (face-attribute face :foreground nil 'default)))
18380 (when (eq bg 'auto)
18381 (setq bg (face-attribute face :background nil 'default)))
18382 (setq optnew (copy-sequence opt))
18383 (plist-put optnew :foreground fg)
18384 (plist-put optnew :background bg))
18385 (setq hash (sha1 (prin1-to-string
18386 (list org-format-latex-header
18387 org-latex-default-packages-alist
18388 org-latex-packages-alist
18389 org-format-latex-options
18390 forbuffer txt fg bg)))
18391 linkfile (format "%s_%s.png" prefix hash)
18392 movefile (format "%s_%s.png" absprefix hash)))
18393 (setq link (concat block "[[file:" linkfile "]]" block))
18394 (if msg (message msg cnt))
18395 (goto-char beg)
18396 (unless checkdir ; Ensure the directory exists.
18397 (setq checkdir t)
18398 (or (file-directory-p todir) (make-directory todir t)))
18399 (unless (file-exists-p movefile)
18400 (org-create-formula-image
18401 txt movefile optnew forbuffer processing-type))
18402 (if overlays
18403 (progn
18404 (mapc (lambda (o)
18405 (if (eq (overlay-get o 'org-overlay-type)
18406 'org-latex-overlay)
18407 (delete-overlay o)))
18408 (overlays-in beg end))
18409 (setq ov (make-overlay beg end))
18410 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18411 (if (featurep 'xemacs)
18412 (progn
18413 (overlay-put ov 'invisible t)
18414 (overlay-put
18415 ov 'end-glyph
18416 (make-glyph (vector 'png :file movefile))))
18417 (overlay-put
18418 ov 'display
18419 (list 'image :type 'png :file movefile :ascent 'center)))
18420 (push ov org-latex-fragment-image-overlays)
18421 (goto-char end))
18422 (delete-region beg end)
18423 (insert (org-add-props link
18424 (list 'org-latex-src
18425 (replace-regexp-in-string
18427 'org-latex-src-embed-type
18428 (if block-type 'paragraph 'character))))))
18429 ((eq processing-type 'mathml)
18430 ;; Process to MathML
18431 (unless (save-match-data (org-format-latex-mathml-available-p))
18432 (user-error "LaTeX to MathML converter not configured"))
18433 (setq txt (match-string n)
18434 beg (match-beginning n) end (match-end n)
18435 cnt (1+ cnt))
18436 (if msg (message msg cnt))
18437 (goto-char beg)
18438 (delete-region beg end)
18439 (insert (org-format-latex-as-mathml
18440 txt block-type prefix dir)))
18441 (t
18442 (error "Unknown conversion type %s for LaTeX fragments"
18443 processing-type)))))))))
18445 (defun org-create-math-formula (latex-frag &optional mathml-file)
18446 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18447 Use `org-latex-to-mathml-convert-command'. If the conversion is
18449 elements otherwise return nil. When MATHML-FILE is specified,
18450 write the results in to that file. When invoked as an
18451 interactive command, prompt for LATEX-FRAG, with initial value
18452 set to the current active region and echo the results for user
18453 inspection."
18454 (interactive (list (let ((frag (when (org-region-active-p)
18455 (buffer-substring-no-properties
18456 (region-beginning) (region-end)))))
18457 (read-string "LaTeX Fragment: " frag nil frag))))
18458 (unless latex-frag (error "Invalid LaTeX fragment"))
18459 (let* ((tmp-in-file (file-relative-name
18460 (make-temp-name (expand-file-name "ltxmathml-in"))))
18461 (ignore (write-region latex-frag nil tmp-in-file))
18462 (tmp-out-file (file-relative-name
18463 (make-temp-name (expand-file-name "ltxmathml-out"))))
18464 (cmd (format-spec
18465 org-latex-to-mathml-convert-command
18466 `((?j . ,(shell-quote-argument
18467 (expand-file-name org-latex-to-mathml-jar-file)))
18468 (?I . ,(shell-quote-argument tmp-in-file))
18469 (?o . ,(shell-quote-argument tmp-out-file)))))
18470 mathml shell-command-output)
18471 (when (org-called-interactively-p 'any)
18472 (unless (org-format-latex-mathml-available-p)
18473 (user-error "LaTeX to MathML converter not configured")))
18474 (message "Running %s" cmd)
18475 (setq shell-command-output (shell-command-to-string cmd))
18476 (setq mathml
18477 (when (file-readable-p tmp-out-file)
18478 (with-current-buffer (find-file-noselect tmp-out-file t)
18479 (goto-char (point-min))
18480 (when (re-search-forward
18481 (concat
18482 (regexp-quote
18485 (regexp-quote "</math>")) nil t)
18486 (prog1 (match-string 0) (kill-buffer))))))
18487 (cond
18488 (mathml
18489 (setq mathml
18491 (when mathml-file
18492 (write-region mathml nil mathml-file))
18493 (when (org-called-interactively-p 'any)
18494 (message mathml)))
18495 ((message "LaTeX to MathML conversion failed")
18496 (message shell-command-output)))
18497 (delete-file tmp-in-file)
18498 (when (file-exists-p tmp-out-file)
18499 (delete-file tmp-out-file))
18500 mathml))
18502 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18503 prefix &optional dir)
18504 "Use `org-create-math-formula' but check local cache first."
18505 (let* ((absprefix (expand-file-name prefix dir))
18506 (print-length nil) (print-level nil)
18507 (formula-id (concat
18508 "formula-"
18509 (sha1
18510 (prin1-to-string
18511 (list latex-frag
18512 org-latex-to-mathml-convert-command)))))
18513 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18514 (formula-cache-dir (file-name-directory formula-cache)))
18516 (unless (file-directory-p formula-cache-dir)
18517 (make-directory formula-cache-dir t))
18519 (unless (file-exists-p formula-cache)
18520 (org-create-math-formula latex-frag formula-cache))
18522 (if (file-exists-p formula-cache)
18523 ;; Successful conversion. Return the link to MathML file.
18524 (org-add-props
18525 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18527 'org-latex-src-embed-type (if latex-frag-type
18528 'paragraph 'character)))
18529 ;; Failed conversion. Return the LaTeX fragment verbatim
18530 latex-frag)))
18532 (defun org-create-formula-image (string tofile options buffer &optional type)
18533 "Create an image from LaTeX source using dvipng or convert.
18534 This function calls either `org-create-formula-image-with-dvipng'
18535 or `org-create-formula-image-with-imagemagick' depending on the
18536 value of `org-latex-create-formula-image-program' or on the value
18537 of the optional TYPE variable.
18539 Note: ultimately these two function should be combined as they
18540 share a good deal of logic."
18541 (org-check-external-command
18542 "latex" "needed to convert LaTeX fragments to images")
18543 (funcall
18544 (case (or type org-latex-create-formula-image-program)
18545 ('dvipng
18546 (org-check-external-command
18547 "dvipng" "needed to convert LaTeX fragments to images")
18548 #'org-create-formula-image-with-dvipng)
18549 ('imagemagick
18550 (org-check-external-command
18551 "convert" "you need to install imagemagick")
18552 #'org-create-formula-image-with-imagemagick)
18553 (t (error
18554 "Invalid value of `org-latex-create-formula-image-program'")))
18555 string tofile options buffer))
18557 (declare-function org-export-get-backend "ox" (name))
18558 (declare-function org-export--get-global-options "ox" (&optional backend))
18559 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18560 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18561 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18562 (defun org-create-formula--latex-header ()
18563 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18564 (let ((info (org-combine-plists (org-export--get-global-options
18565 (org-export-get-backend 'latex))
18566 (org-export--get-inbuffer-options
18567 (org-export-get-backend 'latex)))))
18568 (org-latex-guess-babel-language
18569 (org-latex-guess-inputenc
18570 (org-splice-latex-header
18571 org-format-latex-header
18572 org-latex-default-packages-alist
18573 org-latex-packages-alist t
18574 (plist-get info :latex-header)))
18575 info)))
18577 ;; This function borrows from Ganesh Swami's latex2png.el
18578 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18579 "This calls dvipng."
18580 (require 'ox-latex)
18581 (let* ((tmpdir (if (featurep 'xemacs)
18582 (temp-directory)
18583 temporary-file-directory))
18584 (texfilebase (make-temp-name
18585 (expand-file-name "orgtex" tmpdir)))
18586 (texfile (concat texfilebase ".tex"))
18587 (dvifile (concat texfilebase ".dvi"))
18588 (pngfile (concat texfilebase ".png"))
18589 (fnh (if (featurep 'xemacs)
18590 (font-height (face-font 'default))
18591 (face-attribute 'default :height nil)))
18592 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18593 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18594 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18595 "Black"))
18596 (bg (or (plist-get options (if buffer :background :html-background))
18597 "Transparent")))
18598 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18599 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18600 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18601 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18602 (let ((latex-header (org-create-formula--latex-header)))
18603 (with-temp-file texfile
18604 (insert latex-header)
18606 (let ((dir default-directory))
18607 (condition-case nil
18608 (progn
18609 (cd tmpdir)
18610 (call-process "latex" nil nil nil texfile))
18611 (error nil))
18612 (cd dir))
18613 (if (not (file-exists-p dvifile))
18614 (progn (message "Failed to create dvi file from %s" texfile) nil)
18615 (condition-case nil
18616 (if (featurep 'xemacs)
18617 (call-process "dvipng" nil nil nil
18618 "-fg" fg "-bg" bg
18619 "-T" "tight"
18620 "-o" pngfile
18621 dvifile)
18622 (call-process "dvipng" nil nil nil
18623 "-fg" fg "-bg" bg
18624 "-D" dpi
18625 ;;"-x" scale "-y" scale
18626 "-T" "tight"
18627 "-o" pngfile
18628 dvifile))
18629 (error nil))
18630 (if (not (file-exists-p pngfile))
18631 (if org-format-latex-signal-error
18632 (error "Failed to create png file from %s" texfile)
18633 (message "Failed to create png file from %s" texfile)
18634 nil)
18635 ;; Use the requested file name and clean up
18636 (copy-file pngfile tofile 'replace)
18637 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18638 (if (file-exists-p (concat texfilebase e))
18639 (delete-file (concat texfilebase e))))
18640 pngfile))))
18642 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18643 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18644 "This calls convert, which is included into imagemagick."
18645 (require 'ox-latex)
18646 (let* ((tmpdir (if (featurep 'xemacs)
18647 (temp-directory)
18648 temporary-file-directory))
18649 (texfilebase (make-temp-name
18650 (expand-file-name "orgtex" tmpdir)))
18651 (texfile (concat texfilebase ".tex"))
18652 (pdffile (concat texfilebase ".pdf"))
18653 (pngfile (concat texfilebase ".png"))
18654 (fnh (if (featurep 'xemacs)
18655 (font-height (face-font 'default))
18656 (face-attribute 'default :height nil)))
18657 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18658 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18659 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18660 "black"))
18661 (bg (or (plist-get options (if buffer :background :html-background))
18662 "white")))
18663 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18664 (setq fg (org-latex-color-format fg)))
18665 (if (eq bg 'default) (setq bg (org-latex-color :background))
18666 (setq bg (org-latex-color-format
18667 (if (string= bg "Transparent") "white" bg))))
18668 (let ((latex-header (org-create-formula--latex-header)))
18669 (with-temp-file texfile
18670 (insert latex-header)
18676 string
18679 (org-latex-compile texfile t)
18680 (if (not (file-exists-p pdffile))
18681 (progn (message "Failed to create pdf file from %s" texfile) nil)
18682 (condition-case nil
18683 (if (featurep 'xemacs)
18684 (call-process "convert" nil nil nil
18685 "-density" "96"
18686 "-trim"
18687 "-antialias"
18688 pdffile
18689 "-quality" "100"
18690 ;; "-sharpen" "0x1.0"
18691 pngfile)
18692 (call-process "convert" nil nil nil
18693 "-density" dpi
18694 "-trim"
18695 "-antialias"
18696 pdffile
18697 "-quality" "100"
18698 ;; "-sharpen" "0x1.0"
18699 pngfile))
18700 (error nil))
18701 (if (not (file-exists-p pngfile))
18702 (if org-format-latex-signal-error
18703 (error "Failed to create png file from %s" texfile)
18704 (message "Failed to create png file from %s" texfile)
18705 nil)
18706 ;; Use the requested file name and clean up
18707 (copy-file pngfile tofile 'replace)
18708 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18709 (if (file-exists-p (concat texfilebase e))
18710 (delete-file (concat texfilebase e))))
18711 pngfile))))
18713 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18714 "Fill a LaTeX header template TPL.
18715 In the template, the following place holders will be recognized:
18718 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18720 [NO-PACKAGES] do not include PKG
18721 [EXTRA] the string EXTRA
18722 [NO-EXTRA] do not include EXTRA
18724 For backward compatibility, if both the positive and the negative place
18726 assumed to be present at the end of the template.
18727 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18728 EXTRA is a string.
18729 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18730 (let (rpl (end ""))
18732 (setq rpl (if (or (match-end 1) (not def-pkg))
18733 "" (org-latex-packages-to-string def-pkg snippets-p t))
18734 tpl (replace-match rpl t t tpl))
18735 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18738 (setq rpl (if (or (match-end 1) (not pkg))
18739 "" (org-latex-packages-to-string pkg snippets-p t))
18740 tpl (replace-match rpl t t tpl))
18741 (if pkg (setq end
18743 (org-latex-packages-to-string pkg snippets-p)))))
18746 (setq rpl (if (or (match-end 1) (not extra))
18748 tpl (replace-match rpl t t tpl))
18754 tpl)))
18756 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18758 (setq pkg (mapconcat (lambda(p)
18759 (cond
18760 ((stringp p) p)
18761 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18762 (format "%% Package %s omitted" (cadr p)))
18763 ((equal "" (car p))
18765 (t
18767 (car p) (cadr p)))))
18768 pkg
18772 (defun org-dvipng-color (attr)
18773 "Return a RGB color specification for dvipng."
18774 (apply 'format "rgb %s %s %s"
18775 (mapcar 'org-normalize-color
18776 (if (featurep 'xemacs)
18777 (color-rgb-components
18778 (face-property 'default
18779 (cond ((eq attr :foreground) 'foreground)
18780 ((eq attr :background) 'background))))
18781 (color-values (face-attribute 'default attr nil))))))
18783 (defun org-dvipng-color-format (color-name)
18784 "Convert COLOR-NAME to a RGB color value for dvipng."
18785 (apply 'format "rgb %s %s %s"
18786 (mapcar 'org-normalize-color
18787 (color-values color-name))))
18789 (defun org-latex-color (attr)
18790 "Return a RGB color for the LaTeX color package."
18791 (apply 'format "%s,%s,%s"
18792 (mapcar 'org-normalize-color
18793 (if (featurep 'xemacs)
18794 (color-rgb-components
18795 (face-property 'default
18796 (cond ((eq attr :foreground) 'foreground)
18797 ((eq attr :background) 'background))))
18798 (color-values (face-attribute 'default attr nil))))))
18800 (defun org-latex-color-format (color-name)
18801 "Convert COLOR-NAME to a RGB color value."
18802 (apply 'format "%s,%s,%s"
18803 (mapcar 'org-normalize-color
18804 (color-values color-name))))
18806 (defun org-normalize-color (value)
18807 "Return string to be used as color value for an RGB component."
18808 (format "%g" (/ value 65535.0)))
18811 \f
18812 ;; Image display
18814 (defvar org-inline-image-overlays nil)
18815 (make-variable-buffer-local 'org-inline-image-overlays)
18817 (defun org-toggle-inline-images (&optional include-linked)
18818 "Toggle the display of inline images.
18819 INCLUDE-LINKED is passed to `org-display-inline-images'."
18820 (interactive "P")
18821 (if org-inline-image-overlays
18822 (progn
18823 (org-remove-inline-images)
18824 (message "Inline image display turned off"))
18825 (org-display-inline-images include-linked)
18826 (if (and (org-called-interactively-p)
18827 org-inline-image-overlays)
18828 (message "%d images displayed inline"
18829 (length org-inline-image-overlays))
18830 (message "No images to display inline"))))
18832 (defun org-redisplay-inline-images ()
18833 "Refresh the display of inline images."
18834 (interactive)
18835 (if (not org-inline-image-overlays)
18836 (org-toggle-inline-images)
18837 (org-toggle-inline-images)
18838 (org-toggle-inline-images)))
18840 (defun org-display-inline-images (&optional include-linked refresh beg end)
18841 "Display inline images.
18842 Normally only links without a description part are inlined, because this
18843 is how it will work for export. When INCLUDE-LINKED is set, also links
18844 with a description part will be inlined. This can be nice for a quick
18845 look at those images, but it does not reflect what exported files will look
18846 like.
18847 When REFRESH is set, refresh existing images between BEG and END.
18848 This will create new image displays only if necessary.
18849 BEG and END default to the buffer boundaries."
18850 (interactive "P")
18851 (when (display-graphic-p)
18852 (unless refresh
18853 (org-remove-inline-images)
18854 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18855 (save-excursion
18856 (save-restriction
18857 (widen)
18858 (setq beg (or beg (point-min)) end (or end (point-max)))
18859 (goto-char beg)
18861 (substring (org-image-file-name-regexp) 0 -2)
18863 (case-fold-search t)
18864 old file ov img type attrwidth width)
18865 (while (re-search-forward re end t)
18866 (setq old (get-char-property-and-overlay (match-beginning 1)
18867 'org-image-overlay)
18868 file (expand-file-name
18869 (concat (or (match-string 3) "") (match-string 4))))
18870 (when (image-type-available-p 'imagemagick)
18871 (setq attrwidth (if (or (listp org-image-actual-width)
18872 (null org-image-actual-width))
18873 (save-excursion
18874 (save-match-data
18875 (when (re-search-backward
18877 (save-excursion
18879 (string-to-number (match-string 1))))))
18880 width (cond ((eq org-image-actual-width t) nil)
18881 ((null org-image-actual-width) attrwidth)
18882 ((numberp org-image-actual-width)
18883 org-image-actual-width)
18884 ((listp org-image-actual-width)
18885 (or attrwidth (car org-image-actual-width))))
18886 type (if width 'imagemagick)))
18887 (when (file-exists-p file)
18888 (if (and (car-safe old) refresh)
18889 (image-refresh (overlay-get (cdr old) 'display))
18890 (setq img (save-match-data (create-image file type nil :width width)))
18891 (when img
18892 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18893 (overlay-put ov 'display img)
18894 (overlay-put ov 'face 'default)
18895 (overlay-put ov 'org-image-overlay t)
18896 (overlay-put ov 'modification-hooks
18897 (list 'org-display-inline-remove-overlay))
18898 (push ov org-inline-image-overlays))))))))))
18900 (define-obsolete-function-alias
18901 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18903 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18904 "Remove inline-display overlay if a corresponding region is modified."
18905 (let ((inhibit-modification-hooks t))
18906 (when (and ov after)
18907 (delete ov org-inline-image-overlays)
18908 (delete-overlay ov))))
18910 (defun org-remove-inline-images ()
18911 "Remove inline display of images."
18912 (interactive)
18913 (mapc 'delete-overlay org-inline-image-overlays)
18914 (setq org-inline-image-overlays nil))
18916 ;;;; Key bindings
18918 ;; Outline functions from `outline-mode-prefix-map'
18919 ;; that can be remapped in Org:
18920 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18921 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18922 (define-key org-mode-map [remap outline-forward-same-level]
18923 'org-forward-heading-same-level)
18924 (define-key org-mode-map [remap outline-backward-same-level]
18925 'org-backward-heading-same-level)
18926 (define-key org-mode-map [remap show-branches]
18927 'org-kill-note-or-show-branches)
18928 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18929 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18930 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18932 ;; Outline functions from `outline-mode-prefix-map' that can not
18933 ;; be remapped in Org:
18934 ;;
18935 ;; - the column "key binding" shows whether the Outline function is still
18936 ;; available in Org mode on the same key that it has been bound to in
18937 ;; Outline mode:
18938 ;; - "overridden": key used for a different functionality in Org mode
18939 ;; - else: key still bound to the same Outline function in Org mode
18940 ;;
18941 ;; | Outline function | key binding | Org replacement |
18942 ;; |------------------------------------+-------------+-----------------------|
18943 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18944 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18945 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18946 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18947 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18948 ;; | `show-entry' | overridden | no replacement |
18949 ;; | `show-children' | `C-c C-i' | visibility cycling |
18950 ;; | `show-branches' | `C-c C-k' | still same function |
18951 ;; | `show-subtree' | overridden | visibility cycling |
18952 ;; | `show-all' | overridden | no replacement |
18953 ;; | `hide-subtree' | overridden | visibility cycling |
18954 ;; | `hide-body' | overridden | no replacement |
18955 ;; | `hide-entry' | overridden | visibility cycling |
18956 ;; | `hide-leaves' | overridden | no replacement |
18957 ;; | `hide-sublevels' | overridden | no replacement |
18958 ;; | `hide-other' | overridden | no replacement |
18960 ;; Make `C-c C-x' a prefix key
18961 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18963 ;; TAB key with modifiers
18964 (org-defkey org-mode-map "\C-i" 'org-cycle)
18965 (org-defkey org-mode-map [(tab)] 'org-cycle)
18966 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18968 ;; The following line is necessary under Suse GNU/Linux
18969 (unless (featurep 'xemacs)
18970 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18971 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18972 (define-key org-mode-map [backtab] 'org-shifttab)
18974 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18975 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18976 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18978 ;; Cursor keys with modifiers
18979 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18980 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18981 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18982 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18984 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18985 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18986 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18987 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18989 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18990 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18991 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18992 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18994 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18995 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18996 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18997 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18999 ;; Babel keys
19000 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19001 (mapc (lambda (pair)
19002 (define-key org-babel-map (car pair) (cdr pair)))
19003 org-babel-key-bindings)
19005 ;;; Extra keys for tty access.
19006 ;; We only set them when really needed because otherwise the
19007 ;; menus don't show the simple keys
19009 (when (or org-use-extra-keys
19010 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19011 (not window-system))
19012 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19013 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19014 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19015 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19016 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19017 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19018 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19019 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19020 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19021 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19022 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19023 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19024 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19025 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19026 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19027 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19028 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19029 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19030 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19031 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19032 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19033 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19034 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19035 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19036 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19037 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19038 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19039 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19041 ;; All the other keys
19043 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19044 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19045 (if (boundp 'narrow-map)
19046 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19047 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19048 (if (boundp 'narrow-map)
19049 (org-defkey narrow-map "b" 'org-narrow-to-block)
19050 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19051 (if (boundp 'narrow-map)
19052 (org-defkey narrow-map "e" 'org-narrow-to-element)
19053 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19054 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19055 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19056 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19057 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19058 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19059 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19060 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19061 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19062 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19063 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19064 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19065 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19066 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19067 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19068 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19069 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19070 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19071 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19072 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19073 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19074 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19075 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19076 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19077 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19078 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19079 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19081 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19082 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19083 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19084 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19085 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19086 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19087 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19088 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19089 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19090 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19091 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19092 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19093 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19094 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19095 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19096 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19097 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19098 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19099 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19100 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19101 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19103 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19104 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19105 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19106 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19107 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19108 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19109 (org-defkey org-mode-map "\C-c^" 'org-sort)
19110 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19111 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19112 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19113 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19114 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19115 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19116 (org-defkey org-mode-map "\C-m" 'org-return)
19117 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19118 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19119 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19120 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19121 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19122 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19123 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19124 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19125 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19126 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19127 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19128 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19129 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19130 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19131 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19132 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19133 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19134 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19135 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19136 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19137 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19138 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19139 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19141 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19142 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19143 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19145 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19146 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19147 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19148 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19149 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19150 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19151 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19152 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19153 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19154 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19155 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19156 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19157 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19159 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19160 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19161 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19162 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19163 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19164 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19165 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19166 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19167 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19169 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19170 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19171 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19172 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19173 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19175 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19177 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19179 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19180 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19182 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19185 (when (featurep 'xemacs)
19186 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19189 (defconst org-speed-commands-default
19190 '(
19191 ("Outline Navigation")
19192 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19193 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19194 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19195 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19196 ("F" . org-next-block)
19197 ("B" . org-previous-block)
19198 ("u" . (org-speed-move-safe 'outline-up-heading))
19199 ("j" . org-goto)
19200 ("g" . (org-refile t))
19201 ("Outline Visibility")
19202 ("c" . org-cycle)
19203 ("C" . org-shifttab)
19204 (" " . org-display-outline-path)
19205 ("s" . org-narrow-to-subtree)
19206 ("=" . org-columns)
19207 ("Outline Structure Editing")
19208 ("U" . org-shiftmetaup)
19209 ("D" . org-shiftmetadown)
19210 ("r" . org-metaright)
19211 ("l" . org-metaleft)
19212 ("R" . org-shiftmetaright)
19213 ("L" . org-shiftmetaleft)
19214 ("i" . (progn (forward-char 1) (call-interactively
19215 'org-insert-heading-respect-content)))
19216 ("^" . org-sort)
19217 ("w" . org-refile)
19218 ("a" . org-archive-subtree-default-with-confirmation)
19219 ("@" . org-mark-subtree)
19220 ("#" . org-toggle-comment)
19221 ("Clock Commands")
19222 ("I" . org-clock-in)
19223 ("O" . org-clock-out)
19224 ("Meta Data Editing")
19225 ("t" . org-todo)
19226 ("," . (org-priority))
19227 ("0" . (org-priority ?\ ))
19228 ("1" . (org-priority ?A))
19229 ("2" . (org-priority ?B))
19230 ("3" . (org-priority ?C))
19231 (":" . org-set-tags-command)
19232 ("e" . org-set-effort)
19233 ("E" . org-inc-effort)
19234 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19235 (org-entry-put (point) "APPT_WARNTIME" m)))
19236 ("Agenda Views etc")
19237 ("v" . org-agenda)
19238 ("/" . org-sparse-tree)
19239 ("Misc")
19240 ("o" . org-open-at-point)
19241 ("?" . org-speed-command-help)
19242 ("<" . (org-agenda-set-restriction-lock 'subtree))
19243 (">" . (org-agenda-remove-restriction-lock))
19244 )
19245 "The default speed commands.")
19247 (defun org-print-speed-command (e)
19248 (if (> (length (car e)) 1)
19249 (progn
19251 (princ (car e))
19253 (princ (make-string (length (car e)) ?-))
19255 (princ (car e))
19256 (princ " ")
19257 (if (symbolp (cdr e))
19258 (princ (symbol-name (cdr e)))
19259 (prin1 (cdr e)))
19262 (defun org-speed-command-help ()
19263 "Show the available speed commands."
19264 (interactive)
19265 (if (not org-use-speed-commands)
19266 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19267 (with-output-to-temp-buffer "*Help*"
19269 (mapc 'org-print-speed-command org-speed-commands-user)
19272 (mapc 'org-print-speed-command org-speed-commands-default))
19273 (with-current-buffer "*Help*"
19274 (setq truncate-lines t))))
19276 (defun org-speed-move-safe (cmd)
19277 "Execute CMD, but make sure that the cursor always ends up in a headline.
19278 If not, return to the original position and throw an error."
19279 (interactive)
19280 (let ((pos (point)))
19281 (call-interactively cmd)
19282 (unless (and (bolp) (org-at-heading-p))
19283 (goto-char pos)
19284 (error "Boundary reached while executing %s" cmd))))
19286 (defvar org-self-insert-command-undo-counter 0)
19288 (defvar org-table-auto-blank-field) ; defined in org-table.el
19289 (defvar org-speed-command nil)
19291 (define-obsolete-function-alias
19292 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19294 (defun org-speed-command-activate (keys)
19295 "Hook for activating single-letter speed commands.
19296 `org-speed-commands-default' specifies a minimal command set.
19297 Use `org-speed-commands-user' for further customization."
19298 (when (or (and (bolp) (looking-at org-outline-regexp))
19299 (and (functionp org-use-speed-commands)
19300 (funcall org-use-speed-commands)))
19301 (cdr (assoc keys (append org-speed-commands-user
19302 org-speed-commands-default)))))
19304 (define-obsolete-function-alias
19305 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19307 (defun org-babel-speed-command-activate (keys)
19308 "Hook for activating single-letter code block commands."
19309 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19310 (cdr (assoc keys org-babel-key-bindings))))
19312 (defcustom org-speed-command-hook
19313 '(org-speed-command-default-hook org-babel-speed-command-hook)
19314 "Hook for activating speed commands at strategic locations.
19315 Hook functions are called in sequence until a valid handler is
19316 found.
19318 Each hook takes a single argument, a user-pressed command key
19319 which is also a `self-insert-command' from the global map.
19321 Within the hook, examine the cursor position and the command key
19322 and return nil or a valid handler as appropriate. Handler could
19323 be one of an interactive command, a function, or a form.
19325 Set `org-use-speed-commands' to non-nil value to enable this
19326 hook. The default setting is `org-speed-command-activate'."
19327 :group 'org-structure
19328 :version "24.1"
19329 :type 'hook)
19331 (defun org-self-insert-command (N)
19332 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19333 If the cursor is in a table looking at whitespace, the whitespace is
19334 overwritten, and the table is not marked as requiring realignment."
19335 (interactive "p")
19336 (org-check-before-invisible-edit 'insert)
19337 (cond
19338 ((and org-use-speed-commands
19339 (setq org-speed-command
19340 (run-hook-with-args-until-success
19341 'org-speed-command-hook (this-command-keys))))
19342 (cond
19343 ((commandp org-speed-command)
19344 (setq this-command org-speed-command)
19345 (call-interactively org-speed-command))
19346 ((functionp org-speed-command)
19347 (funcall org-speed-command))
19348 ((and org-speed-command (listp org-speed-command))
19349 (eval org-speed-command))
19350 (t (let (org-use-speed-commands)
19351 (call-interactively 'org-self-insert-command)))))
19352 ((and
19353 (org-table-p)
19354 (progn
19355 ;; check if we blank the field, and if that triggers align
19356 (and (featurep 'org-table) org-table-auto-blank-field
19357 (member last-command
19358 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19360 ;; got extra space, this field does not determine column width
19361 (let (org-table-may-need-update) (org-table-blank-field))
19362 ;; no extra space, this field may determine column width
19363 (org-table-blank-field)))
19364 t)
19365 (eq N 1)
19367 (let (org-table-may-need-update)
19368 (goto-char (1- (match-end 0)))
19369 (backward-delete-char 1)
19370 (goto-char (match-beginning 0))
19371 (self-insert-command N)))
19372 (t
19373 (setq org-table-may-need-update t)
19374 (self-insert-command N)
19375 (org-fix-tags-on-the-fly)
19376 (if org-self-insert-cluster-for-undo
19377 (if (not (eq last-command 'org-self-insert-command))
19378 (setq org-self-insert-command-undo-counter 1)
19379 (if (>= org-self-insert-command-undo-counter 20)
19380 (setq org-self-insert-command-undo-counter 1)
19381 (and (> org-self-insert-command-undo-counter 0)
19382 buffer-undo-list (listp buffer-undo-list)
19383 (not (cadr buffer-undo-list)) ; remove nil entry
19384 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19385 (setq org-self-insert-command-undo-counter
19386 (1+ org-self-insert-command-undo-counter))))))))
19388 (defun org-check-before-invisible-edit (kind)
19389 "Check is editing if kind KIND would be dangerous with invisible text around.
19390 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19391 ;; First, try to get out of here as quickly as possible, to reduce overhead
19392 (if (and org-catch-invisible-edits
19393 (or (not (boundp 'visible-mode)) (not visible-mode))
19394 (or (get-char-property (point) 'invisible)
19395 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19396 ;; OK, we need to take a closer look
19397 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19398 (invisible-before-point (if (bobp) nil (get-char-property
19399 (1- (point)) 'invisible)))
19400 (border-and-ok-direction
19401 (or
19402 ;; Check if we are acting predictably before invisible text
19403 (and invisible-at-point (not invisible-before-point)
19404 (memq kind '(insert delete-backward)))
19405 ;; Check if we are acting predictably after invisible text
19406 ;; This works not well, and I have turned it off. It seems
19407 ;; better to always show and stop after invisible text.
19408 ;; (and (not invisible-at-point) invisible-before-point
19409 ;; (memq kind '(insert delete)))
19410 )))
19411 (when (or (memq invisible-at-point '(outline org-hide-block t))
19412 (memq invisible-before-point '(outline org-hide-block t)))
19413 (if (eq org-catch-invisible-edits 'error)
19414 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19415 (if (and org-custom-properties-overlays
19416 (y-or-n-p "Display invisible properties in this buffer? "))
19417 (org-toggle-custom-properties-visibility)
19418 ;; Make the area visible
19419 (save-excursion
19420 (if invisible-before-point
19421 (goto-char (previous-single-char-property-change
19422 (point) 'invisible)))
19423 (org-cycle))
19424 (cond
19425 ((eq org-catch-invisible-edits 'show)
19426 ;; That's it, we do the edit after showing
19427 (message
19428 "Unfolding invisible region around point before editing")
19429 (sit-for 1))
19430 ((and (eq org-catch-invisible-edits 'smart)
19431 border-and-ok-direction)
19432 (message "Unfolding invisible region around point before editing"))
19433 (t
19434 ;; Don't do the edit, make the user repeat it in full visibility
19435 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19437 (defun org-fix-tags-on-the-fly ()
19438 (when (and (equal (char-after (point-at-bol)) ?*)
19439 (org-at-heading-p))
19440 (org-align-tags-here org-tags-column)))
19442 (defun org-delete-backward-char (N)
19443 "Like `delete-backward-char', insert whitespace at field end in tables.
19444 When deleting backwards, in tables this function will insert whitespace in
19446 still be marked for re-alignment if the field did fill the entire column,
19447 because, in this case the deletion might narrow the column."
19448 (interactive "p")
19449 (save-match-data
19450 (org-check-before-invisible-edit 'delete-backward)
19451 (if (and (org-table-p)
19452 (eq N 1)
19453 (string-match "|" (buffer-substring (point-at-bol) (point)))
19454 (looking-at ".*?|"))
19455 (let ((pos (point))
19457 (c org-table-may-need-update))
19458 (backward-delete-char N)
19459 (if (not overwrite-mode)
19460 (progn
19461 (skip-chars-forward "^|")
19462 (insert " ")
19463 (goto-char (1- pos))))
19464 ;; noalign: if there were two spaces at the end, this field
19465 ;; does not determine the width of the column.
19466 (if noalign (setq org-table-may-need-update c)))
19467 (backward-delete-char N)
19468 (org-fix-tags-on-the-fly))))
19470 (defun org-delete-char (N)
19471 "Like `delete-char', but insert whitespace at field end in tables.
19472 When deleting characters, in tables this function will insert whitespace in
19474 still be marked for re-alignment if the field did fill the entire column,
19475 because, in this case the deletion might narrow the column."
19476 (interactive "p")
19477 (save-match-data
19478 (org-check-before-invisible-edit 'delete)
19479 (if (and (org-table-p)
19480 (not (bolp))
19481 (not (= (char-after) ?|))
19482 (eq N 1))
19483 (if (looking-at ".*?|")
19484 (let ((pos (point))
19486 (c org-table-may-need-update))
19487 (replace-match
19488 (concat (substring (match-string 0) 1 -1) " |") nil t)
19489 (goto-char pos)
19490 ;; noalign: if there were two spaces at the end, this field
19491 ;; does not determine the width of the column.
19492 (if noalign (setq org-table-may-need-update c)))
19493 (delete-char N))
19494 (delete-char N)
19495 (org-fix-tags-on-the-fly))))
19497 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19498 (put 'org-self-insert-command 'delete-selection t)
19499 (put 'orgtbl-self-insert-command 'delete-selection t)
19500 (put 'org-delete-char 'delete-selection 'supersede)
19501 (put 'org-delete-backward-char 'delete-selection 'supersede)
19502 (put 'org-yank 'delete-selection 'yank)
19504 ;; Make `flyspell-mode' delay after some commands
19505 (put 'org-self-insert-command 'flyspell-delayed t)
19506 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19507 (put 'org-delete-char 'flyspell-delayed t)
19508 (put 'org-delete-backward-char 'flyspell-delayed t)
19510 ;; Make pabbrev-mode expand after org-mode commands
19511 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19512 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19514 ;; How to do this: Measure non-white length of current string
19515 ;; If equal to column width, we should realign.
19517 (defun org-remap (map &rest commands)
19518 "In MAP, remap the functions given in COMMANDS.
19519 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19520 (let (new old)
19521 (while commands
19522 (setq old (pop commands) new (pop commands))
19523 (if (fboundp 'command-remapping)
19524 (org-defkey map (vector 'remap old) new)
19525 (substitute-key-definition old new map global-map)))))
19527 (defun org-transpose-words ()
19528 "Transpose words for Org.
19529 This uses the `org-mode-transpose-word-syntax-table' syntax
19530 table, which interprets characters in `org-emphasis-alist' as
19531 word constituants."
19532 (interactive)
19533 (with-syntax-table org-mode-transpose-word-syntax-table
19534 (call-interactively 'transpose-words)))
19535 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19537 (when (eq org-enable-table-editor 'optimized)
19538 ;; If the user wants maximum table support, we need to hijack
19539 ;; some standard editing functions
19540 (org-remap org-mode-map
19541 'self-insert-command 'org-self-insert-command
19542 'delete-char 'org-delete-char
19543 'delete-backward-char 'org-delete-backward-char)
19544 (org-defkey org-mode-map "|" 'org-force-self-insert))
19546 (defvar org-ctrl-c-ctrl-c-hook nil
19547 "Hook for functions attaching themselves to `C-c C-c'.
19549 This can be used to add additional functionality to the C-c C-c
19550 key which executes context-dependent commands. This hook is run
19551 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19552 run after the last test.
19554 Each function will be called with no arguments. The function
19555 must check if the context is appropriate for it to act. If yes,
19556 it should do its thing and then return a non-nil value. If the
19557 context is wrong, just do nothing and return nil.")
19559 (defvar org-ctrl-c-ctrl-c-final-hook nil
19560 "Hook for functions attaching themselves to `C-c C-c'.
19562 This can be used to add additional functionality to the C-c C-c
19563 key which executes context-dependent commands. This hook is run
19564 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19565 before the first test.
19567 Each function will be called with no arguments. The function
19568 must check if the context is appropriate for it to act. If yes,
19569 it should do its thing and then return a non-nil value. If the
19570 context is wrong, just do nothing and return nil.")
19572 (defvar org-tab-first-hook nil
19573 "Hook for functions to attach themselves to TAB.
19574 See `org-ctrl-c-ctrl-c-hook' for more information.
19575 This hook runs as the first action when TAB is pressed, even before
19576 `org-cycle' messes around with the `outline-regexp' to cater for
19577 inline tasks and plain list item folding.
19578 If any function in this hook returns t, any other actions that
19579 would have been caused by TAB (such as table field motion or visibility
19580 cycling) will not occur.")
19582 (defvar org-tab-after-check-for-table-hook nil
19583 "Hook for functions to attach themselves to TAB.
19584 See `org-ctrl-c-ctrl-c-hook' for more information.
19585 This hook runs after it has been established that the cursor is not in a
19586 table, but before checking if the cursor is in a headline or if global cycling
19587 should be done.
19588 If any function in this hook returns t, not other actions like visibility
19589 cycling will be done.")
19591 (defvar org-tab-after-check-for-cycling-hook nil
19592 "Hook for functions to attach themselves to TAB.
19593 See `org-ctrl-c-ctrl-c-hook' for more information.
19594 This hook runs after it has been established that not table field motion and
19595 not visibility should be done because of current context. This is probably
19596 the place where a package like yasnippets can hook in.")
19598 (defvar org-tab-before-tab-emulation-hook nil
19599 "Hook for functions to attach themselves to TAB.
19600 See `org-ctrl-c-ctrl-c-hook' for more information.
19601 This hook runs after every other options for TAB have been exhausted, but
19604 (defvar org-metaleft-hook nil
19605 "Hook for functions attaching themselves to `M-left'.
19606 See `org-ctrl-c-ctrl-c-hook' for more information.")
19607 (defvar org-metaright-hook nil
19608 "Hook for functions attaching themselves to `M-right'.
19609 See `org-ctrl-c-ctrl-c-hook' for more information.")
19610 (defvar org-metaup-hook nil
19611 "Hook for functions attaching themselves to `M-up'.
19612 See `org-ctrl-c-ctrl-c-hook' for more information.")
19613 (defvar org-metadown-hook nil
19614 "Hook for functions attaching themselves to `M-down'.
19615 See `org-ctrl-c-ctrl-c-hook' for more information.")
19616 (defvar org-shiftmetaleft-hook nil
19617 "Hook for functions attaching themselves to `M-S-left'.
19618 See `org-ctrl-c-ctrl-c-hook' for more information.")
19619 (defvar org-shiftmetaright-hook nil
19620 "Hook for functions attaching themselves to `M-S-right'.
19621 See `org-ctrl-c-ctrl-c-hook' for more information.")
19622 (defvar org-shiftmetaup-hook nil
19623 "Hook for functions attaching themselves to `M-S-up'.
19624 See `org-ctrl-c-ctrl-c-hook' for more information.")
19625 (defvar org-shiftmetadown-hook nil
19626 "Hook for functions attaching themselves to `M-S-down'.
19627 See `org-ctrl-c-ctrl-c-hook' for more information.")
19628 (defvar org-metareturn-hook nil
19629 "Hook for functions attaching themselves to `M-RET'.
19630 See `org-ctrl-c-ctrl-c-hook' for more information.")
19631 (defvar org-shiftup-hook nil
19632 "Hook for functions attaching themselves to `S-up'.
19633 See `org-ctrl-c-ctrl-c-hook' for more information.")
19634 (defvar org-shiftup-final-hook nil
19635 "Hook for functions attaching themselves to `S-up'.
19636 This one runs after all other options except shift-select have been excluded.
19637 See `org-ctrl-c-ctrl-c-hook' for more information.")
19638 (defvar org-shiftdown-hook nil
19639 "Hook for functions attaching themselves to `S-down'.
19640 See `org-ctrl-c-ctrl-c-hook' for more information.")
19641 (defvar org-shiftdown-final-hook nil
19642 "Hook for functions attaching themselves to `S-down'.
19643 This one runs after all other options except shift-select have been excluded.
19644 See `org-ctrl-c-ctrl-c-hook' for more information.")
19645 (defvar org-shiftleft-hook nil
19646 "Hook for functions attaching themselves to `S-left'.
19647 See `org-ctrl-c-ctrl-c-hook' for more information.")
19648 (defvar org-shiftleft-final-hook nil
19649 "Hook for functions attaching themselves to `S-left'.
19650 This one runs after all other options except shift-select have been excluded.
19651 See `org-ctrl-c-ctrl-c-hook' for more information.")
19652 (defvar org-shiftright-hook nil
19653 "Hook for functions attaching themselves to `S-right'.
19654 See `org-ctrl-c-ctrl-c-hook' for more information.")
19655 (defvar org-shiftright-final-hook nil
19656 "Hook for functions attaching themselves to `S-right'.
19657 This one runs after all other options except shift-select have been excluded.
19658 See `org-ctrl-c-ctrl-c-hook' for more information.")
19660 (defun org-modifier-cursor-error ()
19661 "Throw an error, a modified cursor command was applied in wrong context."
19662 (user-error "This command is active in special context like tables, headlines or items"))
19664 (defun org-shiftselect-error ()
19665 "Throw an error because Shift-Cursor command was applied in wrong context."
19666 (if (and (boundp 'shift-select-mode) shift-select-mode)
19667 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19668 (user-error "This command works only in special context like headlines or timestamps")))
19670 (defun org-call-for-shift-select (cmd)
19671 (let ((this-command-keys-shift-translated t))
19672 (call-interactively cmd)))
19674 (defun org-shifttab (&optional arg)
19675 "Global visibility cycling or move to previous table field.
19676 Call `org-table-previous-field' within a table.
19677 When ARG is nil, cycle globally through visibility states.
19678 When ARG is a numeric prefix, show contents of this level."
19679 (interactive "P")
19680 (cond
19681 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19682 ((integerp arg)
19683 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19684 (message "Content view to level: %d" arg)
19685 (org-content (prefix-numeric-value arg2))
19686 (org-cycle-show-empty-lines t)
19687 (setq org-cycle-global-status 'overview)))
19688 (t (call-interactively 'org-global-cycle))))
19690 (defun org-shiftmetaleft ()
19691 "Promote subtree or delete table column.
19692 Calls `org-promote-subtree', `org-outdent-item-tree', or
19693 `org-table-delete-column', depending on context. See the
19694 individual commands for more information."
19695 (interactive)
19696 (cond
19697 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19698 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19699 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19700 ((if (not (org-region-active-p)) (org-at-item-p)
19701 (save-excursion (goto-char (region-beginning))
19702 (org-at-item-p)))
19703 (call-interactively 'org-outdent-item-tree))
19704 (t (org-modifier-cursor-error))))
19706 (defun org-shiftmetaright ()
19707 "Demote subtree or insert table column.
19708 Calls `org-demote-subtree', `org-indent-item-tree', or
19709 `org-table-insert-column', depending on context. See the
19710 individual commands for more information."
19711 (interactive)
19712 (cond
19713 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19714 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19715 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19716 ((if (not (org-region-active-p)) (org-at-item-p)
19717 (save-excursion (goto-char (region-beginning))
19718 (org-at-item-p)))
19719 (call-interactively 'org-indent-item-tree))
19720 (t (org-modifier-cursor-error))))
19722 (defun org-shiftmetaup (&optional arg)
19723 "Move subtree up or kill table row.
19724 Calls `org-move-subtree-up' or `org-table-kill-row' or
19725 `org-move-item-up' or `org-timestamp-up', depending on context.
19726 See the individual commands for more information."
19727 (interactive "P")
19728 (cond
19729 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19730 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19731 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19732 ((org-at-item-p) (call-interactively 'org-move-item-up))
19733 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19734 (call-interactively 'org-timestamp-up)))
19735 (t (call-interactively 'org-drag-line-backward))))
19737 (defun org-shiftmetadown (&optional arg)
19738 "Move subtree down or insert table row.
19739 Calls `org-move-subtree-down' or `org-table-insert-row' or
19740 `org-move-item-down' or `org-timestamp-up', depending on context.
19741 See the individual commands for more information."
19742 (interactive "P")
19743 (cond
19744 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19745 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19746 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19747 ((org-at-item-p) (call-interactively 'org-move-item-down))
19748 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19749 (call-interactively 'org-timestamp-down)))
19750 (t (call-interactively 'org-drag-line-forward))))
19752 (defsubst org-hidden-tree-error ()
19753 (user-error
19754 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19756 (defun org-metaleft (&optional arg)
19757 "Promote heading or move table column to left.
19758 Calls `org-do-promote' or `org-table-move-column', depending on context.
19759 With no specific context, calls the Emacs default `backward-word'.
19760 See the individual commands for more information."
19761 (interactive "P")
19762 (cond
19763 ((run-hook-with-args-until-success 'org-metaleft-hook))
19764 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19765 ((org-with-limited-levels
19766 (or (org-at-heading-p)
19767 (and (org-region-active-p)
19768 (save-excursion
19769 (goto-char (region-beginning))
19770 (org-at-heading-p)))))
19771 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19772 (call-interactively 'org-do-promote))
19773 ;; At an inline task.
19774 ((org-at-heading-p)
19775 (call-interactively 'org-inlinetask-promote))
19776 ((or (org-at-item-p)
19777 (and (org-region-active-p)
19778 (save-excursion
19779 (goto-char (region-beginning))
19780 (org-at-item-p))))
19781 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19782 (call-interactively 'org-outdent-item))
19783 (t (call-interactively 'backward-word))))
19785 (defun org-metaright (&optional arg)
19786 "Demote a subtree, a list item or move table column to right.
19787 In front of a drawer or a block keyword, indent it correctly.
19788 With no specific context, calls the Emacs default `forward-word'.
19789 See the individual commands for more information."
19790 (interactive "P")
19791 (cond
19792 ((run-hook-with-args-until-success 'org-metaright-hook))
19793 ((org-at-table-p) (call-interactively 'org-table-move-column))
19794 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19795 ((org-at-block-p) (call-interactively 'org-indent-block))
19796 ((org-with-limited-levels
19797 (or (org-at-heading-p)
19798 (and (org-region-active-p)
19799 (save-excursion
19800 (goto-char (region-beginning))
19801 (org-at-heading-p)))))
19802 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19803 (call-interactively 'org-do-demote))
19804 ;; At an inline task.
19805 ((org-at-heading-p)
19806 (call-interactively 'org-inlinetask-demote))
19807 ((or (org-at-item-p)
19808 (and (org-region-active-p)
19809 (save-excursion
19810 (goto-char (region-beginning))
19811 (org-at-item-p))))
19812 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19813 (call-interactively 'org-indent-item))
19814 (t (call-interactively 'forward-word))))
19816 (defun org-check-for-hidden (what)
19817 "Check if there are hidden headlines/items in the current visual line.
19818 WHAT can be either `headlines' or `items'. If the current line is
19819 an outline or item heading and it has a folded subtree below it,
19820 this function returns t, nil otherwise."
19821 (let ((re (cond
19822 ((eq what 'headlines) org-outline-regexp-bol)
19823 ((eq what 'items) (org-item-beginning-re))
19824 (t (error "This should not happen"))))
19825 beg end)
19826 (save-excursion
19827 (catch 'exit
19828 (unless (org-region-active-p)
19829 (setq beg (point-at-bol))
19830 (beginning-of-line 2)
19831 (while (and (not (eobp)) ;; this is like `next-line'
19832 (get-char-property (1- (point)) 'invisible))
19833 (beginning-of-line 2))
19834 (setq end (point))
19835 (goto-char beg)
19836 (goto-char (point-at-eol))
19837 (setq end (max end (point)))
19838 (while (re-search-forward re end t)
19839 (if (get-char-property (match-beginning 0) 'invisible)
19840 (throw 'exit t))))
19841 nil))))
19843 (defun org-metaup (&optional arg)
19844 "Move subtree up or move table row up.
19845 Calls `org-move-subtree-up' or `org-table-move-row' or
19846 `org-move-item-up', depending on context. See the individual commands
19847 for more information."
19848 (interactive "P")
19849 (cond
19850 ((run-hook-with-args-until-success 'org-metaup-hook))
19851 ((org-region-active-p)
19852 (let* ((a (min (region-beginning) (region-end)))
19853 (b (1- (max (region-beginning) (region-end))))
19854 (c (save-excursion (goto-char a)
19855 (move-beginning-of-line 0)))
19856 (d (save-excursion (goto-char a)
19857 (move-end-of-line 0) (point))))
19858 (transpose-regions a b c d)
19859 (goto-char c)))
19860 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19861 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19862 ((org-at-item-p) (call-interactively 'org-move-item-up))
19863 (t (org-drag-element-backward))))
19865 (defun org-metadown (&optional arg)
19866 "Move subtree down or move table row down.
19867 Calls `org-move-subtree-down' or `org-table-move-row' or
19868 `org-move-item-down', depending on context. See the individual
19869 commands for more information."
19870 (interactive "P")
19871 (cond
19872 ((run-hook-with-args-until-success 'org-metadown-hook))
19873 ((org-region-active-p)
19874 (let* ((a (min (region-beginning) (region-end)))
19875 (b (max (region-beginning) (region-end)))
19876 (c (save-excursion (goto-char b)
19877 (move-beginning-of-line 1)))
19878 (d (save-excursion (goto-char b)
19879 (move-end-of-line 1) (1+ (point)))))
19880 (transpose-regions a b c d)
19881 (goto-char d)))
19882 ((org-at-table-p) (call-interactively 'org-table-move-row))
19883 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19884 ((org-at-item-p) (call-interactively 'org-move-item-down))
19885 (t (org-drag-element-forward))))
19887 (defun org-shiftup (&optional arg)
19888 "Increase item in timestamp or increase priority of current headline.
19889 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19890 depending on context. See the individual commands for more information."
19891 (interactive "P")
19892 (cond
19893 ((run-hook-with-args-until-success 'org-shiftup-hook))
19894 ((and org-support-shift-select (org-region-active-p))
19895 (org-call-for-shift-select 'previous-line))
19896 ((org-at-timestamp-p t)
19897 (call-interactively (if org-edit-timestamp-down-means-later
19898 'org-timestamp-down 'org-timestamp-up)))
19899 ((and (not (eq org-support-shift-select 'always))
19900 org-enable-priority-commands
19901 (org-at-heading-p))
19902 (call-interactively 'org-priority-up))
19903 ((and (not org-support-shift-select) (org-at-item-p))
19904 (call-interactively 'org-previous-item))
19905 ((org-clocktable-try-shift 'up arg))
19906 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19907 (org-support-shift-select
19908 (org-call-for-shift-select 'previous-line))
19909 (t (org-shiftselect-error))))
19911 (defun org-shiftdown (&optional arg)
19912 "Decrease item in timestamp or decrease priority of current headline.
19913 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19914 depending on context. See the individual commands for more information."
19915 (interactive "P")
19916 (cond
19917 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19918 ((and org-support-shift-select (org-region-active-p))
19919 (org-call-for-shift-select 'next-line))
19920 ((org-at-timestamp-p t)
19921 (call-interactively (if org-edit-timestamp-down-means-later
19922 'org-timestamp-up 'org-timestamp-down)))
19923 ((and (not (eq org-support-shift-select 'always))
19924 org-enable-priority-commands
19925 (org-at-heading-p))
19926 (call-interactively 'org-priority-down))
19927 ((and (not org-support-shift-select) (org-at-item-p))
19928 (call-interactively 'org-next-item))
19929 ((org-clocktable-try-shift 'down arg))
19930 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19931 (org-support-shift-select
19932 (org-call-for-shift-select 'next-line))
19933 (t (org-shiftselect-error))))
19935 (defun org-shiftright (&optional arg)
19936 "Cycle the thing at point or in the current line, depending on context.
19937 Depending on context, this does one of the following:
19939 - switch a timestamp at point one day into the future
19940 - on a headline, switch to the next TODO keyword.
19941 - on an item, switch entire list to the next bullet type
19942 - on a property line, switch to the next allowed value
19943 - on a clocktable definition line, move time block into the future"
19944 (interactive "P")
19945 (cond
19946 ((run-hook-with-args-until-success 'org-shiftright-hook))
19947 ((and org-support-shift-select (org-region-active-p))
19948 (org-call-for-shift-select 'forward-char))
19949 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19950 ((and (not (eq org-support-shift-select 'always))
19951 (org-at-heading-p))
19952 (let ((org-inhibit-logging
19953 (not org-treat-S-cursor-todo-selection-as-state-change))
19954 (org-inhibit-blocking
19955 (not org-treat-S-cursor-todo-selection-as-state-change)))
19956 (org-call-with-arg 'org-todo 'right)))
19957 ((or (and org-support-shift-select
19958 (not (eq org-support-shift-select 'always))
19959 (org-at-item-bullet-p))
19960 (and (not org-support-shift-select) (org-at-item-p)))
19961 (org-call-with-arg 'org-cycle-list-bullet nil))
19962 ((and (not (eq org-support-shift-select 'always))
19963 (org-at-property-p))
19964 (call-interactively 'org-property-next-allowed-value))
19965 ((org-clocktable-try-shift 'right arg))
19966 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19967 (org-support-shift-select
19968 (org-call-for-shift-select 'forward-char))
19969 (t (org-shiftselect-error))))
19971 (defun org-shiftleft (&optional arg)
19972 "Cycle the thing at point or in the current line, depending on context.
19973 Depending on context, this does one of the following:
19975 - switch a timestamp at point one day into the past
19976 - on a headline, switch to the previous TODO keyword.
19977 - on an item, switch entire list to the previous bullet type
19978 - on a property line, switch to the previous allowed value
19979 - on a clocktable definition line, move time block into the past"
19980 (interactive "P")
19981 (cond
19982 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19983 ((and org-support-shift-select (org-region-active-p))
19984 (org-call-for-shift-select 'backward-char))
19985 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19986 ((and (not (eq org-support-shift-select 'always))
19987 (org-at-heading-p))
19988 (let ((org-inhibit-logging
19989 (not org-treat-S-cursor-todo-selection-as-state-change))
19990 (org-inhibit-blocking
19991 (not org-treat-S-cursor-todo-selection-as-state-change)))
19992 (org-call-with-arg 'org-todo 'left)))
19993 ((or (and org-support-shift-select
19994 (not (eq org-support-shift-select 'always))
19995 (org-at-item-bullet-p))
19996 (and (not org-support-shift-select) (org-at-item-p)))
19997 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19998 ((and (not (eq org-support-shift-select 'always))
19999 (org-at-property-p))
20000 (call-interactively 'org-property-previous-allowed-value))
20001 ((org-clocktable-try-shift 'left arg))
20002 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20003 (org-support-shift-select
20004 (org-call-for-shift-select 'backward-char))
20005 (t (org-shiftselect-error))))
20007 (defun org-shiftcontrolright ()
20008 "Switch to next TODO set."
20009 (interactive)
20010 (cond
20011 ((and org-support-shift-select (org-region-active-p))
20012 (org-call-for-shift-select 'forward-word))
20013 ((and (not (eq org-support-shift-select 'always))
20014 (org-at-heading-p))
20015 (org-call-with-arg 'org-todo 'nextset))
20016 (org-support-shift-select
20017 (org-call-for-shift-select 'forward-word))
20018 (t (org-shiftselect-error))))
20020 (defun org-shiftcontrolleft ()
20021 "Switch to previous TODO set."
20022 (interactive)
20023 (cond
20024 ((and org-support-shift-select (org-region-active-p))
20025 (org-call-for-shift-select 'backward-word))
20026 ((and (not (eq org-support-shift-select 'always))
20027 (org-at-heading-p))
20028 (org-call-with-arg 'org-todo 'previousset))
20029 (org-support-shift-select
20030 (org-call-for-shift-select 'backward-word))
20031 (t (org-shiftselect-error))))
20033 (defun org-shiftcontrolup (&optional n)
20034 "Change timestamps synchronously up in CLOCK log lines.
20035 Optional argument N tells to change by that many units."
20036 (interactive "P")
20037 (cond ((and (not org-support-shift-select)
20038 (org-at-clock-log-p)
20039 (org-at-timestamp-p t))
20040 (org-clock-timestamps-up n))
20041 (t (org-shiftselect-error))))
20043 (defun org-shiftcontroldown (&optional n)
20044 "Change timestamps synchronously down in CLOCK log lines.
20045 Optional argument N tells to change by that many units."
20046 (interactive "P")
20047 (cond ((and (not org-support-shift-select)
20048 (org-at-clock-log-p)
20049 (org-at-timestamp-p t))
20050 (org-clock-timestamps-down n))
20051 (t (org-shiftselect-error))))
20053 (defun org-ctrl-c-ret ()
20054 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20055 (interactive)
20056 (cond
20057 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20058 (t (call-interactively 'org-insert-heading))))
20060 (defun org-find-visible ()
20061 (let ((s (point)))
20062 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20063 (get-char-property s 'invisible)))
20064 s))
20065 (defun org-find-invisible ()
20066 (let ((s (point)))
20067 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20068 (not (get-char-property s 'invisible))))
20069 s))
20071 (defun org-copy-visible (beg end)
20072 "Copy the visible parts of the region."
20073 (interactive "r")
20074 (let (snippets s)
20075 (save-excursion
20076 (save-restriction
20077 (narrow-to-region beg end)
20078 (setq s (goto-char (point-min)))
20079 (while (not (= (point) (point-max)))
20080 (goto-char (org-find-invisible))
20081 (push (buffer-substring s (point)) snippets)
20082 (setq s (goto-char (org-find-visible))))))
20083 (kill-new (apply 'concat (nreverse snippets)))))
20085 (defun org-copy-special ()
20086 "Copy region in table or copy current subtree.
20087 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20088 See the individual commands for more information."
20089 (interactive)
20090 (call-interactively
20091 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20093 (defun org-cut-special ()
20094 "Cut region in table or cut current subtree.
20095 Calls `org-table-copy' or `org-cut-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-cut-region 'org-cut-subtree)))
20101 (defun org-paste-special (arg)
20102 "Paste rectangular region into table, or past subtree relative to level.
20103 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20104 See the individual commands for more information."
20105 (interactive "P")
20106 (if (org-at-table-p)
20107 (org-table-paste-rectangle)
20108 (org-paste-subtree arg)))
20110 (defsubst org-in-fixed-width-region-p ()
20111 "Is point in a fixed-width region?"
20112 (save-match-data
20113 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20115 (defun org-edit-special (&optional arg)
20116 "Call a special editor for the element at point.
20117 When at a table, call the formula editor with `org-table-edit-formulas'.
20118 When in a source code block, call `org-edit-src-code'.
20119 When in a fixed-width region, call `org-edit-fixed-width-region'.
20120 When at an #+INCLUDE keyword, visit the included file.
20121 On a link, call `ffap' to visit the link at point.
20122 Otherwise, return a user error."
20123 (interactive "P")
20124 (let ((element (org-element-at-point)))
20125 (assert (not buffer-read-only) nil
20126 "Buffer is read-only: %s" (buffer-name))
20127 (case (org-element-type element)
20128 (src-block
20129 (if (not arg) (org-edit-src-code)
20130 (let* ((info (org-babel-get-src-block-info))
20131 (lang (nth 0 info))
20132 (params (nth 2 info))
20133 (session (cdr (assq :session params))))
20134 (if (not session) (org-edit-src-code)
20135 ;; At a src-block with a session and function called with
20136 ;; an ARG: switch to the buffer related to the inferior
20137 ;; process.
20138 (switch-to-buffer
20139 (funcall (intern (concat "org-babel-prep-session:" lang))
20140 session params))))))
20141 (keyword
20142 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20143 (find-file
20144 (org-remove-double-quotes
20145 (car (org-split-string (org-element-property :value element)))))
20146 (user-error "No special environment to edit here")))
20147 (table
20148 (if (eq (org-element-property :type element) 'table.el)
20149 (org-edit-src-code)
20150 (call-interactively 'org-table-edit-formulas)))
20151 ;; Only Org tables contain `table-row' type elements.
20152 (table-row (call-interactively 'org-table-edit-formulas))
20153 ((example-block export-block) (org-edit-src-code))
20154 (fixed-width (org-edit-fixed-width-region))
20155 (otherwise
20156 ;; No notable element at point. Though, we may be at a link,
20157 ;; which is an object. Thus, scan deeper.
20158 (if (eq (org-element-type (org-element-context element)) 'link)
20159 (call-interactively 'ffap)
20160 (user-error "No special environment to edit here"))))))
20162 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20163 (defun org-ctrl-c-ctrl-c (&optional arg)
20164 "Set tags in headline, or update according to changed information at point.
20166 This command does many different things, depending on context:
20168 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20169 this is what we do.
20171 - If the cursor is on a statistics cookie, update it.
20173 - If the cursor is in a headline, prompt for tags and insert them
20174 into the current line, aligned to `org-tags-column'. When called
20175 with prefix arg, realign all tags in the current buffer.
20177 - If the cursor is in one of the special #+KEYWORD lines, this
20178 triggers scanning the buffer for these lines and updating the
20179 information.
20181 - If the cursor is inside a table, realign the table. This command
20182 works even if the automatic table editor has been turned off.
20184 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20185 the entire table.
20187 - If the cursor is at a footnote reference or definition, jump to
20188 the corresponding definition or references, respectively.
20190 - If the cursor is a the beginning of a dynamic block, update it.
20192 - If the current buffer is a capture buffer, close note and file it.
20194 - If the cursor is on a <<<target>>>, update radio targets and
20195 corresponding links in this buffer.
20197 - If the cursor is on a numbered item in a plain list, renumber the
20198 ordered list.
20200 - If the cursor is on a checkbox, toggle it.
20202 - If the cursor is on a code block, evaluate it. The variable
20203 `org-confirm-babel-evaluate' can be used to control prompting
20204 before code block evaluation, by default every code block
20205 evaluation requires confirmation. Code block evaluation can be
20206 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20207 (interactive "P")
20208 (cond
20209 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20210 org-occur-highlights
20211 org-latex-fragment-image-overlays)
20212 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20213 (org-remove-occur-highlights)
20214 (org-remove-latex-fragment-image-overlays)
20215 (message "Temporary highlights/overlays removed from current buffer"))
20216 ((and (local-variable-p 'org-finish-function (current-buffer))
20217 (fboundp org-finish-function))
20218 (funcall org-finish-function))
20219 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20220 (t
20221 (let* ((context (org-element-context)) (type (org-element-type context)))
20222 ;; Test if point is within a blank line.
20224 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20225 (user-error "C-c C-c can do nothing useful at this location"))
20226 ;; When at a link, act according to the parent instead.
20227 (when (eq type 'link)
20228 (setq context (org-element-property :parent context))
20229 (setq type (org-element-type context)))
20230 ;; For convenience: at the first line of a paragraph on the
20231 ;; same line as an item, apply function on that item instead.
20232 (when (eq type 'paragraph)
20233 (let ((parent (org-element-property :parent context)))
20234 (when (and (eq (org-element-type parent) 'item)
20235 (= (point-at-bol) (org-element-property :begin parent)))
20236 (setq context parent type 'item))))
20237 ;; Act according to type of element or object at point.
20238 (case type
20239 (clock (org-clock-update-time-maybe))
20240 (dynamic-block
20241 (save-excursion
20242 (goto-char (org-element-property :post-affiliated context))
20243 (org-update-dblock)))
20244 (footnote-definition
20245 (goto-char (org-element-property :post-affiliated context))
20246 (call-interactively 'org-footnote-action))
20247 (footnote-reference (call-interactively 'org-footnote-action))
20248 ((headline inlinetask)
20249 (save-excursion (goto-char (org-element-property :begin context))
20250 (call-interactively 'org-set-tags)))
20251 (item
20252 ;; At an item: a double C-u set checkbox to "[-]"
20253 ;; unconditionally, whereas a single one will toggle its
20254 ;; presence. Without an universal argument, if the item
20255 ;; has a checkbox, toggle it. Otherwise repair the list.
20256 (let* ((box (org-element-property :checkbox context))
20257 (struct (org-element-property :structure context))
20258 (old-struct (copy-tree struct))
20259 (parents (org-list-parents-alist struct))
20260 (prevs (org-list-prevs-alist struct))
20261 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20262 (org-list-set-checkbox
20263 (org-element-property :begin context) struct
20264 (cond ((equal arg '(16)) "[-]")
20265 ((and (not box) (equal arg '(4))) "[ ]")
20266 ((or (not box) (equal arg '(4))) nil)
20267 ((eq box 'on) "[ ]")
20268 (t "[X]")))
20269 ;; Mimic `org-list-write-struct' but with grabbing
20270 ;; a return value from `org-list-struct-fix-box'.
20271 (org-list-struct-fix-ind struct parents 2)
20272 (org-list-struct-fix-item-end struct)
20273 (org-list-struct-fix-bul struct prevs)
20274 (org-list-struct-fix-ind struct parents)
20275 (let ((block-item
20276 (org-list-struct-fix-box struct parents prevs orderedp)))
20277 (if (and box (equal struct old-struct))
20278 (if (equal arg '(16))
20279 (message "Checkboxes already reset")
20280 (user-error "Cannot toggle this checkbox: %s"
20281 (if (eq box 'on)
20282 "all subitems checked"
20283 "unchecked subitems")))
20284 (org-list-struct-apply-struct struct old-struct)
20285 (org-update-checkbox-count-maybe))
20286 (when block-item
20287 (message "Checkboxes were removed due to empty box at line %d"
20288 (org-current-line block-item))))))
20289 (keyword
20290 (let ((org-inhibit-startup-visibility-stuff t)
20291 (org-startup-align-all-tables nil))
20292 (when (boundp 'org-table-coordinate-overlays)
20293 (mapc 'delete-overlay org-table-coordinate-overlays)
20294 (setq org-table-coordinate-overlays nil))
20295 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20296 (message "Local setup has been refreshed"))
20297 (plain-list
20298 ;; At a plain list, with a double C-u argument, set
20299 ;; checkboxes of each item to "[-]", whereas a single one
20300 ;; will toggle their presence according to the state of the
20301 ;; first item in the list. Without an argument, repair the
20302 ;; list.
20303 (let* ((begin (org-element-property :contents-begin context))
20304 (beginm (move-marker (make-marker) begin))
20305 (struct (org-element-property :structure context))
20306 (old-struct (copy-tree struct))
20307 (first-box (save-excursion
20308 (goto-char begin)
20309 (looking-at org-list-full-item-re)
20310 (match-string-no-properties 3)))
20311 (new-box (cond ((equal arg '(16)) "[-]")
20312 ((equal arg '(4)) (unless first-box "[ ]"))
20313 ((equal first-box "[X]") "[ ]")
20314 (t "[X]"))))
20315 (cond
20316 (arg
20317 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20318 (org-list-get-all-items
20319 begin struct (org-list-prevs-alist struct))))
20320 ((and first-box (eq (point) begin))
20321 ;; For convenience, when point is at bol on the first
20322 ;; item of the list and no argument is provided, simply
20323 ;; toggle checkbox of that item, if any.
20324 (org-list-set-checkbox begin struct new-box)))
20325 (org-list-write-struct
20326 struct (org-list-parents-alist struct) old-struct)
20327 (org-update-checkbox-count-maybe)
20328 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20329 ((property-drawer node-property)
20330 (call-interactively 'org-property-action))
20331 ((radio-target target)
20332 (call-interactively 'org-update-radio-target-regexp))
20333 (statistics-cookie
20334 (call-interactively 'org-update-statistics-cookies))
20335 ((table table-cell table-row)
20336 ;; At a table, recalculate every field and align it. Also
20337 ;; send the table if necessary. If the table has
20338 ;; a `table.el' type, just give up. At a table row or
20339 ;; cell, maybe recalculate line but always align table.
20340 (if (eq (org-element-property :type context) 'table.el)
20341 (message "Use C-c ' to edit table.el tables")
20342 (let ((org-enable-table-editor t))
20343 (if (or (eq type 'table)
20344 ;; Check if point is at a TBLFM line.
20345 (and (eq type 'table-row)
20346 (= (point) (org-element-property :end context))))
20347 (save-excursion
20348 (if (org-at-TBLFM-p)
20349 (progn (require 'org-table)
20350 (org-table-calc-current-TBLFM))
20351 (goto-char (org-element-property :contents-begin context))
20352 (org-call-with-arg 'org-table-recalculate (or arg t))
20353 (orgtbl-send-table 'maybe)))
20354 (org-table-maybe-eval-formula)
20355 (cond (arg (call-interactively 'org-table-recalculate))
20356 ((org-table-maybe-recalculate-line))
20357 (t (org-table-align)))))))
20358 (timestamp (org-timestamp-change 0 'day))
20359 (otherwise
20360 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20361 (user-error
20362 "C-c C-c can do nothing useful at this location")))))))))
20364 (defun org-mode-restart ()
20365 "Restart Org-mode, to scan again for special lines.
20366 Also updates the keyword regular expressions."
20367 (interactive)
20368 (org-mode)
20369 (message "Org-mode restarted"))
20371 (defun org-kill-note-or-show-branches ()
20372 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20373 (interactive)
20374 (if (not org-finish-function)
20375 (progn
20376 (hide-subtree)
20377 (call-interactively 'show-branches))
20378 (let ((org-note-abort t))
20379 (funcall org-finish-function))))
20381 (defun org-open-line (n)
20382 "Insert a new row in tables, call `open-line' elsewhere.
20383 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20384 (interactive "*p")
20385 (cond
20386 ((not org-special-ctrl-o)
20387 (open-line n))
20388 ((org-at-table-p)
20389 (org-table-insert-row))
20390 (t
20391 (open-line n))))
20393 (defun org-return (&optional indent)
20394 "Goto next table row or insert a newline.
20395 Calls `org-table-next-row' or `newline', depending on context.
20396 See the individual commands for more information."
20397 (interactive)
20398 (let (org-ts-what)
20399 (cond
20400 ((or (bobp) (org-in-src-block-p))
20401 (if indent (newline-and-indent) (newline)))
20402 ((org-at-table-p)
20403 (org-table-justify-field-maybe)
20404 (call-interactively 'org-table-next-row))
20405 ;; when `newline-and-indent' is called within a list, make sure
20406 ;; text moved stays inside the item.
20407 ((and (org-in-item-p) indent)
20408 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20409 (progn
20410 (save-match-data (newline))
20411 (org-indent-line-to (length (match-string 0))))
20412 (let ((ind (org-get-indentation)))
20413 (newline)
20414 (if (org-looking-back org-list-end-re)
20415 (org-indent-line)
20416 (org-indent-line-to ind)))))
20417 ((and org-return-follows-link
20418 (org-at-timestamp-p t)
20419 (not (eq org-ts-what 'after)))
20420 (org-follow-timestamp-link))
20421 ((and org-return-follows-link
20422 (let ((tprop (get-text-property (point) 'face)))
20423 (or (eq tprop 'org-link)
20424 (and (listp tprop) (memq 'org-link tprop)))))
20425 (call-interactively 'org-open-at-point))
20426 ((and (org-at-heading-p)
20427 (looking-at
20429 (org-show-entry)
20430 (end-of-line 1)
20431 (newline))
20432 (t (if indent (newline-and-indent) (newline))))))
20434 (defun org-return-indent ()
20435 "Goto next table row or insert a newline and indent.
20436 Calls `org-table-next-row' or `newline-and-indent', depending on
20437 context. See the individual commands for more information."
20438 (interactive)
20439 (org-return t))
20441 (defun org-ctrl-c-star ()
20442 "Compute table, or change heading status of lines.
20443 Calls `org-table-recalculate' or `org-toggle-heading',
20444 depending on context."
20445 (interactive)
20446 (cond
20447 ((org-at-table-p)
20448 (call-interactively 'org-table-recalculate))
20449 (t
20450 ;; Convert all lines in region to list items
20451 (call-interactively 'org-toggle-heading))))
20453 (defun org-ctrl-c-minus ()
20454 "Insert separator line in table or modify bullet status of line.
20455 Also turns a plain line or a region of lines into list items.
20456 Calls `org-table-insert-hline', `org-toggle-item', or
20457 `org-cycle-list-bullet', depending on context."
20458 (interactive)
20459 (cond
20460 ((org-at-table-p)
20461 (call-interactively 'org-table-insert-hline))
20462 ((org-region-active-p)
20463 (call-interactively 'org-toggle-item))
20464 ((org-in-item-p)
20465 (call-interactively 'org-cycle-list-bullet))
20466 (t
20467 (call-interactively 'org-toggle-item))))
20469 (defun org-toggle-item (arg)
20470 "Convert headings or normal lines to items, items to normal lines.
20471 If there is no active region, only the current line is considered.
20473 If the first non blank line in the region is a headline, convert
20474 all headlines to items, shifting text accordingly.
20476 If it is an item, convert all items to normal lines.
20478 If it is normal text, change region into a list of items.
20479 With a prefix argument ARG, change the region in a single item."
20480 (interactive "P")
20481 (let ((shift-text
20482 (function
20483 ;; Shift text in current section to IND, from point to END.
20484 ;; The function leaves point to END line.
20485 (lambda (ind end)
20486 (let ((min-i 1000) (end (copy-marker end)))
20487 ;; First determine the minimum indentation (MIN-I) of
20488 ;; the text.
20489 (save-excursion
20490 (catch 'exit
20491 (while (< (point) end)
20492 (let ((i (org-get-indentation)))
20493 (cond
20494 ;; Skip blank lines and inline tasks.
20496 ((looking-at org-outline-regexp-bol))
20497 ;; We can't find less than 0 indentation.
20498 ((zerop i) (throw 'exit (setq min-i 0)))
20499 ((< i min-i) (setq min-i i))))
20500 (forward-line))))
20501 ;; Then indent each line so that a line indented to
20502 ;; MIN-I becomes indented to IND. Ignore blank lines
20503 ;; and inline tasks in the process.
20504 (let ((delta (- ind min-i)))
20505 (while (< (point) end)
20507 (looking-at org-outline-regexp-bol))
20508 (org-indent-line-to (+ (org-get-indentation) delta)))
20509 (forward-line)))))))
20510 (skip-blanks
20511 (function
20512 ;; Return beginning of first non-blank line, starting from
20513 ;; line at POS.
20514 (lambda (pos)
20515 (save-excursion
20516 (goto-char pos)
20518 (point-at-bol)))))
20519 beg end)
20520 ;; Determine boundaries of changes.
20521 (if (org-region-active-p)
20522 (setq beg (funcall skip-blanks (region-beginning))
20523 end (copy-marker (region-end)))
20524 (setq beg (funcall skip-blanks (point-at-bol))
20525 end (copy-marker (point-at-eol))))
20526 ;; Depending on the starting line, choose an action on the text
20527 ;; between BEG and END.
20528 (org-with-limited-levels
20529 (save-excursion
20530 (goto-char beg)
20531 (cond
20532 ;; Case 1. Start at an item: de-itemize. Note that it only
20533 ;; happens when a region is active: `org-ctrl-c-minus'
20534 ;; would call `org-cycle-list-bullet' otherwise.
20535 ((org-at-item-p)
20536 (while (< (point) end)
20537 (when (org-at-item-p)
20539 (delete-region (point) (match-end 0)))
20540 (forward-line)))
20541 ;; Case 2. Start at an heading: convert to items.
20542 ((org-at-heading-p)
20543 (let* ((bul (org-list-bullet-string "-"))
20544 (bul-len (length bul))
20545 ;; Indentation of the first heading. It should be
20546 ;; relative to the indentation of its parent, if any.
20547 (start-ind (save-excursion
20548 (cond
20549 ((not org-adapt-indentation) 0)
20550 ((not (outline-previous-heading)) 0)
20551 (t (length (match-string 0))))))
20552 ;; Level of first heading. Further headings will be
20553 ;; compared to it to determine hierarchy in the list.
20554 (ref-level (org-reduced-level (org-outline-level))))
20555 (while (< (point) end)
20556 (let* ((level (org-reduced-level (org-outline-level)))
20557 (delta (max 0 (- level ref-level))))
20558 ;; If current headline is less indented than the first
20559 ;; one, set it as reference, in order to preserve
20560 ;; subtrees.
20561 (when (< level ref-level) (setq ref-level level))
20562 (replace-match bul t t)
20563 (org-indent-line-to (+ start-ind (* delta bul-len)))
20564 ;; Ensure all text down to END (or SECTION-END) belongs
20565 ;; to the newly created item.
20566 (let ((section-end (save-excursion
20567 (or (outline-next-heading) (point)))))
20568 (forward-line)
20569 (funcall shift-text
20570 (+ start-ind (* (1+ delta) bul-len))
20571 (min end section-end)))))))
20572 ;; Case 3. Normal line with ARG: make the first line of region
20573 ;; an item, and shift indentation of others lines to
20574 ;; set them as item's body.
20575 (arg (let* ((bul (org-list-bullet-string "-"))
20576 (bul-len (length bul))
20577 (ref-ind (org-get-indentation)))
20579 (insert bul)
20580 (forward-line)
20581 (while (< (point) end)
20582 ;; Ensure that lines less indented than first one
20583 ;; still get included in item body.
20584 (funcall shift-text
20585 (+ ref-ind bul-len)
20586 (min end (save-excursion (or (outline-next-heading)
20587 (point)))))
20588 (forward-line))))
20589 ;; Case 4. Normal line without ARG: turn each non-item line
20590 ;; into an item.
20591 (t
20592 (while (< (point) end)
20593 (unless (or (org-at-heading-p) (org-at-item-p))
20595 (replace-match
20597 (forward-line))))))))
20599 (defun org-toggle-heading (&optional nstars)
20600 "Convert headings to normal text, or items or text to headings.
20601 If there is no active region, only convert the current line.
20604 point into heading.
20606 In a region:
20608 - If the first non blank line is a headline, remove the stars
20609 from all headlines in the region.
20611 - If it is a normal line, turn each and every normal line (i.e.,
20612 not an heading or an item) in the region into headings. If you
20613 want to convert only the first line of this region, use one
20614 universal prefix argument.
20616 - If it is a plain list item, turn all plain list items into headings.
20618 When converting a line into a heading, the number of stars is chosen
20619 such that the lines become children of the current entry. However,
20620 when a numeric prefix argument is given, its value determines the
20621 number of stars to add."
20622 (interactive "P")
20623 (let ((skip-blanks
20624 (function
20625 ;; Return beginning of first non-blank line, starting from
20626 ;; line at POS.
20627 (lambda (pos)
20628 (save-excursion
20629 (goto-char pos)
20630 (while (org-at-comment-p) (forward-line))
20632 (point-at-bol)))))
20633 beg end toggled)
20634 ;; Determine boundaries of changes. If a universal prefix has
20635 ;; been given, put the list in a region. If region ends at a bol,
20636 ;; do not consider the last line to be in the region.
20638 (when (and current-prefix-arg (org-at-item-p))
20639 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20640 (org-mark-element))
20642 (if (org-region-active-p)
20643 (setq beg (funcall skip-blanks (region-beginning))
20644 end (copy-marker (save-excursion
20645 (goto-char (region-end))
20646 (if (bolp) (point) (point-at-eol)))))
20647 (setq beg (funcall skip-blanks (point-at-bol))
20648 end (copy-marker (point-at-eol))))
20649 ;; Ensure inline tasks don't count as headings.
20650 (org-with-limited-levels
20651 (save-excursion
20652 (goto-char beg)
20653 (cond
20654 ;; Case 1. Started at an heading: de-star headings.
20655 ((org-at-heading-p)
20656 (while (< (point) end)
20657 (when (org-at-heading-p t)
20658 (looking-at org-outline-regexp) (replace-match "")
20659 (setq toggled t))
20660 (forward-line)))
20661 ;; Case 2. Started at an item: change items into headlines.
20662 ;; One star will be added by `org-list-to-subtree'.
20663 ((org-at-item-p)
20664 (let* ((stars (make-string
20665 ;; subtract the star that will be added again by
20666 ;; `org-list-to-subtree'
20667 (if (numberp nstars) (1- nstars)
20668 (or (org-current-level) 0))
20669 ?*))
20670 (add-stars
20671 (cond (nstars "") ; stars from prefix only
20672 ((equal stars "") "") ; before first heading
20673 (org-odd-levels-only "*") ; inside heading, odd
20674 (t "")))) ; inside heading, oddeven
20675 (while (< (point) end)
20676 (when (org-at-item-p)
20677 ;; Pay attention to cases when region ends before list.
20678 (let* ((struct (org-list-struct))
20679 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20680 (save-restriction
20681 (narrow-to-region (point) list-end)
20682 (insert
20683 (org-list-to-subtree
20684 (org-list-parse-list t)
20685 '(:istart (concat stars add-stars (funcall get-stars depth))
20686 :icount (concat stars add-stars (funcall get-stars depth)))))))
20687 (setq toggled t))
20688 (forward-line))))
20689 ;; Case 3. Started at normal text: make every line an heading,
20690 ;; skipping headlines and items.
20691 (t (let* ((stars
20692 (make-string
20693 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20694 (add-stars
20695 (cond (nstars "") ; stars from prefix only
20696 ((equal stars "") "*") ; before first heading
20697 (org-odd-levels-only "**") ; inside heading, odd
20698 (t "*"))) ; inside heading, oddeven
20699 (rpl (concat stars add-stars " "))
20700 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20701 (while (< (point) (if (equal nstars '(4)) lend end))
20702 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20704 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20705 (forward-line)))))))
20706 (unless toggled (message "Cannot toggle heading from here"))))
20708 (defun org-meta-return (&optional arg)
20709 "Insert a new heading or wrap a region in a table.
20710 Calls `org-insert-heading' or `org-table-wrap-region', depending
20711 on context. See the individual commands for more information."
20712 (interactive "P")
20713 (org-check-before-invisible-edit 'insert)
20714 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20715 (let* ((element (org-element-at-point))
20716 (type (org-element-type element)))
20717 (when (eq type 'table-row)
20718 (setq element (org-element-property :parent element))
20719 (setq type 'table))
20720 (if (and (eq type 'table)
20721 (eq (org-element-property :type element) 'org)
20722 (>= (point) (org-element-property :contents-begin element))
20723 (< (point) (org-element-property :contents-end element)))
20724 (call-interactively 'org-table-wrap-region)
20725 (call-interactively 'org-insert-heading)))))
20727 ;;; Menu entries
20729 (defsubst org-in-subtree-not-table-p ()
20730 "Are we in a subtree and not in a table?"
20731 (and (not (org-before-first-heading-p))
20732 (not (org-at-table-p))))
20734 ;; Define the Org-mode menus
20735 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20736 '("Tbl"
20737 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20738 ["Next Field" org-cycle (org-at-table-p)]
20739 ["Previous Field" org-shifttab (org-at-table-p)]
20740 ["Next Row" org-return (org-at-table-p)]
20741 "--"
20742 ["Blank Field" org-table-blank-field (org-at-table-p)]
20743 ["Edit Field" org-table-edit-field (org-at-table-p)]
20744 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20745 "--"
20746 ("Column"
20747 ["Move Column Left" org-metaleft (org-at-table-p)]
20748 ["Move Column Right" org-metaright (org-at-table-p)]
20749 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20750 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20751 ("Row"
20752 ["Move Row Up" org-metaup (org-at-table-p)]
20753 ["Move Row Down" org-metadown (org-at-table-p)]
20754 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20755 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20756 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20757 "--"
20758 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20759 ("Rectangle"
20760 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20761 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20762 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20763 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20764 "--"
20765 ("Calculate"
20766 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20767 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20768 ["Edit Formulas" org-edit-special (org-at-table-p)]
20769 "--"
20770 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20771 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20772 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20773 "--"
20774 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20775 "--"
20776 ["Sum Column/Rectangle" org-table-sum
20777 (or (org-at-table-p) (org-region-active-p))]
20778 ["Which Column?" org-table-current-column (org-at-table-p)])
20779 ["Debug Formulas"
20780 org-table-toggle-formula-debugger
20781 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20782 ["Show Col/Row Numbers"
20783 org-table-toggle-coordinate-overlays
20784 :style toggle
20785 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20786 "--"
20787 ["Create" org-table-create (and (not (org-at-table-p))
20788 org-enable-table-editor)]
20789 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20790 ["Import from File" org-table-import (not (org-at-table-p))]
20791 ["Export to File" org-table-export (org-at-table-p)]
20792 "--"
20793 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20795 (easy-menu-define org-org-menu org-mode-map "Org menu"
20796 '("Org"
20797 ("Show/Hide"
20798 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20799 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20800 ["Sparse Tree..." org-sparse-tree t]
20801 ["Reveal Context" org-reveal t]
20802 ["Show All" show-all t]
20803 "--"
20804 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20805 "--"
20806 ["New Heading" org-insert-heading t]
20807 ("Navigate Headings"
20808 ["Up" outline-up-heading t]
20809 ["Next" outline-next-visible-heading t]
20810 ["Previous" outline-previous-visible-heading t]
20811 ["Next Same Level" outline-forward-same-level t]
20812 ["Previous Same Level" outline-backward-same-level t]
20813 "--"
20814 ["Jump" org-goto t])
20815 ("Edit Structure"
20816 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20817 "--"
20818 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20819 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20820 "--"
20821 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20822 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20823 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20824 "--"
20825 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20826 "--"
20827 ["Copy visible text" org-copy-visible t]
20828 "--"
20829 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20830 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20831 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20832 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20833 "--"
20834 ["Sort Region/Children" org-sort t]
20835 "--"
20836 ["Convert to odd levels" org-convert-to-odd-levels t]
20837 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20838 ("Editing"
20839 ["Emphasis..." org-emphasize t]
20840 ["Edit Source Example" org-edit-special t]
20841 "--"
20842 ["Footnote new/jump" org-footnote-action t]
20843 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20844 ("Archive"
20845 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20846 "--"
20847 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20848 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20849 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20850 )
20851 "--"
20852 ("Hyperlinks"
20853 ["Store Link (Global)" org-store-link t]
20854 ["Find existing link to here" org-occur-link-in-agenda-files t]
20855 ["Insert Link" org-insert-link t]
20856 ["Follow Link" org-open-at-point t]
20857 "--"
20858 ["Next link" org-next-link t]
20859 ["Previous link" org-previous-link t]
20860 "--"
20861 ["Descriptive Links"
20862 org-toggle-link-display
20863 :style radio
20864 :selected org-descriptive-links
20865 ]
20866 ["Literal Links"
20867 org-toggle-link-display
20868 :style radio
20869 :selected (not org-descriptive-links)])
20870 "--"
20871 ("TODO Lists"
20872 ["TODO/DONE/-" org-todo t]
20873 ("Select keyword"
20874 ["Next keyword" org-shiftright (org-at-heading-p)]
20875 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20876 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20877 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20878 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20879 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20880 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20881 "--"
20882 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20883 :selected org-enforce-todo-dependencies :style toggle :active t]
20884 "Settings for tree at point"
20885 ["Do Children sequentially" org-toggle-ordered-property :style radio
20886 :selected (org-entry-get nil "ORDERED")
20887 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20888 ["Do Children parallel" org-toggle-ordered-property :style radio
20889 :selected (not (org-entry-get nil "ORDERED"))
20890 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20891 "--"
20892 ["Set Priority" org-priority t]
20893 ["Priority Up" org-shiftup t]
20894 ["Priority Down" org-shiftdown t]
20895 "--"
20896 ["Get news from all feeds" org-feed-update-all t]
20897 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20898 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20899 ("TAGS and Properties"
20900 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20901 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20902 "--"
20903 ["Set property" org-set-property (not (org-before-first-heading-p))]
20904 ["Column view of properties" org-columns t]
20905 ["Insert Column View DBlock" org-insert-columns-dblock t])
20906 ("Dates and Scheduling"
20907 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20908 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20909 ("Change Date"
20910 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20911 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20912 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20913 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20914 ["Compute Time Range" org-evaluate-time-range t]
20915 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20916 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20917 "--"
20918 ["Custom time format" org-toggle-time-stamp-overlays
20919 :style radio :selected org-display-custom-times]
20920 "--"
20921 ["Goto Calendar" org-goto-calendar t]
20922 ["Date from Calendar" org-date-from-calendar t]
20923 "--"
20924 ["Start/Restart Timer" org-timer-start t]
20925 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20926 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20927 ["Insert Timer String" org-timer t]
20928 ["Insert Timer Item" org-timer-item t])
20929 ("Logging work"
20930 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20931 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20932 ["Clock out" org-clock-out t]
20933 ["Clock cancel" org-clock-cancel t]
20934 "--"
20935 ["Mark as default task" org-clock-mark-default-task t]
20936 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20937 ["Goto running clock" org-clock-goto t]
20938 "--"
20939 ["Display times" org-clock-display t]
20940 ["Create clock table" org-clock-report t]
20941 "--"
20942 ["Record DONE time"
20943 (progn (setq org-log-done (not org-log-done))
20944 (message "Switching to %s will %s record a timestamp"
20945 (car org-done-keywords)
20946 (if org-log-done "automatically" "not")))
20947 :style toggle :selected org-log-done])
20948 "--"
20949 ["Agenda Command..." org-agenda t]
20950 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20951 ("File List for Agenda")
20952 ("Special views current file"
20953 ["TODO Tree" org-show-todo-tree t]
20954 ["Check Deadlines" org-check-deadlines t]
20955 ["Timeline" org-timeline t]
20956 ["Tags/Property tree" org-match-sparse-tree t])
20957 "--"
20958 ["Export/Publish..." org-export-dispatch t]
20959 ("LaTeX"
20960 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20961 :selected org-cdlatex-mode]
20962 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20963 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20964 ["Modify math symbol" org-cdlatex-math-modify
20965 (org-inside-LaTeX-fragment-p)]
20966 ["Insert citation" org-reftex-citation t]
20967 "--"
20968 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20969 "--"
20970 ("MobileOrg"
20971 ["Push Files and Views" org-mobile-push t]
20972 ["Get Captured and Flagged" org-mobile-pull t]
20973 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20974 "--"
20975 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20976 "--"
20977 ("Documentation"
20978 ["Show Version" org-version t]
20979 ["Info Documentation" org-info t])
20980 ("Customize"
20981 ["Browse Org Group" org-customize t]
20982 "--"
20983 ["Expand This Menu" org-create-customize-menu
20984 (fboundp 'customize-menu-create)])
20985 ["Send bug report" org-submit-bug-report t]
20986 "--"
20987 ("Refresh/Reload"
20988 ["Refresh setup current buffer" org-mode-restart t]
20989 ["Reload Org (after update)" org-reload t]
20990 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20991 ))
20993 (defun org-info (&optional node)
20994 "Read documentation for Org-mode in the info system.
20995 With optional NODE, go directly to that node."
20996 (interactive)
20997 (info (format "(org)%s" (or node ""))))
20999 ;;;###autoload
21000 (defun org-submit-bug-report ()
21001 "Submit a bug report on Org-mode via mail.
21003 Don't hesitate to report any problems or inaccurate documentation.
21005 If you don't have setup sending mail from (X)Emacs, please copy the
21006 output buffer into your mail program, as it gives us important
21007 information about your Org-mode version and configuration."
21008 (interactive)
21009 (require 'reporter)
21010 (org-load-modules-maybe)
21011 (org-require-autoloaded-modules)
21012 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21013 (reporter-submit-bug-report
21014 "emacs-orgmode@gnu.org"
21015 (org-version nil 'full)
21016 (let (list)
21017 (save-window-excursion
21018 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21019 (delete-other-windows)
21020 (erase-buffer)
21021 (insert "You are about to submit a bug report to the Org-mode mailing list.
21023 We would like to add your full Org-mode and Outline configuration to the
21024 bug report. This greatly simplifies the work of the maintainer and
21025 other experts on the mailing list.
21027 HOWEVER, some variables you have customized may contain private
21028 information. The names of customers, colleagues, or friends, might
21029 appear in the form of file names, tags, todo states, or search strings.
21030 If you answer yes to the prompt, you might want to check and remove
21031 such private information before sending the email.")
21032 (add-text-properties (point-min) (point-max) '(face org-warning))
21033 (when (yes-or-no-p "Include your Org-mode configuration ")
21034 (mapatoms
21035 (lambda (v)
21036 (and (boundp v)
21038 (or (and (symbol-value v)
21040 (and
21041 (get v 'custom-type) (get v 'standard-value)
21042 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21043 (push v list)))))
21044 (kill-buffer (get-buffer "*Warn about privacy*"))
21045 list))
21046 nil nil
21047 "Remember to cover the basics, that is, what you expected to happen and
21048 what in fact did happen. You don't know how to make a good report? See
21050 http://orgmode.org/manual/Feedback.html#Feedback
21052 Your bug report will be posted to the Org-mode mailing list.
21053 ------------------------------------------------------------------------")
21054 (save-excursion
21059 (defun org-install-agenda-files-menu ()
21060 (let ((bl (buffer-list)))
21061 (save-excursion
21062 (while bl
21063 (set-buffer (pop bl))
21064 (if (derived-mode-p 'org-mode) (setq bl nil)))
21065 (when (derived-mode-p 'org-mode)
21066 (easy-menu-change
21067 '("Org") "File List for Agenda"
21068 (append
21069 (list
21070 ["Edit File List" (org-edit-agenda-file-list) t]
21071 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21072 ["Remove Current File from List" org-remove-file t]
21073 ["Cycle through agenda files" org-cycle-agenda-files t]
21074 ["Occur in all agenda files" org-occur-in-agenda-files t]
21075 "--")
21076 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21078 ;;;; Documentation
21080 (defun org-require-autoloaded-modules ()
21081 (interactive)
21082 (mapc 'require
21083 '(org-agenda org-archive org-attach org-clock org-colview org-id
21084 org-remember org-table org-timer)))
21086 ;;;###autoload
21087 (defun org-reload (&optional uncompiled)
21088 "Reload all org lisp files.
21089 With prefix arg UNCOMPILED, load the uncompiled versions."
21090 (interactive "P")
21091 (require 'loadhist)
21092 (let* ((org-dir (org-find-library-dir "org"))
21093 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21095 (remove-re (mapconcat 'identity
21096 (mapcar (lambda (f) (concat "^" f "$"))
21097 (list (if (featurep 'xemacs)
21098 "org-colview"
21099 "org-colview-xemacs")
21100 "org" "org-loaddefs" "org-version"))
21102 (feats (delete-dups
21103 (mapcar 'file-name-sans-extension
21104 (mapcar 'file-name-nondirectory
21105 (delq nil
21106 (mapcar 'feature-file
21107 features))))))
21108 (lfeat (append
21109 (sort
21110 (setq feats
21111 (delq nil (mapcar
21112 (lambda (f)
21113 (if (and (string-match feature-re f)
21114 (not (string-match remove-re f)))
21115 f nil))
21116 feats)))
21117 'string-lessp)
21118 (list "org-version" "org")))
21119 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21120 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21121 load-uncore load-misses)
21122 (setq load-misses
21123 (delq 't
21124 (mapcar (lambda (f)
21125 (or (org-load-noerror-mustsuffix (concat org-dir f))
21126 (and (string= org-dir contrib-dir)
21127 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21128 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21129 (add-to-list 'load-uncore f 'append)
21130 't)
21131 f))
21132 lfeat)))
21133 (if load-uncore
21135 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21136 (if load-misses
21138 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21141 ;;;###autoload
21142 (defun org-customize ()
21143 "Call the customize function with org as argument."
21144 (interactive)
21145 (org-load-modules-maybe)
21146 (org-require-autoloaded-modules)
21147 (customize-browse 'org))
21149 (defun org-create-customize-menu ()
21150 "Create a full customization menu for Org-mode, insert it into the menu."
21151 (interactive)
21152 (org-load-modules-maybe)
21153 (org-require-autoloaded-modules)
21154 (if (fboundp 'customize-menu-create)
21155 (progn
21156 (easy-menu-change
21157 '("Org") "Customize"
21158 `(["Browse Org group" org-customize t]
21159 "--"
21160 ,(customize-menu-create 'org)
21161 ["Set" Custom-set t]
21162 ["Save" Custom-save t]
21163 ["Reset to Current" Custom-reset-current t]
21164 ["Reset to Saved" Custom-reset-saved t]
21165 ["Reset to Standard Settings" Custom-reset-standard t]))
21167 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21169 ;;;; Miscellaneous stuff
21171 ;;; Generally useful functions
21173 (defun org-get-at-bol (property)
21174 "Get text property PROPERTY at beginning of line."
21175 (get-text-property (point-at-bol) property))
21177 (defun org-find-text-property-in-string (prop s)
21178 "Return the first non-nil value of property PROP in string S."
21179 (or (get-text-property 0 prop s)
21180 (get-text-property (or (next-single-property-change 0 prop s) 0)
21181 prop s)))
21183 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21184 "Display the given MESSAGE as a warning."
21185 (if (fboundp 'display-warning)
21186 (display-warning 'org message
21187 (if (featurep 'xemacs) 'warning :warning))
21188 (let ((buf (get-buffer-create "*Org warnings*")))
21189 (with-current-buffer buf
21190 (goto-char (point-max))
21191 (insert "Warning (Org): " message)
21192 (unless (bolp)
21193 (newline)))
21194 (display-buffer buf)
21195 (sit-for 0))))
21197 (defun org-eval (form)
21198 "Eval FORM and return result."
21199 (condition-case error
21200 (eval form)
21201 (error (format "%%![Error: %s]" error))))
21203 (defun org-in-clocktable-p ()
21204 "Check if the cursor is in a clocktable."
21205 (let ((pos (point)) start)
21206 (save-excursion
21207 (end-of-line 1)
21209 (setq start (match-beginning 0))
21211 (>= (match-end 0) pos)
21212 start))))
21214 (defun org-in-commented-line ()
21215 "Is point in a line starting with `#'?"
21216 (equal (char-after (point-at-bol)) ?#))
21218 (defun org-in-indented-comment-line ()
21219 "Is point in a line starting with `#' after some white space?"
21220 (save-excursion
21221 (save-match-data
21222 (goto-char (point-at-bol))
21225 (defun org-in-verbatim-emphasis ()
21226 (save-match-data
21227 (and (org-in-regexp org-emph-re 2)
21228 (>= (point) (match-beginning 3))
21229 (<= (point) (match-end 4))
21230 (member (match-string 3) '("=" "~")))))
21232 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21233 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21234 (if (and marker (marker-buffer marker)
21235 (buffer-live-p (marker-buffer marker)))
21236 (progn
21237 (org-pop-to-buffer-same-window (marker-buffer marker))
21238 (if (or (> marker (point-max)) (< marker (point-min)))
21239 (widen))
21240 (goto-char marker)
21241 (org-show-context 'org-goto))
21242 (if bookmark
21243 (bookmark-jump bookmark)
21244 (error "Cannot find location"))))
21246 (defun org-quote-csv-field (s)
21247 "Quote field for inclusion in CSV material."
21250 s))
21252 (defun org-force-self-insert (N)
21253 "Needed to enforce self-insert under remapping."
21254 (interactive "p")
21255 (self-insert-command N))
21257 (defun org-string-width (s)
21258 "Compute width of string, ignoring invisible characters.
21259 This ignores character with invisibility property `org-link', and also
21260 characters with property `org-cwidth', because these will become invisible
21261 upon the next fontification round."
21262 (let (b l)
21263 (when (or (eq t buffer-invisibility-spec)
21264 (assq 'org-link buffer-invisibility-spec))
21265 (while (setq b (text-property-any 0 (length s)
21266 'invisible 'org-link s))
21267 (setq s (concat (substring s 0 b)
21268 (substring s (or (next-single-property-change
21269 b 'invisible s) (length s)))))))
21270 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21271 (setq s (concat (substring s 0 b)
21272 (substring s (or (next-single-property-change
21273 b 'org-cwidth s) (length s))))))
21274 (setq l (string-width s) b -1)
21275 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21276 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21277 l))
21279 (defun org-shorten-string (s maxlength)
21280 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21281 If the string is shorter or has length MAXLENGTH, just return the
21282 original string. If it is longer, the functions finds a space in the
21283 string, breaks this string off at that locations and adds three dots
21284 as ellipsis. Including the ellipsis, the string will not be longer
21285 than MAXLENGTH. If finding a good breaking point in the string does
21286 not work, the string is just chopped off in the middle of a word
21287 if necessary."
21288 (if (<= (length s) maxlength)
21289 s
21290 (let* ((n (max (- maxlength 4) 1))
21292 (if (string-match re s)
21293 (concat (match-string 1 s) "...")
21294 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21296 (defun org-get-indentation (&optional line)
21297 "Get the indentation of the current line, interpreting tabs.
21298 When LINE is given, assume it represents a line and compute its indentation."
21299 (if line
21300 (if (string-match "^ *" (org-remove-tabs line))
21301 (match-end 0))
21302 (save-excursion
21303 (beginning-of-line 1)
21305 (current-column))))
21307 (defun org-get-string-indentation (s)
21308 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21309 (let ((n -1) (i 0) (w tab-width) c)
21310 (catch 'exit
21311 (while (< (setq n (1+ n)) (length s))
21312 (setq c (aref s n))
21313 (cond ((= c ?\ ) (setq i (1+ i)))
21315 (t (throw 'exit t)))))
21316 i))
21318 (defun org-remove-tabs (s &optional width)
21319 "Replace tabulators in S with spaces.
21320 Assumes that s is a single line, starting in column 0."
21321 (setq width (or width tab-width))
21323 (setq s (replace-match
21324 (make-string
21325 (- (* width (/ (+ (match-beginning 0) width) width))
21326 (match-beginning 0)) ?\ )
21327 t t s)))
21328 s)
21330 (defun org-fix-indentation (line ind)
21331 "Fix indentation in LINE.
21332 IND is a cons cell with target and minimum indentation.
21333 If the current indentation in LINE is smaller than the minimum,
21334 leave it alone. If it is larger than ind, set it to the target."
21335 (let* ((l (org-remove-tabs line))
21336 (i (org-get-indentation l))
21337 (i1 (car ind)) (i2 (cdr ind)))
21338 (if (>= i i2) (setq l (substring line i2)))
21339 (if (> i1 0)
21340 (concat (make-string i1 ?\ ) l)
21341 l)))
21343 (defun org-remove-indentation (code &optional n)
21344 "Remove the maximum common indentation from the lines in CODE.
21345 N may optionally be the number of spaces to remove."
21346 (with-temp-buffer
21347 (insert code)
21348 (org-do-remove-indentation n)
21349 (buffer-string)))
21351 (defun org-do-remove-indentation (&optional n)
21352 "Remove the maximum common indentation from the buffer."
21353 (untabify (point-min) (point-max))
21354 (let ((min 10000) re)
21355 (if n
21356 (setq min n)
21357 (goto-char (point-min))
21359 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21360 (unless (or (= min 0) (= min 10000))
21362 (goto-char (point-min))
21363 (while (re-search-forward re nil t)
21364 (replace-match "")
21365 (end-of-line 1))
21366 min)))
21368 (defun org-fill-template (template alist)
21369 "Find each %key of ALIST in TEMPLATE and replace it."
21370 (let ((case-fold-search nil)
21371 entry key value)
21372 (setq alist (sort (copy-sequence alist)
21373 (lambda (a b) (< (length (car a)) (length (car b))))))
21374 (while (setq entry (pop alist))
21375 (setq template
21376 (replace-regexp-in-string
21377 (concat "%" (regexp-quote (car entry)))
21378 (or (cdr entry) "") template t t)))
21379 template))
21381 (defun org-base-buffer (buffer)
21382 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21383 (if (not buffer)
21384 buffer
21385 (or (buffer-base-buffer buffer)
21386 buffer)))
21388 (defun org-trim (s)
21389 "Remove whitespace at beginning and end of string."
21392 s)
21394 (defun org-wrap (string &optional width lines)
21395 "Wrap string to either a number of lines, or a width in characters.
21396 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21397 that costs. If there is a word longer than WIDTH, the text is actually
21398 wrapped to the length of that word.
21399 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21400 many lines, whatever width that takes.
21401 The return value is a list of lines, without newlines at the end."
21403 (maxword (apply 'max (mapcar 'org-string-width words)))
21404 w ll)
21405 (cond (width
21406 (org-do-wrap words (max maxword width)))
21407 (lines
21408 (setq w maxword)
21409 (setq ll (org-do-wrap words maxword))
21410 (if (<= (length ll) lines)
21411 ll
21412 (setq ll words)
21413 (while (> (length ll) lines)
21414 (setq w (1+ w))
21415 (setq ll (org-do-wrap words w)))
21416 ll))
21417 (t (error "Cannot wrap this")))))
21419 (defun org-do-wrap (words width)
21420 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21421 (let (lines line)
21422 (while words
21423 (setq line (pop words))
21424 (while (and words (< (+ (length line) (length (car words))) width))
21425 (setq line (concat line " " (pop words))))
21426 (setq lines (push line lines)))
21427 (nreverse lines)))
21429 (defun org-split-string (string &optional separators)
21430 "Splits STRING into substrings at SEPARATORS.
21431 No empty strings are returned if there are matches at the beginning
21432 and end of string."
21434 (start 0)
21435 notfirst
21436 (list nil))
21437 (while (and (string-match rexp string
21438 (if (and notfirst
21439 (= start (match-beginning 0))
21440 (< start (length string)))
21441 (1+ start) start))
21442 (< (match-beginning 0) (length string)))
21443 (setq notfirst t)
21444 (or (eq (match-beginning 0) 0)
21445 (and (eq (match-beginning 0) (match-end 0))
21446 (eq (match-beginning 0) start))
21447 (setq list
21448 (cons (substring string start (match-beginning 0))
21449 list)))
21450 (setq start (match-end 0)))
21451 (or (eq start (length string))
21452 (setq list
21453 (cons (substring string start)
21454 list)))
21455 (nreverse list)))
21457 (defun org-quote-vert (s)
21459 (while (string-match "|" s)
21461 s)
21463 (defun org-uuidgen-p (s)
21464 "Is S an ID created by UUIDGEN?"
21465 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21467 (defun org-in-src-block-p (&optional inside)
21468 "Whether point is in a code source block.
21469 When INSIDE is non-nil, don't consider we are within a src block
21470 when point is at #+BEGIN_SRC or #+END_SRC."
21471 (let ((case-fold-search t) ov)
21472 (or (and (setq ov (overlays-at (point)))
21473 (memq 'org-block-background
21474 (overlay-properties (car ov))))
21475 (and (not inside)
21476 (save-match-data
21477 (save-excursion
21478 (beginning-of-line)
21481 (defun org-context ()
21482 "Return a list of contexts of the current cursor position.
21483 If several contexts apply, all are returned.
21484 Each context entry is a list with a symbol naming the context, and
21485 two positions indicating start and end of the context. Possible
21486 contexts are:
21488 :headline anywhere in a headline
21489 :headline-stars on the leading stars in a headline
21490 :todo-keyword on a TODO keyword (including DONE) in a headline
21491 :tags on the TAGS in a headline
21492 :priority on the priority cookie in a headline
21493 :item on the first line of a plain list item
21494 :item-bullet on the bullet/number of a plain list item
21495 :checkbox on the checkbox in a plain list item
21496 :table in an org-mode table
21497 :table-special on a special filed in a table
21498 :table-table in a table.el table
21499 :clocktable in a clocktable
21500 :src-block in a source block
21501 :link on a hyperlink
21502 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21503 :target on a <<target>>
21504 :radio-target on a <<<radio-target>>>
21505 :latex-fragment on a LaTeX fragment
21506 :latex-preview on a LaTeX fragment with overlaid preview image
21508 This function expects the position to be visible because it uses font-lock
21509 faces as a help to recognize the following contexts: :table-special, :link,
21510 and :keyword."
21511 (let* ((f (get-text-property (point) 'face))
21512 (faces (if (listp f) f (list f)))
21513 (case-fold-search t)
21514 (p (point)) clist o)
21515 ;; First the large context
21516 (cond
21517 ((org-at-heading-p t)
21518 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21519 (when (progn
21520 (beginning-of-line 1)
21521 (looking-at org-todo-line-tags-regexp))
21522 (push (org-point-in-group p 1 :headline-stars) clist)
21523 (push (org-point-in-group p 2 :todo-keyword) clist)
21524 (push (org-point-in-group p 4 :tags) clist))
21525 (goto-char p)
21528 (push (org-point-in-group p 0 :priority) clist)))
21530 ((org-at-item-p)
21531 (push (org-point-in-group p 2 :item-bullet) clist)
21532 (push (list :item (point-at-bol)
21533 (save-excursion (org-end-of-item) (point)))
21534 clist)
21535 (and (org-at-item-checkbox-p)
21536 (push (org-point-in-group p 0 :checkbox) clist)))
21538 ((org-at-table-p)
21539 (push (list :table (org-table-begin) (org-table-end)) clist)
21540 (if (memq 'org-formula faces)
21541 (push (list :table-special
21542 (previous-single-property-change p 'face)
21543 (next-single-property-change p 'face)) clist)))
21544 ((org-at-table-p 'any)
21545 (push (list :table-table) clist)))
21546 (goto-char p)
21548 (let ((case-fold-search t))
21549 ;; New the "medium" contexts: clocktables, source blocks
21550 (cond ((org-in-clocktable-p)
21551 (push (list :clocktable
21553 (search-backward "#+BEGIN: clocktable" nil t))
21554 (match-beginning 0))
21556 (match-end 0))) clist))
21557 ((org-in-src-block-p)
21558 (push (list :src-block
21560 (search-backward "#+BEGIN_SRC" nil t))
21561 (match-beginning 0))
21562 (and (search-forward "#+END_SRC" nil t)
21563 (match-beginning 0))) clist))))
21564 (goto-char p)
21566 ;; Now the small context
21567 (cond
21568 ((org-at-timestamp-p)
21569 (push (org-point-in-group p 0 :timestamp) clist))
21570 ((memq 'org-link faces)
21571 (push (list :link
21572 (previous-single-property-change p 'face)
21573 (next-single-property-change p 'face)) clist))
21574 ((memq 'org-special-keyword faces)
21575 (push (list :keyword
21576 (previous-single-property-change p 'face)
21577 (next-single-property-change p 'face)) clist))
21578 ((org-at-target-p)
21579 (push (org-point-in-group p 0 :target) clist)
21580 (goto-char (1- (match-beginning 0)))
21581 (if (looking-at org-radio-target-regexp)
21582 (push (org-point-in-group p 0 :radio-target) clist))
21583 (goto-char p))
21584 ((setq o (car (delq nil
21585 (mapcar
21586 (lambda (x)
21587 (if (memq x org-latex-fragment-image-overlays) x))
21588 (overlays-at (point))))))
21589 (push (list :latex-fragment
21590 (overlay-start o) (overlay-end o)) clist)
21591 (push (list :latex-preview
21592 (overlay-start o) (overlay-end o)) clist))
21593 ((org-inside-LaTeX-fragment-p)
21594 ;; FIXME: positions wrong.
21595 (push (list :latex-fragment (point) (point)) clist)))
21597 (setq clist (nreverse (delq nil clist)))
21598 clist))
21600 ;; FIXME: Compare with at-regexp-p Do we need both?
21601 (defun org-in-regexp (re &optional nlines visually)
21602 "Check if point is inside a match of regexp.
21603 Normally only the current line is checked, but you can include NLINES extra
21604 lines both before and after point into the search.
21605 If VISUALLY is set, require that the cursor is not after the match but
21606 really on, so that the block visually is on the match."
21607 (catch 'exit
21608 (let ((pos (point))
21609 (eol (point-at-eol (+ 1 (or nlines 0))))
21610 (inc (if visually 1 0)))
21611 (save-excursion
21612 (beginning-of-line (- 1 (or nlines 0)))
21613 (while (re-search-forward re eol t)
21614 (if (and (<= (match-beginning 0) pos)
21615 (>= (+ inc (match-end 0)) pos))
21616 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21618 (defun org-at-regexp-p (regexp)
21619 "Is point inside a match of REGEXP in the current line?"
21620 (catch 'exit
21621 (save-excursion
21622 (let ((pos (point)) (end (point-at-eol)))
21623 (beginning-of-line 1)
21624 (while (re-search-forward regexp end t)
21625 (if (and (<= (match-beginning 0) pos)
21626 (>= (match-end 0) pos))
21627 (throw 'exit t)))
21628 nil))))
21630 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21631 "Non-nil when point is between matches of START-RE and END-RE.
21633 Also return a non-nil value when point is on one of the matches.
21635 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21636 buffer positions. Default values are the positions of headlines
21637 surrounding the point.
21639 The functions returns a cons cell whose car (resp. cdr) is the
21640 position before START-RE (resp. after END-RE)."
21641 (save-match-data
21642 (let ((pos (point))
21643 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21644 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21645 beg end)
21646 (save-excursion
21647 ;; Point is on a block when on START-RE or if START-RE can be
21648 ;; found before it...
21649 (and (or (org-at-regexp-p start-re)
21650 (re-search-backward start-re limit-up t))
21651 (setq beg (match-beginning 0))
21652 ;; ... and END-RE after it...
21653 (goto-char (match-end 0))
21654 (re-search-forward end-re limit-down t)
21655 (> (setq end (match-end 0)) pos)
21656 ;; ... without another START-RE in-between.
21657 (goto-char (match-beginning 0))
21658 (not (re-search-backward start-re (1+ beg) t))
21659 ;; Return value.
21660 (cons beg end))))))
21662 (defun org-in-block-p (names)
21663 "Non-nil when point belongs to a block whose name belongs to NAMES.
21665 NAMES is a list of strings containing names of blocks.
21667 Return first block name matched, or nil. Beware that in case of
21668 nested blocks, the returned name may not belong to the closest
21669 block from point."
21670 (save-match-data
21671 (catch 'exit
21672 (let ((case-fold-search t)
21673 (lim-up (save-excursion (outline-previous-heading)))
21674 (lim-down (save-excursion (outline-next-heading))))
21675 (mapc (lambda (name)
21676 (let ((n (regexp-quote name)))
21677 (when (org-between-regexps-p
21680 lim-up lim-down)
21681 (throw 'exit n))))
21682 names))
21683 nil)))
21685 (defun org-in-drawer-p ()
21686 "Is point within a drawer?"
21687 (save-match-data
21688 (let ((case-fold-search t)
21689 (lim-up (save-excursion (outline-previous-heading)))
21690 (lim-down (save-excursion (outline-next-heading))))
21691 (org-between-regexps-p
21694 lim-up lim-down))))
21696 (defun org-occur-in-agenda-files (regexp &optional nlines)
21697 "Call `multi-occur' with buffers for all agenda files."
21699 (let* ((files (org-agenda-files))
21700 (tnames (mapcar 'file-truename files))
21701 (extra org-agenda-text-search-extra-files)
21702 f)
21703 (when (eq (car extra) 'agenda-archives)
21704 (setq extra (cdr extra))
21705 (setq files (org-add-archive-files files)))
21706 (while (setq f (pop extra))
21707 (unless (member (file-truename f) tnames)
21708 (add-to-list 'files f 'append)
21709 (add-to-list 'tnames (file-truename f) 'append)))
21710 (multi-occur
21711 (mapcar (lambda (x)
21712 (with-current-buffer
21713 (or (get-file-buffer x) (find-file-noselect x))
21714 (widen)
21715 (current-buffer)))
21716 files)
21717 regexp)))
21719 (if (boundp 'occur-mode-find-occurrence-hook)
21720 ;; Emacs 23
21721 (add-hook 'occur-mode-find-occurrence-hook
21722 (lambda ()
21723 (when (derived-mode-p 'org-mode)
21724 (org-reveal))))
21725 ;; Emacs 22
21726 (defadvice occur-mode-goto-occurrence
21727 (after org-occur-reveal activate)
21728 (and (derived-mode-p 'org-mode) (org-reveal)))
21729 (defadvice occur-mode-goto-occurrence-other-window
21730 (after org-occur-reveal activate)
21731 (and (derived-mode-p 'org-mode) (org-reveal)))
21732 (defadvice occur-mode-display-occurrence
21733 (after org-occur-reveal activate)
21734 (when (derived-mode-p 'org-mode)
21735 (let ((pos (occur-mode-find-occurrence)))
21736 (with-current-buffer (marker-buffer pos)
21737 (save-excursion
21738 (goto-char pos)
21739 (org-reveal)))))))
21741 (defun org-occur-link-in-agenda-files ()
21742 "Create a link and search for it in the agendas.
21743 The link is not stored in `org-stored-links', it is just created
21744 for the search purpose."
21745 (interactive)
21746 (let ((link (condition-case nil
21747 (org-store-link nil)
21748 (error "Unable to create a link to here"))))
21749 (org-occur-in-agenda-files (regexp-quote link))))
21751 (defun org-reverse-string (string)
21752 "Return the reverse of STRING."
21753 (apply 'string (reverse (string-to-list string))))
21755 (defsubst org-uniquify (list)
21756 "Non-destructively remove duplicate elements from LIST."
21757 (let ((res (copy-sequence list))) (delete-dups res)))
21759 (defun org-uniquify-alist (alist)
21760 "Merge elements of ALIST with the same key.
21762 For example, in this alist:
21764 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21765 => '((a 1 3) (b 2))
21767 merge (a 1) and (a 3) into (a 1 3).
21769 The function returns the new ALIST."
21770 (let (rtn)
21771 (mapc
21772 (lambda (e)
21773 (let (n)
21774 (if (not (assoc (car e) rtn))
21775 (push e rtn)
21776 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21777 (setq rtn (assq-delete-all (car e) rtn))
21778 (push n rtn))))
21779 alist)
21780 rtn))
21782 (defun org-delete-all (elts list)
21783 "Remove all elements in ELTS from LIST."
21784 (while elts
21785 (setq list (delete (pop elts) list)))
21786 list)
21788 (defun org-count (cl-item cl-seq)
21789 "Count the number of occurrences of ITEM in SEQ.
21790 Taken from `count' in cl-seq.el with all keyword arguments removed."
21791 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21792 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21793 (while (< cl-start cl-end)
21794 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21795 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21796 (setq cl-start (1+ cl-start)))
21797 cl-count))
21799 (defun org-remove-if (predicate seq)
21800 "Remove everything from SEQ that fulfills PREDICATE."
21801 (let (res e)
21802 (while seq
21803 (setq e (pop seq))
21804 (if (not (funcall predicate e)) (push e res)))
21805 (nreverse res)))
21807 (defun org-remove-if-not (predicate seq)
21808 "Remove everything from SEQ that does not fulfill PREDICATE."
21809 (let (res e)
21810 (while seq
21811 (setq e (pop seq))
21812 (if (funcall predicate e) (push e res)))
21813 (nreverse res)))
21815 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21816 "Reduce two-argument FUNCTION across SEQ.
21817 Taken from `reduce' in cl-seq.el with all keyword arguments but
21819 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21820 (cadr (memq :initial-value cl-keys)))
21821 (cl-seq (pop cl-seq))
21822 (t (funcall cl-func)))))
21823 (while cl-seq
21824 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21825 cl-accum))
21827 (defun org-every (pred seq)
21828 "Return true if PREDICATE is true of every element of SEQ.
21829 Adapted from `every' in cl.el."
21830 (catch 'org-every
21831 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21832 t))
21834 (defun org-some (pred seq)
21835 "Return true if PREDICATE is true of any element of SEQ.
21836 Adapted from `some' in cl.el."
21837 (catch 'org-some
21838 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21839 nil))
21841 (defun org-back-over-empty-lines ()
21842 "Move backwards over whitespace, to the beginning of the first empty line.
21843 Returns the number of empty lines passed."
21844 (let ((pos (point)))
21845 (if (cdr (assoc 'heading org-blank-before-new-entry))
21847 (unless (eobp)
21848 (forward-line -1)))
21849 (beginning-of-line 2)
21850 (goto-char (min (point) pos))
21851 (count-lines (point) pos)))
21853 (defun org-skip-whitespace ()
21856 (defun org-point-in-group (point group &optional context)
21857 "Check if POINT is in match-group GROUP.
21858 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21859 match. If the match group does not exist or point is not inside it,
21860 return nil."
21861 (and (match-beginning group)
21862 (>= point (match-beginning group))
21863 (<= point (match-end group))
21864 (if context
21865 (list context (match-beginning group) (match-end group))
21866 t)))
21868 (defun org-switch-to-buffer-other-window (&rest args)
21869 "Switch to buffer in a second window on the current frame.
21870 In particular, do not allow pop-up frames.
21871 Returns the newly created buffer."
21872 (org-no-popups
21873 (apply 'switch-to-buffer-other-window args)))
21875 (defun org-combine-plists (&rest plists)
21876 "Create a single property list from all plists in PLISTS.
21877 The process starts by copying the first list, and then setting properties
21878 from the other lists. Settings in the last list are the most significant
21879 ones and overrule settings in the other lists."
21880 (let ((rtn (copy-sequence (pop plists)))
21881 p v ls)
21882 (while plists
21883 (setq ls (pop plists))
21884 (while ls
21885 (setq p (pop ls) v (pop ls))
21886 (setq rtn (plist-put rtn p v))))
21887 rtn))
21889 (defun org-replace-escapes (string table)
21890 "Replace %-escapes in STRING with values in TABLE.
21892 The sequences in STRING may contain normal field width and padding information,
21894 so values can contain further %-escapes if they are define later in TABLE."
21895 (let ((tbl (copy-alist table))
21896 (case-fold-search nil)
21897 (pchg 0)
21898 e re rpl)
21899 (while (setq e (pop tbl))
21900 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21901 (when (and (cdr e) (string-match re (cdr e)))
21902 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21903 (safe "SREF"))
21904 (add-text-properties 0 3 (list 'sref sref) safe)
21905 (setcdr e (replace-match safe t t (cdr e)))))
21906 (while (string-match re string)
21907 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21908 (cdr e)))
21909 (setq string (replace-match rpl t t string))))
21910 (while (setq pchg (next-property-change pchg string))
21911 (let ((sref (get-text-property pchg 'sref string)))
21912 (when (and sref (string-match "SREF" string pchg))
21913 (setq string (replace-match sref t t string)))))
21914 string))
21916 (defun org-sublist (list start end)
21917 "Return a section of LIST, from START to END.
21918 Counting starts at 1."
21919 (let (rtn (c start))
21920 (setq list (nthcdr (1- start) list))
21921 (while (and list (<= c end))
21922 (push (pop list) rtn)
21923 (setq c (1+ c)))
21924 (nreverse rtn)))
21926 (defun org-find-base-buffer-visiting (file)
21927 "Like `find-buffer-visiting' but always return the base buffer and
21928 not an indirect buffer."
21929 (let ((buf (or (get-file-buffer file)
21930 (find-buffer-visiting file))))
21931 (if buf
21932 (or (buffer-base-buffer buf) buf)
21933 nil)))
21935 (defun org-image-file-name-regexp (&optional extensions)
21936 "Return regexp matching the file names of images.
21937 If EXTENSIONS is given, only match these."
21938 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21939 (image-file-name-regexp)
21940 (let ((image-file-name-extensions
21941 (or extensions
21942 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21943 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21945 (regexp-opt (nconc (mapcar 'upcase
21946 image-file-name-extensions)
21947 image-file-name-extensions)
21948 t)
21951 (defun org-file-image-p (file &optional extensions)
21952 "Return non-nil if FILE is an image."
21953 (save-match-data
21954 (string-match (org-image-file-name-regexp extensions) file)))
21956 (defun org-get-cursor-date (&optional with-time)
21957 "Return the date at cursor in as a time.
21958 This works in the calendar and in the agenda, anywhere else it just
21959 returns the current time.
21960 If WITH-TIME is non-nil, returns the time of the event at point (in
21961 the agenda) or the current time of the day."
21962 (let (date day defd tp tm hod mod)
21963 (when with-time
21964 (setq tp (get-text-property (point) 'time))
21966 (setq hod (string-to-number (match-string 1 tp))
21967 mod (string-to-number (match-string 2 tp))))
21968 (or tp (setq hod (nth 2 (decode-time (current-time)))
21969 mod (nth 1 (decode-time (current-time))))))
21970 (cond
21971 ((eq major-mode 'calendar-mode)
21972 (setq date (calendar-cursor-to-date)
21973 defd (encode-time 0 (or mod 0) (or hod 0)
21974 (nth 1 date) (nth 0 date) (nth 2 date))))
21975 ((eq major-mode 'org-agenda-mode)
21976 (setq day (get-text-property (point) 'day))
21977 (if day
21978 (setq date (calendar-gregorian-from-absolute day)
21979 defd (encode-time 0 (or mod 0) (or hod 0)
21980 (nth 1 date) (nth 0 date) (nth 2 date))))))
21981 (or defd (current-time))))
21983 (defun org-mark-subtree (&optional up)
21984 "Mark the current subtree.
21985 This puts point at the start of the current subtree, and mark at
21986 the end. If a numeric prefix UP is given, move up into the
21987 hierarchy of headlines by UP levels before marking the subtree."
21988 (interactive "P")
21989 (org-with-limited-levels
21990 (cond ((org-at-heading-p) (beginning-of-line))
21991 ((org-before-first-heading-p) (user-error "Not in a subtree"))
21992 (t (outline-previous-visible-heading 1))))
21993 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21994 (if (org-called-interactively-p 'any)
21995 (call-interactively 'org-mark-element)
21996 (org-mark-element)))
21999 ;;; Indentation
22001 (defun org-indent-line ()
22002 "Indent line depending on context."
22003 (interactive)
22004 (let* ((pos (point))
22005 (itemp (org-at-item-p))
22006 (case-fold-search t)
22008 (inline-task-p (and (featurep 'org-inlinetask)
22009 (org-inlinetask-in-task-p)))
22010 (inline-re (and inline-task-p
22011 (org-inlinetask-outline-regexp)))
22012 column)
22013 (if (and orgstruct-is-++ (eq pos (point)))
22014 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22015 (indent-according-to-mode))
22016 (beginning-of-line 1)
22017 (cond
22018 ;; Headings
22019 ((looking-at org-outline-regexp) (setq column 0))
22020 ;; Footnote definition
22021 ((looking-at org-footnote-definition-re) (setq column 0))
22022 ;; Literal examples
22024 (setq column (org-get-indentation))) ; do nothing
22025 ;; Lists
22026 ((ignore-errors (goto-char (org-in-item-p)))
22027 (setq column (if itemp
22028 (org-get-indentation)
22029 (org-list-item-body-column (point))))
22030 (goto-char pos))
22031 ;; Drawers
22033 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22034 (save-excursion
22035 (goto-char (1- (match-beginning 1)))
22036 (setq column (current-column))))
22037 ;; Special blocks
22039 (save-excursion
22040 (re-search-backward
22042 (setq column (org-get-indentation (match-string 0))))
22045 (save-excursion
22047 (setq column
22048 (cond ((equal (downcase (match-string 1)) "src")
22049 ;; src blocks: let `org-edit-src-exit' handle them
22050 (org-get-indentation))
22051 ((equal (downcase (match-string 1)) "example")
22052 (max (org-get-indentation)
22053 (org-get-indentation (match-string 0))))
22054 (t
22055 (org-get-indentation (match-string 0))))))
22056 ;; This line has nothing special, look at the previous relevant
22057 ;; line to compute indentation
22058 (t
22059 (beginning-of-line 0)
22060 (while (and (not (bobp))
22061 (not (looking-at org-table-line-regexp))
22062 (not (looking-at org-drawer-regexp))
22063 ;; When point started in an inline task, do not move
22064 ;; above task starting line.
22065 (not (and inline-task-p (looking-at inline-re)))
22066 ;; Skip drawers, blocks, empty lines, verbatim,
22067 ;; comments, tables, footnotes definitions, lists,
22068 ;; inline tasks.
22070 (re-search-backward org-drawer-regexp nil t))
22074 (looking-at org-footnote-definition-re)
22075 (and (not inline-task-p)
22076 (featurep 'org-inlinetask)
22077 (org-inlinetask-in-task-p)
22078 (or (org-inlinetask-goto-beginning) t))))
22079 (beginning-of-line 0))
22080 (cond
22081 ;; There was a list item above.
22082 ((ignore-errors (goto-char (org-in-item-p)))
22083 (goto-char (org-list-get-top-point (org-list-struct)))
22084 (setq column (org-get-indentation)))
22085 ;; There was an heading above.
22087 (if (not org-adapt-indentation)
22088 (setq column 0)
22089 (goto-char (match-end 0))
22090 (setq column (current-column))))
22091 ;; A drawer had started and is unfinished
22092 ((looking-at org-drawer-regexp)
22093 (goto-char (1- (match-beginning 1)))
22094 (setq column (current-column)))
22095 ;; Else, nothing noticeable found: get indentation and go on.
22096 (t (setq column (org-get-indentation))))))
22097 ;; Now apply indentation and move cursor accordingly
22098 (goto-char pos)
22099 (if (<= (current-column) (current-indentation))
22100 (org-indent-line-to column)
22101 (save-excursion (org-indent-line-to column)))
22102 ;; Special polishing for properties, see `org-property-format'
22103 (setq column (current-column))
22104 (beginning-of-line 1)
22105 (if (looking-at org-property-re)
22106 (replace-match (concat (match-string 4)
22107 (format org-property-format
22108 (match-string 1) (match-string 3)))
22109 t t))
22110 (org-move-to-column column))))
22112 (defun org-indent-drawer ()
22113 "Indent the drawer at point."
22114 (interactive)
22115 (let ((p (point))
22116 (e (and (save-excursion (re-search-forward ":END:" nil t))
22117 (match-end 0)))
22118 (folded
22119 (save-excursion
22120 (end-of-line)
22121 (when (overlays-at (point))
22122 (member 'invisible (overlay-properties
22123 (car (overlays-at (point)))))))))
22124 (when folded (org-cycle))
22125 (indent-for-tab-command)
22126 (while (and (move-beginning-of-line 2) (< (point) e))
22127 (indent-for-tab-command))
22128 (goto-char p)
22129 (when folded (org-cycle)))
22130 (message "Drawer at point indented"))
22132 (defun org-indent-block ()
22133 "Indent the block at point."
22134 (interactive)
22135 (let ((p (point))
22136 (case-fold-search t)
22138 (match-end 0)))
22139 (folded
22140 (save-excursion
22141 (end-of-line)
22142 (when (overlays-at (point))
22143 (member 'invisible (overlay-properties
22144 (car (overlays-at (point)))))))))
22145 (when folded (org-cycle))
22146 (indent-for-tab-command)
22147 (while (and (move-beginning-of-line 2) (< (point) e))
22148 (indent-for-tab-command))
22149 (goto-char p)
22150 (when folded (org-cycle)))
22151 (message "Block at point indented"))
22153 (defun org-indent-region (start end)
22154 "Indent region."
22155 (interactive "r")
22156 (save-excursion
22157 (let ((line-end (org-current-line end)))
22158 (goto-char start)
22159 (while (< (org-current-line) line-end)
22160 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22161 (t (call-interactively 'org-indent-line)))
22162 (move-beginning-of-line 2)))))
22165 ;;; Filling
22167 ;; We use our own fill-paragraph and auto-fill functions.
22169 ;; `org-fill-paragraph' relies on adaptive filling and context
22170 ;; checking. Appropriate `fill-prefix' is computed with
22171 ;; `org-adaptive-fill-function'.
22173 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22174 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22175 ;; `org-adaptive-fill-function' value. Internally,
22176 ;; `org-comment-line-break-function' breaks the line.
22178 ;; `org-setup-filling' installs filling and auto-filling related
22179 ;; variables during `org-mode' initialization.
22181 (defvar org-element-paragraph-separate) ; org-element.el
22182 (defun org-setup-filling ()
22183 (require 'org-element)
22184 ;; Prevent auto-fill from inserting unwanted new items.
22185 (when (boundp 'fill-nobreak-predicate)
22186 (org-set-local
22187 'fill-nobreak-predicate
22188 (org-uniquify
22189 (append fill-nobreak-predicate
22190 '(org-fill-line-break-nobreak-p
22191 org-fill-paragraph-with-timestamp-nobreak-p)))))
22192 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22193 (org-set-local 'paragraph-start paragraph-ending)
22194 (org-set-local 'paragraph-separate paragraph-ending))
22195 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22196 (org-set-local 'auto-fill-inhibit-regexp nil)
22197 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22198 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22199 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22201 (defun org-fill-line-break-nobreak-p ()
22202 "Non-nil when a new line at point would create an Org line break."
22203 (save-excursion
22208 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22209 "Non-nil when a new line at point would split a timestamp."
22210 (and (org-at-timestamp-p t)
22211 (not (looking-at org-ts-regexp-both))))
22213 (declare-function message-in-body-p "message" ())
22214 (defvar orgtbl-line-start-regexp) ; From org-table.el
22215 (defun org-adaptive-fill-function ()
22216 "Compute a fill prefix for the current line.
22217 Return fill prefix, as a string, or nil if current line isn't
22218 meant to be filled. For convenience, if `adaptive-fill-regexp'
22219 matches in paragraphs or comments, use it."
22220 (catch 'exit
22221 (when (derived-mode-p 'message-mode)
22222 (save-excursion
22223 (beginning-of-line)
22224 (cond ((or (not (message-in-body-p))
22225 (looking-at orgtbl-line-start-regexp))
22226 (throw 'exit nil))
22227 ((looking-at message-cite-prefix-regexp)
22228 (throw 'exit (match-string-no-properties 0)))
22229 ((looking-at org-outline-regexp)
22230 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22231 (org-with-wide-buffer
22232 (let* ((p (line-beginning-position))
22233 (element (save-excursion
22234 (beginning-of-line)
22235 (or (ignore-errors (org-element-at-point))
22236 (user-error "An element cannot be parsed line %d"
22237 (line-number-at-pos (point))))))
22238 (type (org-element-type element))
22239 (post-affiliated (org-element-property :post-affiliated element)))
22240 (unless (and post-affiliated (< p post-affiliated))
22241 (case type
22242 (comment
22243 (save-excursion
22244 (beginning-of-line)
22246 (concat (match-string 0) "# ")))
22247 (footnote-definition "")
22248 ((item plain-list)
22249 (make-string (org-list-item-body-column
22250 (or post-affiliated
22251 (org-element-property :begin element)))
22252 ? ))
22253 (paragraph
22254 ;; Fill prefix is usually the same as the current line,
22255 ;; unless the paragraph is at the beginning of an item.
22256 (let ((parent (org-element-property :parent element)))
22257 (save-excursion
22258 (beginning-of-line)
22259 (cond ((eq (org-element-type parent) 'item)
22260 (make-string (org-list-item-body-column
22261 (org-element-property :begin parent))
22262 ? ))
22263 ((and adaptive-fill-regexp
22264 ;; Locally disable
22265 ;; `adaptive-fill-function' to let
22266 ;; `fill-context-prefix' handle
22267 ;; `adaptive-fill-regexp' variable.
22268 (let (adaptive-fill-function)
22269 (fill-context-prefix
22270 post-affiliated
22271 (org-element-property :end element)))))
22273 (t "")))))
22274 (comment-block
22275 ;; Only fill contents if P is within block boundaries.
22276 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22277 (forward-line)
22278 (point)))
22279 (cend (save-excursion
22280 (goto-char (org-element-property :end element))
22282 (line-beginning-position))))
22283 (when (and (>= p cbeg) (< p cend))
22285 (match-string 0)
22286 ""))))))))))
22288 (declare-function message-goto-body "message" ())
22289 (defvar message-cite-prefix-regexp) ; From message.el
22290 (defun org-fill-paragraph (&optional justify)
22291 "Fill element at point, when applicable.
22293 This function only applies to comment blocks, comments, example
22294 blocks and paragraphs. Also, as a special case, re-align table
22295 when point is at one.
22297 If JUSTIFY is non-nil (interactively, with prefix argument),
22298 justify as well. If `sentence-end-double-space' is non-nil, then
22299 period followed by one space does not end a sentence, so don't
22300 break a line there. The variable `fill-column' controls the
22301 width for filling.
22303 For convenience, when point is at a plain list, an item or
22304 a footnote definition, try to fill the first paragraph within."
22305 (interactive)
22306 (if (and (derived-mode-p 'message-mode)
22307 (or (not (message-in-body-p))
22308 (save-excursion (move-beginning-of-line 1)
22309 (looking-at message-cite-prefix-regexp))))
22310 ;; First ensure filling is correct in message-mode.
22311 (let ((fill-paragraph-function
22312 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22313 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22314 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22315 (paragraph-separate
22316 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22317 (fill-paragraph nil))
22318 (with-syntax-table org-mode-transpose-word-syntax-table
22319 ;; Move to end of line in order to get the first paragraph
22320 ;; within a plain list or a footnote definition.
22321 (let ((element (save-excursion
22322 (end-of-line)
22323 (or (ignore-errors (org-element-at-point))
22324 (user-error "An element cannot be parsed line %d"
22325 (line-number-at-pos (point)))))))
22326 ;; First check if point is in a blank line at the beginning of
22327 ;; the buffer. In that case, ignore filling.
22328 (case (org-element-type element)
22329 ;; Use major mode filling function is src blocks.
22330 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22331 ;; Align Org tables, leave table.el tables as-is.
22332 (table-row (org-table-align) t)
22333 (table
22334 (when (eq (org-element-property :type element) 'org)
22335 (save-excursion
22336 (goto-char (org-element-property :post-affiliated element))
22337 (org-table-align)))
22338 t)
22339 (paragraph
22340 ;; Paragraphs may contain `line-break' type objects.
22341 (let ((beg (max (point-min)
22342 (org-element-property :contents-begin element)))
22343 (end (min (point-max)
22344 (org-element-property :contents-end element))))
22345 ;; Do nothing if point is at an affiliated keyword.
22346 (if (< (line-end-position) beg) t
22347 (when (derived-mode-p 'message-mode)
22348 ;; In `message-mode', do not fill following citation
22349 ;; in current paragraph nor text before message body.
22350 (let ((body-start (save-excursion (message-goto-body))))
22351 (when body-start (setq beg (max body-start beg))))
22352 (when (save-excursion
22353 (re-search-forward
22354 (concat "^" message-cite-prefix-regexp) end t))
22355 (setq end (match-beginning 0))))
22356 ;; Fill paragraph, taking line breaks into account.
22357 ;; For that, slice the paragraph using line breaks as
22358 ;; separators, and fill the parts in reverse order to
22359 ;; avoid messing with markers.
22360 (save-excursion
22361 (goto-char end)
22362 (mapc
22363 (lambda (pos)
22364 (fill-region-as-paragraph pos (point) justify)
22365 (goto-char pos))
22366 ;; Find the list of ending positions for line breaks
22367 ;; in the current paragraph. Add paragraph
22368 ;; beginning to include first slice.
22369 (nreverse
22370 (cons beg
22371 (org-element-map
22372 (org-element--parse-objects
22373 beg end nil (org-element-restriction 'paragraph))
22374 'line-break
22375 (lambda (lb) (org-element-property :end lb)))))))
22376 t)))
22377 ;; Contents of `comment-block' type elements should be
22378 ;; filled as plain text, but only if point is within block
22379 ;; markers.
22380 (comment-block
22381 (let* ((case-fold-search t)
22382 (beg (save-excursion
22383 (goto-char (org-element-property :begin element))
22385 (forward-line)
22386 (point)))
22387 (end (save-excursion
22388 (goto-char (org-element-property :end element))
22390 (line-beginning-position))))
22391 (if (or (< (point) beg) (> (point) end)) t
22392 (fill-region-as-paragraph
22393 (save-excursion (end-of-line)
22395 (line-beginning-position))
22396 (save-excursion (beginning-of-line)
22398 (line-beginning-position))
22399 justify))))
22400 ;; Fill comments.
22401 (comment
22402 (let ((begin (org-element-property :post-affiliated element))
22403 (end (org-element-property :end element)))
22404 (when (and (>= (point) begin) (<= (point) end))
22405 (let ((begin (save-excursion
22406 (end-of-line)
22408 (progn (forward-line) (point))
22409 begin)))
22410 (end (save-excursion
22411 (end-of-line)
22413 (1- (line-beginning-position))
22415 (line-end-position)))))
22416 ;; Do not fill comments when at a blank line.
22417 (when (> end begin)
22418 (let ((fill-prefix
22419 (save-excursion
22420 (beginning-of-line)
22422 (let ((comment-prefix (match-string 0)))
22423 (goto-char (match-end 0))
22424 (if (looking-at adaptive-fill-regexp)
22425 (concat comment-prefix (match-string 0))
22426 (concat comment-prefix " "))))))
22427 (save-excursion
22428 (fill-region-as-paragraph begin end justify))))))
22429 t))
22430 ;; Ignore every other element.
22431 (otherwise t))))))
22433 (defun org-auto-fill-function ()
22434 "Auto-fill function."
22435 ;; Check if auto-filling is meaningful.
22436 (let ((fc (current-fill-column)))
22437 (when (and fc (> (current-column) fc))
22438 (let* ((fill-prefix (org-adaptive-fill-function))
22439 ;; Enforce empty fill prefix, if required. Otherwise, it
22440 ;; will be computed again.
22441 (adaptive-fill-mode (not (equal fill-prefix ""))))
22442 (when fill-prefix (do-auto-fill))))))
22444 (defun org-comment-line-break-function (&optional soft)
22445 "Break line at point and indent, continuing comment if within one.
22446 The inserted newline is marked hard if variable
22447 `use-hard-newlines' is true, unless optional argument SOFT is
22448 non-nil."
22450 (save-excursion (forward-char -1) (delete-horizontal-space))
22451 (delete-horizontal-space)
22452 (indent-to-left-margin)
22453 (insert-before-markers-and-inherit fill-prefix))
22456 ;;; Comments
22458 ;; Org comments syntax is quite complex. It requires the entire line
22459 ;; to be just a comment. Also, even with the right syntax at the
22460 ;; beginning of line, some some elements (i.e. verse-block or
22461 ;; example-block) don't accept comments. Usual Emacs comment commands
22462 ;; cannot cope with those requirements. Therefore, Org replaces them.
22464 ;; Org still relies on `comment-dwim', but cannot trust
22465 ;; `comment-only-p'. So, `comment-region-function' and
22466 ;; `uncomment-region-function' both point
22467 ;; to`org-comment-or-uncomment-region'. Eventually,
22468 ;; `org-insert-comment' takes care of insertion of comments at the
22469 ;; beginning of line.
22471 ;; `org-setup-comments-handling' install comments related variables
22472 ;; during `org-mode' initialization.
22474 (defun org-setup-comments-handling ()
22475 (interactive)
22476 (org-set-local 'comment-use-syntax nil)
22477 (org-set-local 'comment-start "# ")
22479 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22480 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22481 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22483 (defun org-insert-comment ()
22484 "Insert an empty comment above current line.
22485 If the line is empty, insert comment at its beginning."
22486 (beginning-of-line)
22488 (org-indent-line)
22489 (insert "# "))
22491 (defvar comment-empty-lines) ; From newcomment.el.
22492 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22493 "Comment or uncomment each non-blank line in the region.
22494 Uncomment each non-blank line between BEG and END if it only
22495 contains commented lines. Otherwise, comment them."
22496 (save-restriction
22497 ;; Restrict region
22498 (narrow-to-region (save-excursion (goto-char beg)
22500 (line-beginning-position))
22501 (save-excursion (goto-char end)
22503 (line-end-position)))
22504 (let ((uncommentp
22505 ;; UNCOMMENTP is non-nil when every non blank line between
22506 ;; BEG and END is a comment.
22507 (save-excursion
22508 (goto-char (point-min))
22509 (while (and (not (eobp))
22510 (let ((element (org-element-at-point)))
22511 (and (eq (org-element-type element) 'comment)
22512 (goto-char (min (point-max)
22513 (org-element-property
22514 :end element)))))))
22515 (eobp))))
22516 (if uncommentp
22517 ;; Only blank lines and comments in region: uncomment it.
22518 (save-excursion
22519 (goto-char (point-min))
22520 (while (not (eobp))
22522 (replace-match "" nil nil nil 1))
22523 (forward-line)))
22524 ;; Comment each line in region.
22525 (let ((min-indent (point-max)))
22526 ;; First find the minimum indentation across all lines.
22527 (save-excursion
22528 (goto-char (point-min))
22529 (while (and (not (eobp)) (not (zerop min-indent)))
22531 (setq min-indent (min min-indent (current-indentation))))
22532 (forward-line)))
22533 ;; Then loop over all lines.
22534 (save-excursion
22535 (goto-char (point-min))
22536 (while (not (eobp))
22538 ;; Don't get fooled by invisible text (e.g. link path)
22539 ;; when moving to column MIN-INDENT.
22540 (let ((buffer-invisibility-spec nil))
22541 (org-move-to-column min-indent t))
22542 (insert comment-start))
22543 (forward-line))))))))
22546 ;;; Planning
22548 ;; This section contains tools to operate on timestamp objects, as
22549 ;; returned by, e.g. `org-element-context'.
22551 (defun org-timestamp-has-time-p (timestamp)
22552 "Non-nil when TIMESTAMP has a time specified."
22553 (org-element-property :hour-start timestamp))
22555 (defun org-timestamp-format (timestamp format &optional end utc)
22556 "Format a TIMESTAMP element into a string.
22558 FORMAT is a format specifier to be passed to
22559 `format-time-string'.
22561 When optional argument END is non-nil, use end of date-range or
22562 time-range, if possible.
22564 When optional argument UTC is non-nil, time will be expressed as
22565 Universal Time."
22566 (format-time-string
22567 format
22568 (apply 'encode-time
22569 (cons 0
22570 (mapcar
22571 (lambda (prop) (or (org-element-property prop timestamp) 0))
22572 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22573 '(:minute-start :hour-start :day-start :month-start
22574 :year-start)))))
22575 utc))
22577 (defun org-timestamp-split-range (timestamp &optional end)
22578 "Extract a timestamp object from a date or time range.
22580 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22581 the end of the range. Otherwise, extract its start.
22583 Return a new timestamp object sharing the same parent as
22584 TIMESTAMP."
22585 (let ((type (org-element-property :type timestamp)))
22586 (if (memq type '(active inactive diary)) timestamp
22587 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22588 ;; Set new type.
22589 (org-element-put-property
22590 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22591 ;; Copy start properties over end properties if END is
22592 ;; non-nil. Otherwise, copy end properties over `start' ones.
22593 (let ((p-alist '((:minute-start . :minute-end)
22594 (:hour-start . :hour-end)
22595 (:day-start . :day-end)
22596 (:month-start . :month-end)
22597 (:year-start . :year-end))))
22598 (dolist (p-cell p-alist)
22599 (org-element-put-property
22600 split-ts
22601 (funcall (if end 'car 'cdr) p-cell)
22602 (org-element-property
22603 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22604 ;; Eventually refresh `:raw-value'.
22605 (org-element-put-property split-ts :raw-value nil)
22606 (org-element-put-property
22607 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22609 (defun org-timestamp-translate (timestamp &optional boundary)
22610 "Apply `org-translate-time' on a TIMESTAMP object.
22611 When optional argument BOUNDARY is non-nil, it is either the
22612 symbol `start' or `end'. In this case, only translate the
22613 starting or ending part of TIMESTAMP if it is a date or time
22614 range. Otherwise, translate both parts."
22615 (if (and (not boundary)
22616 (memq (org-element-property :type timestamp)
22617 '(active-range inactive-range)))
22618 (concat
22619 (org-translate-time
22620 (org-element-property :raw-value
22621 (org-timestamp-split-range timestamp)))
22622 "--"
22623 (org-translate-time
22624 (org-element-property :raw-value
22625 (org-timestamp-split-range timestamp t))))
22626 (org-translate-time
22627 (org-element-property
22628 :raw-value
22629 (if (not boundary) timestamp
22630 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22634 ;;; Other stuff.
22636 (defun org-toggle-fixed-width-section (arg)
22637 "Toggle the fixed-width export.
22638 If there is no active region, the QUOTE keyword at the current headline is
22639 inserted or removed. When present, it causes the text between this headline
22640 and the next to be exported as fixed-width text, and unmodified.
22641 If there is an active region, this command adds or removes a colon as the
22642 first character of this line. If the first character of a line is a colon,
22643 this line is also exported in fixed-width font."
22644 (interactive "P")
22645 (let* ((cc 0)
22646 (regionp (org-region-active-p))
22647 (beg (if regionp (region-beginning) (point)))
22648 (end (if regionp (region-end)))
22649 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22650 (case-fold-search nil)
22652 off)
22653 (if regionp
22654 (save-excursion
22655 (goto-char beg)
22656 (setq cc (current-column))
22657 (beginning-of-line 1)
22658 (setq off (looking-at re))
22659 (while (> nlines 0)
22660 (setq nlines (1- nlines))
22661 (beginning-of-line 1)
22662 (cond
22663 (arg
22664 (org-move-to-column cc t)
22666 (forward-line -1))
22667 ((and off (looking-at re))
22668 (replace-match "" t t nil 1))
22669 ((not off) (org-move-to-column cc t) (insert ": ")))
22670 (forward-line 1)))
22671 (save-excursion
22672 (org-back-to-heading)
22673 (cond
22674 ((looking-at (format org-heading-keyword-regexp-format
22675 org-quote-string))
22676 (goto-char (match-end 1))
22677 (looking-at (concat " +" org-quote-string))
22678 (replace-match "" t t)
22679 (when (eolp) (insert " ")))
22680 ((looking-at org-outline-regexp)
22681 (goto-char (match-end 0))
22682 (insert org-quote-string " ")))))))
22684 (defun org-reftex-citation ()
22685 "Use reftex-citation to insert a citation into the buffer.
22686 This looks for a line like
22688 #+BIBLIOGRAPHY: foo plain option:-d
22690 and derives from it that foo.bib is the bibliography file relevant
22691 for this document. It then installs the necessary environment for RefTeX
22692 to work in this buffer and calls `reftex-citation' to insert a citation
22693 into the buffer.
22695 Export of such citations to both LaTeX and HTML is handled by the contributed
22696 package ox-bibtex by Taru Karttunen."
22697 (interactive)
22698 (let ((reftex-docstruct-symbol 'rds)
22700 rds bib)
22701 (save-excursion
22702 (save-restriction
22703 (widen)
22704 (let ((case-fold-search t)
22706 (if (not (save-excursion
22707 (or (re-search-forward re nil t)
22708 (re-search-backward re nil t))))
22709 (error "No bibliography defined in file")
22710 (setq bib (concat (match-string 1) ".bib")
22711 rds (list (list 'bib bib)))))))
22712 (call-interactively 'reftex-citation)))
22714 ;;;; Functions extending outline functionality
22716 (defun org-beginning-of-line (&optional arg)
22717 "Go to the beginning of the current line. If that is invisible, continue
22718 to a visible line beginning. This makes the function of C-a more intuitive.
22719 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22720 first attempt, and only move to after the tags when the cursor is already
22721 beyond the end of the headline."
22722 (interactive "P")
22723 (let ((pos (point))
22724 (special (if (consp org-special-ctrl-a/e)
22725 (car org-special-ctrl-a/e)
22726 org-special-ctrl-a/e))
22727 deactivate-mark refpos)
22728 (if (org-bound-and-true-p visual-line-mode)
22729 (beginning-of-visual-line 1)
22730 (beginning-of-line 1))
22731 (if (and arg (fboundp 'move-beginning-of-line))
22732 (call-interactively 'move-beginning-of-line)
22733 (if (bobp)
22734 nil
22735 (backward-char 1)
22736 (if (org-truely-invisible-p)
22737 (while (and (not (bobp)) (org-truely-invisible-p))
22738 (backward-char 1)
22739 (beginning-of-line 1))
22740 (forward-char 1))))
22741 (when special
22742 (cond
22743 ((and (looking-at org-complex-heading-regexp)
22744 (= (char-after (match-end 1)) ?\ ))
22745 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22746 (point-at-eol)))
22747 (goto-char
22748 (if (eq special t)
22749 (cond ((> pos refpos) refpos)
22750 ((= pos (point)) refpos)
22751 (t (point)))
22752 (cond ((> pos (point)) (point))
22753 ((not (eq last-command this-command)) (point))
22754 (t refpos)))))
22755 ((org-at-item-p)
22756 ;; Being at an item and not looking at an the item means point
22757 ;; was previously moved to beginning of a visual line, which
22758 ;; doesn't contain the item. Therefore, do nothing special,
22759 ;; just stay here.
22760 (when (looking-at org-list-full-item-re)
22761 ;; Set special position at first white space character after
22762 ;; bullet, and check-box, if any.
22763 (let ((after-bullet
22764 (let ((box (match-end 3)))
22765 (if (not box) (match-end 1)
22766 (let ((after (char-after box)))
22767 (if (and after (= after ? )) (1+ box) box))))))
22768 ;; Special case: Move point to special position when
22769 ;; currently after it or at beginning of line.
22770 (if (eq special t)
22771 (when (or (> pos after-bullet) (= (point) pos))
22772 (goto-char after-bullet))
22773 ;; Reversed case: Move point to special position when
22774 ;; point was already at beginning of line and command is
22775 ;; repeated.
22776 (when (and (= (point) pos) (eq last-command this-command))
22777 (goto-char after-bullet))))))))
22778 (org-no-warnings
22779 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22780 (setq disable-point-adjustment
22781 (or (not (invisible-p (point)))
22782 (not (invisible-p (max (point-min) (1- (point))))))))
22784 (defun org-end-of-line (&optional arg)
22785 "Go to the end of the line.
22786 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22787 tags on the first attempt, and only move to after the tags when
22788 the cursor is already beyond the end of the headline."
22789 (interactive "P")
22790 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22791 org-special-ctrl-a/e))
22792 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22793 'end-of-visual-line)
22794 ((fboundp 'move-end-of-line) 'move-end-of-line)
22795 (t 'end-of-line)))
22796 deactivate-mark)
22797 (if (or (not special) arg) (call-interactively move-fun)
22798 (let* ((element (save-excursion (beginning-of-line)
22799 (org-element-at-point)))
22800 (type (org-element-type element)))
22801 (cond
22802 ((memq type '(headline inlinetask))
22803 (let ((pos (point)))
22804 (beginning-of-line 1)
22806 (if (eq special t)
22807 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22808 (goto-char (match-beginning 1))
22809 (goto-char (match-end 0)))
22810 (if (or (< pos (match-end 0))
22811 (not (eq this-command last-command)))
22812 (goto-char (match-end 0))
22813 (goto-char (match-beginning 1))))
22814 (call-interactively move-fun))))
22815 ((org-element-property :hiddenp element)
22816 ;; If element is hidden, `move-end-of-line' would put point
22817 ;; after it. Use `end-of-line' to stay on current line.
22818 (call-interactively 'end-of-line))
22819 (t (call-interactively move-fun)))))
22820 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22821 (setq disable-point-adjustment
22822 (or (not (invisible-p (point)))
22823 (not (invisible-p (max (point-min) (1- (point))))))))
22825 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22826 (define-key org-mode-map "\C-e" 'org-end-of-line)
22828 (defun org-backward-sentence (&optional arg)
22829 "Go to beginning of sentence, or beginning of table field.
22830 This will call `backward-sentence' or `org-table-beginning-of-field',
22831 depending on context."
22832 (interactive "P")
22833 (cond
22834 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22835 (t (call-interactively 'backward-sentence))))
22837 (defun org-forward-sentence (&optional arg)
22838 "Go to end of sentence, or end of table field.
22839 This will call `forward-sentence' or `org-table-end-of-field',
22840 depending on context."
22841 (interactive "P")
22842 (cond
22843 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22844 (t (call-interactively 'forward-sentence))))
22846 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22847 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22849 (defun org-kill-line (&optional arg)
22850 "Kill line, to tags or end of line."
22851 (interactive "P")
22852 (cond
22853 ((or (not org-special-ctrl-k)
22854 (bolp)
22855 (not (org-at-heading-p)))
22856 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22857 org-ctrl-k-protect-subtree)
22858 (if (or (eq org-ctrl-k-protect-subtree 'error)
22859 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22860 (user-error "C-k aborted as it would kill a hidden subtree")))
22861 (call-interactively
22862 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22864 (kill-region (point) (match-beginning 1))
22865 (org-set-tags nil t))
22866 (t (kill-region (point) (point-at-eol)))))
22868 (define-key org-mode-map "\C-k" 'org-kill-line)
22870 (defun org-yank (&optional arg)
22871 "Yank. If the kill is a subtree, treat it specially.
22872 This command will look at the current kill and check if is a single
22873 subtree, or a series of subtrees[1]. If it passes the test, and if the
22874 cursor is at the beginning of a line or after the stars of a currently
22875 empty headline, then the yank is handled specially. How exactly depends
22876 on the value of the following variables, both set by default.
22878 org-yank-folded-subtrees
22879 When set, the subtree(s) will be folded after insertion, but only
22880 if doing so would now swallow text after the yanked text.
22882 org-yank-adjusted-subtrees
22883 When set, the subtree will be promoted or demoted in order to
22884 fit into the local outline tree structure, which means that the level
22885 will be adjusted so that it becomes the smaller one of the two
22886 *visible* surrounding headings.
22888 Any prefix to this command will cause `yank' to be called directly with
22890 will just
22891 plainly yank the text as it is.
22893 \[1] The test checks if the first non-white line is a heading
22894 and if there are no other headings with fewer stars."
22895 (interactive "P")
22896 (org-yank-generic 'yank arg))
22898 (defun org-yank-generic (command arg)
22899 "Perform some yank-like command.
22901 This function implements the behavior described in the `org-yank'
22902 documentation. However, it has been generalized to work for any
22903 interactive command with similar behavior."
22905 ;; pretend to be command COMMAND
22906 (setq this-command command)
22908 (if arg
22909 (call-interactively command)
22911 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22912 (and (org-kill-is-subtree-p)
22913 (or (bolp)
22915 (string-match
22917 (buffer-substring (point-at-bol) (point)))))))
22918 swallowp)
22919 (cond
22920 ((and subtreep org-yank-folded-subtrees)
22921 (let ((beg (point))
22922 end)
22923 (if (and subtreep org-yank-adjusted-subtrees)
22924 (org-paste-subtree nil nil 'for-yank)
22925 (call-interactively command))
22927 (setq end (point))
22928 (goto-char beg)
22929 (when (and (bolp) subtreep
22930 (not (setq swallowp
22931 (org-yank-folding-would-swallow-text beg end))))
22932 (org-with-limited-levels
22933 (or (looking-at org-outline-regexp)
22934 (re-search-forward org-outline-regexp-bol end t))
22935 (while (and (< (point) end) (looking-at org-outline-regexp))
22936 (hide-subtree)
22937 (org-cycle-show-empty-lines 'folded)
22938 (condition-case nil
22939 (outline-forward-same-level 1)
22940 (error (goto-char end))))))
22941 (when swallowp
22942 (message
22943 "Inserted text not folded because that would swallow text"))
22945 (goto-char end)
22947 (beginning-of-line 1)
22948 (push-mark beg 'nomsg)))
22949 ((and subtreep org-yank-adjusted-subtrees)
22950 (let ((beg (point-at-bol)))
22951 (org-paste-subtree nil nil 'for-yank)
22952 (push-mark beg 'nomsg)))
22953 (t
22954 (call-interactively command))))))
22956 (defun org-yank-folding-would-swallow-text (beg end)
22957 "Would hide-subtree at BEG swallow any text after END?"
22958 (let (level)
22959 (org-with-limited-levels
22960 (save-excursion
22961 (goto-char beg)
22962 (when (or (looking-at org-outline-regexp)
22963 (re-search-forward org-outline-regexp-bol end t))
22964 (setq level (org-outline-level)))
22965 (goto-char end)
22967 (if (or (eobp)
22968 (and (bolp) (looking-at org-outline-regexp)
22969 (<= (org-outline-level) level)))
22970 nil ; Nothing would be swallowed
22971 t))))) ; something would swallow
22973 (define-key org-mode-map "\C-y" 'org-yank)
22975 (defun org-truely-invisible-p ()
22976 "Check if point is at a character currently not visible.
22977 This version does not only check the character property, but also
22978 `visible-mode'."
22979 ;; Early versions of noutline don't have `outline-invisible-p'.
22980 (if (org-bound-and-true-p visible-mode)
22981 nil
22982 (outline-invisible-p)))
22984 (defun org-invisible-p2 ()
22985 "Check if point is at a character currently not visible."
22986 (save-excursion
22987 (if (and (eolp) (not (bobp))) (backward-char 1))
22988 ;; Early versions of noutline don't have `outline-invisible-p'.
22989 (outline-invisible-p)))
22991 (defun org-back-to-heading (&optional invisible-ok)
22992 "Call `outline-back-to-heading', but provide a better error message."
22993 (condition-case nil
22994 (outline-back-to-heading invisible-ok)
22995 (error (error "Before first headline at position %d in buffer %s"
22996 (point) (current-buffer)))))
22998 (defun org-before-first-heading-p ()
22999 "Before first heading?"
23000 (save-excursion
23001 (end-of-line)
23002 (null (re-search-backward org-outline-regexp-bol nil t))))
23004 (defun org-at-heading-p (&optional ignored)
23005 (outline-on-heading-p t))
23006 ;; Compatibility alias with Org versions < 7.8.03
23007 (defalias 'org-on-heading-p 'org-at-heading-p)
23009 (defun org-at-comment-p nil
23010 "Is cursor in a line starting with a # character?"
23011 (save-excursion
23012 (beginning-of-line)
23013 (looking-at "^#")))
23015 (defun org-at-drawer-p nil
23016 "Is cursor at a drawer keyword?"
23017 (save-excursion
23018 (move-beginning-of-line 1)
23019 (looking-at org-drawer-regexp)))
23021 (defun org-at-block-p nil
23022 "Is cursor at a block keyword?"
23023 (save-excursion
23024 (move-beginning-of-line 1)
23025 (looking-at org-block-regexp)))
23027 (defun org-point-at-end-of-empty-headline ()
23028 "If point is at the end of an empty headline, return t, else nil.
23029 If the heading only contains a TODO keyword, it is still still considered
23030 empty."
23032 (when org-todo-line-regexp
23033 (save-excursion
23034 (beginning-of-line 1)
23035 (let ((case-fold-search nil))
23036 (looking-at org-todo-line-regexp)
23037 (string= (match-string 3) ""))))))
23039 (defun org-at-heading-or-item-p ()
23040 (or (org-at-heading-p) (org-at-item-p)))
23042 (defun org-at-target-p ()
23043 (or (org-in-regexp org-radio-target-regexp)
23044 (org-in-regexp org-target-regexp)))
23045 ;; Compatibility alias with Org versions < 7.8.03
23046 (defalias 'org-on-target-p 'org-at-target-p)
23048 (defun org-up-heading-all (arg)
23049 "Move to the heading line of which the present line is a subheading.
23050 This function considers both visible and invisible heading lines.
23051 With argument, move up ARG levels."
23052 (if (fboundp 'outline-up-heading-all)
23053 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23054 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23056 (defun org-up-heading-safe ()
23057 "Move to the heading line of which the present line is a subheading.
23058 This version will not throw an error. It will return the level of the
23059 headline found, or nil if no higher level is found.
23061 Also, this function will be a lot faster than `outline-up-heading',
23062 because it relies on stars being the outline starters. This can really
23063 make a significant difference in outlines with very many siblings."
23064 (let (start-level re)
23065 (org-back-to-heading t)
23066 (setq start-level (funcall outline-level))
23067 (if (equal start-level 1)
23068 nil
23070 (if (re-search-backward re nil t)
23071 (funcall outline-level)))))
23073 (defun org-first-sibling-p ()
23074 "Is this heading the first child of its parents?"
23075 (interactive)
23076 (let ((re org-outline-regexp-bol)
23077 level l)
23078 (unless (org-at-heading-p t)
23079 (user-error "Not at a heading"))
23080 (setq level (funcall outline-level))
23081 (save-excursion
23082 (if (not (re-search-backward re nil t))
23083 t
23084 (setq l (funcall outline-level))
23085 (< l level)))))
23087 (defun org-goto-sibling (&optional previous)
23088 "Goto the next sibling, even if it is invisible.
23089 When PREVIOUS is set, go to the previous sibling instead. Returns t
23090 when a sibling was found. When none is found, return nil and don't
23091 move point."
23092 (let ((fun (if previous 're-search-backward 're-search-forward))
23093 (pos (point))
23094 (re org-outline-regexp-bol)
23095 level l)
23096 (when (condition-case nil (org-back-to-heading t) (error nil))
23097 (setq level (funcall outline-level))
23098 (catch 'exit
23099 (or previous (forward-char 1))
23100 (while (funcall fun re nil t)
23101 (setq l (funcall outline-level))
23102 (when (< l level) (goto-char pos) (throw 'exit nil))
23103 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23104 (goto-char pos)
23105 nil))))
23107 (defun org-show-siblings ()
23108 "Show all siblings of the current headline."
23109 (save-excursion
23110 (while (org-goto-sibling) (org-flag-heading nil)))
23111 (save-excursion
23112 (while (org-goto-sibling 'previous)
23113 (org-flag-heading nil))))
23115 (defun org-goto-first-child ()
23116 "Goto the first child, even if it is invisible.
23117 Return t when a child was found. Otherwise don't move point and
23118 return nil."
23119 (let (level (pos (point)) (re org-outline-regexp-bol))
23120 (when (condition-case nil (org-back-to-heading t) (error nil))
23121 (setq level (outline-level))
23122 (forward-char 1)
23123 (if (and (re-search-forward re nil t) (> (outline-level) level))
23124 (progn (goto-char (match-beginning 0)) t)
23125 (goto-char pos) nil))))
23127 (defun org-show-hidden-entry ()
23128 "Show an entry where even the heading is hidden."
23129 (save-excursion
23130 (org-show-entry)))
23132 (defun org-flag-heading (flag &optional entry)
23133 "Flag the current heading. FLAG non-nil means make invisible.
23134 When ENTRY is non-nil, show the entire entry."
23135 (save-excursion
23136 (org-back-to-heading t)
23137 ;; Check if we should show the entire entry
23138 (if entry
23139 (progn
23140 (org-show-entry)
23141 (save-excursion
23142 (and (outline-next-heading)
23143 (org-flag-heading nil))))
23144 (outline-flag-region (max (point-min) (1- (point)))
23145 (save-excursion (outline-end-of-heading) (point))
23146 flag))))
23148 (defun org-get-next-sibling ()
23149 "Move to next heading of the same level, and return point.
23150 If there is no such heading, return nil.
23151 This is like outline-next-sibling, but invisible headings are ok."
23152 (let ((level (funcall outline-level)))
23153 (outline-next-heading)
23154 (while (and (not (eobp)) (> (funcall outline-level) level))
23155 (outline-next-heading))
23156 (if (or (eobp) (< (funcall outline-level) level))
23157 nil
23158 (point))))
23160 (defun org-get-last-sibling ()
23161 "Move to previous heading of the same level, and return point.
23162 If there is no such heading, return nil."
23163 (let ((opoint (point))
23164 (level (funcall outline-level)))
23165 (outline-previous-heading)
23166 (when (and (/= (point) opoint) (outline-on-heading-p t))
23167 (while (and (> (funcall outline-level) level)
23168 (not (bobp)))
23169 (outline-previous-heading))
23170 (if (< (funcall outline-level) level)
23171 nil
23172 (point)))))
23174 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23175 "Goto to the end of a subtree."
23176 ;; This contains an exact copy of the original function, but it uses
23177 ;; `org-back-to-heading', to make it work also in invisible
23178 ;; trees. And is uses an invisible-ok argument.
23179 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23180 ;; Furthermore, when used inside Org, finding the end of a large subtree
23181 ;; with many children and grandchildren etc, this can be much faster
23182 ;; than the outline version.
23183 (org-back-to-heading invisible-ok)
23184 (let ((first t)
23185 (level (funcall outline-level)))
23186 (if (and (derived-mode-p 'org-mode) (< level 1000))
23187 ;; A true heading (not a plain list item), in Org-mode
23188 ;; This means we can easily find the end by looking
23189 ;; only for the right number of stars. Using a regexp to do
23190 ;; this is so much faster than using a Lisp loop.
23192 (forward-char 1)
23193 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23194 ;; something else, do it the slow way
23195 (while (and (not (eobp))
23196 (or first (> (funcall outline-level) level)))
23197 (setq first nil)
23198 (outline-next-heading)))
23199 (unless to-heading
23201 (progn
23202 ;; Go to end of line before heading
23203 (forward-char -1)
23205 ;; leave blank line before heading
23206 (forward-char -1))))))
23207 (point))
23209 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23210 "Use Org version in org-mode, for dramatic speed-up."
23211 (if (derived-mode-p 'org-mode)
23212 (progn
23213 (org-end-of-subtree nil t)
23214 (unless (eobp) (backward-char 1)))
23215 ad-do-it))
23217 (defun org-end-of-meta-data-and-drawers ()
23218 "Jump to the first text after meta data and drawers in the current entry.
23219 This will move over empty lines, lines with planning time stamps,
23220 clocking lines, and drawers."
23221 (org-back-to-heading t)
23222 (let ((end (save-excursion (outline-next-heading) (point)))
23225 (forward-line 1)
23226 (while (re-search-forward re end t)
23227 (if (not (match-end 1))
23228 ;; empty or planning line
23229 (forward-line 1)
23230 ;; a drawer, find the end
23232 (forward-line 1)))
23234 (point)))
23236 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23237 "Move forward to the ARG'th subheading at same level as this one.
23238 Stop at the first and last subheadings of a superior heading.
23239 Normally this only looks at visible headings, but when INVISIBLE-OK is
23240 non-nil it will also look at invisible ones."
23241 (interactive "p")
23242 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23243 (if (and arg (< arg 0))
23244 (goto-char (point-min))
23245 (outline-next-heading))
23246 (org-at-heading-p)
23247 (let ((level (- (match-end 0) (match-beginning 0) 1))
23248 (f (if (and arg (< arg 0))
23249 're-search-backward
23250 're-search-forward))
23251 (count (if arg (abs arg) 1))
23252 (result (point)))
23253 (while (and (prog1 (> count 0)
23254 (forward-char (if (and arg (< arg 0)) -1 1)))
23255 (funcall f org-outline-regexp-bol nil 'move))
23256 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23257 (cond ((< l level) (setq count 0))
23258 ((and (= l level)
23259 (or invisible-ok
23260 (progn
23261 (goto-char (line-beginning-position))
23262 (not (outline-invisible-p)))))
23263 (setq count (1- count))
23264 (when (eq l level)
23265 (setq result (point)))))))
23266 (goto-char result))
23267 (beginning-of-line 1)))
23269 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23270 "Move backward to the ARG'th subheading at same level as this one.
23271 Stop at the first and last subheadings of a superior heading."
23272 (interactive "p")
23273 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23275 (defun org-next-block (arg &optional backward block-regexp)
23276 "Jump to the next block.
23277 With a prefix argument ARG, jump forward ARG many source blocks.
23278 When BACKWARD is non-nil, jump to the previous block.
23279 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23280 (interactive "p")
23281 (let ((re (or block-regexp org-block-regexp))
23282 (re-search-fn (or (and backward 're-search-backward)
23283 're-search-forward)))
23284 (if (looking-at re) (forward-char 1))
23285 (condition-case nil
23286 (funcall re-search-fn re nil nil arg)
23287 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23288 (goto-char (match-beginning 0)) (org-show-context)))
23290 (defun org-previous-block (arg &optional block-regexp)
23291 "Jump to the previous block.
23292 With a prefix argument ARG, jump backward ARG many source blocks.
23293 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23294 (interactive "p")
23295 (org-next-block arg t block-regexp))
23297 (defun org-forward-paragraph ()
23298 "Move forward to beginning of next paragraph or equivalent.
23300 The function moves point to the beginning of the next visible
23301 structural element, which can be a paragraph, a table, a list
23302 item, etc. It also provides some special moves for convenience:
23304 - On an affiliated keyword, jump to the beginning of the
23305 relative element.
23306 - On an item or a footnote definition, move to the second
23307 element inside, if any.
23308 - On a table or a property drawer, jump after it.
23309 - On a verse or source block, stop after blank lines."
23310 (interactive)
23311 (when (eobp) (user-error "Cannot move further down"))
23312 (let* ((deactivate-mark nil)
23313 (element (org-element-at-point))
23314 (type (org-element-type element))
23315 (post-affiliated (org-element-property :post-affiliated element))
23316 (contents-begin (org-element-property :contents-begin element))
23317 (contents-end (org-element-property :contents-end element))
23318 (end (let ((end (org-element-property :end element)) (parent element))
23319 (while (and (setq parent (org-element-property :parent parent))
23320 (= (org-element-property :contents-end parent) end))
23321 (setq end (org-element-property :end parent)))
23322 end)))
23323 (cond ((not element)
23325 (or (eobp) (beginning-of-line)))
23326 ;; On affiliated keywords, move to element's beginning.
23327 ((and post-affiliated (< (point) post-affiliated))
23328 (goto-char post-affiliated))
23329 ;; At a table row, move to the end of the table. Similarly,
23330 ;; at a node property, move to the end of the property
23331 ;; drawer.
23332 ((memq type '(node-property table-row))
23333 (goto-char (org-element-property
23334 :end (org-element-property :parent element))))
23335 ((memq type '(property-drawer table)) (goto-char end))
23336 ;; Consider blank lines as separators in verse and source
23337 ;; blocks to ease editing.
23338 ((memq type '(src-block verse-block))
23339 (when (eq type 'src-block)
23340 (setq contents-end
23341 (save-excursion (goto-char end)
23343 (line-beginning-position))))
23344 (beginning-of-line)
23347 (goto-char end)
23349 (if (= (point) contents-end) (goto-char end)
23350 (beginning-of-line))))
23351 ;; With no contents, just skip element.
23352 ((not contents-begin) (goto-char end))
23353 ;; If contents are invisible, skip the element altogether.
23354 ((outline-invisible-p (line-end-position))
23355 (case type
23356 (headline
23357 (org-with-limited-levels (outline-next-visible-heading 1)))
23358 ;; At a plain list, make sure we move to the next item
23359 ;; instead of skipping the whole list.
23360 (plain-list (forward-char)
23361 (org-forward-paragraph))
23362 (otherwise (goto-char end))))
23363 ((>= (point) contents-end) (goto-char end))
23364 ((>= (point) contents-begin)
23365 ;; This can only happen on paragraphs and plain lists.
23366 (case type
23367 (paragraph (goto-char end))
23368 ;; At a plain list, try to move to second element in
23369 ;; first item, if possible.
23370 (plain-list (end-of-line)
23371 (org-forward-paragraph))))
23372 ;; When contents start on the middle of a line (e.g. in
23373 ;; items and footnote definitions), try to reach first
23374 ;; element starting after current line.
23375 ((> (line-end-position) contents-begin)
23376 (end-of-line)
23377 (org-forward-paragraph))
23378 (t (goto-char contents-begin)))))
23380 (defun org-backward-paragraph ()
23381 "Move backward to start of previous paragraph or equivalent.
23383 The function moves point to the beginning of the current
23384 structural element, which can be a paragraph, a table, a list
23385 item, etc., or to the beginning of the previous visible one if
23386 point is already there. It also provides some special moves for
23387 convenience:
23389 - On an affiliated keyword, jump to the first one.
23390 - On a table or a property drawer, move to its beginning.
23391 - On a verse or source block, stop before blank lines."
23392 (interactive)
23393 (when (bobp) (user-error "Cannot move further up"))
23394 (let* ((deactivate-mark nil)
23395 (element (org-element-at-point))
23396 (type (org-element-type element))
23397 (contents-begin (org-element-property :contents-begin element))
23398 (contents-end (org-element-property :contents-end element))
23399 (post-affiliated (org-element-property :post-affiliated element))
23400 (begin (org-element-property :begin element)))
23401 (cond
23402 ((not element) (goto-char (point-min)))
23403 ((= (point) begin)
23404 (backward-char)
23405 (org-backward-paragraph))
23406 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23407 ((memq type '(node-property table-row))
23408 (goto-char (org-element-property
23409 :post-affiliated (org-element-property :parent element))))
23410 ((memq type '(property-drawer table)) (goto-char begin))
23411 ((memq type '(src-block verse-block))
23412 (when (eq type 'src-block)
23413 (setq contents-begin
23414 (save-excursion (goto-char begin) (forward-line) (point))))
23415 (if (= (point) contents-begin) (goto-char post-affiliated)
23416 ;; Inside a verse block, see blank lines as paragraph
23417 ;; separators.
23418 (let ((origin (point)))
23422 (if (= (point) origin) (goto-char contents-begin)
23423 (beginning-of-line))))))
23424 ((not contents-begin) (goto-char (or post-affiliated begin)))
23425 ((eq type 'paragraph)
23426 (goto-char contents-begin)
23427 ;; When at first paragraph in an item or a footnote definition,
23428 ;; move directly to beginning of line.
23429 (let ((parent-contents
23430 (org-element-property
23431 :contents-begin (org-element-property :parent element))))
23432 (when (and parent-contents (= parent-contents contents-begin))
23433 (beginning-of-line))))
23434 ;; At the end of a greater element, move to the beginning of the
23435 ;; last element within.
23436 ((>= (point) contents-end)
23437 (goto-char (1- contents-end))
23438 (org-backward-paragraph))
23439 (t (goto-char (or post-affiliated begin))))
23440 ;; Ensure we never leave point invisible.
23441 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23443 (defun org-forward-element ()
23444 "Move forward by one element.
23445 Move to the next element at the same level, when possible."
23446 (interactive)
23447 (cond ((eobp) (user-error "Cannot move further down"))
23448 ((org-with-limited-levels (org-at-heading-p))
23449 (let ((origin (point)))
23450 (goto-char (org-end-of-subtree nil t))
23451 (unless (org-with-limited-levels (org-at-heading-p))
23452 (goto-char origin)
23453 (user-error "Cannot move further down"))))
23454 (t
23455 (let* ((elem (org-element-at-point))
23456 (end (org-element-property :end elem))
23457 (parent (org-element-property :parent elem)))
23458 (cond ((and parent (= (org-element-property :contents-end parent) end))
23459 (goto-char (org-element-property :end parent)))
23460 ((integer-or-marker-p end) (goto-char end))
23461 (t (message "No element at point")))))))
23463 (defun org-backward-element ()
23464 "Move backward by one element.
23465 Move to the previous element at the same level, when possible."
23466 (interactive)
23467 (cond ((bobp) (user-error "Cannot move further up"))
23468 ((org-with-limited-levels (org-at-heading-p))
23469 ;; At a headline, move to the previous one, if any, or stay
23470 ;; here.
23471 (let ((origin (point)))
23472 (org-with-limited-levels (org-backward-heading-same-level 1))
23473 ;; When current headline has no sibling above, move to its
23474 ;; parent.
23475 (when (= (point) origin)
23476 (or (org-with-limited-levels (org-up-heading-safe))
23477 (progn (goto-char origin)
23478 (user-error "Cannot move further up"))))))
23479 (t
23480 (let* ((trail (org-element-at-point 'keep-trail))
23481 (elem (car trail))
23482 (prev-elem (nth 1 trail))
23483 (beg (org-element-property :begin elem)))
23484 (cond
23485 ;; Move to beginning of current element if point isn't
23486 ;; there already.
23487 ((null beg) (message "No element at point"))
23488 ((/= (point) beg) (goto-char beg))
23489 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23490 ((org-before-first-heading-p) (goto-char (point-min)))
23491 (t (org-back-to-heading)))))))
23493 (defun org-up-element ()
23494 "Move to upper element."
23495 (interactive)
23496 (if (org-with-limited-levels (org-at-heading-p))
23497 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23498 (let* ((elem (org-element-at-point))
23499 (parent (org-element-property :parent elem)))
23500 (if parent (goto-char (org-element-property :begin parent))
23501 (if (org-with-limited-levels (org-before-first-heading-p))
23502 (user-error "No surrounding element")
23503 (org-with-limited-levels (org-back-to-heading)))))))
23505 (defvar org-element-greater-elements)
23506 (defun org-down-element ()
23507 "Move to inner element."
23508 (interactive)
23509 (let ((element (org-element-at-point)))
23510 (cond
23511 ((memq (org-element-type element) '(plain-list table))
23512 (goto-char (org-element-property :contents-begin element))
23513 (forward-char))
23514 ((memq (org-element-type element) org-element-greater-elements)
23515 ;; If contents are hidden, first disclose them.
23516 (when (org-element-property :hiddenp element) (org-cycle))
23517 (goto-char (or (org-element-property :contents-begin element)
23518 (user-error "No content for this element"))))
23519 (t (user-error "No inner element")))))
23521 (defun org-drag-element-backward ()
23522 "Move backward element at point."
23523 (interactive)
23524 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23525 (let* ((trail (org-element-at-point 'keep-trail))
23526 (elem (car trail))
23527 (prev-elem (nth 1 trail)))
23528 ;; Error out if no previous element or previous element is
23529 ;; a parent of the current one.
23530 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23531 (user-error "Cannot drag element backward")
23532 (let ((pos (point)))
23533 (org-element-swap-A-B prev-elem elem)
23534 (goto-char (+ (org-element-property :begin prev-elem)
23535 (- pos (org-element-property :begin elem)))))))))
23537 (defun org-drag-element-forward ()
23538 "Move forward element at point."
23539 (interactive)
23540 (let* ((pos (point))
23541 (elem (org-element-at-point)))
23542 (when (= (point-max) (org-element-property :end elem))
23543 (user-error "Cannot drag element forward"))
23544 (goto-char (org-element-property :end elem))
23545 (let ((next-elem (org-element-at-point)))
23546 (when (or (org-element-nested-p elem next-elem)
23547 (and (eq (org-element-type next-elem) 'headline)
23548 (not (eq (org-element-type elem) 'headline))))
23549 (goto-char pos)
23550 (user-error "Cannot drag element forward"))
23551 ;; Compute new position of point: it's shifted by NEXT-ELEM
23552 ;; body's length (without final blanks) and by the length of
23553 ;; blanks between ELEM and NEXT-ELEM.
23554 (let ((size-next (- (save-excursion
23555 (goto-char (org-element-property :end next-elem))
23557 (forward-line)
23558 ;; Small correction if buffer doesn't end
23559 ;; with a newline character.
23560 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23561 (org-element-property :begin next-elem)))
23562 (size-blank (- (org-element-property :end elem)
23563 (save-excursion
23564 (goto-char (org-element-property :end elem))
23566 (forward-line)
23567 (point)))))
23568 (org-element-swap-A-B elem next-elem)
23569 (goto-char (+ pos size-next size-blank))))))
23571 (defun org-drag-line-forward (arg)
23572 "Drag the line at point ARG lines forward."
23573 (interactive "p")
23574 (dotimes (n (abs arg))
23575 (let ((c (current-column)))
23576 (if (< 0 arg)
23577 (progn
23578 (beginning-of-line 2)
23579 (transpose-lines 1)
23580 (beginning-of-line 0))
23581 (transpose-lines 1)
23582 (beginning-of-line -1))
23583 (org-move-to-column c))))
23585 (defun org-drag-line-backward (arg)
23586 "Drag the line at point ARG lines backward."
23587 (interactive "p")
23588 (org-drag-line-forward (- arg)))
23590 (defun org-mark-element ()
23591 "Put point at beginning of this element, mark at end.
23593 Interactively, if this command is repeated or (in Transient Mark
23594 mode) if the mark is active, it marks the next element after the
23595 ones already marked."
23596 (interactive)
23597 (let (deactivate-mark)
23598 (if (and (org-called-interactively-p 'any)
23599 (or (and (eq last-command this-command) (mark t))
23600 (and transient-mark-mode mark-active)))
23601 (set-mark
23602 (save-excursion
23603 (goto-char (mark))
23604 (goto-char (org-element-property :end (org-element-at-point)))))
23605 (let ((element (org-element-at-point)))
23606 (end-of-line)
23607 (push-mark (org-element-property :end element) t t)
23608 (goto-char (org-element-property :begin element))))))
23610 (defun org-narrow-to-element ()
23611 "Narrow buffer to current element."
23612 (interactive)
23613 (let ((elem (org-element-at-point)))
23614 (cond
23615 ((eq (car elem) 'headline)
23616 (narrow-to-region
23617 (org-element-property :begin elem)
23618 (org-element-property :end elem)))
23619 ((memq (car elem) org-element-greater-elements)
23620 (narrow-to-region
23621 (org-element-property :contents-begin elem)
23622 (org-element-property :contents-end elem)))
23623 (t
23624 (narrow-to-region
23625 (org-element-property :begin elem)
23626 (org-element-property :end elem))))))
23628 (defun org-transpose-element ()
23629 "Transpose current and previous elements, keeping blank lines between.
23630 Point is moved after both elements."
23631 (interactive)
23632 (org-skip-whitespace)
23633 (let ((end (org-element-property :end (org-element-at-point))))
23634 (org-drag-element-backward)
23635 (goto-char end)))
23637 (defun org-unindent-buffer ()
23638 "Un-indent the visible part of the buffer.
23639 Relative indentation (between items, inside blocks, etc.) isn't
23640 modified."
23641 (interactive)
23642 (unless (eq major-mode 'org-mode)
23643 (user-error "Cannot un-indent a buffer not in Org mode"))
23644 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23645 unindent-tree ; For byte-compiler.
23646 (unindent-tree
23647 (function
23648 (lambda (contents)
23649 (mapc
23650 (lambda (element)
23651 (if (memq (org-element-type element) '(headline section))
23652 (funcall unindent-tree (org-element-contents element))
23653 (save-excursion
23654 (save-restriction
23655 (narrow-to-region
23656 (org-element-property :begin element)
23657 (org-element-property :end element))
23658 (org-do-remove-indentation)))))
23659 (reverse contents))))))
23660 (funcall unindent-tree (org-element-contents parse-tree))))
23662 (defun org-show-subtree ()
23663 "Show everything after this heading at deeper levels."
23664 (interactive)
23665 (outline-flag-region
23666 (point)
23667 (save-excursion
23668 (org-end-of-subtree t t))
23669 nil))
23671 (defun org-show-entry ()
23672 "Show the body directly following this heading.
23673 Show the heading too, if it is currently invisible."
23674 (interactive)
23675 (save-excursion
23676 (condition-case nil
23677 (progn
23678 (org-back-to-heading t)
23679 (outline-flag-region
23680 (max (point-min) (1- (point)))
23681 (save-excursion
23682 (if (re-search-forward
23684 (match-beginning 1)
23685 (point-max)))
23686 nil)
23687 (org-cycle-hide-drawers 'children))
23688 (error nil))))
23690 (defun org-make-options-regexp (kwds &optional extra)
23691 "Make a regular expression for keyword lines."
23692 (concat
23698 ;; Make isearch reveal the necessary context
23699 (defun org-isearch-end ()
23700 "Reveal context after isearch exits."
23701 (when isearch-success ; only if search was successful
23702 (if (featurep 'xemacs)
23703 ;; Under XEmacs, the hook is run in the correct place,
23704 ;; we directly show the context.
23705 (org-show-context 'isearch)
23706 ;; In Emacs the hook runs *before* restoring the overlays.
23707 ;; So we have to use a one-time post-command-hook to do this.
23708 ;; (Emacs 22 has a special variable, see function `org-mode')
23709 (unless (and (boundp 'isearch-mode-end-hook-quit)
23710 isearch-mode-end-hook-quit)
23711 ;; Only when the isearch was not quitted.
23712 (org-add-hook 'post-command-hook 'org-isearch-post-command
23713 'append 'local)))
23714 (org-fix-ellipsis-at-bol)))
23716 (defun org-isearch-post-command ()
23717 "Remove self from hook, and show context."
23718 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23719 (org-show-context 'isearch))
23722 ;;;; Integration with and fixes for other packages
23724 ;;; Imenu support
23726 (defvar org-imenu-markers nil
23727 "All markers currently used by Imenu.")
23728 (make-variable-buffer-local 'org-imenu-markers)
23730 (defun org-imenu-new-marker (&optional pos)
23731 "Return a new marker for use by Imenu, and remember the marker."
23732 (let ((m (make-marker)))
23733 (move-marker m (or pos (point)))
23734 (push m org-imenu-markers)
23735 m))
23737 (defun org-imenu-get-tree ()
23738 "Produce the index for Imenu."
23739 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23740 (setq org-imenu-markers nil)
23741 (let* ((n org-imenu-depth)
23742 (re (concat "^" (org-get-limited-outline-regexp)))
23743 (subs (make-vector (1+ n) nil))
23744 (last-level 0)
23745 m level head0 head)
23746 (save-excursion
23747 (save-restriction
23748 (widen)
23749 (goto-char (point-max))
23750 (while (re-search-backward re nil t)
23751 (setq level (org-reduced-level (funcall outline-level)))
23752 (when (and (<= level n)
23753 (looking-at org-complex-heading-regexp)
23754 (setq head0 (org-match-string-no-properties 4)))
23755 (setq head (org-link-display-format head0)
23756 m (org-imenu-new-marker))
23757 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23758 (if (>= level last-level)
23759 (push (cons head m) (aref subs level))
23760 (push (cons head (aref subs (1+ level))) (aref subs level))
23761 (loop for i from (1+ level) to n do (aset subs i nil)))
23762 (setq last-level level)))))
23763 (aref subs 1)))
23765 (eval-after-load "imenu"
23766 '(progn
23767 (add-hook 'imenu-after-jump-hook
23768 (lambda ()
23769 (if (derived-mode-p 'org-mode)
23770 (org-show-context 'org-goto))))))
23772 (defun org-link-display-format (link)
23773 "Replace a link with its the description.
23774 If there is no description, use the link target."
23775 (save-match-data
23776 (if (string-match org-bracket-link-analytic-regexp link)
23777 (replace-match (if (match-end 5)
23778 (match-string 5 link)
23779 (concat (match-string 1 link)
23780 (match-string 3 link)))
23781 nil t link)
23782 link)))
23784 (defun org-toggle-link-display ()
23785 "Toggle the literal or descriptive display of links."
23786 (interactive)
23787 (if org-descriptive-links
23788 (progn (org-remove-from-invisibility-spec '(org-link))
23789 (org-restart-font-lock)
23790 (setq org-descriptive-links nil))
23791 (progn (add-to-invisibility-spec '(org-link))
23792 (org-restart-font-lock)
23793 (setq org-descriptive-links t))))
23795 ;; Speedbar support
23797 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23798 "Overlay marking the agenda restriction line in speedbar.")
23799 (overlay-put org-speedbar-restriction-lock-overlay
23800 'face 'org-agenda-restriction-lock)
23801 (overlay-put org-speedbar-restriction-lock-overlay
23802 'help-echo "Agendas are currently limited to this item.")
23803 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23805 (defun org-speedbar-set-agenda-restriction ()
23806 "Restrict future agenda commands to the location at point in speedbar.
23808 (interactive)
23809 (require 'org-agenda)
23810 (let (p m tp np dir txt)
23811 (cond
23812 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23813 'org-imenu t))
23814 (setq m (get-text-property p 'org-imenu-marker))
23815 (with-current-buffer (marker-buffer m)
23816 (goto-char m)
23817 (org-agenda-set-restriction-lock 'subtree)))
23818 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23819 'speedbar-function 'speedbar-find-file))
23820 (setq tp (previous-single-property-change
23821 (1+ p) 'speedbar-function)
23822 np (next-single-property-change
23823 tp 'speedbar-function)
23824 dir (speedbar-line-directory)
23825 txt (buffer-substring-no-properties (or tp (point-min))
23826 (or np (point-max))))
23827 (with-current-buffer (find-file-noselect
23828 (let ((default-directory dir))
23829 (expand-file-name txt)))
23830 (unless (derived-mode-p 'org-mode)
23831 (user-error "Cannot restrict to non-Org-mode file"))
23832 (org-agenda-set-restriction-lock 'file)))
23833 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23834 (move-overlay org-speedbar-restriction-lock-overlay
23835 (point-at-bol) (point-at-eol))
23836 (setq current-prefix-arg nil)
23837 (org-agenda-maybe-redo)))
23839 (defvar speedbar-file-key-map)
23840 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23841 (eval-after-load "speedbar"
23842 '(progn
23843 (speedbar-add-supported-extension ".org")
23844 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23845 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23846 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23847 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23848 (add-hook 'speedbar-visiting-tag-hook
23849 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23851 ;;; Fixes and Hacks for problems with other packages
23853 ;; Make flyspell not check words in links, to not mess up our keymap
23854 (defvar org-element-affiliated-keywords) ; From org-element.el
23855 (defvar org-element-block-name-alist) ; From org-element.el
23856 (defun org-mode-flyspell-verify ()
23857 "Don't let flyspell put overlays at active buttons, or on
23858 {todo,all-time,additional-option-like}-keywords."
23859 (require 'org-element) ; For `org-element-affiliated-keywords'
23860 (let ((pos (max (1- (point)) (point-min)))
23861 (word (thing-at-point 'word)))
23862 (and (not (get-text-property pos 'keymap))
23863 (not (get-text-property pos 'org-no-flyspell))
23864 (not (member word org-todo-keywords-1))
23865 (not (member word org-all-time-keywords))
23866 (not (member word org-options-keywords))
23867 (not (member word (mapcar 'car org-startup-options)))
23868 (not (member-ignore-case word org-element-affiliated-keywords))
23869 (not (member-ignore-case word (org-get-export-keywords)))
23870 (not (member-ignore-case
23871 word (mapcar 'car org-element-block-name-alist)))
23872 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23873 (not (org-in-src-block-p)))))
23875 (defun org-remove-flyspell-overlays-in (beg end)
23876 "Remove flyspell overlays in region."
23877 (and (org-bound-and-true-p flyspell-mode)
23878 (fboundp 'flyspell-delete-region-overlays)
23879 (flyspell-delete-region-overlays beg end))
23880 (add-text-properties beg end '(org-no-flyspell t)))
23882 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23883 (eval-after-load "bookmark"
23884 '(if (boundp 'bookmark-after-jump-hook)
23885 ;; We can use the hook
23886 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23887 ;; Hook not available, use advice
23888 (defadvice bookmark-jump (after org-make-visible activate)
23889 "Make the position visible."
23890 (org-bookmark-jump-unhide))))
23892 ;; Make sure saveplace shows the location if it was hidden
23893 (eval-after-load "saveplace"
23894 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23895 "Make the position visible."
23896 (org-bookmark-jump-unhide)))
23898 ;; Make sure ecb shows the location if it was hidden
23899 (eval-after-load "ecb"
23900 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23901 "Make hierarchy visible when jumping into location from ECB tree buffer."
23902 (if (derived-mode-p 'org-mode)
23903 (org-show-context))))
23905 (defun org-bookmark-jump-unhide ()
23906 "Unhide the current position, to show the bookmark location."
23907 (and (derived-mode-p 'org-mode)
23908 (or (outline-invisible-p)
23909 (save-excursion (goto-char (max (point-min) (1- (point))))
23910 (outline-invisible-p)))
23911 (org-show-context 'bookmark-jump)))
23913 ;; Make session.el ignore our circular variable
23914 (defvar session-globals-exclude)
23915 (eval-after-load "session"
23916 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23918 ;;;; Finish up
23920 (provide 'org)
23922 (run-hooks 'org-load-hook)
23924 ;;; org.el ends here