| blob | 9b4f444afae3fda5270ced1dac0cb57d7aa2a026 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
86 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
87 ;; some places -- e.g. see the macro `org-with-limited-levels'.
88 ;;
89 ;; In Org buffers, the value of `outline-regexp' is that of
90 ;; `org-outline-regexp'. The only function still directly relying on
91 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
92 ;; job when `orgstruct-mode' is active.
97 "Regexp to match Org headlines.
98 This is similar to `org-outline-regexp' but additionally makes
102 "Matches a headline, putting stars and text into groups.
105 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
118 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
163 ;; load languages based on value of `org-babel-load-languages'
166 ;;;###autoload
168 "Load the languages defined in `org-babel-load-languages'."
180 org-babel-load-languages))
182 ;;;###autoload
184 "Load Emacs Lisp source code blocks in the Org-mode FILE.
185 This function exports the source code using `org-babel-tangle'
186 and then loads the resulting file using `load-file'. With prefix
187 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
188 file to byte-code before it is loaded."
198 ;; tangle if the org-mode file is newer than the elisp file
207 exported-file)))
210 "Languages which can be evaluated in Org-mode buffers.
211 This list can be used to load support for any of the languages
212 below, note that each language will depend on a different set of
213 system executables and/or Emacs modes. When a language is
215 with `org-babel-execute-src-block' bound by default to C-c
216 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
217 be set to remove code block evaluation from the C-c C-c
218 keybinding. By default only Emacs Lisp (which has no
219 requirements) is loaded."
224 :key-type
268 ;;;; Customization variables
270 "Remove ID property of clones of a subtree.
271 When non-nil, clones of a subtree don't inherit the ID property.
272 Otherwise they inherit the ID property with a new unique
273 identifier."
278 ;;; Version
281 ;;;###autoload
283 "Show the org-mode version in the echo area.
284 With prefix argument HERE, insert it at point.
285 When FULL is non-nil, use a verbose version string.
286 When MESSAGE is non-nil, display a message with the version."
299 org-version
300 git-version
303 org-install-dir
312 _version)))
316 ;;; Compatibility constants
318 ;;; The custom variables
321 "Outline-based notes management and organizer."
327 "Mode hook for Org-mode, run after the mode was turned on."
332 "Hook that is run after org.el has been loaded."
337 "Hook that is run after an Org log buffer is created."
347 "Load all extensions listed in `org-modules'."
352 org-modules)
356 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
361 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
362 "Modules that should always be loaded together with org.el.
364 If a description starts with <C>, the file is not part of Emacs
365 and loading it will require that you have downloaded and properly
366 installed the Org mode distribution.
368 You can also use this system to load external packages (i.e. neither Org
369 core modules, nor modules from the CONTRIB directory). Just add symbols
370 to the end of the list. If the package is called org-xyz.el, then you need
371 to add the symbol `xyz', and the package must have a call to:
373 \(provide 'org-xyz)
375 For export specific modules, see also `org-export-backends'."
380 :type
405 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
414 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
419 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
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 VALUE stands for the
455 new value of the variable, after updating it:
457 \(progn
458 \(setq org-export-registered-backends
459 \(org-remove-if-not
460 \(lambda (backend)
461 \(or (memq backend val)
462 \(catch 'parentp
463 \(mapc
464 \(lambda (b)
465 \(and (org-export-derived-backend-p b (car backend))
466 \(throw 'parentp t)))
467 val)
468 nil)))
469 org-export-registered-backends))
470 \(let ((new-list (mapcar 'car org-export-registered-backends)))
471 \(dolist (backend val)
472 \(cond
475 backend))
476 \((not (memq backend new-list)) (push backend new-list))))
477 \(set-default var new-list)))
479 Adding a back-end to this list will also pull the back-end it
480 depends on, if any."
488 ;; Any back-end not required anymore (not present in VAL and not
489 ;; a parent of any back-end in the new value) is removed from the
490 ;; list of registered back-ends.
500 val)
501 nil)))
502 org-export-registered-backends))
503 ;; Now build NEW-LIST of both new back-ends and required
504 ;; parents.
510 backend))
512 ;; Set VAR to that list with fixed dependencies.
539 backend))))
540 org-export-backends))
543 "Non-nil means make shift-cursor commands select text when possible.
545 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
546 start selecting a region, or enlarge regions started in this way.
547 In Org-mode, in special contexts, these same keys are used for
548 other purposes, important enough to compete with shift selection.
549 Org tries to balance these needs by supporting `shift-select-mode'
550 outside these special contexts, under control of this variable.
552 The default of this variable is nil, to avoid confusing behavior. Shifted
553 cursor keys will then execute Org commands in the following contexts:
554 - on a headline, changing TODO state (left/right) and priority (up/down)
555 - on a time stamp, changing the time
556 - in a plain list item, changing the bullet type
557 - in a property definition line, switching between allowed values
558 - in the BEGIN line of a clock table (changing the time block).
559 Outside these contexts, the commands will throw an error.
561 When this variable is t and the cursor is not in a special
562 context, Org-mode will support shift-selection for making and
563 enlarging regions. To make this more effective, the bullet
564 cycling will no longer happen anywhere in an item line, but only
565 if the cursor is exactly on the bullet.
567 If you set this variable to the symbol `always', then the keys
568 will not be special in headlines, property lines, and item lines,
569 to make shift selection work there as well. If this is what you
570 want, you can use the following alternative commands: `C-c C-t'
571 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
572 can be used to switch TODO sets, `C-c -' to cycle item bullet
573 types, and properties can be edited by hand or in column view.
575 However, when the cursor is on a timestamp, shift-cursor commands
576 will still edit the time stamp - this is just too good to give up.
578 XEmacs user should have this variable set to nil, because
579 `shift-select-mode' is in Emacs 23 or later only."
587 "Shall some commands act upon headlines in the active region?
589 When set to `t', some commands will be performed in all headlines
590 within the active region.
592 When set to `start-level', some commands will be performed in all
593 headlines within the active region, provided that these headlines
594 are of the same level than the first one.
596 When set to a string, those commands will be performed on the
597 matching headlines within the active region. Such string must be
598 a tags/property/todo match as it is used in the agenda tags view.
600 The list of commands is: `org-schedule', `org-deadline',
601 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
602 `org-archive-to-archive-sibling'. The archiving commands skip
603 already archived entries."
613 "Options concerning startup of Org-mode."
618 "Non-nil means entering Org-mode will switch to OVERVIEW.
619 This can also be configured on a per-file basis by adding one of
620 the following lines anywhere in the buffer:
622 #+STARTUP: fold (or `overview', this is equivalent)
623 #+STARTUP: nofold (or `showall', this is equivalent)
624 #+STARTUP: content
625 #+STARTUP: showeverything
627 By default, this option is ignored when Org opens agenda files
628 for the first time. If you want the agenda to honor the startup
629 option, set `org-agenda-inhibit-startup' to nil."
638 "Non-nil means entering Org-mode will set `truncate-lines'.
639 This is useful since some lines containing links can be very long and
640 uninteresting. Also tables look terrible when wrapped."
645 "Non-nil means turn on `org-indent-mode' on startup.
646 This can also be configured on a per-file basis by adding one of
647 the following lines anywhere in the buffer:
649 #+STARTUP: indent
650 #+STARTUP: noindent"
658 When this option is turned on, you can use TeX-like syntax for sub- and
660 considered as a single item - so grouping with {} is normally not
661 needed. For example, the following things will be parsed as single
662 sub- or superscripts.
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible - so when in doubt use {} to enclose
671 the sub/superscript. If you set this variable to the symbol
672 `{}', the braces are *required* in order to trigger
673 interpretations as sub/superscript. This can be helpful in
683 "Non-nil means turn on `org-beamer-mode' on startup.
684 This can also be configured on a per-file basis by adding one of
685 the following lines anywhere in the buffer:
687 #+STARTUP: beamer"
693 "Non-nil means align all tables when visiting a file.
694 This is useful when the column width in tables is forced with <N> cookies
695 in table fields. Such tables will look correct only after the first re-align.
696 This can also be configured on a per-file basis by adding one of
697 the following lines anywhere in the buffer:
698 #+STARTUP: align
699 #+STARTUP: noalign"
704 "Non-nil means show inline images when loading a new Org file.
705 This can also be configured on a per-file basis by adding one of
706 the following lines anywhere in the buffer:
707 #+STARTUP: inlineimages
708 #+STARTUP: noinlineimages"
714 "Non-nil means preview LaTeX fragments when loading a new Org file.
716 This can also be configured on a per-file basis by adding one of
717 the followinglines anywhere in the buffer:
718 #+STARTUP: latexpreview
719 #+STARTUP: nolatexpreview"
726 "Non-nil means insert the first line setting Org-mode in empty files.
727 When the function `org-mode' is called interactively in an empty file, this
728 normally means that the file name does not automatically trigger Org-mode.
729 To ensure that the file will always be in Org-mode in the future, a
730 line enforcing Org-mode will be inserted into the buffer, if this option
731 has been set."
736 "Non-nil means use alternative key bindings for some keys.
737 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
738 These keys are also used by other packages like shift-selection-mode'
739 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
740 If you want to use Org-mode together with one of these other modes,
741 or more generally if you would like to move some Org-mode commands to
742 other keys, set this variable and configure the keys with the variable
743 `org-disputed-keys'.
745 This option is only relevant at load-time of Org-mode, and must be set
746 *before* org.el is loaded. Changing it requires a restart of Emacs to
747 become effective."
752 "Non-nil means use extra key sequence definitions for certain commands.
753 This happens automatically if you run XEmacs or if `window-system'
754 is nil. This variable lets you do the same manually. You must
755 set it before loading org.
757 Example: on Carbon Emacs 22 running graphically, with an external
758 keyboard on a Powerbook, the default way of setting M-left might
759 not work for either Alt or ESC. Setting this variable will make
760 it work for ESC."
773 "Keys for which Org-mode and other modes compete.
774 This is an alist, cars are the default keys, second element specifies
775 the alternative to use when `org-replace-disputed-keys' is t.
777 Keys can be specified in any syntax supported by `define-key'.
778 The value of this option takes effect only at Org-mode's startup,
779 therefore you'll have to restart Emacs to apply it after changing."
784 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
785 Or return the original if not disputed.
786 Also apply the translations defined in `org-xemacs-key-equivalents'."
791 org-disputed-keys)))
795 key)
805 "Define a key, possibly translated, as returned by `org-key'."
809 "The ellipsis to use in the Org-mode outline.
810 When nil, just use the standard three dots. When a string, use that instead,
811 When a face, use the standard 3 dots, but with the specified face.
812 The change affects only Org-mode (which will then use its own display table).
813 Changing this requires executing `M-x org-mode' in a buffer to become
814 effective."
824 "Keywords in Org-mode."
829 "String to mark deadline entries.
830 A deadline is this string, followed by a time stamp. Should be a word,
831 terminated by a colon. You can insert a schedule keyword and
833 Changes become only effective after restarting Emacs."
838 "String to mark scheduled TODO entries.
839 A schedule is this string, followed by a time stamp. Should be a word,
840 terminated by a colon. You can insert a schedule keyword and
842 Changes become only effective after restarting Emacs."
847 "String used as the prefix for timestamps logging closing a TODO entry."
852 "String used as prefix for timestamps clocking work hours on an item."
857 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
872 "Entries starting with this keyword will never be exported.
873 An entry can be toggled between COMMENT and normal with
875 Changes become only effective after restarting Emacs."
880 "Entries starting with this keyword will be exported in fixed-width font.
881 Quoting applies only to the text in the entry following the headline, and does
882 not extend beyond the next headline, even if that is lower level.
883 An entry can be toggled between QUOTE and normal with
890 "Regular expression for specifying repeated events.
894 "Options concerning the general structure of Org-mode files."
899 "Options about how to make context of a location visible."
923 "Non-nil means show full hierarchy when revealing a location.
924 Org-mode often shows locations in an org-mode file which might have
925 been invisible before. When this is set, the hierarchy of headings
926 above the exposed location is shown.
927 Turning this off for example for sparse trees makes them very compact.
928 Instead of t, this can also be an alist specifying this option for different
929 contexts. Valid contexts are
930 agenda when exposing an entry from the agenda
931 org-goto when using the command `org-goto' on key C-c C-j
932 occur-tree when using the command `org-occur' on key C-c /
933 tags-tree when constructing a sparse tree based on tags matches
934 link-search when exposing search matches associated with a link
935 mark-goto when exposing the jump goal of a mark
936 bookmark-jump when exposing a bookmark location
937 isearch when exiting from an incremental search
938 default default for all contexts not set explicitly"
943 "Non-nil means show following heading when revealing a location.
944 Org-mode often shows locations in an org-mode file which might have
945 been invisible before. When this is set, the heading following the
946 match is shown.
947 Turning this off for example for sparse trees makes them very compact,
948 but makes it harder to edit the location of the match. In such a case,
950 Instead of t, this can also be an alist specifying this option for different
951 contexts. See `org-show-hierarchy-above' for valid contexts."
956 "Non-nil means show all sibling heading when revealing a location.
957 Org-mode often shows locations in an org-mode file which might have
958 been invisible before. When this is set, the sibling of the current entry
959 heading are all made visible. If `org-show-hierarchy-above' is t,
960 the same happens on each level of the hierarchy above the current entry.
962 By default this is on for the isearch context, off for all other contexts.
963 Turning this off for example for sparse trees makes them very compact,
964 but makes it harder to edit the location of the match. In such a case,
966 Instead of t, this can also be an alist specifying this option for different
967 contexts. See `org-show-hierarchy-above' for valid contexts."
969 :type org-context-choice
974 "Non-nil means show the entry below a headline when revealing a location.
975 Org-mode often shows locations in an org-mode file which might have
976 been invisible before. When this is set, the text below the headline that is
977 exposed is also shown.
979 By default this is off for all contexts.
980 Instead of t, this can also be an alist specifying this option for different
981 contexts. See `org-show-hierarchy-above' for valid contexts."
986 "How should indirect tree buffers be displayed?
987 This applies to indirect buffers created with the commands
989 Valid values are:
990 current-window Display in the current window
991 other-window Just display in another window.
992 dedicated-frame Create one new frame, and re-use it each time.
993 new-frame Make a new frame each time. Note that in this case
994 previously-made indirect buffers are kept, and you need to
995 kill these buffers yourself."
1005 "Non-nil means activate single letter commands at beginning of a headline.
1006 This may also be a function to test for appropriate locations where speed
1007 commands should be active."
1015 "Alist of additional speed commands.
1016 This list will be checked before `org-speed-commands-default'
1017 when the variable `org-use-speed-commands' is non-nil
1018 and when the cursor is at the beginning of a headline.
1019 The car if each entry is a string with a single letter, which must
1020 be assigned to `self-insert-command' in the global map.
1021 The cdr is either a command to be called interactively, a function
1022 to be called, or a form to be evaluated.
1023 An entry that is just a list with a single string will be interpreted
1024 as a descriptive headline that will be added when listing the speed
1025 commands in the Help buffer using the `?' speed command."
1037 "Options concerning visibility cycling in Org-mode."
1042 "Non-nil means skip CHILDREN state in entries that don't have any."
1047 "Maximum level which should still be subject to visibility cycling.
1048 Levels higher than this will, for cycling, be treated as text, not a headline.
1049 When `org-odd-levels-only' is set, a value of N in this variable actually
1050 means 2N-1 stars as the limiting headline.
1051 When nil, cycle all levels.
1052 Note that the limiting level of cycling is also influenced by
1053 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1054 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1055 than its value."
1062 "Names of drawers. Drawers are not opened by cycling on the headline above.
1063 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1064 this:
1065 :DRAWERNAME:
1066 .....
1067 :END:
1069 the property API.
1071 Drawers can be defined on the per-file basis with a line like:
1073 #+DRAWERS: HIDDEN STATE PROPERTIES"
1079 "Non-nil means entering Org-mode will fold all blocks.
1080 This can also be set in on a per-file basis with
1082 #+STARTUP: hideblocks
1083 #+STARTUP: showblocks"
1089 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1090 This makes it possible to do global cycling without having to use S-TAB or
1092 of the buffer must not be a headline -- it may be empty or some other text.
1093 When used in this way, `org-cycle-hook' is disabled temporarily to make
1094 sure the cursor stays at the beginning of the buffer. When this option is
1095 nil, don't do anything special at the beginning of the buffer."
1100 "Non-nil means cycle entry level or item indentation in new empty entries.
1102 When the cursor is at the end of an empty headline, i.e., with only stars
1103 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1104 and then all possible ancestor states, before returning to the original state.
1105 This makes data entry extremely fast: M-RET to create a new headline,
1106 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1108 When the cursor is at the end of an empty plain list item, one TAB will
1109 make it a subitem, two or more tabs will back up to make this an item
1110 higher up in the item hierarchy."
1115 "Where should `org-cycle' emulate TAB.
1116 nil Never
1117 white Only in completely white lines
1118 whitestart Only at the beginning of lines, before the first non-white char
1119 t Everywhere except in headlines
1120 exc-hl-bol Everywhere except at the start of a headline
1121 If TAB is used in a place where it does not emulate TAB, the current subtree
1122 visibility is cycled."
1131 "Number of empty lines needed to keep an empty line between collapsed trees.
1132 If you leave an empty line between the end of a subtree and the following
1133 headline, this empty line is hidden when the subtree is folded.
1134 Org-mode will leave (exactly) one empty line visible if the number of
1135 empty lines is equal or larger to the number given in this variable.
1136 So the default 2 means at least 2 empty lines after the end of a subtree
1137 are needed to produce free space between a collapsed subtree and the
1138 following headline.
1140 If the number is negative, and the number of empty lines is at least -N,
1141 all empty lines are shown.
1143 Special case: when 0, never leave empty lines in collapsed view."
1149 "Hook that is run before visibility cycling is happening.
1150 The function(s) in this hook must accept a single argument which indicates
1151 the new state that will be set right after running this hook. The
1152 argument is a symbol. Before a global state change, it can have the values
1153 `overview', `content', or `all'. Before a local state change, it can have
1154 the values `folded', `children', or `subtree'."
1159 org-cycle-hide-drawers
1160 org-cycle-hide-inline-tasks
1161 org-cycle-show-empty-lines
1162 org-optimize-window-after-visibility-change)
1163 "Hook that is run after `org-cycle' has changed the buffer visibility.
1164 The function(s) in this hook must accept a single argument which indicates
1165 the new state that was set by the most recent `org-cycle' command. The
1166 argument is a symbol. After a global state change, it can have the values
1167 `overview', `contents', or `all'. After a local state change, it can have
1168 the values `folded', `children', or `subtree'."
1173 "Options concerning structure editing in Org-mode."
1178 "Non-nil means skip even levels and only use odd levels for the outline.
1179 This has the effect that two stars are being added/taken away in
1180 promotion/demotion commands. It also influences how levels are
1181 handled by the exporters.
1182 Changing it requires restart of `font-lock-mode' to become effective
1183 for fontification also in regions already fontified.
1184 You may also set this on a per-file basis by adding one of the following
1185 lines to the buffer:
1187 #+STARTUP: odd
1188 #+STARTUP: oddeven"
1194 "Non-nil means adapt indentation to outline node level.
1196 When this variable is set, Org assumes that you write outlines by
1197 indenting text in each node to align with the headline (after the stars).
1198 The following issues are influenced by this variable:
1200 - When this is set and the *entire* text in an entry is indented, the
1201 indentation is increased by one space in a demotion command, and
1202 decreased by one in a promotion command. If any line in the entry
1203 body starts with text at column 0, indentation is not changed at all.
1205 - Property drawers and planning information is inserted indented when
1206 this variable s set. When nil, they will not be indented.
1208 - TAB indents a line relative to context. The lines below a headline
1209 will be indented when this variable is set.
1211 Note that this is all about true indentation, by adding and removing
1212 space characters. See also `org-indent.el' which does level-dependent
1213 indentation in a virtual way, i.e. at display time in Emacs."
1218 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1220 When t, `C-a' will bring back the cursor to the beginning of the
1221 headline text, i.e. after the stars and after a possible TODO
1222 keyword. In an item, this will be the position after bullet and
1223 check-box, if any. When the cursor is already at that position,
1224 another `C-a' will bring it to the beginning of the line.
1226 `C-e' will jump to the end of the headline, ignoring the presence
1227 of tags in the headline. A second `C-e' will then jump to the
1228 true end of the line, after any tags. This also means that, when
1229 this variable is non-nil, `C-e' also will never jump beyond the
1230 end of the heading of a folded section, i.e. not after the
1231 ellipses.
1233 When set to the symbol `reversed', the first `C-a' or `C-e' works
1234 normally, going to the true line boundary first. Only a directly
1235 following, identical keypress will bring the cursor to the
1236 special positions.
1238 This may also be a cons cell where the behavior for `C-a' and
1239 `C-e' is set separately."
1257 "Non-nil means `C-k' will behave specially in headlines.
1258 When nil, `C-k' will call the default `kill-line' command.
1259 When t, the following will happen while the cursor is in the headline:
1261 - When the cursor is at the beginning of a headline, kill the entire
1262 line and possible the folded subtree below the line.
1263 - When in the middle of the headline text, kill the headline up to the tags.
1264 - When after the headline text, kill the tags."
1269 "Non-nil means, do not delete a hidden subtree with C-k.
1270 When set to the symbol `error', simply throw an error when C-k is
1271 used to kill (part-of) a headline that has hidden text behind it.
1272 Any other non-nil value will result in a query to the user, if it is
1273 OK to kill that hidden subtree. When nil, kill without remorse."
1282 "Check if in invisible region before inserting or deleting a character.
1283 Valid values are:
1285 nil Do not check, so just do invisible edits.
1286 error Throw an error and do nothing.
1287 show Make point visible, and do the requested edit.
1288 show-and-error Make point visible, then throw an error and abort the edit.
1289 smart Make point visible, and do insertion/deletion if it is
1290 adjacent to visible text and the change feels predictable.
1291 Never delete a previously invisible character or add in the
1292 middle or right after an invisible region. Basically, this
1293 allows insertion and backward-delete right before ellipses.
1294 FIXME: maybe in this case we should not even show?"
1305 "Non-nil means when yanking subtrees, fold them.
1306 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1307 it starts with a heading and all other headings in it are either children
1308 or siblings, then fold all the subtrees. However, do this only if no
1309 text after the yank would be swallowed into a folded tree by this action."
1314 "Non-nil means when yanking subtrees, adjust the level.
1315 With this setting, `org-paste-subtree' is used to insert the subtree, see
1316 this function for details."
1321 "Non-nil means M-RET will split the line at the cursor position.
1322 When nil, it will go to the end of the line before making a
1323 new line.
1324 You may also set this option in a different way for different
1325 contexts. Valid contexts are:
1327 headline when creating a new headline
1328 item when creating a new item
1329 table in a table field
1330 default the value to be used for all contexts not explicitly
1331 customized"
1348 "Non-nil means insert new headings after the current subtree.
1349 When nil, the new heading is created directly after the current line.
1350 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1351 this variable on for the duration of the command."
1357 "Should `org-insert-heading' leave a blank line before new heading/item?
1358 The value is an alist, with `heading' and `plain-list-item' as CAR,
1359 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1360 which case Org will look at the surrounding headings/items and try to
1361 make an intelligent decision whether to insert a blank line or not.
1363 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1364 the setting here is ignored and no empty line is inserted to avoid breaking
1365 the list structure."
1378 "Hook being run after inserting a new heading."
1384 This currently only means they are never auto-wrapped.
1385 When nil, such lines will be treated like ordinary lines.
1386 See also the QUOTE keyword."
1391 "Non-nil means typing characters in `org-goto' starts incremental search.
1392 When nil, you can use these keybindings to navigate the buffer:
1394 q Quit the org-goto interface
1395 n Go to the next visible heading
1396 p Go to the previous visible heading
1397 f Go one heading forward on same level
1398 b Go one heading backward on same level
1399 u Go one heading up"
1404 "Options concerning sparse trees in Org-mode."
1409 "Non-nil means highlight all matches that define a sparse tree.
1410 The highlights will automatically disappear the next time the buffer is
1411 changed by an edit command."
1416 "Non-nil means any change to the buffer will remove temporary highlights.
1417 Such highlights are created by `org-occur' and `org-clock-display'.
1418 When nil, `C-c C-c needs to be used to get rid of the highlights.
1419 The highlights created by `org-preview-latex-fragment' always need
1420 `C-c C-c' to be removed."
1427 "Hook that is run after `org-occur' has constructed a sparse tree.
1428 This can be used to recenter the window to show as much of the structure
1429 as possible."
1434 "Options concerning imenu and speedbar in Org-mode."
1439 "The maximum level for Imenu access to Org-mode headlines.
1440 This also applied for speedbar access."
1445 "Options concerning tables in Org-mode."
1451 When nil, such lines will be treated like ordinary lines.
1453 When equal to the symbol `optimized', the table editor will be optimized to
1454 do the following:
1455 - Automatic overwrite mode in front of whitespace in table fields.
1456 This makes the structure of the table stay in tact as long as the edited
1457 field does not exceed the column width.
1458 - Minimize the number of realigns. Normally, the table is aligned each time
1459 TAB or RET are pressed to move to another field. With optimization this
1460 happens only if changes to a field might have changed the column width.
1461 Optimization requires replacing the functions `self-insert-command',
1462 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1463 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1464 very good at guessing when a re-align will be necessary, but you can always
1467 If you would like to use the optimized version in Org-mode, but the
1468 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1470 This variable can be used to turn on and off the table editor during a session,
1471 but in order to toggle optimization, a restart is required.
1473 See also the variable `org-table-auto-blank-field'."
1482 "Non-nil means cluster self-insert commands for undo when possible.
1483 If this is set, then, like in the Emacs command loop, 20 consecutive
1484 characters will be undone together.
1485 This is configurable, because there is some impact on typing performance."
1490 "Non-nil means TAB will automatically notice a table.el table.
1491 When it sees such a table, it moves point into it and - if necessary -
1492 calls `table-recognize-table'."
1497 "Options concerning links in Org-mode."
1502 "Buffer-local version of `org-link-abbrev-alist', which see.
1507 "Alist of link abbreviations.
1508 The car of each element is a string, to be replaced at the start of a link.
1510 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1512 [[linkkey:tag][description]]
1514 The 'linkkey' must be a word word, starting with a letter, followed
1515 by letters, numbers, '-' or '_'.
1517 If REPLACE is a string, the tag will simply be appended to create the link.
1520 at that point (see the function `url-hexify-string'). If the string contains
1522 be invoked: this function takes the tag as its only argument and must return
1523 a string.
1525 REPLACE may also be a function that will be called with the tag as the
1526 only argument to create the link, which should be returned as a string.
1528 See the manual for examples."
1538 "Non-nil means Org will display descriptive links.
1539 E.g. [[http://orgmode.org][Org website]] will be displayed as
1541 description. When set to `nil', Org will display the full links
1542 literally.
1544 You can interactively set the value of this variable by calling
1545 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1550 "How the path name in file links should be stored.
1551 Valid values are:
1553 relative Relative to the current directory, i.e. the directory of the file
1554 into which the link is being inserted.
1555 absolute Absolute path, if possible with ~ for home directory.
1556 noabbrev Absolute path, no abbreviation of home directory.
1557 adaptive Use relative path for files in the current directory and sub-
1558 directories of it. For other files, use an absolute path."
1567 "Types of links that should be activated in Org-mode files.
1568 This is a list of symbols, each leading to the activation of a certain link
1569 type. In principle, it does not hurt to turn on most link types - there may
1570 be a small gain when turning off unused link types. The types are:
1572 bracket The recommended [[link][description]] or [[link]] links with hiding.
1573 angle Links in angular brackets that may contain whitespace like
1574 <bbdb:Carsten Dominik>.
1575 plain Plain links in normal text, no whitespace, like http://google.com.
1576 radio Text that is matched by a radio target, see manual for details.
1577 tag Tag settings in a headline (link to tag search).
1578 date Time stamps (link to calendar).
1579 footnote Footnote labels.
1581 Changing this variable requires a restart of Emacs to become effective."
1593 "Function to use for generating link descriptions from links.
1594 When nil, the link location will be used. This function must take
1595 two parameters: the first one is the link, the second one is the
1596 description generated by `org-insert-link'. The function should
1597 return the description to use."
1602 "Options concerning storing links in Org-mode."
1607 "When non-nil, hexify URL when creating a link."
1613 "Format of the description part of a link to an email or usenet message.
1614 The following %-escapes will be replaced by corresponding information:
1622 %s subject
1623 %d date
1624 %m message-id.
1626 You may use normal field width specification between the % and the letter.
1627 This is for example useful to limit the length of the subject.
1641 It should match if the message is from the user him/herself."
1646 "Non-nil means file links from `org-store-link' contain context.
1647 A search string will be added to the file name with :: as separator and
1648 used to find the context when the link is activated by the command
1649 `org-open-at-point'. When this option is t, the entire active region
1650 will be placed in the search string of the file link. If set to a
1651 positive integer, only the first n lines of context will be stored.
1654 negates this setting for the duration of the command."
1659 "Non-nil means keep link in list for entire session.
1661 The command `org-store-link' adds a link pointing to the current
1662 location to an internal list. These links accumulate during a session.
1663 The command `org-insert-link' can be used to insert links into any
1664 Org-mode file (offering completion for all stored links). When this
1666 will be removed from the list, to make completing the unused links
1667 more efficient."
1672 "Options concerning following links in Org-mode."
1677 "Function to translate links with different syntax to Org syntax.
1678 This can be used to translate links created for example by the Planner
1679 or emacs-wiki packages to Org syntax.
1680 The function must accept two parameters, a TYPE containing the link
1682 which is everything after the link protocol. It should return a cons
1683 with possibly modified values of type and path.
1684 Org contains a function for this, so if you set this variable to
1685 `org-translate-link-from-planner', you should be able follow many
1686 links created by planner."
1691 "Hook that is run after a link has been followed."
1696 "Non-nil means on links TAB will follow the link.
1697 Needs to be set before org.el is loaded.
1698 This really should not be used, it does not make sense, and the
1699 implementation is bad."
1704 "Non-nil means on links RET will follow the link.
1705 In tables, the special behavior of RET has precedence."
1711 "Non-nil means mouse-1 on a link will follow the link.
1712 A longer mouse click will still set point. Does not work on XEmacs.
1713 Needs to be set before org.el is loaded."
1718 "Number of different positions to be recorded in the ring.
1719 Changing this requires a restart of Emacs to work correctly."
1724 "Non-nil means internal links in Org files must exactly match a headline.
1725 When nil, the link search tries to match a phrase with all words
1726 in the search text."
1733 query-to-create)))
1741 "Setup the frame configuration for following links.
1742 When following a link with Emacs, it may often be useful to display
1743 this link in another window or frame. This variable can be used to
1744 set this up for the different types of links.
1745 For VM, use any of
1746 `vm-visit-folder'
1747 `vm-visit-folder-other-window'
1748 `vm-visit-folder-other-frame'
1749 For Gnus, use any of
1750 `gnus'
1751 `gnus-other-frame'
1752 `org-gnus-no-new-news'
1753 For FILE, use any of
1754 `find-file'
1755 `find-file-other-window'
1756 `find-file-other-frame'
1757 For Wanderlust use any of
1758 `wl'
1759 `wl-other-frame'
1760 For the calendar, use the variable `calendar-setup'.
1761 For BBDB, it is currently only possible to display the matches in
1762 another window."
1786 "Non-nil means use indirect buffer to display infile links.
1787 Activating internal links (from one location in a file to another location
1788 in the same file) normally just jumps to the location. When the link is
1790 is displayed in
1791 another window. When this option is set, the other window actually displays
1792 an indirect buffer clone of the current buffer, to avoid any visibility
1793 changes to the current buffer."
1798 "Non-nil means `org-open-file' will open non-existing files.
1799 When nil, an error will be generated.
1800 This variable applies only to external applications because they
1801 might choke on non-existing files. If the link is to a file that
1802 will be opened in Emacs, the variable is ignored."
1807 "Non-nil means a link to a directory really means to index.org.
1808 When nil, following a directory link will run dired or open a finder/explorer
1809 window on that directory."
1814 "Function and arguments to call for following mailto links.
1815 This is a list with the first element being a Lisp function, and the
1816 remaining elements being arguments to the function. In string arguments,
1817 %a will be replaced by the address, and %s will be replaced by the subject
1818 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1827 "Non-nil means ask for confirmation before executing shell links.
1828 Shell links can be dangerous: just think about a link
1830 [[shell:rm -rf ~/*][Google Search]]
1833 but really it would remove your entire home directory.
1834 Therefore we advise against setting this variable to nil.
1835 Just change it to `y-or-n-p' if you want to confirm with a
1843 'safe-local-variable
1847 "A regexp to skip confirmation for shell links."
1853 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1854 Elisp links can be dangerous: just think about a link
1859 but really it would remove your entire home directory.
1860 Therefore we advise against setting this variable to nil.
1861 Just change it to `y-or-n-p' if you want to confirm with a
1869 'safe-local-variable
1873 "A regexp to skip confirmation for Elisp links."
1882 "Default file applications on a UNIX or GNU/Linux system.
1893 "Default file applications on a MacOS X system.
1895 for some files for which the OS does not have a good default.
1903 'mswindows-shell-execute
1908 'mswindows-shell-execute
1911 "Default file applications on a Windows NT system.
1920 "External applications for opening `file:path' items in a document.
1921 Org-mode uses system defaults for different file types, but
1922 you can use this variable to set the application for a given file
1923 extension. The entries in this list are cons cells where the car identifies
1924 files and the cdr the corresponding command. Possible values for the
1925 file identifier are
1927 ways, depending on its contents:
1929 - Alphanumeric characters only:
1930 Match links with this file extension.
1932 to open PDFs with evince.
1934 - Regular expression: Match links where the
1935 filename matches the regexp. If you want to
1936 use groups here, use shy groups.
1940 to open *.html and *.xhtml with firefox.
1942 - Regular expression which contains (non-shy) groups:
1944 anything after that, matches the regexp.
1945 In a custom command string, %1, %2, etc. are replaced with
1946 the parts of the link that were matched by the groups.
1947 For backwards compatibility, if a command string is given
1948 that does not use any of the group matches, this case is
1949 handled identically to the second one (i.e. match against
1950 file name only).
1951 In a custom lisp form, you can access the group matches with
1952 (match-string n link).
1955 to open [[file:document.pdf::5]] with evince at page 5.
1957 `directory' Matches a directory
1958 `remote' Matches a remote file, accessible through tramp or efs.
1959 Remote files most likely should be visited through Emacs
1960 because external applications cannot handle such paths.
1961 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1962 so all files Emacs knows how to handle. Using this with
1963 command `emacs' will open most files in Emacs. Beware that this
1964 will also open html files inside Emacs, unless you add
1966 t Default for files not matched by any of the other options.
1967 `system' The system command to open files, like `open' on Windows
1968 and Mac OS X, and mailcap under GNU/Linux. This is the command
1969 that will be selected if you call `C-c C-o' with a double
1972 Possible values for the command are:
1973 `emacs' The file will be visited by the current Emacs process.
1974 `default' Use the default application for this file type, which is the
1975 association for t in the list, most likely in the system-specific
1976 part.
1977 This can be used to overrule an unwanted setting in the
1978 system-specific variable.
1980 This command is specified by the entry whose car is `system'.
1981 Most likely, the system-specific version of this variable
1982 does define this command, but you can overrule/replace it
1983 here.
1984 string A command to be executed by a shell; %s will be replaced
1985 by the path to the file.
1986 sexp A Lisp form which will be evaluated. The file path will
1987 be available in the Lisp variable `file'.
1988 For more examples, see the system specific constants
1989 `org-file-apps-defaults-macosx'
1990 `org-file-apps-defaults-windowsnt'
1991 `org-file-apps-defaults-gnu'."
2001 auto-mode))
2010 "The URL of the DOI server."
2016 "Options concerning refiling entries in Org-mode."
2021 "Directory with org files.
2022 This is just a default location to look for Org files. There is no need
2023 at all to put your files into this directory. It is only used in the
2024 following situations:
2026 1. When a capture template specifies a target file that is not an
2027 absolute path. The path will then be interpreted relative to
2028 `org-directory'
2029 2. When a capture note is filed away in an interactive way (when exiting the
2030 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2031 with `org-directory' as the default path."
2038 "Default target for storing notes.
2039 Used as a fall back file for org-remember.el and org-capture.el, for
2040 templates that do not specify a target file."
2046 file))
2049 "The default interface to be used for `org-goto'.
2050 Allowed values are:
2051 outline The interface shows an outline of the relevant file
2052 and the correct heading is found by moving through
2053 the outline or by searching with incremental search.
2054 outline-path-completion Headlines in the current buffer are offered via
2055 completion. This is the interface also used by
2056 the refile command."
2063 "Maximum target level when running `org-goto' with refile interface."
2068 "Non-nil means store new notes at the beginning of a file or entry.
2069 When nil, new notes will be filed to the end of a file or entry.
2070 This can also be a list with cons cells of regular expressions that
2071 are matched against file names, and values."
2082 "Information to record when a task is refiled.
2084 Possible values are:
2086 nil Don't add anything
2087 time Add a time stamp to the task
2088 note Prompt for a note and add it with template `org-log-note-headings'
2090 This option can also be set with on a per-file-basis with
2092 #+STARTUP: nologrefile
2093 #+STARTUP: logrefile
2094 #+STARTUP: lognoterefile
2096 You can have local logging settings for a subtree by setting the LOGGING
2097 property to one or more of these keywords.
2099 When bulk-refiling from the agenda, the value `note' is forbidden and
2100 will temporarily be changed to `time'."
2111 This is a list of cons cells. Each cell contains:
2112 - a specification of the files to be considered, either a list of files,
2113 or a symbol whose function or variable value will be used to retrieve
2114 a file name or a list of file names. If you use `org-agenda-files' for
2115 that, all agenda files will be scanned for targets. Nil means consider
2116 headings in the current buffer.
2117 - A specification of how to find candidate refile targets. This may be
2118 any of:
2120 This tag has to be present in all target headlines, inheritance will
2121 not be considered.
2123 todo keyword.
2125 headlines that are refiling targets.
2126 - a cons cell (:level . N). Any headline of level N is considered a target.
2127 Note that, when `org-odd-levels-only' is set, level corresponds to
2128 order in hierarchy, not to the number of stars.
2129 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2130 Note that, when `org-odd-levels-only' is set, level corresponds to
2131 order in hierarchy, not to the number of stars.
2133 Each element of this list generates a set of possible targets.
2134 The union of these sets is presented (with completion) to
2135 the user by `org-refile'.
2137 You can set the variable `org-refile-target-verify-function' to a function
2138 to verify each headline found by the simple criteria above.
2140 When this variable is nil, all top-level headlines in the current buffer
2141 are used, equivalent to the value `((nil . (:level . 1))'."
2157 "Function to verify if the headline at point should be a refile target.
2158 The function will be called without arguments, with point at the
2159 beginning of the headline. It should return t and leave point
2160 where it is if the headline is a valid target for refiling.
2162 If the target should not be selected, the function must return nil.
2163 In addition to this, it may move point to a place from where the search
2164 should be continued. For example, the function may decide that the entire
2165 subtree of the current entry should be excluded and move point to the end
2166 of the subtree."
2171 "Non-nil means cache refile targets to speed up the process.
2172 The cache for a particular file will be updated automatically when
2173 the buffer has been killed, or when any of the marker used for flagging
2174 refile targets no longer points at a live buffer.
2175 If you have added new entries to a buffer that might themselves be targets,
2176 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2177 find that easier, `C-u C-u C-u C-c C-w'."
2183 "Non-nil means provide refile targets as paths.
2184 So a level 3 headline will be available as level1/level2/level3.
2186 When the value is `file', also include the file name (without directory)
2187 into the path. In this case, you can also stop the completion after
2188 the file name, to get entries inserted as top level in the file.
2190 When `full-file-path', include the full file path."
2199 "Non-nil means complete the outline path in hierarchical steps.
2200 When Org-mode uses the refile interface to select an outline path
2201 \(see variable `org-refile-use-outline-path'), the completion of
2202 the path can be done is a single go, or if can be done in steps down
2203 the headline hierarchy. Going in steps is probably the best if you
2204 do not use a special completion package like `ido' or `icicles'.
2205 However, when using these packages, going in one step can be very
2206 fast, while still showing the whole path to the entry."
2211 "Non-nil means allow to create new nodes as refile targets.
2213 of an existing node. When the value of this variable is `confirm',
2214 new node creation must be confirmed by the user (recommended)
2215 When nil, the completion must match an existing entry.
2217 Note that, if the new heading is not seen by the criteria
2218 listed in `org-refile-targets', multiple instances of the same
2219 heading would be created by trying again to file under the new
2220 heading."
2228 "Non-nil means also refile active region within a subtree.
2230 By default `org-refile' doesn't allow refiling regions if they
2231 don't contain a set of subtrees, but it might be convenient to
2232 do so sometimes: in that case, the first line of the region is
2233 converted to a headline before refiling."
2239 "Options concerning TODO items in Org-mode."
2244 "Options concerning Progress logging in Org-mode."
2251 "The available interpretation symbols for customizing `org-todo-keywords'.
2255 "List of TODO entry keyword sequences and their interpretation.
2258 Each sequence starts with a symbol, either `sequence' or `type',
2259 indicating if the keywords should be interpreted as a sequence of
2260 action steps, or as different types of TODO items. The first
2261 keywords are states requiring action - these states will select a headline
2262 for inclusion into the global TODO list Org-mode produces. If one of
2265 the last keyword is treated as the only DONE state of the sequence.
2268 additional state where no keyword is present. For details about this
2269 cycling, see the manual.
2271 TODO keywords and interpretation can also be set on a per-file basis with
2272 the special #+SEQ_TODO and #+TYP_TODO lines.
2274 Each keyword can optionally specify a character for fast state selection
2275 \(in combination with the variable `org-use-fast-todo-selection')
2276 and specifiers for state change logging, using the same syntax that
2279 indicates to record a time stamp each time this state is selected.
2281 Each keyword may also specify if a timestamp or a note should be
2282 recorded when entering or leaving the state, by adding additional
2283 characters in the parenthesis after the keyword. This looks like this:
2285 record only the time of the state change. With X and Y being either
2287 Y when leaving the state if and only if the *target* state does not
2288 define X. You may omit any of the fast-selection key or X or /Y,
2289 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2291 For backward compatibility, this variable may also be just a list
2292 of keywords. In this case the interpretation (sequence or type) will be
2293 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2303 ;;Quick and dirty way to see
2304 ;;`org-todo-interpretations'. This takes the
2305 ;;place of item arguments
2306 :convert-widget
2313 org-todo-interpretation-widgets))
2314 widget))
2350 "Controls how TODO keywords are interpreted.
2351 This variable is in principle obsolete and is only used for
2352 backward compatibility, if the interpretation of todo keywords is
2353 not given already in `org-todo-keywords'. See that variable for
2354 more information."
2361 "Non-nil means use the fast todo selection scheme with C-c C-t.
2362 This variable describes if and under what circumstances the cycling
2363 mechanism for TODO keywords will be replaced by a single-key, direct
2364 selection scheme.
2366 When nil, fast selection is never used.
2368 When the symbol `prefix', it will be used when `org-todo' is called
2369 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2370 `C-u t' in an agenda buffer.
2372 When t, fast selection is used by default. In this case, the prefix
2373 argument forces cycling instead.
2375 In all cases, the special interface is only used if access keys have
2376 actually been assigned by the user, i.e. if keywords in the configuration
2377 are followed by a letter in parenthesis, like TODO(t)."
2385 "Non-nil means update todo statistics after insert and toggle.
2386 ALL-HEADLINES means update todo statistics by including headlines
2387 with no TODO keyword as well, counting them as not done.
2388 A list of TODO keywords means the same, but skip keywords that are
2389 not in this list.
2391 When this is set, todo statistics is updated in the parent of the
2392 current entry each time a todo state is changed."
2402 "Non-nil means TODO statistics covers just direct children.
2403 When nil, all entries in the subtree are considered.
2404 This has only an effect if `org-provide-todo-statistics' is set.
2405 To set this to nil for only a single subtree, use a COOKIE_DATA
2411 "Hook which is run after the state of a TODO item was changed.
2412 The new state (a string with a TODO keyword, or nil) is available in the
2413 Lisp variable `org-state'."
2418 "Hook for functions that are allowed to block a state change.
2420 Functions in this hook should not modify the buffer.
2421 Each function gets as its single argument a property list,
2422 see `org-trigger-hook' for more information about this list.
2424 If any of the functions in this hook returns nil, the state change
2428 "Hook for functions that are triggered by a state change.
2430 Each function gets as its single argument a property list with at
2431 least the following elements:
2433 (:type type-of-change :position pos-at-entry-start
2434 :from old-state :to new-state)
2436 Depending on the type, more properties may be present.
2438 This mechanism is currently implemented for:
2440 TODO state changes
2441 ------------------
2442 :type todo-state-change
2443 :from previous state (keyword as a string), or nil, or a symbol
2444 'todo' or 'done', to indicate the general type of state.
2448 "Non-nil means undone TODO entries will block switching the parent to DONE.
2449 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2450 be blocked if any prior sibling is not yet done.
2451 Finally, if the parent is blocked because of ordered siblings of its own,
2452 the child will also be blocked."
2464 "Non-nil means unchecked boxes will block switching the parent to DONE.
2465 When this is nil, checkboxes have no influence on switching TODO states.
2466 When non-nil, you first need to check off all check boxes before the TODO
2467 entry can be switched to DONE.
2468 This variable needs to be set before org.el is loaded, and you need to
2469 restart Emacs after a change to make the change effective. The only way
2470 to change is while Emacs is running is through the customize interface."
2482 "Non-nil means inserting a TODO heading is treated as state change.
2484 logging will apply if appropriate. When nil, the new TODO item will
2485 be inserted directly, and no logging will take place."
2490 "Non-nil means switching TODO states with S-cursor counts as state change.
2491 This is the default behavior. However, setting this to nil allows a
2492 convenient way to select a TODO state and bypass any logging associated
2493 with that."
2498 "Tag changes that should be triggered by TODO state changes.
2499 This is a list. Each entry is
2501 (state-change (tag . flag) .......)
2503 State-change can be a string with a state, and empty string to indicate the
2504 state that has no TODO keyword, or it can be one of the symbols `todo'
2505 or `done', meaning any not-done or done state, respectively."
2519 "Information to record when a task moves to the DONE state.
2521 Possible values are:
2523 nil Don't add anything, just change the keyword
2524 time Add a time stamp to the task
2525 note Prompt for a note and add it with template `org-log-note-headings'
2527 This option can also be set with on a per-file-basis with
2529 #+STARTUP: nologdone
2530 #+STARTUP: logdone
2531 #+STARTUP: lognotedone
2533 You can have local logging settings for a subtree by setting the LOGGING
2534 property to one or more of these keywords."
2542 ;; Normalize old uses of org-log-done.
2549 "Information to record when the scheduling date of a tasks is modified.
2551 Possible values are:
2553 nil Don't add anything, just change the date
2554 time Add a time stamp to the task
2555 note Prompt for a note and add it with template `org-log-note-headings'
2557 This option can also be set with on a per-file-basis with
2559 #+STARTUP: nologreschedule
2560 #+STARTUP: logreschedule
2561 #+STARTUP: lognotereschedule"
2570 "Information to record when the deadline date of a tasks is modified.
2572 Possible values are:
2574 nil Don't add anything, just change the date
2575 time Add a time stamp to the task
2576 note Prompt for a note and add it with template `org-log-note-headings'
2578 This option can also be set with on a per-file-basis with
2580 #+STARTUP: nologredeadline
2581 #+STARTUP: logredeadline
2582 #+STARTUP: lognoteredeadline
2584 You can have local logging settings for a subtree by setting the LOGGING
2585 property to one or more of these keywords."
2594 "Non-nil means record a note when clocking out of an item.
2595 This can also be configured on a per-file basis by adding one of
2596 the following lines anywhere in the buffer:
2598 #+STARTUP: lognoteclock-out
2599 #+STARTUP: nolognoteclock-out"
2605 "Non-nil means the CLOSED time stamp will contain date and time.
2606 When nil, only the date will be recorded."
2620 "Headings for notes added to entries.
2621 The value is an alist, with the car being a symbol indicating the note
2622 context, and the cdr is the heading to be used. The heading may also be the
2623 empty string.
2624 %t in the heading will be replaced by a time stamp.
2625 %T will be an active time stamp instead the default inactive one
2626 %d will be replaced by a short-format time stamp.
2627 %D will be replaced by an active short-format time stamp.
2628 %s will be replaced by the new TODO state, in double quotes.
2629 %S will be replaced by the old TODO state, in double quotes.
2630 %u will be replaced by the user name.
2631 %U will be replaced by the full user name.
2633 In fact, it is not a good idea to change the `state' entry, because
2634 agenda log mode depends on the format of these entries."
2640 "Heading when changing todo state (todo sequence only)"
2654 "Non-nil means insert state change notes and time stamps into a drawer.
2655 When nil, state changes notes will be inserted after the headline and
2656 any scheduling and clock lines, but not inside a drawer.
2658 The value of this variable should be the name of the drawer to use.
2659 LOGBOOK is proposed as the default drawer for this purpose, you can
2660 also set this to a string to define the drawer of your choice.
2664 A value of t or nil can also be set with on a per-file-basis with
2666 #+STARTUP: logdrawer
2667 #+STARTUP: nologdrawer
2669 If this variable is set, `org-log-state-notes-insert-after-drawers'
2670 will be ignored.
2672 You can set the property LOG_INTO_DRAWER to overrule this setting for
2673 a subtree."
2684 "Return the value of `org-log-into-drawer', but let properties overrule.
2685 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2686 used instead of the default value."
2695 "Non-nil means insert state change notes after any drawers in entry.
2696 Only the drawers that *immediately* follow the headline and the
2697 deadline/scheduled line are skipped.
2698 When nil, insert notes right after the heading and perhaps the line
2699 with deadline/scheduling if present.
2701 This variable will have no effect if `org-log-into-drawer' is
2702 set."
2708 "Non-nil means the latest state note will be directly after heading.
2709 When nil, the state change notes will be ordered according to time.
2711 This option can also be set with on a per-file-basis with
2713 #+STARTUP: logstatesreversed
2714 #+STARTUP: nologstatesreversed"
2720 "The TODO state to which a repeater should return the repeating task.
2721 By default this is the first task in a TODO sequence, or the previous state
2722 in a TODO_TYP set. But you can specify another task here.
2723 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2730 "Non-nil means record moving through the DONE state when triggering repeat.
2731 An auto-repeating task is immediately switched back to TODO when
2734 record a closing note, there will be no record of the task moving
2735 through DONE. This variable forces taking a note anyway.
2737 nil Don't force a record
2738 time Record a time stamp
2739 note Prompt for a note and add it with template `org-log-note-headings'
2741 This option can also be set with on a per-file-basis with
2743 #+STARTUP: nologrepeat
2744 #+STARTUP: logrepeat
2745 #+STARTUP: lognoterepeat
2747 You can have local logging settings for a subtree by setting the LOGGING
2748 property to one or more of these keywords."
2758 "Priorities in Org-mode."
2763 "Non-nil means priority commands are active.
2764 When nil, these commands will be disabled, so that you never accidentally
2765 set a priority."
2770 "The highest priority of TODO items. A character like ?A, ?B etc.
2771 Must have a smaller ASCII number than `org-lowest-priority'."
2776 "The lowest priority of TODO items. A character like ?A, ?B etc.
2777 Must have a larger ASCII number than `org-highest-priority'."
2782 "The default priority of TODO items.
2783 This is the priority an item gets if no explicit priority is given.
2784 When starting to cycle on an empty priority the first step in the cycle
2785 depends on `org-priority-start-cycle-with-default'. The resulting first
2786 step priority must not exceed the range from `org-highest-priority' to
2787 `org-lowest-priority' which means that `org-default-priority' has to be
2788 in this range exclusive or inclusive the range boundaries. Else the
2789 first step refuses to set the default and the second will fall back
2790 to (depending on the command used) the highest or lowest priority."
2795 "Non-nil means start with default priority when starting to cycle.
2796 When this is nil, the first step in the cycle will be (depending on the
2797 command used) one higher or lower than the default priority.
2798 See also `org-default-priority'."
2803 "Function to extract the priority from a string.
2804 The string is normally the headline. If this is nil Org computes the
2805 priority from the priority cookie like [#A] in the headline. It returns
2806 an integer, increasing by 1000 for each priority level.
2807 The user can set a different function here, which should take a string
2808 as an argument and return the numeric priority."
2814 "Options concerning time stamps and deadlines in Org-mode."
2819 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2820 When nil, these labeled time stamps are forces into the second line of an
2821 entry, just after the headline. When scheduling from the global TODO list,
2822 the time stamp will always be forced into the second line."
2827 "Formats for `format-time-string' which are used for time stamps.
2831 "Number of minutes to round time stamps to.
2832 These are two values, the first applies when first creating a time stamp.
2833 The second applies when changing it with the commands `S-up' and `S-down'.
2834 When changing the time stamp, this means that it will change in steps
2835 of N minutes, as given by the second value.
2837 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2838 numbers should be factors of 60, so for example 5, 10, 15.
2840 When this is larger than 1, you can still force an exact time stamp by using
2841 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2842 and by using a prefix arg to `S-up/down' to specify the exact number
2843 of minutes to shift."
2853 ;; Normalize old customizations of this variable.
2857 org-time-stamp-rounding-minutes)))
2860 "Non-nil means overlay custom formats over all time stamps.
2861 The formats are defined through the variable `org-time-stamp-custom-formats'.
2862 To turn this on on a per-file basis, insert anywhere in the file:
2863 #+STARTUP: customtime"
2871 "Custom formats for time stamps. See `format-time-string' for the syntax.
2872 These are overlaid over the default ISO format if the variable
2873 `org-display-custom-times' is set. Time like %H:%M should be at the
2874 end of the second format. The custom formats are also honored by export
2875 commands, if custom time display is turned on at the time of export."
2880 "Get the right format for a time string."
2885 f)))
2889 "The format string used when creating CLOCKSUM lines.
2890 This is also used when Org mode generates a time duration.
2892 The value can be a single format string containing two
2893 %-sequences, which will be filled with the number of hours and
2894 minutes in that order.
2896 Alternatively, the value can be a plist associating any of the
2897 keys :years, :months, :weeks, :days, :hours or :minutes with
2898 format strings. The time duration is formatted using only the
2899 time components that are needed and concatenating the results.
2900 If a time unit in absent, it falls back to the next smallest
2901 unit.
2903 The keys :require-years, :require-months, :require-days,
2904 :require-weeks, :require-hours, :require-minutes are also
2905 meaningful. A non-nil value for these keys indicates that the
2906 corresponding time component should always be included, even if
2907 its value is 0.
2910 For example,
2913 :require-minutes t)
2915 means durations longer than a day will be expressed in days,
2916 hours and minutes, and durations less than a day will always be
2917 expressed in hours and minutes (even for durations less than an
2918 hour).
2920 The value
2924 means durations longer than a day will be expressed in days and
2925 minutes, and durations less than a day will be expressed entirely
2926 in minutes (even for durations longer than an hour)."
2966 See `org-time-clocksum-format' for more on time clock formats."
2974 E.g. by default, one day is considered to be a 8 hours effort,
2975 so a task that has been clocked for 16 hours will be displayed
2976 as during 2 days in the clock display or in the clocktable.
2978 See `org-effort-durations' on how to set effort durations
2979 and `org-time-clocksum-format' for more on time clock formats."
2987 "The format string used when creating CLOCKSUM lines,
2988 or when Org mode generates a time duration, if
2989 `org-time-clocksum-use-fractional' is enabled.
2991 The value can be a single format string containing one
2992 %-sequence, which will be filled with the number of hours as
2993 a float.
2995 Alternatively, the value can be a plist associating any of the
2996 keys :years, :months, :weeks, :days, :hours or :minutes with
2997 a format string. The time duration is formatted using the
2998 largest time unit which gives a non-zero integer part. If all
2999 specified formats have zero integer part, the smallest time unit
3000 is used."
3017 "Number of days before expiration during which a deadline becomes active.
3018 This variable governs the display in sparse trees and in the agenda.
3019 When 0 or negative, it means use this number (the absolute value of it)
3020 even if a deadline has a different individual lead time specified.
3022 Custom commands can set this variable in the options section."
3028 "Number of days before a scheduled item becomes active.
3029 This variable governs the display in sparse trees and in the agenda.
3030 The default value (i.e. 0) means: don't delay scheduled item.
3031 When negative, it means use this number (the absolute value of it)
3032 even if a scheduled item has a different individual delay time
3033 specified.
3035 Custom commands can set this variable in the options section."
3043 "Non-nil means assume future for incomplete date input from user.
3044 This affects the following situations:
3045 1. The user gives a month but not a year.
3048 2. The user gives a day, but no month.
3051 it will be considered as *this* month.
3053 If you set this variable to the symbol `time', then also the following
3054 will work:
3056 3. If the user gives a time.
3057 If the time is before now, it will be interpreted as tomorrow.
3059 Currently none of this works for ISO week specifications.
3061 When this option is nil, the current day, month and year will always be
3062 used as defaults.
3064 See also `org-agenda-jump-prefer-future'."
3072 "Should the agenda jump command prefer the future for incomplete dates?
3073 The default is to do the same as configured in `org-read-date-prefer-future'.
3074 But you can also set a deviating value here.
3075 This may t or nil, or the symbol `org-read-date-prefer-future'."
3081 org-read-date-prefer-future)
3086 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3088 Depending on the system Emacs is running on, certain dates cannot
3089 be represented with the type used internally to represent time.
3090 Dates between 1970-1-1 and 2038-1-1 can always be represented
3091 correctly. Some systems allow for earlier dates, some for later,
3092 some for both. One way to find out it to insert any date into an
3093 Org buffer, putting the cursor on the year and hitting S-up and
3094 S-down to test the range.
3096 When this variable is set to t, the date/time prompt will not let
3097 you specify dates outside the 1970-2037 range, so it is certain that
3098 these dates will work in whatever version of Emacs you are
3099 running, and also that you can move a file from one Emacs implementation
3100 to another. WHenever Org is forcing the year for you, it will display
3101 a message and beep.
3103 When this variable is nil, Org will check if the date is
3104 representable in the specific Emacs implementation you are using.
3105 If not, it will force a year, usually the current year, and beep
3106 to remind you. Currently this setting is not recommended because
3107 the likelihood that you will open your Org files in an Emacs that
3108 has limited date range is not negligible.
3110 A workaround for this problem is to use diary sexp dates for time
3111 stamps outside of this range."
3117 "Non-nil means display current interpretation of date prompt live.
3118 This display will be in an overlay, in the minibuffer."
3123 "Non-nil means pop up a calendar when prompting for a date.
3124 In the calendar, the date can be selected with mouse-1. However, the
3125 minibuffer will also be active, and you can simply enter the date as well.
3126 When nil, only the minibuffer will be available."
3133 'org-read-date-minibuffer-setup-hook
3136 "Hook to be used to set up keys for the date/time interface.
3137 Add key definitions to `minibuffer-local-map', which will be a
3138 temporary copy.
3140 WARNING: This option is obsolete, you should use
3141 `org-read-date-minibuffer-local-map' to set up keys."
3146 "The hour when your day really ends. Must be an integer.
3147 This has influence for the following applications:
3149 the time given here, the day recognized as TODAY is actually yesterday.
3150 - When a date is read from the user and it is still before the time given
3151 here, the current date and time will be assumed to be yesterday, 23:59.
3152 Also, timestamps inserted in capture templates follow this rule.
3154 IMPORTANT: This is a feature whose implementation is and likely will
3155 remain incomplete. Really, it is only here because past midnight seems to
3156 be the favorite working time of John Wiegley :-)"
3161 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3162 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3164 23:59 of the previous day."
3170 "When non-nil, use the last clock out time for `org-todo'.
3171 Note that this option has precedence over the combined use of
3172 `org-use-effective-time' and `org-extend-today-until'."
3179 "Non-nil means S-down will increase the time in a time stamp.
3180 When nil, S-up will increase."
3185 "Non-nil means make the calendar window follow timestamp changes.
3186 When a timestamp is modified and the calendar window is visible, it will be
3187 moved to the new date."
3192 "Options concerning tags in Org-mode."
3197 "List of tags allowed in Org-mode files.
3198 When this list is nil, Org-mode will base TAG input on what is already in the
3199 buffer.
3200 The value of this variable is an alist, the car of each entry must be a
3201 keyword as a string, the cdr may be a character that is used to select
3202 that tag through the fast-tag-selection interface.
3203 See the manual for details."
3220 "List of tags that will always appear in all Org-mode files.
3221 This is in addition to any in buffer settings or customizations
3222 of `org-tag-alist'.
3223 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3224 The value of this variable is an alist, the car of each entry must be a
3225 keyword as a string, the cdr may be a character that is used to select
3226 that tag through the fast-tag-selection interface.
3227 See the manual for details.
3228 To disable these tags on a per-file basis, insert anywhere in the file:
3229 #+STARTUP: noptag"
3241 "If non-nil, always offer completion for all tags of all agenda files.
3242 Instead of customizing this variable directly, you might want to
3243 set it locally for capture buffers, because there no list of
3244 tags in that file can be created dynamically (there are none).
3246 (add-hook 'org-capture-mode-hook
3247 (lambda ()
3248 (set (make-local-variable
3249 'org-complete-tags-always-offer-all-agenda-tags)
3250 t)))"
3256 "List of tags that can be inherited by all entries in the file.
3257 The tags will be inherited if the variable `org-use-tag-inheritance'
3258 says they should be.
3262 "Non-nil means use fast tag selection scheme.
3263 This is a special interface to select and deselect tags with single keys.
3264 When nil, fast selection is never used.
3265 When the symbol `auto', fast selection is used if and only if selection
3266 characters for tags have been configured, either through the variable
3267 `org-tag-alist' or through a #+TAGS line in the buffer.
3268 When t, fast selection is always used and selection keys are assigned
3269 automatically if necessary."
3277 "Non-nil means fast tag selection exits after first change.
3278 When nil, you have to press RET to exit it.
3279 During fast tag selection, you can toggle this flag with `C-c'.
3280 This variable can also have the value `expert'. In this case, the window
3281 displaying the tags menu is not even shown, until you press C-c again."
3289 "Non-nil means fast tags selection interface will also offer TODO states.
3293 "The column to which tags should be indented in a headline.
3294 If this number is positive, it specifies the column. If it is negative,
3295 it means that the tags should be flushright to that column. For example,
3296 -80 works well for a normal 80 character screen.
3297 When 0, place tags directly after headline text, with only one space in
3298 between."
3303 "Non-nil keeps tags aligned when modifying headlines.
3304 Some operations (i.e. demoting) change the length of a headline and
3305 therefore shift the tags around. With this option turned on, after
3306 each such operation the tags are again aligned to `org-tags-column'."
3311 "Non-nil means tags in levels apply also for sublevels.
3312 When nil, only the tags directly given in a specific line apply there.
3313 This may also be a list of tags that should be inherited, or a regexp that
3314 matches tags that should be inherited. Additional control is possible
3315 with the variable `org-tags-exclude-from-inheritance' which gives an
3316 explicit list of tags to be excluded from inheritance, even if the value of
3317 `org-use-tag-inheritance' would select it for inheritance.
3319 If this option is t, a match early-on in a tree can lead to a large
3320 number of matches in the subtree when constructing the agenda or creating
3321 a sparse tree. If you only want to see the first match in a tree during
3322 a search, check out the variable `org-tags-match-list-sublevels'."
3331 "List of tags that should never be inherited.
3332 This is a way to exclude a few tags from inheritance. For way to do
3333 the opposite, to actively allow inheritance for selected tags,
3334 see the variable `org-use-tag-inheritance'."
3339 "Check if TAG is one that should be inherited."
3351 "Non-nil means list also sublevels of headlines matching a search.
3352 This variable applies to tags/property searches, and also to stuck
3353 projects because this search is based on a tags match as well.
3355 When set to the symbol `indented', sublevels are indented with
3356 leading dots.
3358 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3359 the sublevels of a headline matching a tag search often also match
3360 the same search. Listing all of them can create very long lists.
3361 Setting this variable to nil causes subtrees of a match to be skipped.
3363 This variable is semi-obsolete and probably should always be true. It
3364 is better to limit inheritance to certain tags using the variables
3365 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3373 "When set, tags are sorted using this function as a comparator."
3389 "Options concerning properties in Org-mode."
3394 "How property key/value pairs should be formatted by `indent-line'.
3395 When `indent-line' hits a property definition, it will format the line
3396 according to this format, mainly to make sure that the values are
3397 lined-up with respect to each other."
3402 "Alist of properties and functions to adjust inserted values.
3403 Elements of this alist must be of the form
3405 ([string] [function])
3407 where [string] must be a property name and [function] must be a
3408 lambda expression: this lambda expression must take one argument,
3409 the value to adjust, and return the new value as a string.
3413 and the clock summary:
3416 (let ((clocksum (org-clock-sum-current-item))
3417 (effort (org-duration-string-to-minutes
3419 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3426 "Non-nil means properties apply also for sublevels.
3428 This setting is chiefly used during property searches. Turning it on can
3429 cause significant overhead when doing a search, which is why it is not
3430 on by default.
3432 When nil, only the properties directly given in the current entry count.
3433 When t, every property is inherited. The value may also be a list of
3434 properties that should have inheritance, or a regular expression matching
3435 properties that should be inherited.
3437 However, note that some special properties use inheritance under special
3438 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3440 for valid values of a property.
3442 Note for programmers:
3443 When querying an entry with `org-entry-get', you can control if inheritance
3444 should be used. By default, `org-entry-get' looks only at the local
3445 properties. You can request inheritance by setting the inherit argument
3446 to t (to force inheritance) or to `selective' (to respect the setting
3447 in this variable)."
3456 "Check if PROPERTY is one that should be inherited."
3467 "The default column format, if no other format has been defined.
3468 This variable can be set on the per-file basis by inserting a line
3470 #+COLUMNS: %25ITEM ....."
3475 "The ellipses to be used when a field in column view is truncated.
3476 When this is the empty string, as many characters as possible are shown,
3477 but then there will be no visual indication that the field has been truncated.
3478 When this is a string of length N, the last N characters of a truncated
3479 field are replaced by this string. If the column is narrower than the
3480 ellipses string, only part of the ellipses string will be shown."
3485 "Function that modifies values for display in column view.
3486 For example, it can be used to cut out a certain part from a time stamp.
3487 The function must take 2 arguments:
3489 column-title The title of the column (*not* the property name)
3490 value The value that should be modified.
3492 The function should return the value that should be displayed,
3493 or nil if the normal value should be used."
3498 "The property that is being used to keep track of effort estimates.
3499 Effort estimates given in this property need to have the format H:MM."
3507 "List of property/value pairs that can be inherited by any entry.
3509 These are fixed values, for the preset properties. The user variable
3510 that can be used to add to this list is `org-global-properties'.
3512 The entries in this list are cons cells where the car is a property
3513 name and cdr is a string with the value. If the value represents
3518 "List of property/value pairs that can be inherited by any entry.
3520 This list will be combined with the constant `org-global-properties-fixed'.
3522 The entries in this list are cons cells where the car is a property
3523 name and cdr is a string with the value.
3525 You can set buffer-local values for the same purpose in the variable
3526 `org-file-properties' this by adding lines like
3528 #+PROPERTY: NAME VALUE"
3535 "List of property/value pairs that can be inherited by any entry.
3536 Valid for the current buffer.
3541 "Options concerning agenda views in Org-mode."
3546 "Variable used by org files to set a category for agenda display.
3547 Such files should use a file variable to set it, for example
3551 or contain a special line
3553 #+CATEGORY: ELisp
3555 If the file does not specify a category, then file's base name
3561 "The files to be used for agenda display.
3565 If an entry is a directory, all files in that directory that are matched by
3566 `org-agenda-file-regexp' will be part of the file list.
3568 If the value of the variable is not a list but a single file name, then
3569 the list of agenda files is actually stored and maintained in that file, one
3570 agenda file per line. In this file paths can be given relative to
3571 `org-directory'. Tilde expansion and environment variable substitution
3572 are also made."
3579 "Regular expression to match files for `org-agenda-files'.
3580 If any element in the list in that variable contains a directory instead
3581 of a normal file, all files in that directory that are matched by this
3582 regular expression will be included."
3587 "List of extra files to be searched by text search commands.
3588 These files will be search in addition to the agenda files by the
3589 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3590 Note that these files will only be searched for text search commands,
3591 not for the other agenda views like todo lists, tag searches or the weekly
3592 agenda. This variable is intended to list notes and possibly archive files
3593 that should also be searched by these two commands.
3594 In fact, if the first element in the list is the symbol `agenda-archives',
3595 than all archive files of all agenda files will be added to the search
3596 scope."
3606 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3607 A nil value means to remove them, after a query, from the list."
3612 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3613 The command `org-calendar-goto-agenda' will be bound to this key. The
3614 default is the character `c' because then `c' can be used to switch back and
3615 forth between agenda and calendar."
3620 "The key to be installed in `calendar-mode-map' for adding diary entries.
3621 This option is irrelevant until `org-agenda-diary-file' has been configured
3622 to point to an Org-mode file. When that is the case, the command
3623 `org-agenda-diary-entry' will be bound to the key given here, by default
3624 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3625 if you want to continue doing this, you need to change this to a different
3626 key."
3631 "File to which to add new entries with the `i' key in agenda and calendar.
3632 When this is the symbol `diary-file', the functionality in the Emacs
3633 calendar will be used to add entries to the `diary-file'. But when this
3634 points to a file, `org-agenda-diary-entry' will be used instead."
3648 org-calendar-insert-diary-entry-key
3652 "Options for embedding LaTeX code into Org-mode."
3660 "Options for creating images from LaTeX fragments.
3661 This is a property list with the following properties:
3663 `default' means use the foreground of the default face.
3664 `auto' means use the foreground from the text face.
3666 `default' means use the background of the default face.
3667 `auto' means use the background from the text face.
3668 :scale a scaling factor for the size of the images, to get more pixels
3669 :html-foreground, :html-background, :html-scale
3670 the same numbers for HTML export.
3671 :matchers a list indicating which matchers should be used to
3672 find LaTeX fragments. Valid members of this list are:
3683 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3684 When nil, just push out a message."
3691 Use this to specify additional executable file say a jar file.
3693 When using MathToWeb as the converter, specify the full-path to
3694 your mathtoweb.jar file."
3702 "Command to convert LaTeX fragments to MathML.
3703 Replace format-specifiers in the command as noted below and use
3704 `shell-command' to convert LaTeX to MathML.
3705 %j: Executable file in fully expanded form as specified by
3706 `org-latex-to-mathml-jar-file'.
3707 %I: Input LaTeX file in fully expanded form
3708 %o: Output MathML file
3709 This command is used by `org-create-math-formula'.
3711 When using MathToWeb as the converter, set this to
3720 "Program to convert LaTeX fragments with.
3722 dvipng Process the LaTeX fragments to dvi file, then convert
3723 dvi files to png files using dvipng.
3724 This will also include processing of non-math environments.
3725 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3726 to convert pdf files to png files"
3734 "Path to store latex preview images.
3735 A relative path here creates many directories relative to the
3736 processed org files paths. An absolute path puts all preview
3737 images at the same place."
3743 "Return t if `org-latex-to-mathml-convert-command' is usable."
3746 org-latex-to-mathml-convert-command)
3748 org-latex-to-mathml-convert-command))))
3753 t))))))
3760 \[PACKAGES]
3761 \[DEFAULT-PACKAGES]
3762 % The settings below are copied from fullpage.sty
3775 "The document header used for processing LaTeX fragments.
3776 It is imperative that this header make sure that no page number
3777 appears on the page. The package defined in the variables
3778 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3780 header, or they will be appended."
3785 "Set the packages alist and make sure it has 3 elements per entry."
3789 x))
3790 val)))
3793 "Get the packages alist and make sure it has 3 elements per entry."
3797 x))
3816 "Alist of default packages to be inserted in the header.
3818 Change this only if one of the packages here causes an
3819 incompatibility with another package you are using.
3821 The packages in this list are needed by one part or another of
3822 Org mode to function properly:
3824 - inputenc, fontenc: for basic font and character selection
3825 - textcomp, marvosymb, wasysym, latexsym, amssym: for various
3826 symbols used for interpreting the entities in `org-entities'.
3827 You can skip some of these packages if you don't use any of the
3828 symbols in it.
3829 - graphicx: for including images
3830 - float, wrapfig: for figure placement
3831 - longtable: for long tables
3832 - hyperref: for cross references
3834 Therefore you should not modify this variable unless you know
3835 what you are doing. The one reason to change it anyway is that
3836 you might be loading some other package that conflicts with one
3837 of the default packages. Each cell is of the format
3839 the package also needs to be included when compiling LaTeX
3840 snippets into images for inclusion into non-LaTeX output."
3855 "Alist of packages to be inserted in every LaTeX header.
3857 These will be inserted after `org-latex-default-packages-alist'.
3858 Each cell is of the format:
3862 SNIPPET-FLAG, when t, indicates that this package is also needed
3863 when turning LaTeX snippets into images for inclusion into
3864 non-LaTeX output.
3866 Make sure that you only list packages here which:
3868 - you want in every file
3869 - do not conflict with the setup in `org-format-latex-header'.
3870 - do not conflict with the default packages in
3871 `org-latex-default-packages-alist'."
3885 "Settings for Org-mode appearance."
3890 "Non-nil means fontify only the stars in each headline.
3891 When nil, the entire headline is fontified.
3892 Changing it requires restart of `font-lock-mode' to become effective
3893 also in regions already fontified."
3898 "Non-nil means hide the first N-1 stars in a headline.
3899 This works by using the face `org-hide' for these stars. This
3900 face is white for a light background, and black for a dark
3901 background. You may have to customize the face `org-hide' to
3902 make this work.
3903 Changing it requires restart of `font-lock-mode' to become effective
3904 also in regions already fontified.
3905 You may also set this on a per-file basis by adding one of the following
3906 lines to the buffer:
3908 #+STARTUP: hidestars
3909 #+STARTUP: showstars"
3914 "List of symbols corresponding to keywords to be hidden the org buffer.
3915 For example, a value '(title) for this list will make the document's title
3916 appear in the buffer without the initial #+TITLE: keyword."
3925 "List of properties (as strings) with a special meaning.
3926 The default use of these custom properties is to let the user
3927 hide them with `org-toggle-custom-properties-visibility'."
3934 "Non-nil means change the face of a headline if it is marked DONE.
3935 Normally, only the TODO/DONE keyword indicates the state of a headline.
3936 When this is non-nil, the headline after the keyword is set to the
3937 `org-headline-done' as an additional indication."
3942 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3943 Changing this variable requires a restart of Emacs to take effect."
3948 "Non-nil means fontify the whole line for headings.
3949 This is useful when setting a background color for the
3950 org-level-* faces."
3955 "Non-nil means highlight LaTeX related syntax in the buffer.
3956 When non nil, the value should be a list containing any of the
3957 following symbols:
3958 `latex' Highlight LaTeX snippets and environments.
3959 `script' Highlight subscript and superscript.
3960 `entities' Highlight entities."
3972 "Non-nil mean font-lock should hide the emphasis marker characters."
3977 "Non-nil means show entities as UTF8 characters.
3984 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3990 "Regular expression for matching emphasis.
3991 After a match, the match groups contain these elements:
3992 0 The match of the full regular expression, including the characters
3993 before and after the proper match
3994 1 The character before the proper match, or empty at beginning of line
3995 2 The proper match, including the leading and trailing markers
3996 3 The leading marker like * or /, indicating the type of highlighting
3997 4 The text between the emphasis markers, not including the markers
4004 "Set variable and compute the emphasis regular expression."
4008 org-emphasis-alist org-emphasis-regexp-components)
4020 ;; make sure special characters appear at the right position in the class
4032 ;; Make the regexp
4040 body1
4052 body1
4058 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4059 ;; set this option proved cumbersome. See this message/thread:
4060 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4063 "Components used to build the regular expression for emphasis.
4064 This is a list with five entries. Terminology: In an emphasis string
4068 specify what is allowed/forbidden in each part:
4070 pre Chars allowed as prematch. Beginning of line will be allowed too.
4071 post Chars allowed as postmatch. End of line will be allowed too.
4072 border The chars *forbidden* as border characters.
4074 non-shy groups here, and don't allow newline here.
4075 newline The maximum number of newlines allowed in an emphasis exp.
4086 "Alist of characters and faces to emphasize text.
4087 Text starting and ending with a special character will be emphasized,
4088 for example *bold*, _underlined_ and /italic/. This variable sets the
4089 marker characters and the face to be used by font-lock for highlighting
4090 in Org-mode Emacs buffers.
4092 You need to reload Org or to restart Emacs after customizing this."
4107 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4110 ;;; Miscellaneous options
4113 "Completion in Org-mode."
4118 "Non-nil means use ido completion wherever possible.
4119 Note that `ido-mode' must be active for this variable to be relevant.
4120 If you decide to turn this variable on, you might well want to turn off
4121 `org-outline-path-complete-in-steps'.
4122 See also `org-completion-use-iswitchb'."
4127 "Non-nil means use iswitchb completion wherever possible.
4128 Note that `iswitchb-mode' must be active for this variable to be relevant.
4129 If you decide to turn this variable on, you might well want to turn off
4130 `org-outline-path-complete-in-steps'.
4131 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4137 Normal means, no org-mode-specific context."
4141 ;;; Functions and variables from their packages
4142 ;; Declared here to avoid compiler warnings
4144 ;; XEmacs only
4150 ;; Emacs only
4153 ;; Various packages
4172 org-agenda-format-item "org-agenda"
4199 ;;; Autoload and prepare some org modules
4201 ;; Some table stuff that needs to be defined here, because it is used
4202 ;; by the functions setting up org-mode or checking for table context.
4215 "Detect the first line outside a table when searching from within it.
4218 ;; Autoload the functions in org-table.el that are needed by functions here.
4227 ;;;###autoload
4229 "Unconditionally turn on `orgtbl-mode'."
4234 "Return t if the cursor is inside an org-type table.
4235 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4240 org-table-line-regexp)))
4241 nil))
4245 "Return t if and only if we are at a table.el table."
4252 "If there is a table.el table nearby, recognize it and move into it."
4258 nil
4268 t
4273 t)
4274 nil)
4275 nil))
4278 "Return t if the cursor is inside a hline in a table."
4283 nil))
4287 "Apply FUNCTION to the start of all tables in the buffer."
4297 ;; Exclude tables in src/example/verbatim/clocktable blocks
4305 ;; Declare and autoload functions from ox.el and al.
4311 ;; Declare and autoload functions from org-agenda.el
4323 "Return t when point (or POS) is in #+TBLFM line."
4338 "Return non-nil if clock is currently running.
4339 The return value is actually the clock marker."
4344 org-clock-update-time-maybe
4345 org-clocktable-shift)))
4348 "Check if the current buffer contains the running clock.
4349 If yes, offer to stop it and to save the buffer with the changes."
4358 "Check if this line starts a clock table, if yes, shift the time block."
4362 ;;;###autoload
4364 "Set up hooks for clock persistence."
4369 ;; Define the variable already here, to make sure we have it.
4371 "Non-nil if Org-Indent mode is enabled.
4374 ;; Autoload archiving code
4375 ;; The stuff that is needed for cycling and tags has to be defined here.
4378 "Options concerning archiving in Org-mode."
4383 "The location where subtrees should be archived.
4385 The value of this variable is a string, consisting of two parts,
4386 separated by a double-colon. The first part is a filename and
4387 the second part is a headline.
4389 When the filename is omitted, archiving happens in the same file.
4390 %s in the filename will be replaced by the current file
4391 name (without the directory part). Archiving to a different file
4392 is useful to keep archived entries from contributing to the
4393 Org-mode Agenda.
4395 The archived entries will be filed as subtrees of the specified
4396 headline. When the headline is omitted, the subtrees are simply
4397 filed away at the end of the file, as top-level entries. Also in
4398 the heading you can use %s to represent the file name, this can be
4399 useful when using the same archive for a number of different files.
4401 Here are a few examples:
4403 If the current file is Projects.org, archive in file
4404 Projects.org_archive, as top-level trees. This is the default.
4407 Archive in the current file, under the top-level headline
4411 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4414 Archive in file ~/org/archive.org (absolute path), under headlines
4419 items to the datetree. Items are placed in either the CLOSED
4420 date of the item, or the current date if there is no CLOSED date.
4421 The heading will be a subentry to the current date. There doesn't
4422 need to be a heading, but there always needs to be a slash after
4423 datetree. For example, to store archived items directly in the
4427 Archive in file ./basement (relative path), as level 3 trees
4430 You may set this option on a per-file basis by adding to the buffer a
4431 line like
4433 #+ARCHIVE: basement::** Finished Tasks
4435 You may also define it locally for a subtree by setting an ARCHIVE property
4436 in the entry. If such a property is found in an entry, or anywhere up
4437 the hierarchy, it will be used."
4442 "The tag that marks a subtree as archived.
4443 An archived subtree does not open during visibility cycling, and does
4444 not contribute to the agenda listings.
4445 After changing this, font-lock must be restarted in the relevant buffers to
4446 get the proper fontification."
4452 "Non-nil means the agenda will skip any items located in archived trees.
4453 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4454 variable is no longer recommended, you should leave it at the value t.
4455 Instead, use the key `v' to cycle the archives-mode in the agenda."
4461 "Non-nil means ignore archived trees when creating column view."
4467 "Non-nil means `org-cycle' will open archived trees.
4468 An archived tree is a tree marked with the tag ARCHIVE.
4469 When nil, archived trees will stay folded. You can still open them with
4470 normal outline commands like `show-all', but not with the cycling commands."
4476 "Non-nil means sparse tree construction shows matches in archived trees.
4477 When nil, matches in these trees are highlighted, but the trees are kept in
4478 collapsed state."
4484 "The default date type when building a sparse tree.
4485 When this is nil, a date is a scheduled or a deadline timestamp.
4486 Otherwise, these types are allowed:
4488 all: all timestamps
4489 active: only active timestamps (<...>)
4490 inactive: only inactive timestamps (<...)
4491 scheduled: only scheduled timestamps
4492 deadline: only deadline timestamps"
4504 "Re-hide all archived subtrees after a visibility state change."
4515 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4518 "Cycle subtree even if it is archived."
4525 "Re-hide all archived subtrees after a visibility state change."
4542 flag)))
4550 ;; Autoload Column View Code
4558 org-columns-get-format-and-top-level
4559 org-columns-compute
4560 org-columns-remove-overlays))
4562 ;; Autoload ID code
4570 org-id-copy
4571 org-id-get-with-outline-path-completion
4572 org-id-get-with-outline-drilling))
4574 ;;; Variables for pre-computed regular expressions, all buffer local
4592 "Matches a headline and puts everything into groups:
4593 group 1: the stars
4594 group 2: The todo keyword, maybe
4595 group 3: Priority cookie
4596 group 4: True headline
4600 "Printf format to make regexp to match an exact headline.
4601 This regexp will match the headline of any node which has the
4602 exact headline text that is put into the format, but may have any
4606 "Matches a headline and puts TODO state into group 2 if present.
4658 "Regular expression to match a plain time or time range.
4659 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4660 groups carry important information:
4661 0 the full match
4662 1 the first time, range or not
4670 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4671 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4672 groups carry important information:
4673 0 the full match
4674 7 hours of duration
4683 "Regular expression to match a timestamp time or time range.
4684 After a match, the following groups carry important information:
4685 0 the full match
4686 1 date plus weekday, for back referencing to make sure both times are on the same day
4687 2 the first time, range or not
4748 "Variable associated with STARTUP options for org-mode.
4749 Each element is a list of three items: the startup options (as written
4750 in the #+STARTUP line), the corresponding variable, and the value to set
4751 this variable to if the option is found. An optional forth element PUSH
4755 "Update PROPS with KEY and VAL."
4769 "Printf format for a regexp matching a headline with some keyword.
4770 This regexp will match the headline of any node which has the
4771 exact keyword that is put into the format. The keyword isn't in
4775 "Printf format for a regexp matching a headline, possibly with some keyword.
4776 This regexp can match any headline with the specified keyword, or
4777 without a keyword. The keyword isn't in any group by default,
4781 "When non-nil (the default), use group tags.
4782 This can be turned on/off through `org-toggle-tags-groups'."
4788 "Toggle support for group tags.
4789 Support for group tags is controlled by the option
4790 `org-group-tags', which is non-nil by default."
4794 org-group-tags)
4802 "Precompute regular expressions used for tags in the current buffer."
4808 tags ftags key value)
4825 ftags
4829 ;; Process the file tags.
4833 ;; Process the tags.
4834 ;; FIXME
4844 org-tag-groups-alist)
4869 "Precompute regular expressions used in the current buffer."
4887 kwds kws0 kwsa key log value cat arch const links hw dws
4888 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4901 org-tag-groups-alist))))
4921 ;; general TODO-like setup
4930 links)))
4937 props))))
4944 l var val)
4962 ;; Prevent checking in Gnus messages
4974 ;; search for property blocks
4983 props)))))))
4998 ;; Process the TODO keywords
5000 ;; Use the global values as if they had been given locally.
5012 kws)))
5015 kwsa nil
5018 ;; 1 2
5026 kw)
5028 kws0)
5045 ;; Compute the regular expressions and other local variables.
5046 ;; Using `org-outline-regexp-bol' would complicate them much,
5047 ;; because of the fixed white space at the end of that string.
5055 org-drawer-regexp
5059 org-not-done-keywords
5061 org-todo-regexp
5065 org-not-done-regexp
5069 org-not-done-heading-regexp
5071 org-todo-line-regexp
5073 org-complex-heading-regexp
5080 org-complex-heading-regexp-format
5085 ;; Stats cookies can be stuck to body.
5092 org-todo-line-tags-regexp
5099 org-deadline-time-regexp
5101 org-deadline-time-hour-regexp
5104 org-deadline-line-regexp
5106 org-scheduled-regexp
5108 org-scheduled-time-regexp
5110 org-scheduled-time-hour-regexp
5113 org-closed-time-regexp
5115 org-keyword-time-regexp
5121 org-keyword-time-not-clock-regexp
5127 org-maybe-keyword-time-regexp
5133 org-all-time-keywords
5136 org-clock-string org-closed-string)))
5141 "Return the contents of FILE, as a string."
5152 "Extract the log state setting from a TODO keyword string.
5166 "Remove a pair of parenthesis at the end of each string in LIST."
5170 x))
5171 list))
5174 "Assign fast keys to a keyword-key alist.
5175 Respect keys that are already there."
5193 ;;; Some variables used in various places
5200 "Function to be called when `C-c C-c' is used.
5204 ;; FIXME: Occasionally check by commenting these, to make sure
5205 ;; no other functions uses these, forgetting to let-bind them.
5210 ;; Defined somewhere in this file, but used before definition.
5216 ;;;; Define the Org-mode
5218 ;; We use a before-change function to check if a table might need
5219 ;; an update.
5221 "Indicates that a table might need an update.
5222 This variable is set by `org-before-change-function'.
5225 "Every change indicates that a table might need an update."
5240 (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"))
5243 ;; Other stuff we need.
5249 ;; (require 'org-macs) moved higher up in the file before it is first used
5251 ;; (require 'org-compat) moved higher up in the file before it is first used
5259 ;; babel
5262 ;;;###autoload
5264 "Outline-based notes management and organizer, alias
5267 Org-mode develops organizational tasks around a NOTES file which
5268 contains information about projects as plain text. Org-mode is
5269 implemented on top of outline-mode, which is ideal to keep the content
5270 of large files well structured. It supports ToDo items, deadlines and
5271 time stamps, which magically appear in the diary listing of the Emacs
5272 calendar. Tables are easily created with a built-in table editor.
5273 Plain text URL-like links connect to websites, emails (VM), Usenet
5274 messages (Gnus), BBDB entries, and any files related to the project.
5275 For printing and sharing of notes, an Org-mode file (or a part of it)
5276 can be exported as a structured ASCII or HTML file.
5278 The following commands are available:
5282 ;; Get rid of Outline menus, they are not needed
5283 ;; Need to do this here because define-derived-mode sets up
5284 ;; the keymap so late. Still, it is a waste to call this each time
5285 ;; we switch another buffer into org-mode.
5288 ;; Assume this is Greg's port, it uses easymenu
5308 ;; FIXME Circumvent a bug in outline.el (Emacs <24.4)
5316 org-display-table 4
5319 org-ellipsis)))
5325 ;; tag faces set outside customize.... force initialization.
5327 ;; Calc embedded
5329 ;; Modify a few syntax entries
5336 ;; Activate before-change-function
5340 ;; Check for running clock before killing a buffer
5342 ;; Initialize macros templates.
5344 ;; Initialize radio targets.
5346 ;; Indentation.
5349 ;; Filling and auto-filling.
5351 ;; Comments.
5353 ;; Beginning/end of defun
5356 ;; Next error for sparse trees
5358 ;; Make sure dependence stuff works reliably, even for users who set it
5359 ;; too late :-(
5371 ;; Align options lines
5373 'align-mode-rules-list
5378 ;; Imenu
5382 ;; Make isearch reveal context
5385 ;; Emacs 21 and XEmacs make use of the hook
5387 ;; Emacs 22 deals with this through a special variable
5392 ;; Setup the pcomplete hooks
5405 ;; If empty file that did not turn on org-mode automatically, make it to.
5421 ;; Try to set org-hide correctly
5424 ;; Update `customize-package-emacs-version-alist'
5434 org-emphasis-alist)
5435 st))
5448 "unspecified-bg"
5461 "Current time, possibly rounded to ROUNDING-MINUTES.
5462 When ROUNDING-MINUTES is not an integer, fall back on the car of
5463 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5464 the rounding returns a past time."
5476 res))))
5479 "Return today date, considering `org-extend-today-until'."
5484 ;;;; Font-Lock stuff, including the activators
5515 "Regular expression used to analyze links.
5516 Here is what the match groups contain after a match:
5517 1: http:
5518 2: http
5519 3: path
5520 4: [desc]
5531 "Create a regular expression which will match a balanced sexp.
5532 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5533 as single character strings.
5534 The regexp returned will match the entire expression including the
5535 delimiters. It will also define a single group which contains the
5536 match except for the outermost delimiters. The maximum depth of
5537 stacked delimiters is N. Escaping delimiters is not possible."
5566 "Update the link regular expressions.
5567 This should be called after the variable `org-link-types' has changed."
5571 org-link-re-with-space
5577 org-link-re-with-space2
5583 org-link-re-with-space3
5588 org-angle-link-re
5594 org-plain-link-re
5598 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5599 org-bracket-link-regexp
5601 org-bracket-link-analytic-regexp
5609 org-bracket-link-analytic-regexp++
5617 org-any-link-re
5626 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5629 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5630 "Regular expression matching time strings for analysis.
5631 This one does not require the space after the date, so it can be used
5633 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5650 "Regular expression matching a time stamp or time stamp range.
5656 "Run through the buffer and add overlays to emphasized strings."
5665 'face
5678 rtn))
5681 "Insert or change an emphasis, i.e. a font like bold or italic.
5682 If there is an active region, change that region to a new emphasis.
5683 If there is no region, just insert the marker characters and position
5684 the cursor between them.
5685 CHAR should be the marker character. If it is a space, it means to
5686 remove the emphasis of the selected region.
5687 If CHAR is not given (for example in an interactive call) it will be
5688 prompted for."
5731 "Run through the buffer and add overlays to links."
5740 nil
5747 t)))
5755 t)))
5758 "When non-nil, fontify code in code blocks."
5765 "When non-nil, allow promoting a top level subtree.
5766 The leading star of the top level headline will be replaced
5767 by a #."
5778 "Fontify #+ lines and blocks."
5781 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5782 limit t)
5790 end end1 quoting block-type ovl)
5793 ;; a single line of backend-specific content
5801 ; for backend-specific code
5802 t)
5804 ;; Truly a block
5817 beg end
5825 ;; remove old background overlays
5830 ;; add a background overlay
5845 t))
5865 t)
5871 ;; just any other in-buffer setting, but not indented
5875 t)
5879 "Run through the buffer and add overlays to links."
5888 t)))
5891 "Run through the buffer and add overlays to footnotes."
5898 'keymap org-mouse-map
5899 'help-echo
5901 "Footnote definition"
5903 'font-lock-fontified t
5904 'font-lock-multiline t
5908 "Run through the buffer and add overlays to bracketed links."
5913 ;; FIXME: Above we should remove the escapes. But that
5914 ;; requires another match, protecting match data, a lot
5915 ;; of overhead for font-lock.
5924 ;; We need to remove the invisible property here. Table narrowing
5925 ;; may have made some of this invisible.
5943 t)))
5946 "Run through the buffer and add overlays to dates."
5959 t)))
5968 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5972 "Run through the buffer and add overlays to target matches."
5980 'keymap org-mouse-map
5984 t)))))
5987 "Find all radio targets in this file and update the regular expression."
6002 t)))
6010 "Compute regular expression for LaTeX, entities and sub/superscript.
6011 Result depends on variable `org-highlight-latex-and-related'."
6013 'org-latex-and-related-regexp
6025 org-latex-regexps)))))
6032 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6033 LIMIT bounds the search for syntax to highlight. Stop at first
6034 highlighted object, if any. Return t if some highlighting was
6035 done, nil otherwise."
6044 1
6052 nil)))
6055 "Restart `font-lock-mode', to force refontification."
6061 "Return a list of all targets in this file.
6062 When optional argument RADIO is non-nil, only find radio
6063 targets."
6068 ;; Make sure point is really within the object.
6073 rtn)))
6076 "Make regular expression matching all strings in TARGETS.
6077 The regular expression finds the targets also if there is a line break
6078 between words."
6087 x)
6088 targets
6100 t)))
6103 "Compute the outline level of the heading at point.
6104 If this is called at a normal headline, the level is the number of stars.
6105 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6110 0
6116 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
6123 "Functions that can manipulate `org-font-lock-extra-keywords'.
6124 This is called after `org-font-lock-extra-keywords' is defined, but before
6125 it is installed to be used by font lock. This can be useful if something
6129 "Run `org-font-lock-hook' within LIMIT."
6133 "Set font lock defaults for the current buffer."
6138 ;; Call the hook
6140 ;; Headlines
6147 ;; Table lines
6150 ;; Table internals
6155 ;; Drawers
6158 ;; Properties
6162 ;; Links
6170 ;; Targets.
6172 ;; Diary sexps.
6174 ;; Macro
6177 ;; TODO keyword
6179 org-todo-regexp)
6181 ;; DONE
6189 nil)
6190 ;; Priorities
6192 ;; Tags
6194 ;; Tags groups
6200 ;; Special keywords
6205 ;; Emphasis
6210 ;; Checkboxes
6211 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6216 ;; Description list items
6219 ;; ARCHIVEd headings
6221 org-outline-regexp-bol
6224 ;; Specials
6228 ;; Code
6230 ;; COMMENT
6236 ;; Blocks and meta lines
6240 ;; Now set the full font-lock-keywords
6247 "Toggle the composition display of entities as UTF8 characters."
6263 "Display or hide properties in `org-custom-properties'."
6280 org-custom-properties)))))))
6283 "Find an entity to fontify."
6289 limit t)
6304 nil))))
6307 "Fontify string S like in Org-mode."
6319 "Get the right face for match N in font-lock matching of headlines."
6332 "Get the right face for a TODO keyword KWD.
6333 If KWD is a number, get the corresponding match group."
6341 "Create a face list that inherits INHERIT, but sets the foreground color.
6342 When FACE-OR-COLOR is not a string, just return it."
6346 face-or-color)
6347 face-or-color))
6350 "Add the special tag faces."
6359 "Add the special priority faces."
6367 org-priority-faces)))
6372 "Get the right face for a TODO keyword KWD.
6373 If KWD is a number, get the corresponding match group."
6380 "Remove fontification and activation overlays from links."
6385 deactivate-mark buffer-file-name buffer-file-truename)
6389 invisible t intangible t
6390 org-no-flyspell t org-emphasis t))
6400 "Remove specific display properties that have been added by font lock.
6401 The will remove the raise properties that are used to show superscripts
6402 and subscripts."
6412 "Add raise properties to sub/superscripts."
6416 org-match-substring-regexp
6417 org-match-substring-with-braces-regexp)
6418 limit t)
6428 ;; Handle a_b^c
6431 t
6433 'display
6449 t)))))
6451 ;;;; Visibility cycling, including org-goto and indirect buffer
6453 ;;; Cycling
6464 ;;;###autoload
6466 "TAB-action and visibility cycling for Org-mode.
6468 This is the command invoked in Org-mode by the TAB key. Its main purpose
6469 is outline visibility cycling, but it also invokes other actions
6470 in special contexts.
6472 - When this function is called with a prefix argument, rotate the entire
6473 buffer through 3 states (global cycling)
6474 1. OVERVIEW: Show only top-level headlines.
6475 2. CONTENTS: Show all headlines of all levels, but no body text.
6476 3. SHOW ALL: Show everything.
6477 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6478 determined by the variable `org-startup-folded', and by any VISIBILITY
6479 properties in the buffer.
6480 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6481 including any drawers.
6483 - When inside a table, re-align the table and move to the next field.
6485 - When point is at the beginning of a headline, rotate the subtree started
6486 by this line through 3 different states (local cycling)
6487 1. FOLDED: Only the main headline is shown.
6488 2. CHILDREN: The main headline and the direct children are shown.
6489 From this state, you can move to one of the children
6490 and zoom in further.
6491 3. SUBTREE: Show the entire subtree, including body text.
6492 If there is no subtree, switch directly from CHILDREN to FOLDED.
6494 - When point is at the beginning of an empty headline and the variable
6495 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6496 of the headline by demoting and promoting it to likely levels. This
6497 speeds up creation document structure by pressing TAB once or several
6498 times right after creating a new headline.
6500 - When there is a numeric prefix, go up to a heading with level ARG, do
6501 a `show-subtree' and return to the previous cursor position. If ARG
6502 is negative, go up that many levels.
6504 - When point is not at the beginning of a headline, execute the global
6505 binding for TAB, which is re-indenting the line. See the option
6506 `org-cycle-emulate-tab' for details.
6508 - Special case: if point is at the beginning of the buffer and there is
6509 no headline in line 1, this function will act as if called with prefix arg
6510 (C-u TAB, same as S-TAB) also when called without prefix arg.
6511 But only if also the variable `org-cycle-global-at-bob' is t."
6522 org-inlinetask-min-level
6527 limit-level)))
6530 outline-regexp
6538 org-cycle-hook))
6542 ;; special case: use global cycling
6556 ;; Table: enter it or move to the next field.
6567 ;; Global cycling: delegate to `org-cycle-internal-global'.
6570 ;; Drawers: delegate to `org-flag-drawer'.
6578 ;; Show-subtree, ARG levels up from here.
6586 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6594 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6601 ;; From there: TAB emulation and template completion.
6623 t
6632 "Do the global cycling action."
6633 ;; Hack to avoid display of messages for .org attachments in Gnus
6639 ;; We just created the overview - now do table of contents
6640 ;; This can be slow in very large buffers, so indicate action
6650 ;; We just showed the table of contents - now show everything
6658 ;; Default action: go to overview
6666 "Do the local cycling action."
6669 ;; First, determine end of headline (EOH), end of subtree or item
6670 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6690 ;; Determine end invisible part of buffer (EOL)
6692 ;; XEmacs doesn't have `next-single-char-property-change'
6702 ;; Find out what to do next and set `this-command'
6705 ;; Nothing is hidden behind this heading
6718 org-cycle-skip-children-state-if-no-children))))
6719 ;; Entire subtree is hidden in one line: children view
6726 ;; FIXME: This slows down the func way too much.
6727 ;; How keep drawers hidden in subtree anyway?
6728 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6729 ;; (org-cycle-hide-drawers 'subtree))
6731 ;; Fold every list in subtree to top-level items.
6754 ;; We just showed the children, or no children are there,
6755 ;; now show everything.
6764 ;; Default action: hide the subtree.
6772 ;;;###autoload
6774 "Cycle the global visibility. For details see `org-cycle'.
6776 With a numeric prefix, show all headlines up to that level."
6792 "Set the visibility required by startup options and properties."
6807 "Switch subtree visibilities according to :VISIBILITY: property."
6814 nil t)
6838 ;; This function uses outline-regexp instead of the more fundamental
6839 ;; org-outline-regexp so that org-cycle-global works outside of Org
6840 ;; buffers, where outline-regexp is needed.
6842 "Switch to overview mode, showing only top-level headlines.
6843 Really, this shows all headlines with level equal or greater than the level
6844 of the first headline in the buffer. This is important, because if the
6845 first headline is not level one, then (hide-sublevels 1) gives confusing
6846 results."
6860 "Show all headlines in the buffer, like a table of contents.
6861 With numerical argument N, show content up to level N."
6864 ;; Visit all headings and show their offspring
6871 t)
6880 "Adjust the window after a change in outline visibility.
6881 This function is the default value of the hook `org-cycle-hook'."
6891 "Remove outline overlays that do not contain non-white stuff."
6901 "Fix visibility issues after moving a subtree."
6902 ;; First, find a reasonable region to look at:
6903 ;; Start two siblings above, end three below
6921 ;; Properly fold already folded siblings
6932 "Show empty lines above all visible headlines.
6933 The region to be covered depends on STATE when called through
6934 `org-cycle-hook'. Lisp program can use t for STATE to get the
6935 entire buffer covered. Note that an empty line is only shown if there
6936 are at least `org-cycle-separator-lines' empty lines before the headline."
6946 beg end b e)
6970 ;; Never hide empty lines at the end of the file.
6980 "Move to the parent and re-show empty lines before visible headlines."
6986 "Return `org-agenda-files' list, plus all open org-mode files.
6987 This is useful for operations that need to scan all of a user's
6988 open and agenda-wise Org files."
6996 files))
6999 "Return the beginning position of the current entry."
7003 "Return the end position of the current entry."
7007 "Re-hide all drawers after a visibility state change."
7022 "Re-hide inline task when switching to 'contents visibility state."
7025 org-inlinetask-min-level)
7029 "When FLAG is non-nil, hide the drawer we are within.
7030 Otherwise make it visible."
7042 "Is the end of the current subtree visible?"
7047 "Move cursor to the first headline and recenter the headline.
7048 Optional argument N means put the headline into the Nth line of the window."
7054 ;;; Saving and restoring visibility
7057 "Return a list of the locations of all outline overlays.
7058 These are overlays with the `invisible' property value `outline'.
7059 The return value is a list of cons cells, with start and stop
7060 positions for each overlay.
7061 If USE-MARKERS is set, return the positions as markers."
7079 "Create visibility overlays for all positions in DATA.
7080 DATA should have been made by `org-outline-overlay-data'."
7088 data)))))
7090 ;;; Folding of blocks
7097 "Call FUNCTION at the head of all source blocks in the current buffer.
7098 Optional arguments START and END can be used to limit the range."
7110 "Toggle the visibility of all blocks in the current buffer."
7114 "Fold all blocks in the current buffer."
7120 "Unfold all blocks in the current buffer."
7126 "Toggle visibility of block at point."
7137 "Toggle the visibility of the current block."
7144 ov)
7160 ;; make the block accessible to isearch
7162 ov 'isearch-open-invisible
7173 ;; org-tab-after-check-for-cycling-hook
7175 ;; Remove overlays when changing major mode
7180 ;;; Org-goto
7186 "Set the keymap `org-goto'."
7190 mouse-drag-region universal-argument org-occur))
7191 cmd)
7207 nil)
7208 (org-defkey map "q" 'org-goto-quit)
7209 (org-defkey map "n" 'outline-next-visible-heading)
7210 (org-defkey map "p" 'outline-previous-visible-heading)
7211 (org-defkey map "f" 'outline-forward-same-level)
7212 (org-defkey map "b" 'outline-backward-same-level)
7213 (org-defkey map "u" 'outline-up-heading))
7214 (org-defkey map "/" 'org-occur)
7215 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7216 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7217 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7218 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7219 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7220 map)))
7222 (defconst org-goto-help
7223 "Browse buffer copy, to find location or copy text.%s
7224 RET=jump to location C-g=quit and return to previous location
7225 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7227 (defvar org-goto-start-pos) ; dynamically scoped parameter
7229 (defun org-goto (&optional alternative-interface)
7230 "Look up a different location in the current file, keeping current visibility.
7232 When you want look-up or go to a different location in a
7233 document, the fastest way is often to fold the entire buffer and
7234 then dive into the tree. This method has the disadvantage, that
7235 the previous location will be folded, which may not be what you
7236 want.
7238 This command works around this by showing a copy of the current
7239 buffer in an indirect buffer, in overview mode. You can dive
7240 into the tree in that copy, use org-occur and incremental search
7241 to find a location. When pressing RET or `Q', the command
7242 returns to the original buffer in which the visibility is still
7243 unchanged. After RET it will also jump to the location selected
7244 in the indirect buffer and expose the headline hierarchy above.
7246 With a prefix argument, use the alternative interface: e.g. if
7247 `org-goto-interface' is 'outline use 'outline-path-completion."
7248 (interactive "P")
7249 (org-goto-map)
7250 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7251 (org-refile-use-outline-path t)
7252 (org-refile-target-verify-function nil)
7253 (interface
7254 (if (not alternative-interface)
7255 org-goto-interface
7256 (if (eq org-goto-interface 'outline)
7257 'outline-path-completion
7258 'outline)))
7259 (org-goto-start-pos (point))
7260 (selected-point
7261 (if (eq interface 'outline)
7262 (car (org-get-location (current-buffer) org-goto-help))
7263 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7264 (org-refile-check-position pa)
7265 (nth 3 pa)))))
7266 (if selected-point
7267 (progn
7268 (org-mark-ring-push org-goto-start-pos)
7269 (goto-char selected-point)
7270 (if (or (outline-invisible-p) (org-invisible-p2))
7271 (org-show-context 'org-goto)))
7272 (message "Quit"))))
7274 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7275 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7276 (defvar org-goto-local-auto-isearch-map) ; defined below
7278 (defun org-get-location (buf help)
7279 "Let the user select a location in the Org-mode buffer BUF.
7280 This function uses a recursive edit. It returns the selected position
7281 or nil."
7282 (org-no-popups
7283 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7284 (isearch-hide-immediately nil)
7285 (isearch-search-fun-function
7286 (lambda () 'org-goto-local-search-headings))
7287 (org-goto-selected-point org-goto-exit-command))
7288 (save-excursion
7289 (save-window-excursion
7290 (delete-other-windows)
7291 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7292 (org-pop-to-buffer-same-window
7293 (condition-case nil
7294 (make-indirect-buffer (current-buffer) "*org-goto*")
7295 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7296 (with-output-to-temp-buffer "*Org Help*"
7297 (princ (format help (if org-goto-auto-isearch
7298 " Just type for auto-isearch."
7299 " n/p/f/b/u to navigate, q to quit."))))
7300 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7301 (setq buffer-read-only nil)
7302 (let ((org-startup-truncated t)
7303 (org-startup-folded nil)
7304 (org-startup-align-all-tables nil))
7305 (org-mode)
7306 (org-overview))
7307 (setq buffer-read-only t)
7308 (if (and (boundp 'org-goto-start-pos)
7309 (integer-or-marker-p org-goto-start-pos))
7310 (let ((org-show-hierarchy-above t)
7311 (org-show-siblings t)
7312 (org-show-following-heading t))
7313 (goto-char org-goto-start-pos)
7314 (and (outline-invisible-p) (org-show-context)))
7315 (goto-char (point-min)))
7316 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7317 (message "Select location and press RET")
7318 (use-local-map org-goto-map)
7319 (recursive-edit)))
7320 (kill-buffer "*org-goto*")
7321 (cons org-goto-selected-point org-goto-exit-command))))
7323 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7324 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7325 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7326 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7328 (defun org-goto-local-search-headings (string bound noerror)
7329 "Search and make sure that any matches are in headlines."
7330 (catch 'return
7331 (while (if isearch-forward
7332 (search-forward string bound noerror)
7333 (search-backward string bound noerror))
7334 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7335 (and (member :headline context)
7336 (not (member :tags context))))
7337 (throw 'return (point))))))
7339 (defun org-goto-local-auto-isearch ()
7340 "Start isearch."
7341 (interactive)
7342 (goto-char (point-min))
7343 (let ((keys (this-command-keys)))
7344 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7345 (isearch-mode t)
7346 (isearch-process-search-char (string-to-char keys)))))
7348 (defun org-goto-ret (&optional arg)
7349 "Finish `org-goto' by going to the new location."
7350 (interactive "P")
7351 (setq org-goto-selected-point (point)
7352 org-goto-exit-command 'return)
7353 (throw 'exit nil))
7355 (defun org-goto-left ()
7356 "Finish `org-goto' by going to the new location."
7357 (interactive)
7358 (if (org-at-heading-p)
7359 (progn
7360 (beginning-of-line 1)
7361 (setq org-goto-selected-point (point)
7362 org-goto-exit-command 'left)
7363 (throw 'exit nil))
7364 (error "Not on a heading")))
7366 (defun org-goto-right ()
7367 "Finish `org-goto' by going to the new location."
7368 (interactive)
7369 (if (org-at-heading-p)
7370 (progn
7371 (setq org-goto-selected-point (point)
7372 org-goto-exit-command 'right)
7373 (throw 'exit nil))
7374 (error "Not on a heading")))
7376 (defun org-goto-quit ()
7377 "Finish `org-goto' without cursor motion."
7378 (interactive)
7379 (setq org-goto-selected-point nil)
7380 (setq org-goto-exit-command 'quit)
7381 (throw 'exit nil))
7383 ;;; Indirect buffer display of subtrees
7385 (defvar org-indirect-dedicated-frame nil
7386 "This is the frame being used for indirect tree display.")
7387 (defvar org-last-indirect-buffer nil)
7389 (defun org-tree-to-indirect-buffer (&optional arg)
7390 "Create indirect buffer and narrow it to current subtree.
7391 With a numerical prefix ARG, go up to this level and then take that tree.
7392 If ARG is negative, go up that many levels.
7394 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7395 indirect buffer previously made with this command, to avoid proliferation of
7396 indirect buffers. However, when you call the command with a \
7398 when `org-indirect-buffer-display' is `new-frame', the last buffer
7399 is kept so that you can work with several indirect buffers at the same time.
7400 If `org-indirect-buffer-display' is `dedicated-frame', the \
7402 requests that a new frame be made for the new buffer, so that the dedicated
7403 frame is not changed."
7404 (interactive "P")
7405 (let ((cbuf (current-buffer))
7406 (cwin (selected-window))
7407 (pos (point))
7408 beg end level heading ibuf)
7409 (save-excursion
7410 (org-back-to-heading t)
7411 (when (numberp arg)
7412 (setq level (org-outline-level))
7413 (if (< arg 0) (setq arg (+ level arg)))
7414 (while (> (setq level (org-outline-level)) arg)
7415 (org-up-heading-safe)))
7416 (setq beg (point)
7417 heading (org-get-heading))
7418 (org-end-of-subtree t t)
7419 (if (org-at-heading-p) (backward-char 1))
7420 (setq end (point)))
7421 (if (and (buffer-live-p org-last-indirect-buffer)
7422 (not (eq org-indirect-buffer-display 'new-frame))
7423 (not arg))
7424 (kill-buffer org-last-indirect-buffer))
7425 (setq ibuf (org-get-indirect-buffer cbuf)
7426 org-last-indirect-buffer ibuf)
7427 (cond
7428 ((or (eq org-indirect-buffer-display 'new-frame)
7429 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7430 (select-frame (make-frame))
7431 (delete-other-windows)
7432 (org-pop-to-buffer-same-window ibuf)
7433 (org-set-frame-title heading))
7434 ((eq org-indirect-buffer-display 'dedicated-frame)
7435 (raise-frame
7436 (select-frame (or (and org-indirect-dedicated-frame
7437 (frame-live-p org-indirect-dedicated-frame)
7438 org-indirect-dedicated-frame)
7439 (setq org-indirect-dedicated-frame (make-frame)))))
7440 (delete-other-windows)
7441 (org-pop-to-buffer-same-window ibuf)
7442 (org-set-frame-title (concat "Indirect: " heading)))
7443 ((eq org-indirect-buffer-display 'current-window)
7444 (org-pop-to-buffer-same-window ibuf))
7445 ((eq org-indirect-buffer-display 'other-window)
7446 (pop-to-buffer ibuf))
7447 (t (error "Invalid value")))
7448 (if (featurep 'xemacs)
7449 (save-excursion (org-mode) (turn-on-font-lock)))
7450 (narrow-to-region beg end)
7451 (show-all)
7452 (goto-char pos)
7453 (run-hook-with-args 'org-cycle-hook 'all)
7454 (and (window-live-p cwin) (select-window cwin))))
7456 (defun org-get-indirect-buffer (&optional buffer)
7457 (setq buffer (or buffer (current-buffer)))
7458 (let ((n 1) (base (buffer-name buffer)) bname)
7459 (while (buffer-live-p
7460 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7461 (setq n (1+ n)))
7462 (condition-case nil
7463 (make-indirect-buffer buffer bname 'clone)
7464 (error (make-indirect-buffer buffer bname)))))
7466 (defun org-set-frame-title (title)
7467 "Set the title of the current frame to the string TITLE."
7468 ;; FIXME: how to name a single frame in XEmacs???
7469 (unless (featurep 'xemacs)
7470 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7472 ;;;; Structure editing
7474 ;;; Inserting headlines
7476 (defun org-previous-line-empty-p (&optional next)
7477 "Is the previous line a blank line?
7478 When NEXT is non-nil, check the next line instead."
7479 (save-excursion
7480 (and (not (bobp))
7481 (or (beginning-of-line (if next 2 0)) t)
7482 (save-match-data
7485 (defun org-insert-heading (&optional arg invisible-ok)
7486 "Insert a new heading or item with same depth at point.
7487 If point is in a plain list and ARG is nil, create a new list item.
7488 With one universal prefix argument, insert a heading even in lists.
7489 With two universal prefix arguments, insert the heading at the end
7490 of the parent subtree.
7492 If point is at the beginning of a headline, insert a sibling before
7493 the current headline. If point is not at the beginning, split the line
7494 and create a new headline with the text in the current line after point
7495 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7497 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7498 This is important for non-interactive uses of the command."
7499 (interactive "P")
7500 (cond
7501 ((or (= (buffer-size) 0)
7502 (and (not (save-excursion
7503 (and (ignore-errors (org-back-to-heading invisible-ok))
7504 (org-at-heading-p))))
7505 (or arg (not (org-in-item-p)))))
7506 (insert
7508 (if (org-in-src-block-p) ",* " "* "))
7509 (run-hooks 'org-insert-heading-hook))
7510 ((or arg
7511 org-insert-heading-respect-content
7512 (not (org-insert-item
7513 (save-excursion
7514 (beginning-of-line)
7515 (looking-at org-list-full-item-re)
7516 (match-string 3)))))
7517 (let (begn endn)
7518 (when (org-buffer-narrowed-p)
7519 (setq begn (point-min) endn (point-max))
7520 (widen))
7521 (let* ((empty-line-p nil)
7522 (eops (equal arg '(16))) ; insert at end of parent subtree
7523 (org-insert-heading-respect-content
7524 (or (not (null arg)) org-insert-heading-respect-content))
7525 (level nil)
7526 (on-heading (org-at-heading-p))
7527 (on-empty-line
7529 (head (save-excursion
7530 (condition-case nil
7531 (progn
7532 (org-back-to-heading invisible-ok)
7533 (when (and (not on-heading)
7534 (featurep 'org-inlinetask)
7535 (integerp org-inlinetask-min-level)
7536 (>= (length (match-string 0))
7537 org-inlinetask-min-level))
7538 ;; Find a heading level before the inline task
7539 (while (and (setq level (org-up-heading-safe))
7540 (>= level org-inlinetask-min-level)))
7541 (if (org-at-heading-p)
7542 (org-back-to-heading invisible-ok)
7543 (error "This should not happen")))
7544 (unless (and (save-excursion
7545 (save-match-data
7546 (org-backward-heading-same-level 1 invisible-ok))
7547 (= (point) (match-beginning 0)))
7548 (not (org-previous-line-empty-p t)))
7549 (setq empty-line-p (org-previous-line-empty-p)))
7550 (match-string 0))
7551 (error "* "))))
7552 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7553 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7554 pos hide-previous previous-pos)
7555 (if ;; At the beginning of a heading, open a new line for insertiong
7556 (and (bolp) (org-at-heading-p)
7557 (not eops)
7558 (or (bobp)
7559 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7560 (open-line (if blank 2 1))
7561 (save-excursion
7562 (setq previous-pos (point-at-bol))
7563 (end-of-line)
7564 (setq hide-previous (outline-invisible-p)))
7565 (and org-insert-heading-respect-content
7566 (save-excursion
7567 (while (outline-invisible-p)
7568 (org-show-subtree)
7569 (org-up-heading-safe))))
7570 (let ((split
7571 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7572 (save-excursion
7573 (let ((p (point)))
7574 (goto-char (point-at-bol))
7575 (and (looking-at org-complex-heading-regexp)
7576 (match-beginning 4)
7577 (> p (match-beginning 4)))))))
7578 tags pos)
7579 (cond
7580 ;; Insert a new line, possibly at end of parent subtree
7581 ((and (not arg) (not on-heading) (not on-empty-line)
7582 (not (save-excursion
7583 (beginning-of-line 1)
7584 (looking-at org-list-full-item-re))))
7585 (beginning-of-line 1))
7586 (org-insert-heading-respect-content
7587 (if (not eops)
7588 (progn
7589 (org-end-of-subtree nil t)
7591 (while (and (not (bobp))
7592 ;; Don't delete spaces in empty headlines
7593 (not (looking-back org-outline-regexp))
7595 (backward-delete-char 1)))
7596 (let ((p (point)))
7597 (org-up-heading-safe)
7598 (if (= p (point))
7599 (goto-char (point-max))
7600 (org-end-of-subtree nil t))))
7601 (when (featurep 'org-inlinetask)
7602 (while (and (not (eobp))
7604 (>= (length (match-string 1))
7605 org-inlinetask-min-level))
7606 (org-end-of-subtree nil t)))
7607 (or (bolp) (newline))
7608 (or (org-previous-line-empty-p)
7609 (and blank (newline)))
7610 (if (or empty-line-p eops) (open-line 1)))
7611 ;; Insert a headling containing text after point
7612 ((org-at-heading-p)
7613 (when hide-previous
7614 (show-children)
7615 (org-show-entry))
7617 (setq tags (and (match-end 2) (match-string 2)))
7618 (and (match-end 1)
7619 (delete-region (match-beginning 1) (match-end 1)))
7620 (setq pos (point-at-bol))
7621 (or split (end-of-line 1))
7622 (delete-horizontal-space)
7624 (buffer-substring (point-at-bol) (point)))
7625 (insert " "))
7626 (newline (if blank 2 1))
7627 (when tags
7628 (save-excursion
7629 (goto-char pos)
7630 (end-of-line 1)
7631 (insert " " tags)
7632 (org-set-tags nil 'align))))
7633 (t
7634 (or split (end-of-line 1))
7635 (newline (cond ((and blank (not on-empty-line)) 2)
7636 (blank 1)
7637 (on-empty-line 0) (t 1)))))))
7638 (insert head) (just-one-space)
7639 (setq pos (point))
7640 (end-of-line 1)
7641 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7642 (when (and org-insert-heading-respect-content hide-previous)
7643 (save-excursion
7644 (goto-char previous-pos)
7645 (hide-subtree)))
7646 (when (and begn endn)
7647 (narrow-to-region (min (point) begn) (max (point) endn)))
7648 (run-hooks 'org-insert-heading-hook))))))
7650 (defun org-get-heading (&optional no-tags no-todo)
7651 "Return the heading of the current entry, without the stars.
7652 When NO-TAGS is non-nil, don't include tags.
7653 When NO-TODO is non-nil, don't include TODO keywords."
7654 (save-excursion
7655 (org-back-to-heading t)
7656 (cond
7657 ((and no-tags no-todo)
7658 (looking-at org-complex-heading-regexp)
7659 (match-string 4))
7660 (no-tags
7661 (looking-at (concat org-outline-regexp
7664 (match-string 1))
7665 (no-todo
7666 (looking-at org-todo-line-regexp)
7667 (match-string 3))
7668 (t (looking-at org-heading-regexp)
7669 (match-string 2)))))
7671 (defvar orgstruct-mode) ; defined below
7673 (defun org-heading-components ()
7674 "Return the components of the current heading.
7675 This is a list with the following elements:
7676 - the level as an integer
7677 - the reduced level, different if `org-odd-levels-only' is set.
7678 - the TODO keyword, or nil
7679 - the priority character, like ?A, or nil if no priority is given
7680 - the headline text itself, or the tags string if no headline text
7681 - the tags string, or nil."
7682 (save-excursion
7683 (org-back-to-heading t)
7684 (if (let (case-fold-search)
7685 (looking-at
7686 (if orgstruct-mode
7687 org-heading-regexp
7688 org-complex-heading-regexp)))
7689 (if orgstruct-mode
7690 (list (length (match-string 1))
7691 (org-reduced-level (length (match-string 1)))
7692 nil
7693 nil
7694 (match-string 2)
7695 nil)
7696 (list (length (match-string 1))
7697 (org-reduced-level (length (match-string 1)))
7698 (org-match-string-no-properties 2)
7699 (and (match-end 3) (aref (match-string 3) 2))
7700 (org-match-string-no-properties 4)
7701 (org-match-string-no-properties 5))))))
7703 (defun org-get-entry ()
7704 "Get the entry text, after heading, entire subtree."
7705 (save-excursion
7706 (org-back-to-heading t)
7707 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7709 (defun org-insert-heading-after-current ()
7710 "Insert a new heading with same level as current, after current subtree."
7711 (interactive)
7712 (org-back-to-heading)
7713 (org-insert-heading)
7714 (org-move-subtree-down)
7715 (end-of-line 1))
7717 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7718 "Insert heading with `org-insert-heading-respect-content' set to t."
7719 (interactive "P")
7720 (let ((org-insert-heading-respect-content t))
7721 (org-insert-heading arg invisible-ok)))
7723 (defun org-insert-todo-heading-respect-content (&optional force-state)
7724 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7725 (interactive "P")
7726 (let ((org-insert-heading-respect-content t))
7727 (org-insert-todo-heading force-state t)))
7729 (defun org-insert-todo-heading (arg &optional force-heading)
7730 "Insert a new heading with the same level and TODO state as current heading.
7731 If the heading has no TODO state, or if the state is DONE, use the first
7732 state (TODO by default). Also one prefix arg, force first state. With two
7733 prefix args, force inserting at the end of the parent subtree."
7734 (interactive "P")
7735 (when (or force-heading (not (org-insert-item 'checkbox)))
7736 (org-insert-heading (or (and (equal arg '(16)) '(16))
7737 force-heading))
7738 (save-excursion
7739 (org-back-to-heading)
7740 (outline-previous-heading)
7741 (looking-at org-todo-line-regexp))
7742 (let*
7743 ((new-mark-x
7744 (if (or arg
7745 (not (match-beginning 2))
7746 (member (match-string 2) org-done-keywords))
7747 (car org-todo-keywords-1)
7748 (match-string 2)))
7749 (new-mark
7750 (or
7751 (run-hook-with-args-until-success
7752 'org-todo-get-default-hook new-mark-x nil)
7753 new-mark-x)))
7754 (beginning-of-line 1)
7755 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7756 (if org-treat-insert-todo-heading-as-state-change
7757 (org-todo new-mark)
7758 (insert new-mark " "))))
7759 (when org-provide-todo-statistics
7760 (org-update-parent-todo-statistics))))
7762 (defun org-insert-subheading (arg)
7763 "Insert a new subheading and demote it.
7764 Works for outline headings and for plain lists alike."
7765 (interactive "P")
7766 (org-insert-heading arg)
7767 (cond
7768 ((org-at-heading-p) (org-do-demote))
7769 ((org-at-item-p) (org-indent-item))))
7771 (defun org-insert-todo-subheading (arg)
7772 "Insert a new subheading with TODO keyword or checkbox and demote it.
7773 Works for outline headings and for plain lists alike."
7774 (interactive "P")
7775 (org-insert-todo-heading arg)
7776 (cond
7777 ((org-at-heading-p) (org-do-demote))
7778 ((org-at-item-p) (org-indent-item))))
7780 ;;; Promotion and Demotion
7782 (defvar org-after-demote-entry-hook nil
7783 "Hook run after an entry has been demoted.
7784 The cursor will be at the beginning of the entry.
7785 When a subtree is being demoted, the hook will be called for each node.")
7787 (defvar org-after-promote-entry-hook nil
7788 "Hook run after an entry has been promoted.
7789 The cursor will be at the beginning of the entry.
7790 When a subtree is being promoted, the hook will be called for each node.")
7792 (defun org-promote-subtree ()
7793 "Promote the entire subtree.
7794 See also `org-promote'."
7795 (interactive)
7796 (save-excursion
7797 (org-with-limited-levels (org-map-tree 'org-promote)))
7798 (org-fix-position-after-promote))
7800 (defun org-demote-subtree ()
7801 "Demote the entire subtree. See `org-demote'.
7802 See also `org-promote'."
7803 (interactive)
7804 (save-excursion
7805 (org-with-limited-levels (org-map-tree 'org-demote)))
7806 (org-fix-position-after-promote))
7809 (defun org-do-promote ()
7810 "Promote the current heading higher up the tree.
7811 If the region is active in `transient-mark-mode', promote all headings
7812 in the region."
7813 (interactive)
7814 (save-excursion
7815 (if (org-region-active-p)
7816 (org-map-region 'org-promote (region-beginning) (region-end))
7817 (org-promote)))
7818 (org-fix-position-after-promote))
7820 (defun org-do-demote ()
7821 "Demote the current heading lower down the tree.
7822 If the region is active in `transient-mark-mode', demote all headings
7823 in the region."
7824 (interactive)
7825 (save-excursion
7826 (if (org-region-active-p)
7827 (org-map-region 'org-demote (region-beginning) (region-end))
7828 (org-demote)))
7829 (org-fix-position-after-promote))
7831 (defun org-fix-position-after-promote ()
7832 "Make sure that after pro/demotion cursor position is right."
7833 (let ((pos (point)))
7834 (when (save-excursion
7835 (beginning-of-line 1)
7836 (looking-at org-todo-line-regexp)
7837 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7838 (cond ((eobp) (insert " "))
7839 ((eolp) (insert " "))
7840 ((equal (char-after) ?\ ) (forward-char 1))))))
7842 (defun org-current-level ()
7843 "Return the level of the current entry, or nil if before the first headline.
7844 The level is the number of stars at the beginning of the headline."
7845 (save-excursion
7846 (org-with-limited-levels
7847 (if (ignore-errors (org-back-to-heading t))
7848 (funcall outline-level)))))
7850 (defun org-get-previous-line-level ()
7851 "Return the outline depth of the last headline before the current line.
7852 Returns 0 for the first headline in the buffer, and nil if before the
7853 first headline."
7854 (let ((current-level (org-current-level))
7855 (prev-level (when (> (line-number-at-pos) 1)
7856 (save-excursion
7857 (beginning-of-line 0)
7858 (org-current-level)))))
7859 (cond ((null current-level) nil) ; Before first headline
7860 ((null prev-level) 0) ; At first headline
7861 (prev-level))))
7863 (defun org-reduced-level (l)
7864 "Compute the effective level of a heading.
7865 This takes into account the setting of `org-odd-levels-only'."
7866 (cond
7867 ((zerop l) 0)
7868 (org-odd-levels-only (1+ (floor (/ l 2))))
7869 (t l)))
7871 (defun org-level-increment ()
7872 "Return the number of stars that will be added or removed at a
7873 time to headlines when structure editing, based on the value of
7874 `org-odd-levels-only'."
7875 (if org-odd-levels-only 2 1))
7877 (defun org-get-valid-level (level &optional change)
7878 "Rectify a level change under the influence of `org-odd-levels-only'
7879 LEVEL is a current level, CHANGE is by how much the level should be
7880 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7881 even level numbers will become the next higher odd number."
7882 (if org-odd-levels-only
7883 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7884 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7885 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7886 (max 1 (+ level (or change 0)))))
7888 (if (boundp 'define-obsolete-function-alias)
7889 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7890 (define-obsolete-function-alias 'org-get-legal-level
7891 'org-get-valid-level)
7892 (define-obsolete-function-alias 'org-get-legal-level
7893 'org-get-valid-level "23.1")))
7895 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7896 ;; ̀org-with-limited-levels'
7897 (defun org-promote ()
7898 "Promote the current heading higher up the tree.
7899 If the region is active in `transient-mark-mode', promote all headings
7900 in the region."
7901 (org-back-to-heading t)
7902 (let* ((level (save-match-data (funcall outline-level)))
7903 (after-change-functions (remove 'flyspell-after-change-function
7904 after-change-functions))
7905 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7906 (diff (abs (- level (length up-head) -1))))
7907 (cond ((and (= level 1) org-called-with-limited-levels
7908 org-allow-promoting-top-level-subtree)
7909 (replace-match "# " nil t))
7910 ((= level 1)
7911 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7912 (t (replace-match up-head nil t)))
7913 ;; Fixup tag positioning
7914 (unless (= level 1)
7915 (and org-auto-align-tags (org-set-tags nil t))
7916 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7917 (run-hooks 'org-after-promote-entry-hook)))
7919 (defun org-demote ()
7920 "Demote the current heading lower down the tree.
7921 If the region is active in `transient-mark-mode', demote all headings
7922 in the region."
7923 (org-back-to-heading t)
7924 (let* ((level (save-match-data (funcall outline-level)))
7925 (after-change-functions (remove 'flyspell-after-change-function
7926 after-change-functions))
7927 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7928 (diff (abs (- level (length down-head) -1))))
7929 (replace-match down-head nil t)
7930 ;; Fixup tag positioning
7931 (and org-auto-align-tags (org-set-tags nil t))
7932 (if org-adapt-indentation (org-fixup-indentation diff))
7933 (run-hooks 'org-after-demote-entry-hook)))
7935 (defun org-cycle-level ()
7936 "Cycle the level of an empty headline through possible states.
7937 This goes first to child, then to parent, level, then up the hierarchy.
7938 After top level, it switches back to sibling level."
7939 (interactive)
7940 (let ((org-adapt-indentation nil))
7941 (when (org-point-at-end-of-empty-headline)
7942 (setq this-command 'org-cycle-level) ; Only needed for caching
7943 (let ((cur-level (org-current-level))
7944 (prev-level (org-get-previous-line-level)))
7945 (cond
7946 ;; If first headline in file, promote to top-level.
7947 ((= prev-level 0)
7948 (loop repeat (/ (- cur-level 1) (org-level-increment))
7949 do (org-do-promote)))
7950 ;; If same level as prev, demote one.
7951 ((= prev-level cur-level)
7952 (org-do-demote))
7953 ;; If parent is top-level, promote to top level if not already.
7954 ((= prev-level 1)
7955 (loop repeat (/ (- cur-level 1) (org-level-increment))
7956 do (org-do-promote)))
7957 ;; If top-level, return to prev-level.
7958 ((= cur-level 1)
7959 (loop repeat (/ (- prev-level 1) (org-level-increment))
7960 do (org-do-demote)))
7961 ;; If less than prev-level, promote one.
7962 ((< cur-level prev-level)
7963 (org-do-promote))
7964 ;; If deeper than prev-level, promote until higher than
7965 ;; prev-level.
7966 ((> cur-level prev-level)
7967 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7968 do (org-do-promote))))
7969 t))))
7971 (defun org-map-tree (fun)
7972 "Call FUN for every heading underneath the current one."
7973 (org-back-to-heading)
7974 (let ((level (funcall outline-level)))
7975 (save-excursion
7976 (funcall fun)
7977 (while (and (progn
7978 (outline-next-heading)
7979 (> (funcall outline-level) level))
7980 (not (eobp)))
7981 (funcall fun)))))
7983 (defun org-map-region (fun beg end)
7984 "Call FUN for every heading between BEG and END."
7985 (let ((org-ignore-region t))
7986 (save-excursion
7987 (setq end (copy-marker end))
7988 (goto-char beg)
7989 (if (and (re-search-forward org-outline-regexp-bol nil t)
7990 (< (point) end))
7991 (funcall fun))
7992 (while (and (progn
7993 (outline-next-heading)
7994 (< (point) end))
7995 (not (eobp)))
7996 (funcall fun)))))
7998 (defvar org-property-end-re) ; silence byte-compiler
7999 (defun org-fixup-indentation (diff)
8000 "Change the indentation in the current entry by DIFF.
8001 However, if any line in the current entry has no indentation, or if it
8002 would end up with no indentation after the change, nothing at all is done."
8003 (save-excursion
8004 (let ((end (save-excursion (outline-next-heading)
8005 (point-marker)))
8006 (prohibit (if (> diff 0)
8009 col)
8010 (unless (save-excursion (end-of-line 1)
8011 (re-search-forward prohibit end t))
8012 (while (and (< (point) end)
8014 (goto-char (match-end 0))
8015 (setq col (current-column))
8016 (if (< diff 0) (replace-match ""))
8017 (org-indent-to-column (+ diff col))))
8018 (move-marker end nil))))
8020 (defun org-convert-to-odd-levels ()
8021 "Convert an org-mode file with all levels allowed to one with odd levels.
8022 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8023 level 5 etc."
8024 (interactive)
8025 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8026 (let ((outline-level 'org-outline-level)
8027 (org-odd-levels-only nil) n)
8028 (save-excursion
8029 (goto-char (point-min))
8031 (setq n (- (length (match-string 0)) 2))
8032 (while (>= (setq n (1- n)) 0)
8033 (org-demote))
8034 (end-of-line 1))))))
8036 (defun org-convert-to-oddeven-levels ()
8037 "Convert an org-mode file with only odd levels to one with odd/even levels.
8038 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8039 file contains a section with an even level, conversion would
8040 destroy the structure of the file. An error is signaled in this
8041 case."
8042 (interactive)
8043 (goto-char (point-min))
8044 ;; First check if there are no even levels
8046 (org-show-context t)
8047 (error "Not all levels are odd in this file. Conversion not possible"))
8048 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8049 (let ((outline-regexp org-outline-regexp)
8050 (outline-level 'org-outline-level)
8051 (org-odd-levels-only nil) n)
8052 (save-excursion
8053 (goto-char (point-min))
8055 (setq n (/ (1- (length (match-string 0))) 2))
8056 (while (>= (setq n (1- n)) 0)
8057 (org-promote))
8058 (end-of-line 1))))))
8060 (defun org-tr-level (n)
8061 "Make N odd if required."
8062 (if org-odd-levels-only (1+ (/ n 2)) n))
8064 ;;; Vertical tree motion, cutting and pasting of subtrees
8066 (defun org-move-subtree-up (&optional arg)
8067 "Move the current subtree up past ARG headlines of the same level."
8068 (interactive "p")
8069 (org-move-subtree-down (- (prefix-numeric-value arg))))
8071 (defun org-move-subtree-down (&optional arg)
8072 "Move the current subtree down past ARG headlines of the same level."
8073 (interactive "p")
8074 (setq arg (prefix-numeric-value arg))
8075 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8076 'org-get-last-sibling))
8077 (ins-point (make-marker))
8078 (cnt (abs arg))
8079 (col (current-column))
8080 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8081 ;; Select the tree
8082 (org-back-to-heading)
8083 (setq beg0 (point))
8084 (save-excursion
8085 (setq ne-beg (org-back-over-empty-lines))
8086 (setq beg (point)))
8087 (save-match-data
8088 (save-excursion (outline-end-of-heading)
8089 (setq folded (outline-invisible-p)))
8090 (outline-end-of-subtree))
8091 (outline-next-heading)
8092 (setq ne-end (org-back-over-empty-lines))
8093 (setq end (point))
8094 (goto-char beg0)
8095 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8096 ;; include less whitespace
8097 (save-excursion
8098 (goto-char beg)
8099 (forward-line (- ne-beg ne-end))
8100 (setq beg (point))))
8101 ;; Find insertion point, with error handling
8102 (while (> cnt 0)
8103 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8104 (progn (goto-char beg0)
8105 (user-error "Cannot move past superior level or buffer limit")))
8106 (setq cnt (1- cnt)))
8107 (if (> arg 0)
8108 ;; Moving forward - still need to move over subtree
8109 (progn (org-end-of-subtree t t)
8110 (save-excursion
8111 (org-back-over-empty-lines)
8112 (or (bolp) (newline)))))
8113 (setq ne-ins (org-back-over-empty-lines))
8114 (move-marker ins-point (point))
8115 (setq txt (buffer-substring beg end))
8116 (org-save-markers-in-region beg end)
8117 (delete-region beg end)
8118 (org-remove-empty-overlays-at beg)
8119 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8120 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8122 (let ((bbb (point)))
8123 (insert-before-markers txt)
8124 (org-reinstall-markers-in-region bbb)
8125 (move-marker ins-point bbb))
8127 (setq ins-end (point))
8128 (goto-char ins-point)
8129 (org-skip-whitespace)
8130 (when (and (< arg 0)
8131 (org-first-sibling-p)
8132 (> ne-ins ne-beg))
8133 ;; Move whitespace back to beginning
8134 (save-excursion
8135 (goto-char ins-end)
8136 (let ((kill-whole-line t))
8137 (kill-line (- ne-ins ne-beg)) (point)))
8139 (move-marker ins-point nil)
8140 (if folded
8141 (hide-subtree)
8142 (org-show-entry)
8143 (show-children)
8144 (org-cycle-hide-drawers 'children))
8145 (org-clean-visibility-after-subtree-move)
8146 ;; move back to the initial column we were at
8147 (move-to-column col)))
8149 (defvar org-subtree-clip ""
8150 "Clipboard for cut and paste of subtrees.
8151 This is actually only a copy of the kill, because we use the normal kill
8152 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8154 (defvar org-subtree-clip-folded nil
8155 "Was the last copied subtree folded?
8156 This is used to fold the tree back after pasting.")
8158 (defun org-cut-subtree (&optional n)
8159 "Cut the current subtree into the clipboard.
8160 With prefix arg N, cut this many sequential subtrees.
8161 This is a short-hand for marking the subtree and then cutting it."
8162 (interactive "p")
8163 (org-copy-subtree n 'cut))
8165 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8166 "Cut the current subtree into the clipboard.
8167 With prefix arg N, cut this many sequential subtrees.
8168 This is a short-hand for marking the subtree and then copying it.
8169 If CUT is non-nil, actually cut the subtree.
8170 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8171 of some markers in the region, even if CUT is non-nil. This is
8172 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8173 (interactive "p")
8174 (let (beg end folded (beg0 (point)))
8175 (if (org-called-interactively-p 'any)
8176 (org-back-to-heading nil) ; take what looks like a subtree
8177 (org-back-to-heading t)) ; take what is really there
8178 (setq beg (point))
8180 (save-match-data
8181 (if nosubtrees
8182 (outline-next-heading)
8183 (save-excursion (outline-end-of-heading)
8184 (setq folded (outline-invisible-p)))
8185 (condition-case nil
8186 (org-forward-heading-same-level (1- n) t)
8187 (error nil))
8188 (org-end-of-subtree t t)))
8189 (setq end (point))
8190 (goto-char beg0)
8191 (when (> end beg)
8192 (setq org-subtree-clip-folded folded)
8193 (when (or cut force-store-markers)
8194 (org-save-markers-in-region beg end))
8195 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8196 (setq org-subtree-clip (current-kill 0))
8197 (message "%s: Subtree(s) with %d characters"
8198 (if cut "Cut" "Copied")
8199 (length org-subtree-clip)))))
8201 (defun org-paste-subtree (&optional level tree for-yank)
8202 "Paste the clipboard as a subtree, with modification of headline level.
8203 The entire subtree is promoted or demoted in order to match a new headline
8204 level.
8206 If the cursor is at the beginning of a headline, the same level as
8207 that headline is used to paste the tree.
8209 If not, the new level is derived from the *visible* headings
8210 before and after the insertion point, and taken to be the inferior headline
8211 level of the two. So if the previous visible heading is level 3 and the
8212 next is level 4 (or vice versa), level 4 will be used for insertion.
8213 This makes sure that the subtree remains an independent subtree and does
8214 not swallow low level entries.
8216 You can also force a different level, either by using a numeric prefix
8217 argument, or by inserting the heading marker by hand. For example, if the
8220 If optional TREE is given, use this text instead of the kill ring.
8222 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8223 move back over whitespace before inserting, and move point to the end of
8224 the inserted text when done."
8225 (interactive "P")
8226 (setq tree (or tree (and kill-ring (current-kill 0))))
8227 (unless (org-kill-is-subtree-p tree)
8228 (error "%s"
8229 (substitute-command-keys
8231 (org-with-limited-levels
8232 (let* ((visp (not (outline-invisible-p)))
8233 (txt tree)
8235 (old-level (if (string-match org-outline-regexp-bol txt)
8236 (- (match-end 0) (match-beginning 0) 1)
8237 -1))
8238 (force-level (cond (level (prefix-numeric-value level))
8240 (string-match
8242 (point-at-bol) (point))))
8243 (- (match-end 1) (match-beginning 1)))
8244 ((and (bolp)
8245 (looking-at org-outline-regexp))
8246 (- (match-end 0) (point) 1))))
8247 (previous-level (save-excursion
8248 (condition-case nil
8249 (progn
8250 (outline-previous-visible-heading 1)
8251 (if (looking-at ^re_)
8252 (- (match-end 0) (match-beginning 0) 1)
8253 1))
8254 (error 1))))
8255 (next-level (save-excursion
8256 (condition-case nil
8257 (progn
8258 (or (looking-at org-outline-regexp)
8259 (outline-next-visible-heading 1))
8260 (if (looking-at ^re_)
8261 (- (match-end 0) (match-beginning 0) 1)
8262 1))
8263 (error 1))))
8264 (new-level (or force-level (max previous-level next-level)))
8265 (shift (if (or (= old-level -1)
8266 (= new-level -1)
8267 (= old-level new-level))
8268 0
8269 (- new-level old-level)))
8270 (delta (if (> shift 0) -1 1))
8271 (func (if (> shift 0) 'org-demote 'org-promote))
8272 (org-odd-levels-only nil)
8273 beg end newend)
8274 ;; Remove the forced level indicator
8275 (if force-level
8276 (delete-region (point-at-bol) (point)))
8277 ;; Paste
8278 (beginning-of-line (if (bolp) 1 2))
8279 (setq beg (point))
8280 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8281 (insert-before-markers txt)
8283 (setq newend (point))
8284 (org-reinstall-markers-in-region beg)
8285 (setq end (point))
8286 (goto-char beg)
8288 (setq beg (point))
8289 (if (and (outline-invisible-p) visp)
8290 (save-excursion (outline-show-heading)))
8291 ;; Shift if necessary
8292 (unless (= shift 0)
8293 (save-restriction
8294 (narrow-to-region beg end)
8295 (while (not (= shift 0))
8296 (org-map-region func (point-min) (point-max))
8297 (setq shift (+ delta shift)))
8298 (goto-char (point-min))
8299 (setq newend (point-max))))
8300 (when (or (org-called-interactively-p 'interactive) for-yank)
8301 (message "Clipboard pasted as level %d subtree" new-level))
8302 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8303 kill-ring
8304 (eq org-subtree-clip (current-kill 0))
8305 org-subtree-clip-folded)
8306 ;; The tree was folded before it was killed/copied
8307 (hide-subtree))
8308 (and for-yank (goto-char newend)))))
8310 (defun org-kill-is-subtree-p (&optional txt)
8311 "Check if the current kill is an outline subtree, or a set of trees.
8312 Returns nil if kill does not start with a headline, or if the first
8313 headline level is not the largest headline level in the tree.
8314 So this will actually accept several entries of equal levels as well,
8315 which is OK for `org-paste-subtree'.
8316 If optional TXT is given, check this string instead of the current kill."
8317 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8318 (re (org-get-limited-outline-regexp))
8319 (^re (concat "^" re))
8320 (start-level (and kill
8321 (string-match
8323 kill)
8324 (- (match-end 2) (match-beginning 2) 1)))
8325 (start (1+ (or (match-beginning 2) -1))))
8326 (if (not start-level)
8327 (progn
8328 nil) ;; does not even start with a heading
8329 (catch 'exit
8330 (while (setq start (string-match ^re kill (1+ start)))
8331 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8332 (throw 'exit nil)))
8333 t))))
8335 (defvar org-markers-to-move nil
8336 "Markers that should be moved with a cut-and-paste operation.
8337 Those markers are stored together with their positions relative to
8338 the start of the region.")
8340 (defun org-save-markers-in-region (beg end)
8341 "Check markers in region.
8342 If these markers are between BEG and END, record their position relative
8343 to BEG, so that after moving the block of text, we can put the markers back
8344 into place.
8345 This function gets called just before an entry or tree gets cut from the
8346 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8347 called immediately, to move the markers with the entries."
8348 (setq org-markers-to-move nil)
8349 (when (featurep 'org-clock)
8350 (org-clock-save-markers-for-cut-and-paste beg end))
8351 (when (featurep 'org-agenda)
8352 (org-agenda-save-markers-for-cut-and-paste beg end)))
8354 (defun org-check-and-save-marker (marker beg end)
8355 "Check if MARKER is between BEG and END.
8356 If yes, remember the marker and the distance to BEG."
8357 (when (and (marker-buffer marker)
8358 (equal (marker-buffer marker) (current-buffer)))
8359 (if (and (>= marker beg) (< marker end))
8360 (push (cons marker (- marker beg)) org-markers-to-move))))
8362 (defun org-reinstall-markers-in-region (beg)
8363 "Move all remembered markers to their position relative to BEG."
8364 (mapc (lambda (x)
8365 (move-marker (car x) (+ beg (cdr x))))
8366 org-markers-to-move)
8367 (setq org-markers-to-move nil))
8369 (defun org-narrow-to-subtree ()
8370 "Narrow buffer to the current subtree."
8371 (interactive)
8372 (save-excursion
8373 (save-match-data
8374 (org-with-limited-levels
8375 (narrow-to-region
8376 (progn (org-back-to-heading t) (point))
8377 (progn (org-end-of-subtree t t)
8378 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8379 (point)))))))
8381 (defun org-narrow-to-block ()
8382 "Narrow buffer to the current block."
8383 (interactive)
8384 (let* ((case-fold-search t)
8387 (if blockp
8388 (narrow-to-region (car blockp) (cdr blockp))
8389 (error "Not in a block"))))
8391 (eval-when-compile
8392 (defvar org-property-drawer-re))
8394 (defvar org-property-start-re) ;; defined below
8395 (defun org-clone-subtree-with-time-shift (n &optional shift)
8396 "Clone the task (subtree) at point N times.
8397 The clones will be inserted as siblings.
8399 In interactive use, the user will be prompted for the number of
8400 clones to be produced. When called with a universal prefix argument
8401 and if the entry has a timestamp, the user will also be prompted for
8402 a time shift, which may be a repeater as used in time stamps, for
8403 example `+3d'.
8405 When a valid repeater is given and the entry contains any time
8406 stamps, the clones will become a sequence in time, with time
8407 stamps in the subtree shifted for each clone produced. If SHIFT
8408 is nil or the empty string, time stamps will be left alone. The
8409 ID property of the original subtree is removed.
8411 If the original subtree did contain time stamps with a repeater,
8412 the following will happen:
8413 - the repeater will be removed in each clone
8414 - an additional clone will be produced, with the current, unshifted
8415 date(s) in the entry.
8416 - the original entry will be placed *after* all the clones, with
8417 repeater intact.
8418 - the start days in the repeater in the original entry will be shifted
8419 to past the last clone.
8420 In this way you can spell out a number of instances of a repeating task,
8421 and still retain the repeater to cover future instances of the task."
8422 (interactive "nNumber of clones to produce: ")
8423 (let ((shift
8424 (or shift
8425 (if (and (equal current-prefix-arg '(4))
8426 (save-excursion
8427 (re-search-forward org-ts-regexp-both
8428 (save-excursion
8429 (org-end-of-subtree t)
8430 (point)) t)))
8431 (read-from-minibuffer
8432 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8433 ""))) ;; No time shift
8434 (n-no-remove -1)
8435 (drawer-re org-drawer-regexp)
8436 beg end template task idprop
8437 shift-n shift-what doshift nmin nmax)
8438 (if (not (and (integerp n) (> n 0)))
8439 (error "Invalid number of replications %s" n))
8442 shift)))
8443 (error "Invalid shift specification %s" shift))
8444 (when doshift
8445 (setq shift-n (string-to-number (match-string 1 shift))
8446 shift-what (cdr (assoc (match-string 2 shift)
8447 '(("d" . day) ("w" . week)
8448 ("m" . month) ("y" . year))))))
8449 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8450 (setq nmin 1 nmax n)
8451 (org-back-to-heading t)
8452 (setq beg (point))
8453 (setq idprop (org-entry-get nil "ID"))
8454 (org-end-of-subtree t t)
8456 (setq end (point))
8457 (setq template (buffer-substring beg end))
8458 (when (and doshift
8460 (delete-region beg end)
8461 (setq end beg)
8462 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8463 (goto-char end)
8464 (loop for n from nmin to nmax do
8465 ;; prepare clone
8466 (with-temp-buffer
8467 (insert template)
8468 (org-mode)
8469 (goto-char (point-min))
8470 (org-show-subtree)
8471 (and idprop (if org-clone-delete-id
8472 (org-entry-delete nil "ID")
8473 (org-id-get-create t)))
8474 (unless (= n 0)
8476 (kill-whole-line))
8477 (goto-char (point-min))
8478 (while (re-search-forward drawer-re nil t)
8479 (mapc (lambda (d)
8480 (org-remove-empty-drawer-at d (point))) org-drawers)))
8481 (goto-char (point-min))
8482 (when doshift
8483 (while (re-search-forward org-ts-regexp-both nil t)
8484 (org-timestamp-change (* n shift-n) shift-what))
8485 (unless (= n n-no-remove)
8486 (goto-char (point-min))
8487 (while (re-search-forward org-ts-regexp nil t)
8488 (save-excursion
8489 (goto-char (match-beginning 0))
8491 (delete-region (match-beginning 1) (match-end 1)))))))
8492 (setq task (buffer-string)))
8493 (insert task))
8494 (goto-char beg)))
8496 ;;; Outline Sorting
8498 (defun org-sort (with-case)
8499 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8500 Optional argument WITH-CASE means sort case-sensitively."
8501 (interactive "P")
8502 (cond
8503 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8504 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8505 (t
8506 (org-call-with-arg 'org-sort-entries with-case))))
8508 (defun org-sort-remove-invisible (s)
8509 "Remove invisible links from string S."
8510 (remove-text-properties 0 (length s) org-rm-props s)
8511 (while (string-match org-bracket-link-regexp s)
8512 (setq s (replace-match (if (match-end 2)
8513 (match-string 3 s)
8514 (match-string 1 s)) t t s)))
8515 (let ((st (format " %s " s)))
8516 (while (string-match org-emph-re st)
8517 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8518 (setq s (substring st 1 -1)))
8519 s)
8521 (defvar org-priority-regexp) ; defined later in the file
8523 (defvar org-after-sorting-entries-or-items-hook nil
8524 "Hook that is run after a bunch of entries or items have been sorted.
8525 When children are sorted, the cursor is in the parent line when this
8526 hook gets called. When a region or a plain list is sorted, the cursor
8527 will be in the first entry of the sorted region/list.")
8529 (defun org-sort-entries
8530 (&optional with-case sorting-type getkey-func compare-func property)
8531 "Sort entries on a certain level of an outline tree.
8532 If there is an active region, the entries in the region are sorted.
8533 Else, if the cursor is before the first entry, sort the top-level items.
8534 Else, the children of the entry at point are sorted.
8536 Sorting can be alphabetically, numerically, by date/time as given by
8537 a time stamp, by a property, by priority order, or by a custom function.
8539 The command prompts for the sorting type unless it has been given to the
8540 function through the SORTING-TYPE argument, which needs to be a character,
8541 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8542 precise meaning of each character:
8544 n Numerically, by converting the beginning of the entry/item to a number.
8545 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8546 o By order of TODO keywords.
8547 t By date/time, either the first active time stamp in the entry, or, if
8548 none exist, by the first inactive one.
8549 s By the scheduled date/time.
8550 d By deadline date/time.
8551 c By creation time, which is assumed to be the first inactive time stamp
8552 at the beginning of a line.
8553 p By priority according to the cookie.
8554 r By the value of a property.
8556 Capital letters will reverse the sort order.
8558 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8559 called with point at the beginning of the record. It must return either
8560 a string or a number that should serve as the sorting key for that record.
8562 Comparing entries ignores case by default. However, with an optional argument
8563 WITH-CASE, the sorting considers case as well.
8565 Sorting is done against the visible part of the headlines, it ignores hidden
8566 links."
8567 (interactive "P")
8568 (let ((case-func (if with-case 'identity 'downcase))
8569 (cmstr
8570 ;; The clock marker is lost when using `sort-subr', let's
8571 ;; store the clocking string.
8572 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8573 (save-excursion
8574 (goto-char org-clock-marker)
8575 (looking-back "^.*") (match-string-no-properties 0))))
8576 start beg end stars re re2
8577 txt what tmp)
8578 ;; Find beginning and end of region to sort
8579 (cond
8580 ((org-region-active-p)
8581 ;; we will sort the region
8582 (setq end (region-end)
8583 what "region")
8584 (goto-char (region-beginning))
8585 (if (not (org-at-heading-p)) (outline-next-heading))
8586 (setq start (point)))
8587 ((or (org-at-heading-p)
8588 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8589 ;; we will sort the children of the current headline
8590 (org-back-to-heading)
8591 (setq start (point)
8592 end (progn (org-end-of-subtree t t)
8594 (org-back-over-empty-lines)
8595 (point))
8596 what "children")
8597 (goto-char start)
8598 (show-subtree)
8599 (outline-next-heading))
8600 (t
8601 ;; we will sort the top-level entries in this file
8602 (goto-char (point-min))
8603 (or (org-at-heading-p) (outline-next-heading))
8604 (setq start (point))
8605 (goto-char (point-max))
8606 (beginning-of-line 1)
8608 ;; File ends in a non-white line
8609 (end-of-line 1)
8611 (setq end (point-max))
8612 (setq what "top-level")
8613 (goto-char start)
8614 (show-all)))
8616 (setq beg (point))
8617 (if (>= beg end) (error "Nothing to sort"))
8620 (setq stars (match-string 1)
8621 re (concat "^" (regexp-quote stars) " +")
8623 txt (buffer-substring beg end))
8625 (if (and (not (equal stars "*")) (string-match re2 txt))
8626 (error "Region to sort contains a level above the first entry"))
8628 (unless sorting-type
8629 (message
8630 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8632 A/N/P/R/O/F/T/S/D/C means reversed:"
8633 what)
8634 (setq sorting-type (read-char-exclusive))
8636 (unless getkey-func
8637 (and (= (downcase sorting-type) ?f)
8638 (setq getkey-func
8639 (org-icompleting-read "Sort using function: "
8640 obarray 'fboundp t nil nil))
8641 (setq getkey-func (intern getkey-func))))
8643 (and (= (downcase sorting-type) ?r)
8644 (not property)
8645 (setq property
8646 (org-icompleting-read "Property: "
8647 (mapcar 'list (org-buffer-property-keys t))
8648 nil t))))
8650 (message "Sorting entries...")
8652 (save-restriction
8653 (narrow-to-region start end)
8654 (let ((dcst (downcase sorting-type))
8655 (case-fold-search nil)
8656 (now (current-time)))
8657 (sort-subr
8658 (/= dcst sorting-type)
8659 ;; This function moves to the beginning character of the "record" to
8660 ;; be sorted.
8661 (lambda nil
8662 (if (re-search-forward re nil t)
8663 (goto-char (match-beginning 0))
8664 (goto-char (point-max))))
8665 ;; This function moves to the last character of the "record" being
8666 ;; sorted.
8667 (lambda nil
8668 (save-match-data
8669 (condition-case nil
8670 (outline-forward-same-level 1)
8671 (error
8672 (goto-char (point-max))))))
8673 ;; This function returns the value that gets sorted against.
8674 (lambda nil
8675 (cond
8676 ((= dcst ?n)
8677 (if (looking-at org-complex-heading-regexp)
8678 (string-to-number (org-sort-remove-invisible (match-string 4)))
8679 nil))
8680 ((= dcst ?a)
8681 (if (looking-at org-complex-heading-regexp)
8682 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8683 nil))
8684 ((= dcst ?t)
8685 (let ((end (save-excursion (outline-next-heading) (point))))
8686 (if (or (re-search-forward org-ts-regexp end t)
8687 (re-search-forward org-ts-regexp-both end t))
8688 (org-time-string-to-seconds (match-string 0))
8689 (org-float-time now))))
8690 ((= dcst ?c)
8691 (let ((end (save-excursion (outline-next-heading) (point))))
8692 (if (re-search-forward
8694 end t)
8695 (org-time-string-to-seconds (match-string 0))
8696 (org-float-time now))))
8697 ((= dcst ?s)
8698 (let ((end (save-excursion (outline-next-heading) (point))))
8699 (if (re-search-forward org-scheduled-time-regexp end t)
8700 (org-time-string-to-seconds (match-string 1))
8701 (org-float-time now))))
8702 ((= dcst ?d)
8703 (let ((end (save-excursion (outline-next-heading) (point))))
8704 (if (re-search-forward org-deadline-time-regexp end t)
8705 (org-time-string-to-seconds (match-string 1))
8706 (org-float-time now))))
8707 ((= dcst ?p)
8708 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8709 (string-to-char (match-string 2))
8710 org-default-priority))
8711 ((= dcst ?r)
8712 (or (org-entry-get nil property) ""))
8713 ((= dcst ?o)
8714 (if (looking-at org-complex-heading-regexp)
8715 (- 9999 (length (member (match-string 2)
8716 org-todo-keywords-1)))))
8717 ((= dcst ?f)
8718 (if getkey-func
8719 (progn
8720 (setq tmp (funcall getkey-func))
8721 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8722 tmp)
8723 (error "Invalid key function `%s'" getkey-func)))
8724 (t (error "Invalid sorting type `%c'" sorting-type))))
8725 nil
8726 (cond
8727 ((= dcst ?a) 'string<)
8728 ((= dcst ?f) compare-func)
8729 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8730 (run-hooks 'org-after-sorting-entries-or-items-hook)
8731 ;; Reset the clock marker if needed
8732 (when cmstr
8733 (save-excursion
8734 (goto-char start)
8735 (search-forward cmstr nil t)
8736 (move-marker org-clock-marker (point))))
8737 (message "Sorting entries...done")))
8739 (defun org-do-sort (table what &optional with-case sorting-type)
8740 "Sort TABLE of WHAT according to SORTING-TYPE.
8741 The user will be prompted for the SORTING-TYPE if the call to this
8742 function does not specify it. WHAT is only for the prompt, to indicate
8743 what is being sorted. The sorting key will be extracted from
8744 the car of the elements of the table.
8745 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8746 (unless sorting-type
8747 (message
8748 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8749 what)
8750 (setq sorting-type (read-char-exclusive)))
8751 (let ((dcst (downcase sorting-type))
8752 extractfun comparefun)
8753 ;; Define the appropriate functions
8754 (cond
8755 ((= dcst ?n)
8756 (setq extractfun 'string-to-number
8757 comparefun (if (= dcst sorting-type) '< '>)))
8758 ((= dcst ?a)
8759 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8760 (lambda(x) (downcase (org-sort-remove-invisible x))))
8761 comparefun (if (= dcst sorting-type)
8762 'string<
8763 (lambda (a b) (and (not (string< a b))
8764 (not (string= a b)))))))
8765 ((= dcst ?t)
8766 (setq extractfun
8767 (lambda (x)
8768 (if (or (string-match org-ts-regexp x)
8769 (string-match org-ts-regexp-both x))
8770 (org-float-time
8771 (org-time-string-to-time (match-string 0 x)))
8772 0))
8773 comparefun (if (= dcst sorting-type) '< '>)))
8774 (t (error "Invalid sorting type `%c'" sorting-type)))
8776 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8777 table)
8778 (lambda (a b) (funcall comparefun (car a) (car b))))))
8781 ;;; The orgstruct minor mode
8783 ;; Define a minor mode which can be used in other modes in order to
8784 ;; integrate the org-mode structure editing commands.
8786 ;; This is really a hack, because the org-mode structure commands use
8787 ;; keys which normally belong to the major mode. Here is how it
8788 ;; works: The minor mode defines all the keys necessary to operate the
8789 ;; structure commands, but wraps the commands into a function which
8790 ;; tests if the cursor is currently at a headline or a plain list
8791 ;; item. If that is the case, the structure command is used,
8792 ;; temporarily setting many Org-mode variables like regular
8793 ;; expressions for filling etc. However, when any of those keys is
8794 ;; used at a different location, function uses `key-binding' to look
8795 ;; up if the key has an associated command in another currently active
8796 ;; keymap (minor modes, major mode, global), and executes that
8797 ;; command. There might be problems if any of the keys is otherwise
8798 ;; used as a prefix key.
8800 (defcustom orgstruct-heading-prefix-regexp nil
8801 "Regexp that matches the custom prefix of Org headlines in
8802 orgstruct(++)-mode."
8803 :group 'org
8804 :version "24.4"
8805 :package-version '(Org . "8.0")
8806 :type 'string)
8807 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8809 (defcustom orgstruct-setup-hook nil
8810 "Hook run after orgstruct-mode-map is filled."
8811 :group 'org
8812 :version "24.4"
8813 :package-version '(Org . "8.0")
8814 :type 'hook)
8816 (defvar orgstruct-initialized nil)
8818 (defvar org-local-vars nil
8819 "List of local variables, for use by `orgstruct-mode'.")
8821 ;;;###autoload
8822 (define-minor-mode orgstruct-mode
8823 "Toggle the minor mode `orgstruct-mode'.
8824 This mode is for using Org-mode structure commands in other
8825 modes. The following keys behave as if Org-mode were active, if
8826 the cursor is on a headline, or on a plain list item (both as
8827 defined by Org-mode)."
8828 nil " OrgStruct" (make-sparse-keymap)
8829 (funcall (if orgstruct-mode
8830 'add-to-invisibility-spec
8831 'remove-from-invisibility-spec)
8832 '(outline . t))
8833 (when orgstruct-mode
8834 (org-load-modules-maybe)
8835 (unless orgstruct-initialized
8836 (orgstruct-setup)
8837 (setq orgstruct-initialized t))))
8839 ;;;###autoload
8840 (defun turn-on-orgstruct ()
8841 "Unconditionally turn on `orgstruct-mode'."
8842 (orgstruct-mode 1))
8844 (defvar org-fb-vars nil)
8845 (make-variable-buffer-local 'org-fb-vars)
8846 (defun orgstruct++-mode (&optional arg)
8847 "Toggle `orgstruct-mode', the enhanced version of it.
8848 In addition to setting orgstruct-mode, this also exports all
8849 indentation and autofilling variables from org-mode into the
8850 buffer. It will also recognize item context in multiline items."
8851 (interactive "P")
8852 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8853 (if (< arg 1)
8854 (progn (orgstruct-mode -1)
8855 (mapc (lambda(v)
8856 (org-set-local (car v)
8857 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8858 org-fb-vars))
8859 (orgstruct-mode 1)
8860 (setq org-fb-vars nil)
8861 (let (var val)
8862 (mapc
8863 (lambda (x)
8864 (when (string-match
8866 (symbol-name (car x)))
8867 (setq var (car x) val (nth 1 x))
8868 (push (list var `(quote ,(eval var))) org-fb-vars)
8869 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8870 org-local-vars)
8871 (org-set-local 'orgstruct-is-++ t))))
8873 (defvar orgstruct-is-++ nil
8874 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8875 (make-variable-buffer-local 'orgstruct-is-++)
8877 ;;;###autoload
8878 (defun turn-on-orgstruct++ ()
8879 "Unconditionally turn on `orgstruct++-mode'."
8880 (orgstruct++-mode 1))
8882 (defun orgstruct-error ()
8883 "Error when there is no default binding for a structure key."
8884 (interactive)
8885 (funcall (if (fboundp 'user-error)
8886 'user-error
8887 'error)
8888 "This key has no function outside structure elements"))
8890 (defun orgstruct-setup ()
8891 "Setup orgstruct keymap."
8892 (dolist (cell '((org-demote . t)
8893 (org-metaleft . t)
8894 (org-metaright . t)
8895 (org-promote . t)
8896 (org-shiftmetaleft . t)
8897 (org-shiftmetaright . t)
8898 org-backward-element
8899 org-backward-heading-same-level
8900 org-ctrl-c-ret
8901 org-ctrl-c-minus
8902 org-ctrl-c-star
8903 org-cycle
8904 org-forward-heading-same-level
8905 org-insert-heading
8906 org-insert-heading-respect-content
8907 org-kill-note-or-show-branches
8908 org-mark-subtree
8909 org-meta-return
8910 org-metadown
8911 org-metaup
8912 org-narrow-to-subtree
8913 org-promote-subtree
8914 org-reveal
8915 org-shiftdown
8916 org-shiftleft
8917 org-shiftmetadown
8918 org-shiftmetaup
8919 org-shiftright
8920 org-shifttab
8921 org-shifttab
8922 org-shiftup
8923 org-show-subtree
8924 org-sort
8925 org-up-element
8926 outline-demote
8927 outline-next-visible-heading
8928 outline-previous-visible-heading
8929 outline-promote
8930 outline-up-heading
8931 show-children))
8932 (let ((f (or (car-safe cell) cell))
8933 (disable-when-heading-prefix (cdr-safe cell)))
8934 (when (fboundp f)
8935 (dolist (binding (nconc (where-is-internal f org-mode-map)
8936 (where-is-internal f outline-mode-map)))
8937 ;; TODO use local-function-key-map
8938 (dolist (rep '(("<tab>" . "TAB")
8939 ("<return>" . "RET")
8940 ("<escape>" . "ESC")
8941 ("<delete>" . "DEL")))
8942 (setq binding (read-kbd-macro
8943 (let ((case-fold-search))
8944 (replace-regexp-in-string
8945 (regexp-quote (cdr rep))
8946 (car rep)
8947 (key-description binding))))))
8948 (let ((key (lookup-key orgstruct-mode-map binding)))
8949 (when (or (not key) (numberp key))
8950 (condition-case nil
8951 (org-defkey orgstruct-mode-map
8952 binding
8953 (orgstruct-make-binding f binding disable-when-heading-prefix))
8954 (error nil))))))))
8955 (run-hooks 'orgstruct-setup-hook))
8957 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
8958 "Create a function for binding in the structure minor mode.
8959 FUN is the command to call inside a table. KEY is the key that
8960 should be checked in for a command to execute outside of tables.
8961 Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
8962 if `orgstruct-heading-prefix-regexp' is non-nil."
8963 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
8964 (let ((nname name)
8965 (i 0))
8966 (while (fboundp (intern nname))
8967 (setq nname (format "%s-%d" name (setq i (1+ i)))))
8968 (setq name (intern nname)))
8969 (eval
8970 (let ((bindings '((org-heading-regexp
8971 (concat "^"
8972 orgstruct-heading-prefix-regexp
8974 (org-outline-regexp
8976 (org-outline-regexp-bol
8977 (concat "^" org-outline-regexp))
8978 (outline-regexp org-outline-regexp)
8980 (outline-level 'org-outline-level)
8981 (outline-heading-alist))))
8982 `(defun ,name (arg)
8984 "Outside of structure, run the binding of `"
8985 (key-description key) "'."
8986 (when disable-when-heading-prefix
8987 (concat
8990 "`" (symbol-name fun) "'.")))
8991 (interactive "p")
8992 (let* ((disable
8993 ,(when disable-when-heading-prefix
8994 '(and orgstruct-heading-prefix-regexp
8995 (not (string= orgstruct-heading-prefix-regexp "")))))
8996 (fallback
8997 (or disable
8998 (not
8999 (let* ,bindings
9000 (org-context-p 'headline 'item
9001 ,(when (memq fun '(org-insert-heading))
9002 '(when orgstruct-is-++
9003 'item-body))))))))
9004 (if fallback
9005 (let* ((orgstruct-mode)
9006 (binding
9007 (loop with key = ,key
9008 for rep in
9009 '(nil
9014 do
9015 (when rep
9016 (setq key (read-kbd-macro
9017 (let ((case-fold-search))
9018 (replace-regexp-in-string
9019 (car rep)
9020 (cdr rep)
9021 (key-description key))))))
9022 thereis (key-binding key))))
9023 (if (keymapp binding)
9024 (set-temporary-overlay-map binding)
9025 (let ((func (or binding
9026 (unless disable
9027 'orgstruct-error))))
9028 (when func
9029 (call-interactively func)))))
9030 (org-run-like-in-org-mode
9031 (lambda ()
9032 (interactive)
9033 (let* ,bindings
9034 (call-interactively ',fun)))))))))
9035 name))
9037 (defun org-contextualize-keys (alist contexts)
9038 "Return valid elements in ALIST depending on CONTEXTS.
9040 `org-agenda-custom-commands' or `org-capture-templates' are the
9041 values used for ALIST, and `org-agenda-custom-commands-contexts'
9042 or `org-capture-templates-contexts' are the associated contexts
9043 definitions."
9044 (let ((contexts
9045 ;; normalize contexts
9046 (mapcar
9047 (lambda(c) (cond ((listp (cadr c))
9048 (list (car c) (car c) (cadr c)))
9049 ((string= "" (cadr c))
9050 (list (car c) (car c) (caddr c)))
9051 (t c))) contexts))
9052 (a alist) c r s)
9053 ;; loop over all commands or templates
9054 (while (setq c (pop a))
9055 (let (vrules repl)
9056 (cond
9057 ((not (assoc (car c) contexts))
9058 (push c r))
9059 ((and (assoc (car c) contexts)
9060 (setq vrules (org-contextualize-validate-key
9061 (car c) contexts)))
9062 (mapc (lambda (vr)
9063 (when (not (equal (car vr) (cadr vr)))
9064 (setq repl vr))) vrules)
9065 (if (not repl) (push c r)
9066 (push (cadr repl) s)
9067 (push
9068 (cons (car c)
9069 (cdr (or (assoc (cadr repl) alist)
9070 (error "Undefined key `%s' as contextual replacement for `%s'"
9071 (cadr repl) (car c)))))
9072 r))))))
9073 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9074 (delq
9075 nil
9076 (delete-dups
9077 (mapcar (lambda (x)
9078 (let ((tpl (car x)))
9079 (when (not (delq
9080 nil
9081 (mapcar (lambda(y)
9082 (equal y tpl)) s))) x)))
9083 (reverse r))))))
9085 (defun org-contextualize-validate-key (key contexts)
9086 "Check CONTEXTS for agenda or capture KEY."
9087 (let (r rr res)
9088 (while (setq r (pop contexts))
9089 (mapc
9090 (lambda (rr)
9091 (when
9092 (and (equal key (car r))
9093 (if (functionp rr) (funcall rr)
9094 (or (and (eq (car rr) 'in-file)
9095 (buffer-file-name)
9096 (string-match (cdr rr) (buffer-file-name)))
9097 (and (eq (car rr) 'in-mode)
9098 (string-match (cdr rr) (symbol-name major-mode)))
9099 (and (eq (car rr) 'in-buffer)
9100 (string-match (cdr rr) (buffer-name)))
9101 (when (and (eq (car rr) 'not-in-file)
9102 (buffer-file-name))
9103 (not (string-match (cdr rr) (buffer-file-name))))
9104 (when (eq (car rr) 'not-in-mode)
9105 (not (string-match (cdr rr) (symbol-name major-mode))))
9106 (when (eq (car rr) 'not-in-buffer)
9107 (not (string-match (cdr rr) (buffer-name)))))))
9108 (push r res)))
9109 (car (last r))))
9110 (delete-dups (delq nil res))))
9112 (defun org-context-p (&rest contexts)
9113 "Check if local context is any of CONTEXTS.
9114 Possible values in the list of contexts are `table', `headline', and `item'."
9115 (let ((pos (point)))
9116 (goto-char (point-at-bol))
9117 (prog1 (or (and (memq 'table contexts)
9119 (and (memq 'headline contexts)
9120 (looking-at org-outline-regexp))
9121 (and (memq 'item contexts)
9123 (and (memq 'item-body contexts)
9124 (org-in-item-p)))
9125 (goto-char pos))))
9127 (defun org-get-local-variables ()
9128 "Return a list of all local variables in an Org mode buffer."
9129 (let (varlist)
9130 (with-current-buffer (get-buffer-create "*Org tmp*")
9131 (erase-buffer)
9132 (org-mode)
9133 (setq varlist (buffer-local-variables)))
9134 (kill-buffer "*Org tmp*")
9135 (delq nil
9136 (mapcar
9137 (lambda (x)
9138 (setq x
9139 (if (symbolp x)
9140 (list x)
9141 (list (car x) (cdr x))))
9142 (if (and (not (get (car x) 'org-state))
9143 (string-match
9144 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9145 (symbol-name (car x))))
9146 x nil))
9147 varlist))))
9149 (defun org-clone-local-variables (from-buffer &optional regexp)
9150 "Clone local variables from FROM-BUFFER.
9151 Optional argument REGEXP selects variables to clone."
9152 (mapc
9153 (lambda (pair)
9154 (and (symbolp (car pair))
9155 (or (null regexp)
9156 (string-match regexp (symbol-name (car pair))))
9157 (set (make-local-variable (car pair))
9158 (cdr pair))))
9159 (buffer-local-variables from-buffer)))
9161 ;;;###autoload
9162 (defun org-run-like-in-org-mode (cmd)
9163 "Run a command, pretending that the current buffer is in Org-mode.
9164 This will temporarily bind local variables that are typically bound in
9165 Org-mode to the values they have in Org-mode, and then interactively
9166 call CMD."
9167 (org-load-modules-maybe)
9168 (unless org-local-vars
9169 (setq org-local-vars (org-get-local-variables)))
9170 (let (binds)
9171 (dolist (var org-local-vars)
9172 (when (or (not (boundp (car var)))
9173 (eq (symbol-value (car var))
9174 (default-value (car var))))
9175 (push (list (car var) `(quote ,(cadr var))) binds)))
9176 (eval `(let ,binds
9177 (call-interactively (quote ,cmd))))))
9179 ;;;; Archiving
9181 (defun org-get-category (&optional pos force-refresh)
9182 "Get the category applying to position POS."
9183 (save-match-data
9184 (if force-refresh (org-refresh-category-properties))
9185 (let ((pos (or pos (point))))
9186 (or (get-text-property pos 'org-category)
9187 (progn (org-refresh-category-properties)
9188 (get-text-property pos 'org-category))))))
9190 (defun org-refresh-category-properties ()
9191 "Refresh category text properties in the buffer."
9192 (let ((case-fold-search t)
9193 (inhibit-read-only t)
9194 (def-cat (cond
9195 ((null org-category)
9196 (if buffer-file-name
9197 (file-name-sans-extension
9198 (file-name-nondirectory buffer-file-name))
9199 "???"))
9200 ((symbolp org-category) (symbol-name org-category))
9201 (t org-category)))
9202 beg end cat pos optionp)
9203 (org-with-silent-modifications
9204 (save-excursion
9205 (save-restriction
9206 (widen)
9207 (goto-char (point-min))
9208 (put-text-property (point) (point-max) 'org-category def-cat)
9209 (while (re-search-forward
9211 (setq pos (match-end 0)
9212 optionp (equal (char-after (match-beginning 0)) ?#)
9213 cat (org-trim (match-string 2)))
9214 (if optionp
9215 (setq beg (point-at-bol) end (point-max))
9216 (org-back-to-heading t)
9217 (setq beg (point) end (org-end-of-subtree t t)))
9218 (put-text-property beg end 'org-category cat)
9219 (put-text-property beg end 'org-category-position beg)
9220 (goto-char pos)))))))
9222 (defun org-refresh-properties (dprop tprop)
9223 "Refresh buffer text properties.
9224 DPROP is the drawer property and TPROP is the corresponding text
9225 property to set."
9226 (let ((case-fold-search t)
9227 (inhibit-read-only t) p)
9228 (org-with-silent-modifications
9229 (save-excursion
9230 (save-restriction
9231 (widen)
9232 (goto-char (point-min))
9234 (setq p (org-match-string-no-properties 1))
9235 (save-excursion
9236 (org-back-to-heading t)
9237 (put-text-property
9238 (point-at-bol) (point-at-eol) tprop p))))))))
9241 ;;;; Link Stuff
9243 ;;; Link abbreviations
9245 (defun org-link-expand-abbrev (link)
9246 "Apply replacements as defined in `org-link-abbrev-alist'."
9248 (let* ((key (match-string 1 link))
9249 (as (or (assoc key org-link-abbrev-alist-local)
9250 (assoc key org-link-abbrev-alist)))
9251 (tag (and (match-end 2) (match-string 3 link)))
9252 rpl)
9253 (if (not as)
9254 link
9255 (setq rpl (cdr as))
9256 (cond
9257 ((symbolp rpl) (funcall rpl tag))
9259 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
9260 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9261 ((string-match "%h" rpl)
9262 (replace-match (url-hexify-string (or tag "")) t t rpl))
9263 (t (concat rpl tag)))))
9264 link))
9266 ;;; Storing and inserting links
9268 (defvar org-insert-link-history nil
9269 "Minibuffer history for links inserted with `org-insert-link'.")
9271 (defvar org-stored-links nil
9272 "Contains the links stored with `org-store-link'.")
9274 (defvar org-store-link-plist nil
9275 "Plist with info about the most recently link created with `org-store-link'.")
9277 (defvar org-link-protocols nil
9278 "Link protocols added to Org-mode using `org-add-link-type'.")
9280 (defvar org-store-link-functions nil
9281 "List of functions that are called to create and store a link.
9282 Each function will be called in turn until one returns a non-nil
9283 value. Each function should check if it is responsible for creating
9284 this link (for example by looking at the major mode).
9285 If not, it must exit and return nil.
9286 If yes, it should return a non-nil value after a calling
9287 `org-store-link-props' with a list of properties and values.
9288 Special properties are:
9292 This is obligatory as well.
9293 :description Optional default description for the second pair
9294 of brackets in an Org-mode link. The user can still change
9295 this when inserting this link into an Org-mode buffer.
9297 In addition to these, any additional properties can be specified
9298 and then used in capture templates.")
9300 (defun org-add-link-type (type &optional follow export)
9301 "Add TYPE to the list of `org-link-types'.
9302 Re-compute all regular expressions depending on `org-link-types'
9304 FOLLOW and EXPORT are two functions.
9306 FOLLOW should take the link path as the single argument and do whatever
9307 is necessary to follow the link, for example find a file or display
9308 a mail message.
9310 EXPORT should format the link path for export to one of the export formats.
9311 It should be a function accepting three arguments:
9314 desc the description of the link, if any, or a description added by
9315 org-export-normalize-links if there is none
9316 format the export format, a symbol like `html' or `latex' or `ascii'..
9318 The function may use the FORMAT information to return different values
9319 depending on the format. The return value will be put literally into
9320 the exported file. If the return value is nil, this means Org should
9321 do what it normally does with links which do not have EXPORT defined.
9323 Org-mode has a built-in default for exporting links. If you are happy with
9324 this default, there is no need to define an export function for the link
9325 type. For a simple example of an export function, see `org-bbdb.el'."
9326 (add-to-list 'org-link-types type t)
9327 (org-make-link-regexps)
9328 (if (assoc type org-link-protocols)
9329 (setcdr (assoc type org-link-protocols) (list follow export))
9330 (push (list type follow export) org-link-protocols)))
9332 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9333 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9335 ;;;###autoload
9336 (defun org-store-link (arg)
9338 This link is added to `org-stored-links' and can later be inserted
9341 For some link types, a prefix arg is interpreted.
9342 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9343 For file links, arg negates `org-context-in-file-links'.
9345 A double prefix arg force skipping storing functions that are not
9346 part of Org's core.
9348 A triple prefix arg force storing a link for each line in the
9349 active region."
9350 (interactive "P")
9351 (org-load-modules-maybe)
9352 (if (and (equal arg '(64)) (org-region-active-p))
9353 (save-excursion
9354 (let ((end (region-end)))
9355 (goto-char (region-beginning))
9356 (set-mark (point))
9357 (while (< (point-at-eol) end)
9358 (move-end-of-line 1) (activate-mark)
9359 (let (current-prefix-arg)
9360 (call-interactively 'org-store-link))
9361 (move-beginning-of-line 2)
9362 (set-mark (point)))))
9363 (org-with-limited-levels
9364 (setq org-store-link-plist nil)
9365 (let (link cpltxt desc description search
9366 txt custom-id agenda-link sfuns sfunsn)
9367 (cond
9369 ;; Store a link using an external link type
9370 ((and (not (equal arg '(16)))
9371 (setq sfuns
9372 (delq
9373 nil (mapcar (lambda (f)
9374 (let (fs) (if (funcall f) (push f fs))))
9375 org-store-link-functions))
9376 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9377 (or (and (cdr sfuns)
9378 (funcall (intern
9379 (completing-read
9380 "Which function for creating the link? "
9381 sfunsn t (car sfunsn)))))
9382 (funcall (caar sfuns)))
9383 (setq link (plist-get org-store-link-plist :link)
9384 desc (or (plist-get org-store-link-plist
9385 :description) link))))
9387 ;; Store a link from a source code buffer
9388 ((org-src-edit-buffer-p)
9389 (let (label gc)
9390 (while (or (not label)
9391 (save-excursion
9392 (save-restriction
9393 (widen)
9394 (goto-char (point-min))
9395 (re-search-forward
9396 (regexp-quote (format org-coderef-label-format label))
9397 nil t))))
9398 (when label (message "Label exists already") (sit-for 2))
9399 (setq label (read-string "Code line label: " label)))
9400 (end-of-line 1)
9401 (setq link (format org-coderef-label-format label))
9402 (setq gc (- 79 (length link)))
9403 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9404 (insert link)
9405 (setq link (concat "(" label ")") desc nil)))
9407 ;; We are in the agenda, link to referenced location
9408 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9409 (let ((m (or (get-text-property (point) 'org-hd-marker)
9410 (get-text-property (point) 'org-marker))))
9411 (when m
9412 (org-with-point-at m
9413 (setq agenda-link
9414 (if (org-called-interactively-p 'any)
9415 (call-interactively 'org-store-link)
9416 (org-store-link nil)))))))
9418 ((eq major-mode 'calendar-mode)
9419 (let ((cd (calendar-cursor-to-date)))
9420 (setq link
9421 (format-time-string
9422 (car org-time-stamp-formats)
9423 (apply 'encode-time
9424 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9425 nil nil nil))))
9426 (org-store-link-props :type "calendar" :date cd)))
9428 ((eq major-mode 'help-mode)
9429 (setq link (concat "help:" (save-excursion
9430 (goto-char (point-min))
9431 (looking-at "^[^ ]+")
9432 (match-string 0))))
9433 (org-store-link-props :type "help"))
9435 ((eq major-mode 'w3-mode)
9436 (setq cpltxt (if (and (buffer-name)
9437 (not (string-match "Untitled" (buffer-name))))
9438 (buffer-name)
9439 (url-view-url t))
9440 link (url-view-url t))
9441 (org-store-link-props :type "w3" :url (url-view-url t)))
9443 ((eq major-mode 'image-mode)
9444 (setq cpltxt (concat "file:"
9445 (abbreviate-file-name buffer-file-name))
9446 link cpltxt)
9447 (org-store-link-props :type "image" :file buffer-file-name))
9449 ;; In dired, store a link to the file of the current line
9450 ((eq major-mode 'dired-mode)
9451 (let ((file (dired-get-filename nil t)))
9452 (setq file (if file
9453 (abbreviate-file-name
9454 (expand-file-name (dired-get-filename nil t)))
9455 ;; otherwise, no file so use current directory.
9456 default-directory))
9457 (setq cpltxt (concat "file:" file)
9458 link cpltxt)))
9460 ((setq search (run-hook-with-args-until-success
9461 'org-create-file-search-functions))
9462 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9463 "::" search))
9464 (setq cpltxt (or description link)))
9466 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9467 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9468 (cond
9469 ;; Store a link using the radio target at point
9471 (setq cpltxt
9472 (concat "file:"
9473 (abbreviate-file-name
9474 (buffer-file-name (buffer-base-buffer)))
9475 "::" (match-string 1))
9476 link cpltxt))
9477 ((and (featurep 'org-id)
9478 (or (eq org-id-link-to-org-use-id t)
9479 (and (org-called-interactively-p 'any)
9480 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9481 (and (eq org-id-link-to-org-use-id
9482 'create-if-interactive-and-no-custom-id)
9483 (not custom-id))))
9484 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9485 ;; Store a link using the ID at point
9486 (setq link (condition-case nil
9487 (prog1 (org-id-store-link)
9488 (setq desc (plist-get org-store-link-plist
9489 :description)))
9490 (error
9491 ;; Probably before first headline, link only to file
9492 (concat "file:"
9493 (abbreviate-file-name
9494 (buffer-file-name (buffer-base-buffer))))))))
9495 (t
9496 ;; Just link to current headline
9497 (setq cpltxt (concat "file:"
9498 (abbreviate-file-name
9499 (buffer-file-name (buffer-base-buffer)))))
9500 ;; Add a context search string
9501 (when (org-xor org-context-in-file-links arg)
9502 (let* ((ee (org-element-at-point))
9503 (et (org-element-type ee))
9504 (ev (plist-get (cadr ee) :value))
9505 (ek (plist-get (cadr ee) :key))
9506 (eok (and (stringp ek) (string-match "name" ek))))
9507 (setq txt (cond
9508 ((org-at-heading-p) nil)
9509 ((and (eq et 'keyword) eok) ev)
9510 ((org-region-active-p)
9511 (buffer-substring (region-beginning) (region-end)))))
9513 (setq cpltxt
9514 (concat cpltxt "::"
9515 (condition-case nil
9516 (org-make-org-heading-search-string txt)
9517 (error "")))
9518 desc (or (and (eq et 'keyword) eok ev)
9519 (nth 4 (ignore-errors (org-heading-components)))
9520 "NONE")))))
9522 (setq cpltxt (substring cpltxt 0 -2)))
9523 (setq link cpltxt))))
9525 ((buffer-file-name (buffer-base-buffer))
9526 ;; Just link to this file here.
9527 (setq cpltxt (concat "file:"
9528 (abbreviate-file-name
9529 (buffer-file-name (buffer-base-buffer)))))
9530 ;; Add a context string.
9531 (when (org-xor org-context-in-file-links arg)
9532 (setq txt (if (org-region-active-p)
9533 (buffer-substring (region-beginning) (region-end))
9534 (buffer-substring (point-at-bol) (point-at-eol))))
9535 ;; Only use search option if there is some text.
9537 (setq cpltxt
9538 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9539 desc "NONE")))
9540 (setq link cpltxt))
9542 ((org-called-interactively-p 'interactive)
9543 (user-error "No method for storing a link from this buffer"))
9545 (t (setq link nil)))
9547 ;; We're done setting link and desc, clean up
9548 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9549 (setq link (or link cpltxt)
9550 desc (or desc cpltxt))
9551 (cond ((equal desc "NONE") (setq desc nil))
9552 ((string-match org-bracket-link-regexp desc)
9553 (setq desc
9554 (replace-regexp-in-string
9555 org-bracket-link-regexp
9557 (length desc)) "*" "")) desc))))
9559 ;; Return the link
9560 (if (not (and (or (org-called-interactively-p 'any)
9561 executing-kbd-macro) link))
9562 (or agenda-link (and link (org-make-link-string link desc)))
9563 (push (list link desc) org-stored-links)
9564 (message "Stored: %s" (or desc link))
9565 (when custom-id
9566 (setq link (concat "file:" (abbreviate-file-name
9567 (buffer-file-name)) "::#" custom-id))
9568 (push (list link desc) org-stored-links)))))))
9570 (defun org-store-link-props (&rest plist)
9571 "Store link properties, extract names and addresses."
9572 (let (x adr)
9573 (when (setq x (plist-get plist :from))
9574 (setq adr (mail-extract-address-components x))
9575 (setq plist (plist-put plist :fromname (car adr)))
9576 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9577 (when (setq x (plist-get plist :to))
9578 (setq adr (mail-extract-address-components x))
9579 (setq plist (plist-put plist :toname (car adr)))
9580 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9581 (let ((from (plist-get plist :from))
9582 (to (plist-get plist :to)))
9583 (when (and from to org-from-is-user-regexp)
9584 (setq plist
9585 (plist-put plist :fromto
9586 (if (string-match org-from-is-user-regexp from)
9587 (concat "to %t")
9588 (concat "from %f"))))))
9589 (setq org-store-link-plist plist))
9591 (defun org-add-link-props (&rest plist)
9592 "Add these properties to the link property list."
9593 (let (key value)
9594 (while plist
9595 (setq key (pop plist) value (pop plist))
9596 (setq org-store-link-plist
9597 (plist-put org-store-link-plist key value)))))
9599 (defun org-email-link-description (&optional fmt)
9600 "Return the description part of an email link.
9601 This takes information from `org-store-link-plist' and formats it
9602 according to FMT (default from `org-email-link-description-format')."
9603 (setq fmt (or fmt org-email-link-description-format))
9604 (let* ((p org-store-link-plist)
9605 (to (plist-get p :toaddress))
9606 (from (plist-get p :fromaddress))
9607 (table
9608 (list
9609 (cons "%c" (plist-get p :fromto))
9610 (cons "%F" (plist-get p :from))
9611 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9612 (cons "%T" (plist-get p :to))
9613 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9614 (cons "%s" (plist-get p :subject))
9615 (cons "%d" (plist-get p :date))
9616 (cons "%m" (plist-get p :message-id)))))
9617 (when (string-match "%c" fmt)
9618 ;; Check if the user wrote this message
9619 (if (and org-from-is-user-regexp from to
9620 (save-match-data (string-match org-from-is-user-regexp from)))
9621 (setq fmt (replace-match "to %t" t t fmt))
9622 (setq fmt (replace-match "from %f" t t fmt))))
9623 (org-replace-escapes fmt table)))
9625 (defun org-make-org-heading-search-string (&optional string)
9626 "Make search string for the current headline or STRING."
9627 (let ((s (or string
9628 (and (derived-mode-p 'org-mode)
9629 (save-excursion
9630 (org-back-to-heading t)
9631 (org-element-property :raw-value (org-element-at-point))))))
9632 (lines org-context-in-file-links))
9633 (or string (setq s (concat "*" s))) ; Add * for headlines
9635 (when (and string (integerp lines) (> lines 0))
9637 (when (< lines (length slines))
9638 (setq s (mapconcat
9639 'identity
9640 (reverse (nthcdr (- (length slines) lines)
9644 (defun org-make-link-string (link &optional description)
9645 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9647 (error "Empty link"))
9648 (when (and description
9649 (stringp description)
9651 (setq description nil))
9652 (when (stringp description)
9653 ;; Remove brackets from the description, they are fatal.
9655 (setq description (replace-match "{" t t description)))
9657 (setq description (replace-match "}" t t description))))
9658 (when (equal link description)
9659 ;; No description needed, it is identical
9660 (setq description nil))
9661 (when (and (not description)
9662 (not (string-match (org-image-file-name-regexp) link))
9663 (not (equal link (org-link-escape link))))
9664 (setq description (org-extract-attributes link)))
9665 (setq link
9666 (cond ((string-match (org-image-file-name-regexp) link) link)
9667 ((string-match org-link-types-re link)
9668 (concat (match-string 1 link)
9669 (org-link-escape (substring link (match-end 1)))))
9670 (t (org-link-escape link))))
9671 (concat "[[" link "]"
9672 (if description (concat "[" description "]") "")
9673 "]"))
9675 (defconst org-link-escape-chars
9676 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9677 "List of characters that should be escaped in link.
9678 This is the list that is used for internal purposes.")
9680 (defconst org-link-escape-chars-browser
9681 '(?\ )
9682 "List of escapes for characters that are problematic in links.
9683 This is the list that is used before handing over to the browser.")
9685 (defun org-link-escape (text &optional table merge)
9686 "Return percent escaped representation of TEXT.
9687 TEXT is a string with the text to escape.
9688 Optional argument TABLE is a list with characters that should be
9689 escaped. When nil, `org-link-escape-chars' is used.
9690 If optional argument MERGE is set, merge TABLE into
9691 `org-link-escape-chars'."
9692 (cond
9693 ((and table merge)
9694 (mapc (lambda (defchr)
9695 (unless (member defchr table)
9696 (setq table (cons defchr table)))) org-link-escape-chars))
9697 ((null table)
9698 (setq table org-link-escape-chars)))
9699 (mapconcat
9700 (lambda (char)
9701 (if (or (member char table)
9702 (and (or (< char 32) (= char 37) (> char 126))
9703 org-url-hexify-p))
9704 (mapconcat (lambda (sequence-element)
9705 (format "%%%.2X" sequence-element))
9706 (or (encode-coding-char char 'utf-8)
9707 (error "Unable to percent escape character: %s"
9708 (char-to-string char))) "")
9709 (char-to-string char))) text ""))
9711 (defun org-link-unescape (str)
9712 "Unhex hexified Unicode strings as returned from the JavaScript function
9713 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9714 (unless (and (null str) (string= "" str))
9715 (let ((pos 0) (case-fold-search t) unhexed)
9717 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9718 (setq str (replace-match unhexed t t str))
9719 (setq pos (+ pos (length unhexed))))))
9720 str)
9722 (defun org-link-unescape-compound (hex)
9723 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9724 Note: this function also decodes single byte encodings like
9725 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9726 (save-match-data
9727 (let* ((bytes (cdr (split-string hex "%")))
9728 (ret "")
9729 (eat 0)
9730 (sum 0))
9731 (while bytes
9732 (let* ((val (string-to-number (pop bytes) 16))
9733 (shift-xor
9734 (if (= 0 eat)
9735 (cond
9736 ((>= val 252) (cons 6 252))
9737 ((>= val 248) (cons 5 248))
9738 ((>= val 240) (cons 4 240))
9739 ((>= val 224) (cons 3 224))
9740 ((>= val 192) (cons 2 192))
9741 (t (cons 0 0)))
9742 (cons 6 128))))
9743 (if (>= val 192) (setq eat (car shift-xor)))
9744 (setq val (logxor val (cdr shift-xor)))
9745 (setq sum (+ (lsh sum (car shift-xor)) val))
9746 (if (> eat 0) (setq eat (- eat 1)))
9747 (cond
9748 ((= 0 eat) ;multi byte
9749 (setq ret (concat ret (org-char-to-string sum)))
9750 (setq sum 0))
9751 ((not bytes) ; single byte(s)
9752 (setq ret (org-link-unescape-single-byte-sequence hex))))
9753 )) ;; end (while bytes
9754 ret )))
9756 (defun org-link-unescape-single-byte-sequence (hex)
9757 "Unhexify hex-encoded single byte character sequences."
9758 (mapconcat (lambda (byte)
9759 (char-to-string (string-to-number byte 16)))
9760 (cdr (split-string hex "%")) ""))
9762 (defun org-xor (a b)
9763 "Exclusive or."
9764 (if a (not b) b))
9766 (defun org-fixup-message-id-for-http (s)
9767 "Replace special characters in a message id, so it can be used in an http query."
9768 (when (string-match "%" s)
9769 (setq s (mapconcat (lambda (c)
9770 (if (eq c ?%)
9771 "%25"
9772 (char-to-string c)))
9773 s "")))
9774 (while (string-match "<" s)
9775 (setq s (replace-match "%3C" t t s)))
9776 (while (string-match ">" s)
9777 (setq s (replace-match "%3E" t t s)))
9778 (while (string-match "@" s)
9779 (setq s (replace-match "%40" t t s)))
9780 s)
9782 (defun org-link-prettify (link)
9783 "Return a human-readable representation of LINK.
9784 The car of LINK must be a raw link the cdr of LINK must be either
9785 a link description or nil."
9786 (let ((desc (or (cadr link) "<no description>")))
9787 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9788 "<" (car link) ">")))
9790 ;;;###autoload
9791 (defun org-insert-link-global ()
9792 "Insert a link like Org-mode does.
9793 This command can be called in any mode to insert a link in Org-mode syntax."
9794 (interactive)
9795 (org-load-modules-maybe)
9796 (org-run-like-in-org-mode 'org-insert-link))
9798 (defun org-insert-all-links (&optional keep)
9799 "Insert all links in `org-stored-links'."
9800 (interactive "P")
9801 (let ((links (copy-sequence org-stored-links)) l)
9802 (while (setq l (if keep (pop links) (pop org-stored-links)))
9803 (insert "- ")
9804 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9807 (defun org-link-fontify-links-to-this-file ()
9808 "Fontify links to the current file in `org-stored-links'."
9809 (let ((f (buffer-file-name)) a b)
9810 (setq a (mapcar (lambda(l)
9811 (let ((ll (car l)))
9813 (equal f (expand-file-name (match-string 1 ll))))
9814 ll)))
9815 org-stored-links))
9816 (when (featurep 'org-id)
9817 (setq b (mapcar (lambda(l)
9818 (let ((ll (car l)))
9820 (equal f (expand-file-name
9821 (or (org-id-find-id-file
9822 (match-string 1 ll)) ""))))
9823 ll)))
9824 org-stored-links)))
9825 (mapcar (lambda(l)
9826 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9827 (delq nil (append a b)))))
9829 (defvar org-link-links-in-this-file nil)
9830 (defun org-insert-link (&optional complete-file link-location default-description)
9831 "Insert a link. At the prompt, enter the link.
9833 Completion can be used to insert any of the link protocol prefixes like
9834 http or ftp in use.
9836 The history can be used to select a link previously stored with
9837 `org-store-link'. When the empty string is entered (i.e. if you just
9838 press RET at the prompt), the link defaults to the most recently
9839 stored link. As SPC triggers completion in the minibuffer, you need to
9840 use M-SPC or C-q SPC to force the insertion of a space character.
9842 You will also be prompted for a description, and if one is given, it will
9843 be displayed in the buffer instead of the link.
9845 If there is already a link at point, this command will allow you to edit link
9846 and description parts.
9849 be selected using completion. The path to the file will be relative to the
9850 current directory if the file is in the current directory or a subdirectory.
9851 Otherwise, the link will be the absolute path as completed in the minibuffer
9852 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9853 option `org-link-file-path-type'.
9856 the current directory or below.
9859 `org-keep-stored-link-after-insertion'.
9861 If `org-make-link-description-function' is non-nil, this function will be
9862 called with the link target, and the result will be the default
9863 link description.
9865 If the LINK-LOCATION parameter is non-nil, this value will be
9866 used as the link location instead of reading one interactively.
9868 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9869 be used as the default description."
9870 (interactive "P")
9871 (let* ((wcf (current-window-configuration))
9872 (origbuf (current-buffer))
9873 (region (if (org-region-active-p)
9874 (buffer-substring (region-beginning) (region-end))))
9875 (remove (and region (list (region-beginning) (region-end))))
9876 (desc region)
9877 tmphist ; byte-compile incorrectly complains about this
9878 (link link-location)
9879 (abbrevs org-link-abbrev-alist-local)
9880 entry file all-prefixes auto-desc)
9881 (cond
9882 (link-location) ; specified by arg, just use it.
9883 ((org-in-regexp org-bracket-link-regexp 1)
9884 ;; We do have a link at point, and we are going to edit it.
9885 (setq remove (list (match-beginning 0) (match-end 0)))
9886 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9887 (setq link (read-string "Link: "
9888 (org-link-unescape
9889 (org-match-string-no-properties 1)))))
9890 ((or (org-in-regexp org-angle-link-re)
9891 (org-in-regexp org-plain-link-re))
9892 ;; Convert to bracket link
9893 (setq remove (list (match-beginning 0) (match-end 0))
9894 link (read-string "Link: "
9895 (org-remove-angle-brackets (match-string 0)))))
9896 ((member complete-file '((4) (16)))
9897 ;; Completing read for file names.
9898 (setq link (org-file-complete-link complete-file)))
9899 (t
9900 ;; Read link, with completion for stored links.
9901 (org-link-fontify-links-to-this-file)
9902 (org-switch-to-buffer-other-window "*Org Links*")
9903 (with-current-buffer "*Org Links*"
9904 (erase-buffer)
9905 (insert "Insert a link.
9907 (when org-stored-links
9909 (insert (mapconcat 'org-link-prettify
9911 (goto-char (point-min)))
9912 (let ((cw (selected-window)))
9913 (select-window (get-buffer-window "*Org Links*" 'visible))
9914 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9915 (unless (pos-visible-in-window-p (point-max))
9916 (org-fit-window-to-buffer))
9917 (and (window-live-p cw) (select-window cw)))
9918 ;; Fake a link history, containing the stored links.
9919 (setq tmphist (append (mapcar 'car org-stored-links)
9920 org-insert-link-history))
9921 (setq all-prefixes (append (mapcar 'car abbrevs)
9922 (mapcar 'car org-link-abbrev-alist)
9923 org-link-types))
9924 (unwind-protect
9925 (progn
9926 (setq link
9927 (org-completing-read
9928 "Link: "
9929 (append
9930 (mapcar (lambda (x) (concat x ":"))
9931 all-prefixes)
9932 (mapcar 'car org-stored-links))
9933 nil nil nil
9934 'tmphist
9935 (caar org-stored-links)))
9937 (error "No link selected"))
9938 (mapc (lambda(l)
9939 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9940 org-stored-links)
9941 (if (or (member link all-prefixes)
9942 (and (equal ":" (substring link -1))
9943 (member (substring link 0 -1) all-prefixes)
9944 (setq link (substring link 0 -1))))
9945 (setq link (with-current-buffer origbuf
9946 (org-link-try-special-completion link)))))
9947 (set-window-configuration wcf)
9948 (kill-buffer "*Org Links*"))
9949 (setq entry (assoc link org-stored-links))
9950 (or entry (push link org-insert-link-history))
9951 (setq desc (or desc (nth 1 entry)))))
9953 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9954 (not org-keep-stored-link-after-insertion))
9955 (setq org-stored-links (delq (assoc link org-stored-links)
9956 org-stored-links)))
9958 (if (string-match org-plain-link-re link)
9959 ;; URL-like link, normalize the use of angular brackets.
9960 (setq link (org-remove-angle-brackets link)))
9962 ;; Check if we are linking to the current file with a search
9963 ;; option If yes, simplify the link by using only the search
9964 ;; option.
9965 (when (and buffer-file-name
9967 (let* ((path (match-string 1 link))
9968 (case-fold-search nil)
9969 (search (match-string 2 link)))
9970 (save-match-data
9971 (if (equal (file-truename buffer-file-name) (file-truename path))
9972 ;; We are linking to this same file, with a search option
9973 (setq link search)))))
9975 ;; Check if we can/should use a relative path. If yes, simplify the link
9977 (let* ((type (match-string 1 link))
9978 (path (match-string 2 link))
9979 (origpath path)
9980 (case-fold-search nil))
9981 (cond
9982 ((or (eq org-link-file-path-type 'absolute)
9983 (equal complete-file '(16)))
9984 (setq path (abbreviate-file-name (expand-file-name path))))
9985 ((eq org-link-file-path-type 'noabbrev)
9986 (setq path (expand-file-name path)))
9987 ((eq org-link-file-path-type 'relative)
9988 (setq path (file-relative-name path)))
9989 (t
9990 (save-match-data
9991 (if (string-match (concat "^" (regexp-quote
9992 (expand-file-name
9993 (file-name-as-directory
9994 default-directory))))
9995 (expand-file-name path))
9996 ;; We are linking a file with relative path name.
9997 (setq path (substring (expand-file-name path)
9998 (match-end 0)))
9999 (setq path (abbreviate-file-name (expand-file-name path)))))))
10000 (setq link (concat type path))
10001 (if (equal desc origpath)
10002 (setq desc path))))
10004 (if org-make-link-description-function
10005 (setq desc
10006 (or (condition-case nil
10007 (funcall org-make-link-description-function link desc)
10008 (error (progn (message "Can't get link description from `%s'"
10009 (symbol-name org-make-link-description-function))
10010 (sit-for 2) nil)))
10011 (read-string "Description: " default-description)))
10012 (if default-description (setq desc default-description)
10013 (setq desc (or (and auto-desc desc)
10014 (read-string "Description: " desc)))))
10017 (if remove (apply 'delete-region remove))
10018 (insert (org-make-link-string link desc))))
10020 (defun org-link-try-special-completion (type)
10021 "If there is completion support for link type TYPE, offer it."
10022 (let ((fun (intern (concat "org-" type "-complete-link"))))
10023 (if (functionp fun)
10024 (funcall fun)
10025 (read-string "Link (no completion support): " (concat type ":")))))
10027 (defun org-file-complete-link (&optional arg)
10028 "Create a file link using completion."
10029 (let (file link)
10030 (setq file (org-iread-file-name "File: "))
10031 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10032 (pwd1 (file-name-as-directory (abbreviate-file-name
10033 (expand-file-name ".")))))
10034 (cond
10035 ((equal arg '(16))
10036 (setq link (concat
10037 "file:"
10038 (abbreviate-file-name (expand-file-name file)))))
10040 (setq link (concat "file:" (match-string 1 file))))
10042 (expand-file-name file))
10043 (setq link (concat
10044 "file:" (match-string 1 (expand-file-name file)))))
10045 (t (setq link (concat "file:" file)))))
10046 link))
10048 (defun org-iread-file-name (&rest args)
10049 "Read-file-name using `ido-mode' speedup if available.
10050 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10051 See `read-file-name' for a description of parameters."
10052 (org-without-partial-completion
10053 (if (and org-completion-use-ido
10054 (fboundp 'ido-read-file-name)
10055 (boundp 'ido-mode) ido-mode
10056 (listp (second args)))
10057 (let ((ido-enter-matching-directory nil))
10058 (apply 'ido-read-file-name args))
10059 (apply 'read-file-name args))))
10061 (defun org-completing-read (&rest args)
10062 "Completing-read with SPACE being a normal character."
10063 (let ((enable-recursive-minibuffers t)
10064 (minibuffer-local-completion-map
10065 (copy-keymap minibuffer-local-completion-map)))
10066 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10067 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10068 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10069 (apply 'org-icompleting-read args)))
10071 (defun org-completing-read-no-i (&rest args)
10072 (let (org-completion-use-ido org-completion-use-iswitchb)
10073 (apply 'org-completing-read args)))
10075 (defun org-iswitchb-completing-read (prompt choices &rest args)
10076 "Use iswitch as a completing-read replacement to choose from choices.
10077 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10078 from."
10079 (let* ((iswitchb-use-virtual-buffers nil)
10080 (iswitchb-make-buflist-hook
10081 (lambda ()
10082 (setq iswitchb-temp-buflist choices))))
10083 (iswitchb-read-buffer prompt)))
10085 (defun org-icompleting-read (&rest args)
10086 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10087 (org-without-partial-completion
10088 (if (and org-completion-use-ido
10089 (fboundp 'ido-completing-read)
10090 (boundp 'ido-mode) ido-mode
10091 (listp (second args)))
10092 (let ((ido-enter-matching-directory nil))
10093 (apply 'ido-completing-read (concat (car args))
10094 (if (consp (car (nth 1 args)))
10095 (mapcar 'car (nth 1 args))
10096 (nth 1 args))
10097 (cddr args)))
10098 (if (and org-completion-use-iswitchb
10099 (boundp 'iswitchb-mode) iswitchb-mode
10100 (listp (second args)))
10101 (apply 'org-iswitchb-completing-read (concat (car args))
10102 (if (consp (car (nth 1 args)))
10103 (mapcar 'car (nth 1 args))
10104 (nth 1 args))
10105 (cddr args))
10106 (apply 'completing-read args)))))
10108 (defun org-extract-attributes (s)
10109 "Extract the attributes cookie from a string and set as text property."
10110 (let (a attr (start 0) key value)
10111 (save-match-data
10113 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10115 (setq key (match-string 1 a) value (match-string 2 a)
10116 start (match-end 0)
10117 attr (plist-put attr (intern key) value))))
10118 (org-add-props s nil 'org-attr attr))
10119 s))
10121 ;;; Opening/following a link
10123 (defvar org-link-search-failed nil)
10125 (defvar org-open-link-functions nil
10126 "Hook for functions finding a plain text link.
10127 These functions must take a single argument, the link content.
10128 They will be called for links that look like [[link text][description]]
10132 These functions will be called *before* Org attempts to resolve the
10133 link by doing text searches in the current buffer - so if you want a
10135 handle this as a special case.
10137 When the function does handle the link, it must return a non-nil value.
10138 If it decides that it is not responsible for this link, it must return
10139 nil to indicate that that Org-mode can continue with other options
10140 like exact and fuzzy text search.")
10142 (defun org-next-link (&optional search-backward)
10143 "Move forward to the next link.
10144 If the link is in hidden text, expose it."
10145 (interactive "P")
10146 (when (and org-link-search-failed (eq this-command last-command))
10147 (goto-char (point-min))
10148 (message "Link search wrapped back to beginning of buffer"))
10149 (setq org-link-search-failed nil)
10150 (let* ((pos (point))
10151 (ct (org-context))
10152 (a (assoc :link ct))
10153 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10154 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10155 ((looking-at org-any-link-re)
10156 ;; Don't stay stuck at link without an org-link face
10157 (forward-char (if search-backward -1 1))))
10158 (if (funcall srch-fun org-any-link-re nil t)
10159 (progn
10160 (goto-char (match-beginning 0))
10161 (if (outline-invisible-p) (org-show-context)))
10162 (goto-char pos)
10163 (setq org-link-search-failed t)
10164 (message "No further link found"))))
10166 (defun org-previous-link ()
10167 "Move backward to the previous link.
10168 If the link is in hidden text, expose it."
10169 (interactive)
10170 (funcall 'org-next-link t))
10172 (defun org-translate-link (s)
10173 "Translate a link string if a translation function has been defined."
10174 (if (and org-link-translation-function
10175 (fboundp org-link-translation-function)
10177 (progn
10178 (setq s (funcall org-link-translation-function
10179 (match-string 1 s) (match-string 2 s)))
10180 (concat (car s) ":" (cdr s)))
10181 s))
10183 (defun org-translate-link-from-planner (type path)
10184 "Translate a link from Emacs Planner syntax so that Org can follow it.
10185 This is still an experimental function, your mileage may vary."
10186 (cond
10187 ((member type '("http" "https" "news" "ftp"))
10188 ;; standard Internet links are the same.
10189 nil)
10190 ((and (equal type "irc") (string-match "^//" path))
10191 ;; Planner has two / at the beginning of an irc link, we have 1.
10192 ;; We should have zero, actually....
10193 (setq path (substring path 1)))
10194 ((and (equal type "lisp") (string-match "^/" path))
10195 ;; Planner has a slash, we do not.
10196 (setq type "elisp" path (substring path 1)))
10198 ;; A typical message link. Planner has the id after the final slash,
10199 ;; we separate it with a hash mark
10200 (setq path (concat (match-string 1 path) "#"
10201 (org-remove-angle-brackets (match-string 2 path))))))
10202 (cons type path))
10204 (defun org-find-file-at-mouse (ev)
10205 "Open file link or URL at mouse."
10206 (interactive "e")
10207 (mouse-set-point ev)
10208 (org-open-at-point 'in-emacs))
10210 (defun org-open-at-mouse (ev)
10211 "Open file link or URL at mouse.
10212 See the docstring of `org-open-file' for details."
10213 (interactive "e")
10214 (mouse-set-point ev)
10215 (if (eq major-mode 'org-agenda-mode)
10216 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10217 (org-open-at-point))
10219 (defvar org-window-config-before-follow-link nil
10220 "The window configuration before following a link.
10221 This is saved in case the need arises to restore it.")
10223 (defvar org-open-link-marker (make-marker)
10224 "Marker pointing to the location where `org-open-at-point; was called.")
10226 ;;;###autoload
10227 (defun org-open-at-point-global ()
10228 "Follow a link like Org-mode does.
10229 This command can be called in any mode to follow a link that has
10230 Org-mode syntax."
10231 (interactive)
10232 (org-run-like-in-org-mode 'org-open-at-point))
10234 ;;;###autoload
10235 (defun org-open-link-from-string (s &optional arg reference-buffer)
10236 "Open a link in the string S, as if it was in Org-mode."
10238 (let ((reference-buffer (or reference-buffer (current-buffer))))
10239 (with-temp-buffer
10240 (let ((org-inhibit-startup (not reference-buffer)))
10241 (org-mode)
10242 (insert s)
10243 (goto-char (point-min))
10244 (when reference-buffer
10245 (setq org-link-abbrev-alist-local
10246 (with-current-buffer reference-buffer
10247 org-link-abbrev-alist-local)))
10248 (org-open-at-point arg reference-buffer)))))
10250 (defvar org-open-at-point-functions nil
10251 "Hook that is run when following a link at point.
10253 Functions in this hook must return t if they identify and follow
10254 a link at point. If they don't find anything interesting at point,
10255 they must return nil.")
10257 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10258 (defun org-open-at-point (&optional arg reference-buffer)
10259 "Open link at or after point.
10260 If there is no link at point, this function will search forward up to
10261 the end of the current line.
10262 Normally, files will be opened by an appropriate application. If the
10263 optional prefix argument ARG is non-nil, Emacs will visit the file.
10264 With a double prefix argument, try to open outside of Emacs, in the
10265 application the system uses for this file type."
10266 (interactive "P")
10267 ;; if in a code block, then open the block's results
10268 (unless (call-interactively #'org-babel-open-src-block-result)
10269 (org-load-modules-maybe)
10270 (move-marker org-open-link-marker (point))
10271 (setq org-window-config-before-follow-link (current-window-configuration))
10272 (org-remove-occur-highlights nil nil t)
10273 (cond
10274 ((and (org-at-heading-p)
10275 (not (org-at-timestamp-p t))
10276 (not (org-in-regexp
10281 (not (get-text-property (point) 'org-linked-text)))
10282 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10283 (lk0 (car lkall))
10284 (lk (if (stringp lk0) (list lk0) lk0))
10285 (lkend (cdr lkall)))
10286 (mapcar (lambda(l)
10287 (search-forward l nil lkend)
10288 (goto-char (match-beginning 0))
10289 (org-open-at-point))
10290 lk))
10291 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10292 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10293 ((and (org-at-timestamp-p t)
10294 (not (org-in-regexp org-bracket-link-regexp)))
10295 (org-follow-timestamp-link))
10296 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10297 (not (org-in-regexp org-any-link-re)))
10298 (org-footnote-action))
10299 (t
10300 (let (type path link line search (pos (point)))
10301 (catch 'match
10302 (save-excursion
10304 (when (org-in-regexp org-bracket-link-regexp 1)
10305 (setq link (org-extract-attributes
10306 (org-link-unescape (org-match-string-no-properties 1))))
10308 (setq link (replace-match " " t t link)))
10309 (setq link (org-link-expand-abbrev link))
10310 (cond
10311 ((or (file-name-absolute-p link)
10313 (setq type "file" path link))
10314 ((string-match org-link-re-with-space3 link)
10315 (setq type (match-string 1 link) path (match-string 2 link)))
10317 (setq type "help" path (match-string 1 link)))
10318 (t (setq type "thisfile" path link)))
10319 (throw 'match t)))
10321 (when (get-text-property (point) 'org-linked-text)
10322 (setq type "thisfile"
10323 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10324 (1+ (point)) (point))
10325 path (buffer-substring
10326 (or (previous-single-property-change pos 'org-linked-text)
10327 (point-min))
10328 (or (next-single-property-change pos 'org-linked-text)
10329 (point-max))))
10330 (throw 'match t))
10332 (save-excursion
10333 (when (or (org-in-regexp org-angle-link-re)
10334 (let ((match (org-in-regexp org-plain-link-re)))
10335 ;; Check a plain link is not within a bracket link
10336 (and match
10337 (save-excursion
10338 (progn
10339 (goto-char (car match))
10340 (not (org-in-regexp org-bracket-link-regexp))))))
10341 (let ((line_ending (save-excursion (end-of-line) (point))))
10342 ;; We are in a line before a plain or bracket link
10343 (or (re-search-forward org-plain-link-re line_ending t)
10344 (re-search-forward org-bracket-link-regexp line_ending t))))
10345 (setq type (match-string 1)
10346 path (org-link-unescape (match-string 2)))
10347 (throw 'match t)))
10348 (save-excursion
10350 (setq type "tags"
10351 path (match-string 1))
10352 (while (string-match ":" path)
10353 (setq path (replace-match "+" t t path)))
10354 (throw 'match t)))
10356 (setq type "tree-match"
10357 path (match-string 1))
10358 (throw 'match t)))
10359 (unless path
10360 (user-error "No link found"))
10362 ;; switch back to reference buffer
10363 ;; needed when if called in a temporary buffer through
10364 ;; org-open-link-from-string
10365 (with-current-buffer (or reference-buffer (current-buffer))
10367 ;; Remove any trailing spaces in path
10369 (setq path (replace-match "" t t path)))
10370 (if (and org-link-translation-function
10371 (fboundp org-link-translation-function))
10372 ;; Check if we need to translate the link
10373 (let ((tmp (funcall org-link-translation-function type path)))
10374 (setq type (car tmp) path (cdr tmp))))
10376 (cond
10378 ((assoc type org-link-protocols)
10379 (funcall (nth 1 (assoc type org-link-protocols)) path))
10381 ((equal type "help")
10382 (let ((f-or-v (intern path)))
10383 (cond ((fboundp f-or-v)
10384 (describe-function f-or-v))
10385 ((boundp f-or-v)
10386 (describe-variable f-or-v))
10387 (t (error "Not a known function or variable")))))
10389 ((equal type "mailto")
10390 (let ((cmd (car org-link-mailto-program))
10391 (args (cdr org-link-mailto-program)) args1
10392 (address path) (subject "") a)
10394 (setq address (match-string 1 path)
10395 subject (org-link-escape (match-string 2 path))))
10396 (while args
10397 (cond
10398 ((not (stringp (car args))) (push (pop args) args1))
10399 (t (setq a (pop args))
10400 (if (string-match "%a" a)
10401 (setq a (replace-match address t t a)))
10402 (if (string-match "%s" a)
10403 (setq a (replace-match subject t t a)))
10404 (push a args1))))
10405 (apply cmd (nreverse args1))))
10407 ((member type '("http" "https" "ftp" "news"))
10408 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
10409 (org-link-escape
10410 path org-link-escape-chars-browser)
10411 path))))
10413 ((string= type "doi")
10414 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
10415 (org-link-escape
10416 path org-link-escape-chars-browser)
10417 path))))
10419 ((member type '("message"))
10420 (browse-url (concat type ":" path)))
10422 ((string= type "tags")
10423 (org-tags-view arg path))
10425 ((string= type "tree-match")
10428 ((string= type "file")
10430 (setq line (string-to-number (match-string 1 path))
10431 path (substring path 0 (match-beginning 0)))
10433 (setq search (match-string 1 path)
10434 path (substring path 0 (match-beginning 0)))))
10435 (if (string-match "[*?{]" (file-name-nondirectory path))
10436 (dired path)
10437 (org-open-file path arg line search)))
10439 ((string= type "shell")
10440 (let ((buf (generate-new-buffer "*Org Shell Output"))
10441 (cmd path))
10442 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10443 (string-match org-confirm-shell-link-not-regexp cmd))
10444 (not org-confirm-shell-link-function)
10445 (funcall org-confirm-shell-link-function
10447 (org-add-props cmd nil
10448 'face 'org-warning))))
10449 (progn
10450 (message "Executing %s" cmd)
10451 (shell-command cmd buf)
10452 (if (featurep 'midnight)
10453 (setq clean-buffer-list-kill-buffer-names
10454 (cons buf clean-buffer-list-kill-buffer-names))))
10455 (error "Abort"))))
10457 ((string= type "elisp")
10458 (let ((cmd path))
10459 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10460 (string-match org-confirm-elisp-link-not-regexp cmd))
10461 (not org-confirm-elisp-link-function)
10462 (funcall org-confirm-elisp-link-function
10464 (org-add-props cmd nil
10465 'face 'org-warning))))
10466 (message "%s => %s" cmd
10467 (if (equal (string-to-char cmd) ?\()
10468 (eval (read cmd))
10469 (call-interactively (read cmd))))
10470 (error "Abort"))))
10472 ((and (string= type "thisfile")
10473 (run-hook-with-args-until-success
10474 'org-open-link-functions path)))
10476 ((string= type "thisfile")
10477 (if arg
10478 (switch-to-buffer-other-window
10479 (org-get-buffer-for-internal-link (current-buffer)))
10480 (org-mark-ring-push))
10481 (let ((cmd `(org-link-search
10482 ,path
10483 ,(cond ((equal arg '(4)) ''occur)
10484 ((equal arg '(16)) ''org-occur))
10485 ,pos)))
10486 (condition-case nil (let ((org-link-search-inhibit-query t))
10487 (eval cmd))
10488 (error (progn (widen) (eval cmd))))))
10490 (t (browse-url-at-point)))))))
10491 (move-marker org-open-link-marker nil)
10492 (run-hook-with-args 'org-follow-link-hook)))
10494 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10495 "Offer links in the current entry and return the selected link.
10496 If there is only one link, return it.
10497 If NTH is an integer, return the NTH link found.
10498 If ZERO is a string, check also this string for a link, and if
10499 there is one, return it."
10500 (with-current-buffer buffer
10501 (save-excursion
10502 (save-restriction
10503 (widen)
10504 (goto-char marker)
10508 (cnt ?0)
10509 (in-emacs (if (integerp nth) nil nth))
10510 have-zero end links link c)
10511 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10512 (push (match-string 0 zero) links)
10513 (setq cnt (1- cnt) have-zero t))
10514 (save-excursion
10515 (org-back-to-heading t)
10516 (setq end (save-excursion (outline-next-heading) (point)))
10517 (while (re-search-forward re end t)
10518 (push (match-string 0) links))
10519 (setq links (org-uniquify (reverse links))))
10520 (cond
10521 ((null links)
10522 (message "No links"))
10523 ((equal (length links) 1)
10524 (setq link (car links)))
10525 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10526 (setq link (nth (if have-zero nth (1- nth)) links)))
10527 (t ; we have to select a link
10528 (save-excursion
10529 (save-window-excursion
10530 (delete-other-windows)
10531 (with-output-to-temp-buffer "*Select Link*"
10532 (mapc (lambda (l)
10533 (if (not (string-match org-bracket-link-regexp l))
10535 (org-remove-angle-brackets l)))
10536 (if (match-end 3)
10538 (match-string 3 l) (match-string 1 l)))
10540 (match-string 1 l))))))
10541 links))
10542 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10543 (message "Select link to open, RET to open all:")
10544 (setq c (read-char-exclusive))
10545 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10546 (when (equal c ?q) (error "Abort"))
10547 (if (equal c ?\C-m)
10548 (setq link links)
10549 (setq nth (- c ?0))
10550 (if have-zero (setq nth (1+ nth)))
10551 (unless (and (integerp nth) (>= (length links) nth))
10552 (error "Invalid link selection"))
10553 (setq link (nth (1- nth) links)))))
10554 (cons link end))))))
10556 ;; Add special file links that specify the way of opening
10558 (org-add-link-type "file+sys" 'org-open-file-with-system)
10559 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10560 (defun org-open-file-with-system (path)
10561 "Open file at PATH using the system way of opening it."
10562 (org-open-file path 'system))
10563 (defun org-open-file-with-emacs (path)
10564 "Open file at PATH in Emacs."
10565 (org-open-file path 'emacs))
10568 ;;; File search
10570 (defvar org-create-file-search-functions nil
10571 "List of functions to construct the right search string for a file link.
10572 These functions are called in turn with point at the location to
10573 which the link should point.
10575 A function in the hook should first test if it would like to
10576 handle this file type, for example by checking the `major-mode'
10577 or the file extension. If it decides not to handle this file, it
10578 should just return nil to give other functions a chance. If it
10579 does handle the file, it must return the search string to be used
10580 when following the link. The search string will be part of the
10581 file link, given after a double colon, and `org-open-at-point'
10582 will automatically search for it. If special measures must be
10583 taken to make the search successful, another function should be
10584 added to the companion hook `org-execute-file-search-functions',
10585 which see.
10587 A function in this hook may also use `setq' to set the variable
10588 `description' to provide a suggestion for the descriptive text to
10589 be used for this link when it gets inserted into an Org-mode
10592 (defvar org-execute-file-search-functions nil
10593 "List of functions to execute a file search triggered by a link.
10595 Functions added to this hook must accept a single argument, the
10596 search string that was part of the file link, the part after the
10597 double colon. The function must first check if it would like to
10598 handle this search, for example by checking the `major-mode' or
10599 the file extension. If it decides not to handle this search, it
10600 should just return nil to give other functions a chance. If it
10601 does handle the search, it must return a non-nil value to keep
10602 other functions from trying.
10604 Each function can access the current prefix argument through the
10605 variable `current-prefix-arg'. Note that a single prefix is used
10606 to force opening a link in Emacs, so it may be good to only use a
10607 numeric or double prefix to guide the search function.
10609 In case this is needed, a function in this hook can also restore
10610 the window configuration before `org-open-at-point' was called using:
10612 (set-window-configuration org-window-config-before-follow-link)")
10614 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10615 (defun org-link-search (s &optional type avoid-pos stealth)
10616 "Search for a link search option.
10617 If S is surrounded by forward slashes, it is interpreted as a
10618 regular expression. In org-mode files, this will create an `org-occur'
10619 sparse tree. In ordinary files, `occur' will be used to list matches.
10620 If the current buffer is in `dired-mode', grep will be used to search
10621 in all files. If AVOID-POS is given, ignore matches near that position.
10623 When optional argument STEALTH is non-nil, do not modify
10624 visibility around point, thus ignoring
10625 `org-show-hierarchy-above', `org-show-following-heading' and
10626 `org-show-siblings' variables."
10627 (let ((case-fold-search t)
10631 org-emphasis-alist)
10633 (pos (point))
10634 (pre nil) (post nil)
10635 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10636 (cond
10637 ;; First check if there are any special search functions
10638 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10639 ;; Now try the builtin stuff
10640 ((and (equal (string-to-char s0) ?#)
10641 (> (length s0) 1)
10642 (save-excursion
10643 (goto-char (point-min))
10644 (and
10645 (re-search-forward
10648 (setq type 'dedicated
10649 pos (match-beginning 0))))
10650 ;; There is an exact target for this
10651 (goto-char pos)
10652 (org-back-to-heading t)))
10653 ((save-excursion
10654 (goto-char (point-min))
10655 (and
10656 (re-search-forward
10657 (concat "<<" (regexp-quote s0) ">>") nil t)
10658 (setq type 'dedicated
10659 pos (match-beginning 0))))
10660 ;; There is an exact target for this
10661 (goto-char pos))
10662 ((save-excursion
10663 (goto-char (point-min))
10664 (and
10665 (re-search-forward
10667 (setq type 'dedicated pos (match-beginning 0))))
10668 ;; Found an element with a matching #+name affiliated keyword.
10669 (goto-char pos))
10671 (save-excursion
10672 (goto-char (point-min))
10673 (and
10674 (re-search-forward
10675 (concat "[^[]" (regexp-quote
10676 (format org-coderef-label-format
10677 (match-string 1 s0))))
10678 nil t)
10679 (setq type 'dedicated
10680 pos (1+ (match-beginning 0))))))
10681 ;; There is a coderef target for this
10682 (goto-char pos))
10684 ;; A regular expression
10685 (cond
10686 ((derived-mode-p 'org-mode)
10687 (org-occur (match-string 1 s)))
10688 (t (org-do-occur (match-string 1 s)))))
10689 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10690 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10691 (goto-char (point-min))
10692 (cond
10693 ((let (case-fold-search)
10694 (re-search-forward (format org-complex-heading-regexp-format
10695 (regexp-quote s))
10696 nil t))
10697 ;; OK, found a match
10698 (setq type 'dedicated)
10699 (goto-char (match-beginning 0)))
10700 ((and (not org-link-search-inhibit-query)
10701 (eq org-link-search-must-match-exact-headline 'query-to-create)
10702 (y-or-n-p "No match - create this as a new heading? "))
10703 (goto-char (point-max))
10704 (or (bolp) (newline))
10706 (beginning-of-line 0))
10707 (t
10708 (goto-char pos)
10709 (error "No match"))))
10710 (t
10711 ;; A normal search string
10712 (when (equal (string-to-char s) ?*)
10713 ;; Anchor on headlines, post may include tags.
10716 s (substring s 1)))
10717 (remove-text-properties
10718 0 (length s)
10719 '(face nil mouse-face nil keymap nil fontified nil) s)
10720 ;; Make a series of regular expressions to find a match
10731 re4 (concat "[^a-zA-Z_]" re4_)
10733 re1 (concat pre re2 post)
10734 re3 (concat pre (if pre re4_ re4) post)
10735 re5 (concat pre ".*" re4)
10736 re2 (concat pre re2)
10737 re2a (concat pre (if pre re2a_ re2a))
10738 re4 (concat pre (if pre re4_ re4))
10742 (cond
10743 ((eq type 'org-occur) (org-occur reall))
10744 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10745 (t (goto-char (point-min))
10746 (setq type 'fuzzy)
10747 (if (or (and (org-search-not-self 1 re0 nil t)
10748 (setq type 'dedicated))
10749 (org-search-not-self 1 re1 nil t)
10750 (org-search-not-self 1 re2 nil t)
10751 (org-search-not-self 1 re2a nil t)
10752 (org-search-not-self 1 re3 nil t)
10753 (org-search-not-self 1 re4 nil t)
10754 (org-search-not-self 1 re5 nil t))
10755 (goto-char (match-beginning 1))
10756 (goto-char pos)
10757 (error "No match"))))))
10758 (and (derived-mode-p 'org-mode)
10759 (not stealth)
10760 (org-show-context 'link-search))
10761 type))
10763 (defun org-search-not-self (group &rest args)
10764 "Execute `re-search-forward', but only accept matches that do not
10765 enclose the position of `org-open-link-marker'."
10766 (let ((m org-open-link-marker))
10767 (catch 'exit
10768 (while (apply 're-search-forward args)
10769 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10770 (goto-char (match-end group))
10771 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10772 (> (match-beginning 0) (marker-position m))
10773 (< (match-end 0) (marker-position m)))
10774 (save-match-data
10775 (or (not (org-in-regexp
10776 org-bracket-link-analytic-regexp 1))
10777 (not (match-end 4)) ; no description
10778 (and (<= (match-beginning 4) (point))
10779 (>= (match-end 4) (point))))))
10780 (throw 'exit (point))))))))
10782 (defun org-get-buffer-for-internal-link (buffer)
10783 "Return a buffer to be used for displaying the link target of internal links."
10784 (cond
10785 ((not org-display-internal-link-with-indirect-buffer)
10786 buffer)
10787 ((string-match "(Clone)$" (buffer-name buffer))
10788 (message "Buffer is already a clone, not making another one")
10789 ;; we also do not modify visibility in this case
10790 buffer)
10791 (t ; make a new indirect buffer for displaying the link
10792 (let* ((bn (buffer-name buffer))
10793 (ibn (concat bn "(Clone)"))
10794 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10795 (with-current-buffer ib (org-overview))
10796 ib))))
10798 (defun org-do-occur (regexp &optional cleanup)
10799 "Call the Emacs command `occur'.
10800 If CLEANUP is non-nil, remove the printout of the regular expression
10801 in the *Occur* buffer. This is useful if the regex is long and not useful
10802 to read."
10803 (occur regexp)
10804 (when cleanup
10805 (let ((cwin (selected-window)) win beg end)
10806 (when (setq win (get-buffer-window "*Occur*"))
10807 (select-window win))
10808 (goto-char (point-min))
10809 (when (re-search-forward "match[a-z]+" nil t)
10810 (setq beg (match-end 0))
10812 (setq end (1- (match-beginning 0)))))
10813 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10814 (goto-char (point-min))
10815 (select-window cwin))))
10817 ;;; The mark ring for links jumps
10819 (defvar org-mark-ring nil
10820 "Mark ring for positions before jumps in Org-mode.")
10821 (defvar org-mark-ring-last-goto nil
10822 "Last position in the mark ring used to go back.")
10823 ;; Fill and close the ring
10824 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10825 (loop for i from 1 to org-mark-ring-length do
10826 (push (make-marker) org-mark-ring))
10827 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10828 org-mark-ring)
10830 (defun org-mark-ring-push (&optional pos buffer)
10831 "Put the current position or POS into the mark ring and rotate it."
10832 (interactive)
10833 (setq pos (or pos (point)))
10834 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10835 (move-marker (car org-mark-ring)
10836 (or pos (point))
10837 (or buffer (current-buffer)))
10838 (message "%s"
10839 (substitute-command-keys
10842 (defun org-mark-ring-goto (&optional n)
10843 "Jump to the previous position in the mark ring.
10844 With prefix arg N, jump back that many stored positions. When
10845 called several times in succession, walk through the entire ring.
10846 Org-mode commands jumping to a different position in the current file,
10847 or to another Org-mode file, automatically push the old position
10848 onto the ring."
10849 (interactive "p")
10850 (let (p m)
10851 (if (eq last-command this-command)
10852 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10853 (setq p org-mark-ring))
10854 (setq org-mark-ring-last-goto p)
10855 (setq m (car p))
10856 (org-pop-to-buffer-same-window (marker-buffer m))
10857 (goto-char m)
10858 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10860 (defun org-remove-angle-brackets (s)
10861 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10862 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10863 s)
10864 (defun org-add-angle-brackets (s)
10865 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10866 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10867 s)
10868 (defun org-remove-double-quotes (s)
10871 s)
10873 ;;; Following specific links
10875 (defun org-follow-timestamp-link ()
10876 "Open an agenda view for the time-stamp date/range at point."
10877 (cond
10878 ((org-at-date-range-p t)
10879 (let ((org-agenda-start-on-weekday)
10880 (t1 (match-string 1))
10881 (t2 (match-string 2)) tt1 tt2)
10882 (setq tt1 (time-to-days (org-time-string-to-time t1))
10883 tt2 (time-to-days (org-time-string-to-time t2)))
10884 (let ((org-agenda-buffer-tmp-name
10885 (format "*Org Agenda(a:%s)"
10886 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10887 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10888 ((org-at-timestamp-p t)
10889 (let ((org-agenda-buffer-tmp-name
10890 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10891 (org-agenda-list nil (time-to-days (org-time-string-to-time
10892 (substring (match-string 1) 0 10)))
10893 1)))
10894 (t (error "This should not happen"))))
10897 ;;; Following file links
10898 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10899 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10900 (declare-function mailcap-mime-info
10901 "mailcap" (string &optional request no-decode))
10902 (defvar org-wait nil)
10903 (defun org-open-file (path &optional in-emacs line search)
10904 "Open the file at PATH.
10905 First, this expands any special file name abbreviations. Then the
10906 configuration variable `org-file-apps' is checked if it contains an
10907 entry for this file type, and if yes, the corresponding command is launched.
10909 If no application is found, Emacs simply visits the file.
10911 With optional prefix argument IN-EMACS, Emacs will visit the file.
10913 prefix arg, Org tries to avoid opening in Emacs
10914 and to use an external application to visit the file.
10916 Optional LINE specifies a line to go to, optional SEARCH a string
10917 to search for. If LINE or SEARCH is given, the file will be
10918 opened in Emacs, unless an entry from org-file-apps that makes
10919 use of groups in a regexp matches.
10921 If you want to change the way frames are used when following a
10922 link, please customize `org-link-frame-setup'.
10924 If the file does not exist, an error is thrown."
10925 (let* ((file (if (equal path "")
10926 buffer-file-name
10927 (substitute-in-file-name (expand-file-name path))))
10928 (file-apps (append org-file-apps (org-default-apps)))
10929 (apps (org-remove-if
10930 'org-file-apps-entry-match-against-dlink-p file-apps))
10931 (apps-dlink (org-remove-if-not
10932 'org-file-apps-entry-match-against-dlink-p file-apps))
10933 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10934 (dirp (if remp nil (file-directory-p file)))
10935 (file (if (and dirp org-open-directory-means-index-dot-org)
10936 (concat (file-name-as-directory file) "index.org")
10937 file))
10938 (a-m-a-p (assq 'auto-mode apps))
10939 (dfile (downcase file))
10940 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10941 (link (cond ((and (eq line nil)
10942 (eq search nil))
10943 file)
10944 (line
10945 (concat file "::" (number-to-string line)))
10946 (search
10947 (concat file "::" search))))
10948 (dlink (downcase link))
10949 (old-buffer (current-buffer))
10950 (old-pos (point))
10951 (old-mode major-mode)
10952 ext cmd link-match-data)
10954 (setq ext (match-string 1 dfile))
10956 (setq ext (match-string 1 dfile))))
10957 (cond
10958 ((member in-emacs '((16) system))
10959 (setq cmd (cdr (assoc 'system apps))))
10960 (in-emacs (setq cmd 'emacs))
10961 (t
10962 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10963 (and dirp (cdr (assoc 'directory apps)))
10964 ; first, try matching against apps-dlink
10965 ; if we get a match here, store the match data for later
10966 (let ((match (assoc-default dlink apps-dlink
10967 'string-match)))
10968 (if match
10969 (progn (setq link-match-data (match-data))
10970 match)
10971 (progn (setq in-emacs (or in-emacs line search))
10972 nil))) ; if we have no match in apps-dlink,
10973 ; always open the file in emacs if line or search
10974 ; is given (for backwards compatibility)
10975 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10976 'string-match)
10977 (cdr (assoc ext apps))
10978 (cdr (assoc t apps))))))
10979 (when (eq cmd 'system)
10980 (setq cmd (cdr (assoc 'system apps))))
10981 (when (eq cmd 'default)
10982 (setq cmd (cdr (assoc t apps))))
10983 (when (eq cmd 'mailcap)
10984 (require 'mailcap)
10985 (mailcap-parse-mailcaps)
10986 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10987 (command (mailcap-mime-info mime-type)))
10988 (if (stringp command)
10989 (setq cmd command)
10990 (setq cmd 'emacs))))
10991 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10992 (not (file-exists-p file))
10993 (not org-open-non-existing-files))
10994 (error "No such file: %s" file))
10995 (cond
10997 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10999 (setq cmd (replace-match "%s" t t cmd)))
11000 (while (string-match "%s" cmd)
11001 (setq cmd (replace-match
11002 (save-match-data
11003 (shell-quote-argument
11004 (convert-standard-filename file)))
11005 t t cmd)))
11007 ;; Replace "%1", "%2" etc. in command with group matches from regex
11008 (save-match-data
11009 (let ((match-index 1)
11010 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11011 (set-match-data link-match-data)
11012 (while (<= match-index number-of-groups)
11013 (let ((regex (concat "%" (number-to-string match-index)))
11014 (replace-with (match-string match-index dlink)))
11015 (while (string-match regex cmd)
11016 (setq cmd (replace-match replace-with t t cmd))))
11017 (setq match-index (+ match-index 1)))))
11019 (save-window-excursion
11020 (message "Running %s...done" cmd)
11021 (start-process-shell-command cmd nil cmd)
11022 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11023 ((or (stringp cmd)
11024 (eq cmd 'emacs))
11025 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11026 (widen)
11027 (if line (org-goto-line line)
11028 (if search (org-link-search search))))
11029 ((consp cmd)
11030 (let ((file (convert-standard-filename file)))
11031 (save-match-data
11032 (set-match-data link-match-data)
11033 (eval cmd))))
11034 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11035 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11036 (or (not (equal old-buffer (current-buffer)))
11037 (not (equal old-pos (point))))
11038 (org-mark-ring-push old-pos old-buffer))))
11040 (defun org-file-apps-entry-match-against-dlink-p (entry)
11041 "This function returns non-nil if `entry' uses a regular
11042 expression which should be matched against the whole link by
11043 org-open-file.
11045 It assumes that is the case when the entry uses a regular
11046 expression which has at least one grouping construct and the
11047 action is either a lisp form or a command string containing
11048 '%1', i.e. using at least one subexpression match as a
11049 parameter."
11050 (let ((selector (car entry))
11051 (action (cdr entry)))
11052 (if (stringp selector)
11053 (and (> (regexp-opt-depth selector) 0)
11054 (or (and (stringp action)
11055 (string-match "%[0-9]" action))
11056 (consp action)))
11057 nil)))
11059 (defun org-default-apps ()
11060 "Return the default applications for this operating system."
11061 (cond
11062 ((eq system-type 'darwin)
11063 org-file-apps-defaults-macosx)
11064 ((eq system-type 'windows-nt)
11065 org-file-apps-defaults-windowsnt)
11066 (t org-file-apps-defaults-gnu)))
11068 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11069 "Convert extensions to regular expressions in the cars of LIST.
11070 Also, weed out any non-string entries, because the return value is used
11071 only for regexp matching.
11072 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11073 point to the symbol `emacs', indicating that the file should
11074 be opened in Emacs."
11075 (append
11076 (delq nil
11077 (mapcar (lambda (x)
11078 (if (not (stringp (car x)))
11079 nil
11081 x
11083 list))
11084 (if add-auto-mode
11085 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11087 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11088 (defun org-file-remote-p (file)
11089 "Test whether FILE specifies a location on a remote system.
11090 Return non-nil if the location is indeed remote.
11094 (cond ((fboundp 'file-remote-p)
11095 (file-remote-p file))
11096 ((fboundp 'tramp-handle-file-remote-p)
11097 (tramp-handle-file-remote-p file))
11098 ((and (boundp 'ange-ftp-name-format)
11099 (string-match (car ange-ftp-name-format) file))
11100 t)))
11103 ;;;; Refiling
11105 (defun org-get-org-file ()
11106 "Read a filename, with default directory `org-directory'."
11107 (let ((default (or org-default-notes-file remember-data-file)))
11108 (read-file-name (format "File name [%s]: " default)
11109 (file-name-as-directory org-directory)
11110 default)))
11112 (defun org-notes-order-reversed-p ()
11113 "Check if the current file should receive notes in reversed order."
11114 (cond
11115 ((not org-reverse-note-order) nil)
11116 ((eq t org-reverse-note-order) t)
11117 ((not (listp org-reverse-note-order)) nil)
11118 (t (catch 'exit
11119 (let ((all org-reverse-note-order)
11120 entry)
11121 (while (setq entry (pop all))
11122 (if (string-match (car entry) buffer-file-name)
11123 (throw 'exit (cdr entry))))
11124 nil)))))
11126 (defvar org-refile-target-table nil
11127 "The list of refile targets, created by `org-refile'.")
11129 (defvar org-agenda-new-buffers nil
11130 "Buffers created to visit agenda files.")
11132 (defvar org-refile-cache nil
11133 "Cache for refile targets.")
11135 (defvar org-refile-markers nil
11136 "All the markers used for caching refile locations.")
11138 (defun org-refile-marker (pos)
11139 "Get a new refile marker, but only if caching is in use."
11140 (if (not org-refile-use-cache)
11141 pos
11142 (let ((m (make-marker)))
11143 (move-marker m pos)
11144 (push m org-refile-markers)
11145 m)))
11147 (defun org-refile-cache-clear ()
11148 "Clear the refile cache and disable all the markers."
11149 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11150 (setq org-refile-markers nil)
11151 (setq org-refile-cache nil)
11152 (message "Refile cache has been cleared"))
11154 (defun org-refile-cache-check-set (set)
11155 "Check if all the markers in the cache still have live buffers."
11156 (let (marker)
11157 (catch 'exit
11158 (while (and set (setq marker (nth 3 (pop set))))
11159 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11160 (when (and marker (null (marker-buffer marker)))
11161 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11162 (sit-for 3)
11163 (throw 'exit nil)))
11164 t)))
11166 (defun org-refile-cache-put (set &rest identifiers)
11167 "Push the refile targets SET into the cache, under IDENTIFIERS."
11168 (let* ((key (sha1 (prin1-to-string identifiers)))
11169 (entry (assoc key org-refile-cache)))
11170 (if entry
11171 (setcdr entry set)
11172 (push (cons key set) org-refile-cache))))
11174 (defun org-refile-cache-get (&rest identifiers)
11175 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11176 (cond
11177 ((not org-refile-cache) nil)
11178 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11179 (t
11180 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11181 org-refile-cache))))
11182 (and set (org-refile-cache-check-set set) set)))))
11184 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11185 "Produce a table with refile targets."
11186 (let ((case-fold-search nil)
11187 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11188 (entries (or org-refile-targets '((nil . (:level . 1)))))
11189 targets tgs txt re files f desc descre fast-path-p level pos0)
11190 (message "Getting targets...")
11191 (with-current-buffer (or default-buffer (current-buffer))
11192 (while (setq entry (pop entries))
11193 (setq files (car entry) desc (cdr entry))
11194 (setq fast-path-p nil)
11195 (cond
11196 ((null files) (setq files (list (current-buffer))))
11197 ((eq files 'org-agenda-files)
11198 (setq files (org-agenda-files 'unrestricted)))
11199 ((and (symbolp files) (fboundp files))
11200 (setq files (funcall files)))
11201 ((and (symbolp files) (boundp files))
11202 (setq files (symbol-value files))))
11203 (if (stringp files) (setq files (list files)))
11204 (cond
11205 ((eq (car desc) :tag)
11207 ((eq (car desc) :todo)
11209 ((eq (car desc) :regexp)
11210 (setq descre (cdr desc)))
11211 ((eq (car desc) :level)
11213 (if org-odd-levels-only
11214 (1- (* 2 (cdr desc)))
11215 (cdr desc)))
11217 ((eq (car desc) :maxlevel)
11218 (setq fast-path-p t)
11220 (if org-odd-levels-only
11221 (1- (* 2 (cdr desc)))
11222 (cdr desc)))
11224 (t (error "Bad refiling target description %s" desc)))
11225 (while (setq f (pop files))
11226 (with-current-buffer
11227 (if (bufferp f) f (org-get-agenda-file-buffer f))
11228 (or
11229 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11230 (progn
11231 (if (bufferp f) (setq f (buffer-file-name
11232 (buffer-base-buffer f))))
11233 (setq f (and f (expand-file-name f)))
11234 (if (eq org-refile-use-outline-path 'file)
11235 (push (list (file-name-nondirectory f) f nil nil) tgs))
11236 (save-excursion
11237 (save-restriction
11238 (widen)
11239 (goto-char (point-min))
11240 (while (re-search-forward descre nil t)
11241 (goto-char (setq pos0 (point-at-bol)))
11242 (catch 'next
11243 (when org-refile-target-verify-function
11244 (save-match-data
11245 (or (funcall org-refile-target-verify-function)
11246 (throw 'next t))))
11247 (when (and (looking-at org-complex-heading-regexp)
11248 (not (member (match-string 4) excluded-entries))
11249 (match-string 4))
11250 (setq level (org-reduced-level
11251 (- (match-end 1) (match-beginning 1)))
11252 txt (org-link-display-format (match-string 4))
11254 re (format org-complex-heading-regexp-format
11255 (regexp-quote (match-string 4))))
11256 (when org-refile-use-outline-path
11257 (setq txt (mapconcat
11258 'org-protect-slash
11259 (append
11260 (if (eq org-refile-use-outline-path
11261 'file)
11262 (list (file-name-nondirectory
11263 (buffer-file-name
11264 (buffer-base-buffer))))
11265 (if (eq org-refile-use-outline-path
11266 'full-file-path)
11267 (list (buffer-file-name
11268 (buffer-base-buffer)))))
11269 (org-get-outline-path fast-path-p
11270 level txt)
11271 (list txt))
11272 "/")))
11273 (push (list txt f re (org-refile-marker (point)))
11274 tgs)))
11275 (when (= (point) pos0)
11276 ;; verification function has not moved point
11277 (goto-char (point-at-eol))))))))
11278 (when org-refile-use-cache
11279 (org-refile-cache-put tgs (buffer-file-name) descre))
11280 (setq targets (append tgs targets))))))
11281 (message "Getting targets...done")
11282 (nreverse targets)))
11284 (defun org-protect-slash (s)
11285 (while (string-match "/" s)
11287 s)
11289 (defvar org-olpa (make-vector 20 nil))
11291 (defun org-get-outline-path (&optional fastp level heading)
11292 "Return the outline path to the current entry, as a list.
11294 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11295 routine which makes outline path derivations for an entire file,
11296 avoiding backtracing. Refile target collection makes use of that."
11297 (if fastp
11298 (progn
11299 (if (> level 19)
11300 (error "Outline path failure, more than 19 levels"))
11301 (loop for i from level upto 19 do
11302 (aset org-olpa i nil))
11303 (prog1
11304 (delq nil (append org-olpa nil))
11305 (aset org-olpa level heading)))
11306 (let (rtn case-fold-search)
11307 (save-excursion
11308 (save-restriction
11309 (widen)
11310 (while (org-up-heading-safe)
11311 (when (looking-at org-complex-heading-regexp)
11312 (push (org-match-string-no-properties 4) rtn)))
11313 rtn)))))
11315 (defun org-format-outline-path (path &optional width prefix separator)
11316 "Format the outline path PATH for display.
11317 WIDTH is the maximum number of characters that is available.
11318 PREFIX is a prefix to be included in the returned string,
11319 such as the file name.
11320 SEPARATOR is inserted between the different parts of the path,
11322 (setq width (or width 79))
11323 (if prefix (setq width (- width (length prefix))))
11324 (if (not path)
11325 (or prefix "")
11326 (let* ((nsteps (length path))
11327 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11328 (maxwidth (if (<= total-width width)
11329 10000 ;; everything fits
11330 ;; we need to shorten the level headings
11331 (/ (- width nsteps) nsteps)))
11332 (org-odd-levels-only nil)
11333 (n 0)
11334 (total (1+ (length prefix))))
11335 (setq maxwidth (max maxwidth 10))
11336 (concat prefix
11337 (if prefix (or separator "/"))
11338 (mapconcat
11339 (lambda (h)
11340 (setq n (1+ n))
11341 (if (and (= n nsteps) (< maxwidth 10000))
11342 (setq maxwidth (- total-width total)))
11343 (if (< (length h) maxwidth)
11344 (progn (setq total (+ total (length h) 1)) h)
11345 (setq h (substring h 0 (- maxwidth 2))
11346 total (+ total maxwidth 1))
11348 (setq h (substring h 0 (match-beginning 0))))
11349 (setq h (concat h "..")))
11350 (org-add-props h nil 'face
11351 (nth (% (1- n) org-n-level-faces)
11352 org-level-faces))
11353 h)
11354 path (or separator "/"))))))
11356 (defun org-display-outline-path (&optional file current separator just-return-string)
11357 "Display the current outline path in the echo area.
11359 If FILE is non-nil, prepend the output with the file name.
11360 If CURRENT is non-nil, append the current heading to the output.
11361 SEPARATOR is passed through to `org-format-outline-path'. It separates
11363 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11364 (interactive "P")
11365 (let* (case-fold-search
11366 message-log-max ; Don't populate the *Messages* buffer
11367 (bfn (buffer-file-name (buffer-base-buffer)))
11368 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11369 res)
11370 (if current (setq path (append path
11371 (save-excursion
11372 (org-back-to-heading t)
11373 (if (looking-at org-complex-heading-regexp)
11374 (list (match-string 4)))))))
11375 (setq res
11376 (org-format-outline-path
11377 path
11378 (1- (frame-width))
11379 (and file bfn (concat (file-name-nondirectory bfn) separator))
11380 separator))
11381 (if just-return-string
11382 (org-no-properties res)
11383 (message "%s" res))))
11385 (defvar org-refile-history nil
11386 "History for refiling operations.")
11388 (defvar org-after-refile-insert-hook nil
11389 "Hook run after `org-refile' has inserted its stuff at the new location.
11390 Note that this is still *before* the stuff will be removed from
11391 the *old* location.")
11393 (defvar org-capture-last-stored-marker)
11394 (defvar org-refile-keep nil
11395 "Non-nil means `org-refile' will copy instead of refile.")
11397 (defun org-copy ()
11398 "Like `org-refile', but copy."
11399 (interactive)
11400 (let ((org-refile-keep t))
11401 (funcall 'org-refile nil nil nil "Copy")))
11403 (defun org-refile (&optional goto default-buffer rfloc msg)
11404 "Move the entry or entries at point to another heading.
11405 The list of target headings is compiled using the information in
11406 `org-refile-targets', which see.
11408 At the target location, the entry is filed as a subitem of the target
11409 heading. Depending on `org-reverse-note-order', the new subitem will
11410 either be the first or the last subitem.
11412 If there is an active region, all entries in that region will be moved.
11413 However, the region must fulfill the requirement that the first heading
11414 is the first one sets the top-level of the moved text - at most siblings
11415 below it are allowed.
11417 With prefix arg GOTO, the command will only visit the target location
11418 and not actually move anything.
11421 go to the location where the last refiling operation has put the subtree.
11422 With a prefix argument of `2', refile to the running clock.
11424 RFLOC can be a refile location obtained in a different way.
11429 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11431 If you are using target caching (see `org-refile-use-cache'),
11432 you have to clear the target cache in order to find new targets.
11433 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11434 prefix argument (`C-u C-u C-u C-c C-w')."
11436 (interactive "P")
11437 (if (member goto '(0 (64)))
11438 (org-refile-cache-clear)
11439 (let* ((actionmsg (or msg "Refile"))
11440 (cbuf (current-buffer))
11441 (regionp (org-region-active-p))
11442 (region-start (and regionp (region-beginning)))
11443 (region-end (and regionp (region-end)))
11444 (region-length (and regionp (- region-end region-start)))
11445 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11446 pos it nbuf file re level reversed)
11447 (setq last-command nil)
11448 (when regionp
11449 (goto-char region-start)
11450 (or (bolp) (goto-char (point-at-bol)))
11451 (setq region-start (point))
11452 (unless (or (org-kill-is-subtree-p
11453 (buffer-substring region-start region-end))
11454 (prog1 org-refile-active-region-within-subtree
11455 (org-toggle-heading)))
11456 (error "The region is not a (sequence of) subtree(s)")))
11457 (if (equal goto '(16))
11458 (org-refile-goto-last-stored)
11459 (when (or
11460 (and (equal goto 2)
11461 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11462 (prog1
11463 (setq it (list (or org-clock-heading "running clock")
11464 (buffer-file-name
11465 (marker-buffer org-clock-hd-marker))
11466 ""
11467 (marker-position org-clock-hd-marker)))
11468 (setq goto nil)))
11469 (setq it (or rfloc
11470 (let (heading-text)
11471 (save-excursion
11472 (unless goto
11473 (org-back-to-heading t)
11474 (setq heading-text
11475 (nth 4 (org-heading-components))))
11477 (org-refile-get-location
11478 (cond (goto "Goto")
11479 (regionp (concat actionmsg " region to"))
11482 default-buffer
11483 (and (not (equal '(4) goto))
11484 org-refile-allow-creating-parent-nodes)
11485 goto))))))
11486 (setq file (nth 1 it)
11487 re (nth 2 it)
11488 pos (nth 3 it))
11489 (if (and (not goto)
11490 pos
11491 (equal (buffer-file-name) file)
11492 (if regionp
11493 (and (>= pos region-start)
11494 (<= pos region-end))
11495 (and (>= pos (point))
11496 (< pos (save-excursion
11497 (org-end-of-subtree t t))))))
11498 (error "Cannot refile to position inside the tree or region"))
11500 (setq nbuf (or (find-buffer-visiting file)
11501 (find-file-noselect file)))
11502 (if goto
11503 (progn
11504 (org-pop-to-buffer-same-window nbuf)
11505 (goto-char pos)
11506 (org-show-context 'org-goto))
11507 (if regionp
11508 (progn
11509 (org-kill-new (buffer-substring region-start region-end))
11510 (org-save-markers-in-region region-start region-end))
11511 (org-copy-subtree 1 nil t))
11512 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11513 (find-file-noselect file)))
11514 (setq reversed (org-notes-order-reversed-p))
11515 (save-excursion
11516 (save-restriction
11517 (widen)
11518 (if pos
11519 (progn
11520 (goto-char pos)
11521 (looking-at org-outline-regexp)
11522 (setq level (org-get-valid-level (funcall outline-level) 1))
11523 (goto-char
11524 (if reversed
11525 (or (outline-next-heading) (point-max))
11526 (or (save-excursion (org-get-next-sibling))
11527 (org-end-of-subtree t t)
11528 (point-max)))))
11529 (setq level 1)
11530 (if (not reversed)
11531 (goto-char (point-max))
11532 (goto-char (point-min))
11533 (or (outline-next-heading) (goto-char (point-max)))))
11534 (if (not (bolp)) (newline))
11535 (org-paste-subtree level)
11536 (when org-log-refile
11537 (org-add-log-setup 'refile nil nil 'findpos
11538 org-log-refile)
11539 (unless (eq org-log-refile 'note)
11540 (save-excursion (org-add-log-note))))
11541 (and org-auto-align-tags
11542 (let ((org-loop-over-headlines-in-active-region nil))
11543 (org-set-tags nil t)))
11544 (with-demoted-errors
11545 (bookmark-set "org-refile-last-stored"))
11546 ;; If we are refiling for capture, make sure that the
11547 ;; last-capture pointers point here
11548 (when (org-bound-and-true-p org-refile-for-capture)
11549 (with-demoted-errors
11550 (bookmark-set "org-capture-last-stored-marker"))
11551 (move-marker org-capture-last-stored-marker (point)))
11552 (if (fboundp 'deactivate-mark) (deactivate-mark))
11553 (run-hooks 'org-after-refile-insert-hook))))
11554 (unless org-refile-keep
11555 (if regionp
11556 (delete-region (point) (+ (point) region-length))
11557 (org-cut-subtree)))
11558 (when (featurep 'org-inlinetask)
11559 (org-inlinetask-remove-END-maybe))
11560 (setq org-markers-to-move nil)
11563 (defun org-refile-goto-last-stored ()
11564 "Go to the location where the last refile was stored."
11565 (interactive)
11566 (bookmark-jump "org-refile-last-stored")
11567 (message "This is the location of the last refile"))
11569 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11570 no-exclude)
11571 "Prompt the user for a refile location, using PROMPT.
11572 PROMPT should not be suffixed with a colon and a space, because
11573 this function appends the default value from
11574 `org-refile-history' automatically, if that is not empty.
11575 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11576 this is used for the GOTO interface."
11577 (let ((org-refile-targets org-refile-targets)
11578 (org-refile-use-outline-path org-refile-use-outline-path)
11579 excluded-entries)
11580 (when (and (derived-mode-p 'org-mode)
11581 (not org-refile-use-cache)
11582 (not no-exclude))
11583 (org-map-tree
11584 (lambda()
11585 (setq excluded-entries
11586 (append excluded-entries (list (org-get-heading t t)))))))
11587 (setq org-refile-target-table
11588 (org-refile-get-targets default-buffer excluded-entries)))
11589 (unless org-refile-target-table
11590 (error "No refile targets"))
11591 (let* ((cbuf (current-buffer))
11592 (partial-completion-mode nil)
11593 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11594 (cfunc (if (and org-refile-use-outline-path
11595 org-outline-path-complete-in-steps)
11596 'org-olpath-completing-read
11597 'org-icompleting-read))
11598 (extra (if org-refile-use-outline-path "/" ""))
11599 (cbnex (concat (buffer-name) extra))
11600 (filename (and cfn (expand-file-name cfn)))
11601 (tbl (mapcar
11602 (lambda (x)
11603 (if (and (not (member org-refile-use-outline-path
11604 '(file full-file-path)))
11605 (not (equal filename (nth 1 x))))
11606 (cons (concat (car x) extra " ("
11607 (file-name-nondirectory (nth 1 x)) ")")
11608 (cdr x))
11609 (cons (concat (car x) extra) (cdr x))))
11610 org-refile-target-table))
11611 (completion-ignore-case t)
11612 cdef
11613 (prompt (concat prompt
11614 (or (and (car org-refile-history)
11615 (concat " (default " (car org-refile-history) ")"))
11616 (and (assoc cbnex tbl) (setq cdef cbnex)
11617 (concat " (default " cbnex ")"))) ": "))
11618 pa answ parent-target child parent old-hist)
11619 (setq old-hist org-refile-history)
11620 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11621 nil 'org-refile-history (or cdef (car org-refile-history))))
11622 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11623 (org-refile-check-position pa)
11624 (if pa
11625 (progn
11626 (when (or (not org-refile-history)
11627 (not (eq old-hist org-refile-history))
11628 (not (equal (car pa) (car org-refile-history))))
11629 (setq org-refile-history
11630 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11631 org-refile-history
11632 (cdr org-refile-history))))
11633 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11634 (pop org-refile-history)))
11635 pa)
11637 (progn
11638 (setq parent (match-string 1 answ)
11639 child (match-string 2 answ))
11640 (setq parent-target (or (assoc parent tbl)
11641 (assoc (concat parent "/") tbl)))
11642 (when (and parent-target
11643 (or (eq new-nodes t)
11644 (and (eq new-nodes 'confirm)
11646 child)))))
11647 (org-refile-new-child parent-target child)))
11648 (error "Invalid target location")))))
11650 (declare-function org-string-nw-p "org-macs" (s))
11651 (defun org-refile-check-position (refile-pointer)
11652 "Check if the refile pointer matches the headline to which it points."
11653 (let* ((file (nth 1 refile-pointer))
11654 (re (nth 2 refile-pointer))
11655 (pos (nth 3 refile-pointer))
11656 buffer)
11657 (if (and (not (markerp pos)) (not file))
11658 (error "Please save the buffer to a file before refiling")
11659 (when (org-string-nw-p re)
11660 (setq buffer (if (markerp pos)
11661 (marker-buffer pos)
11662 (or (find-buffer-visiting file)
11663 (find-file-noselect file))))
11664 (with-current-buffer buffer
11665 (save-excursion
11666 (save-restriction
11667 (widen)
11668 (goto-char pos)
11669 (beginning-of-line 1)
11670 (unless (org-looking-at-p re)
11671 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11673 (defun org-refile-new-child (parent-target child)
11674 "Use refile target PARENT-TARGET to add new CHILD below it."
11675 (unless parent-target
11676 (error "Cannot find parent for new node"))
11677 (let ((file (nth 1 parent-target))
11678 (pos (nth 3 parent-target))
11679 level)
11680 (with-current-buffer (or (find-buffer-visiting file)
11681 (find-file-noselect file))
11682 (save-excursion
11683 (save-restriction
11684 (widen)
11685 (if pos
11686 (goto-char pos)
11687 (goto-char (point-max))
11688 (if (not (bolp)) (newline)))
11689 (when (looking-at org-outline-regexp)
11690 (setq level (funcall outline-level))
11691 (org-end-of-subtree t t))
11692 (org-back-over-empty-lines)
11694 (if pos (org-get-valid-level level 1) 1) ?*)
11696 (beginning-of-line 0)
11697 (list (concat (car parent-target) "/" child) file "" (point)))))))
11699 (defun org-olpath-completing-read (prompt collection &rest args)
11700 "Read an outline path like a file name."
11701 (let ((thetable collection)
11702 (org-completion-use-ido nil) ; does not work with ido.
11703 (org-completion-use-iswitchb nil)) ; or iswitchb
11704 (apply
11705 'org-icompleting-read prompt
11706 (lambda (string predicate &optional flag)
11707 (let (rtn r f (l (length string)))
11708 (cond
11709 ((eq flag nil)
11710 ;; try completion
11711 (try-completion string thetable))
11712 ((eq flag t)
11713 ;; all-completions
11714 (setq rtn (all-completions string thetable predicate))
11715 (mapcar
11716 (lambda (x)
11717 (setq r (substring x l))
11718 (if (string-match " ([^)]*)$" x)
11719 (setq f (match-string 0 x))
11720 (setq f ""))
11721 (if (string-match "/" r)
11722 (concat string (substring r 0 (match-end 0)) f)
11723 x))
11724 rtn))
11725 ((eq flag 'lambda)
11726 ;; exact match?
11727 (assoc string thetable)))))
11728 args)))
11730 ;;;; Dynamic blocks
11732 (defun org-find-dblock (name)
11733 "Find the first dynamic block with name NAME in the buffer.
11734 If not found, stay at current position and return nil."
11735 (let ((case-fold-search t) pos)
11736 (save-excursion
11737 (goto-char (point-min))
11738 (setq pos (and (re-search-forward
11740 (match-beginning 0))))
11741 (if pos (goto-char pos))
11742 pos))
11744 (defconst org-dblock-start-re
11746 "Matches the start line of a dynamic block, with parameters.")
11749 "Matches the end of a dynamic block.")
11751 (defun org-create-dblock (plist)
11752 "Create a dynamic block section, with parameters taken from PLIST.
11753 PLIST must contain a :name entry which is used as name of the block."
11755 (end-of-line 1)
11756 (newline))
11757 (let ((col (current-column))
11758 (name (plist-get plist :name)))
11759 (insert "#+BEGIN: " name)
11760 (while plist
11761 (if (eq (car plist) :name)
11762 (setq plist (cddr plist))
11763 (insert " " (prin1-to-string (pop plist)))))
11765 (beginning-of-line -2)))
11767 (defun org-prepare-dblock ()
11768 "Prepare dynamic block for refresh.
11769 This empties the block, puts the cursor at the insert position and returns
11770 the property list including an extra property :name with the block name."
11771 (unless (looking-at org-dblock-start-re)
11772 (error "Not at a dynamic block"))
11773 (let* ((begdel (1+ (match-end 0)))
11774 (name (org-no-properties (match-string 1)))
11775 (params (append (list :name name)
11776 (read (concat "(" (match-string 3) ")")))))
11777 (save-excursion
11778 (beginning-of-line 1)
11780 (setq params (plist-put params :indentation-column (current-column))))
11781 (unless (re-search-forward org-dblock-end-re nil t)
11782 (error "Dynamic block not terminated"))
11783 (setq params
11784 (append params
11785 (list :content (buffer-substring
11786 begdel (match-beginning 0)))))
11787 (delete-region begdel (match-beginning 0))
11788 (goto-char begdel)
11789 (open-line 1)
11790 params))
11792 (defun org-map-dblocks (&optional command)
11793 "Apply COMMAND to all dynamic blocks in the current buffer.
11794 If COMMAND is not given, use `org-update-dblock'."
11795 (let ((cmd (or command 'org-update-dblock)))
11796 (save-excursion
11797 (goto-char (point-min))
11798 (while (re-search-forward org-dblock-start-re nil t)
11799 (goto-char (match-beginning 0))
11800 (save-excursion
11801 (condition-case nil
11802 (funcall cmd)
11803 (error (message "Error during update of dynamic block"))))
11804 (unless (re-search-forward org-dblock-end-re nil t)
11805 (error "Dynamic block not terminated"))))))
11807 (defun org-dblock-update (&optional arg)
11808 "User command for updating dynamic blocks.
11809 Update the dynamic block at point. With prefix ARG, update all dynamic
11810 blocks in the buffer."
11811 (interactive "P")
11812 (if arg
11813 (org-update-all-dblocks)
11814 (or (looking-at org-dblock-start-re)
11815 (org-beginning-of-dblock))
11816 (org-update-dblock)))
11818 (defun org-update-dblock ()
11819 "Update the dynamic block at point.
11820 This means to empty the block, parse for parameters and then call
11821 the correct writing function."
11822 (interactive)
11823 (save-window-excursion
11824 (let* ((pos (point))
11825 (line (org-current-line))
11826 (params (org-prepare-dblock))
11827 (name (plist-get params :name))
11828 (indent (plist-get params :indentation-column))
11829 (cmd (intern (concat "org-dblock-write:" name))))
11830 (message "Updating dynamic block `%s' at line %d..." name line)
11831 (funcall cmd params)
11832 (message "Updating dynamic block `%s' at line %d...done" name line)
11833 (goto-char pos)
11834 (when (and indent (> indent 0))
11835 (setq indent (make-string indent ?\ ))
11836 (save-excursion
11837 (org-beginning-of-dblock)
11838 (forward-line 1)
11839 (while (not (looking-at org-dblock-end-re))
11840 (insert indent)
11841 (beginning-of-line 2))
11842 (when (looking-at org-dblock-end-re)
11844 (replace-match ""))
11845 (insert indent)))))))
11847 (defun org-beginning-of-dblock ()
11848 "Find the beginning of the dynamic block at point.
11849 Error if there is no such block at point."
11850 (let ((pos (point))
11851 beg)
11852 (end-of-line 1)
11853 (if (and (re-search-backward org-dblock-start-re nil t)
11854 (setq beg (match-beginning 0))
11855 (re-search-forward org-dblock-end-re nil t)
11856 (> (match-end 0) pos))
11857 (goto-char beg)
11858 (goto-char pos)
11859 (error "Not in a dynamic block"))))
11861 (defun org-update-all-dblocks ()
11862 "Update all dynamic blocks in the buffer.
11863 This function can be used in a hook."
11864 (interactive)
11865 (when (derived-mode-p 'org-mode)
11866 (org-map-dblocks 'org-update-dblock)))
11869 ;;;; Completion
11871 (defun org-get-export-keywords ()
11872 "Return a list of all currently understood export keywords.
11873 Export keywords include options, block names, attributes and
11874 keywords relative to each registered export back-end."
11875 (delq nil
11876 (let (keywords)
11877 (mapc
11878 (lambda (back-end)
11879 (let ((props (cdr back-end)))
11880 ;; Back-end name (for keywords, like #+LATEX:)
11881 (push (upcase (symbol-name (car back-end))) keywords)
11882 ;; Back-end options.
11883 (mapc (lambda (option) (push (cadr option) keywords))
11884 (plist-get (cdr back-end) :options-alist))))
11885 (org-bound-and-true-p org-export-registered-backends))
11886 keywords)))
11888 (defconst org-options-keywords
11889 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11890 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11891 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11892 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11893 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11895 (defcustom org-structure-template-alist
11910 ("L" "#+LaTeX: "
11914 ("H" "#+HTML: "
11917 ("A" "#+ASCII: ")
11918 ("i" "#+INDEX: ?"
11919 "#+INDEX: ?")
11920 ("I" "#+INCLUDE: %file ?"
11922 "Structure completion elements.
11923 This is a list of abbreviation keys and values. The value gets inserted
11924 if you type `<' followed by the key and then press the completion key,
11925 usually `M-TAB'. %file will be replaced by a file name after prompting
11926 for the file using completion. The cursor will be placed at the position
11927 of the `?` in the template.
11928 There are two templates for each key, the first uses the original Org syntax,
11929 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11930 the default when the /org-mtags.el/ module has been loaded. See also the
11931 variable `org-mtags-prefer-muse-templates'."
11932 :group 'org-completion
11933 :type '(repeat
11934 (string :tag "Key")
11935 (string :tag "Template")
11936 (string :tag "Muse Template")))
11938 (defun org-try-structure-completion ()
11939 "Try to complete a structure template before point.
11941 expands them."
11942 (let ((l (buffer-substring (point-at-bol) (point)))
11943 a)
11946 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11947 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11948 (match-beginning 1)) a)
11949 t)))
11951 (defun org-complete-expand-structure-template (start cell)
11952 "Expand a structure template."
11953 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11954 (rpl (nth (if musep 2 1) cell))
11955 (ind ""))
11956 (delete-region start (point))
11958 (cond
11959 ((bolp))
11961 (setq ind (buffer-substring (point-at-bol) (point))))
11962 (t (newline))))
11963 (setq start (point))
11964 (if (string-match "%file" rpl)
11965 (setq rpl (replace-match
11966 (concat
11968 (save-match-data
11969 (abbreviate-file-name (read-file-name "Include file: ")))
11971 t t rpl)))
11974 (insert rpl)
11977 ;;;; TODO, DEADLINE, Comments
11979 (defun org-toggle-comment ()
11980 "Change the COMMENT state of an entry."
11981 (interactive)
11982 (save-excursion
11983 (org-back-to-heading)
11984 (let (case-fold-search)
11985 (cond
11986 ((looking-at (format org-heading-keyword-regexp-format
11987 org-comment-string))
11988 (goto-char (match-end 1))
11989 (looking-at (concat " +" org-comment-string))
11990 (replace-match "" t t)
11991 (when (eolp) (insert " ")))
11992 ((looking-at org-outline-regexp)
11993 (goto-char (match-end 0))
11994 (insert org-comment-string " "))))))
11996 (defvar org-last-todo-state-is-todo nil
11997 "This is non-nil when the last TODO state change led to a TODO state.
11998 If the last change removed the TODO tag or switched to DONE, then
11999 this is nil.")
12001 (defvar org-setting-tags nil) ; dynamically skipped
12003 (defvar org-todo-setup-filter-hook nil
12004 "Hook for functions that pre-filter todo specs.
12005 Each function takes a todo spec and returns either nil or the spec
12006 transformed into canonical form." )
12008 (defvar org-todo-get-default-hook nil
12009 "Hook for functions that get a default item for todo.
12010 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12011 nil or a string to be used for the todo mark." )
12013 (defvar org-agenda-headline-snapshot-before-repeat)
12015 (defun org-current-effective-time ()
12016 "Return current time adjusted for `org-extend-today-until' variable."
12017 (let* ((ct (org-current-time))
12018 (dct (decode-time ct))
12019 (ct1
12020 (cond
12021 (org-use-last-clock-out-time-as-effective-time
12022 (or (org-clock-get-last-clock-out-time) ct))
12023 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12024 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12025 (t ct))))
12026 ct1))
12028 (defun org-todo-yesterday (&optional arg)
12029 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12030 (interactive "P")
12031 (if (eq major-mode 'org-agenda-mode)
12032 (apply 'org-agenda-todo-yesterday arg)
12033 (let* ((hour (third (decode-time
12034 (org-current-time))))
12035 (org-extend-today-until (1+ hour)))
12036 (org-todo arg))))
12038 (defvar org-block-entry-blocking ""
12039 "First entry preventing the TODO state change.")
12041 (defun org-todo (&optional arg)
12042 "Change the TODO state of an item.
12043 The state of an item is given by a keyword at the start of the heading,
12044 like
12045 *** TODO Write paper
12046 *** DONE Call mom
12048 The different keywords are specified in the variable `org-todo-keywords'.
12050 So for this example: when the item starts with TODO, it is changed to DONE.
12051 When it starts with DONE, the DONE is removed. And when neither TODO nor
12052 DONE are present, add TODO at the beginning of the heading.
12055 state.
12056 With numeric prefix arg, switch to that state.
12058 keywords (nextset).
12060 With a numeric prefix arg of 0, inhibit note taking for the change.
12062 For calling through lisp, arg is also interpreted in the following way:
12063 'none -> empty state
12065 'done -> switch to DONE
12066 'nextset -> switch to the next set of keywords
12067 'previousset -> switch to the previous set of keywords
12069 really is a member of `org-todo-keywords'."
12070 (interactive "P")
12071 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12072 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12073 'region-start-level 'region))
12074 org-loop-over-headlines-in-active-region)
12075 (org-map-entries
12076 `(org-todo ,arg)
12077 org-loop-over-headlines-in-active-region
12078 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12079 (if (equal arg '(16)) (setq arg 'nextset))
12080 (let ((org-blocker-hook org-blocker-hook)
12081 commentp
12082 case-fold-search)
12083 (when (equal arg '(64))
12084 (setq arg nil org-blocker-hook nil))
12085 (when (and org-blocker-hook
12086 (or org-inhibit-blocking
12087 (org-entry-get nil "NOBLOCKING")))
12088 (setq org-blocker-hook nil))
12089 (save-excursion
12090 (catch 'exit
12091 (org-back-to-heading t)
12093 (org-toggle-comment)
12094 (setq commentp t))
12095 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12098 (let* ((match-data (match-data))
12099 (startpos (point-at-bol))
12100 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12101 (org-log-done org-log-done)
12102 (org-log-repeat org-log-repeat)
12103 (org-todo-log-states org-todo-log-states)
12104 (org-inhibit-logging
12105 (if (equal arg 0)
12106 (progn (setq arg nil) 'note) org-inhibit-logging))
12107 (this (match-string 1))
12108 (hl-pos (match-beginning 0))
12109 (head (org-get-todo-sequence-head this))
12110 (ass (assoc head org-todo-kwd-alist))
12111 (interpret (nth 1 ass))
12112 (done-word (nth 3 ass))
12113 (final-done-word (nth 4 ass))
12114 (org-last-state (or this ""))
12115 (completion-ignore-case t)
12116 (member (member this org-todo-keywords-1))
12117 (tail (cdr member))
12118 (org-state (cond
12119 ((and org-todo-key-trigger
12120 (or (and (equal arg '(4))
12121 (eq org-use-fast-todo-selection 'prefix))
12122 (and (not arg) org-use-fast-todo-selection
12123 (not (eq org-use-fast-todo-selection
12124 'prefix)))))
12125 ;; Use fast selection
12126 (org-fast-todo-selection))
12127 ((and (equal arg '(4))
12128 (or (not org-use-fast-todo-selection)
12129 (not org-todo-key-trigger)))
12130 ;; Read a state with completion
12131 (org-icompleting-read
12132 "State: " (mapcar 'list org-todo-keywords-1)
12133 nil t))
12134 ((eq arg 'right)
12135 (if this
12136 (if tail (car tail) nil)
12137 (car org-todo-keywords-1)))
12138 ((eq arg 'left)
12139 (if (equal member org-todo-keywords-1)
12140 nil
12141 (if this
12142 (nth (- (length org-todo-keywords-1)
12143 (length tail) 2)
12144 org-todo-keywords-1)
12145 (org-last org-todo-keywords-1))))
12146 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12147 (setq arg nil))) ; hack to fall back to cycling
12148 (arg
12149 ;; user or caller requests a specific state
12150 (cond
12151 ((equal arg "") nil)
12152 ((eq arg 'none) nil)
12153 ((eq arg 'done) (or done-word (car org-done-keywords)))
12154 ((eq arg 'nextset)
12155 (or (car (cdr (member head org-todo-heads)))
12156 (car org-todo-heads)))
12157 ((eq arg 'previousset)
12158 (let ((org-todo-heads (reverse org-todo-heads)))
12159 (or (car (cdr (member head org-todo-heads)))
12160 (car org-todo-heads))))
12161 ((car (member arg org-todo-keywords-1)))
12162 ((stringp arg)
12163 (error "State `%s' not valid in this file" arg))
12164 ((nth (1- (prefix-numeric-value arg))
12165 org-todo-keywords-1))))
12166 ((null member) (or head (car org-todo-keywords-1)))
12167 ((equal this final-done-word) nil) ;; -> make empty
12168 ((null tail) nil) ;; -> first entry
12169 ((memq interpret '(type priority))
12170 (if (eq this-command last-command)
12171 (car tail)
12172 (if (> (length tail) 0)
12173 (or done-word (car org-done-keywords))
12174 nil)))
12175 (t
12176 (car tail))))
12177 (org-state (or
12178 (run-hook-with-args-until-success
12179 'org-todo-get-default-hook org-state org-last-state)
12180 org-state))
12181 (next (if org-state (concat " " org-state " ") " "))
12182 (change-plist (list :type 'todo-state-change :from this :to org-state
12183 :position startpos))
12184 dolog now-done-p)
12185 (when org-blocker-hook
12186 (setq org-last-todo-state-is-todo
12187 (not (member this org-done-keywords)))
12188 (unless (save-excursion
12189 (save-match-data
12190 (org-with-wide-buffer
12191 (run-hook-with-args-until-failure
12192 'org-blocker-hook change-plist))))
12193 (if (org-called-interactively-p 'interactive)
12195 this org-state org-block-entry-blocking)
12196 ;; fail silently
12198 this org-state org-block-entry-blocking)
12199 (throw 'exit nil))))
12200 (store-match-data match-data)
12201 (replace-match next t t)
12202 (unless (pos-visible-in-window-p hl-pos)
12203 (message "TODO state changed to %s" (org-trim next)))
12204 (unless head
12205 (setq head (org-get-todo-sequence-head org-state)
12206 ass (assoc head org-todo-kwd-alist)
12207 interpret (nth 1 ass)
12208 done-word (nth 3 ass)
12209 final-done-word (nth 4 ass)))
12210 (when (memq arg '(nextset previousset))
12211 (message "Keyword-Set %d/%d: %s"
12212 (- (length org-todo-sets) -1
12213 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12214 (length org-todo-sets)
12215 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12216 (setq org-last-todo-state-is-todo
12217 (not (member org-state org-done-keywords)))
12218 (setq now-done-p (and (member org-state org-done-keywords)
12219 (not (member this org-done-keywords))))
12220 (and logging (org-local-logging logging))
12221 (when (and (or org-todo-log-states org-log-done)
12222 (not (eq org-inhibit-logging t))
12223 (not (memq arg '(nextset previousset))))
12224 ;; we need to look at recording a time and note
12225 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12226 (nth 2 (assoc this org-todo-log-states))))
12227 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12228 (setq dolog 'time))
12229 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12230 (and org-state
12231 (member org-state org-not-done-keywords)
12232 (not (member this org-not-done-keywords))))
12233 ;; This is now a todo state and was not one before
12234 ;; If there was a CLOSED time stamp, get rid of it.
12235 (org-add-planning-info nil nil 'closed))
12236 (when (and now-done-p org-log-done)
12237 ;; It is now done, and it was not done before
12238 (org-add-planning-info 'closed (org-current-effective-time))
12239 (if (and (not dolog) (eq 'note org-log-done))
12240 (org-add-log-setup 'done org-state this 'findpos 'note)))
12241 (when (and org-state dolog)
12242 ;; This is a non-nil state, and we need to log it
12243 (org-add-log-setup 'state org-state this 'findpos dolog)))
12244 ;; Fixup tag positioning
12245 (org-todo-trigger-tag-changes org-state)
12246 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12247 (when org-provide-todo-statistics
12248 (org-update-parent-todo-statistics))
12249 (run-hooks 'org-after-todo-state-change-hook)
12250 (if (and arg (not (member org-state org-done-keywords)))
12251 (setq head (org-get-todo-sequence-head org-state)))
12252 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12253 ;; Do we need to trigger a repeat?
12254 (when now-done-p
12255 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12256 ;; This is for the agenda, take a snapshot of the headline.
12257 (save-match-data
12258 (setq org-agenda-headline-snapshot-before-repeat
12259 (org-get-heading))))
12260 (org-auto-repeat-maybe org-state))
12261 ;; Fixup cursor location if close to the keyword
12262 (if (and (outline-on-heading-p)
12263 (not (bolp))
12264 (save-excursion (beginning-of-line 1)
12265 (looking-at org-todo-line-regexp))
12266 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12267 (progn
12268 (goto-char (or (match-end 2) (match-end 1)))
12269 (and (looking-at " ") (just-one-space))))
12270 (when org-trigger-hook
12271 (save-excursion
12272 (run-hook-with-args 'org-trigger-hook change-plist)))
12273 (when commentp (org-toggle-comment))))))))
12275 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12276 "Block turning an entry into a TODO, using the hierarchy.
12277 This checks whether the current task should be blocked from state
12278 changes. Such blocking occurs when:
12280 1. The task has children which are not all in a completed state.
12282 2. A task has a parent with the property :ORDERED:, and there
12283 are siblings prior to the current task with incomplete
12284 status.
12286 3. The parent of the task is blocked because it has siblings that should
12287 be done first, or is child of a block grandparent TODO entry."
12289 (if (not org-enforce-todo-dependencies)
12290 t ; if locally turned off don't block
12291 (catch 'dont-block
12292 ;; If this is not a todo state change, or if this entry is already DONE,
12293 ;; do not block
12294 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12295 (member (plist-get change-plist :from)
12296 (cons 'done org-done-keywords))
12297 (member (plist-get change-plist :to)
12298 (cons 'todo org-not-done-keywords))
12299 (not (plist-get change-plist :to)))
12300 (throw 'dont-block t))
12301 ;; If this task has children, and any are undone, it's blocked
12302 (save-excursion
12303 (org-back-to-heading t)
12304 (let ((this-level (funcall outline-level)))
12305 (outline-next-heading)
12306 (let ((child-level (funcall outline-level)))
12307 (while (and (not (eobp))
12308 (> child-level this-level))
12309 ;; this todo has children, check whether they are all
12310 ;; completed
12311 (if (and (not (org-entry-is-done-p))
12312 (org-entry-is-todo-p))
12313 (progn (setq org-block-entry-blocking (org-get-heading))
12314 (throw 'dont-block nil)))
12315 (outline-next-heading)
12316 (setq child-level (funcall outline-level))))))
12317 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12318 ;; any previous siblings are undone, it's blocked
12319 (save-excursion
12320 (org-back-to-heading t)
12321 (let* ((pos (point))
12322 (parent-pos (and (org-up-heading-safe) (point))))
12323 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12324 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12325 (forward-line 1)
12326 (re-search-forward org-not-done-heading-regexp pos t))
12327 (setq org-block-entry-blocking (match-string 0))
12328 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12329 ;; Search further up the hierarchy, to see if an ancestor is blocked
12330 (while t
12331 (goto-char parent-pos)
12332 (if (not (looking-at org-not-done-heading-regexp))
12333 (throw 'dont-block t)) ; do not block, parent is not a TODO
12334 (setq pos (point))
12335 (setq parent-pos (and (org-up-heading-safe) (point)))
12336 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12337 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12338 (forward-line 1)
12339 (re-search-forward org-not-done-heading-regexp pos t)
12340 (setq org-block-entry-blocking (org-get-heading)))
12341 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12343 (defcustom org-track-ordered-property-with-tag nil
12344 "Should the ORDERED property also be shown as a tag?
12345 The ORDERED property decides if an entry should require subtasks to be
12346 completed in sequence. Since a property is not very visible, setting
12347 this option means that toggling the ORDERED property with the command
12348 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12349 not relevant for the behavior, but it makes things more visible.
12351 Note that toggling the tag with tags commands will not change the property
12352 and therefore not influence behavior!
12354 This can be t, meaning the tag ORDERED should be used, It can also be a
12355 string to select a different tag for this task."
12356 :group 'org-todo
12357 :type '(choice
12358 (const :tag "No tracking" nil)
12359 (const :tag "Track with ORDERED tag" t)
12360 (string :tag "Use other tag")))
12362 (defun org-toggle-ordered-property ()
12363 "Toggle the ORDERED property of the current entry.
12364 For better visibility, you can track the value of this property with a tag.
12365 See variable `org-track-ordered-property-with-tag'."
12366 (interactive)
12367 (let* ((t1 org-track-ordered-property-with-tag)
12368 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12369 (save-excursion
12370 (org-back-to-heading)
12371 (if (org-entry-get nil "ORDERED")
12372 (progn
12373 (org-delete-property "ORDERED" "PROPERTIES")
12374 (and tag (org-toggle-tag tag 'off))
12375 (message "Subtasks can be completed in arbitrary order"))
12376 (org-entry-put nil "ORDERED" "t")
12377 (and tag (org-toggle-tag tag 'on))
12378 (message "Subtasks must be completed in sequence")))))
12380 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12381 (defun org-block-todo-from-checkboxes (change-plist)
12382 "Block turning an entry into a TODO, using checkboxes.
12383 This checks whether the current task should be blocked from state
12384 changes because there are unchecked boxes in this entry."
12385 (if (not org-enforce-todo-checkbox-dependencies)
12386 t ; if locally turned off don't block
12387 (catch 'dont-block
12388 ;; If this is not a todo state change, or if this entry is already DONE,
12389 ;; do not block
12390 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12391 (member (plist-get change-plist :from)
12392 (cons 'done org-done-keywords))
12393 (member (plist-get change-plist :to)
12394 (cons 'todo org-not-done-keywords))
12395 (not (plist-get change-plist :to)))
12396 (throw 'dont-block t))
12397 ;; If this task has checkboxes that are not checked, it's blocked
12398 (save-excursion
12399 (org-back-to-heading t)
12400 (let ((beg (point)) end)
12401 (outline-next-heading)
12402 (setq end (point))
12403 (goto-char beg)
12404 (if (org-list-search-forward
12405 (concat (org-item-beginning-re)
12408 end t)
12409 (progn
12410 (if (boundp 'org-blocked-by-checkboxes)
12411 (setq org-blocked-by-checkboxes t))
12412 (throw 'dont-block nil)))))
12413 t))) ; do not block
12415 (defun org-entry-blocked-p ()
12416 "Is the current entry blocked?"
12417 (org-with-silent-modifications
12418 (if (org-entry-get nil "NOBLOCKING")
12419 nil ;; Never block this entry
12420 (not (run-hook-with-args-until-failure
12421 'org-blocker-hook
12422 (list :type 'todo-state-change
12423 :position (point)
12424 :from 'todo
12425 :to 'done))))))
12427 (defun org-update-statistics-cookies (all)
12428 "Update the statistics cookie, either from TODO or from checkboxes.
12429 This should be called with the cursor in a line with a statistics cookie."
12430 (interactive "P")
12431 (if all
12432 (progn
12433 (org-update-checkbox-count 'all)
12434 (org-map-entries 'org-update-parent-todo-statistics))
12435 (if (not (org-at-heading-p))
12436 (org-update-checkbox-count)
12437 (let ((pos (point-marker))
12438 end l1 l2)
12439 (ignore-errors (org-back-to-heading t))
12440 (if (not (org-at-heading-p))
12441 (org-update-checkbox-count)
12442 (setq l1 (org-outline-level))
12443 (setq end (save-excursion
12444 (outline-next-heading)
12445 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12446 (point)))
12447 (if (and (save-excursion
12448 (re-search-forward
12450 (not (save-excursion (re-search-forward
12452 (org-update-checkbox-count)
12453 (if (and l2 (> l2 l1))
12454 (progn
12455 (goto-char end)
12456 (org-update-parent-todo-statistics))
12457 (goto-char pos)
12458 (beginning-of-line 1)
12459 (while (re-search-forward
12461 (point-at-eol) t)
12462 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12463 (goto-char pos)
12464 (move-marker pos nil)))))
12466 (defvar org-entry-property-inherited-from) ;; defined below
12467 (defun org-update-parent-todo-statistics ()
12468 "Update any statistics cookie in the parent of the current headline.
12469 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12470 the entire subtree and this will travel up the hierarchy and update
12471 statistics everywhere."
12472 (let* ((prop (save-excursion (org-up-heading-safe)
12473 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12474 (recursive (or (not org-hierarchical-todo-statistics)
12476 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12477 0))
12478 (first t)
12480 level ltoggle l1 new ndel
12481 (cnt-all 0) (cnt-done 0) is-percent kwd
12482 checkbox-beg ov ovs ove cookie-present)
12483 (catch 'exit
12484 (save-excursion
12485 (beginning-of-line 1)
12486 (setq ltoggle (funcall outline-level))
12487 ;; Three situations are to consider:
12489 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12490 ;; to the top-level ancestor on the headline;
12492 ;; 2. If parent has "recursive" property, repeat up to the
12493 ;; headline setting that property, taking inheritance into
12494 ;; account;
12496 ;; 3. Else, move up to direct parent and proceed only once.
12497 (while (and (setq level (org-up-heading-safe))
12498 (or recursive first)
12499 (>= (point) lim))
12500 (setq first nil cookie-present nil)
12501 (unless (and level
12502 (not (string-match
12504 (downcase (or (org-entry-get nil "COOKIE_DATA")
12505 "")))))
12506 (throw 'exit nil))
12507 (while (re-search-forward box-re (point-at-eol) t)
12508 (setq cnt-all 0 cnt-done 0 cookie-present t)
12509 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12510 (save-match-data
12511 (unless (outline-next-heading) (throw 'exit nil))
12512 (while (and (looking-at org-complex-heading-regexp)
12513 (> (setq l1 (length (match-string 1))) level))
12514 (setq kwd (and (or recursive (= l1 ltoggle))
12515 (match-string 2)))
12516 (if (or (eq org-provide-todo-statistics 'all-headlines)
12517 (and (listp org-provide-todo-statistics)
12518 (or (member kwd org-provide-todo-statistics)
12519 (member kwd org-done-keywords))))
12520 (setq cnt-all (1+ cnt-all))
12521 (if (eq org-provide-todo-statistics t)
12522 (and kwd (setq cnt-all (1+ cnt-all)))))
12523 (and (member kwd org-done-keywords)
12524 (setq cnt-done (1+ cnt-done)))
12525 (outline-next-heading)))
12526 (setq new
12527 (if is-percent
12528 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12529 (format "[%d/%d]" cnt-done cnt-all))
12530 ndel (- (match-end 0) checkbox-beg))
12531 ;; handle overlays when updating cookie from column view
12532 (when (setq ov (car (overlays-at checkbox-beg)))
12533 (setq ovs (overlay-start ov) ove (overlay-end ov))
12534 (delete-overlay ov))
12535 (goto-char checkbox-beg)
12536 (insert new)
12537 (delete-region (point) (+ (point) ndel))
12538 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12539 (when ov (move-overlay ov ovs ove)))
12540 (when cookie-present
12541 (run-hook-with-args 'org-after-todo-statistics-hook
12542 cnt-done (- cnt-all cnt-done))))))
12543 (run-hooks 'org-todo-statistics-hook)))
12545 (defvar org-after-todo-statistics-hook nil
12546 "Hook that is called after a TODO statistics cookie has been updated.
12547 Each function is called with two arguments: the number of not-done entries
12548 and the number of done entries.
12550 For example, the following function, when added to this hook, will switch
12551 an entry to DONE when all children are done, and back to TODO when new
12552 entries are set to a TODO status. Note that this hook is only called
12553 when there is a statistics cookie in the headline!
12555 (defun org-summary-todo (n-done n-not-done)
12557 (let (org-log-done org-log-states) ; turn off logging
12559 ")
12561 (defvar org-todo-statistics-hook nil
12562 "Hook that is run whenever Org thinks TODO statistics should be updated.
12563 This hook runs even if there is no statistics cookie present, in which case
12564 `org-after-todo-statistics-hook' would not run.")
12566 (defun org-todo-trigger-tag-changes (state)
12567 "Apply the changes defined in `org-todo-state-tags-triggers'."
12568 (let ((l org-todo-state-tags-triggers)
12569 changes)
12570 (when (or (not state) (equal state ""))
12571 (setq changes (append changes (cdr (assoc "" l)))))
12572 (when (and (stringp state) (> (length state) 0))
12573 (setq changes (append changes (cdr (assoc state l)))))
12574 (when (member state org-not-done-keywords)
12575 (setq changes (append changes (cdr (assoc 'todo l)))))
12576 (when (member state org-done-keywords)
12577 (setq changes (append changes (cdr (assoc 'done l)))))
12578 (dolist (c changes)
12579 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12581 (defun org-local-logging (value)
12582 "Get logging settings from a property VALUE."
12583 (let* (words w a)
12584 ;; directly set the variables, they are already local.
12585 (setq org-log-done nil
12586 org-log-repeat nil
12587 org-todo-log-states nil)
12588 (setq words (org-split-string value))
12589 (while (setq w (pop words))
12590 (cond
12591 ((setq a (assoc w org-startup-options))
12592 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12593 (set (nth 1 a) (nth 2 a))))
12594 ((setq a (org-extract-log-state-settings w))
12595 (and (member (car a) org-todo-keywords-1)
12596 (push a org-todo-log-states)))))))
12598 (defun org-get-todo-sequence-head (kwd)
12599 "Return the head of the TODO sequence to which KWD belongs.
12600 If KWD is not set, check if there is a text property remembering the
12601 right sequence."
12602 (let (p)
12603 (cond
12604 ((not kwd)
12605 (or (get-text-property (point-at-bol) 'org-todo-head)
12606 (progn
12607 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12608 nil (point-at-eol)))
12609 (get-text-property p 'org-todo-head))))
12610 ((not (member kwd org-todo-keywords-1))
12611 (car org-todo-keywords-1))
12612 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12614 (defun org-fast-todo-selection ()
12615 "Fast TODO keyword selection with single keys.
12616 Returns the new TODO keyword, or nil if no state change should occur."
12617 (let* ((fulltable org-todo-key-alist)
12618 (done-keywords org-done-keywords) ;; needed for the faces.
12619 (maxlen (apply 'max (mapcar
12620 (lambda (x)
12621 (if (stringp (car x)) (string-width (car x)) 0))
12622 fulltable)))
12623 (expert nil)
12624 (fwidth (+ maxlen 3 1 3))
12625 (ncol (/ (- (window-width) 4) fwidth))
12626 tg cnt e c tbl
12627 groups ingroup)
12628 (save-excursion
12629 (save-window-excursion
12630 (if expert
12631 (set-buffer (get-buffer-create " *Org todo*"))
12632 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12633 (erase-buffer)
12634 (org-set-local 'org-done-keywords done-keywords)
12635 (setq tbl fulltable cnt 0)
12636 (while (setq e (pop tbl))
12637 (cond
12638 ((equal e '(:startgroup))
12639 (push '() groups) (setq ingroup t)
12640 (when (not (= cnt 0))
12641 (setq cnt 0)
12643 (insert "{ "))
12644 ((equal e '(:endgroup))
12645 (setq ingroup nil cnt 0)
12647 ((equal e '(:newline))
12648 (when (not (= cnt 0))
12649 (setq cnt 0)
12651 (setq e (car tbl))
12652 (while (equal (car tbl) '(:newline))
12654 (setq tbl (cdr tbl)))))
12655 (t
12656 (setq tg (car e) c (cdr e))
12657 (if ingroup (push tg (car groups)))
12658 (setq tg (org-add-props tg nil 'face
12659 (org-get-todo-face tg)))
12660 (if (and (= cnt 0) (not ingroup)) (insert " "))
12661 (insert "[" c "] " tg (make-string
12662 (- fwidth 4 (length tg)) ?\ ))
12663 (when (= (setq cnt (1+ cnt)) ncol)
12665 (if ingroup (insert " "))
12666 (setq cnt 0)))))
12668 (goto-char (point-min))
12669 (if (not expert) (org-fit-window-to-buffer))
12670 (message "[a-z..]:Set [SPC]:clear")
12671 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12672 (cond
12673 ((or (= c ?\C-g)
12674 (and (= c ?q) (not (rassoc c fulltable))))
12675 (setq quit-flag t))
12676 ((= c ?\ ) nil)
12677 ((setq e (rassoc c fulltable) tg (car e))
12678 tg)
12679 (t (setq quit-flag t)))))))
12681 (defun org-entry-is-todo-p ()
12682 (member (org-get-todo-state) org-not-done-keywords))
12684 (defun org-entry-is-done-p ()
12685 (member (org-get-todo-state) org-done-keywords))
12687 (defun org-get-todo-state ()
12688 "Return the TODO keyword of the current subtree."
12689 (save-excursion
12690 (org-back-to-heading t)
12691 (and (looking-at org-todo-line-regexp)
12692 (match-end 2)
12693 (match-string 2))))
12695 (defun org-at-date-range-p (&optional inactive-ok)
12696 "Is the cursor inside a date range?"
12697 (interactive)
12698 (save-excursion
12699 (catch 'exit
12700 (let ((pos (point)))
12702 (skip-chars-backward "<[")
12703 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12704 (>= (match-end 0) pos)
12705 (throw 'exit t))
12707 (skip-chars-backward "<[")
12708 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12709 (>= (match-end 0) pos)
12710 (throw 'exit t)))
12711 nil)))
12713 (defun org-get-repeat (&optional tagline)
12714 "Check if there is a deadline/schedule with repeater in this entry."
12715 (save-match-data
12716 (save-excursion
12717 (org-back-to-heading t)
12718 (and (re-search-forward (if tagline
12720 org-repeat-re)
12721 (org-entry-end-position) t)
12722 (match-string-no-properties 1)))))
12724 (defvar org-last-changed-timestamp)
12725 (defvar org-last-inserted-timestamp)
12726 (defvar org-log-post-message)
12727 (defvar org-log-note-purpose)
12728 (defvar org-log-note-how)
12729 (defvar org-log-note-extra)
12730 (defun org-auto-repeat-maybe (done-word)
12731 "Check if the current headline contains a repeated deadline/schedule.
12732 If yes, set TODO state back to what it was and change the base date
12733 of repeating deadline/scheduled time stamps to new date.
12734 This function is run automatically after each state change to a DONE state."
12735 ;; last-state is dynamically scoped into this function
12736 (let* ((repeat (org-get-repeat))
12737 (aa (assoc org-last-state org-todo-kwd-alist))
12738 (interpret (nth 1 aa))
12739 (head (nth 2 aa))
12740 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12741 (msg "Entry repeats: ")
12742 (org-log-done nil)
12743 (org-todo-log-states nil)
12744 re type n what ts time to-state)
12745 (when repeat
12746 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12747 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12748 org-todo-repeat-to-state))
12749 (unless (and to-state (member to-state org-todo-keywords-1))
12750 (setq to-state (if (eq interpret 'type) org-last-state head)))
12751 (org-todo to-state)
12752 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12753 (org-entry-put nil "LAST_REPEAT" (format-time-string
12754 (org-time-stamp-format t t))))
12755 (when org-log-repeat
12756 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12757 (memq 'org-add-log-note post-command-hook))
12758 ;; OK, we are already setup for some record
12759 (if (eq org-log-repeat 'note)
12760 ;; make sure we take a note, not only a time stamp
12761 (setq org-log-note-how 'note))
12762 ;; Set up for taking a record
12763 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12764 org-last-state
12765 'findpos org-log-repeat)))
12766 (org-back-to-heading t)
12767 (org-add-planning-info nil nil 'closed)
12771 (while (re-search-forward
12772 re (save-excursion (outline-next-heading) (point)) t)
12773 (setq type (if (match-end 1) org-scheduled-string
12774 (if (match-end 3) org-deadline-string "Plain:"))
12775 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12777 (setq n (string-to-number (match-string 2 ts))
12778 what (match-string 3 ts))
12779 (if (equal what "w") (setq n (* n 7) what "d"))
12781 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12782 ;; Preparation, see if we need to modify the start date for the change
12783 (when (match-end 1)
12784 (setq time (save-match-data (org-time-string-to-time ts)))
12785 (cond
12786 ((equal (match-string 1 ts) ".")
12787 ;; Shift starting date to today
12788 (org-timestamp-change
12789 (- (org-today) (time-to-days time))
12790 'day))
12791 ((equal (match-string 1 ts) "+")
12792 (let ((nshiftmax 10) (nshift 0))
12793 (while (or (= nshift 0)
12794 (<= (time-to-days time)
12795 (time-to-days (current-time))))
12796 (when (= (incf nshift) nshiftmax)
12797 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12798 (error "Abort")))
12799 (org-timestamp-change n (cdr (assoc what whata)))
12800 (org-at-timestamp-p t)
12801 (setq ts (match-string 1))
12802 (setq time (save-match-data (org-time-string-to-time ts)))))
12803 (org-timestamp-change (- n) (cdr (assoc what whata)))
12804 ;; rematch, so that we have everything in place for the real shift
12805 (org-at-timestamp-p t)
12806 (setq ts (match-string 1))
12808 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12809 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12810 (setq org-log-post-message msg)
12811 (message "%s" msg))))
12813 (defun org-show-todo-tree (arg)
12814 "Make a compact tree which shows all headlines marked with TODO.
12815 The tree will show the lines where the regexp matches, and all higher
12816 headlines above the match.
12818 With a numeric prefix N, construct a sparse tree for the Nth element
12819 of `org-todo-keywords-1'."
12820 (interactive "P")
12821 (let ((case-fold-search nil)
12822 (kwd-re
12823 (cond ((null arg) org-not-done-regexp)
12824 ((equal arg '(4))
12825 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12826 (mapcar 'list org-todo-keywords-1))))
12830 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12831 (regexp-quote (nth (1- (prefix-numeric-value arg))
12832 org-todo-keywords-1)))
12833 (t (error "Invalid prefix argument: %s" arg)))))
12834 (message "%d TODO entries found"
12835 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12837 (defun org-deadline (arg &optional time)
12839 With one universal prefix argument, remove any deadline from the item.
12840 With two universal prefix arguments, prompt for a warning delay.
12841 With argument TIME, set the deadline at the corresponding date. TIME
12843 (interactive "P")
12844 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12845 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12846 'region-start-level 'region))
12847 org-loop-over-headlines-in-active-region)
12848 (org-map-entries
12849 `(org-deadline ',arg ,time)
12850 org-loop-over-headlines-in-active-region
12851 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12852 (let* ((old-date (org-entry-get nil "DEADLINE"))
12853 (old-date-time (if old-date (org-time-string-to-time old-date)))
12854 (repeater (and old-date
12855 (string-match
12857 old-date)
12858 (match-string 1 old-date))))
12859 (cond
12860 ((equal arg '(4))
12861 (when (and old-date org-log-redeadline)
12862 (org-add-log-setup 'deldeadline nil old-date 'findpos
12863 org-log-redeadline))
12864 (org-remove-timestamp-with-keyword org-deadline-string)
12865 (message "Item no longer has a deadline."))
12866 ((equal arg '(16))
12867 (save-excursion
12868 (if (re-search-forward
12869 org-deadline-time-regexp
12870 (save-excursion (outline-next-heading) (point)) t)
12871 (let* ((rpl0 (match-string 1))
12872 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12873 (replace-match
12874 (concat org-deadline-string
12875 " <" rpl
12876 (format " -%dd"
12877 (abs
12878 (- (time-to-days
12879 (save-match-data
12880 (org-read-date nil t nil "Warn starting from" old-date-time)))
12881 (time-to-days old-date-time))))
12882 ">") t t))
12883 (user-error "No deadline information to update"))))
12884 (t
12885 (org-add-planning-info 'deadline time 'closed)
12886 (when (and old-date org-log-redeadline
12887 (not (equal old-date
12888 (substring org-last-inserted-timestamp 1 -1))))
12889 (org-add-log-setup 'redeadline nil old-date 'findpos
12890 org-log-redeadline))
12891 (when repeater
12892 (save-excursion
12893 (org-back-to-heading t)
12894 (when (re-search-forward (concat org-deadline-string " "
12895 org-last-inserted-timestamp)
12896 (save-excursion
12897 (outline-next-heading) (point)) t)
12898 (goto-char (1- (match-end 0)))
12899 (insert " " repeater)
12900 (setq org-last-inserted-timestamp
12901 (concat (substring org-last-inserted-timestamp 0 -1)
12902 " " repeater
12903 (substring org-last-inserted-timestamp -1))))))
12904 (message "Deadline on %s" org-last-inserted-timestamp))))))
12906 (defun org-schedule (arg &optional time)
12907 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12908 With one universal prefix argument, remove any scheduling date from the item.
12909 With two universal prefix arguments, prompt for a delay cookie.
12910 With argument TIME, scheduled at the corresponding date. TIME can
12912 (interactive "P")
12913 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12914 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12915 'region-start-level 'region))
12916 org-loop-over-headlines-in-active-region)
12917 (org-map-entries
12918 `(org-schedule ',arg ,time)
12919 org-loop-over-headlines-in-active-region
12920 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12921 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12922 (old-date-time (if old-date (org-time-string-to-time old-date)))
12923 (repeater (and old-date
12924 (string-match
12926 old-date)
12927 (match-string 1 old-date))))
12928 (cond
12929 ((equal arg '(4))
12930 (progn
12931 (when (and old-date org-log-reschedule)
12932 (org-add-log-setup 'delschedule nil old-date 'findpos
12933 org-log-reschedule))
12934 (org-remove-timestamp-with-keyword org-scheduled-string)
12935 (message "Item is no longer scheduled.")))
12936 ((equal arg '(16))
12937 (save-excursion
12938 (if (re-search-forward
12939 org-scheduled-time-regexp
12940 (save-excursion (outline-next-heading) (point)) t)
12941 (let* ((rpl0 (match-string 1))
12942 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12943 (replace-match
12944 (concat org-scheduled-string
12945 " <" rpl
12946 (format " -%dd"
12947 (abs
12948 (- (time-to-days
12949 (save-match-data
12950 (org-read-date nil t nil "Delay until" old-date-time)))
12951 (time-to-days old-date-time))))
12952 ">") t t))
12953 (user-error "No scheduled information to update"))))
12954 (t
12955 (org-add-planning-info 'scheduled time 'closed)
12956 (when (and old-date org-log-reschedule
12957 (not (equal old-date
12958 (substring org-last-inserted-timestamp 1 -1))))
12959 (org-add-log-setup 'reschedule nil old-date 'findpos
12960 org-log-reschedule))
12961 (when repeater
12962 (save-excursion
12963 (org-back-to-heading t)
12964 (when (re-search-forward (concat org-scheduled-string " "
12965 org-last-inserted-timestamp)
12966 (save-excursion
12967 (outline-next-heading) (point)) t)
12968 (goto-char (1- (match-end 0)))
12969 (insert " " repeater)
12970 (setq org-last-inserted-timestamp
12971 (concat (substring org-last-inserted-timestamp 0 -1)
12972 " " repeater
12973 (substring org-last-inserted-timestamp -1))))))
12974 (message "Scheduled to %s" org-last-inserted-timestamp))))))
12976 (defun org-get-scheduled-time (pom &optional inherit)
12977 "Get the scheduled time as a time tuple, of a format suitable
12978 for calling org-schedule with, or if there is no scheduling,
12979 returns nil."
12980 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12981 (when time
12982 (apply 'encode-time (org-parse-time-string time)))))
12984 (defun org-get-deadline-time (pom &optional inherit)
12985 "Get the deadline as a time tuple, of a format suitable for
12986 calling org-deadline with, or if there is no scheduling, returns
12987 nil."
12988 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12989 (when time
12990 (apply 'encode-time (org-parse-time-string time)))))
12992 (defun org-remove-timestamp-with-keyword (keyword)
12993 "Remove all time stamps with KEYWORD in the current entry."
12995 beg)
12996 (save-excursion
12997 (org-back-to-heading t)
12998 (setq beg (point))
12999 (outline-next-heading)
13000 (while (re-search-backward re beg t)
13001 (replace-match "")
13003 (equal (char-before) ?\ ))
13004 (backward-delete-char 1)
13006 (point-at-bol) (point-at-eol)))
13007 (delete-region (point-at-bol)
13008 (min (point-max) (1+ (point-at-eol))))))))))
13010 (defun org-add-planning-info (what &optional time &rest remove)
13011 "Insert new timestamp with keyword in the line directly after the headline.
13012 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13013 If non is given, the user is prompted for a date.
13014 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13015 be removed."
13016 (interactive)
13017 (let (org-time-was-given org-end-time-was-given ts
13018 end default-time default-input)
13020 (catch 'exit
13021 (when (and (memq what '(scheduled deadline))
13022 (or (not time)
13023 (and (stringp time)
13024 (string-match "^[-+]+[0-9]" time))))
13025 ;; Try to get a default date/time from existing timestamp
13026 (save-excursion
13027 (org-back-to-heading t)
13028 (setq end (save-excursion (outline-next-heading) (point)))
13029 (when (re-search-forward (if (eq what 'scheduled)
13030 org-scheduled-time-regexp
13031 org-deadline-time-regexp)
13032 end t)
13033 (setq ts (match-string 1)
13034 default-time
13035 (apply 'encode-time (org-parse-time-string ts))
13036 default-input (and ts (org-get-compact-tod ts))))))
13037 (when what
13038 (setq time
13039 (if (stringp time)
13040 ;; This is a string (relative or absolute), set proper date
13041 (apply 'encode-time
13042 (org-read-date-analyze
13043 time default-time (decode-time default-time)))
13044 ;; If necessary, get the time from the user
13045 (or time (org-read-date nil 'to-time nil nil
13046 default-time default-input)))))
13048 (when (and org-insert-labeled-timestamps-at-point
13049 (member what '(scheduled deadline)))
13050 (insert
13051 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13052 (org-insert-time-stamp time org-time-was-given
13053 nil nil nil (list org-end-time-was-given))
13054 (setq what nil))
13055 (save-excursion
13056 (save-restriction
13057 (let (col list elt ts buffer-invisibility-spec)
13058 (org-back-to-heading t)
13060 (goto-char (match-end 1))
13061 (setq col (current-column))
13062 (goto-char (match-end 0))
13064 (when (and (not what)
13065 (not (looking-at
13067 org-keyword-time-not-clock-regexp))))
13068 ;; Nothing to add, nothing to remove...... :-)
13069 (throw 'exit nil))
13070 (if (and (not (looking-at org-outline-regexp))
13073 (not (equal (match-string 1) org-clock-string)))
13074 (narrow-to-region (match-beginning 0) (match-end 0))
13076 (backward-char 1)
13077 (narrow-to-region (point) (point))
13078 (and org-adapt-indentation (org-indent-to-column col)))
13079 ;; Check if we have to remove something.
13080 (setq list (cons what remove))
13081 (while list
13082 (setq elt (pop list))
13083 (when (or (and (eq elt 'scheduled)
13084 (re-search-forward org-scheduled-time-regexp nil t))
13085 (and (eq elt 'deadline)
13086 (re-search-forward org-deadline-time-regexp nil t))
13087 (and (eq elt 'closed)
13088 (re-search-forward org-closed-time-regexp nil t)))
13089 (replace-match "")
13090 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13092 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13093 (when what
13094 (insert
13095 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13096 (cond ((eq what 'scheduled) org-scheduled-string)
13097 ((eq what 'deadline) org-deadline-string)
13098 ((eq what 'closed) org-closed-string))
13099 " ")
13100 (setq ts (org-insert-time-stamp
13101 time
13102 (or org-time-was-given
13103 (and (eq what 'closed) org-log-done-with-time))
13104 (eq what 'closed)
13105 nil nil (list org-end-time-was-given)))
13106 (insert
13107 (if (not (or (bolp) (eq (char-before) ?\ )
13108 (memq (char-after) '(32 10))
13109 (eobp))) " " ""))
13110 (end-of-line 1))
13111 (goto-char (point-min))
13112 (widen)
13115 (delete-region (1- (point)) (point-at-eol)))
13116 ts))))))
13118 (defvar org-log-note-marker (make-marker))
13119 (defvar org-log-note-purpose nil)
13120 (defvar org-log-note-state nil)
13121 (defvar org-log-note-previous-state nil)
13122 (defvar org-log-note-how nil)
13123 (defvar org-log-note-extra nil)
13124 (defvar org-log-note-window-configuration nil)
13125 (defvar org-log-note-return-to (make-marker))
13126 (defvar org-log-note-effective-time nil
13127 "Remembered current time so that dynamically scoped
13128 `org-extend-today-until' affects tha timestamps in state change
13129 log")
13131 (defvar org-log-post-message nil
13132 "Message to be displayed after a log note has been stored.
13133 The auto-repeater uses this.")
13135 (defun org-add-note ()
13136 "Add a note to the current entry.
13137 This is done in the same way as adding a state change note."
13138 (interactive)
13139 (org-add-log-setup 'note nil nil 'findpos nil))
13141 (defvar org-property-end-re)
13142 (defun org-add-log-setup (&optional purpose state prev-state
13143 findpos how extra)
13144 "Set up the post command hook to take a note.
13145 If this is about to TODO state change, the new state is expected in STATE.
13146 When FINDPOS is non-nil, find the correct position for the note in
13147 the current entry. If not, assume that it can be inserted at point.
13148 HOW is an indicator what kind of note should be created.
13149 EXTRA is additional text that will be inserted into the notes buffer."
13150 (let* ((org-log-into-drawer (org-log-into-drawer))
13151 (drawer (cond ((stringp org-log-into-drawer)
13152 org-log-into-drawer)
13153 (org-log-into-drawer "LOGBOOK"))))
13154 (save-restriction
13155 (save-excursion
13156 (when findpos
13157 (org-back-to-heading t)
13158 (narrow-to-region (point) (save-excursion
13159 (outline-next-heading) (point)))
13163 (goto-char (match-end 0))
13164 (cond
13165 (drawer
13167 nil t)
13168 (progn
13169 (goto-char (match-end 0))
13170 (or org-log-states-order-reversed
13171 (and (re-search-forward org-property-end-re nil t)
13172 (goto-char (1- (match-beginning 0))))))
13174 (beginning-of-line 0)
13175 (org-indent-line)
13176 (beginning-of-line 2)
13177 (org-indent-line)
13178 (end-of-line 0)))
13179 ((and org-log-state-notes-insert-after-drawers
13180 (save-excursion
13181 (forward-line) (looking-at org-drawer-regexp)))
13182 (forward-line)
13183 (while (looking-at org-drawer-regexp)
13184 (goto-char (match-end 0))
13185 (re-search-forward org-property-end-re (point-max) t)
13186 (forward-line))
13187 (forward-line -1)))
13188 (unless org-log-states-order-reversed
13190 (org-skip-over-state-notes)
13192 (move-marker org-log-note-marker (point))
13193 (setq org-log-note-purpose purpose
13194 org-log-note-state state
13195 org-log-note-previous-state prev-state
13196 org-log-note-how how
13197 org-log-note-extra extra
13198 org-log-note-effective-time (org-current-effective-time))
13199 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13201 (defun org-skip-over-state-notes ()
13202 "Skip past the list of State notes in an entry."
13204 (when (ignore-errors (goto-char (org-in-item-p)))
13205 (let* ((struct (org-list-struct))
13206 (prevs (org-list-prevs-alist struct)))
13208 (goto-char (or (org-list-get-next-item (point) struct prevs)
13209 (org-list-get-item-end (point) struct)))))))
13211 (defun org-add-log-note (&optional purpose)
13212 "Pop up a window for taking a note, and add this note later at point."
13213 (remove-hook 'post-command-hook 'org-add-log-note)
13214 (setq org-log-note-window-configuration (current-window-configuration))
13215 (delete-other-windows)
13216 (move-marker org-log-note-return-to (point))
13217 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13218 (goto-char org-log-note-marker)
13219 (org-switch-to-buffer-other-window "*Org Note*")
13220 (erase-buffer)
13221 (if (memq org-log-note-how '(time state))
13222 (let (current-prefix-arg) (org-store-log-note))
13223 (let ((org-inhibit-startup t)) (org-mode))
13224 (insert (format "# Insert note for %s.
13226 (cond
13227 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13228 ((eq org-log-note-purpose 'done) "closed todo item")
13229 ((eq org-log-note-purpose 'state)
13231 (or org-log-note-previous-state "")
13232 (or org-log-note-state "")))
13233 ((eq org-log-note-purpose 'reschedule)
13234 "rescheduling")
13235 ((eq org-log-note-purpose 'delschedule)
13236 "no longer scheduled")
13237 ((eq org-log-note-purpose 'redeadline)
13238 "changing deadline")
13239 ((eq org-log-note-purpose 'deldeadline)
13240 "removing deadline")
13241 ((eq org-log-note-purpose 'refile)
13242 "refiling")
13243 ((eq org-log-note-purpose 'note)
13244 "this entry")
13245 (t (error "This should not happen")))))
13246 (if org-log-note-extra (insert org-log-note-extra))
13247 (org-set-local 'org-finish-function 'org-store-log-note)
13248 (run-hooks 'org-log-buffer-setup-hook)))
13250 (defvar org-note-abort nil) ; dynamically scoped
13251 (defun org-store-log-note ()
13252 "Finish taking a log note, and insert it to where it belongs."
13253 (let ((txt (buffer-string)))
13254 (kill-buffer (current-buffer))
13255 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13256 lines ind bul)
13258 (setq txt (replace-match "" t t txt)))
13260 (setq txt (replace-match "" t t txt)))
13263 (setq note
13264 (org-replace-escapes
13265 note
13266 (list (cons "%u" (user-login-name))
13267 (cons "%U" user-full-name)
13268 (cons "%t" (format-time-string
13269 (org-time-stamp-format 'long 'inactive)
13270 org-log-note-effective-time))
13271 (cons "%T" (format-time-string
13272 (org-time-stamp-format 'long nil)
13273 org-log-note-effective-time))
13274 (cons "%d" (format-time-string
13275 (org-time-stamp-format nil 'inactive)
13276 org-log-note-effective-time))
13277 (cons "%D" (format-time-string
13278 (org-time-stamp-format nil nil)
13279 org-log-note-effective-time))
13280 (cons "%s" (if org-log-note-state
13282 ""))
13283 (cons "%S" (if org-log-note-previous-state
13287 (push note lines))
13288 (when (or current-prefix-arg org-note-abort)
13289 (when org-log-into-drawer
13290 (org-remove-empty-drawer-at
13291 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13292 org-log-note-marker))
13293 (setq lines nil))
13294 (when lines
13295 (with-current-buffer (marker-buffer org-log-note-marker)
13296 (save-excursion
13297 (goto-char org-log-note-marker)
13298 (move-marker org-log-note-marker nil)
13299 (end-of-line 1)
13301 (setq ind (save-excursion
13302 (if (ignore-errors (goto-char (org-in-item-p)))
13303 (let ((struct (org-list-struct)))
13304 (org-list-get-ind
13305 (org-list-get-top-point struct) struct))
13307 (cond
13308 ((and (org-at-heading-p)
13309 org-adapt-indentation)
13310 (1+ (org-current-level)))
13311 ((org-at-heading-p) 0)
13312 (t (org-get-indentation))))))
13313 (setq bul (org-list-bullet-string "-"))
13314 (org-indent-line-to ind)
13315 (insert bul (pop lines))
13316 (let ((ind-body (+ (length bul) ind)))
13317 (while lines
13319 (org-indent-line-to ind-body)
13320 (insert (pop lines))))
13321 (message "Note stored")
13322 (org-back-to-heading t)
13323 (org-cycle-hide-drawers 'children))
13324 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13325 ;; from within `org-add-log-note' because `buffer-undo-list'
13326 ;; is then modified outside of `org-with-remote-undo'.
13327 (when (eq this-command 'org-agenda-todo)
13328 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13329 ;; Don't add undo information when called from `org-agenda-todo'
13330 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13331 (set-window-configuration org-log-note-window-configuration)
13332 (with-current-buffer (marker-buffer org-log-note-return-to)
13333 (goto-char org-log-note-return-to))
13334 (move-marker org-log-note-return-to nil)
13335 (and org-log-post-message (message "%s" org-log-post-message))))
13337 (defun org-remove-empty-drawer-at (drawer pos)
13338 "Remove an empty drawer DRAWER at position POS.
13339 POS may also be a marker."
13340 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13341 (save-excursion
13342 (save-restriction
13343 (widen)
13344 (goto-char pos)
13345 (if (org-in-regexp
13347 (replace-match ""))))))
13349 (defvar org-ts-type nil)
13350 (defun org-sparse-tree (&optional arg type)
13351 "Create a sparse tree, prompt for the details.
13352 This command can create sparse trees. You first need to select the type
13353 of match used to create the tree:
13355 t Show all TODO entries.
13356 T Show entries with a specific TODO keyword.
13357 m Show entries selected by a tags/property match.
13358 p Enter a property name and its value (both with completion on existing
13359 names/values) and show entries with that property.
13360 r Show entries matching a regular expression (`/' can be used as well).
13361 b Show deadlines and scheduled items before a date.
13362 a Show deadlines and scheduled items after a date.
13363 d Show deadlines due within `org-deadline-warning-days'.
13364 D Show deadlines and scheduled items between a date range."
13365 (interactive "P")
13366 (let (ans kwd value ts-type)
13367 (setq type (or type org-sparse-tree-default-date-type))
13368 (setq org-ts-type type)
13369 (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"
13370 (cond ((eq type 'all) "all timestamps")
13371 ((eq type 'scheduled) "only scheduled")
13372 ((eq type 'deadline) "only deadline")
13373 ((eq type 'active) "only active timestamps")
13374 ((eq type 'inactive) "only inactive timestamps")
13375 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13376 ((eq type 'closed) "with a closed time-stamp")
13377 (t "scheduled/deadline")))
13378 (setq ans (read-char-exclusive))
13379 (cond
13380 ((equal ans ?c)
13381 (org-sparse-tree
13382 arg (cadr (member type '(scheduled-or-deadline
13383 all scheduled deadline active inactive closed)))))
13384 ((equal ans ?d)
13385 (call-interactively 'org-check-deadlines))
13386 ((equal ans ?b)
13387 (call-interactively 'org-check-before-date))
13388 ((equal ans ?a)
13389 (call-interactively 'org-check-after-date))
13390 ((equal ans ?D)
13391 (call-interactively 'org-check-dates-range))
13392 ((equal ans ?t)
13393 (call-interactively 'org-show-todo-tree))
13394 ((equal ans ?T)
13395 (org-show-todo-tree '(4)))
13396 ((member ans '(?T ?m))
13397 (call-interactively 'org-match-sparse-tree))
13398 ((member ans '(?p ?P))
13399 (setq kwd (org-icompleting-read "Property: "
13400 (mapcar 'list (org-buffer-property-keys))))
13401 (setq value (org-icompleting-read "Value: "
13402 (mapcar 'list (org-property-values kwd))))
13405 (org-match-sparse-tree arg (concat kwd "=" value)))
13406 ((member ans '(?r ?R ?/))
13407 (call-interactively 'org-occur))
13410 (defvar org-occur-highlights nil
13411 "List of overlays used for occur matches.")
13412 (make-variable-buffer-local 'org-occur-highlights)
13413 (defvar org-occur-parameters nil
13414 "Parameters of the active org-occur calls.
13415 This is a list, each call to org-occur pushes as cons cell,
13416 containing the regular expression and the callback, onto the list.
13417 The list can contain several entries if `org-occur' has been called
13418 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13419 will only contain one set of parameters. When the highlights are
13420 removed (for example with `C-c C-c', or with the next edit (depending
13421 on `org-remove-highlights-with-change'), this variable is emptied
13422 as well.")
13423 (make-variable-buffer-local 'org-occur-parameters)
13425 (defun org-occur (regexp &optional keep-previous callback)
13426 "Make a compact tree which shows all matches of REGEXP.
13427 The tree will show the lines where the regexp matches, and all higher
13428 headlines above the match. It will also show the heading after the match,
13429 to make sure editing the matching entry is easy.
13430 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13431 call to `org-occur' will be kept, to allow stacking of calls to this
13432 command.
13433 If CALLBACK is non-nil, it is a function which is called to confirm
13434 that the match should indeed be shown."
13436 (when (equal regexp "")
13437 (error "Regexp cannot be empty"))
13438 (unless keep-previous
13439 (org-remove-occur-highlights nil nil t))
13440 (push (cons regexp callback) org-occur-parameters)
13441 (let ((cnt 0))
13442 (save-excursion
13443 (goto-char (point-min))
13444 (if (or (not keep-previous) ; do not want to keep
13445 (not org-occur-highlights)) ; no previous matches
13446 ;; hide everything
13447 (org-overview))
13448 (while (re-search-forward regexp nil t)
13449 (when (or (not callback)
13450 (save-match-data (funcall callback)))
13451 (setq cnt (1+ cnt))
13452 (when org-highlight-sparse-tree-matches
13453 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13454 (org-show-context 'occur-tree))))
13455 (when org-remove-highlights-with-change
13456 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13457 nil 'local))
13458 (unless org-sparse-tree-open-archived-trees
13459 (org-hide-archived-subtrees (point-min) (point-max)))
13460 (run-hooks 'org-occur-hook)
13461 (if (org-called-interactively-p 'interactive)
13462 (message "%d match(es) for regexp %s" cnt regexp))
13463 cnt))
13465 (defun org-occur-next-match (&optional n reset)
13466 "Function for `next-error-function' to find sparse tree matches.
13467 N is the number of matches to move, when negative move backwards.
13468 RESET is entirely ignored - this function always goes back to the
13469 starting point when no match is found."
13470 (let* ((limit (if (< n 0) (point-min) (point-max)))
13471 (search-func (if (< n 0)
13472 'previous-single-char-property-change
13473 'next-single-char-property-change))
13474 (n (abs n))
13475 (pos (point))
13476 p1)
13477 (catch 'exit
13478 (while (setq p1 (funcall search-func (point) 'org-type))
13479 (when (equal p1 limit)
13480 (goto-char pos)
13481 (error "No more matches"))
13482 (when (equal (get-char-property p1 'org-type) 'org-occur)
13483 (setq n (1- n))
13484 (when (= n 0)
13485 (goto-char p1)
13486 (throw 'exit (point))))
13487 (goto-char p1))
13488 (goto-char p1)
13489 (error "No more matches"))))
13491 (defun org-show-context (&optional key)
13492 "Make sure point and context are visible.
13493 How much context is shown depends upon the variables
13494 `org-show-hierarchy-above', `org-show-following-heading',
13495 `org-show-entry-below' and `org-show-siblings'."
13496 (let ((heading-p (org-at-heading-p t))
13497 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13498 (following-p (org-get-alist-option org-show-following-heading key))
13499 (entry-p (org-get-alist-option org-show-entry-below key))
13500 (siblings-p (org-get-alist-option org-show-siblings key)))
13501 ;; Show heading or entry text
13502 (if (and heading-p (not entry-p))
13503 (org-flag-heading nil) ; only show the heading
13504 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13505 (org-show-hidden-entry))) ; show entire entry
13506 (when following-p
13507 ;; Show next sibling, or heading below text
13508 (save-excursion
13509 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13510 (org-flag-heading nil))))
13511 (when siblings-p (org-show-siblings))
13512 (when hierarchy-p
13513 ;; show all higher headings, possibly with siblings
13514 (save-excursion
13515 (while (and (condition-case nil
13516 (progn (org-up-heading-all 1) t)
13517 (error nil))
13518 (not (bobp)))
13519 (org-flag-heading nil)
13520 (when siblings-p (org-show-siblings)))))
13521 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13523 (defvar org-reveal-start-hook nil
13524 "Hook run before revealing a location.")
13526 (defun org-reveal (&optional siblings)
13527 "Show current entry, hierarchy above it, and the following headline.
13528 This can be used to show a consistent set of context around locations
13529 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13530 not t for the search context.
13532 With optional argument SIBLINGS, on each level of the hierarchy all
13533 siblings are shown. This repairs the tree structure to what it would
13534 look like when opened with hierarchical calls to `org-cycle'.
13536 go to the parent and show the
13537 entire tree."
13538 (interactive "P")
13539 (run-hooks 'org-reveal-start-hook)
13540 (let ((org-show-hierarchy-above t)
13541 (org-show-following-heading t)
13542 (org-show-siblings (if siblings t org-show-siblings)))
13543 (org-show-context nil))
13544 (when (equal siblings '(16))
13545 (save-excursion
13546 (when (org-up-heading-safe)
13547 (org-show-subtree)
13548 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13550 (defun org-highlight-new-match (beg end)
13551 "Highlight from BEG to END and mark the highlight is an occur headline."
13552 (let ((ov (make-overlay beg end)))
13553 (overlay-put ov 'face 'secondary-selection)
13554 (overlay-put ov 'org-type 'org-occur)
13555 (push ov org-occur-highlights)))
13557 (defun org-remove-occur-highlights (&optional beg end noremove)
13558 "Remove the occur highlights from the buffer.
13559 BEG and END are ignored. If NOREMOVE is nil, remove this function
13560 from the `before-change-functions' in the current buffer."
13561 (interactive)
13562 (unless org-inhibit-highlight-removal
13563 (mapc 'delete-overlay org-occur-highlights)
13564 (setq org-occur-highlights nil)
13565 (setq org-occur-parameters nil)
13566 (unless noremove
13567 (remove-hook 'before-change-functions
13568 'org-remove-occur-highlights 'local))))
13570 ;;;; Priorities
13573 "Regular expression matching the priority indicator.")
13575 (defvar org-remove-priority-next-time nil)
13577 (defun org-priority-up ()
13578 "Increase the priority of the current item."
13579 (interactive)
13580 (org-priority 'up))
13582 (defun org-priority-down ()
13583 "Decrease the priority of the current item."
13584 (interactive)
13585 (org-priority 'down))
13587 (defun org-priority (&optional action show)
13588 "Change the priority of an item.
13589 ACTION can be `set', `up', `down', or a character."
13590 (interactive "P")
13591 (if (equal action '(4))
13592 (org-show-priority)
13593 (unless org-enable-priority-commands
13594 (error "Priority commands are disabled"))
13595 (setq action (or action 'set))
13596 (let (current new news have remove)
13597 (save-excursion
13598 (org-back-to-heading t)
13599 (if (looking-at org-priority-regexp)
13600 (setq current (string-to-char (match-string 2))
13601 have t))
13602 (cond
13603 ((eq action 'remove)
13604 (setq remove t new ?\ ))
13605 ((or (eq action 'set)
13606 (if (featurep 'xemacs) (characterp action) (integerp action)))
13607 (if (not (eq action 'set))
13608 (setq new action)
13609 (message "Priority %c-%c, SPC to remove: "
13610 org-highest-priority org-lowest-priority)
13611 (save-match-data
13612 (setq new (read-char-exclusive))))
13613 (if (and (= (upcase org-highest-priority) org-highest-priority)
13614 (= (upcase org-lowest-priority) org-lowest-priority))
13615 (setq new (upcase new)))
13616 (cond ((equal new ?\ ) (setq remove t))
13617 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13618 (error "Priority must be between `%c' and `%c'"
13619 org-highest-priority org-lowest-priority))))
13620 ((eq action 'up)
13621 (setq new (if have
13622 (1- current) ; normal cycling
13623 ;; last priority was empty
13624 (if (eq last-command this-command)
13625 org-lowest-priority ; wrap around empty to lowest
13626 ;; default
13627 (if org-priority-start-cycle-with-default
13628 org-default-priority
13629 (1- org-default-priority))))))
13630 ((eq action 'down)
13631 (setq new (if have
13632 (1+ current) ; normal cycling
13633 ;; last priority was empty
13634 (if (eq last-command this-command)
13635 org-highest-priority ; wrap around empty to highest
13636 ;; default
13637 (if org-priority-start-cycle-with-default
13638 org-default-priority
13639 (1+ org-default-priority))))))
13640 (t (error "Invalid action")))
13641 (if (or (< (upcase new) org-highest-priority)
13642 (> (upcase new) org-lowest-priority))
13643 (if (and (memq action '(up down))
13644 (not have) (not (eq last-command this-command)))
13645 ;; `new' is from default priority
13646 (error
13647 "The default can not be set, see `org-default-priority' why")
13648 ;; normal cycling: `new' is beyond highest/lowest priority
13649 ;; and is wrapped around to the empty priority
13650 (setq remove t)))
13651 (setq news (format "%c" new))
13652 (if have
13653 (if remove
13654 (replace-match "" t t nil 1)
13655 (replace-match news t t nil 2))
13656 (if remove
13657 (error "No priority cookie found in line")
13658 (let ((case-fold-search nil))
13659 (looking-at org-todo-line-regexp))
13660 (if (match-end 2)
13661 (progn
13662 (goto-char (match-end 2))
13663 (insert " [#" news "]"))
13664 (goto-char (match-beginning 3))
13665 (insert "[#" news "] "))))
13666 (org-preserve-lc (org-set-tags nil 'align)))
13667 (if remove
13668 (message "Priority removed")
13669 (message "Priority of current item set to %s" news)))))
13671 (defun org-show-priority ()
13672 "Show the priority of the current item.
13673 This priority is composed of the main priority given with the [#A] cookies,
13674 and by additional input from the age of a schedules or deadline entry."
13675 (interactive)
13676 (let ((pri (if (eq major-mode 'org-agenda-mode)
13677 (org-get-at-bol 'priority)
13678 (save-excursion
13679 (save-match-data
13680 (beginning-of-line)
13681 (and (looking-at org-heading-regexp)
13682 (org-get-priority (match-string 0))))))))
13683 (message "Priority is %d" (if pri pri -1000))))
13685 (defun org-get-priority (s)
13686 "Find priority cookie and return priority."
13687 (save-match-data
13688 (if (functionp org-get-priority-function)
13689 (funcall org-get-priority-function)
13690 (if (not (string-match org-priority-regexp s))
13691 (* 1000 (- org-lowest-priority org-default-priority))
13692 (* 1000 (- org-lowest-priority
13693 (string-to-char (match-string 2 s))))))))
13695 ;;;; Tags
13697 (defvar org-agenda-archives-mode)
13698 (defvar org-map-continue-from nil
13699 "Position from where mapping should continue.
13700 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13702 (defvar org-scanner-tags nil
13703 "The current tag list while the tags scanner is running.")
13704 (defvar org-trust-scanner-tags nil
13705 "Should `org-get-tags-at' use the tags for the scanner.
13706 This is for internal dynamical scoping only.
13707 When this is non-nil, the function `org-get-tags-at' will return the value
13708 of `org-scanner-tags' instead of building the list by itself. This
13709 can lead to large speed-ups when the tags scanner is used in a file with
13710 many entries, and when the list of tags is retrieved, for example to
13711 obtain a list of properties. Building the tags list for each entry in such
13712 a file becomes an N^2 operation - but with this variable set, it scales
13713 as N.")
13715 (defun org-scan-tags (action matcher todo-only &optional start-level)
13716 "Sca headline tags with inheritance and produce output ACTION.
13718 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13719 or `agenda' to produce an entry list for an agenda view. It can also be
13720 a Lisp form or a function that should be called at each matched headline, in
13721 this case the return value is a list of all return values from these calls.
13723 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13724 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13725 only lines with a not-done TODO keyword are included in the output.
13726 This should be the same variable that was scoped into
13727 and set by `org-make-tags-matcher' when it constructed MATCHER.
13729 START-LEVEL can be a string with asterisks, reducing the scope to
13730 headlines matching this string."
13731 (require 'org-agenda)
13732 (let* ((re (concat "^"
13733 (if start-level
13734 ;; Get the correct level to match
13736 org-outline-regexp)
13740 (props (list 'face 'default
13741 'done-face 'org-agenda-done
13742 'undone-face 'default
13743 'mouse-face 'highlight
13744 'org-not-done-regexp org-not-done-regexp
13745 'org-todo-regexp org-todo-regexp
13746 'org-complex-heading-regexp org-complex-heading-regexp
13747 'help-echo
13748 (format "mouse-2 or RET jump to org file %s"
13749 (abbreviate-file-name
13750 (or (buffer-file-name (buffer-base-buffer))
13751 (buffer-name (buffer-base-buffer)))))))
13752 (case-fold-search nil)
13753 (org-map-continue-from nil)
13754 lspos tags tags-list
13755 (tags-alist (list (cons 0 org-file-tags)))
13756 (llast 0) rtn rtn1 level category i txt
13757 todo marker entry priority)
13758 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13759 (setq action (list 'lambda nil action)))
13760 (save-excursion
13761 (goto-char (point-min))
13762 (when (eq action 'sparse-tree)
13763 (org-overview)
13764 (org-remove-occur-highlights))
13765 (while (re-search-forward re nil t)
13766 (setq org-map-continue-from nil)
13767 (catch :skip
13768 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13769 tags (if (match-end 4) (org-match-string-no-properties 4)))
13770 (goto-char (setq lspos (match-beginning 0)))
13771 (setq level (org-reduced-level (org-outline-level))
13772 category (org-get-category))
13773 (setq i llast llast level)
13774 ;; remove tag lists from same and sublevels
13775 (while (>= i level)
13776 (when (setq entry (assoc i tags-alist))
13777 (setq tags-alist (delete entry tags-alist)))
13778 (setq i (1- i)))
13779 ;; add the next tags
13780 (when tags
13781 (setq tags (org-split-string tags ":")
13782 tags-alist
13783 (cons (cons level tags) tags-alist)))
13784 ;; compile tags for current headline
13785 (setq tags-list
13786 (if org-use-tag-inheritance
13787 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13788 tags)
13789 org-scanner-tags tags-list)
13790 (when org-use-tag-inheritance
13791 (setcdr (car tags-alist)
13792 (mapcar (lambda (x)
13793 (setq x (copy-sequence x))
13794 (org-add-prop-inherited x))
13795 (cdar tags-alist))))
13796 (when (and tags org-use-tag-inheritance
13797 (or (not (eq t org-use-tag-inheritance))
13798 org-tags-exclude-from-inheritance))
13799 ;; selective inheritance, remove uninherited ones
13800 (setcdr (car tags-alist)
13801 (org-remove-uninherited-tags (cdar tags-alist))))
13802 (when (and
13804 ;; eval matcher only when the todo condition is OK
13805 (and (or (not todo-only) (member todo org-not-done-keywords))
13806 (let ((case-fold-search t) (org-trust-scanner-tags t))
13807 (eval matcher)))
13809 ;; Call the skipper, but return t if it does not skip,
13810 ;; so that the `and' form continues evaluating
13811 (progn
13812 (unless (eq action 'sparse-tree) (org-agenda-skip))
13813 t)
13815 ;; Check if timestamps are deselecting this entry
13816 (or (not todo-only)
13817 (and (member todo org-not-done-keywords)
13818 (or (not org-agenda-tags-todo-honor-ignore-options)
13819 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13821 ;; select this headline
13822 (cond
13823 ((eq action 'sparse-tree)
13824 (and org-highlight-sparse-tree-matches
13825 (org-get-heading) (match-end 0)
13826 (org-highlight-new-match
13827 (match-beginning 1) (match-end 1)))
13828 (org-show-context 'tags-tree))
13829 ((eq action 'agenda)
13830 (setq txt (org-agenda-format-item
13831 ""
13832 (concat
13833 (if (eq org-tags-match-list-sublevels 'indented)
13834 (make-string (1- level) ?.) "")
13835 (org-get-heading))
13836 level category
13837 tags-list)
13838 priority (org-get-priority txt))
13839 (goto-char lspos)
13840 (setq marker (org-agenda-new-marker))
13841 (org-add-props txt props
13842 'org-marker marker 'org-hd-marker marker 'org-category category
13843 'todo-state todo
13844 'priority priority 'type "tagsmatch")
13845 (push txt rtn))
13846 ((functionp action)
13847 (setq org-map-continue-from nil)
13848 (save-excursion
13849 (setq rtn1 (funcall action))
13850 (push rtn1 rtn)))
13851 (t (error "Invalid action")))
13853 ;; if we are to skip sublevels, jump to end of subtree
13854 (unless org-tags-match-list-sublevels
13855 (org-end-of-subtree t)
13856 (backward-char 1))))
13857 ;; Get the correct position from where to continue
13858 (if org-map-continue-from
13859 (goto-char org-map-continue-from)
13860 (and (= (point) lspos) (end-of-line 1)))))
13861 (when (and (eq action 'sparse-tree)
13862 (not org-sparse-tree-open-archived-trees))
13863 (org-hide-archived-subtrees (point-min) (point-max)))
13864 (nreverse rtn)))
13866 (defun org-remove-uninherited-tags (tags)
13867 "Remove all tags that are not inherited from the list TAGS."
13868 (cond
13869 ((eq org-use-tag-inheritance t)
13870 (if org-tags-exclude-from-inheritance
13871 (org-delete-all org-tags-exclude-from-inheritance tags)
13872 tags))
13873 ((not org-use-tag-inheritance) nil)
13874 ((stringp org-use-tag-inheritance)
13875 (delq nil (mapcar
13876 (lambda (x)
13877 (if (and (string-match org-use-tag-inheritance x)
13878 (not (member x org-tags-exclude-from-inheritance)))
13879 x nil))
13880 tags)))
13881 ((listp org-use-tag-inheritance)
13882 (delq nil (mapcar
13883 (lambda (x)
13884 (if (member x org-use-tag-inheritance) x nil))
13885 tags)))))
13887 (defun org-match-sparse-tree (&optional todo-only match)
13888 "Create a sparse tree according to tags string MATCH.
13889 MATCH can contain positive and negative selection of tags, like
13891 If optional argument TODO-ONLY is non-nil, only select lines that are
13892 also TODO lines."
13893 (interactive "P")
13894 (org-agenda-prepare-buffers (list (current-buffer)))
13895 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13897 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13899 (defvar org-cached-props nil)
13900 (defun org-cached-entry-get (pom property)
13901 (if (or (eq t org-use-property-inheritance)
13902 (and (stringp org-use-property-inheritance)
13903 (string-match org-use-property-inheritance property))
13904 (and (listp org-use-property-inheritance)
13905 (member property org-use-property-inheritance)))
13906 ;; Caching is not possible, check it directly
13907 (org-entry-get pom property 'inherit)
13908 ;; Get all properties, so that we can do complicated checks easily
13909 (cdr (assoc property (or org-cached-props
13910 (setq org-cached-props
13911 (org-entry-properties pom)))))))
13913 (defun org-global-tags-completion-table (&optional files)
13914 "Return the list of all tags in all agenda buffer/files.
13915 Optional FILES argument is a list of files which can be used
13916 instead of the agenda files."
13917 (save-excursion
13918 (org-uniquify
13919 (delq nil
13920 (apply 'append
13921 (mapcar
13922 (lambda (file)
13923 (set-buffer (find-file-noselect file))
13924 (append (org-get-buffer-tags)
13925 (mapcar (lambda (x) (if (stringp (car-safe x))
13926 (list (car-safe x)) nil))
13927 org-tag-alist)))
13928 (if (and files (car files))
13929 files
13930 (org-agenda-files))))))))
13932 (defun org-make-tags-matcher (match)
13933 "Create the TAGS/TODO matcher form for the selection string MATCH.
13935 The variable `todo-only' is scoped dynamically into this function.
13936 It will be set to t if the matcher restricts matching to TODO entries,
13937 otherwise will not be touched.
13939 Returns a cons of the selection string MATCH and the constructed
13940 lisp form implementing the matcher. The matcher is to be evaluated
13941 at an Org entry, with point on the headline, and returns t if the
13942 entry matches the selection string MATCH. The returned lisp form
13943 references two variables with information about the entry, which
13944 must be bound around the form's evaluation: todo, the TODO keyword
13945 at the entry (or nil of none); and tags-list, the list of all tags
13946 at the entry including inherited ones. Additionally, the category
13947 of the entry (if any) must be specified as the text property
13948 'org-category on the headline.
13950 See also `org-scan-tags'.
13951 "
13952 (declare (special todo-only))
13953 (unless (boundp 'todo-only)
13954 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
13955 (unless match
13956 ;; Get a new match request, with completion against the global
13957 ;; tags table and the local tags in current buffer
13958 (let ((org-last-tags-completion-table
13959 (org-uniquify
13960 (delq nil (append (org-get-buffer-tags)
13961 (org-global-tags-completion-table))))))
13962 (setq match (org-completing-read-no-i
13963 "Match: " 'org-tags-completion-function nil nil nil
13964 'org-tags-history))))
13966 ;; Parse the string and create a lisp form
13967 (let ((match0 match)
13968 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13969 minus tag mm
13970 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13971 orterms term orlist re-p str-p level-p level-op time-p
13972 prop-p pn pv po gv rest)
13973 ;; Expand group tags
13974 (setq match (org-tags-expand match))
13975 (if (string-match "/+" match)
13976 ;; match contains also a todo-matching request
13977 (progn
13978 (setq tagsmatch (substring match 0 (match-beginning 0))
13979 todomatch (substring match (match-end 0)))
13980 (if (string-match "^!" todomatch)
13981 (setq todo-only t todomatch (substring todomatch 1)))
13983 (setq todomatch nil)))
13984 ;; only matching tags
13985 (setq tagsmatch match todomatch nil))
13987 ;; Make the tags matcher
13989 (setq tagsmatcher t)
13990 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13991 (while (setq term (pop orterms))
13993 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13994 (while (string-match re term)
13995 (setq rest (substring term (match-end 0))
13996 minus (and (match-end 1)
13997 (equal (match-string 1 term) "-"))
13998 tag (save-match-data (replace-regexp-in-string
14000 (match-string 2 term)))
14001 re-p (equal (string-to-char tag) ?{)
14002 level-p (match-end 4)
14003 prop-p (match-end 5)
14004 mm (cond
14005 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14006 (level-p
14007 (setq level-op (org-op-to-function (match-string 3 term)))
14008 `(,level-op level ,(string-to-number
14009 (match-string 4 term))))
14010 (prop-p
14011 (setq pn (match-string 5 term)
14012 po (match-string 6 term)
14013 pv (match-string 7 term)
14014 re-p (equal (string-to-char pv) ?{)
14016 time-p (save-match-data
14018 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14019 (if time-p (setq pv (org-matcher-time pv)))
14020 (setq po (org-op-to-function po (if time-p 'time str-p)))
14021 (cond
14022 ((equal pn "CATEGORY")
14023 (setq gv '(get-text-property (point) 'org-category)))
14024 ((equal pn "TODO")
14025 (setq gv 'todo))
14026 (t
14027 (setq gv `(org-cached-entry-get nil ,pn))))
14028 (if re-p
14029 (if (eq po 'org<>)
14030 `(not (string-match ,pv (or ,gv "")))
14031 `(string-match ,pv (or ,gv "")))
14032 (if str-p
14033 `(,po (or ,gv "") ,pv)
14034 `(,po (string-to-number (or ,gv ""))
14035 ,(string-to-number pv) ))))
14036 (t `(member ,tag tags-list)))
14037 mm (if minus (list 'not mm) mm)
14038 term rest)
14039 (push mm tagsmatcher))
14040 (push (if (> (length tagsmatcher) 1)
14041 (cons 'and tagsmatcher)
14042 (car tagsmatcher))
14043 orlist)
14044 (setq tagsmatcher nil))
14045 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14046 (setq tagsmatcher
14047 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14048 ;; Make the todo matcher
14050 (setq todomatcher t)
14051 (setq orterms (org-split-string todomatch "|") orlist nil)
14052 (while (setq term (pop orterms))
14053 (while (string-match re term)
14054 (setq minus (and (match-end 1)
14055 (equal (match-string 1 term) "-"))
14056 kwd (match-string 2 term)
14057 re-p (equal (string-to-char kwd) ?{)
14058 term (substring term (match-end 0))
14059 mm (if re-p
14060 `(string-match ,(substring kwd 1 -1) todo)
14061 (list 'equal 'todo kwd))
14062 mm (if minus (list 'not mm) mm))
14063 (push mm todomatcher))
14064 (push (if (> (length todomatcher) 1)
14065 (cons 'and todomatcher)
14066 (car todomatcher))
14067 orlist)
14068 (setq todomatcher nil))
14069 (setq todomatcher (if (> (length orlist) 1)
14070 (cons 'or orlist) (car orlist))))
14072 ;; Return the string and lisp forms of the matcher
14073 (setq matcher (if todomatcher
14074 (list 'and tagsmatcher todomatcher)
14075 tagsmatcher))
14076 (when todo-only
14077 (setq matcher (list 'and '(member todo org-not-done-keywords)
14078 matcher)))
14079 (cons match0 matcher)))
14081 (defun org-tags-expand (match &optional single-as-list downcased)
14082 "Expand group tags in MATCH.
14084 This replaces every group tag in MATCH with a regexp tag search.
14086 will be replaced like this:
14092 Replacing by a regexp preserves the structure of the match.
14093 E.g., this expansion
14100 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14101 assumed to be a single group tag, and the function will return
14102 the list of tags in this group.
14104 When DOWNCASE is non-nil, expand downcased TAGS."
14105 (if org-group-tags
14106 (let* ((case-fold-search t)
14107 (stable org-mode-syntax-table)
14108 (tal (or org-tag-groups-alist-for-agenda
14109 org-tag-groups-alist))
14110 (tal (if downcased
14111 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14112 (tml (mapcar 'car tal))
14113 (rtnmatch match) rpl)
14114 ;; @ and _ are allowed as word-components in tags
14115 (modify-syntax-entry ?@ "w" stable)
14116 (modify-syntax-entry ?_ "w" stable)
14117 (while (and tml
14118 (string-match
14121 (let* ((dir (match-string 1 rtnmatch))
14122 (tag (match-string 2 rtnmatch))
14123 (tag (if downcased (downcase tag) tag)))
14124 (setq tml (delete tag tml))
14125 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14126 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14128 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14129 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14130 (if single-as-list
14131 (or (reverse rpl) (list rtnmatch))
14132 rtnmatch))
14133 (if single-as-list (list (if downcased (downcase match) match))
14134 match)))
14136 (defun org-op-to-function (op &optional stringp)
14137 "Turn an operator into the appropriate function."
14138 (setq op
14139 (cond
14140 ((equal op "<" ) '(< string< org-time<))
14141 ((equal op ">" ) '(> org-string> org-time>))
14142 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14143 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14144 ((member op '("=" "==")) '(= string= org-time=))
14145 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14146 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14148 (defun org<> (a b) (not (= a b)))
14149 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14150 (defun org-string>= (a b) (not (string< a b)))
14151 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14152 (defun org-string<> (a b) (not (string= a b)))
14153 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14154 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14155 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14156 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14157 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14158 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14159 (defun org-2ft (s)
14160 "Convert S to a floating point time.
14161 If S is already a number, just return it. If it is a string, parse
14162 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14163 (cond
14164 ((numberp s) s)
14165 ((stringp s)
14166 (condition-case nil
14167 (float-time (apply 'encode-time (org-parse-time-string s)))
14168 (error 0.)))
14169 (t 0.)))
14171 (defun org-time-today ()
14172 "Time in seconds today at 0:00.
14173 Returns the float number of seconds since the beginning of the
14174 epoch to the beginning of today (00:00)."
14175 (float-time (apply 'encode-time
14176 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14178 (defun org-matcher-time (s)
14179 "Interpret a time comparison value."
14180 (save-match-data
14181 (cond
14182 ((string= s "<now>") (float-time))
14183 ((string= s "<today>") (org-time-today))
14184 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14185 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14187 (+ (org-time-today)
14188 (* (string-to-number (match-string 1 s))
14189 (cdr (assoc (match-string 2 s)
14190 '(("d" . 86400.0) ("w" . 604800.0)
14191 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14192 (t (org-2ft s)))))
14194 (defun org-match-any-p (re list)
14195 "Does re match any element of list?"
14196 (setq list (mapcar (lambda (x) (string-match re x)) list))
14197 (delq nil list))
14199 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14200 (defvar org-tags-overlay (make-overlay 1 1))
14201 (org-detach-overlay org-tags-overlay)
14203 (defun org-get-local-tags-at (&optional pos)
14204 "Get a list of tags defined in the current headline."
14205 (org-get-tags-at pos 'local))
14207 (defun org-get-local-tags ()
14208 "Get a list of tags defined in the current headline."
14209 (org-get-tags-at nil 'local))
14211 (defun org-get-tags-at (&optional pos local)
14212 "Get a list of all headline tags applicable at POS.
14213 POS defaults to point. If tags are inherited, the list contains
14214 the targets in the same sequence as the headlines appear, i.e.
14215 the tags of the current headline come last.
14216 When LOCAL is non-nil, only return tags from the current headline,
14217 ignore inherited ones."
14218 (interactive)
14219 (if (and org-trust-scanner-tags
14220 (or (not pos) (equal pos (point)))
14221 (not local))
14222 org-scanner-tags
14223 (let (tags ltags lastpos parent)
14224 (save-excursion
14225 (save-restriction
14226 (widen)
14227 (goto-char (or pos (point)))
14228 (save-match-data
14229 (catch 'done
14230 (condition-case nil
14231 (progn
14232 (org-back-to-heading t)
14233 (while (not (equal lastpos (point)))
14234 (setq lastpos (point))
14235 (when (looking-at
14237 (setq ltags (org-split-string
14238 (org-match-string-no-properties 1) ":"))
14239 (when parent
14240 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14241 (setq tags (append
14242 (if parent
14243 (org-remove-uninherited-tags ltags)
14244 ltags)
14245 tags)))
14246 (or org-use-tag-inheritance (throw 'done t))
14247 (if local (throw 'done t))
14248 (or (org-up-heading-safe) (error nil))
14249 (setq parent t)))
14250 (error nil)))))
14251 (if local
14252 tags
14253 (reverse (delete-dups
14254 (reverse (append
14255 (org-remove-uninherited-tags
14256 org-file-tags) tags)))))))))
14258 (defun org-add-prop-inherited (s)
14259 (add-text-properties 0 (length s) '(inherited t) s)
14260 s)
14262 (defun org-toggle-tag (tag &optional onoff)
14263 "Toggle the tag TAG for the current line.
14264 If ONOFF is `on' or `off', don't toggle but set to this state."
14265 (let (res current)
14266 (save-excursion
14267 (org-back-to-heading t)
14269 (point-at-eol) t)
14270 (progn
14271 (setq current (match-string 1))
14272 (replace-match ""))
14273 (setq current ""))
14274 (setq current (nreverse (org-split-string current ":")))
14275 (cond
14276 ((eq onoff 'on)
14277 (setq res t)
14278 (or (member tag current) (push tag current)))
14279 ((eq onoff 'off)
14280 (or (not (member tag current)) (setq current (delete tag current))))
14281 (t (if (member tag current)
14282 (setq current (delete tag current))
14283 (setq res t)
14284 (push tag current))))
14285 (end-of-line 1)
14286 (if current
14287 (progn
14288 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14289 (org-set-tags nil t))
14290 (delete-horizontal-space))
14291 (run-hooks 'org-after-tags-change-hook))
14292 res))
14294 (defun org-align-tags-here (to-col)
14295 ;; Assumes that this is a headline
14296 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14297 (beginning-of-line 1)
14299 (< pos (match-beginning 2)))
14300 (progn
14301 (setq tags-l (- (match-end 2) (match-beginning 2)))
14302 (goto-char (match-beginning 1))
14303 (insert " ")
14304 (delete-region (point) (1+ (match-beginning 2)))
14305 (setq ncol (max (current-column)
14306 (1+ col)
14307 (if (> to-col 0)
14308 to-col
14309 (- (abs to-col) tags-l))))
14310 (setq p (point))
14311 (insert (make-string (- ncol (current-column)) ?\ ))
14312 (setq ncol (current-column))
14313 (when indent-tabs-mode (tabify p (point-at-eol)))
14314 (org-move-to-column (min ncol col) t))
14315 (goto-char pos))))
14317 (defun org-set-tags-command (&optional arg just-align)
14318 "Call the set-tags command for the current entry."
14319 (interactive "P")
14320 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14321 (org-set-tags arg just-align)
14322 (save-excursion
14323 (unless (and (org-region-active-p)
14324 org-loop-over-headlines-in-active-region)
14325 (org-back-to-heading t))
14326 (org-set-tags arg just-align))))
14328 (defun org-set-tags-to (data)
14329 "Set the tags of the current entry to DATA, replacing the current tags.
14330 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14331 If DATA is nil or the empty string, any tags will be removed."
14332 (interactive "sTags: ")
14333 (setq data
14334 (cond
14335 ((eq data nil) "")
14336 ((equal data "") "")
14337 ((stringp data)
14338 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14339 ":"))
14340 ((listp data)
14341 (concat ":" (mapconcat 'identity data ":") ":"))))
14342 (when data
14343 (save-excursion
14344 (org-back-to-heading t)
14345 (when (looking-at org-complex-heading-regexp)
14346 (if (match-end 5)
14347 (progn
14348 (goto-char (match-beginning 5))
14349 (insert data)
14350 (delete-region (point) (point-at-eol))
14351 (org-set-tags nil 'align))
14352 (goto-char (point-at-eol))
14353 (insert " " data)
14354 (org-set-tags nil 'align)))
14355 (beginning-of-line 1)
14357 (delete-region (match-beginning 1) (match-end 1))))))
14359 (defun org-align-all-tags ()
14360 "Align the tags i all headings."
14361 (interactive)
14362 (save-excursion
14363 (or (ignore-errors (org-back-to-heading t))
14364 (outline-next-heading))
14365 (if (org-at-heading-p)
14366 (org-set-tags t)
14367 (message "No headings"))))
14369 (defvar org-indent-indentation-per-level)
14370 (defun org-set-tags (&optional arg just-align)
14371 "Set the tags for the current headline.
14372 With prefix ARG, realign all tags in headings in the current buffer."
14373 (interactive "P")
14374 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14375 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14376 'region-start-level 'region))
14377 org-loop-over-headlines-in-active-region)
14378 (org-map-entries
14379 ;; We don't use ARG and JUST-ALIGN here these args are not
14380 ;; useful when looping over headlines
14381 `(org-set-tags)
14382 org-loop-over-headlines-in-active-region
14383 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14384 (let* ((re org-outline-regexp-bol)
14385 (current (unless arg (org-get-tags-string)))
14386 (col (current-column))
14387 (org-setting-tags t)
14388 table current-tags inherited-tags ; computed below when needed
14389 tags p0 c0 c1 rpl di tc level)
14390 (if arg
14391 (save-excursion
14392 (goto-char (point-min))
14393 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14394 (while (re-search-forward re nil t)
14395 (org-set-tags nil t)
14396 (end-of-line 1)))
14397 (message "All tags realigned to column %d" org-tags-column))
14398 (if just-align
14399 (setq tags current)
14400 ;; Get a new set of tags from the user
14401 (save-excursion
14402 (setq table (append org-tag-persistent-alist
14403 (or org-tag-alist (org-get-buffer-tags))
14404 (and
14405 org-complete-tags-always-offer-all-agenda-tags
14406 (org-global-tags-completion-table
14407 (org-agenda-files))))
14408 org-last-tags-completion-table table
14409 current-tags (org-split-string current ":")
14410 inherited-tags (nreverse
14411 (nthcdr (length current-tags)
14412 (nreverse (org-get-tags-at))))
14413 tags
14414 (if (or (eq t org-use-fast-tag-selection)
14415 (and org-use-fast-tag-selection
14416 (delq nil (mapcar 'cdr table))))
14417 (org-fast-tag-selection
14418 current-tags inherited-tags table
14419 (if org-fast-tag-selection-include-todo
14420 org-todo-key-alist))
14421 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14422 (org-trim
14423 (org-icompleting-read "Tags: "
14424 'org-tags-completion-function
14425 nil nil current 'org-tags-history))))))
14426 (while (string-match "[-+&]+" tags)
14427 ;; No boolean logic, just a list
14428 (setq tags (replace-match ":" t t tags))))
14430 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14432 (if org-tags-sort-function
14433 (setq tags (mapconcat 'identity
14434 (sort (org-split-string
14435 tags (org-re "[^[:alnum:]_@#%]+"))
14436 org-tags-sort-function) ":")))
14439 (setq tags "")
14440 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14441 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14443 ;; Insert new tags at the correct column
14444 (beginning-of-line 1)
14445 (setq level (or (and (looking-at org-outline-regexp)
14446 (- (match-end 0) (point) 1))
14447 1))
14448 (cond
14449 ((and (equal current "") (equal tags "")))
14450 ((re-search-forward
14452 (point-at-eol) t)
14453 (if (equal tags "")
14454 (setq rpl "")
14455 (goto-char (match-beginning 0))
14456 (setq c0 (current-column)
14457 ;; compute offset for the case of org-indent-mode active
14458 di (if org-indent-mode
14459 (* (1- org-indent-indentation-per-level) (1- level))
14460 0)
14461 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14462 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14463 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14464 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14465 (replace-match rpl t t)
14466 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14467 tags)
14468 (t (error "Tags alignment failed")))
14469 (org-move-to-column col)
14470 (unless just-align
14471 (run-hooks 'org-after-tags-change-hook))))))
14473 (defun org-change-tag-in-region (beg end tag off)
14474 "Add or remove TAG for each entry in the region.
14475 This works in the agenda, and also in an org-mode buffer."
14476 (interactive
14477 (list (region-beginning) (region-end)
14478 (let ((org-last-tags-completion-table
14479 (if (derived-mode-p 'org-mode)
14480 (org-uniquify
14481 (delq nil (append (org-get-buffer-tags)
14482 (org-global-tags-completion-table))))
14483 (org-global-tags-completion-table))))
14484 (org-icompleting-read
14485 "Tag: " 'org-tags-completion-function nil nil nil
14486 'org-tags-history))
14487 (progn
14489 (equal (read-char-exclusive) ?r))))
14490 (if (fboundp 'deactivate-mark) (deactivate-mark))
14491 (let ((agendap (equal major-mode 'org-agenda-mode))
14492 l1 l2 m buf pos newhead (cnt 0))
14493 (goto-char end)
14494 (setq l2 (1- (org-current-line)))
14495 (goto-char beg)
14496 (setq l1 (org-current-line))
14497 (loop for l from l1 to l2 do
14498 (org-goto-line l)
14499 (setq m (get-text-property (point) 'org-hd-marker))
14500 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14501 (and agendap m))
14502 (setq buf (if agendap (marker-buffer m) (current-buffer))
14503 pos (if agendap m (point)))
14504 (with-current-buffer buf
14505 (save-excursion
14506 (save-restriction
14507 (goto-char pos)
14508 (setq cnt (1+ cnt))
14509 (org-toggle-tag tag (if off 'off 'on))
14510 (setq newhead (org-get-heading)))))
14511 (and agendap (org-agenda-change-all-lines newhead m))))
14512 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14514 (defun org-tags-completion-function (string predicate &optional flag)
14515 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14516 (confirm (lambda (x) (stringp (car x)))))
14518 (setq s1 (match-string 1 string)
14519 s2 (match-string 2 string))
14520 (setq s1 "" s2 string))
14521 (cond
14522 ((eq flag nil)
14523 ;; try completion
14524 (setq rtn (try-completion s2 ctable confirm))
14525 (if (stringp rtn)
14526 (setq rtn
14527 (concat s1 s2 (substring rtn (length s2))
14528 (if (and org-add-colon-after-tag-completion
14529 (assoc rtn ctable))
14530 ":" ""))))
14531 rtn)
14532 ((eq flag t)
14533 ;; all-completions
14534 (all-completions s2 ctable confirm))
14535 ((eq flag 'lambda)
14536 ;; exact match?
14537 (assoc s2 ctable)))))
14539 (defun org-fast-tag-insert (kwd tags face &optional end)
14540 "Insert KDW, and the TAGS, the latter with face FACE.
14541 Also insert END."
14542 (insert (format "%-12s" (concat kwd ":"))
14543 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14544 (or end "")))
14546 (defun org-fast-tag-show-exit (flag)
14547 (save-excursion
14548 (org-goto-line 3)
14550 (replace-match ""))
14551 (when flag
14552 (end-of-line 1)
14553 (org-move-to-column (- (window-width) 19) t)
14554 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14556 (defun org-set-current-tags-overlay (current prefix)
14557 "Add an overlay to CURRENT tag with PREFIX."
14558 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14559 (if (featurep 'xemacs)
14560 (org-overlay-display org-tags-overlay (concat prefix s)
14561 'secondary-selection)
14562 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14563 (org-overlay-display org-tags-overlay (concat prefix s)))))
14565 (defvar org-last-tag-selection-key nil)
14566 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14567 "Fast tag selection with single keys.
14568 CURRENT is the current list of tags in the headline, INHERITED is the
14569 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14570 possibly with grouping information. TODO-TABLE is a similar table with
14571 TODO keywords, should these have keys assigned to them.
14572 If the keys are nil, a-z are automatically assigned.
14573 Returns the new tags string, or nil to not change the current settings."
14574 (let* ((fulltable (append table todo-table))
14575 (maxlen (apply 'max (mapcar
14576 (lambda (x)
14577 (if (stringp (car x)) (string-width (car x)) 0))
14578 fulltable)))
14579 (buf (current-buffer))
14580 (expert (eq org-fast-tag-selection-single-key 'expert))
14581 (buffer-tags nil)
14582 (fwidth (+ maxlen 3 1 3))
14583 (ncol (/ (- (window-width) 4) fwidth))
14584 (i-face 'org-done)
14585 (c-face 'org-todo)
14586 tg cnt e c char c1 c2 ntable tbl rtn
14587 ov-start ov-end ov-prefix
14588 (exit-after-next org-fast-tag-selection-single-key)
14589 (done-keywords org-done-keywords)
14590 groups ingroup)
14591 (save-excursion
14592 (beginning-of-line 1)
14593 (if (looking-at
14595 (setq ov-start (match-beginning 1)
14596 ov-end (match-end 1)
14597 ov-prefix "")
14598 (setq ov-start (1- (point-at-eol))
14599 ov-end (1+ ov-start))
14601 (setq ov-prefix
14602 (concat
14603 (buffer-substring (1- (point)) (point))
14604 (if (> (current-column) org-tags-column)
14605 " "
14606 (make-string (- org-tags-column (current-column)) ?\ ))))))
14607 (move-overlay org-tags-overlay ov-start ov-end)
14608 (save-window-excursion
14609 (if expert
14610 (set-buffer (get-buffer-create " *Org tags*"))
14611 (delete-other-windows)
14612 (split-window-vertically)
14613 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14614 (erase-buffer)
14615 (org-set-local 'org-done-keywords done-keywords)
14618 (org-fast-tag-show-exit exit-after-next)
14619 (org-set-current-tags-overlay current ov-prefix)
14620 (setq tbl fulltable char ?a cnt 0)
14621 (while (setq e (pop tbl))
14622 (cond
14623 ((equal (car e) :startgroup)
14624 (push '() groups) (setq ingroup t)
14625 (when (not (= cnt 0))
14626 (setq cnt 0)
14628 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14629 ((equal (car e) :endgroup)
14630 (setq ingroup nil cnt 0)
14632 ((equal e '(:newline))
14633 (when (not (= cnt 0))
14634 (setq cnt 0)
14636 (setq e (car tbl))
14637 (while (equal (car tbl) '(:newline))
14639 (setq tbl (cdr tbl)))))
14640 ((equal e '(:grouptags)) nil)
14641 (t
14642 (setq tg (copy-sequence (car e)) c2 nil)
14643 (if (cdr e)
14644 (setq c (cdr e))
14645 ;; automatically assign a character.
14646 (setq c1 (string-to-char
14647 (downcase (substring
14648 tg (if (= (string-to-char tg) ?@) 1 0)))))
14649 (if (or (rassoc c1 ntable) (rassoc c1 table))
14650 (while (or (rassoc char ntable) (rassoc char table))
14651 (setq char (1+ char)))
14652 (setq c2 c1))
14653 (setq c (or c2 char)))
14654 (if ingroup (push tg (car groups)))
14655 (setq tg (org-add-props tg nil 'face
14656 (cond
14657 ((not (assoc tg table))
14658 (org-get-todo-face tg))
14659 ((member tg current) c-face)
14660 ((member tg inherited) i-face))))
14661 (if (equal (caar tbl) :grouptags)
14662 (org-add-props tg nil 'face 'org-tag-group))
14663 (if (and (= cnt 0) (not ingroup)) (insert " "))
14664 (insert "[" c "] " tg (make-string
14665 (- fwidth 4 (length tg)) ?\ ))
14666 (push (cons tg c) ntable)
14667 (when (= (setq cnt (1+ cnt)) ncol)
14669 (if ingroup (insert " "))
14670 (setq cnt 0)))))
14671 (setq ntable (nreverse ntable))
14673 (goto-char (point-min))
14674 (if (not expert) (org-fit-window-to-buffer))
14675 (setq rtn
14676 (catch 'exit
14677 (while t
14678 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14679 (if (not groups) "no " "")
14680 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14681 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14682 (setq org-last-tag-selection-key c)
14683 (cond
14685 ((= c ?!)
14686 (setq groups (not groups))
14687 (goto-char (point-min))
14688 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14689 ((= c ?\C-c)
14690 (if (not expert)
14691 (org-fast-tag-show-exit
14692 (setq exit-after-next (not exit-after-next)))
14693 (setq expert nil)
14694 (delete-other-windows)
14695 (set-window-buffer (split-window-vertically) " *Org tags*")
14696 (org-switch-to-buffer-other-window " *Org tags*")
14697 (org-fit-window-to-buffer)))
14698 ((or (= c ?\C-g)
14699 (and (= c ?q) (not (rassoc c ntable))))
14700 (org-detach-overlay org-tags-overlay)
14701 (setq quit-flag t))
14702 ((= c ?\ )
14703 (setq current nil)
14704 (if exit-after-next (setq exit-after-next 'now)))
14706 (condition-case nil
14707 (setq tg (org-icompleting-read
14708 "Tag: "
14709 (or buffer-tags
14710 (with-current-buffer buf
14711 (org-get-buffer-tags)))))
14712 (quit (setq tg "")))
14714 (add-to-list 'buffer-tags (list tg))
14715 (if (member tg current)
14716 (setq current (delete tg current))
14717 (push tg current)))
14718 (if exit-after-next (setq exit-after-next 'now)))
14719 ((setq e (rassoc c todo-table) tg (car e))
14720 (with-current-buffer buf
14721 (save-excursion (org-todo tg)))
14722 (if exit-after-next (setq exit-after-next 'now)))
14723 ((setq e (rassoc c ntable) tg (car e))
14724 (if (member tg current)
14725 (setq current (delete tg current))
14726 (loop for g in groups do
14727 (if (member tg g)
14728 (mapc (lambda (x)
14729 (setq current (delete x current)))
14730 g)))
14731 (push tg current))
14732 (if exit-after-next (setq exit-after-next 'now))))
14734 ;; Create a sorted list
14735 (setq current
14736 (sort current
14737 (lambda (a b)
14738 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14739 (if (eq exit-after-next 'now) (throw 'exit t))
14740 (goto-char (point-min))
14741 (beginning-of-line 2)
14742 (delete-region (point) (point-at-eol))
14743 (org-fast-tag-insert "Current" current c-face)
14744 (org-set-current-tags-overlay current ov-prefix)
14745 (while (re-search-forward
14747 (setq tg (match-string 1))
14748 (add-text-properties
14749 (match-beginning 1) (match-end 1)
14750 (list 'face
14751 (cond
14752 ((member tg current) c-face)
14753 ((member tg inherited) i-face)
14754 (t (get-text-property (match-beginning 1) 'face))))))
14755 (goto-char (point-min)))))
14756 (org-detach-overlay org-tags-overlay)
14757 (if rtn
14758 (mapconcat 'identity current ":")
14759 nil))))
14761 (defun org-get-tags-string ()
14762 "Get the TAGS string in the current headline."
14763 (unless (org-at-heading-p t)
14764 (error "Not on a heading"))
14765 (save-excursion
14766 (beginning-of-line 1)
14768 (org-match-string-no-properties 1)
14769 "")))
14771 (defun org-get-tags ()
14772 "Get the list of tags specified in the current headline."
14773 (org-split-string (org-get-tags-string) ":"))
14775 (defun org-get-buffer-tags ()
14776 "Get a table of all tags used in the buffer, for completion."
14777 (let (tags)
14778 (save-excursion
14779 (goto-char (point-min))
14780 (while (re-search-forward
14782 (when (equal (char-after (point-at-bol 0)) ?*)
14783 (mapc (lambda (x) (add-to-list 'tags x))
14784 (org-split-string (org-match-string-no-properties 1) ":")))))
14785 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14786 (mapcar 'list tags)))
14788 ;;;; The mapping API
14790 (defun org-map-entries (func &optional match scope &rest skip)
14791 "Call FUNC at each headline selected by MATCH in SCOPE.
14793 FUNC is a function or a lisp form. The function will be called without
14794 arguments, with the cursor positioned at the beginning of the headline.
14795 The return values of all calls to the function will be collected and
14796 returned as a list.
14798 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14799 does not need to preserve point. After evaluation, the cursor will be
14800 moved to the end of the line (presumably of the headline of the
14801 processed entry) and search continues from there. Under some
14802 circumstances, this may not produce the wanted results. For example,
14803 if you have removed (e.g. archived) the current (sub)tree it could
14804 mean that the next entry will be skipped entirely. In such cases, you
14805 can specify the position from where search should continue by making
14806 FUNC set the variable `org-map-continue-from' to the desired buffer
14807 position.
14809 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14810 Only headlines that are matched by this query will be considered during
14811 the iteration. When MATCH is nil or t, all headlines will be
14812 visited by the iteration.
14814 SCOPE determines the scope of this command. It can be any of:
14816 nil The current buffer, respecting the restriction if any
14817 tree The subtree started with the entry at point
14818 region The entries within the active region, if any
14819 region-start-level
14820 The entries within the active region, but only those at
14821 the same level than the first one.
14822 file The current buffer, without restriction
14823 file-with-archives
14824 The current buffer, and any archives associated with it
14825 agenda All agenda files
14826 agenda-with-archives
14827 All agenda files with any archive files associated with them
14828 \(file1 file2 ...)
14829 If this is a list, all files in the list will be scanned
14831 The remaining args are treated as settings for the skipping facilities of
14832 the scanner. The following items can be given here:
14834 archive skip trees with the archive tag
14835 comment skip trees with the COMMENT keyword
14836 function or Emacs Lisp form:
14837 will be used as value for `org-agenda-skip-function', so
14838 whenever the function returns a position, FUNC will not be
14839 called for that entry and search will continue from the
14840 position returned
14842 If your function needs to retrieve the tags including inherited tags
14843 at the *current* entry, you can use the value of the variable
14844 `org-scanner-tags' which will be much faster than getting the value
14845 with `org-get-tags-at'. If your function gets properties with
14846 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14847 to t around the call to `org-entry-properties' to get the same speedup.
14848 Note that if your function moves around to retrieve tags and properties at
14849 a *different* entry, you cannot use these techniques."
14850 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14851 (not (org-region-active-p)))
14852 (let* ((org-agenda-archives-mode nil) ; just to make sure
14853 (org-agenda-skip-archived-trees (memq 'archive skip))
14854 (org-agenda-skip-comment-trees (memq 'comment skip))
14855 (org-agenda-skip-function
14856 (car (org-delete-all '(comment archive) skip)))
14857 (org-tags-match-list-sublevels t)
14858 (start-level (eq scope 'region-start-level))
14859 matcher file res
14860 org-todo-keywords-for-agenda
14861 org-done-keywords-for-agenda
14862 org-todo-keyword-alist-for-agenda
14863 org-drawers-for-agenda
14864 org-tag-alist-for-agenda
14865 todo-only)
14867 (cond
14868 ((eq match t) (setq matcher t))
14869 ((eq match nil) (setq matcher t))
14870 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14872 (save-window-excursion
14873 (save-restriction
14874 (cond ((eq scope 'tree)
14875 (org-back-to-heading t)
14876 (org-narrow-to-subtree)
14877 (setq scope nil))
14878 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14879 (org-region-active-p))
14880 ;; If needed, set start-level to a string like "2"
14881 (when start-level
14882 (save-excursion
14883 (goto-char (region-beginning))
14884 (unless (org-at-heading-p) (outline-next-heading))
14885 (setq start-level (org-current-level))))
14886 (narrow-to-region (region-beginning)
14887 (save-excursion
14888 (goto-char (region-end))
14889 (unless (and (bolp) (org-at-heading-p))
14890 (outline-next-heading))
14891 (point)))
14892 (setq scope nil)))
14894 (if (not scope)
14895 (progn
14896 (org-agenda-prepare-buffers
14897 (list (buffer-file-name (current-buffer))))
14898 (setq res (org-scan-tags func matcher todo-only start-level)))
14899 ;; Get the right scope
14900 (cond
14901 ((and scope (listp scope) (symbolp (car scope)))
14902 (setq scope (eval scope)))
14903 ((eq scope 'agenda)
14904 (setq scope (org-agenda-files t)))
14905 ((eq scope 'agenda-with-archives)
14906 (setq scope (org-agenda-files t))
14907 (setq scope (org-add-archive-files scope)))
14908 ((eq scope 'file)
14909 (setq scope (list (buffer-file-name))))
14910 ((eq scope 'file-with-archives)
14911 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14912 (org-agenda-prepare-buffers scope)
14913 (while (setq file (pop scope))
14914 (with-current-buffer (org-find-base-buffer-visiting file)
14915 (save-excursion
14916 (save-restriction
14917 (widen)
14918 (goto-char (point-min))
14919 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14920 res)))
14922 ;;;; Properties
14924 ;;; Setting and retrieving properties
14926 (defconst org-special-properties
14927 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14928 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14929 "The special properties valid in Org-mode.
14931 These are properties that are not defined in the property drawer,
14932 but in some other way.")
14934 (defconst org-default-properties
14935 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14936 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14937 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14938 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14939 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14940 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14941 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14942 "Some properties that are used by Org-mode for various purposes.
14943 Being in this list makes sure that they are offered for completion.")
14946 "Regular expression matching the first line of a property drawer.")
14949 "Regular expression matching the last line of a property drawer.")
14952 "Regular expression matching the first line of a property drawer.")
14955 "Regular expression matching the first line of a property drawer.")
14957 (defconst org-property-drawer-re
14960 "Matches an entire property drawer.")
14962 (defconst org-clock-drawer-re
14965 "Matches an entire clock drawer.")
14967 (defsubst org-re-property (property)
14968 "Return a regexp matching a PROPERTY line.
14969 Match group 1 will be set to the value."
14972 (defsubst org-re-property-keyword (property)
14973 "Return a regexp matching a PROPERTY line, possibly with no
14974 value for the property."
14977 (defun org-property-action ()
14978 "Do an action on properties."
14979 (interactive)
14980 (let (c)
14981 (org-at-property-p)
14982 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14983 (setq c (read-char-exclusive))
14984 (cond
14985 ((equal c ?s)
14986 (call-interactively 'org-set-property))
14987 ((equal c ?d)
14988 (call-interactively 'org-delete-property))
14989 ((equal c ?D)
14990 (call-interactively 'org-delete-property-globally))
14991 ((equal c ?c)
14992 (call-interactively 'org-compute-property-at-point))
14993 (t (error "No such property action %c" c)))))
14995 (defun org-inc-effort ()
14996 "Increment the value of the effort property in the current entry."
14997 (interactive)
14998 (org-set-effort nil t))
15000 (defvar org-clock-effort) ;; Defined in org-clock.el
15001 (defvar org-clock-current-task) ;; Defined in org-clock.el
15002 (defun org-set-effort (&optional value increment)
15003 "Set the effort property of the current entry.
15004 With numerical prefix arg, use the nth allowed value, 0 stands for the
15005 10th allowed value.
15007 When INCREMENT is non-nil, set the property to the next allowed value."
15008 (interactive "P")
15009 (if (equal value 0) (setq value 10))
15010 (let* ((completion-ignore-case t)
15011 (prop org-effort-property)
15012 (cur (org-entry-get nil prop))
15013 (allowed (org-property-get-allowed-values nil prop 'table))
15014 (existing (mapcar 'list (org-property-values prop)))
15015 (heading (nth 4 (org-heading-components)))
15016 rpl
15017 (val (cond
15018 ((stringp value) value)
15019 ((and allowed (integerp value))
15020 (or (car (nth (1- value) allowed))
15021 (car (org-last allowed))))
15022 ((and allowed increment)
15023 (or (caadr (member (list cur) allowed))
15024 (error "Allowed effort values are not set")))
15025 (allowed
15026 (message "Select 1-9,0, [RET%s]: %s"
15027 (if cur (concat "=" cur) "")
15028 (mapconcat 'car allowed " "))
15029 (setq rpl (read-char-exclusive))
15031 cur
15032 (setq rpl (- rpl ?0))
15033 (if (equal rpl 0) (setq rpl 10))
15034 (if (and (> rpl 0) (<= rpl (length allowed)))
15035 (car (nth (1- rpl) allowed))
15036 (org-completing-read "Effort: " allowed nil))))
15037 (t
15038 (let (org-completion-use-ido org-completion-use-iswitchb)
15039 (org-completing-read
15041 (concat "[" cur "]") "")
15042 ": ")
15043 existing nil nil "" nil cur))))))
15044 (unless (equal (org-entry-get nil prop) val)
15045 (org-entry-put nil prop val))
15046 (save-excursion
15047 (org-back-to-heading t)
15048 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15049 (when (string= heading org-clock-current-task)
15050 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15051 (org-clock-update-mode-line))
15052 (message "%s is now %s" prop val)))
15054 (defun org-at-property-p ()
15055 "Is cursor inside a property drawer?"
15056 (save-excursion
15057 (beginning-of-line 1)
15059 (save-match-data ;; Used by calling procedures
15060 (let ((p (point))
15061 (range (unless (org-before-first-heading-p)
15062 (org-get-property-block))))
15063 (and range (<= (car range) p) (< p (cdr range))))))))
15065 (defun org-get-property-block (&optional beg end force)
15066 "Return the (beg . end) range of the body of the property drawer.
15067 BEG and END are the beginning and end of the current subtree, or of
15068 the part before the first headline. If they are not given, they will
15069 be found. If the drawer does not exist and FORCE is non-nil, create
15070 the drawer."
15071 (catch 'exit
15072 (save-excursion
15073 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15074 (progn (org-back-to-heading t) (point))))
15075 (end (or end (and (not (outline-next-heading)) (point-max))
15076 (point))))
15077 (goto-char beg)
15078 (if (re-search-forward org-property-start-re end t)
15079 (setq beg (1+ (match-end 0)))
15080 (if force
15081 (save-excursion
15082 (org-insert-property-drawer)
15083 (setq end (progn (outline-next-heading) (point))))
15084 (throw 'exit nil))
15085 (goto-char beg)
15086 (if (re-search-forward org-property-start-re end t)
15087 (setq beg (1+ (match-end 0)))))
15088 (if (re-search-forward org-property-end-re end t)
15089 (setq end (match-beginning 0))
15090 (or force (throw 'exit nil))
15091 (goto-char beg)
15092 (setq end beg)
15093 (org-indent-line)
15095 (cons beg end)))))
15097 (defun org-entry-properties (&optional pom which specific)
15098 "Get all properties of the entry at point-or-marker POM.
15099 This includes the TODO keyword, the tags, time strings for deadline,
15100 scheduled, and clocking, and any additional properties defined in the
15101 entry. The return value is an alist, keys may occur multiple times
15102 if the property key was used several times.
15103 POM may also be nil, in which case the current entry is used.
15104 If WHICH is nil or `all', get all properties. If WHICH is
15105 `special' or `standard', only get that subclass. If WHICH
15106 is a string only get exactly this property. SPECIFIC can be a string, the
15107 specific property we are interested in. Specifying it can speed
15108 things up because then unnecessary parsing is avoided."
15109 (setq which (or which 'all))
15110 (org-with-point-at pom
15111 (let ((clockstr (substring org-clock-string 0 -1))
15112 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15113 (case-fold-search nil)
15114 beg end range props sum-props key key1 value string clocksum clocksumt)
15115 (save-excursion
15116 (when (condition-case nil
15117 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15118 (error nil))
15119 (setq beg (point))
15120 (setq sum-props (get-text-property (point) 'org-summaries))
15121 (setq clocksum (get-text-property (point) :org-clock-minutes)
15122 clocksumt (get-text-property (point) :org-clock-minutes-today))
15123 (outline-next-heading)
15124 (setq end (point))
15125 (when (memq which '(all special))
15126 ;; Get the special properties, like TODO and tags
15127 (goto-char beg)
15128 (when (and (or (not specific) (string= specific "TODO"))
15129 (looking-at org-todo-line-regexp) (match-end 2))
15130 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15131 (when (and (or (not specific) (string= specific "PRIORITY"))
15132 (looking-at org-priority-regexp))
15133 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15134 (when (or (not specific) (string= specific "FILE"))
15135 (push (cons "FILE" buffer-file-name) props))
15136 (when (and (or (not specific) (string= specific "TAGS"))
15137 (setq value (org-get-tags-string))
15139 (push (cons "TAGS" value) props))
15140 (when (and (or (not specific) (string= specific "ALLTAGS"))
15141 (setq value (org-get-tags-at)))
15142 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15143 ":"))
15144 props))
15145 (when (or (not specific) (string= specific "BLOCKED"))
15146 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15147 (when (or (not specific)
15148 (member specific
15149 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15150 "TIMESTAMP" "TIMESTAMP_IA")))
15151 (catch 'match
15152 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15153 (setq key (if (match-end 1)
15154 (substring (org-match-string-no-properties 1)
15155 0 -1))
15156 string (if (equal key clockstr)
15157 (org-trim
15158 (buffer-substring-no-properties
15159 (match-beginning 3) (goto-char
15160 (point-at-eol))))
15161 (substring (org-match-string-no-properties 3)
15162 1 -1)))
15163 ;; Get the correct property name from the key. This is
15164 ;; necessary if the user has configured time keywords.
15165 (setq key1 (concat key ":"))
15166 (cond
15167 ((not key)
15168 (setq key
15169 (if (= (char-after (match-beginning 3)) ?\[)
15170 "TIMESTAMP_IA" "TIMESTAMP")))
15171 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15172 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15173 ((equal key1 org-closed-string) (setq key "CLOSED"))
15174 ((equal key1 org-clock-string) (setq key "CLOCK")))
15175 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15176 (progn
15177 (push (cons key string) props)
15178 ;; no need to search further if match is found
15179 (throw 'match t))
15180 (when (or (equal key "CLOCK") (not (assoc key props)))
15181 (push (cons key string) props)))))))
15183 (when (memq which '(all standard))
15184 ;; Get the standard properties, like :PROP: ...
15185 (setq range (org-get-property-block beg end))
15186 (when range
15187 (goto-char (car range))
15188 (while (re-search-forward
15190 (cdr range) t)
15191 (setq key (org-match-string-no-properties 1)
15192 value (org-trim (or (org-match-string-no-properties 2) "")))
15193 (unless (member key excluded)
15194 (push (cons key (or value "")) props)))))
15195 (if clocksum
15196 (push (cons "CLOCKSUM"
15197 (org-columns-number-to-string (/ (float clocksum) 60.)
15198 'add_times))
15199 props))
15200 (if clocksumt
15201 (push (cons "CLOCKSUM_T"
15202 (org-columns-number-to-string (/ (float clocksumt) 60.)
15203 'add_times))
15204 props))
15205 (unless (assoc "CATEGORY" props)
15206 (push (cons "CATEGORY" (org-get-category)) props))
15207 (append sum-props (nreverse props)))))))
15209 (defun org-entry-get (pom property &optional inherit literal-nil)
15210 "Get value of PROPERTY for entry or content at point-or-marker POM.
15211 If INHERIT is non-nil and the entry does not have the property,
15212 then also check higher levels of the hierarchy.
15213 If INHERIT is the symbol `selective', use inheritance only if the setting
15214 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15215 If the property is present but empty, the return value is the empty string.
15216 If the property is not present at all, nil is returned.
15219 do not interpret it as the list atom nil. This is used for inheritance
15221 (org-with-point-at pom
15222 (if (and inherit (if (eq inherit 'selective)
15223 (org-property-inherit-p property)
15224 t))
15225 (org-entry-get-with-inheritance property literal-nil)
15226 (if (member property org-special-properties)
15227 ;; We need a special property. Use `org-entry-properties' to
15228 ;; retrieve it, but specify the wanted property
15229 (cdr (assoc property (org-entry-properties nil 'special property)))
15230 (let ((range (org-get-property-block)))
15231 (when (and range (not (eq (car range) (cdr range))))
15232 (let* ((props (list (or (assoc property org-file-properties)
15233 (assoc property org-global-properties)
15234 (assoc property org-global-properties-fixed))))
15235 (ap (lambda (key)
15236 (when (re-search-forward
15237 (org-re-property key) (cdr range) t)
15238 (setq props
15239 (org-update-property-plist
15240 key
15241 (if (match-end 1)
15242 (org-match-string-no-properties 1) "")
15243 props)))))
15244 val)
15245 (goto-char (car range))
15246 (funcall ap property)
15247 (goto-char (car range))
15248 (while (funcall ap (concat property "+")))
15249 (setq val (cdr (assoc property props)))
15250 (when val (if literal-nil val (org-not-nil val))))))))))
15252 (defun org-property-or-variable-value (var &optional inherit)
15253 "Check if there is a property fixing the value of VAR.
15254 If yes, return this value. If not, return the current value of the variable."
15255 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15257 (read prop)
15258 (symbol-value var))))
15260 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15261 "Delete the property PROPERTY from entry at point-or-marker POM.
15262 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15263 an empty drawer to delete."
15264 (org-with-point-at pom
15265 (if (member property org-special-properties)
15266 nil ; cannot delete these properties.
15267 (let ((range (org-get-property-block)))
15268 (if (and range
15269 (goto-char (car range))
15270 (re-search-forward
15271 (org-re-property property)
15272 (cdr range) t))
15273 (progn
15274 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15275 (and delete-empty-drawer
15276 (org-remove-empty-drawer-at
15277 delete-empty-drawer (car range)))
15278 t)
15279 nil)))))
15281 ;; Multi-values properties are properties that contain multiple values
15282 ;; These values are assumed to be single words, separated by whitespace.
15283 (defun org-entry-add-to-multivalued-property (pom property value)
15284 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15285 (let* ((old (org-entry-get pom property))
15287 (setq value (org-entry-protect-space value))
15288 (unless (member value values)
15289 (setq values (append values (list value)))
15290 (org-entry-put pom property
15291 (mapconcat 'identity values " ")))))
15293 (defun org-entry-remove-from-multivalued-property (pom property value)
15294 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15295 (let* ((old (org-entry-get pom property))
15297 (setq value (org-entry-protect-space value))
15298 (when (member value values)
15299 (setq values (delete value values))
15300 (org-entry-put pom property
15301 (mapconcat 'identity values " ")))))
15303 (defun org-entry-member-in-multivalued-property (pom property value)
15304 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15305 (let* ((old (org-entry-get pom property))
15307 (setq value (org-entry-protect-space value))
15308 (member value values)))
15310 (defun org-entry-get-multivalued-property (pom property)
15311 "Return a list of values in a multivalued property."
15312 (let* ((value (org-entry-get pom property))
15314 (mapcar 'org-entry-restore-space values)))
15316 (defun org-entry-put-multivalued-property (pom property &rest values)
15317 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15318 VALUES should be a list of strings. Spaces will be protected."
15319 (org-entry-put pom property
15320 (mapconcat 'org-entry-protect-space values " "))
15321 (let* ((value (org-entry-get pom property))
15323 (mapcar 'org-entry-restore-space values)))
15325 (defun org-entry-protect-space (s)
15326 "Protect spaces and newline in string S."
15327 (while (string-match " " s)
15328 (setq s (replace-match "%20" t t s)))
15330 (setq s (replace-match "%0A" t t s)))
15331 s)
15333 (defun org-entry-restore-space (s)
15334 "Restore spaces and newline in string S."
15335 (while (string-match "%20" s)
15336 (setq s (replace-match " " t t s)))
15337 (while (string-match "%0A" s)
15339 s)
15341 (defvar org-entry-property-inherited-from (make-marker)
15342 "Marker pointing to the entry from where a property was inherited.
15343 Each call to `org-entry-get-with-inheritance' will set this marker to the
15344 location of the entry where the inheritance search matched. If there was
15345 no match, the marker will point nowhere.
15346 Note that also `org-entry-get' calls this function, if the INHERIT flag
15347 is set.")
15349 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15350 "Get PROPERTY of entry or content at point, search higher levels if needed.
15351 The search will stop at the first ancestor which has the property defined.
15353 should be considered as undefined (this is the meaning of nil here).
15355 (move-marker org-entry-property-inherited-from nil)
15356 (let (tmp)
15357 (save-excursion
15358 (save-restriction
15359 (widen)
15360 (catch 'ex
15361 (while t
15362 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15363 (or (ignore-errors (org-back-to-heading t))
15364 (goto-char (point-min)))
15365 (move-marker org-entry-property-inherited-from (point))
15366 (throw 'ex tmp))
15367 (or (ignore-errors (org-up-heading-safe))
15368 (throw 'ex nil))))))
15369 (setq tmp (or tmp
15370 (cdr (assoc property org-file-properties))
15371 (cdr (assoc property org-global-properties))
15372 (cdr (assoc property org-global-properties-fixed))))
15373 (if literal-nil tmp (org-not-nil tmp))))
15375 (defvar org-property-changed-functions nil
15376 "Hook called when the value of a property has changed.
15377 Each hook function should accept two arguments, the name of the property
15378 and the new value.")
15380 (defun org-entry-put (pom property value)
15381 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15382 (org-with-point-at pom
15383 (org-back-to-heading t)
15384 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15385 range)
15386 (cond
15387 ((equal property "TODO")
15389 (not (member value org-todo-keywords-1)))
15391 (if (or (not value)
15393 (setq value 'none))
15394 (org-todo value)
15395 (org-set-tags nil 'align))
15396 ((equal property "PRIORITY")
15398 (string-to-char value) ?\ ))
15399 (org-set-tags nil 'align))
15400 ((equal property "CLOCKSUM")
15401 (if (not (re-search-forward
15403 (error "Cannot find a clock log")
15404 (goto-char (- (match-end 1) 2))
15405 (cond
15406 ((eq value 'earlier) (org-timestamp-down))
15407 ((eq value 'later) (org-timestamp-up)))
15408 (org-clock-sum-current-item)))
15409 ((equal property "SCHEDULED")
15410 (if (re-search-forward org-scheduled-time-regexp end t)
15411 (cond
15412 ((eq value 'earlier) (org-timestamp-change -1 'day))
15413 ((eq value 'later) (org-timestamp-change 1 'day))
15414 (t (call-interactively 'org-schedule)))
15415 (call-interactively 'org-schedule)))
15416 ((equal property "DEADLINE")
15417 (if (re-search-forward org-deadline-time-regexp end t)
15418 (cond
15419 ((eq value 'earlier) (org-timestamp-change -1 'day))
15420 ((eq value 'later) (org-timestamp-change 1 'day))
15421 (t (call-interactively 'org-deadline)))
15422 (call-interactively 'org-deadline)))
15423 ((member property org-special-properties)
15424 (error "The %s property can not yet be set with `org-entry-put'"
15425 property))
15426 (t ; a non-special property
15427 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15428 (setq range (org-get-property-block beg end 'force))
15429 (goto-char (car range))
15430 (if (re-search-forward
15431 (org-re-property-keyword property) (cdr range) t)
15432 (progn
15433 (delete-region (match-beginning 0) (match-end 0))
15434 (goto-char (match-beginning 0)))
15435 (goto-char (cdr range))
15437 (backward-char 1)
15438 (org-indent-line))
15439 (insert ":" property ":")
15440 (and value (insert " " value))
15441 (org-indent-line)))))
15442 (run-hook-with-args 'org-property-changed-functions property value)))
15444 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15445 "Get all property keys in the current buffer.
15446 With INCLUDE-SPECIALS, also list the special properties that reflect things
15447 like tags and TODO state.
15448 With INCLUDE-DEFAULTS, also include properties that has special meaning
15449 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15450 and others.
15451 With INCLUDE-COLUMNS, also include property names given in COLUMN
15452 formats in the current buffer."
15453 (let (rtn range cfmt s p)
15454 (save-excursion
15455 (save-restriction
15456 (widen)
15457 (goto-char (point-min))
15458 (while (re-search-forward org-property-start-re nil t)
15459 (setq range (org-get-property-block))
15460 (goto-char (car range))
15461 (while (re-search-forward
15463 (cdr range) t)
15464 (add-to-list 'rtn (org-match-string-no-properties 1)))
15465 (outline-next-heading))))
15467 (when include-specials
15468 (setq rtn (append org-special-properties rtn)))
15470 (when include-defaults
15471 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15472 (add-to-list 'rtn org-effort-property))
15474 (when include-columns
15475 (save-excursion
15476 (save-restriction
15477 (widen)
15478 (goto-char (point-min))
15479 (while (re-search-forward
15481 nil t)
15482 (setq cfmt (match-string 2) s 0)
15484 cfmt s)
15485 (setq s (match-end 0)
15486 p (match-string 1 cfmt))
15487 (unless (or (equal p "ITEM")
15488 (member p org-special-properties))
15489 (add-to-list 'rtn (match-string 1 cfmt))))))))
15491 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15493 (defun org-property-values (key)
15494 "Return a list of all values of property KEY in the current buffer."
15495 (save-excursion
15496 (save-restriction
15497 (widen)
15498 (goto-char (point-min))
15499 (let ((re (org-re-property key))
15500 values)
15501 (while (re-search-forward re nil t)
15502 (add-to-list 'values (org-trim (match-string 1))))
15503 (delete "" values)))))
15505 (defun org-insert-property-drawer ()
15506 "Insert a property drawer into the current entry."
15507 (org-back-to-heading t)
15508 (looking-at org-outline-regexp)
15509 (let ((indent (if org-adapt-indentation
15510 (- (match-end 0) (match-beginning 0))
15511 0))
15512 (beg (point))
15514 end hiddenp)
15515 (outline-next-heading)
15516 (setq end (point))
15517 (goto-char beg)
15518 (while (re-search-forward re end t))
15519 (setq hiddenp (outline-invisible-p))
15520 (end-of-line 1)
15523 (if (member (match-string 1) '("CLOCK:" ":END:"))
15524 ;; just skip this line
15525 (beginning-of-line 2)
15526 ;; Drawer start, find the end
15528 (beginning-of-line 1)))
15529 (org-skip-over-state-notes)
15531 (if (eq (char-before) ?*) (forward-char 1))
15533 (beginning-of-line 0)
15534 (org-indent-to-column indent)
15535 (beginning-of-line 2)
15536 (org-indent-to-column indent)
15537 (beginning-of-line 0)
15538 (if hiddenp
15539 (save-excursion
15540 (org-back-to-heading t)
15541 (hide-entry))
15542 (org-flag-drawer t))))
15544 (defun org-insert-drawer (&optional arg drawer)
15545 "Insert a drawer at point.
15547 Optional argument DRAWER, when non-nil, is a string representing
15548 drawer's name. Otherwise, the user is prompted for a name.
15550 If a region is active, insert the drawer around that region
15551 instead.
15553 Point is left between drawer's boundaries."
15554 (interactive "P")
15555 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15556 "LOGBOOK"))
15557 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15558 ;; internally by Org. They are meant to be inserted
15559 ;; automatically.
15560 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15561 ;; Remove system drawers from list. Note: For some reason,
15562 ;; `org-completing-read' ignores the predicate while
15563 ;; `completing-read' handles it fine.
15564 (drawer (if arg "PROPERTIES"
15565 (or drawer
15566 (completing-read
15567 "Drawer: " org-drawers
15568 (lambda (d) (not (member d system-drawers))))))))
15569 (cond
15570 ;; With C-u, fall back on `org-insert-property-drawer'
15571 (arg (org-insert-property-drawer))
15572 ;; With an active region, insert a drawer at point.
15573 ((not (org-region-active-p))
15574 (progn
15577 (forward-line -2)))
15578 ;; Otherwise, insert the drawer at point
15579 (t
15580 (let ((rbeg (region-beginning))
15581 (rend (copy-marker (region-end))))
15582 (unwind-protect
15583 (progn
15584 (goto-char rbeg)
15585 (beginning-of-line)
15586 (when (save-excursion
15587 (re-search-forward org-outline-regexp-bol rend t))
15588 (error "Drawers cannot contain headlines"))
15589 ;; Position point at the beginning of the first
15590 ;; non-blank line in region. Insert drawer's opening
15591 ;; there, then indent it.
15592 (org-skip-whitespace)
15593 (beginning-of-line)
15595 (forward-line -1)
15596 (indent-for-tab-command)
15597 ;; Move point to the beginning of the first blank line
15598 ;; after the last non-blank line in region. Insert
15599 ;; drawer's closing, then indent it.
15600 (goto-char rend)
15603 (deactivate-mark t)
15604 (indent-for-tab-command)
15606 ;; Clear marker, whatever the outcome of insertion is.
15607 (set-marker rend nil)))))))
15609 (defvar org-property-set-functions-alist nil
15610 "Property set function alist.
15611 Each entry should have the following format:
15613 (PROPERTY . READ-FUNCTION)
15615 The read function will be called with the same argument as
15616 `org-completing-read'.")
15618 (defun org-set-property-function (property)
15619 "Get the function that should be used to set PROPERTY.
15620 This is computed according to `org-property-set-functions-alist'."
15621 (or (cdr (assoc property org-property-set-functions-alist))
15622 'org-completing-read))
15624 (defun org-read-property-value (property)
15625 "Read PROPERTY value from user."
15626 (let* ((completion-ignore-case t)
15627 (allowed (org-property-get-allowed-values nil property 'table))
15628 (cur (org-entry-get nil property))
15629 (prompt (concat property " value"
15631 (concat " [" cur "]") "") ": "))
15632 (set-function (org-set-property-function property))
15633 (val (if allowed
15634 (funcall set-function prompt allowed nil
15635 (not (get-text-property 0 'org-unrestricted
15636 (caar allowed))))
15637 (let (org-completion-use-ido org-completion-use-iswitchb)
15638 (funcall set-function prompt
15639 (mapcar 'list (org-property-values property))
15640 nil nil "" nil cur)))))
15641 (if (equal val "")
15642 cur
15643 val)))
15645 (defvar org-last-set-property nil)
15646 (defvar org-last-set-property-value nil)
15647 (defun org-read-property-name ()
15648 "Read a property name."
15649 (let* ((completion-ignore-case t)
15650 (keys (org-buffer-property-keys nil t t))
15651 (default-prop (or (save-excursion
15652 (save-match-data
15653 (beginning-of-line)
15655 (null (string= (match-string 1) "END"))
15656 (match-string 1))))
15657 org-last-set-property))
15658 (property (org-icompleting-read
15659 (concat "Property"
15660 (if default-prop (concat " [" default-prop "]") "")
15661 ": ")
15662 (mapcar 'list keys)
15663 nil nil nil nil
15664 default-prop)))
15665 (if (member property keys)
15666 property
15667 (or (cdr (assoc (downcase property)
15668 (mapcar (lambda (x) (cons (downcase x) x))
15669 keys)))
15670 property))))
15672 (defun org-set-property-and-value (use-last)
15673 "Allow to set [PROPERTY]: [value] direction from prompt.
15674 When use-default, don't even ask, just use the last
15676 (interactive "P")
15677 (let* ((completion-ignore-case t)
15678 (pv (or (and use-last org-last-set-property-value)
15679 (org-completing-read
15681 nil nil nil nil nil
15682 org-last-set-property-value)))
15683 prop val)
15685 (setq prop (match-string 1 pv)
15686 val (match-string 2 pv))
15687 (org-set-property prop val))))
15689 (defun org-set-property (property value)
15690 "In the current entry, set PROPERTY to VALUE.
15691 When called interactively, this will prompt for a property name, offering
15692 completion on existing and default properties. And then it will prompt
15693 for a value, offering completion either on allowed values (via an inherited
15694 xxx_ALL property) or on existing values in other instances of this property
15695 in the current file."
15696 (interactive (list nil nil))
15697 (let* ((property (or property (org-read-property-name)))
15698 (value (or value (org-read-property-value property)))
15699 (fn (cdr (assoc property org-properties-postprocess-alist))))
15700 (setq org-last-set-property property)
15701 (setq org-last-set-property-value (concat property ": " value))
15702 ;; Possibly postprocess the inserted value:
15703 (when fn (setq value (funcall fn value)))
15704 (unless (equal (org-entry-get nil property) value)
15705 (org-entry-put nil property value))))
15707 (defun org-delete-property (property &optional delete-empty-drawer)
15708 "In the current entry, delete PROPERTY.
15709 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15710 an empty drawer to delete."
15711 (interactive
15712 (let* ((completion-ignore-case t)
15713 (prop (org-icompleting-read "Property: "
15714 (org-entry-properties nil 'standard))))
15715 (list prop)))
15716 (message "Property %s %s" property
15717 (if (org-entry-delete nil property delete-empty-drawer)
15718 "deleted"
15719 "was not present in the entry")))
15721 (defun org-delete-property-globally (property)
15722 "Remove PROPERTY globally, from all entries."
15723 (interactive
15724 (let* ((completion-ignore-case t)
15725 (prop (org-icompleting-read
15726 "Globally remove property: "
15727 (mapcar 'list (org-buffer-property-keys)))))
15728 (list prop)))
15729 (save-excursion
15730 (save-restriction
15731 (widen)
15732 (goto-char (point-min))
15733 (let ((cnt 0))
15734 (while (re-search-forward
15735 (org-re-property property)
15736 nil t)
15737 (setq cnt (1+ cnt))
15738 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15741 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15743 (defun org-compute-property-at-point ()
15744 "Compute the property at point.
15745 This looks for an enclosing column format, extracts the operator and
15746 then applies it to the property in the column format's scope."
15747 (interactive)
15748 (unless (org-at-property-p)
15749 (error "Not at a property"))
15750 (let ((prop (org-match-string-no-properties 2)))
15751 (org-columns-get-format-and-top-level)
15752 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15753 (error "No operator defined for property %s" prop))
15754 (org-columns-compute prop)))
15756 (defvar org-property-allowed-value-functions nil
15757 "Hook for functions supplying allowed values for a specific property.
15758 The functions must take a single argument, the name of the property, and
15760 the values, this means that these values are intended as defaults for
15761 completion, but that other values should be allowed too.
15762 The functions must return nil if they are not responsible for this
15763 property.")
15765 (defun org-property-get-allowed-values (pom property &optional table)
15766 "Get allowed values for the property PROPERTY.
15767 When TABLE is non-nil, return an alist that can directly be used for
15768 completion."
15769 (let (vals)
15770 (cond
15771 ((equal property "TODO")
15772 (setq vals (org-with-point-at pom
15773 (append org-todo-keywords-1 '("")))))
15774 ((equal property "PRIORITY")
15775 (let ((n org-lowest-priority))
15776 (while (>= n org-highest-priority)
15777 (push (char-to-string n) vals)
15778 (setq n (1- n)))))
15779 ((member property org-special-properties))
15780 ((setq vals (run-hook-with-args-until-success
15781 'org-property-allowed-value-functions property)))
15782 (t
15783 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15785 (setq vals (car (read-from-string (concat "(" vals ")"))))
15786 (setq vals (mapcar (lambda (x)
15787 (cond ((stringp x) x)
15788 ((numberp x) (number-to-string x))
15789 ((symbolp x) (symbol-name x))
15790 (t "???")))
15791 vals)))))
15792 (when (member ":ETC" vals)
15793 (setq vals (remove ":ETC" vals))
15794 (org-add-props (car vals) '(org-unrestricted t)))
15795 (if table (mapcar 'list vals) vals)))
15797 (defun org-property-previous-allowed-value (&optional previous)
15798 "Switch to the next allowed value for this property."
15799 (interactive)
15800 (org-property-next-allowed-value t))
15802 (defun org-property-next-allowed-value (&optional previous)
15803 "Switch to the next allowed value for this property."
15804 (interactive)
15805 (unless (org-at-property-p)
15806 (error "Not at a property"))
15807 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15808 (key (match-string 2))
15809 (value (match-string 3))
15810 (allowed (or (org-property-get-allowed-values (point) key)
15811 (and (member value '("[ ]" "[-]" "[X]"))
15812 '("[ ]" "[X]"))))
15813 (heading (save-match-data (nth 4 (org-heading-components))))
15814 nval)
15815 (unless allowed
15816 (error "Allowed values for this property have not been defined"))
15817 (if previous (setq allowed (reverse allowed)))
15818 (if (member value allowed)
15819 (setq nval (car (cdr (member value allowed)))))
15820 (setq nval (or nval (car allowed)))
15821 (if (equal nval value)
15822 (error "Only one allowed value for this property"))
15823 (org-at-property-p)
15824 (replace-match (concat " :" key ": " nval) t t)
15825 (org-indent-line)
15826 (beginning-of-line 1)
15828 (when (equal prop org-effort-property)
15829 (save-excursion
15830 (org-back-to-heading t)
15831 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15832 (when (string= org-clock-current-task heading)
15833 (setq org-clock-effort nval)
15834 (org-clock-update-mode-line)))
15835 (run-hook-with-args 'org-property-changed-functions key nval)))
15837 (defun org-find-olp (path &optional this-buffer)
15838 "Return a marker pointing to the entry at outline path OLP.
15839 If anything goes wrong, throw an error.
15840 You can wrap this call to catch the error like this:
15842 (condition-case msg
15843 (org-mobile-locate-entry (match-string 4))
15844 (error (nth 1 msg)))
15846 The return value will then be either a string with the error message,
15847 or a marker if everything is OK.
15849 If THIS-BUFFER is set, the outline path does not contain a file,
15850 only headings."
15851 (let* ((file (if this-buffer buffer-file-name (pop path)))
15852 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15853 (level 1)
15854 (lmin 1)
15855 (lmax 1)
15856 limit re end found pos heading cnt flevel)
15857 (unless buffer (error "File not found :%s" file))
15858 (with-current-buffer buffer
15859 (save-excursion
15860 (save-restriction
15861 (widen)
15862 (setq limit (point-max))
15863 (goto-char (point-min))
15864 (while (setq heading (pop path))
15865 (setq re (format org-complex-heading-regexp-format
15866 (regexp-quote heading)))
15867 (setq cnt 0 pos (point))
15868 (while (re-search-forward re end t)
15869 (setq level (- (match-end 1) (match-beginning 1)))
15870 (if (and (>= level lmin) (<= level lmax))
15871 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15872 (when (= cnt 0) (error "Heading not found on level %d: %s"
15873 lmax heading))
15874 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15875 lmax heading))
15876 (goto-char found)
15877 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15878 (setq end (save-excursion (org-end-of-subtree t t))))
15879 (when (org-at-heading-p)
15880 (point-marker)))))))
15882 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15883 "Find node HEADING in BUFFER.
15884 Return a marker to the heading if it was found, or nil if not.
15885 If POS-ONLY is set, return just the position instead of a marker.
15887 The heading text must match exact, but it may have a TODO keyword,
15888 a priority cookie and tags in the standard locations."
15889 (with-current-buffer (or buffer (current-buffer))
15890 (save-excursion
15891 (save-restriction
15892 (widen)
15893 (goto-char (point-min))
15894 (let (case-fold-search)
15895 (if (re-search-forward
15896 (format org-complex-heading-regexp-format
15897 (regexp-quote heading)) nil t)
15898 (if pos-only
15899 (match-beginning 0)
15900 (move-marker (make-marker) (match-beginning 0)))))))))
15902 (defun org-find-exact-heading-in-directory (heading &optional dir)
15903 "Find Org node headline HEADING in all .org files in directory DIR.
15904 When the target headline is found, return a marker to this location."
15905 (let ((files (directory-files (or dir default-directory)
15907 file visiting m buffer)
15908 (catch 'found
15909 (while (setq file (pop files))
15910 (message "trying %s" file)
15911 (setq visiting (org-find-base-buffer-visiting file))
15912 (setq buffer (or visiting (find-file-noselect file)))
15913 (setq m (org-find-exact-headline-in-buffer
15914 heading buffer))
15915 (when (and (not m) (not visiting)) (kill-buffer buffer))
15916 (and m (throw 'found m))))))
15918 (defun org-find-entry-with-id (ident)
15919 "Locate the entry that contains the ID property with exact value IDENT.
15920 IDENT can be a string, a symbol or a number, this function will search for
15921 the string representation of it.
15922 Return the position where this entry starts, or nil if there is no such entry."
15923 (interactive "sID: ")
15924 (let ((id (cond
15925 ((stringp ident) ident)
15926 ((symbol-name ident) (symbol-name ident))
15927 ((numberp ident) (number-to-string ident))
15928 (t (error "IDENT %s must be a string, symbol or number" ident))))
15929 (case-fold-search nil))
15930 (save-excursion
15931 (save-restriction
15932 (widen)
15933 (goto-char (point-min))
15934 (when (re-search-forward
15936 nil t)
15937 (org-back-to-heading t)
15938 (point))))))
15940 ;;;; Timestamps
15942 (defvar org-last-changed-timestamp nil)
15943 (defvar org-last-inserted-timestamp nil
15944 "The last time stamp inserted with `org-insert-time-stamp'.")
15945 (defvar org-time-was-given) ; dynamically scoped parameter
15946 (defvar org-end-time-was-given) ; dynamically scoped parameter
15947 (defvar org-ts-what) ; dynamically scoped parameter
15949 (defun org-time-stamp (arg &optional inactive)
15950 "Prompt for a date/time and insert a time stamp.
15951 If the user specifies a time like HH:MM or if this command is
15952 called with at least one prefix argument, the time stamp contains
15953 the date and the time. Otherwise, only the date is be included.
15955 All parts of a date not specified by the user is filled in from
15956 the current date/time. So if you just press return without
15957 typing anything, the time stamp will represent the current
15958 date/time.
15960 If there is already a timestamp at the cursor, it will be
15961 modified.
15963 With two universal prefix arguments, insert an active timestamp
15964 with the current time without prompting the user."
15965 (interactive "P")
15966 (let* ((ts nil)
15967 (default-time
15968 ;; Default time is either today, or, when entering a range,
15969 ;; the range start.
15970 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15971 (save-excursion
15972 (re-search-backward
15974 (- (point) 20) t)))
15975 (apply 'encode-time (org-parse-time-string (match-string 1)))
15976 (current-time)))
15977 (default-input (and ts (org-get-compact-tod ts)))
15978 (repeater (save-excursion
15979 (save-match-data
15980 (beginning-of-line)
15981 (when (re-search-forward
15983 (save-excursion (progn (end-of-line) (point))) t)
15984 (match-string 0)))))
15985 org-time-was-given org-end-time-was-given time)
15986 (cond
15987 ((and (org-at-timestamp-p t)
15988 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15989 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15990 (insert "--")
15991 (setq time (let ((this-command this-command))
15992 (org-read-date arg 'totime nil nil
15993 default-time default-input inactive)))
15994 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15995 ((org-at-timestamp-p t)
15996 (setq time (let ((this-command this-command))
15997 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15998 (when (org-at-timestamp-p t) ; just to get the match data
15999 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16000 (replace-match "")
16001 (setq org-last-changed-timestamp
16002 (org-insert-time-stamp
16003 time (or org-time-was-given arg)
16004 inactive nil nil (list org-end-time-was-given)))
16005 (when repeater (goto-char (1- (point))) (insert " " repeater)
16006 (setq org-last-changed-timestamp
16007 (concat (substring org-last-inserted-timestamp 0 -1)
16008 " " repeater ">"))))
16009 (message "Timestamp updated"))
16010 ((equal arg '(16))
16011 (org-insert-time-stamp (current-time) t))
16012 (t
16013 (setq time (let ((this-command this-command))
16014 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16015 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16016 nil nil (list org-end-time-was-given))))))
16018 ;; FIXME: can we use this for something else, like computing time differences?
16019 (defun org-get-compact-tod (s)
16020 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16021 (let* ((t1 (match-string 1 s))
16022 (h1 (string-to-number (match-string 2 s)))
16023 (m1 (string-to-number (match-string 3 s)))
16024 (t2 (and (match-end 4) (match-string 5 s)))
16025 (h2 (and t2 (string-to-number (match-string 6 s))))
16026 (m2 (and t2 (string-to-number (match-string 7 s))))
16027 dh dm)
16028 (if (not t2)
16029 t1
16030 (setq dh (- h2 h1) dm (- m2 m1))
16031 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16032 (concat t1 "+" (number-to-string dh)
16033 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
16035 (defun org-time-stamp-inactive (&optional arg)
16036 "Insert an inactive time stamp.
16037 An inactive time stamp is enclosed in square brackets instead of angle
16038 brackets. It is inactive in the sense that it does not trigger agenda entries,
16039 does not link to the calendar and cannot be changed with the S-cursor keys.
16040 So these are more for recording a certain time/date."
16041 (interactive "P")
16042 (org-time-stamp arg 'inactive))
16044 (defvar org-date-ovl (make-overlay 1 1))
16045 (overlay-put org-date-ovl 'face 'org-date-selected)
16046 (org-detach-overlay org-date-ovl)
16048 (defvar org-ans1) ; dynamically scoped parameter
16049 (defvar org-ans2) ; dynamically scoped parameter
16051 (defvar org-plain-time-of-day-regexp) ; defined below
16053 (defvar org-overriding-default-time nil) ; dynamically scoped
16054 (defvar org-read-date-overlay nil)
16055 (defvar org-dcst nil) ; dynamically scoped
16056 (defvar org-read-date-history nil)
16057 (defvar org-read-date-final-answer nil)
16058 (defvar org-read-date-analyze-futurep nil)
16059 (defvar org-read-date-analyze-forced-year nil)
16060 (defvar org-read-date-inactive)
16062 (defvar org-read-date-minibuffer-local-map
16063 (let ((map (make-sparse-keymap)))
16064 (set-keymap-parent map minibuffer-local-map)
16065 (org-defkey map (kbd ".")
16066 (lambda () (interactive)
16067 (org-eval-in-calendar '(calendar-goto-today))))
16068 (org-defkey map [(meta shift left)]
16069 (lambda () (interactive)
16070 (org-eval-in-calendar '(calendar-backward-month 1))))
16071 (org-defkey map [(meta shift right)]
16072 (lambda () (interactive)
16073 (org-eval-in-calendar '(calendar-forward-month 1))))
16074 (org-defkey map [(meta shift up)]
16075 (lambda () (interactive)
16076 (org-eval-in-calendar '(calendar-backward-year 1))))
16077 (org-defkey map [(meta shift down)]
16078 (lambda () (interactive)
16079 (org-eval-in-calendar '(calendar-forward-year 1))))
16080 (org-defkey map [?\e (shift left)]
16081 (lambda () (interactive)
16082 (org-eval-in-calendar '(calendar-backward-month 1))))
16083 (org-defkey map [?\e (shift right)]
16084 (lambda () (interactive)
16085 (org-eval-in-calendar '(calendar-forward-month 1))))
16086 (org-defkey map [?\e (shift up)]
16087 (lambda () (interactive)
16088 (org-eval-in-calendar '(calendar-backward-year 1))))
16089 (org-defkey map [?\e (shift down)]
16090 (lambda () (interactive)
16091 (org-eval-in-calendar '(calendar-forward-year 1))))
16092 (org-defkey map [(shift up)]
16093 (lambda () (interactive)
16094 (org-eval-in-calendar '(calendar-backward-week 1))))
16095 (org-defkey map [(shift down)]
16096 (lambda () (interactive)
16097 (org-eval-in-calendar '(calendar-forward-week 1))))
16098 (org-defkey map [(shift left)]
16099 (lambda () (interactive)
16100 (org-eval-in-calendar '(calendar-backward-day 1))))
16101 (org-defkey map [(shift right)]
16102 (lambda () (interactive)
16103 (org-eval-in-calendar '(calendar-forward-day 1))))
16104 (org-defkey map "!"
16105 (lambda () (interactive)
16106 (org-eval-in-calendar '(diary-view-entries))
16107 (message "")))
16108 (org-defkey map ">"
16109 (lambda () (interactive)
16110 (org-eval-in-calendar '(scroll-calendar-left 1))))
16111 (org-defkey map "<"
16112 (lambda () (interactive)
16113 (org-eval-in-calendar '(scroll-calendar-right 1))))
16114 (org-defkey map "\C-v"
16115 (lambda () (interactive)
16116 (org-eval-in-calendar
16117 '(calendar-scroll-left-three-months 1))))
16118 (org-defkey map "\M-v"
16119 (lambda () (interactive)
16120 (org-eval-in-calendar
16121 '(calendar-scroll-right-three-months 1))))
16122 map)
16123 "Keymap for minibuffer commands when using `org-read-date'.")
16125 (defun org-read-date (&optional org-with-time to-time from-string prompt
16126 default-time default-input inactive)
16127 "Read a date, possibly a time, and make things smooth for the user.
16128 The prompt will suggest to enter an ISO date, but you can also enter anything
16129 which will at least partially be understood by `parse-time-string'.
16130 Unrecognized parts of the date will default to the current day, month, year,
16131 hour and minute. If this command is called to replace a timestamp at point,
16132 or to enter the second timestamp of a range, the default time is taken
16133 from the existing stamp. Furthermore, the command prefers the future,
16134 so if you are giving a date where the year is not given, and the day-month
16135 combination is already past in the current year, it will assume you
16136 mean next year. For details, see the manual. A few examples:
16138 3-2-5 --> 2003-02-05
16139 feb 15 --> currentyear-02-15
16140 2/15 --> currentyear-02-15
16141 sep 12 9 --> 2009-09-12
16142 12:45 --> today 12:45
16143 22 sept 0:34 --> currentyear-09-22 0:34
16144 12 --> currentyear-currentmonth-12
16145 Fri --> nearest Friday after today
16146 -Tue --> last Tuesday
16147 etc.
16149 Furthermore you can specify a relative date by giving, as the *first* thing
16150 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16151 change in days weeks, months, years.
16152 With a single plus or minus, the date is relative to today. With a double
16153 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16154 +4d --> four days from today
16155 +4 --> same as above
16156 +2w --> two weeks from today
16157 ++5 --> five days from default date
16159 The function understands only English month and weekday abbreviations.
16161 While prompting, a calendar is popped up - you can also select the
16162 date with the mouse (button 1). The calendar shows a period of three
16163 months. To scroll it to other months, use the keys `>' and `<'.
16164 If you don't like the calendar, turn it off with
16165 \(setq org-read-date-popup-calendar nil)
16167 With optional argument TO-TIME, the date will immediately be converted
16168 to an internal time.
16169 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16170 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16171 still enter a time, and this function will inform the calling routine
16172 about this change. The calling routine may then choose to change the
16173 format used to insert the time stamp into the buffer to include the time.
16174 With optional argument FROM-STRING, read from this string instead from
16175 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16176 the time/date that is used for everything that is not specified by the
16177 user."
16178 (require 'parse-time)
16179 (let* ((org-time-stamp-rounding-minutes
16180 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16181 (org-dcst org-display-custom-times)
16182 (ct (org-current-time))
16183 (org-def (or org-overriding-default-time default-time ct))
16184 (org-defdecode (decode-time org-def))
16185 (dummy (progn
16186 (when (< (nth 2 org-defdecode) org-extend-today-until)
16187 (setcar (nthcdr 2 org-defdecode) -1)
16188 (setcar (nthcdr 1 org-defdecode) 59)
16189 (setq org-def (apply 'encode-time org-defdecode)
16190 org-defdecode (decode-time org-def)))))
16191 (mouse-autoselect-window nil) ; Don't let the mouse jump
16192 (calendar-frame-setup nil)
16193 (calendar-setup nil)
16194 (calendar-move-hook nil)
16195 (calendar-view-diary-initially-flag nil)
16196 (calendar-view-holidays-initially-flag nil)
16197 (timestr (format-time-string
16198 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16199 (prompt (concat (if prompt (concat prompt " ") "")
16200 (format "Date+time [%s]: " timestr)))
16201 ans (org-ans0 "") org-ans1 org-ans2 final)
16203 (cond
16204 (from-string (setq ans from-string))
16205 (org-read-date-popup-calendar
16206 (save-excursion
16207 (save-window-excursion
16208 (calendar)
16209 (org-eval-in-calendar '(setq cursor-type nil) t)
16210 (unwind-protect
16211 (progn
16212 (calendar-forward-day (- (time-to-days org-def)
16213 (calendar-absolute-from-gregorian
16214 (calendar-current-date))))
16215 (org-eval-in-calendar nil t)
16216 (let* ((old-map (current-local-map))
16217 (map (copy-keymap calendar-mode-map))
16218 (minibuffer-local-map
16219 (copy-keymap org-read-date-minibuffer-local-map)))
16220 (org-defkey map (kbd "RET") 'org-calendar-select)
16221 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16222 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16223 (unwind-protect
16224 (progn
16225 (use-local-map map)
16226 (setq org-read-date-inactive inactive)
16227 (add-hook 'post-command-hook 'org-read-date-display)
16228 (setq org-ans0 (read-string prompt default-input
16229 'org-read-date-history nil))
16230 ;; org-ans0: from prompt
16231 ;; org-ans1: from mouse click
16232 ;; org-ans2: from calendar motion
16233 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16234 (remove-hook 'post-command-hook 'org-read-date-display)
16235 (use-local-map old-map)
16236 (when org-read-date-overlay
16237 (delete-overlay org-read-date-overlay)
16238 (setq org-read-date-overlay nil)))))
16239 (bury-buffer "*Calendar*")))))
16241 (t ; Naked prompt only
16242 (unwind-protect
16243 (setq ans (read-string prompt default-input
16244 'org-read-date-history timestr))
16245 (when org-read-date-overlay
16246 (delete-overlay org-read-date-overlay)
16247 (setq org-read-date-overlay nil)))))
16249 (setq final (org-read-date-analyze ans org-def org-defdecode))
16251 (when org-read-date-analyze-forced-year
16252 (message "Year was forced into %s"
16253 (if org-read-date-force-compatible-dates
16254 "compatible range (1970-2037)"
16255 "range representable on this machine"))
16256 (ding))
16258 ;; One round trip to get rid of 34th of August and stuff like that....
16259 (setq final (decode-time (apply 'encode-time final)))
16261 (setq org-read-date-final-answer ans)
16263 (if to-time
16264 (apply 'encode-time final)
16265 (if (and (boundp 'org-time-was-given) org-time-was-given)
16266 (format "%04d-%02d-%02d %02d:%02d"
16267 (nth 5 final) (nth 4 final) (nth 3 final)
16268 (nth 2 final) (nth 1 final))
16269 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16271 (defvar org-def)
16272 (defvar org-defdecode)
16273 (defvar org-with-time)
16274 (defun org-read-date-display ()
16275 "Display the current date prompt interpretation in the minibuffer."
16276 (when org-read-date-display-live
16277 (when org-read-date-overlay
16278 (delete-overlay org-read-date-overlay))
16279 (when (minibufferp (current-buffer))
16280 (save-excursion
16281 (end-of-line 1)
16282 (while (not (equal (buffer-substring
16283 (max (point-min) (- (point) 4)) (point))
16284 " "))
16285 (insert " ")))
16286 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16287 " " (or org-ans1 org-ans2)))
16288 (org-end-time-was-given nil)
16289 (f (org-read-date-analyze ans org-def org-defdecode))
16290 (fmts (if org-dcst
16291 org-time-stamp-custom-formats
16292 org-time-stamp-formats))
16293 (fmt (if (or org-with-time
16294 (and (boundp 'org-time-was-given) org-time-was-given))
16295 (cdr fmts)
16296 (car fmts)))
16297 (txt (format-time-string fmt (apply 'encode-time f)))
16298 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16299 (txt (concat "=> " txt)))
16300 (when (and org-end-time-was-given
16301 (string-match org-plain-time-of-day-regexp txt))
16302 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16303 org-end-time-was-given
16304 (substring txt (match-end 0)))))
16305 (when org-read-date-analyze-futurep
16306 (setq txt (concat txt " (=>F)")))
16307 (setq org-read-date-overlay
16308 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16309 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16311 (defun org-read-date-analyze (ans org-def org-defdecode)
16312 "Analyze the combined answer of the date prompt."
16313 ;; FIXME: cleanup and comment
16314 (let ((nowdecode (decode-time (current-time)))
16315 delta deltan deltaw deltadef year month day
16316 hour minute second wday pm h2 m2 tl wday1
16317 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16318 (setq org-read-date-analyze-futurep nil
16319 org-read-date-analyze-forced-year nil)
16321 (setq ans "+0"))
16323 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16324 (setq ans (replace-match "" t t ans)
16325 deltan (car delta)
16326 deltaw (nth 1 delta)
16327 deltadef (nth 2 delta)))
16329 ;; Check if there is an iso week date in there. If yes, store the
16330 ;; info and postpone interpreting it until the rest of the parsing
16331 ;; is done.
16332 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16333 (setq iso-year (if (match-end 1)
16334 (org-small-year-to-year
16335 (string-to-number (match-string 1 ans))))
16336 iso-weekday (if (match-end 3)
16337 (string-to-number (match-string 3 ans)))
16338 iso-week (string-to-number (match-string 2 ans)))
16339 (setq ans (replace-match "" t t ans)))
16341 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16342 (when (string-match
16344 (setq year (if (match-end 2)
16345 (string-to-number (match-string 2 ans))
16346 (progn (setq kill-year t)
16347 (string-to-number (format-time-string "%Y"))))
16348 month (string-to-number (match-string 3 ans))
16349 day (string-to-number (match-string 4 ans)))
16350 (if (< year 100) (setq year (+ 2000 year)))
16352 t nil ans)))
16354 ;; Help matching dotted european dates
16355 (when (string-match
16356 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16357 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16358 (setq kill-year t)
16359 (string-to-number (format-time-string "%Y")))
16360 day (string-to-number (match-string 1 ans))
16361 month (string-to-number (match-string 2 ans))
16362 ans (replace-match (format "%04d-%02d-%02d" year month day)
16363 t nil ans)))
16365 ;; Help matching american dates, like 5/30 or 5/30/7
16366 (when (string-match
16367 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16368 (setq year (if (match-end 4)
16369 (string-to-number (match-string 4 ans))
16370 (progn (setq kill-year t)
16371 (string-to-number (format-time-string "%Y"))))
16372 month (string-to-number (match-string 1 ans))
16373 day (string-to-number (match-string 2 ans)))
16374 (if (< year 100) (setq year (+ 2000 year)))
16376 t nil ans)))
16377 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16378 ;; If there is a time with am/pm, and *no* time without it, we convert
16379 ;; so that matching will be successful.
16380 (loop for i from 1 to 2 do ; twice, for end time as well
16383 (setq hour (string-to-number (match-string 1 ans))
16384 minute (if (match-end 3)
16385 (string-to-number (match-string 3 ans))
16386 0)
16387 pm (equal ?p
16388 (string-to-char (downcase (match-string 4 ans)))))
16389 (if (and (= hour 12) (not pm))
16390 (setq hour 0)
16391 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16392 (setq ans (replace-match (format "%02d:%02d" hour minute)
16393 t t ans))))
16395 ;; Check if a time range is given as a duration
16396 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16397 (setq hour (string-to-number (match-string 1 ans))
16398 h2 (+ hour (string-to-number (match-string 3 ans)))
16399 minute (string-to-number (match-string 2 ans))
16400 m2 (+ minute (if (match-end 5) (string-to-number
16401 (match-string 5 ans))0)))
16402 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16403 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16404 t t ans)))
16406 ;; Check if there is a time range
16407 (when (boundp 'org-end-time-was-given)
16408 (setq org-time-was-given nil)
16409 (when (and (string-match org-plain-time-of-day-regexp ans)
16410 (match-end 8))
16411 (setq org-end-time-was-given (match-string 8 ans))
16412 (setq ans (concat (substring ans 0 (match-beginning 7))
16413 (substring ans (match-end 7))))))
16415 (setq tl (parse-time-string ans)
16416 day (or (nth 3 tl) (nth 3 org-defdecode))
16417 month (or (nth 4 tl)
16418 (if (and org-read-date-prefer-future
16419 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16420 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16421 (nth 4 org-defdecode)))
16422 year (or (and (not kill-year) (nth 5 tl))
16423 (if (and org-read-date-prefer-future
16424 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16425 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16426 (nth 5 org-defdecode)))
16427 hour (or (nth 2 tl) (nth 2 org-defdecode))
16428 minute (or (nth 1 tl) (nth 1 org-defdecode))
16429 second (or (nth 0 tl) 0)
16430 wday (nth 6 tl))
16432 (when (and (eq org-read-date-prefer-future 'time)
16433 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16434 (equal day (nth 3 nowdecode))
16435 (equal month (nth 4 nowdecode))
16436 (equal year (nth 5 nowdecode))
16437 (nth 2 tl)
16438 (or (< (nth 2 tl) (nth 2 nowdecode))
16439 (and (= (nth 2 tl) (nth 2 nowdecode))
16440 (nth 1 tl)
16441 (< (nth 1 tl) (nth 1 nowdecode)))))
16442 (setq day (1+ day)
16443 futurep t))
16445 ;; Special date definitions below
16446 (cond
16447 (iso-week
16448 ;; There was an iso week
16449 (require 'cal-iso)
16450 (setq futurep nil)
16451 (setq year (or iso-year year)
16452 day (or iso-weekday wday 1)
16453 wday nil ; to make sure that the trigger below does not match
16454 iso-date (calendar-gregorian-from-absolute
16455 (calendar-absolute-from-iso
16456 (list iso-week day year))))
16457 ; FIXME: Should we also push ISO weeks into the future?
16458 ; (when (and org-read-date-prefer-future
16459 ; (not iso-year)
16460 ; (< (calendar-absolute-from-gregorian iso-date)
16461 ; (time-to-days (current-time))))
16462 ; (setq year (1+ year)
16463 ; iso-date (calendar-gregorian-from-absolute
16464 ; (calendar-absolute-from-iso
16465 ; (list iso-week day year)))))
16466 (setq month (car iso-date)
16467 year (nth 2 iso-date)
16468 day (nth 1 iso-date)))
16469 (deltan
16470 (setq futurep nil)
16471 (unless deltadef
16472 (let ((now (decode-time (current-time))))
16473 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16474 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16475 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16476 ((equal deltaw "m") (setq month (+ month deltan)))
16477 ((equal deltaw "y") (setq year (+ year deltan)))))
16478 ((and wday (not (nth 3 tl)))
16479 ;; Weekday was given, but no day, so pick that day in the week
16480 ;; on or after the derived date.
16481 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16482 (unless (equal wday wday1)
16483 (setq day (+ day (% (- wday wday1 -7) 7))))))
16484 (if (and (boundp 'org-time-was-given)
16485 (nth 2 tl))
16486 (setq org-time-was-given t))
16487 (if (< year 100) (setq year (+ 2000 year)))
16488 ;; Check of the date is representable
16489 (if org-read-date-force-compatible-dates
16490 (progn
16491 (if (< year 1970)
16492 (setq year 1970 org-read-date-analyze-forced-year t))
16493 (if (> year 2037)
16494 (setq year 2037 org-read-date-analyze-forced-year t)))
16495 (condition-case nil
16496 (ignore (encode-time second minute hour day month year))
16497 (error
16498 (setq year (nth 5 org-defdecode))
16499 (setq org-read-date-analyze-forced-year t))))
16500 (setq org-read-date-analyze-futurep futurep)
16501 (list second minute hour day month year)))
16503 (defvar parse-time-weekdays)
16504 (defun org-read-date-get-relative (s today default)
16505 "Check string S for special relative date string.
16506 TODAY and DEFAULT are internal times, for today and for a default.
16507 Return shift list (N what def-flag)
16509 N is the number of WHATs to shift.
16510 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16511 the DEFAULT date rather than TODAY."
16512 (require 'parse-time)
16513 (when (and
16514 (string-match
16515 (concat
16520 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16521 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16522 (string-to-char (substring (match-string 1 s) -1))
16523 ?+))
16524 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16525 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16526 (what (if (match-end 3) (match-string 3 s) "d"))
16527 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16528 (date (if rel default today))
16529 (wday (nth 6 (decode-time date)))
16530 delta)
16531 (if wday1
16532 (progn
16533 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16534 (if (= delta 0) (setq delta 7))
16535 (if (= dir ?-)
16536 (progn
16537 (setq delta (- delta 7))
16538 (if (= delta 0) (setq delta -7))))
16539 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16540 (list delta "d" rel))
16541 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16543 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16544 "Turn a user-specified date into the internal representation.
16545 The internal representation needed by the calendar is (month day year).
16546 This is a wrapper to handle the brain-dead convention in calendar that
16547 user function argument order change dependent on argument order."
16548 (if (boundp 'calendar-date-style)
16549 (cond
16550 ((eq calendar-date-style 'american)
16551 (list arg1 arg2 arg3))
16552 ((eq calendar-date-style 'european)
16553 (list arg2 arg1 arg3))
16554 ((eq calendar-date-style 'iso)
16555 (list arg2 arg3 arg1)))
16556 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16557 (if (org-bound-and-true-p european-calendar-style)
16558 (list arg2 arg1 arg3)
16559 (list arg1 arg2 arg3)))))
16561 (defun org-eval-in-calendar (form &optional keepdate)
16562 "Eval FORM in the calendar window and return to current window.
16563 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16564 otherwise stick to the current value of `org-ans2'."
16565 (let ((sf (selected-frame))
16566 (sw (selected-window)))
16567 (select-window (get-buffer-window "*Calendar*" t))
16568 (eval form)
16569 (when (and (not keepdate) (calendar-cursor-to-date))
16570 (let* ((date (calendar-cursor-to-date))
16571 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16572 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16573 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16574 (select-window sw)
16575 (org-select-frame-set-input-focus sf)))
16577 (defun org-calendar-select ()
16578 "Return to `org-read-date' with the date currently selected.
16579 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16580 (interactive)
16581 (when (calendar-cursor-to-date)
16582 (let* ((date (calendar-cursor-to-date))
16583 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16584 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16585 (if (active-minibuffer-window) (exit-minibuffer))))
16587 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16588 "Insert a date stamp for the date given by the internal TIME.
16589 WITH-HM means use the stamp format that includes the time of the day.
16590 INACTIVE means use square brackets instead of angular ones, so that the
16591 stamp will not contribute to the agenda.
16592 PRE and POST are optional strings to be inserted before and after the
16593 stamp.
16594 The command returns the inserted time stamp."
16595 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16596 stamp)
16597 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16598 (insert-before-markers (or pre ""))
16599 (when (listp extra)
16600 (setq extra (car extra))
16601 (if (and (stringp extra)
16603 (setq extra (format "-%02d:%02d"
16604 (string-to-number (match-string 1 extra))
16605 (string-to-number (match-string 2 extra))))
16606 (setq extra nil)))
16607 (when extra
16608 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16609 (insert-before-markers (setq stamp (format-time-string fmt time)))
16610 (insert-before-markers (or post ""))
16611 (setq org-last-inserted-timestamp stamp)))
16613 (defun org-toggle-time-stamp-overlays ()
16614 "Toggle the use of custom time stamp formats."
16615 (interactive)
16616 (setq org-display-custom-times (not org-display-custom-times))
16617 (unless org-display-custom-times
16618 (let ((p (point-min)) (bmp (buffer-modified-p)))
16619 (while (setq p (next-single-property-change p 'display))
16620 (if (and (get-text-property p 'display)
16621 (eq (get-text-property p 'face) 'org-date))
16622 (remove-text-properties
16623 p (setq p (next-single-property-change p 'display))
16624 '(display t))))
16625 (set-buffer-modified-p bmp)))
16626 (if (featurep 'xemacs)
16627 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16628 (org-restart-font-lock)
16629 (setq org-table-may-need-update t)
16630 (if org-display-custom-times
16631 (message "Time stamps are overlaid with custom format")
16632 (message "Time stamp overlays removed")))
16634 (defun org-display-custom-time (beg end)
16635 "Overlay modified time stamp format over timestamp between BEG and END."
16636 (let* ((ts (buffer-substring beg end))
16637 t1 w1 with-hm tf time str w2 (off 0))
16638 (save-match-data
16639 (setq t1 (org-parse-time-string ts t))
16640 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16641 (setq off (- (match-end 0) (match-beginning 0)))))
16642 (setq end (- end off))
16643 (setq w1 (- end beg)
16644 with-hm (and (nth 1 t1) (nth 2 t1))
16645 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16646 time (org-fix-decoded-time t1)
16647 str (org-add-props
16648 (format-time-string
16649 (substring tf 1 -1) (apply 'encode-time time))
16650 nil 'mouse-face 'highlight)
16651 w2 (length str))
16652 (if (not (= w2 w1))
16653 (add-text-properties (1+ beg) (+ 2 beg)
16654 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16655 (if (featurep 'xemacs)
16656 (progn
16657 (put-text-property beg end 'invisible t)
16658 (put-text-property beg end 'end-glyph (make-glyph str)))
16659 (put-text-property beg end 'display str))))
16661 (defun org-translate-time (string)
16662 "Translate all timestamps in STRING to custom format.
16663 But do this only if the variable `org-display-custom-times' is set."
16664 (when org-display-custom-times
16665 (save-match-data
16666 (let* ((start 0)
16667 (re org-ts-regexp-both)
16668 t1 with-hm inactive tf time str beg end)
16669 (while (setq start (string-match re string start))
16670 (setq beg (match-beginning 0)
16671 end (match-end 0)
16672 t1 (save-match-data
16673 (org-parse-time-string (substring string beg end) t))
16674 with-hm (and (nth 1 t1) (nth 2 t1))
16675 inactive (equal (substring string beg (1+ beg)) "[")
16676 tf (funcall (if with-hm 'cdr 'car)
16677 org-time-stamp-custom-formats)
16678 time (org-fix-decoded-time t1)
16679 str (format-time-string
16680 (concat
16681 (if inactive "[" "<") (substring tf 1 -1)
16682 (if inactive "]" ">"))
16683 (apply 'encode-time time))
16684 string (replace-match str t t string)
16685 start (+ start (length str)))))))
16686 string)
16688 (defun org-fix-decoded-time (time)
16689 "Set 0 instead of nil for the first 6 elements of time.
16690 Don't touch the rest."
16691 (let ((n 0))
16692 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16694 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16696 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16697 "Difference between TIMESTAMP-STRING and now in days.
16698 If SECONDS is non-nil, return the difference in seconds."
16699 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16700 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16701 (funcall fdiff (current-time)))))
16703 (defun org-deadline-close (timestamp-string &optional ndays)
16704 "Is the time in TIMESTAMP-STRING close to the current date?"
16705 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16706 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16707 (not (org-entry-is-done-p))))
16709 (defun org-get-wdays (ts &optional delay zero-delay)
16710 "Get the deadline lead time appropriate for timestring TS.
16711 When DELAY is non-nil, get the delay time for scheduled items
16712 instead of the deadline lead time. When ZERO-DELAY is non-nil
16713 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16714 don't try to find the delay cookie in the scheduled timestamp."
16715 (let ((tv (if delay org-scheduled-delay-days
16716 org-deadline-warning-days)))
16717 (cond
16718 ((or (and delay (< tv 0))
16719 (and delay zero-delay (<= tv 0))
16720 (and (not delay) (<= tv 0)))
16721 ;; Enforce this value no matter what
16722 (- tv))
16724 ;; lead time is specified.
16725 (floor (* (string-to-number (match-string 1 ts))
16726 (cdr (assoc (match-string 2 ts)
16727 '(("d" . 1) ("w" . 7)
16728 ("m" . 30.4) ("y" . 365.25)
16729 ("h" . 0.041667)))))))
16730 ;; go for the default.
16731 (t tv))))
16733 (defun org-calendar-select-mouse (ev)
16734 "Return to `org-read-date' with the date currently selected.
16735 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16736 (interactive "e")
16737 (mouse-set-point ev)
16738 (when (calendar-cursor-to-date)
16739 (let* ((date (calendar-cursor-to-date))
16740 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16741 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16742 (if (active-minibuffer-window) (exit-minibuffer))))
16744 (defun org-check-deadlines (ndays)
16745 "Check if there are any deadlines due or past due.
16746 A deadline is considered due if it happens within `org-deadline-warning-days'
16747 days from today's date. If the deadline appears in an entry marked DONE,
16748 it is not shown. The prefix arg NDAYS can be used to test that many
16750 (interactive "P")
16751 (let* ((org-warn-days
16752 (cond
16753 ((equal ndays '(4)) 100000)
16754 (ndays (prefix-numeric-value ndays))
16755 (t (abs org-deadline-warning-days))))
16756 (case-fold-search nil)
16758 (callback
16759 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16761 (message "%d deadlines past-due or due within %d days"
16762 (org-occur regexp nil callback)
16763 org-warn-days)))
16765 (defsubst org-re-timestamp (type)
16766 "Return a regexp for timestamp TYPE.
16767 Allowed values for TYPE are:
16769 all: all timestamps
16770 active: only active timestamps (<...>)
16771 inactive: only inactive timestamps ([...])
16772 scheduled: only scheduled timestamps
16773 deadline: only deadline timestamps
16774 closed: only closed time-stamps
16776 When TYPE is nil, fall back on returning a regexp that matches
16777 both scheduled and deadline timestamps."
16778 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16779 ((eq type 'active) org-ts-regexp)
16783 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16784 ((eq type 'scheduled-or-deadline)
16787 (defun org-check-before-date (date)
16788 "Check if there are deadlines or scheduled entries before DATE."
16789 (interactive (list (org-read-date)))
16790 (let ((case-fold-search nil)
16791 (regexp (org-re-timestamp org-ts-type))
16792 (callback
16793 (lambda () (time-less-p
16794 (org-time-string-to-time (match-string 1))
16795 (org-time-string-to-time date)))))
16796 (message "%d entries before %s"
16797 (org-occur regexp nil callback) date)))
16799 (defun org-check-after-date (date)
16800 "Check if there are deadlines or scheduled entries after DATE."
16801 (interactive (list (org-read-date)))
16802 (let ((case-fold-search nil)
16803 (regexp (org-re-timestamp org-ts-type))
16804 (callback
16805 (lambda () (not
16806 (time-less-p
16807 (org-time-string-to-time (match-string 1))
16808 (org-time-string-to-time date))))))
16809 (message "%d entries after %s"
16810 (org-occur regexp nil callback) date)))
16812 (defun org-check-dates-range (start-date end-date)
16813 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16814 (interactive (list (org-read-date nil nil nil "Range starts")
16815 (org-read-date nil nil nil "Range end")))
16816 (let ((case-fold-search nil)
16817 (regexp (org-re-timestamp org-ts-type))
16818 (callback
16819 (lambda ()
16820 (let ((match (match-string 1)))
16821 (and
16822 (not (time-less-p
16823 (org-time-string-to-time match)
16824 (org-time-string-to-time start-date)))
16825 (time-less-p
16826 (org-time-string-to-time match)
16827 (org-time-string-to-time end-date)))))))
16828 (message "%d entries between %s and %s"
16829 (org-occur regexp nil callback) start-date end-date)))
16831 (defun org-evaluate-time-range (&optional to-buffer)
16832 "Evaluate a time range by computing the difference between start and end.
16833 Normally the result is just printed in the echo area, but with prefix arg
16834 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16835 If the time range is actually in a table, the result is inserted into the
16836 next column.
16837 For time difference computation, a year is assumed to be exactly 365
16838 days in order to avoid rounding problems."
16839 (interactive "P")
16840 (or
16841 (org-clock-update-time-maybe)
16842 (save-excursion
16843 (unless (org-at-date-range-p t)
16844 (goto-char (point-at-bol))
16845 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16846 (if (not (org-at-date-range-p t))
16847 (error "Not at a time-stamp range, and none found in current line")))
16848 (let* ((ts1 (match-string 1))
16849 (ts2 (match-string 2))
16850 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16851 (match-end (match-end 0))
16852 (time1 (org-time-string-to-time ts1))
16853 (time2 (org-time-string-to-time ts2))
16854 (t1 (org-float-time time1))
16855 (t2 (org-float-time time2))
16856 (diff (abs (- t2 t1)))
16857 (negative (< (- t2 t1) 0))
16858 ;; (ys (floor (* 365 24 60 60)))
16859 (ds (* 24 60 60))
16860 (hs (* 60 60))
16861 (fy "%dy %dd %02d:%02d")
16862 (fy1 "%dy %dd")
16863 (fd "%dd %02d:%02d")
16864 (fd1 "%dd")
16865 (fh "%02d:%02d")
16866 y d h m align)
16867 (if havetime
16868 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16869 y 0
16870 d (floor (/ diff ds)) diff (mod diff ds)
16871 h (floor (/ diff hs)) diff (mod diff hs)
16872 m (floor (/ diff 60)))
16873 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16874 y 0
16875 d (floor (+ (/ diff ds) 0.5))
16876 h 0 m 0))
16877 (if (not to-buffer)
16878 (message "%s" (org-make-tdiff-string y d h m))
16879 (if (org-at-table-p)
16880 (progn
16881 (goto-char match-end)
16882 (setq align t)
16883 (and (looking-at " *|") (goto-char (match-end 0))))
16884 (goto-char match-end))
16885 (if (looking-at
16887 (replace-match ""))
16888 (if negative (insert " -"))
16889 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16890 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16891 (insert " " (format fh h m))))
16892 (if align (org-table-align))
16893 (message "Time difference inserted")))))
16895 (defun org-make-tdiff-string (y d h m)
16896 (let ((fmt "")
16897 (l nil))
16898 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16899 l (push y l)))
16900 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16901 l (push d l)))
16902 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16903 l (push h l)))
16904 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16905 l (push m l)))
16906 (apply 'format fmt (nreverse l))))
16908 (defun org-time-string-to-time (s &optional buffer pos)
16909 "Convert a timestamp string into internal time."
16910 (condition-case errdata
16911 (apply 'encode-time (org-parse-time-string s))
16913 s (if (not (and buffer pos))
16914 ""
16915 (format " at %d in buffer `%s'" pos buffer))
16916 (cdr errdata)))))
16918 (defun org-time-string-to-seconds (s)
16919 "Convert a timestamp string to a number of seconds."
16920 (org-float-time (org-time-string-to-time s)))
16922 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16923 "Convert a time stamp to an absolute day number.
16924 If there is a specifier for a cyclic time stamp, get the closest
16925 date to DAYNR.
16926 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16927 The variable `date' is bound by the calendar when this is called."
16928 (cond
16930 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16931 daynr
16932 (+ daynr 1000)))
16934 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16935 (time-to-days (current-time))) (match-string 0 s)
16936 prefer show-all))
16937 (t (time-to-days
16938 (condition-case errdata
16939 (apply 'encode-time (org-parse-time-string s))
16941 s (if (not (and buffer pos))
16942 ""
16943 (format " at %d in buffer `%s'" pos buffer))
16944 (cdr errdata))))))))
16946 (defun org-days-to-iso-week (days)
16947 "Return the iso week number."
16948 (require 'cal-iso)
16949 (car (calendar-iso-from-absolute days)))
16951 (defun org-small-year-to-year (year)
16952 "Convert 2-digit years into 4-digit years.
16953 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16954 The year 2000 cannot be abbreviated. Any year larger than 99
16955 is returned unchanged."
16956 (if (< year 38)
16957 (setq year (+ 2000 year))
16958 (if (< year 100)
16959 (setq year (+ 1900 year))))
16960 year)
16962 (defun org-time-from-absolute (d)
16963 "Return the time corresponding to date D.
16964 D may be an absolute day number, or a calendar-type list (month day year)."
16965 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16966 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16968 (defun org-calendar-holiday ()
16969 "List of holidays, for Diary display in Org-mode."
16970 (require 'holidays)
16971 (let ((hl (funcall
16972 (if (fboundp 'calendar-check-holidays)
16973 'calendar-check-holidays 'check-calendar-holidays) date)))
16974 (if hl (mapconcat 'identity hl "; "))))
16976 (defun org-diary-sexp-entry (sexp entry date)
16977 "Process a SEXP diary ENTRY for DATE."
16978 (require 'diary-lib)
16979 (let ((result (if calendar-debug-sexp
16980 (let ((stack-trace-on-error t))
16981 (eval (car (read-from-string sexp))))
16982 (condition-case nil
16983 (eval (car (read-from-string sexp)))
16984 (error
16985 (beep)
16986 (message "Bad sexp at line %d in %s: %s"
16987 (org-current-line)
16988 (buffer-file-name) sexp)
16989 (sleep-for 2))))))
16990 (cond ((stringp result) (split-string result "; "))
16991 ((and (consp result)
16992 (not (consp (cdr result)))
16993 (stringp (cdr result))) (cdr result))
16994 ((and (consp result)
16995 (stringp (car result))) result)
16996 (result entry))))
16998 (defun org-diary-to-ical-string (frombuf)
16999 "Get iCalendar entries from diary entries in buffer FROMBUF.
17000 This uses the icalendar.el library."
17001 (let* ((tmpdir (if (featurep 'xemacs)
17002 (temp-directory)
17003 temporary-file-directory))
17004 (tmpfile (make-temp-name
17005 (expand-file-name "orgics" tmpdir)))
17006 buf rtn b e)
17007 (with-current-buffer frombuf
17008 (icalendar-export-region (point-min) (point-max) tmpfile)
17009 (setq buf (find-buffer-visiting tmpfile))
17010 (set-buffer buf)
17011 (goto-char (point-min))
17012 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17013 (setq b (match-beginning 0)))
17014 (goto-char (point-max))
17015 (if (re-search-backward "^END:VEVENT" nil t)
17016 (setq e (match-end 0)))
17018 (kill-buffer buf)
17019 (delete-file tmpfile)
17020 rtn))
17022 (defun org-closest-date (start current change prefer show-all)
17023 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17024 When PREFER is `past', return a date that is either CURRENT or past.
17025 When PREFER is `future', return a date that is either CURRENT or future.
17026 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17027 ;; Make the proper lists from the dates
17028 (catch 'exit
17029 (let ((a1 '(("h" . hour)
17030 ("d" . day)
17031 ("w" . week)
17032 ("m" . month)
17033 ("y" . year)))
17034 (shour (nth 2 (org-parse-time-string start)))
17035 dn dw sday cday n1 n2 n0
17036 d m y y1 y2 date1 date2 nmonths nm ny m2)
17038 (setq start (org-date-to-gregorian start)
17039 current (org-date-to-gregorian
17040 (if show-all
17041 current
17042 (time-to-days (current-time))))
17043 sday (calendar-absolute-from-gregorian start)
17044 cday (calendar-absolute-from-gregorian current))
17046 (if (<= cday sday) (throw 'exit sday))
17049 (setq dn (string-to-number (match-string 1 change))
17050 dw (cdr (assoc (match-string 2 change) a1)))
17051 (error "Invalid change specifier: %s" change))
17052 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17053 (cond
17054 ((eq dw 'hour)
17055 (let ((missing-hours
17056 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17057 dn)))
17058 (setq n1 (if (zerop missing-hours) cday
17059 (- cday (1+ (floor (/ missing-hours 24)))))
17060 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17061 ((eq dw 'day)
17062 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17063 n2 (+ n1 dn)))
17064 ((eq dw 'year)
17065 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17066 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17067 (setq date1 (list m d y1)
17068 n1 (calendar-absolute-from-gregorian date1)
17069 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17070 n2 (calendar-absolute-from-gregorian date2)))
17071 ((eq dw 'month)
17072 ;; approx number of month between the two dates
17073 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17074 ;; How often does dn fit in there?
17075 (setq d (nth 1 start) m (car start) y (nth 2 start)
17076 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17077 m (+ m nm)
17078 ny (floor (/ m 12))
17079 y (+ y ny)
17080 m (- m (* ny 12)))
17081 (while (> m 12) (setq m (- m 12) y (1+ y)))
17082 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17083 (setq m2 (+ m dn) y2 y)
17084 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17085 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17086 (while (<= n2 cday)
17087 (setq n1 n2 m m2 y y2)
17088 (setq m2 (+ m dn) y2 y)
17089 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17090 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17091 ;; Make sure n1 is the earlier date
17092 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17093 (if show-all
17094 (cond
17095 ((eq prefer 'past) (if (= cday n2) n2 n1))
17096 ((eq prefer 'future) (if (= cday n1) n1 n2))
17097 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17098 (cond
17099 ((eq prefer 'past) (if (= cday n2) n2 n1))
17100 ((eq prefer 'future) (if (= cday n1) n1 n2))
17101 (t (if (= cday n1) n1 n2)))))))
17103 (defun org-date-to-gregorian (date)
17104 "Turn any specification of DATE into a Gregorian date for the calendar."
17105 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17106 ((and (listp date) (= (length date) 3)) date)
17107 ((stringp date)
17108 (setq date (org-parse-time-string date))
17109 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17110 ((listp date)
17111 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17113 (defun org-parse-time-string (s &optional nodefault)
17114 "Parse the standard Org-mode time string.
17115 This should be a lot faster than the normal `parse-time-string'.
17116 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17117 hour and minute fields will be nil if not given."
17118 (cond ((string-match org-ts-regexp0 s)
17119 (list 0
17120 (if (or (match-beginning 8) (not nodefault))
17121 (string-to-number (or (match-string 8 s) "0")))
17122 (if (or (match-beginning 7) (not nodefault))
17123 (string-to-number (or (match-string 7 s) "0")))
17124 (string-to-number (match-string 4 s))
17125 (string-to-number (match-string 3 s))
17126 (string-to-number (match-string 2 s))
17127 nil nil nil))
17128 ((string-match "^<[^>]+>$" s)
17129 (decode-time (seconds-to-time (org-matcher-time s))))
17130 (t (error "Not a standard Org-mode time string: %s" s))))
17132 (defun org-timestamp-up (&optional arg)
17133 "Increase the date item at the cursor by one.
17134 If the cursor is on the year, change the year. If it is on the month,
17135 the day or the time, change that.
17136 With prefix ARG, change by that many units."
17137 (interactive "p")
17138 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17140 (defun org-timestamp-down (&optional arg)
17141 "Decrease the date item at the cursor by one.
17142 If the cursor is on the year, change the year. If it is on the month,
17143 the day or the time, change that.
17144 With prefix ARG, change by that many units."
17145 (interactive "p")
17146 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17148 (defun org-timestamp-up-day (&optional arg)
17149 "Increase the date in the time stamp by one day.
17150 With prefix ARG, change that many days."
17151 (interactive "p")
17152 (if (and (not (org-at-timestamp-p t))
17153 (org-at-heading-p))
17154 (org-todo 'up)
17155 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17157 (defun org-timestamp-down-day (&optional arg)
17158 "Decrease the date in the time stamp by one day.
17159 With prefix ARG, change that many days."
17160 (interactive "p")
17161 (if (and (not (org-at-timestamp-p t))
17162 (org-at-heading-p))
17163 (org-todo 'down)
17164 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17166 (defun org-at-timestamp-p (&optional inactive-ok)
17167 "Determine if the cursor is in or at a timestamp."
17168 (interactive)
17169 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17170 (pos (point))
17171 (ans (or (looking-at tsr)
17172 (save-excursion
17174 (if (> (point) (point-min)) (backward-char 1))
17175 (and (looking-at tsr)
17176 (> (- (match-end 0) pos) -1))))))
17177 (and ans
17178 (boundp 'org-ts-what)
17179 (setq org-ts-what
17180 (cond
17181 ((= pos (match-beginning 0)) 'bracket)
17182 ;; Point is considered to be "on the bracket" whether
17183 ;; it's really on it or right after it.
17184 ((= pos (1- (match-end 0))) 'bracket)
17185 ((= pos (match-end 0)) 'after)
17186 ((org-pos-in-match-range pos 2) 'year)
17187 ((org-pos-in-match-range pos 3) 'month)
17188 ((org-pos-in-match-range pos 7) 'hour)
17189 ((org-pos-in-match-range pos 8) 'minute)
17190 ((or (org-pos-in-match-range pos 4)
17191 (org-pos-in-match-range pos 5)) 'day)
17192 ((and (> pos (or (match-end 8) (match-end 5)))
17193 (< pos (match-end 0)))
17194 (- pos (or (match-end 8) (match-end 5))))
17195 (t 'day))))
17196 ans))
17198 (defun org-toggle-timestamp-type ()
17199 "Toggle the type (<active> or [inactive]) of a time stamp."
17200 (interactive)
17201 (when (org-at-timestamp-p t)
17202 (let ((beg (match-beginning 0)) (end (match-end 0))
17203 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17204 (save-excursion
17205 (goto-char beg)
17206 (while (re-search-forward "[][<>]" end t)
17207 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17208 t t)))
17209 (message "Timestamp is now %sactive"
17210 (if (equal (char-after beg) ?<) "" "in")))))
17212 (defun org-at-clock-log-p nil
17213 "Is the cursor on the clock log line?"
17214 (save-excursion
17215 (move-beginning-of-line 1)
17218 (defvar org-clock-history) ; defined in org-clock.el
17219 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17220 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17221 "Change the date in the time stamp at point.
17222 The date will be changed by N times WHAT. WHAT can be `day', `month',
17223 `year', `minute', `second'. If WHAT is not given, the cursor position
17224 in the timestamp determines what will be changed.
17226 (let ((origin (point)) origin-cat
17227 with-hm inactive
17228 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17229 org-ts-what
17230 extra rem
17231 ts time time0 fixnext clrgx)
17232 (if (not (org-at-timestamp-p t))
17233 (error "Not at a timestamp"))
17234 (if (and (not what) (eq org-ts-what 'bracket))
17235 (org-toggle-timestamp-type)
17236 ;; Point isn't on brackets. Remember the part of the time-stamp
17237 ;; the point was in. Indeed, size of time-stamps may change,
17238 ;; but point must be kept in the same category nonetheless.
17239 (setq origin-cat org-ts-what)
17240 (if (and (not what) (not (eq org-ts-what 'day))
17241 org-display-custom-times
17242 (get-text-property (point) 'display)
17243 (not (get-text-property (1- (point)) 'display)))
17244 (setq org-ts-what 'day))
17245 (setq org-ts-what (or what org-ts-what)
17246 inactive (= (char-after (match-beginning 0)) ?\[)
17247 ts (match-string 0))
17248 (replace-match "")
17249 (when (string-match
17250 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17251 ts)
17252 (setq extra (match-string 1 ts))
17253 (if suppress-tmp-delay
17254 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17256 (setq with-hm t))
17257 (setq time0 (org-parse-time-string ts))
17258 (when (and updown
17259 (eq org-ts-what 'minute)
17260 (not current-prefix-arg))
17261 ;; This looks like s-up and s-down. Change by one rounding step.
17262 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17263 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17264 (setcar (cdr time0) (+ (nth 1 time0)
17265 (if (> n 0) (- rem) (- dm rem))))))
17266 (setq time
17267 (encode-time (or (car time0) 0)
17268 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17269 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17270 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17271 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17272 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17273 (nthcdr 6 time0)))
17274 (when (and (member org-ts-what '(hour minute))
17275 extra
17277 (setq extra (org-modify-ts-extra
17278 extra
17279 (if (eq org-ts-what 'hour) 2 5)
17280 n dm)))
17281 (when (integerp org-ts-what)
17282 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17283 (if (eq what 'calendar)
17284 (let ((cal-date (org-get-date-from-calendar)))
17285 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17286 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17287 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17288 (setcar time0 (or (car time0) 0))
17289 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17290 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17291 (setq time (apply 'encode-time time0))))
17292 ;; Insert the new time-stamp, and ensure point stays in the same
17293 ;; category as before (i.e. not after the last position in that
17294 ;; category).
17295 (let ((pos (point)))
17296 ;; Stay before inserted string. `save-excursion' is of no use.
17297 (setq org-last-changed-timestamp
17298 (org-insert-time-stamp time with-hm inactive nil nil extra))
17299 (goto-char pos))
17300 (save-match-data
17301 (looking-at org-ts-regexp3)
17302 (goto-char (cond
17303 ;; `day' category ends before `hour' if any, or at
17304 ;; the end of the day name.
17305 ((eq origin-cat 'day)
17306 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17307 ((eq origin-cat 'hour) (min (match-end 7) origin))
17308 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17309 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17310 ;; `year' and `month' have both fixed size: point
17311 ;; couldn't have moved into another part.
17312 (t origin))))
17313 ;; Update clock if on a CLOCK line.
17314 (org-clock-update-time-maybe)
17315 ;; Maybe adjust the closest clock in `org-clock-history'
17316 (when org-clock-adjust-closest
17317 (if (not (and (org-at-clock-log-p)
17318 (< 1 (length (delq nil (mapcar 'marker-position
17319 org-clock-history))))))
17320 (message "No clock to adjust")
17321 (cond ((save-excursion ; fix previous clock?
17322 (re-search-backward org-ts-regexp0 nil t)
17325 ((save-excursion ; fix next clock?
17326 (re-search-backward org-ts-regexp0 nil t)
17329 (save-window-excursion
17330 ;; Find closest clock to point, adjust the previous/next one in history
17331 (let* ((p (save-excursion (org-back-to-heading t)))
17332 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17333 (clfixnth
17334 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17335 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17336 (if (not clfixpos)
17337 (message "No clock to adjust")
17338 (save-excursion
17339 (org-goto-marker-or-bmk clfixpos)
17340 (org-show-subtree)
17341 (when (re-search-forward clrgx nil t)
17342 (goto-char (match-beginning 1))
17343 (let (org-clock-adjust-closest)
17344 (org-timestamp-change n org-ts-what updown))
17345 (message "Clock adjusted in %s for heading: %s"
17346 (file-name-nondirectory (buffer-file-name))
17347 (org-get-heading t t)))))))))
17348 ;; Try to recenter the calendar window, if any.
17349 (if (and org-calendar-follow-timestamp-change
17350 (get-buffer-window "*Calendar*" t)
17351 (memq org-ts-what '(day month year)))
17352 (org-recenter-calendar (time-to-days time))))))
17354 (defun org-modify-ts-extra (s pos n dm)
17355 "Change the different parts of the lead-time and repeat fields in timestamp."
17356 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17357 ng h m new rem)
17358 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17359 (cond
17360 ((or (org-pos-in-match-range pos 2)
17361 (org-pos-in-match-range pos 3))
17362 (setq m (string-to-number (match-string 3 s))
17363 h (string-to-number (match-string 2 s)))
17364 (if (org-pos-in-match-range pos 2)
17365 (setq h (+ h n))
17366 (setq n (* dm (org-no-warnings (signum n))))
17367 (when (not (= 0 (setq rem (% m dm))))
17368 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17369 (setq m (+ m n)))
17370 (if (< m 0) (setq m (+ m 60) h (1- h)))
17371 (if (> m 59) (setq m (- m 60) h (1+ h)))
17372 (setq h (min 24 (max 0 h)))
17373 (setq ng 1 new (format "-%02d:%02d" h m)))
17374 ((org-pos-in-match-range pos 6)
17375 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17376 ((org-pos-in-match-range pos 5)
17377 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17379 ((org-pos-in-match-range pos 9)
17380 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17381 ((org-pos-in-match-range pos 8)
17382 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17384 (when ng
17385 (setq s (concat
17386 (substring s 0 (match-beginning ng))
17387 new
17388 (substring s (match-end ng))))))
17389 s))
17391 (defun org-recenter-calendar (date)
17392 "If the calendar is visible, recenter it to DATE."
17393 (let ((cwin (get-buffer-window "*Calendar*" t)))
17394 (when cwin
17395 (let ((calendar-move-hook nil))
17396 (with-selected-window cwin
17397 (calendar-goto-date (if (listp date) date
17398 (calendar-gregorian-from-absolute date))))))))
17400 (defun org-goto-calendar (&optional arg)
17401 "Go to the Emacs calendar at the current date.
17402 If there is a time stamp in the current line, go to that date.
17403 A prefix ARG can be used to force the current date."
17404 (interactive "P")
17405 (let ((tsr org-ts-regexp) diff
17406 (calendar-move-hook nil)
17407 (calendar-view-holidays-initially-flag nil)
17408 (calendar-view-diary-initially-flag nil))
17409 (if (or (org-at-timestamp-p)
17410 (save-excursion
17411 (beginning-of-line 1)
17412 (looking-at (concat ".*" tsr))))
17413 (let ((d1 (time-to-days (current-time)))
17414 (d2 (time-to-days
17415 (org-time-string-to-time (match-string 1)))))
17416 (setq diff (- d2 d1))))
17417 (calendar)
17418 (calendar-goto-today)
17419 (if (and diff (not arg)) (calendar-forward-day diff))))
17421 (defun org-get-date-from-calendar ()
17422 "Return a list (month day year) of date at point in calendar."
17423 (with-current-buffer "*Calendar*"
17424 (save-match-data
17425 (calendar-cursor-to-date))))
17427 (defun org-date-from-calendar ()
17428 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17429 If there is already a time stamp at the cursor position, update it."
17430 (interactive)
17431 (if (org-at-timestamp-p t)
17432 (org-timestamp-change 0 'calendar)
17433 (let ((cal-date (org-get-date-from-calendar)))
17434 (org-insert-time-stamp
17435 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17437 (defcustom org-effort-durations
17438 `(("h" . 60)
17439 ("d" . ,(* 60 8))
17440 ("w" . ,(* 60 8 5))
17441 ("m" . ,(* 60 8 5 4))
17442 ("y" . ,(* 60 8 5 40)))
17443 "Conversion factor to minutes for an effort modifier.
17445 Each entry has the form (MODIFIER . MINUTES).
17447 In an effort string, a number followed by MODIFIER is multiplied
17448 by the specified number of MINUTES to obtain an effort in
17449 minutes.
17453 :group 'org-agenda
17454 :version "24.1"
17455 :type '(alist :key-type (string :tag "Modifier")
17456 :value-type (number :tag "Minutes")))
17458 (defun org-minutes-to-clocksum-string (m)
17459 "Format number of minutes as a clocksum string.
17460 The format is determined by `org-time-clocksum-format',
17461 `org-time-clocksum-use-fractional' and
17462 `org-time-clocksum-fractional-format' and
17463 `org-time-clocksum-use-effort-durations'."
17464 (let ((clocksum "")
17465 (m (round m)) ; Don't allow fractions of minutes
17466 h d w mo y fmt n)
17467 (setq h (if org-time-clocksum-use-effort-durations
17468 (cdr (assoc "h" org-effort-durations)) 60)
17469 d (if org-time-clocksum-use-effort-durations
17470 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17471 w (if org-time-clocksum-use-effort-durations
17472 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17473 mo (if org-time-clocksum-use-effort-durations
17474 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17475 y (if org-time-clocksum-use-effort-durations
17476 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17477 ;; fractional format
17478 (if org-time-clocksum-use-fractional
17479 (cond
17480 ;; single format string
17481 ((stringp org-time-clocksum-fractional-format)
17482 (format org-time-clocksum-fractional-format (/ m (float h))))
17483 ;; choice of fractional formats for different time units
17484 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17485 (> (/ (truncate m) (* y d h)) 0))
17486 (format fmt (/ m (* y d (float h)))))
17487 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17488 (> (/ (truncate m) (* mo d h)) 0))
17489 (format fmt (/ m (* mo d (float h)))))
17490 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17491 (> (/ (truncate m) (* w d h)) 0))
17492 (format fmt (/ m (* w d (float h)))))
17493 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17494 (> (/ (truncate m) (* d h)) 0))
17495 (format fmt (/ m (* d (float h)))))
17496 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17497 (> (/ (truncate m) h) 0))
17498 (format fmt (/ m (float h))))
17499 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17500 (format fmt m))
17501 ;; fall back to smallest time unit with a format
17502 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17503 (format fmt (/ m (float h))))
17504 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17505 (format fmt (/ m (* d (float h)))))
17506 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17507 (format fmt (/ m (* w d (float h)))))
17508 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17509 (format fmt (/ m (* mo d (float h)))))
17510 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17511 (format fmt (/ m (* y d (float h))))))
17512 ;; standard (non-fractional) format, with single format string
17513 (if (stringp org-time-clocksum-format)
17514 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17515 ;; separate formats components
17516 (and (setq fmt (plist-get org-time-clocksum-format :years))
17517 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17518 (plist-get org-time-clocksum-format :require-years))
17519 (setq clocksum (concat clocksum (format fmt n))
17520 m (- m (* n y d h))))
17521 (and (setq fmt (plist-get org-time-clocksum-format :months))
17522 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17523 (plist-get org-time-clocksum-format :require-months))
17524 (setq clocksum (concat clocksum (format fmt n))
17525 m (- m (* n mo d h))))
17526 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17527 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17528 (plist-get org-time-clocksum-format :require-weeks))
17529 (setq clocksum (concat clocksum (format fmt n))
17530 m (- m (* n w d h))))
17531 (and (setq fmt (plist-get org-time-clocksum-format :days))
17532 (or (> (setq n (/ (truncate m) (* d h))) 0)
17533 (plist-get org-time-clocksum-format :require-days))
17534 (setq clocksum (concat clocksum (format fmt n))
17535 m (- m (* n d h))))
17536 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17537 (or (> (setq n (/ (truncate m) h)) 0)
17538 (plist-get org-time-clocksum-format :require-hours))
17539 (setq clocksum (concat clocksum (format fmt n))
17540 m (- m (* n h))))
17541 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17542 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17543 (setq clocksum (concat clocksum (format fmt m))))
17544 ;; return formatted time duration
17545 clocksum))))
17547 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17548 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17549 "Org mode version 8.0")
17551 (defun org-hours-to-clocksum-string (n)
17552 (org-minutes-to-clocksum-string (* n 60)))
17554 (defun org-hh:mm-string-to-minutes (s)
17555 "Convert a string H:MM to a number of minutes.
17556 If the string is just a number, interpret it as minutes.
17557 In fact, the first hh:mm or number in the string will be taken,
17558 there can be extra stuff in the string.
17559 If no number is found, the return value is 0."
17560 (cond
17561 ((integerp s) s)
17563 (+ (* (string-to-number (match-string 1 s)) 60)
17564 (string-to-number (match-string 2 s))))
17566 (string-to-number (match-string 1 s)))
17567 (t 0)))
17569 (defcustom org-image-actual-width t
17570 "Should we use the actual width of images when inlining them?
17572 When set to `t', always use the image width.
17574 When set to a number, use imagemagick (when available) to set
17575 the image's width to this value.
17577 When set to a number in a list, try to get the width from any
17578 #+ATTR.* keyword if it matches a width specification like
17580 #+ATTR_HTML: :width 300px
17582 and fall back on that number if none is found.
17584 When set to nil, try to get the width from an #+ATTR.* keyword
17585 and fall back on the original width if none is found.
17587 This requires Emacs >= 24.1, build with imagemagick support."
17588 :group 'org-appearance
17589 :version "24.4"
17590 :package-version '(Org . "8.0")
17591 :type '(choice
17592 (const :tag "Use the image width" t)
17593 (integer :tag "Use a number of pixels")
17594 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17595 (const :tag "Use #+ATTR* or don't resize" nil)))
17597 (defcustom org-agenda-inhibit-startup nil
17598 "Inhibit startup when preparing agenda buffers.
17599 When this variable is `t' (the default), the initialization of
17600 the Org agenda buffers is inhibited: e.g. the visibility state
17601 is not set, the tables are not re-aligned, etc."
17602 :type 'boolean
17603 :version "24.3"
17604 :group 'org-agenda)
17606 (defun org-duration-string-to-minutes (s &optional output-to-string)
17607 "Convert a duration string S to minutes.
17609 A bare number is interpreted as minutes, modifiers can be set by
17610 customizing `org-effort-durations' (which see).
17612 Entries containing a colon are interpreted as H:MM by
17613 `org-hh:mm-string-to-minutes'."
17614 (let ((result 0)
17616 (regexp-opt (mapcar 'car org-effort-durations))
17618 (while (string-match re s)
17619 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17620 (string-to-number (match-string 1 s))))
17621 (setq s (replace-match "" nil t s)))
17622 (setq result (floor result))
17623 (incf result (org-hh:mm-string-to-minutes s))
17624 (if output-to-string (number-to-string result) result)))
17626 ;;;; Files
17628 (defun org-save-all-org-buffers ()
17629 "Save all Org-mode buffers without user confirmation."
17630 (interactive)
17631 (message "Saving all Org-mode buffers...")
17632 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17633 (when (featurep 'org-id) (org-id-locations-save))
17634 (message "Saving all Org-mode buffers... done"))
17636 (defun org-revert-all-org-buffers ()
17637 "Revert all Org-mode buffers.
17638 Prompt for confirmation when there are unsaved changes.
17639 Be sure you know what you are doing before letting this function
17640 overwrite your changes.
17642 This function is useful in a setup where one tracks org files
17643 with a version control system, to revert on one machine after pulling
17644 changes from another. I believe the procedure must be like this:
17646 1. M-x org-save-all-org-buffers
17647 2. Pull changes from the other machine, resolve conflicts
17648 3. M-x org-revert-all-org-buffers"
17649 (interactive)
17650 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17651 (error "Abort"))
17652 (save-excursion
17653 (save-window-excursion
17654 (mapc
17655 (lambda (b)
17656 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17657 (with-current-buffer b buffer-file-name))
17658 (org-pop-to-buffer-same-window b)
17659 (revert-buffer t 'no-confirm)))
17660 (buffer-list))
17661 (when (and (featurep 'org-id) org-id-track-globally)
17662 (org-id-locations-load)))))
17664 ;;;; Agenda files
17666 ;;;###autoload
17667 (defun org-switchb (&optional arg)
17668 "Switch between Org buffers.
17669 With one prefix argument, restrict available buffers to files.
17670 With two prefix arguments, restrict available buffers to agenda files.
17672 Defaults to `iswitchb' for buffer name completion.
17673 Set `org-completion-use-ido' to make it use ido instead."
17674 (interactive "P")
17675 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17676 ((equal arg '(16)) (org-buffer-list 'agenda))
17677 (t (org-buffer-list))))
17678 (org-completion-use-iswitchb org-completion-use-iswitchb)
17679 (org-completion-use-ido org-completion-use-ido))
17680 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17681 (setq org-completion-use-iswitchb t))
17682 (org-pop-to-buffer-same-window
17683 (org-icompleting-read "Org buffer: "
17684 (mapcar 'list (mapcar 'buffer-name blist))
17685 nil t))))
17687 ;;; Define some older names previously used for this functionality
17688 ;;;###autoload
17689 (defalias 'org-ido-switchb 'org-switchb)
17690 ;;;###autoload
17691 (defalias 'org-iswitchb 'org-switchb)
17693 (defun org-buffer-list (&optional predicate exclude-tmp)
17694 "Return a list of Org buffers.
17695 PREDICATE can be `export', `files' or `agenda'.
17697 export restrict the list to Export buffers.
17698 files restrict the list to buffers visiting Org files.
17699 agenda restrict the list to buffers visiting agenda files.
17701 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17702 (let* ((bfn nil)
17703 (agenda-files (and (eq predicate 'agenda)
17704 (mapcar 'file-truename (org-agenda-files t))))
17705 (filter
17706 (cond
17707 ((eq predicate 'files)
17708 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17709 ((eq predicate 'export)
17710 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17711 ((eq predicate 'agenda)
17712 (lambda (b)
17713 (with-current-buffer b
17714 (and (derived-mode-p 'org-mode)
17715 (setq bfn (buffer-file-name b))
17716 (member (file-truename bfn) agenda-files)))))
17717 (t (lambda (b) (with-current-buffer b
17718 (or (derived-mode-p 'org-mode)
17719 (string-match "\*Org .*Export"
17720 (buffer-name b)))))))))
17721 (delq nil
17722 (mapcar
17723 (lambda(b)
17724 (if (and (funcall filter b)
17725 (or (not exclude-tmp)
17726 (not (string-match "tmp" (buffer-name b)))))
17727 b
17728 nil))
17729 (buffer-list)))))
17731 (defun org-agenda-files (&optional unrestricted archives)
17732 "Get the list of agenda files.
17733 Optional UNRESTRICTED means return the full list even if a restriction
17734 is currently in place.
17735 When ARCHIVES is t, include all archive files that are really being
17736 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17737 `org-agenda-archives-mode' is t."
17738 (let ((files
17739 (cond
17740 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17741 ((stringp org-agenda-files) (org-read-agenda-file-list))
17742 ((listp org-agenda-files) org-agenda-files)
17743 (t (error "Invalid value of `org-agenda-files'")))))
17744 (setq files (apply 'append
17745 (mapcar (lambda (f)
17746 (if (file-directory-p f)
17747 (directory-files
17748 f t org-agenda-file-regexp)
17749 (list f)))
17750 files)))
17751 (when org-agenda-skip-unavailable-files
17752 (setq files (delq nil
17753 (mapcar (function
17754 (lambda (file)
17755 (and (file-readable-p file) file)))
17756 files))))
17757 (when (or (eq archives t)
17758 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17759 (setq files (org-add-archive-files files)))
17760 files))
17762 (defun org-agenda-file-p (&optional file)
17763 "Return non-nil, if FILE is an agenda file.
17764 If FILE is omitted, use the file associated with the current
17765 buffer."
17766 (member (or file (buffer-file-name))
17767 (org-agenda-files t)))
17769 (defun org-edit-agenda-file-list ()
17770 "Edit the list of agenda files.
17771 Depending on setup, this either uses customize to edit the variable
17772 `org-agenda-files', or it visits the file that is holding the list. In the
17773 latter case, the buffer is set up in a way that saving it automatically kills
17774 the buffer and restores the previous window configuration."
17775 (interactive)
17776 (if (stringp org-agenda-files)
17777 (let ((cw (current-window-configuration)))
17778 (find-file org-agenda-files)
17779 (org-set-local 'org-window-configuration cw)
17780 (org-add-hook 'after-save-hook
17781 (lambda ()
17782 (set-window-configuration
17783 (prog1 org-window-configuration
17784 (kill-buffer (current-buffer))))
17785 (org-install-agenda-files-menu)
17786 (message "New agenda file list installed"))
17787 nil 'local)
17788 (message "%s" (substitute-command-keys
17790 (customize-variable 'org-agenda-files)))
17792 (defun org-store-new-agenda-file-list (list)
17793 "Set new value for the agenda file list and save it correctly."
17794 (if (stringp org-agenda-files)
17795 (let ((fe (org-read-agenda-file-list t)) b u)
17796 (while (setq b (find-buffer-visiting org-agenda-files))
17797 (kill-buffer b))
17798 (with-temp-file org-agenda-files
17799 (insert
17800 (mapconcat
17801 (lambda (f) ;; Keep un-expanded entries.
17802 (if (setq u (assoc f fe))
17803 (cdr u)
17804 f))
17807 (let ((org-mode-hook nil) (org-inhibit-startup t)
17808 (org-insert-mode-line-in-empty-file nil))
17809 (setq org-agenda-files list)
17810 (customize-save-variable 'org-agenda-files org-agenda-files))))
17812 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17813 "Read the list of agenda files from a file.
17814 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17815 filenames, used by `org-store-new-agenda-file-list' to write back
17816 un-expanded file names."
17817 (when (file-directory-p org-agenda-files)
17818 (error "`org-agenda-files' cannot be a single directory"))
17819 (when (stringp org-agenda-files)
17820 (with-temp-buffer
17821 (insert-file-contents org-agenda-files)
17822 (mapcar
17823 (lambda (f)
17824 (let ((e (expand-file-name (substitute-in-file-name f)
17825 org-directory)))
17826 (if pair-with-expansion
17827 (cons e f)
17828 e)))
17831 ;;;###autoload
17832 (defun org-cycle-agenda-files ()
17833 "Cycle through the files in `org-agenda-files'.
17834 If the current buffer visits an agenda file, find the next one in the list.
17835 If the current buffer does not, find the first agenda file."
17836 (interactive)
17837 (let* ((fs (org-agenda-files t))
17838 (files (append fs (list (car fs))))
17839 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17840 file)
17841 (unless files (error "No agenda files"))
17842 (catch 'exit
17843 (while (setq file (pop files))
17844 (if (equal (file-truename file) tcf)
17845 (when (car files)
17846 (find-file (car files))
17847 (throw 'exit t))))
17848 (find-file (car fs)))
17849 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17851 (defun org-agenda-file-to-front (&optional to-end)
17852 "Move/add the current file to the top of the agenda file list.
17853 If the file is not present in the list, it is added to the front. If it is
17854 present, it is moved there. With optional argument TO-END, add/move to the
17855 end of the list."
17856 (interactive "P")
17857 (let ((org-agenda-skip-unavailable-files nil)
17858 (file-alist (mapcar (lambda (x)
17859 (cons (file-truename x) x))
17860 (org-agenda-files t)))
17861 (ctf (file-truename
17862 (or buffer-file-name
17863 (error "Please save the current buffer to a file"))))
17864 x had)
17865 (setq x (assoc ctf file-alist) had x)
17867 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17868 (if to-end
17869 (setq file-alist (append (delq x file-alist) (list x)))
17870 (setq file-alist (cons x (delq x file-alist))))
17871 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17872 (org-install-agenda-files-menu)
17873 (message "File %s to %s of agenda file list"
17874 (if had "moved" "added") (if to-end "end" "front"))))
17876 (defun org-remove-file (&optional file)
17877 "Remove current file from the list of files in variable `org-agenda-files'.
17878 These are the files which are being checked for agenda entries.
17879 Optional argument FILE means use this file instead of the current."
17880 (interactive)
17881 (let* ((org-agenda-skip-unavailable-files nil)
17882 (file (or file buffer-file-name
17883 (error "Current buffer does not visit a file")))
17884 (true-file (file-truename file))
17885 (afile (abbreviate-file-name file))
17886 (files (delq nil (mapcar
17887 (lambda (x)
17888 (if (equal true-file
17889 (file-truename x))
17890 nil x))
17891 (org-agenda-files t)))))
17892 (if (not (= (length files) (length (org-agenda-files t))))
17893 (progn
17894 (org-store-new-agenda-file-list files)
17895 (org-install-agenda-files-menu)
17896 (message "Removed file: %s" afile))
17897 (message "File was not in list: %s (not removed)" afile))))
17899 (defun org-file-menu-entry (file)
17900 (vector file (list 'find-file file) t))
17902 (defun org-check-agenda-file (file)
17903 "Make sure FILE exists. If not, ask user what to do."
17904 (when (not (file-exists-p file))
17905 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17906 (abbreviate-file-name file))
17907 (let ((r (downcase (read-char-exclusive))))
17908 (cond
17909 ((equal r ?r)
17910 (org-remove-file file)
17911 (throw 'nextfile t))
17912 (t (error "Abort"))))))
17914 (defun org-get-agenda-file-buffer (file)
17915 "Get a buffer visiting FILE. If the buffer needs to be created, add
17916 it to the list of buffers which might be released later."
17917 (let ((buf (org-find-base-buffer-visiting file)))
17918 (if buf
17919 buf ; just return it
17920 ;; Make a new buffer and remember it
17921 (setq buf (find-file-noselect file))
17922 (if buf (push buf org-agenda-new-buffers))
17923 buf)))
17925 (defun org-release-buffers (blist)
17926 "Release all buffers in list, asking the user for confirmation when needed.
17927 When a buffer is unmodified, it is just killed. When modified, it is saved
17928 \(if the user agrees) and then killed."
17929 (let (buf file)
17930 (while (setq buf (pop blist))
17931 (setq file (buffer-file-name buf))
17932 (when (and (buffer-modified-p buf)
17933 file
17934 (y-or-n-p (format "Save file %s? " file)))
17935 (with-current-buffer buf (save-buffer)))
17936 (kill-buffer buf))))
17938 (defun org-agenda-prepare-buffers (files)
17939 "Create buffers for all agenda files, protect archived trees and comments."
17940 (interactive)
17941 (let ((pa '(:org-archived t))
17942 (pc '(:org-comment t))
17943 (pall '(:org-archived t :org-comment t))
17944 (inhibit-read-only t)
17945 (org-inhibit-startup org-agenda-inhibit-startup)
17946 (rea (concat ":" org-archive-tag ":"))
17947 file re)
17948 (setq org-tag-alist-for-agenda nil
17949 org-tag-groups-alist-for-agenda nil)
17950 (save-excursion
17951 (save-restriction
17952 (while (setq file (pop files))
17953 (catch 'nextfile
17954 (if (bufferp file)
17955 (set-buffer file)
17956 (org-check-agenda-file file)
17957 (set-buffer (org-get-agenda-file-buffer file)))
17958 (widen)
17959 (org-set-regexps-and-options-for-tags)
17960 (org-refresh-category-properties)
17961 (org-refresh-properties org-effort-property 'org-effort)
17962 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
17963 (setq org-todo-keywords-for-agenda
17964 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17965 (setq org-done-keywords-for-agenda
17966 (append org-done-keywords-for-agenda org-done-keywords))
17967 (setq org-todo-keyword-alist-for-agenda
17968 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17969 (setq org-drawers-for-agenda
17970 (append org-drawers-for-agenda org-drawers))
17971 (unless (equal org-tag-alist-for-agenda org-tag-alist)
17972 (setq org-tag-alist-for-agenda
17973 (append org-tag-alist-for-agenda org-tag-alist)))
17974 (if org-group-tags
17975 (setq org-tag-groups-alist-for-agenda
17976 (org-uniquify-alist
17977 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
17978 (org-with-silent-modifications
17979 (save-excursion
17980 (remove-text-properties (point-min) (point-max) pall)
17981 (when org-agenda-skip-archived-trees
17982 (goto-char (point-min))
17983 (while (re-search-forward rea nil t)
17984 (if (org-at-heading-p t)
17985 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17986 (goto-char (point-min))
17987 (setq re (format org-heading-keyword-regexp-format
17988 org-comment-string))
17989 (while (re-search-forward re nil t)
17990 (add-text-properties
17991 (match-beginning 0) (org-end-of-subtree t) pc))))))))
17992 (setq org-todo-keywords-for-agenda
17993 (org-uniquify org-todo-keywords-for-agenda))
17994 (setq org-todo-keyword-alist-for-agenda
17995 (org-uniquify org-todo-keyword-alist-for-agenda))))
17997 \f
17998 ;;;; CDLaTeX minor mode
18000 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18001 "Keymap for the minor `org-cdlatex-mode'.")
18003 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18004 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18005 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18006 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18007 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18009 (defvar org-cdlatex-texmathp-advice-is-done nil
18010 "Flag remembering if we have applied the advice to texmathp already.")
18012 (define-minor-mode org-cdlatex-mode
18013 "Toggle the minor `org-cdlatex-mode'.
18014 This mode supports entering LaTeX environment and math in LaTeX fragments
18015 in Org-mode.
18017 nil " OCDL" nil
18018 (when org-cdlatex-mode
18019 (require 'cdlatex)
18020 (run-hooks 'cdlatex-mode-hook)
18021 (cdlatex-compute-tables))
18022 (unless org-cdlatex-texmathp-advice-is-done
18023 (setq org-cdlatex-texmathp-advice-is-done t)
18024 (defadvice texmathp (around org-math-always-on activate)
18025 "Always return t in org-mode buffers.
18026 This is because we want to insert math symbols without dollars even outside
18027 the LaTeX math segments. If Orgmode thinks that point is actually inside
18028 an embedded LaTeX fragment, let texmathp do its job.
18030 (interactive)
18031 (let (p)
18032 (cond
18033 ((not (derived-mode-p 'org-mode)) ad-do-it)
18034 ((eq this-command 'cdlatex-math-symbol)
18035 (setq ad-return-value t
18036 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18037 (t
18038 (let ((p (org-inside-LaTeX-fragment-p)))
18039 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18040 (setq ad-return-value t
18041 texmathp-why '("Org-mode embedded math" . 0))
18042 (if p ad-do-it)))))))))
18044 (defun turn-on-org-cdlatex ()
18045 "Unconditionally turn on `org-cdlatex-mode'."
18046 (org-cdlatex-mode 1))
18048 (defun org-try-cdlatex-tab ()
18049 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18050 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18051 - inside a LaTeX fragment, or
18052 - after the first word in a line, where an abbreviation expansion could
18053 insert a LaTeX environment."
18054 (when org-cdlatex-mode
18055 (cond
18056 ;; Before any word on the line: No expansion possible.
18058 ;; Just after first word on the line: Expand it. Make sure it
18059 ;; cannot happen on headlines, though.
18060 ((save-excursion
18061 (skip-chars-backward "a-zA-Z0-9*")
18063 (and (bolp) (not (org-at-heading-p))))
18064 (cdlatex-tab) t)
18065 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18067 (defun org-cdlatex-underscore-caret (&optional arg)
18068 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18069 Revert to the normal definition outside of these fragments."
18070 (interactive "P")
18071 (if (org-inside-LaTeX-fragment-p)
18072 (call-interactively 'cdlatex-sub-superscript)
18073 (let (org-cdlatex-mode)
18074 (call-interactively (key-binding (vector last-input-event))))))
18076 (defun org-cdlatex-math-modify (&optional arg)
18077 "Execute `cdlatex-math-modify' in LaTeX fragments.
18078 Revert to the normal definition outside of these fragments."
18079 (interactive "P")
18080 (if (org-inside-LaTeX-fragment-p)
18081 (call-interactively 'cdlatex-math-modify)
18082 (let (org-cdlatex-mode)
18083 (call-interactively (key-binding (vector last-input-event))))))
18086 \f
18087 ;;;; LaTeX fragments
18089 (defvar org-latex-regexps
18091 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18094 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18098 "Regular expressions for matching embedded LaTeX.")
18100 (defun org-inside-LaTeX-fragment-p ()
18101 "Test if point is inside a LaTeX fragment.
18103 sequence appearing also before point.
18104 Even though the matchers for math are configurable, this function assumes
18106 delimiters are skipped when they have been removed by customization.
18107 The return value is nil, or a cons cell with the delimiter and the
18108 position of this delimiter.
18110 This function does a reasonably good job, but can locally be fooled by
18111 for example currency specifications. For example it will assume being in
18113 fragments that are properly closed, but during editing, we have to live
18114 with the uncertainty caused by missing closing delimiters. This function
18115 looks only before point, not after."
18116 (catch 'exit
18117 (let ((pos (point))
18118 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18119 (lim (progn
18121 (point)))
18122 dd-on str (start 0) m re)
18123 (goto-char pos)
18124 (when dodollar
18126 re (nth 1 (assoc "$" org-latex-regexps)))
18127 (while (string-match re str start)
18128 (cond
18129 ((= (match-end 0) (length str))
18130 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18131 ((= (match-end 0) (- (length str) 5))
18132 (throw 'exit nil))
18133 (t (setq start (match-end 0))))))
18134 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18135 (goto-char pos)
18136 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18137 (and (match-beginning 2) (throw 'exit nil))
18138 ;; count $$
18140 (setq dd-on (not dd-on)))
18141 (goto-char pos)
18142 (if dd-on (cons "$$" m))))))
18144 (defun org-inside-latex-macro-p ()
18145 "Is point inside a LaTeX macro or its arguments?"
18146 (save-match-data
18147 (org-in-regexp
18150 (defvar org-latex-fragment-image-overlays nil
18151 "List of overlays carrying the images of latex fragments.")
18152 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18154 (defun org-remove-latex-fragment-image-overlays ()
18155 "Remove all overlays with LaTeX fragment images in current buffer."
18156 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18157 (setq org-latex-fragment-image-overlays nil))
18159 (defun org-preview-latex-fragment (&optional subtree)
18160 "Preview the LaTeX fragment at point, or all locally or globally.
18161 If the cursor is in a LaTeX fragment, create the image and overlay
18162 it over the source code. If there is no fragment at point, display
18163 all fragments in the current text, from one headline to the next. With
18164 prefix SUBTREE, display all fragments in the current subtree. With a
18166 the cursor is before the first headline,
18167 display all fragments in the buffer.
18169 (interactive "P")
18170 (unless buffer-file-name
18171 (error "Can't preview LaTeX fragment in a non-file buffer"))
18172 (org-remove-latex-fragment-image-overlays)
18173 (save-excursion
18174 (save-restriction
18175 (let (beg end at msg)
18176 (cond
18177 ((or (equal subtree '(16))
18178 (not (save-excursion
18179 (re-search-backward org-outline-regexp-bol nil t))))
18180 (setq beg (point-min) end (point-max)
18181 msg "Creating images for buffer...%s"))
18182 ((equal subtree '(4))
18183 (org-back-to-heading)
18184 (setq beg (point) end (org-end-of-subtree t)
18185 msg "Creating images for subtree...%s"))
18186 (t
18187 (if (setq at (org-inside-LaTeX-fragment-p))
18188 (goto-char (max (point-min) (- (cdr at) 2)))
18189 (org-back-to-heading))
18190 (setq beg (point) end (progn (outline-next-heading) (point))
18191 msg (if at "Creating image...%s"
18192 "Creating images for entry...%s"))))
18193 (message msg "")
18194 (narrow-to-region beg end)
18195 (goto-char beg)
18196 (org-format-latex
18197 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18198 (file-name-nondirectory
18199 buffer-file-name)))
18200 default-directory 'overlays msg at 'forbuffer
18201 org-latex-create-formula-image-program)
18202 (message msg "done. Use `C-c C-c' to remove images.")))))
18204 (defun org-format-latex (prefix &optional dir overlays msg at
18205 forbuffer processing-type)
18206 "Replace LaTeX fragments with links to an image, and produce images.
18207 Some of the options can be changed using the variable
18208 `org-format-latex-options'."
18209 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18210 (let* ((prefixnodir (file-name-nondirectory prefix))
18211 (absprefix (expand-file-name prefix dir))
18212 (todir (file-name-directory absprefix))
18213 (opt org-format-latex-options)
18214 (optnew org-format-latex-options)
18215 (matchers (plist-get opt :matchers))
18216 (re-list org-latex-regexps)
18217 (cnt 0) txt hash link beg end re e checkdir
18218 string
18219 m n block-type block linkfile movefile ov)
18220 ;; Check the different regular expressions
18221 (while (setq e (pop re-list))
18222 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18224 (when (member m matchers)
18225 (goto-char (point-min))
18226 (while (re-search-forward re nil t)
18227 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18228 (or (not overlays)
18229 (not (eq (get-char-property (match-beginning n)
18230 'org-overlay-type)
18231 'org-latex-overlay))))
18232 (cond
18233 ((eq processing-type 'verbatim))
18234 ((eq processing-type 'mathjax)
18235 ;; Prepare for MathJax processing.
18236 (setq string (match-string n))
18237 (when (member m '("$" "$1"))
18238 (save-excursion
18239 (delete-region (match-beginning n) (match-end n))
18240 (goto-char (match-beginning n))
18242 ((or (eq processing-type 'dvipng)
18243 (eq processing-type 'imagemagick))
18244 ;; Process to an image.
18245 (setq txt (match-string n)
18246 beg (match-beginning n) end (match-end n)
18247 cnt (1+ cnt))
18248 (let ((face (face-at-point))
18249 (fg (plist-get opt :foreground))
18250 (bg (plist-get opt :background))
18251 ;; Ensure full list is printed.
18252 print-length print-level)
18253 (when forbuffer
18254 ;; Get the colors from the face at point.
18255 (goto-char beg)
18256 (when (eq fg 'auto)
18257 (setq fg (face-attribute face :foreground nil 'default)))
18258 (when (eq bg 'auto)
18259 (setq bg (face-attribute face :background nil 'default)))
18260 (setq optnew (copy-sequence opt))
18261 (plist-put optnew :foreground fg)
18262 (plist-put optnew :background bg))
18263 (setq hash (sha1 (prin1-to-string
18264 (list org-format-latex-header
18265 org-latex-default-packages-alist
18266 org-latex-packages-alist
18267 org-format-latex-options
18268 forbuffer txt fg bg)))
18269 linkfile (format "%s_%s.png" prefix hash)
18270 movefile (format "%s_%s.png" absprefix hash)))
18271 (setq link (concat block "[[file:" linkfile "]]" block))
18272 (if msg (message msg cnt))
18273 (goto-char beg)
18274 (unless checkdir ; Ensure the directory exists.
18275 (setq checkdir t)
18276 (or (file-directory-p todir) (make-directory todir t)))
18277 (unless (file-exists-p movefile)
18278 (org-create-formula-image
18279 txt movefile optnew forbuffer processing-type))
18280 (if overlays
18281 (progn
18282 (mapc (lambda (o)
18283 (if (eq (overlay-get o 'org-overlay-type)
18284 'org-latex-overlay)
18285 (delete-overlay o)))
18286 (overlays-in beg end))
18287 (setq ov (make-overlay beg end))
18288 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18289 (if (featurep 'xemacs)
18290 (progn
18291 (overlay-put ov 'invisible t)
18292 (overlay-put
18293 ov 'end-glyph
18294 (make-glyph (vector 'png :file movefile))))
18295 (overlay-put
18296 ov 'display
18297 (list 'image :type 'png :file movefile :ascent 'center)))
18298 (push ov org-latex-fragment-image-overlays)
18299 (goto-char end))
18300 (delete-region beg end)
18301 (insert (org-add-props link
18302 (list 'org-latex-src
18303 (replace-regexp-in-string
18305 'org-latex-src-embed-type
18306 (if block-type 'paragraph 'character))))))
18307 ((eq processing-type 'mathml)
18308 ;; Process to MathML
18309 (unless (save-match-data (org-format-latex-mathml-available-p))
18310 (error "LaTeX to MathML converter not configured"))
18311 (setq txt (match-string n)
18312 beg (match-beginning n) end (match-end n)
18313 cnt (1+ cnt))
18314 (if msg (message msg cnt))
18315 (goto-char beg)
18316 (delete-region beg end)
18317 (insert (org-format-latex-as-mathml
18318 txt block-type prefix dir)))
18319 (t
18320 (error "Unknown conversion type %s for latex fragments"
18321 processing-type)))))))))
18323 (defun org-create-math-formula (latex-frag &optional mathml-file)
18324 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18325 Use `org-latex-to-mathml-convert-command'. If the conversion is
18327 elements otherwise return nil. When MATHML-FILE is specified,
18328 write the results in to that file. When invoked as an
18329 interactive command, prompt for LATEX-FRAG, with initial value
18330 set to the current active region and echo the results for user
18331 inspection."
18332 (interactive (list (let ((frag (when (org-region-active-p)
18333 (buffer-substring-no-properties
18334 (region-beginning) (region-end)))))
18335 (read-string "LaTeX Fragment: " frag nil frag))))
18336 (unless latex-frag (error "Invalid latex-frag"))
18337 (let* ((tmp-in-file (file-relative-name
18338 (make-temp-name (expand-file-name "ltxmathml-in"))))
18339 (ignore (write-region latex-frag nil tmp-in-file))
18340 (tmp-out-file (file-relative-name
18341 (make-temp-name (expand-file-name "ltxmathml-out"))))
18342 (cmd (format-spec
18343 org-latex-to-mathml-convert-command
18344 `((?j . ,(shell-quote-argument
18345 (expand-file-name org-latex-to-mathml-jar-file)))
18346 (?I . ,(shell-quote-argument tmp-in-file))
18347 (?o . ,(shell-quote-argument tmp-out-file)))))
18348 mathml shell-command-output)
18349 (when (org-called-interactively-p 'any)
18350 (unless (org-format-latex-mathml-available-p)
18351 (error "LaTeX to MathML converter not configured")))
18352 (message "Running %s" cmd)
18353 (setq shell-command-output (shell-command-to-string cmd))
18354 (setq mathml
18355 (when (file-readable-p tmp-out-file)
18356 (with-current-buffer (find-file-noselect tmp-out-file t)
18357 (goto-char (point-min))
18358 (when (re-search-forward
18359 (concat
18360 (regexp-quote
18363 (regexp-quote "</math>")) nil t)
18364 (prog1 (match-string 0) (kill-buffer))))))
18365 (cond
18366 (mathml
18367 (setq mathml
18369 (when mathml-file
18370 (write-region mathml nil mathml-file))
18371 (when (org-called-interactively-p 'any)
18372 (message mathml)))
18373 ((message "LaTeX to MathML conversion failed")
18374 (message shell-command-output)))
18375 (delete-file tmp-in-file)
18376 (when (file-exists-p tmp-out-file)
18377 (delete-file tmp-out-file))
18378 mathml))
18380 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18381 prefix &optional dir)
18382 "Use `org-create-math-formula' but check local cache first."
18383 (let* ((absprefix (expand-file-name prefix dir))
18384 (print-length nil) (print-level nil)
18385 (formula-id (concat
18386 "formula-"
18387 (sha1
18388 (prin1-to-string
18389 (list latex-frag
18390 org-latex-to-mathml-convert-command)))))
18391 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18392 (formula-cache-dir (file-name-directory formula-cache)))
18394 (unless (file-directory-p formula-cache-dir)
18395 (make-directory formula-cache-dir t))
18397 (unless (file-exists-p formula-cache)
18398 (org-create-math-formula latex-frag formula-cache))
18400 (if (file-exists-p formula-cache)
18401 ;; Successful conversion. Return the link to MathML file.
18402 (org-add-props
18403 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18405 'org-latex-src-embed-type (if latex-frag-type
18406 'paragraph 'character)))
18407 ;; Failed conversion. Return the LaTeX fragment verbatim
18408 latex-frag)))
18410 (defun org-create-formula-image (string tofile options buffer &optional type)
18411 "Create an image from LaTeX source using dvipng or convert.
18412 This function calls either `org-create-formula-image-with-dvipng'
18413 or `org-create-formula-image-with-imagemagick' depending on the
18414 value of `org-latex-create-formula-image-program' or on the value
18415 of the optional TYPE variable.
18417 Note: ultimately these two function should be combined as they
18418 share a good deal of logic."
18419 (org-check-external-command
18420 "latex" "needed to convert LaTeX fragments to images")
18421 (funcall
18422 (case (or type org-latex-create-formula-image-program)
18423 ('dvipng
18424 (org-check-external-command
18425 "dvipng" "needed to convert LaTeX fragments to images")
18426 #'org-create-formula-image-with-dvipng)
18427 ('imagemagick
18428 (org-check-external-command
18429 "convert" "you need to install imagemagick")
18430 #'org-create-formula-image-with-imagemagick)
18431 (t (error
18432 "invalid value of `org-latex-create-formula-image-program'")))
18433 string tofile options buffer))
18435 (declare-function org-export--get-global-options "ox" (&optional backend))
18436 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18437 (defun org-create-formula--latex-header ()
18438 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18439 (org-latex-guess-inputenc
18440 (org-splice-latex-header
18441 org-format-latex-header
18442 org-latex-default-packages-alist
18443 org-latex-packages-alist t
18444 (plist-get
18445 (org-combine-plists
18446 (org-export--get-global-options 'latex)
18447 (org-export--get-inbuffer-options 'latex))
18448 :latex-header))))
18450 ;; This function borrows from Ganesh Swami's latex2png.el
18451 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18452 "This calls dvipng."
18453 (require 'ox-latex)
18454 (let* ((tmpdir (if (featurep 'xemacs)
18455 (temp-directory)
18456 temporary-file-directory))
18457 (texfilebase (make-temp-name
18458 (expand-file-name "orgtex" tmpdir)))
18459 (texfile (concat texfilebase ".tex"))
18460 (dvifile (concat texfilebase ".dvi"))
18461 (pngfile (concat texfilebase ".png"))
18462 (fnh (if (featurep 'xemacs)
18463 (font-height (face-font 'default))
18464 (face-attribute 'default :height nil)))
18465 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18466 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18467 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18468 "Black"))
18469 (bg (or (plist-get options (if buffer :background :html-background))
18470 "Transparent")))
18471 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18472 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18473 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18474 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18475 (let ((latex-header (org-create-formula--latex-header)))
18476 (with-temp-file texfile
18477 (insert latex-header)
18479 (let ((dir default-directory))
18480 (condition-case nil
18481 (progn
18482 (cd tmpdir)
18483 (call-process "latex" nil nil nil texfile))
18484 (error nil))
18485 (cd dir))
18486 (if (not (file-exists-p dvifile))
18487 (progn (message "Failed to create dvi file from %s" texfile) nil)
18488 (condition-case nil
18489 (if (featurep 'xemacs)
18490 (call-process "dvipng" nil nil nil
18491 "-fg" fg "-bg" bg
18492 "-T" "tight"
18493 "-o" pngfile
18494 dvifile)
18495 (call-process "dvipng" nil nil nil
18496 "-fg" fg "-bg" bg
18497 "-D" dpi
18498 ;;"-x" scale "-y" scale
18499 "-T" "tight"
18500 "-o" pngfile
18501 dvifile))
18502 (error nil))
18503 (if (not (file-exists-p pngfile))
18504 (if org-format-latex-signal-error
18505 (error "Failed to create png file from %s" texfile)
18506 (message "Failed to create png file from %s" texfile)
18507 nil)
18508 ;; Use the requested file name and clean up
18509 (copy-file pngfile tofile 'replace)
18510 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18511 (if (file-exists-p (concat texfilebase e))
18512 (delete-file (concat texfilebase e))))
18513 pngfile))))
18515 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18516 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18517 "This calls convert, which is included into imagemagick."
18518 (require 'ox-latex)
18519 (let* ((tmpdir (if (featurep 'xemacs)
18520 (temp-directory)
18521 temporary-file-directory))
18522 (texfilebase (make-temp-name
18523 (expand-file-name "orgtex" tmpdir)))
18524 (texfile (concat texfilebase ".tex"))
18525 (pdffile (concat texfilebase ".pdf"))
18526 (pngfile (concat texfilebase ".png"))
18527 (fnh (if (featurep 'xemacs)
18528 (font-height (face-font 'default))
18529 (face-attribute 'default :height nil)))
18530 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18531 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18532 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18533 "black"))
18534 (bg (or (plist-get options (if buffer :background :html-background))
18535 "white")))
18536 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18537 (setq fg (org-latex-color-format fg)))
18538 (if (eq bg 'default) (setq bg (org-latex-color :background))
18539 (setq bg (org-latex-color-format
18540 (if (string= bg "Transparent") "white" bg))))
18541 (let ((latex-header (org-create-formula--latex-header)))
18542 (with-temp-file texfile
18543 (insert latex-header)
18549 string
18552 (org-latex-compile texfile t)
18553 (if (not (file-exists-p pdffile))
18554 (progn (message "Failed to create pdf file from %s" texfile) nil)
18555 (condition-case nil
18556 (if (featurep 'xemacs)
18557 (call-process "convert" nil nil nil
18558 "-density" "96"
18559 "-trim"
18560 "-antialias"
18561 pdffile
18562 "-quality" "100"
18563 ;; "-sharpen" "0x1.0"
18564 pngfile)
18565 (call-process "convert" nil nil nil
18566 "-density" dpi
18567 "-trim"
18568 "-antialias"
18569 pdffile
18570 "-quality" "100"
18571 ;; "-sharpen" "0x1.0"
18572 pngfile))
18573 (error nil))
18574 (if (not (file-exists-p pngfile))
18575 (if org-format-latex-signal-error
18576 (error "Failed to create png file from %s" texfile)
18577 (message "Failed to create png file from %s" texfile)
18578 nil)
18579 ;; Use the requested file name and clean up
18580 (copy-file pngfile tofile 'replace)
18581 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18582 (if (file-exists-p (concat texfilebase e))
18583 (delete-file (concat texfilebase e))))
18584 pngfile))))
18586 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18587 "Fill a LaTeX header template TPL.
18588 In the template, the following place holders will be recognized:
18591 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18593 [NO-PACKAGES] do not include PKG
18594 [EXTRA] the string EXTRA
18595 [NO-EXTRA] do not include EXTRA
18597 For backward compatibility, if both the positive and the negative place
18599 assumed to be present at the end of the template.
18600 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18601 EXTRA is a string.
18602 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18603 (let (rpl (end ""))
18605 (setq rpl (if (or (match-end 1) (not def-pkg))
18606 "" (org-latex-packages-to-string def-pkg snippets-p t))
18607 tpl (replace-match rpl t t tpl))
18608 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18611 (setq rpl (if (or (match-end 1) (not pkg))
18612 "" (org-latex-packages-to-string pkg snippets-p t))
18613 tpl (replace-match rpl t t tpl))
18614 (if pkg (setq end
18616 (org-latex-packages-to-string pkg snippets-p)))))
18619 (setq rpl (if (or (match-end 1) (not extra))
18621 tpl (replace-match rpl t t tpl))
18627 tpl)))
18629 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18631 (setq pkg (mapconcat (lambda(p)
18632 (cond
18633 ((stringp p) p)
18634 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18635 (format "%% Package %s omitted" (cadr p)))
18636 ((equal "" (car p))
18638 (t
18640 (car p) (cadr p)))))
18641 pkg
18645 (defun org-dvipng-color (attr)
18646 "Return a RGB color specification for dvipng."
18647 (apply 'format "rgb %s %s %s"
18648 (mapcar 'org-normalize-color
18649 (if (featurep 'xemacs)
18650 (color-rgb-components
18651 (face-property 'default
18652 (cond ((eq attr :foreground) 'foreground)
18653 ((eq attr :background) 'background))))
18654 (color-values (face-attribute 'default attr nil))))))
18656 (defun org-dvipng-color-format (color-name)
18657 "Convert COLOR-NAME to a RGB color value for dvipng."
18658 (apply 'format "rgb %s %s %s"
18659 (mapcar 'org-normalize-color
18660 (color-values color-name))))
18662 (defun org-latex-color (attr)
18663 "Return a RGB color for the LaTeX color package."
18664 (apply 'format "%s,%s,%s"
18665 (mapcar 'org-normalize-color
18666 (if (featurep 'xemacs)
18667 (color-rgb-components
18668 (face-property 'default
18669 (cond ((eq attr :foreground) 'foreground)
18670 ((eq attr :background) 'background))))
18671 (color-values (face-attribute 'default attr nil))))))
18673 (defun org-latex-color-format (color-name)
18674 "Convert COLOR-NAME to a RGB color value."
18675 (apply 'format "%s,%s,%s"
18676 (mapcar 'org-normalize-color
18677 (color-values color-name))))
18679 (defun org-normalize-color (value)
18680 "Return string to be used as color value for an RGB component."
18681 (format "%g" (/ value 65535.0)))
18684 \f
18685 ;; Image display
18687 (defvar org-inline-image-overlays nil)
18688 (make-variable-buffer-local 'org-inline-image-overlays)
18690 (defun org-toggle-inline-images (&optional include-linked)
18691 "Toggle the display of inline images.
18692 INCLUDE-LINKED is passed to `org-display-inline-images'."
18693 (interactive "P")
18694 (if org-inline-image-overlays
18695 (progn
18696 (org-remove-inline-images)
18697 (message "Inline image display turned off"))
18698 (org-display-inline-images include-linked)
18699 (if (and (org-called-interactively-p)
18700 org-inline-image-overlays)
18701 (message "%d images displayed inline"
18702 (length org-inline-image-overlays))
18703 (message "No images to display inline"))))
18705 (defun org-redisplay-inline-images ()
18706 "Refresh the display of inline images."
18707 (interactive)
18708 (if (not org-inline-image-overlays)
18709 (org-toggle-inline-images)
18710 (org-toggle-inline-images)
18711 (org-toggle-inline-images)))
18713 (defun org-display-inline-images (&optional include-linked refresh beg end)
18714 "Display inline images.
18715 Normally only links without a description part are inlined, because this
18716 is how it will work for export. When INCLUDE-LINKED is set, also links
18717 with a description part will be inlined. This can be nice for a quick
18718 look at those images, but it does not reflect what exported files will look
18719 like.
18720 When REFRESH is set, refresh existing images between BEG and END.
18721 This will create new image displays only if necessary.
18722 BEG and END default to the buffer boundaries."
18723 (interactive "P")
18724 (unless refresh
18725 (org-remove-inline-images)
18726 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18727 (save-excursion
18728 (save-restriction
18729 (widen)
18730 (setq beg (or beg (point-min)) end (or end (point-max)))
18731 (goto-char beg)
18733 (substring (org-image-file-name-regexp) 0 -2)
18735 (case-fold-search t)
18736 old file ov img type attrwidth width)
18737 (while (re-search-forward re end t)
18738 (setq old (get-char-property-and-overlay (match-beginning 1)
18739 'org-image-overlay)
18740 file (expand-file-name
18741 (concat (or (match-string 3) "") (match-string 4))))
18742 (when (image-type-available-p 'imagemagick)
18743 (setq attrwidth (if (or (listp org-image-actual-width)
18744 (null org-image-actual-width))
18745 (save-excursion
18746 (save-match-data
18747 (when (re-search-backward
18749 (save-excursion
18751 (string-to-number (match-string 1))))))
18752 width (cond ((eq org-image-actual-width t) nil)
18753 ((null org-image-actual-width) attrwidth)
18754 ((numberp org-image-actual-width)
18755 org-image-actual-width)
18756 ((listp org-image-actual-width)
18757 (or attrwidth (car org-image-actual-width))))
18758 type (if width 'imagemagick)))
18759 (when (file-exists-p file)
18760 (if (and (car-safe old) refresh)
18761 (image-refresh (overlay-get (cdr old) 'display))
18762 (setq img (save-match-data (create-image file type nil :width width)))
18763 (when img
18764 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18765 (overlay-put ov 'display img)
18766 (overlay-put ov 'face 'default)
18767 (overlay-put ov 'org-image-overlay t)
18768 (overlay-put ov 'modification-hooks
18769 (list 'org-display-inline-remove-overlay))
18770 (push ov org-inline-image-overlays)))))))))
18772 (define-obsolete-function-alias
18773 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18775 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18776 "Remove inline-display overlay if a corresponding region is modified."
18777 (let ((inhibit-modification-hooks t))
18778 (when (and ov after)
18779 (delete ov org-inline-image-overlays)
18780 (delete-overlay ov))))
18782 (defun org-remove-inline-images ()
18783 "Remove inline display of images."
18784 (interactive)
18785 (mapc 'delete-overlay org-inline-image-overlays)
18786 (setq org-inline-image-overlays nil))
18788 ;;;; Key bindings
18790 ;; Outline functions from `outline-mode-prefix-map'
18791 ;; that can be remapped in Org:
18792 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18793 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18794 (define-key org-mode-map [remap outline-forward-same-level]
18795 'org-forward-heading-same-level)
18796 (define-key org-mode-map [remap outline-backward-same-level]
18797 'org-backward-heading-same-level)
18798 (define-key org-mode-map [remap show-branches]
18799 'org-kill-note-or-show-branches)
18800 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18801 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18802 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18804 ;; Outline functions from `outline-mode-prefix-map' that can not
18805 ;; be remapped in Org:
18806 ;;
18807 ;; - the column "key binding" shows whether the Outline function is still
18808 ;; available in Org mode on the same key that it has been bound to in
18809 ;; Outline mode:
18810 ;; - "overridden": key used for a different functionality in Org mode
18811 ;; - else: key still bound to the same Outline function in Org mode
18812 ;;
18813 ;; | Outline function | key binding | Org replacement |
18814 ;; |------------------------------------+-------------+-----------------------|
18815 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18816 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18817 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18818 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18819 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18820 ;; | `show-entry' | overridden | no replacement |
18821 ;; | `show-children' | `C-c C-i' | visibility cycling |
18822 ;; | `show-branches' | `C-c C-k' | still same function |
18823 ;; | `show-subtree' | overridden | visibility cycling |
18824 ;; | `show-all' | overridden | no replacement |
18825 ;; | `hide-subtree' | overridden | visibility cycling |
18826 ;; | `hide-body' | overridden | no replacement |
18827 ;; | `hide-entry' | overridden | visibility cycling |
18828 ;; | `hide-leaves' | overridden | no replacement |
18829 ;; | `hide-sublevels' | overridden | no replacement |
18830 ;; | `hide-other' | overridden | no replacement |
18832 ;; Make `C-c C-x' a prefix key
18833 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18835 ;; TAB key with modifiers
18836 (org-defkey org-mode-map "\C-i" 'org-cycle)
18837 (org-defkey org-mode-map [(tab)] 'org-cycle)
18838 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18840 ;; The following line is necessary under Suse GNU/Linux
18841 (unless (featurep 'xemacs)
18842 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18843 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18844 (define-key org-mode-map [backtab] 'org-shifttab)
18846 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18847 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18848 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18850 ;; Cursor keys with modifiers
18851 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18852 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18853 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18854 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18856 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18857 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18858 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18859 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18861 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18862 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18863 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18864 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18866 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18867 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18868 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18869 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18871 ;; Babel keys
18872 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18873 (mapc (lambda (pair)
18874 (define-key org-babel-map (car pair) (cdr pair)))
18875 org-babel-key-bindings)
18877 ;;; Extra keys for tty access.
18878 ;; We only set them when really needed because otherwise the
18879 ;; menus don't show the simple keys
18881 (when (or org-use-extra-keys
18882 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18883 (not window-system))
18884 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18885 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18886 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18887 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18888 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18889 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18890 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18891 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18892 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18893 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18894 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18895 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18896 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18897 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18898 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18899 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18900 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18901 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18902 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18903 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18904 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18905 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18906 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18907 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18908 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18909 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18910 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18911 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18913 ;; All the other keys
18915 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18916 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18917 (if (boundp 'narrow-map)
18918 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18919 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18920 (if (boundp 'narrow-map)
18921 (org-defkey narrow-map "b" 'org-narrow-to-block)
18922 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18923 (if (boundp 'narrow-map)
18924 (org-defkey narrow-map "e" 'org-narrow-to-element)
18925 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18926 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18927 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18928 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18929 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18930 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18931 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18932 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18933 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
18934 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
18935 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18936 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18937 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18938 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18939 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18940 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18941 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18942 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
18943 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18944 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18945 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18946 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18947 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18948 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18949 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18950 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18951 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18953 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18954 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18955 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18956 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18957 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18958 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18959 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18960 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18961 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18962 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18963 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18964 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18965 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18966 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18967 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18968 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18969 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18970 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18971 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18972 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18973 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18975 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18976 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18977 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18978 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18979 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18980 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18981 (org-defkey org-mode-map "\C-c^" 'org-sort)
18982 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18983 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18984 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18985 (org-defkey org-mode-map [remap open-line] 'org-open-line)
18986 (org-defkey org-mode-map "\C-m" 'org-return)
18987 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18988 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18989 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18990 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18991 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18992 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18993 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18994 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18995 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18996 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18997 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18998 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18999 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19000 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19001 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19002 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19003 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19004 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19005 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19006 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19007 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19008 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19009 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19011 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19012 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19013 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19015 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19016 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19017 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19018 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19019 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19020 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19021 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19022 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19023 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19024 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19025 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19026 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19027 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19029 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19030 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19031 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19032 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19033 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19034 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19035 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19036 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19037 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19039 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19040 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19041 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19042 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19043 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19045 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19047 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19049 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19050 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19052 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19055 (when (featurep 'xemacs)
19056 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19059 (defconst org-speed-commands-default
19060 '(
19061 ("Outline Navigation")
19062 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19063 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19064 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19065 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19066 ("F" . org-next-block)
19067 ("B" . org-previous-block)
19068 ("u" . (org-speed-move-safe 'outline-up-heading))
19069 ("j" . org-goto)
19070 ("g" . (org-refile t))
19071 ("Outline Visibility")
19072 ("c" . org-cycle)
19073 ("C" . org-shifttab)
19074 (" " . org-display-outline-path)
19075 ("s" . org-narrow-to-subtree)
19076 ("=" . org-columns)
19077 ("Outline Structure Editing")
19078 ("U" . org-shiftmetaup)
19079 ("D" . org-shiftmetadown)
19080 ("r" . org-metaright)
19081 ("l" . org-metaleft)
19082 ("R" . org-shiftmetaright)
19083 ("L" . org-shiftmetaleft)
19084 ("i" . (progn (forward-char 1) (call-interactively
19085 'org-insert-heading-respect-content)))
19086 ("^" . org-sort)
19087 ("w" . org-refile)
19088 ("a" . org-archive-subtree-default-with-confirmation)
19089 ("@" . org-mark-subtree)
19090 ("#" . org-toggle-comment)
19091 ("Clock Commands")
19092 ("I" . org-clock-in)
19093 ("O" . org-clock-out)
19094 ("Meta Data Editing")
19095 ("t" . org-todo)
19096 ("," . (org-priority))
19097 ("0" . (org-priority ?\ ))
19098 ("1" . (org-priority ?A))
19099 ("2" . (org-priority ?B))
19100 ("3" . (org-priority ?C))
19101 (":" . org-set-tags-command)
19102 ("e" . org-set-effort)
19103 ("E" . org-inc-effort)
19104 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19105 (org-entry-put (point) "APPT_WARNTIME" m)))
19106 ("Agenda Views etc")
19107 ("v" . org-agenda)
19108 ("/" . org-sparse-tree)
19109 ("Misc")
19110 ("o" . org-open-at-point)
19111 ("?" . org-speed-command-help)
19112 ("<" . (org-agenda-set-restriction-lock 'subtree))
19113 (">" . (org-agenda-remove-restriction-lock))
19114 )
19115 "The default speed commands.")
19117 (defun org-print-speed-command (e)
19118 (if (> (length (car e)) 1)
19119 (progn
19121 (princ (car e))
19123 (princ (make-string (length (car e)) ?-))
19125 (princ (car e))
19126 (princ " ")
19127 (if (symbolp (cdr e))
19128 (princ (symbol-name (cdr e)))
19129 (prin1 (cdr e)))
19132 (defun org-speed-command-help ()
19133 "Show the available speed commands."
19134 (interactive)
19135 (if (not org-use-speed-commands)
19136 (error "Speed commands are not activated, customize `org-use-speed-commands'")
19137 (with-output-to-temp-buffer "*Help*"
19139 (mapc 'org-print-speed-command org-speed-commands-user)
19142 (mapc 'org-print-speed-command org-speed-commands-default))
19143 (with-current-buffer "*Help*"
19144 (setq truncate-lines t))))
19146 (defun org-speed-move-safe (cmd)
19147 "Execute CMD, but make sure that the cursor always ends up in a headline.
19148 If not, return to the original position and throw an error."
19149 (interactive)
19150 (let ((pos (point)))
19151 (call-interactively cmd)
19152 (unless (and (bolp) (org-at-heading-p))
19153 (goto-char pos)
19154 (error "Boundary reached while executing %s" cmd))))
19156 (defvar org-self-insert-command-undo-counter 0)
19158 (defvar org-table-auto-blank-field) ; defined in org-table.el
19159 (defvar org-speed-command nil)
19161 (define-obsolete-function-alias
19162 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19164 (defun org-speed-command-activate (keys)
19165 "Hook for activating single-letter speed commands.
19166 `org-speed-commands-default' specifies a minimal command set.
19167 Use `org-speed-commands-user' for further customization."
19168 (when (or (and (bolp) (looking-at org-outline-regexp))
19169 (and (functionp org-use-speed-commands)
19170 (funcall org-use-speed-commands)))
19171 (cdr (assoc keys (append org-speed-commands-user
19172 org-speed-commands-default)))))
19174 (define-obsolete-function-alias
19175 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19177 (defun org-babel-speed-command-activate (keys)
19178 "Hook for activating single-letter code block commands."
19179 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19180 (cdr (assoc keys org-babel-key-bindings))))
19182 (defcustom org-speed-command-hook
19183 '(org-speed-command-default-hook org-babel-speed-command-hook)
19184 "Hook for activating speed commands at strategic locations.
19185 Hook functions are called in sequence until a valid handler is
19186 found.
19188 Each hook takes a single argument, a user-pressed command key
19189 which is also a `self-insert-command' from the global map.
19191 Within the hook, examine the cursor position and the command key
19192 and return nil or a valid handler as appropriate. Handler could
19193 be one of an interactive command, a function, or a form.
19195 Set `org-use-speed-commands' to non-nil value to enable this
19196 hook. The default setting is `org-speed-command-activate'."
19197 :group 'org-structure
19198 :version "24.1"
19199 :type 'hook)
19201 (defun org-self-insert-command (N)
19202 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19203 If the cursor is in a table looking at whitespace, the whitespace is
19204 overwritten, and the table is not marked as requiring realignment."
19205 (interactive "p")
19206 (org-check-before-invisible-edit 'insert)
19207 (cond
19208 ((and org-use-speed-commands
19209 (setq org-speed-command
19210 (run-hook-with-args-until-success
19211 'org-speed-command-hook (this-command-keys))))
19212 (cond
19213 ((commandp org-speed-command)
19214 (setq this-command org-speed-command)
19215 (call-interactively org-speed-command))
19216 ((functionp org-speed-command)
19217 (funcall org-speed-command))
19218 ((and org-speed-command (listp org-speed-command))
19219 (eval org-speed-command))
19220 (t (let (org-use-speed-commands)
19221 (call-interactively 'org-self-insert-command)))))
19222 ((and
19223 (org-table-p)
19224 (progn
19225 ;; check if we blank the field, and if that triggers align
19226 (and (featurep 'org-table) org-table-auto-blank-field
19227 (member last-command
19228 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19230 ;; got extra space, this field does not determine column width
19231 (let (org-table-may-need-update) (org-table-blank-field))
19232 ;; no extra space, this field may determine column width
19233 (org-table-blank-field)))
19234 t)
19235 (eq N 1)
19237 (let (org-table-may-need-update)
19238 (goto-char (1- (match-end 0)))
19239 (backward-delete-char 1)
19240 (goto-char (match-beginning 0))
19241 (self-insert-command N)))
19242 (t
19243 (setq org-table-may-need-update t)
19244 (self-insert-command N)
19245 (org-fix-tags-on-the-fly)
19246 (if org-self-insert-cluster-for-undo
19247 (if (not (eq last-command 'org-self-insert-command))
19248 (setq org-self-insert-command-undo-counter 1)
19249 (if (>= org-self-insert-command-undo-counter 20)
19250 (setq org-self-insert-command-undo-counter 1)
19251 (and (> org-self-insert-command-undo-counter 0)
19252 buffer-undo-list (listp buffer-undo-list)
19253 (not (cadr buffer-undo-list)) ; remove nil entry
19254 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19255 (setq org-self-insert-command-undo-counter
19256 (1+ org-self-insert-command-undo-counter))))))))
19258 (defun org-check-before-invisible-edit (kind)
19259 "Check is editing if kind KIND would be dangerous with invisible text around.
19260 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19261 ;; First, try to get out of here as quickly as possible, to reduce overhead
19262 (if (and org-catch-invisible-edits
19263 (or (not (boundp 'visible-mode)) (not visible-mode))
19264 (or (get-char-property (point) 'invisible)
19265 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19266 ;; OK, we need to take a closer look
19267 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19268 (invisible-before-point (if (bobp) nil (get-char-property
19269 (1- (point)) 'invisible)))
19270 (border-and-ok-direction
19271 (or
19272 ;; Check if we are acting predictably before invisible text
19273 (and invisible-at-point (not invisible-before-point)
19274 (memq kind '(insert delete-backward)))
19275 ;; Check if we are acting predictably after invisible text
19276 ;; This works not well, and I have turned it off. It seems
19277 ;; better to always show and stop after invisible text.
19278 ;; (and (not invisible-at-point) invisible-before-point
19279 ;; (memq kind '(insert delete)))
19280 )))
19281 (when (or (memq invisible-at-point '(outline org-hide-block t))
19282 (memq invisible-before-point '(outline org-hide-block t)))
19283 (if (eq org-catch-invisible-edits 'error)
19284 (error "Editing in invisible areas is prohibited - make visible first"))
19285 (if (and org-custom-properties-overlays
19286 (y-or-n-p "Display invisible properties in this buffer? "))
19287 (org-toggle-custom-properties-visibility)
19288 ;; Make the area visible
19289 (save-excursion
19290 (if invisible-before-point
19291 (goto-char (previous-single-char-property-change
19292 (point) 'invisible)))
19293 (org-cycle))
19294 (cond
19295 ((eq org-catch-invisible-edits 'show)
19296 ;; That's it, we do the edit after showing
19297 (message
19298 "Unfolding invisible region around point before editing")
19299 (sit-for 1))
19300 ((and (eq org-catch-invisible-edits 'smart)
19301 border-and-ok-direction)
19302 (message "Unfolding invisible region around point before editing"))
19303 (t
19304 ;; Don't do the edit, make the user repeat it in full visibility
19305 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19307 (defun org-fix-tags-on-the-fly ()
19308 (when (and (equal (char-after (point-at-bol)) ?*)
19309 (org-at-heading-p))
19310 (org-align-tags-here org-tags-column)))
19312 (defun org-delete-backward-char (N)
19313 "Like `delete-backward-char', insert whitespace at field end in tables.
19314 When deleting backwards, in tables this function will insert whitespace in
19316 still be marked for re-alignment if the field did fill the entire column,
19317 because, in this case the deletion might narrow the column."
19318 (interactive "p")
19319 (save-match-data
19320 (org-check-before-invisible-edit 'delete-backward)
19321 (if (and (org-table-p)
19322 (eq N 1)
19323 (string-match "|" (buffer-substring (point-at-bol) (point)))
19324 (looking-at ".*?|"))
19325 (let ((pos (point))
19327 (c org-table-may-need-update))
19328 (backward-delete-char N)
19329 (if (not overwrite-mode)
19330 (progn
19331 (skip-chars-forward "^|")
19332 (insert " ")
19333 (goto-char (1- pos))))
19334 ;; noalign: if there were two spaces at the end, this field
19335 ;; does not determine the width of the column.
19336 (if noalign (setq org-table-may-need-update c)))
19337 (backward-delete-char N)
19338 (org-fix-tags-on-the-fly))))
19340 (defun org-delete-char (N)
19341 "Like `delete-char', but insert whitespace at field end in tables.
19342 When deleting characters, in tables this function will insert whitespace in
19344 still be marked for re-alignment if the field did fill the entire column,
19345 because, in this case the deletion might narrow the column."
19346 (interactive "p")
19347 (save-match-data
19348 (org-check-before-invisible-edit 'delete)
19349 (if (and (org-table-p)
19350 (not (bolp))
19351 (not (= (char-after) ?|))
19352 (eq N 1))
19353 (if (looking-at ".*?|")
19354 (let ((pos (point))
19356 (c org-table-may-need-update))
19357 (replace-match
19358 (concat (substring (match-string 0) 1 -1) " |") nil t)
19359 (goto-char pos)
19360 ;; noalign: if there were two spaces at the end, this field
19361 ;; does not determine the width of the column.
19362 (if noalign (setq org-table-may-need-update c)))
19363 (delete-char N))
19364 (delete-char N)
19365 (org-fix-tags-on-the-fly))))
19367 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19368 (put 'org-self-insert-command 'delete-selection t)
19369 (put 'orgtbl-self-insert-command 'delete-selection t)
19370 (put 'org-delete-char 'delete-selection 'supersede)
19371 (put 'org-delete-backward-char 'delete-selection 'supersede)
19372 (put 'org-yank 'delete-selection 'yank)
19374 ;; Make `flyspell-mode' delay after some commands
19375 (put 'org-self-insert-command 'flyspell-delayed t)
19376 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19377 (put 'org-delete-char 'flyspell-delayed t)
19378 (put 'org-delete-backward-char 'flyspell-delayed t)
19380 ;; Make pabbrev-mode expand after org-mode commands
19381 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19382 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19384 ;; How to do this: Measure non-white length of current string
19385 ;; If equal to column width, we should realign.
19387 (defun org-remap (map &rest commands)
19388 "In MAP, remap the functions given in COMMANDS.
19389 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19390 (let (new old)
19391 (while commands
19392 (setq old (pop commands) new (pop commands))
19393 (if (fboundp 'command-remapping)
19394 (org-defkey map (vector 'remap old) new)
19395 (substitute-key-definition old new map global-map)))))
19397 (defun org-transpose-words ()
19398 "Transpose words for Org.
19399 This uses the `org-mode-transpose-word-syntax-table' syntax
19400 table, which interprets characters in `org-emphasis-alist' as
19401 word constituants."
19402 (interactive)
19403 (with-syntax-table org-mode-transpose-word-syntax-table
19404 (call-interactively 'transpose-words)))
19405 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19407 (when (eq org-enable-table-editor 'optimized)
19408 ;; If the user wants maximum table support, we need to hijack
19409 ;; some standard editing functions
19410 (org-remap org-mode-map
19411 'self-insert-command 'org-self-insert-command
19412 'delete-char 'org-delete-char
19413 'delete-backward-char 'org-delete-backward-char)
19414 (org-defkey org-mode-map "|" 'org-force-self-insert))
19416 (defvar org-ctrl-c-ctrl-c-hook nil
19417 "Hook for functions attaching themselves to `C-c C-c'.
19419 This can be used to add additional functionality to the C-c C-c
19420 key which executes context-dependent commands. This hook is run
19421 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19422 run after the last test.
19424 Each function will be called with no arguments. The function
19425 must check if the context is appropriate for it to act. If yes,
19426 it should do its thing and then return a non-nil value. If the
19427 context is wrong, just do nothing and return nil.")
19429 (defvar org-ctrl-c-ctrl-c-final-hook nil
19430 "Hook for functions attaching themselves to `C-c C-c'.
19432 This can be used to add additional functionality to the C-c C-c
19433 key which executes context-dependent commands. This hook is run
19434 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19435 before the first test.
19437 Each function will be called with no arguments. The function
19438 must check if the context is appropriate for it to act. If yes,
19439 it should do its thing and then return a non-nil value. If the
19440 context is wrong, just do nothing and return nil.")
19442 (defvar org-tab-first-hook nil
19443 "Hook for functions to attach themselves to TAB.
19444 See `org-ctrl-c-ctrl-c-hook' for more information.
19445 This hook runs as the first action when TAB is pressed, even before
19446 `org-cycle' messes around with the `outline-regexp' to cater for
19447 inline tasks and plain list item folding.
19448 If any function in this hook returns t, any other actions that
19449 would have been caused by TAB (such as table field motion or visibility
19450 cycling) will not occur.")
19452 (defvar org-tab-after-check-for-table-hook nil
19453 "Hook for functions to attach themselves to TAB.
19454 See `org-ctrl-c-ctrl-c-hook' for more information.
19455 This hook runs after it has been established that the cursor is not in a
19456 table, but before checking if the cursor is in a headline or if global cycling
19457 should be done.
19458 If any function in this hook returns t, not other actions like visibility
19459 cycling will be done.")
19461 (defvar org-tab-after-check-for-cycling-hook nil
19462 "Hook for functions to attach themselves to TAB.
19463 See `org-ctrl-c-ctrl-c-hook' for more information.
19464 This hook runs after it has been established that not table field motion and
19465 not visibility should be done because of current context. This is probably
19466 the place where a package like yasnippets can hook in.")
19468 (defvar org-tab-before-tab-emulation-hook nil
19469 "Hook for functions to attach themselves to TAB.
19470 See `org-ctrl-c-ctrl-c-hook' for more information.
19471 This hook runs after every other options for TAB have been exhausted, but
19474 (defvar org-metaleft-hook nil
19475 "Hook for functions attaching themselves to `M-left'.
19476 See `org-ctrl-c-ctrl-c-hook' for more information.")
19477 (defvar org-metaright-hook nil
19478 "Hook for functions attaching themselves to `M-right'.
19479 See `org-ctrl-c-ctrl-c-hook' for more information.")
19480 (defvar org-metaup-hook nil
19481 "Hook for functions attaching themselves to `M-up'.
19482 See `org-ctrl-c-ctrl-c-hook' for more information.")
19483 (defvar org-metadown-hook nil
19484 "Hook for functions attaching themselves to `M-down'.
19485 See `org-ctrl-c-ctrl-c-hook' for more information.")
19486 (defvar org-shiftmetaleft-hook nil
19487 "Hook for functions attaching themselves to `M-S-left'.
19488 See `org-ctrl-c-ctrl-c-hook' for more information.")
19489 (defvar org-shiftmetaright-hook nil
19490 "Hook for functions attaching themselves to `M-S-right'.
19491 See `org-ctrl-c-ctrl-c-hook' for more information.")
19492 (defvar org-shiftmetaup-hook nil
19493 "Hook for functions attaching themselves to `M-S-up'.
19494 See `org-ctrl-c-ctrl-c-hook' for more information.")
19495 (defvar org-shiftmetadown-hook nil
19496 "Hook for functions attaching themselves to `M-S-down'.
19497 See `org-ctrl-c-ctrl-c-hook' for more information.")
19498 (defvar org-metareturn-hook nil
19499 "Hook for functions attaching themselves to `M-RET'.
19500 See `org-ctrl-c-ctrl-c-hook' for more information.")
19501 (defvar org-shiftup-hook nil
19502 "Hook for functions attaching themselves to `S-up'.
19503 See `org-ctrl-c-ctrl-c-hook' for more information.")
19504 (defvar org-shiftup-final-hook nil
19505 "Hook for functions attaching themselves to `S-up'.
19506 This one runs after all other options except shift-select have been excluded.
19507 See `org-ctrl-c-ctrl-c-hook' for more information.")
19508 (defvar org-shiftdown-hook nil
19509 "Hook for functions attaching themselves to `S-down'.
19510 See `org-ctrl-c-ctrl-c-hook' for more information.")
19511 (defvar org-shiftdown-final-hook nil
19512 "Hook for functions attaching themselves to `S-down'.
19513 This one runs after all other options except shift-select have been excluded.
19514 See `org-ctrl-c-ctrl-c-hook' for more information.")
19515 (defvar org-shiftleft-hook nil
19516 "Hook for functions attaching themselves to `S-left'.
19517 See `org-ctrl-c-ctrl-c-hook' for more information.")
19518 (defvar org-shiftleft-final-hook nil
19519 "Hook for functions attaching themselves to `S-left'.
19520 This one runs after all other options except shift-select have been excluded.
19521 See `org-ctrl-c-ctrl-c-hook' for more information.")
19522 (defvar org-shiftright-hook nil
19523 "Hook for functions attaching themselves to `S-right'.
19524 See `org-ctrl-c-ctrl-c-hook' for more information.")
19525 (defvar org-shiftright-final-hook nil
19526 "Hook for functions attaching themselves to `S-right'.
19527 This one runs after all other options except shift-select have been excluded.
19528 See `org-ctrl-c-ctrl-c-hook' for more information.")
19530 (defun org-modifier-cursor-error ()
19531 "Throw an error, a modified cursor command was applied in wrong context."
19532 (error "This command is active in special context like tables, headlines or items"))
19534 (defun org-shiftselect-error ()
19535 "Throw an error because Shift-Cursor command was applied in wrong context."
19536 (if (and (boundp 'shift-select-mode) shift-select-mode)
19537 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19538 (error "This command works only in special context like headlines or timestamps")))
19540 (defun org-call-for-shift-select (cmd)
19541 (let ((this-command-keys-shift-translated t))
19542 (call-interactively cmd)))
19544 (defun org-shifttab (&optional arg)
19545 "Global visibility cycling or move to previous table field.
19546 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
19547 on context.
19548 See the individual commands for more information."
19549 (interactive "P")
19550 (cond
19551 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19552 ((integerp arg)
19553 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19554 (message "Content view to level: %d" arg)
19555 (org-content (prefix-numeric-value arg2))
19556 (setq org-cycle-global-status 'overview)))
19557 (t (call-interactively 'org-global-cycle))))
19559 (defun org-shiftmetaleft ()
19560 "Promote subtree or delete table column.
19561 Calls `org-promote-subtree', `org-outdent-item-tree', or
19562 `org-table-delete-column', depending on context. See the
19563 individual commands for more information."
19564 (interactive)
19565 (cond
19566 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19567 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19568 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19569 ((if (not (org-region-active-p)) (org-at-item-p)
19570 (save-excursion (goto-char (region-beginning))
19571 (org-at-item-p)))
19572 (call-interactively 'org-outdent-item-tree))
19573 (t (org-modifier-cursor-error))))
19575 (defun org-shiftmetaright ()
19576 "Demote subtree or insert table column.
19577 Calls `org-demote-subtree', `org-indent-item-tree', or
19578 `org-table-insert-column', depending on context. See the
19579 individual commands for more information."
19580 (interactive)
19581 (cond
19582 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19583 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19584 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19585 ((if (not (org-region-active-p)) (org-at-item-p)
19586 (save-excursion (goto-char (region-beginning))
19587 (org-at-item-p)))
19588 (call-interactively 'org-indent-item-tree))
19589 (t (org-modifier-cursor-error))))
19591 (defun org-shiftmetaup (&optional arg)
19592 "Move subtree up or kill table row.
19593 Calls `org-move-subtree-up' or `org-table-kill-row' or
19594 `org-move-item-up' or `org-timestamp-up', depending on context.
19595 See the individual commands for more information."
19596 (interactive "P")
19597 (cond
19598 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19599 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19600 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19601 ((org-at-item-p) (call-interactively 'org-move-item-up))
19602 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19603 (call-interactively 'org-timestamp-up)))
19604 (t (call-interactively 'org-drag-line-backward))))
19606 (defun org-shiftmetadown (&optional arg)
19607 "Move subtree down or insert table row.
19608 Calls `org-move-subtree-down' or `org-table-insert-row' or
19609 `org-move-item-down' or `org-timestamp-up', depending on context.
19610 See the individual commands for more information."
19611 (interactive "P")
19612 (cond
19613 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19614 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19615 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19616 ((org-at-item-p) (call-interactively 'org-move-item-down))
19617 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19618 (call-interactively 'org-timestamp-down)))
19619 (t (call-interactively 'org-drag-line-forward))))
19621 (defsubst org-hidden-tree-error ()
19622 (error
19623 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19625 (defun org-metaleft (&optional arg)
19626 "Promote heading or move table column to left.
19627 Calls `org-do-promote' or `org-table-move-column', depending on context.
19628 With no specific context, calls the Emacs default `backward-word'.
19629 See the individual commands for more information."
19630 (interactive "P")
19631 (cond
19632 ((run-hook-with-args-until-success 'org-metaleft-hook))
19633 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19634 ((org-with-limited-levels
19635 (or (org-at-heading-p)
19636 (and (org-region-active-p)
19637 (save-excursion
19638 (goto-char (region-beginning))
19639 (org-at-heading-p)))))
19640 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19641 (call-interactively 'org-do-promote))
19642 ;; At an inline task.
19643 ((org-at-heading-p)
19644 (call-interactively 'org-inlinetask-promote))
19645 ((or (org-at-item-p)
19646 (and (org-region-active-p)
19647 (save-excursion
19648 (goto-char (region-beginning))
19649 (org-at-item-p))))
19650 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19651 (call-interactively 'org-outdent-item))
19652 (t (call-interactively 'backward-word))))
19654 (defun org-metaright (&optional arg)
19655 "Demote a subtree, a list item or move table column to right.
19656 In front of a drawer or a block keyword, indent it correctly.
19657 With no specific context, calls the Emacs default `forward-word'.
19658 See the individual commands for more information."
19659 (interactive "P")
19660 (cond
19661 ((run-hook-with-args-until-success 'org-metaright-hook))
19662 ((org-at-table-p) (call-interactively 'org-table-move-column))
19663 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19664 ((org-at-block-p) (call-interactively 'org-indent-block))
19665 ((org-with-limited-levels
19666 (or (org-at-heading-p)
19667 (and (org-region-active-p)
19668 (save-excursion
19669 (goto-char (region-beginning))
19670 (org-at-heading-p)))))
19671 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19672 (call-interactively 'org-do-demote))
19673 ;; At an inline task.
19674 ((org-at-heading-p)
19675 (call-interactively 'org-inlinetask-demote))
19676 ((or (org-at-item-p)
19677 (and (org-region-active-p)
19678 (save-excursion
19679 (goto-char (region-beginning))
19680 (org-at-item-p))))
19681 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19682 (call-interactively 'org-indent-item))
19683 (t (call-interactively 'forward-word))))
19685 (defun org-check-for-hidden (what)
19686 "Check if there are hidden headlines/items in the current visual line.
19687 WHAT can be either `headlines' or `items'. If the current line is
19688 an outline or item heading and it has a folded subtree below it,
19689 this function returns t, nil otherwise."
19690 (let ((re (cond
19691 ((eq what 'headlines) org-outline-regexp-bol)
19692 ((eq what 'items) (org-item-beginning-re))
19693 (t (error "This should not happen"))))
19694 beg end)
19695 (save-excursion
19696 (catch 'exit
19697 (unless (org-region-active-p)
19698 (setq beg (point-at-bol))
19699 (beginning-of-line 2)
19700 (while (and (not (eobp)) ;; this is like `next-line'
19701 (get-char-property (1- (point)) 'invisible))
19702 (beginning-of-line 2))
19703 (setq end (point))
19704 (goto-char beg)
19705 (goto-char (point-at-eol))
19706 (setq end (max end (point)))
19707 (while (re-search-forward re end t)
19708 (if (get-char-property (match-beginning 0) 'invisible)
19709 (throw 'exit t))))
19710 nil))))
19712 (defun org-metaup (&optional arg)
19713 "Move subtree up or move table row up.
19714 Calls `org-move-subtree-up' or `org-table-move-row' or
19715 `org-move-item-up', depending on context. See the individual commands
19716 for more information."
19717 (interactive "P")
19718 (cond
19719 ((run-hook-with-args-until-success 'org-metaup-hook))
19720 ((org-region-active-p)
19721 (let* ((a (min (region-beginning) (region-end)))
19722 (b (1- (max (region-beginning) (region-end))))
19723 (c (save-excursion (goto-char a)
19724 (move-beginning-of-line 0)))
19725 (d (save-excursion (goto-char a)
19726 (move-end-of-line 0) (point))))
19727 (transpose-regions a b c d)
19728 (goto-char c)))
19729 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19730 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19731 ((org-at-item-p) (call-interactively 'org-move-item-up))
19732 (t (org-drag-element-backward))))
19734 (defun org-metadown (&optional arg)
19735 "Move subtree down or move table row down.
19736 Calls `org-move-subtree-down' or `org-table-move-row' or
19737 `org-move-item-down', depending on context. See the individual
19738 commands for more information."
19739 (interactive "P")
19740 (cond
19741 ((run-hook-with-args-until-success 'org-metadown-hook))
19742 ((org-region-active-p)
19743 (let* ((a (min (region-beginning) (region-end)))
19744 (b (max (region-beginning) (region-end)))
19745 (c (save-excursion (goto-char b)
19746 (move-beginning-of-line 1)))
19747 (d (save-excursion (goto-char b)
19748 (move-end-of-line 1) (1+ (point)))))
19749 (transpose-regions a b c d)
19750 (goto-char d)))
19751 ((org-at-table-p) (call-interactively 'org-table-move-row))
19752 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19753 ((org-at-item-p) (call-interactively 'org-move-item-down))
19754 (t (org-drag-element-forward))))
19756 (defun org-shiftup (&optional arg)
19757 "Increase item in timestamp or increase priority of current headline.
19758 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19759 depending on context. See the individual commands for more information."
19760 (interactive "P")
19761 (cond
19762 ((run-hook-with-args-until-success 'org-shiftup-hook))
19763 ((and org-support-shift-select (org-region-active-p))
19764 (org-call-for-shift-select 'previous-line))
19765 ((org-at-timestamp-p t)
19766 (call-interactively (if org-edit-timestamp-down-means-later
19767 'org-timestamp-down 'org-timestamp-up)))
19768 ((and (not (eq org-support-shift-select 'always))
19769 org-enable-priority-commands
19770 (org-at-heading-p))
19771 (call-interactively 'org-priority-up))
19772 ((and (not org-support-shift-select) (org-at-item-p))
19773 (call-interactively 'org-previous-item))
19774 ((org-clocktable-try-shift 'up arg))
19775 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19776 (org-support-shift-select
19777 (org-call-for-shift-select 'previous-line))
19778 (t (org-shiftselect-error))))
19780 (defun org-shiftdown (&optional arg)
19781 "Decrease item in timestamp or decrease priority of current headline.
19782 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19783 depending on context. See the individual commands for more information."
19784 (interactive "P")
19785 (cond
19786 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19787 ((and org-support-shift-select (org-region-active-p))
19788 (org-call-for-shift-select 'next-line))
19789 ((org-at-timestamp-p t)
19790 (call-interactively (if org-edit-timestamp-down-means-later
19791 'org-timestamp-up 'org-timestamp-down)))
19792 ((and (not (eq org-support-shift-select 'always))
19793 org-enable-priority-commands
19794 (org-at-heading-p))
19795 (call-interactively 'org-priority-down))
19796 ((and (not org-support-shift-select) (org-at-item-p))
19797 (call-interactively 'org-next-item))
19798 ((org-clocktable-try-shift 'down arg))
19799 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19800 (org-support-shift-select
19801 (org-call-for-shift-select 'next-line))
19802 (t (org-shiftselect-error))))
19804 (defun org-shiftright (&optional arg)
19805 "Cycle the thing at point or in the current line, depending on context.
19806 Depending on context, this does one of the following:
19808 - switch a timestamp at point one day into the future
19809 - on a headline, switch to the next TODO keyword.
19810 - on an item, switch entire list to the next bullet type
19811 - on a property line, switch to the next allowed value
19812 - on a clocktable definition line, move time block into the future"
19813 (interactive "P")
19814 (cond
19815 ((run-hook-with-args-until-success 'org-shiftright-hook))
19816 ((and org-support-shift-select (org-region-active-p))
19817 (org-call-for-shift-select 'forward-char))
19818 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19819 ((and (not (eq org-support-shift-select 'always))
19820 (org-at-heading-p))
19821 (let ((org-inhibit-logging
19822 (not org-treat-S-cursor-todo-selection-as-state-change))
19823 (org-inhibit-blocking
19824 (not org-treat-S-cursor-todo-selection-as-state-change)))
19825 (org-call-with-arg 'org-todo 'right)))
19826 ((or (and org-support-shift-select
19827 (not (eq org-support-shift-select 'always))
19828 (org-at-item-bullet-p))
19829 (and (not org-support-shift-select) (org-at-item-p)))
19830 (org-call-with-arg 'org-cycle-list-bullet nil))
19831 ((and (not (eq org-support-shift-select 'always))
19832 (org-at-property-p))
19833 (call-interactively 'org-property-next-allowed-value))
19834 ((org-clocktable-try-shift 'right arg))
19835 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19836 (org-support-shift-select
19837 (org-call-for-shift-select 'forward-char))
19838 (t (org-shiftselect-error))))
19840 (defun org-shiftleft (&optional arg)
19841 "Cycle the thing at point or in the current line, depending on context.
19842 Depending on context, this does one of the following:
19844 - switch a timestamp at point one day into the past
19845 - on a headline, switch to the previous TODO keyword.
19846 - on an item, switch entire list to the previous bullet type
19847 - on a property line, switch to the previous allowed value
19848 - on a clocktable definition line, move time block into the past"
19849 (interactive "P")
19850 (cond
19851 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19852 ((and org-support-shift-select (org-region-active-p))
19853 (org-call-for-shift-select 'backward-char))
19854 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19855 ((and (not (eq org-support-shift-select 'always))
19856 (org-at-heading-p))
19857 (let ((org-inhibit-logging
19858 (not org-treat-S-cursor-todo-selection-as-state-change))
19859 (org-inhibit-blocking
19860 (not org-treat-S-cursor-todo-selection-as-state-change)))
19861 (org-call-with-arg 'org-todo 'left)))
19862 ((or (and org-support-shift-select
19863 (not (eq org-support-shift-select 'always))
19864 (org-at-item-bullet-p))
19865 (and (not org-support-shift-select) (org-at-item-p)))
19866 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19867 ((and (not (eq org-support-shift-select 'always))
19868 (org-at-property-p))
19869 (call-interactively 'org-property-previous-allowed-value))
19870 ((org-clocktable-try-shift 'left arg))
19871 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19872 (org-support-shift-select
19873 (org-call-for-shift-select 'backward-char))
19874 (t (org-shiftselect-error))))
19876 (defun org-shiftcontrolright ()
19877 "Switch to next TODO set."
19878 (interactive)
19879 (cond
19880 ((and org-support-shift-select (org-region-active-p))
19881 (org-call-for-shift-select 'forward-word))
19882 ((and (not (eq org-support-shift-select 'always))
19883 (org-at-heading-p))
19884 (org-call-with-arg 'org-todo 'nextset))
19885 (org-support-shift-select
19886 (org-call-for-shift-select 'forward-word))
19887 (t (org-shiftselect-error))))
19889 (defun org-shiftcontrolleft ()
19890 "Switch to previous TODO set."
19891 (interactive)
19892 (cond
19893 ((and org-support-shift-select (org-region-active-p))
19894 (org-call-for-shift-select 'backward-word))
19895 ((and (not (eq org-support-shift-select 'always))
19896 (org-at-heading-p))
19897 (org-call-with-arg 'org-todo 'previousset))
19898 (org-support-shift-select
19899 (org-call-for-shift-select 'backward-word))
19900 (t (org-shiftselect-error))))
19902 (defun org-shiftcontrolup (&optional n)
19903 "Change timestamps synchronously up in CLOCK log lines.
19904 Optional argument N tells to change by that many units."
19905 (interactive "P")
19906 (cond ((and (not org-support-shift-select)
19907 (org-at-clock-log-p)
19908 (org-at-timestamp-p t))
19909 (org-clock-timestamps-up n))
19910 (t (org-shiftselect-error))))
19912 (defun org-shiftcontroldown (&optional n)
19913 "Change timestamps synchronously down in CLOCK log lines.
19914 Optional argument N tells to change by that many units."
19915 (interactive "P")
19916 (cond ((and (not org-support-shift-select)
19917 (org-at-clock-log-p)
19918 (org-at-timestamp-p t))
19919 (org-clock-timestamps-down n))
19920 (t (org-shiftselect-error))))
19922 (defun org-ctrl-c-ret ()
19923 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19924 (interactive)
19925 (cond
19926 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19927 (t (call-interactively 'org-insert-heading))))
19929 (defun org-find-visible ()
19930 (let ((s (point)))
19931 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19932 (get-char-property s 'invisible)))
19933 s))
19934 (defun org-find-invisible ()
19935 (let ((s (point)))
19936 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19937 (not (get-char-property s 'invisible))))
19938 s))
19940 (defun org-copy-visible (beg end)
19941 "Copy the visible parts of the region."
19942 (interactive "r")
19943 (let (snippets s)
19944 (save-excursion
19945 (save-restriction
19946 (narrow-to-region beg end)
19947 (setq s (goto-char (point-min)))
19948 (while (not (= (point) (point-max)))
19949 (goto-char (org-find-invisible))
19950 (push (buffer-substring s (point)) snippets)
19951 (setq s (goto-char (org-find-visible))))))
19952 (kill-new (apply 'concat (nreverse snippets)))))
19954 (defun org-copy-special ()
19955 "Copy region in table or copy current subtree.
19956 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19957 See the individual commands for more information."
19958 (interactive)
19959 (call-interactively
19960 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19962 (defun org-cut-special ()
19963 "Cut region in table or cut current subtree.
19964 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19965 See the individual commands for more information."
19966 (interactive)
19967 (call-interactively
19968 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19970 (defun org-paste-special (arg)
19971 "Paste rectangular region into table, or past subtree relative to level.
19972 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19973 See the individual commands for more information."
19974 (interactive "P")
19975 (if (org-at-table-p)
19976 (org-table-paste-rectangle)
19977 (org-paste-subtree arg)))
19979 (defsubst org-in-fixed-width-region-p ()
19980 "Is point in a fixed-width region?"
19981 (save-match-data
19982 (eq 'fixed-width (org-element-type (org-element-at-point)))))
19984 (defun org-edit-special (&optional arg)
19985 "Call a special editor for the element at point.
19986 When at a table, call the formula editor with `org-table-edit-formulas'.
19987 When in a source code block, call `org-edit-src-code'.
19988 When in a fixed-width region, call `org-edit-fixed-width-region'.
19989 When at an #+INCLUDE keyword, visit the included file.
19990 On a link, call `ffap' to visit the link at point.
19991 Otherwise, return a user error."
19992 (interactive "P")
19993 (let ((element (org-element-at-point)))
19994 (assert (not buffer-read-only) nil
19995 "Buffer is read-only: %s" (buffer-name))
19996 (case (org-element-type element)
19997 (src-block
19998 (if (not arg) (org-edit-src-code)
19999 (let* ((info (org-babel-get-src-block-info))
20000 (lang (nth 0 info))
20001 (params (nth 2 info))
20002 (session (cdr (assq :session params))))
20003 (if (not session) (org-edit-src-code)
20004 ;; At a src-block with a session and function called with
20005 ;; an ARG: switch to the buffer related to the inferior
20006 ;; process.
20007 (switch-to-buffer
20008 (funcall (intern (concat "org-babel-prep-session:" lang))
20009 session params))))))
20010 (keyword
20011 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20012 (find-file
20013 (org-remove-double-quotes
20014 (car (org-split-string (org-element-property :value element)))))
20015 (user-error "No special environment to edit here")))
20016 (table
20017 (if (eq (org-element-property :type element) 'table.el)
20018 (org-edit-src-code)
20019 (call-interactively 'org-table-edit-formulas)))
20020 ;; Only Org tables contain `table-row' type elements.
20021 (table-row (call-interactively 'org-table-edit-formulas))
20022 ((example-block export-block) (org-edit-src-code))
20023 (fixed-width (org-edit-fixed-width-region))
20024 (otherwise
20025 ;; No notable element at point. Though, we may be at a link,
20026 ;; which is an object. Thus, scan deeper.
20027 (if (eq (org-element-type (org-element-context element)) 'link)
20028 (call-interactively 'ffap)
20029 (user-error "No special environment to edit here"))))))
20031 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20032 (defun org-ctrl-c-ctrl-c (&optional arg)
20033 "Set tags in headline, or update according to changed information at point.
20035 This command does many different things, depending on context:
20037 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20038 this is what we do.
20040 - If the cursor is on a statistics cookie, update it.
20042 - If the cursor is in a headline, prompt for tags and insert them
20043 into the current line, aligned to `org-tags-column'. When called
20044 with prefix arg, realign all tags in the current buffer.
20046 - If the cursor is in one of the special #+KEYWORD lines, this
20047 triggers scanning the buffer for these lines and updating the
20048 information.
20050 - If the cursor is inside a table, realign the table. This command
20051 works even if the automatic table editor has been turned off.
20053 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20054 the entire table.
20056 - If the cursor is at a footnote reference or definition, jump to
20057 the corresponding definition or references, respectively.
20059 - If the cursor is a the beginning of a dynamic block, update it.
20061 - If the current buffer is a capture buffer, close note and file it.
20063 - If the cursor is on a <<<target>>>, update radio targets and
20064 corresponding links in this buffer.
20066 - If the cursor is on a numbered item in a plain list, renumber the
20067 ordered list.
20069 - If the cursor is on a checkbox, toggle it.
20071 - If the cursor is on a code block, evaluate it. The variable
20072 `org-confirm-babel-evaluate' can be used to control prompting
20073 before code block evaluation, by default every code block
20074 evaluation requires confirmation. Code block evaluation can be
20075 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20076 (interactive "P")
20077 (cond
20078 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20079 org-occur-highlights
20080 org-latex-fragment-image-overlays)
20081 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20082 (org-remove-occur-highlights)
20083 (org-remove-latex-fragment-image-overlays)
20084 (message "Temporary highlights/overlays removed from current buffer"))
20085 ((and (local-variable-p 'org-finish-function (current-buffer))
20086 (fboundp org-finish-function))
20087 (funcall org-finish-function))
20088 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20089 (t
20090 (let* ((context (org-element-context)) (type (org-element-type context)))
20091 ;; Test if point is within a blank line.
20093 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20094 (user-error "C-c C-c can do nothing useful at this location"))
20095 ;; For convenience: at the first line of a paragraph on the
20096 ;; same line as an item, apply function on that item instead.
20097 (when (eq type 'paragraph)
20098 (let ((parent (org-element-property :parent context)))
20099 (when (and (eq (org-element-type parent) 'item)
20100 (= (point-at-bol) (org-element-property :begin parent)))
20101 (setq context parent type 'item))))
20102 ;; Act according to type of element or object at point.
20103 (case type
20104 (clock (org-clock-update-time-maybe))
20105 (dynamic-block
20106 (save-excursion
20107 (goto-char (org-element-property :post-affiliated context))
20108 (org-update-dblock)))
20109 (footnote-definition
20110 (goto-char (org-element-property :post-affiliated context))
20111 (call-interactively 'org-footnote-action))
20112 (footnote-reference (call-interactively 'org-footnote-action))
20113 ((headline inlinetask)
20114 (save-excursion (goto-char (org-element-property :begin context))
20115 (call-interactively 'org-set-tags)))
20116 (item
20117 ;; At an item: a double C-u set checkbox to "[-]"
20118 ;; unconditionally, whereas a single one will toggle its
20119 ;; presence. Without an universal argument, if the item
20120 ;; has a checkbox, toggle it. Otherwise repair the list.
20121 (let* ((box (org-element-property :checkbox context))
20122 (struct (org-element-property :structure context))
20123 (old-struct (copy-tree struct))
20124 (parents (org-list-parents-alist struct))
20125 (prevs (org-list-prevs-alist struct))
20126 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20127 (org-list-set-checkbox
20128 (org-element-property :begin context) struct
20129 (cond ((equal arg '(16)) "[-]")
20130 ((and (not box) (equal arg '(4))) "[ ]")
20131 ((or (not box) (equal arg '(4))) nil)
20132 ((eq box 'on) "[ ]")
20133 (t "[X]")))
20134 ;; Mimic `org-list-write-struct' but with grabbing
20135 ;; a return value from `org-list-struct-fix-box'.
20136 (org-list-struct-fix-ind struct parents 2)
20137 (org-list-struct-fix-item-end struct)
20138 (org-list-struct-fix-bul struct prevs)
20139 (org-list-struct-fix-ind struct parents)
20140 (let ((block-item
20141 (org-list-struct-fix-box struct parents prevs orderedp)))
20142 (if (and box (equal struct old-struct))
20143 (if (equal arg '(16))
20144 (message "Checkboxes already reset")
20145 (user-error "Cannot toggle this checkbox: %s"
20146 (if (eq box 'on)
20147 "all subitems checked"
20148 "unchecked subitems")))
20149 (org-list-struct-apply-struct struct old-struct)
20150 (org-update-checkbox-count-maybe))
20151 (when block-item
20152 (message "Checkboxes were removed due to empty box at line %d"
20153 (org-current-line block-item))))))
20154 (keyword
20155 (let ((org-inhibit-startup-visibility-stuff t)
20156 (org-startup-align-all-tables nil))
20157 (when (boundp 'org-table-coordinate-overlays)
20158 (mapc 'delete-overlay org-table-coordinate-overlays)
20159 (setq org-table-coordinate-overlays nil))
20160 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20161 (message "Local setup has been refreshed"))
20162 (plain-list
20163 ;; At a plain list, with a double C-u argument, set
20164 ;; checkboxes of each item to "[-]", whereas a single one
20165 ;; will toggle their presence according to the state of the
20166 ;; first item in the list. Without an argument, repair the
20167 ;; list.
20168 (let* ((begin (org-element-property :contents-begin context))
20169 (beginm (move-marker (make-marker) begin))
20170 (struct (org-element-property :structure context))
20171 (old-struct (copy-tree struct))
20172 (first-box (save-excursion
20173 (goto-char begin)
20174 (looking-at org-list-full-item-re)
20175 (match-string-no-properties 3)))
20176 (new-box (cond ((equal arg '(16)) "[-]")
20177 ((equal arg '(4)) (unless first-box "[ ]"))
20178 ((equal first-box "[X]") "[ ]")
20179 (t "[X]"))))
20180 (cond
20181 (arg
20182 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20183 (org-list-get-all-items
20184 begin struct (org-list-prevs-alist struct))))
20185 ((and first-box (eq (point) begin))
20186 ;; For convenience, when point is at bol on the first
20187 ;; item of the list and no argument is provided, simply
20188 ;; toggle checkbox of that item, if any.
20189 (org-list-set-checkbox begin struct new-box)))
20190 (org-list-write-struct
20191 struct (org-list-parents-alist struct) old-struct)
20192 (org-update-checkbox-count-maybe)
20193 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20194 ((property-drawer node-property)
20195 (call-interactively 'org-property-action))
20196 ((radio-target target)
20197 (call-interactively 'org-update-radio-target-regexp))
20198 (statistics-cookie
20199 (call-interactively 'org-update-statistics-cookies))
20200 ((table table-cell table-row)
20201 ;; At a table, recalculate every field and align it. Also
20202 ;; send the table if necessary. If the table has
20203 ;; a `table.el' type, just give up. At a table row or
20204 ;; cell, maybe recalculate line but always align table.
20205 (if (eq (org-element-property :type context) 'table.el)
20206 (message "Use C-c ' to edit table.el tables")
20207 (let ((org-enable-table-editor t))
20208 (if (or (eq type 'table)
20209 ;; Check if point is at a TBLFM line.
20210 (and (eq type 'table-row)
20211 (= (point) (org-element-property :end context))))
20212 (save-excursion
20213 (if (org-at-TBLFM-p) (org-calc-current-TBLFM)
20214 (goto-char (org-element-property :contents-begin context))
20215 (org-call-with-arg 'org-table-recalculate (or arg t))
20216 (orgtbl-send-table 'maybe)))
20217 (org-table-maybe-eval-formula)
20218 (cond (arg (call-interactively 'org-table-recalculate))
20219 ((org-table-maybe-recalculate-line))
20220 (t (org-table-align)))))))
20221 (timestamp (org-timestamp-change 0 'day))
20222 (otherwise
20223 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20224 (user-error
20225 "C-c C-c can do nothing useful at this location")))))))))
20227 (defun org-mode-restart ()
20228 "Restart Org-mode, to scan again for special lines.
20229 Also updates the keyword regular expressions."
20230 (interactive)
20231 (org-mode)
20232 (message "Org-mode restarted"))
20234 (defun org-kill-note-or-show-branches ()
20235 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20236 (interactive)
20237 (if (not org-finish-function)
20238 (progn
20239 (hide-subtree)
20240 (call-interactively 'show-branches))
20241 (let ((org-note-abort t))
20242 (funcall org-finish-function))))
20244 (defun org-open-line (n)
20245 "Insert a new row in tables, call `open-line' elsewhere."
20246 (interactive "*p")
20247 (if (org-at-table-p)
20248 (org-table-insert-row)
20249 (open-line n)))
20251 (defun org-return (&optional indent)
20252 "Goto next table row or insert a newline.
20253 Calls `org-table-next-row' or `newline', depending on context.
20254 See the individual commands for more information."
20255 (interactive)
20256 (let (org-ts-what)
20257 (cond
20258 ((or (bobp) (org-in-src-block-p))
20259 (if indent (newline-and-indent) (newline)))
20260 ((org-at-table-p)
20261 (org-table-justify-field-maybe)
20262 (call-interactively 'org-table-next-row))
20263 ;; when `newline-and-indent' is called within a list, make sure
20264 ;; text moved stays inside the item.
20265 ((and (org-in-item-p) indent)
20266 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20267 (progn
20268 (save-match-data (newline))
20269 (org-indent-line-to (length (match-string 0))))
20270 (let ((ind (org-get-indentation)))
20271 (newline)
20272 (if (org-looking-back org-list-end-re)
20273 (org-indent-line)
20274 (org-indent-line-to ind)))))
20275 ((and org-return-follows-link
20276 (org-at-timestamp-p t)
20277 (not (eq org-ts-what 'after)))
20278 (org-follow-timestamp-link))
20279 ((and org-return-follows-link
20280 (let ((tprop (get-text-property (point) 'face)))
20281 (or (eq tprop 'org-link)
20282 (and (listp tprop) (memq 'org-link tprop)))))
20283 (call-interactively 'org-open-at-point))
20284 ((and (org-at-heading-p)
20285 (looking-at
20287 (org-show-entry)
20288 (end-of-line 1)
20289 (newline))
20290 (t (if indent (newline-and-indent) (newline))))))
20292 (defun org-return-indent ()
20293 "Goto next table row or insert a newline and indent.
20294 Calls `org-table-next-row' or `newline-and-indent', depending on
20295 context. See the individual commands for more information."
20296 (interactive)
20297 (org-return t))
20299 (defun org-ctrl-c-star ()
20300 "Compute table, or change heading status of lines.
20301 Calls `org-table-recalculate' or `org-toggle-heading',
20302 depending on context."
20303 (interactive)
20304 (cond
20305 ((org-at-table-p)
20306 (call-interactively 'org-table-recalculate))
20307 (t
20308 ;; Convert all lines in region to list items
20309 (call-interactively 'org-toggle-heading))))
20311 (defun org-ctrl-c-minus ()
20312 "Insert separator line in table or modify bullet status of line.
20313 Also turns a plain line or a region of lines into list items.
20314 Calls `org-table-insert-hline', `org-toggle-item', or
20315 `org-cycle-list-bullet', depending on context."
20316 (interactive)
20317 (cond
20318 ((org-at-table-p)
20319 (call-interactively 'org-table-insert-hline))
20320 ((org-region-active-p)
20321 (call-interactively 'org-toggle-item))
20322 ((org-in-item-p)
20323 (call-interactively 'org-cycle-list-bullet))
20324 (t
20325 (call-interactively 'org-toggle-item))))
20327 (defun org-toggle-item (arg)
20328 "Convert headings or normal lines to items, items to normal lines.
20329 If there is no active region, only the current line is considered.
20331 If the first non blank line in the region is a headline, convert
20332 all headlines to items, shifting text accordingly.
20334 If it is an item, convert all items to normal lines.
20336 If it is normal text, change region into a list of items.
20337 With a prefix argument ARG, change the region in a single item."
20338 (interactive "P")
20339 (let ((shift-text
20340 (function
20341 ;; Shift text in current section to IND, from point to END.
20342 ;; The function leaves point to END line.
20343 (lambda (ind end)
20344 (let ((min-i 1000) (end (copy-marker end)))
20345 ;; First determine the minimum indentation (MIN-I) of
20346 ;; the text.
20347 (save-excursion
20348 (catch 'exit
20349 (while (< (point) end)
20350 (let ((i (org-get-indentation)))
20351 (cond
20352 ;; Skip blank lines and inline tasks.
20354 ((looking-at org-outline-regexp-bol))
20355 ;; We can't find less than 0 indentation.
20356 ((zerop i) (throw 'exit (setq min-i 0)))
20357 ((< i min-i) (setq min-i i))))
20358 (forward-line))))
20359 ;; Then indent each line so that a line indented to
20360 ;; MIN-I becomes indented to IND. Ignore blank lines
20361 ;; and inline tasks in the process.
20362 (let ((delta (- ind min-i)))
20363 (while (< (point) end)
20365 (looking-at org-outline-regexp-bol))
20366 (org-indent-line-to (+ (org-get-indentation) delta)))
20367 (forward-line)))))))
20368 (skip-blanks
20369 (function
20370 ;; Return beginning of first non-blank line, starting from
20371 ;; line at POS.
20372 (lambda (pos)
20373 (save-excursion
20374 (goto-char pos)
20376 (point-at-bol)))))
20377 beg end)
20378 ;; Determine boundaries of changes.
20379 (if (org-region-active-p)
20380 (setq beg (funcall skip-blanks (region-beginning))
20381 end (copy-marker (region-end)))
20382 (setq beg (funcall skip-blanks (point-at-bol))
20383 end (copy-marker (point-at-eol))))
20384 ;; Depending on the starting line, choose an action on the text
20385 ;; between BEG and END.
20386 (org-with-limited-levels
20387 (save-excursion
20388 (goto-char beg)
20389 (cond
20390 ;; Case 1. Start at an item: de-itemize. Note that it only
20391 ;; happens when a region is active: `org-ctrl-c-minus'
20392 ;; would call `org-cycle-list-bullet' otherwise.
20393 ((org-at-item-p)
20394 (while (< (point) end)
20395 (when (org-at-item-p)
20397 (delete-region (point) (match-end 0)))
20398 (forward-line)))
20399 ;; Case 2. Start at an heading: convert to items.
20400 ((org-at-heading-p)
20401 (let* ((bul (org-list-bullet-string "-"))
20402 (bul-len (length bul))
20403 ;; Indentation of the first heading. It should be
20404 ;; relative to the indentation of its parent, if any.
20405 (start-ind (save-excursion
20406 (cond
20407 ((not org-adapt-indentation) 0)
20408 ((not (outline-previous-heading)) 0)
20409 (t (length (match-string 0))))))
20410 ;; Level of first heading. Further headings will be
20411 ;; compared to it to determine hierarchy in the list.
20412 (ref-level (org-reduced-level (org-outline-level))))
20413 (while (< (point) end)
20414 (let* ((level (org-reduced-level (org-outline-level)))
20415 (delta (max 0 (- level ref-level))))
20416 ;; If current headline is less indented than the first
20417 ;; one, set it as reference, in order to preserve
20418 ;; subtrees.
20419 (when (< level ref-level) (setq ref-level level))
20420 (replace-match bul t t)
20421 (org-indent-line-to (+ start-ind (* delta bul-len)))
20422 ;; Ensure all text down to END (or SECTION-END) belongs
20423 ;; to the newly created item.
20424 (let ((section-end (save-excursion
20425 (or (outline-next-heading) (point)))))
20426 (forward-line)
20427 (funcall shift-text
20428 (+ start-ind (* (1+ delta) bul-len))
20429 (min end section-end)))))))
20430 ;; Case 3. Normal line with ARG: make the first line of region
20431 ;; an item, and shift indentation of others lines to
20432 ;; set them as item's body.
20433 (arg (let* ((bul (org-list-bullet-string "-"))
20434 (bul-len (length bul))
20435 (ref-ind (org-get-indentation)))
20437 (insert bul)
20438 (forward-line)
20439 (while (< (point) end)
20440 ;; Ensure that lines less indented than first one
20441 ;; still get included in item body.
20442 (funcall shift-text
20443 (+ ref-ind bul-len)
20444 (min end (save-excursion (or (outline-next-heading)
20445 (point)))))
20446 (forward-line))))
20447 ;; Case 4. Normal line without ARG: turn each non-item line
20448 ;; into an item.
20449 (t
20450 (while (< (point) end)
20451 (unless (or (org-at-heading-p) (org-at-item-p))
20453 (replace-match
20455 (forward-line))))))))
20457 (defun org-toggle-heading (&optional nstars)
20458 "Convert headings to normal text, or items or text to headings.
20459 If there is no active region, only convert the current line.
20462 point into heading.
20464 In a region:
20466 - If the first non blank line is a headline, remove the stars
20467 from all headlines in the region.
20469 - If it is a normal line, turn each and every normal line (i.e.,
20470 not an heading or an item) in the region into headings. If you
20471 want to convert only the first line of this region, use one
20472 universal prefix argument.
20474 - If it is a plain list item, turn all plain list items into headings.
20476 When converting a line into a heading, the number of stars is chosen
20477 such that the lines become children of the current entry. However,
20478 when a numeric prefix argument is given, its value determines the
20479 number of stars to add."
20480 (interactive "P")
20481 (let ((skip-blanks
20482 (function
20483 ;; Return beginning of first non-blank line, starting from
20484 ;; line at POS.
20485 (lambda (pos)
20486 (save-excursion
20487 (goto-char pos)
20488 (while (org-at-comment-p) (forward-line))
20490 (point-at-bol)))))
20491 beg end toggled)
20492 ;; Determine boundaries of changes. If a universal prefix has
20493 ;; been given, put the list in a region. If region ends at a bol,
20494 ;; do not consider the last line to be in the region.
20496 (when (and current-prefix-arg (org-at-item-p))
20497 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20498 (org-mark-element))
20500 (if (org-region-active-p)
20501 (setq beg (funcall skip-blanks (region-beginning))
20502 end (copy-marker (save-excursion
20503 (goto-char (region-end))
20504 (if (bolp) (point) (point-at-eol)))))
20505 (setq beg (funcall skip-blanks (point-at-bol))
20506 end (copy-marker (point-at-eol))))
20507 ;; Ensure inline tasks don't count as headings.
20508 (org-with-limited-levels
20509 (save-excursion
20510 (goto-char beg)
20511 (cond
20512 ;; Case 1. Started at an heading: de-star headings.
20513 ((org-at-heading-p)
20514 (while (< (point) end)
20515 (when (org-at-heading-p t)
20516 (looking-at org-outline-regexp) (replace-match "")
20517 (setq toggled t))
20518 (forward-line)))
20519 ;; Case 2. Started at an item: change items into headlines.
20520 ;; One star will be added by `org-list-to-subtree'.
20521 ((org-at-item-p)
20522 (let* ((stars (make-string
20523 ;; subtract the star that will be added again by
20524 ;; `org-list-to-subtree'
20525 (if (numberp nstars) (1- nstars)
20526 (or (org-current-level) 0))
20527 ?*))
20528 (add-stars
20529 (cond (nstars "") ; stars from prefix only
20530 ((equal stars "") "") ; before first heading
20531 (org-odd-levels-only "*") ; inside heading, odd
20532 (t "")))) ; inside heading, oddeven
20533 (while (< (point) end)
20534 (when (org-at-item-p)
20535 ;; Pay attention to cases when region ends before list.
20536 (let* ((struct (org-list-struct))
20537 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20538 (save-restriction
20539 (narrow-to-region (point) list-end)
20540 (insert
20541 (org-list-to-subtree
20542 (org-list-parse-list t)
20543 '(:istart (concat stars add-stars (funcall get-stars depth))
20544 :icount (concat stars add-stars (funcall get-stars depth)))))))
20545 (setq toggled t))
20546 (forward-line))))
20547 ;; Case 3. Started at normal text: make every line an heading,
20548 ;; skipping headlines and items.
20549 (t (let* ((stars
20550 (make-string
20551 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20552 (add-stars
20553 (cond (nstars "") ; stars from prefix only
20554 ((equal stars "") "*") ; before first heading
20555 (org-odd-levels-only "**") ; inside heading, odd
20556 (t "*"))) ; inside heading, oddeven
20557 (rpl (concat stars add-stars " "))
20558 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20559 (while (< (point) (if (equal nstars '(4)) lend end))
20560 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20562 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20563 (forward-line)))))))
20564 (unless toggled (message "Cannot toggle heading from here"))))
20566 (defun org-meta-return (&optional arg)
20567 "Insert a new heading or wrap a region in a table.
20568 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20569 See the individual commands for more information."
20570 (interactive "P")
20571 (cond
20572 ((run-hook-with-args-until-success 'org-metareturn-hook))
20573 ((or (org-at-drawer-p) (org-at-property-p))
20574 (newline-and-indent))
20575 ((org-at-table-p)
20576 (call-interactively 'org-table-wrap-region))
20577 (t (call-interactively 'org-insert-heading))))
20579 ;;; Menu entries
20581 (defsubst org-in-subtree-not-table-p ()
20582 "Are we in a subtree and not in a table?"
20583 (and (not (org-before-first-heading-p))
20584 (not (org-at-table-p))))
20586 ;; Define the Org-mode menus
20587 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20588 '("Tbl"
20589 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20590 ["Next Field" org-cycle (org-at-table-p)]
20591 ["Previous Field" org-shifttab (org-at-table-p)]
20592 ["Next Row" org-return (org-at-table-p)]
20593 "--"
20594 ["Blank Field" org-table-blank-field (org-at-table-p)]
20595 ["Edit Field" org-table-edit-field (org-at-table-p)]
20596 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20597 "--"
20598 ("Column"
20599 ["Move Column Left" org-metaleft (org-at-table-p)]
20600 ["Move Column Right" org-metaright (org-at-table-p)]
20601 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20602 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20603 ("Row"
20604 ["Move Row Up" org-metaup (org-at-table-p)]
20605 ["Move Row Down" org-metadown (org-at-table-p)]
20606 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20607 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20608 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20609 "--"
20610 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20611 ("Rectangle"
20612 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20613 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20614 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20615 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20616 "--"
20617 ("Calculate"
20618 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20619 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20620 ["Edit Formulas" org-edit-special (org-at-table-p)]
20621 "--"
20622 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20623 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20624 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20625 "--"
20626 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20627 "--"
20628 ["Sum Column/Rectangle" org-table-sum
20629 (or (org-at-table-p) (org-region-active-p))]
20630 ["Which Column?" org-table-current-column (org-at-table-p)])
20631 ["Debug Formulas"
20632 org-table-toggle-formula-debugger
20633 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20634 ["Show Col/Row Numbers"
20635 org-table-toggle-coordinate-overlays
20636 :style toggle
20637 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20638 "--"
20639 ["Create" org-table-create (and (not (org-at-table-p))
20640 org-enable-table-editor)]
20641 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20642 ["Import from File" org-table-import (not (org-at-table-p))]
20643 ["Export to File" org-table-export (org-at-table-p)]
20644 "--"
20645 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20647 (easy-menu-define org-org-menu org-mode-map "Org menu"
20648 '("Org"
20649 ("Show/Hide"
20650 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20651 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20652 ["Sparse Tree..." org-sparse-tree t]
20653 ["Reveal Context" org-reveal t]
20654 ["Show All" show-all t]
20655 "--"
20656 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20657 "--"
20658 ["New Heading" org-insert-heading t]
20659 ("Navigate Headings"
20660 ["Up" outline-up-heading t]
20661 ["Next" outline-next-visible-heading t]
20662 ["Previous" outline-previous-visible-heading t]
20663 ["Next Same Level" outline-forward-same-level t]
20664 ["Previous Same Level" outline-backward-same-level t]
20665 "--"
20666 ["Jump" org-goto t])
20667 ("Edit Structure"
20668 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20669 "--"
20670 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20671 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20672 "--"
20673 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20674 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20675 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20676 "--"
20677 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20678 "--"
20679 ["Copy visible text" org-copy-visible t]
20680 "--"
20681 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20682 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20683 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20684 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20685 "--"
20686 ["Sort Region/Children" org-sort t]
20687 "--"
20688 ["Convert to odd levels" org-convert-to-odd-levels t]
20689 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20690 ("Editing"
20691 ["Emphasis..." org-emphasize t]
20692 ["Edit Source Example" org-edit-special t]
20693 "--"
20694 ["Footnote new/jump" org-footnote-action t]
20695 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20696 ("Archive"
20697 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20698 "--"
20699 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20700 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20701 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20702 )
20703 "--"
20704 ("Hyperlinks"
20705 ["Store Link (Global)" org-store-link t]
20706 ["Find existing link to here" org-occur-link-in-agenda-files t]
20707 ["Insert Link" org-insert-link t]
20708 ["Follow Link" org-open-at-point t]
20709 "--"
20710 ["Next link" org-next-link t]
20711 ["Previous link" org-previous-link t]
20712 "--"
20713 ["Descriptive Links"
20714 org-toggle-link-display
20715 :style radio
20716 :selected org-descriptive-links
20717 ]
20718 ["Literal Links"
20719 org-toggle-link-display
20720 :style radio
20721 :selected (not org-descriptive-links)])
20722 "--"
20723 ("TODO Lists"
20724 ["TODO/DONE/-" org-todo t]
20725 ("Select keyword"
20726 ["Next keyword" org-shiftright (org-at-heading-p)]
20727 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20728 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20729 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20730 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20731 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20732 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20733 "--"
20734 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20735 :selected org-enforce-todo-dependencies :style toggle :active t]
20736 "Settings for tree at point"
20737 ["Do Children sequentially" org-toggle-ordered-property :style radio
20738 :selected (org-entry-get nil "ORDERED")
20739 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20740 ["Do Children parallel" org-toggle-ordered-property :style radio
20741 :selected (not (org-entry-get nil "ORDERED"))
20742 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20743 "--"
20744 ["Set Priority" org-priority t]
20745 ["Priority Up" org-shiftup t]
20746 ["Priority Down" org-shiftdown t]
20747 "--"
20748 ["Get news from all feeds" org-feed-update-all t]
20749 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20750 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20751 ("TAGS and Properties"
20752 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20753 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20754 "--"
20755 ["Set property" org-set-property (not (org-before-first-heading-p))]
20756 ["Column view of properties" org-columns t]
20757 ["Insert Column View DBlock" org-insert-columns-dblock t])
20758 ("Dates and Scheduling"
20759 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20760 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20761 ("Change Date"
20762 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20763 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20764 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20765 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20766 ["Compute Time Range" org-evaluate-time-range t]
20767 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20768 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20769 "--"
20770 ["Custom time format" org-toggle-time-stamp-overlays
20771 :style radio :selected org-display-custom-times]
20772 "--"
20773 ["Goto Calendar" org-goto-calendar t]
20774 ["Date from Calendar" org-date-from-calendar t]
20775 "--"
20776 ["Start/Restart Timer" org-timer-start t]
20777 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20778 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20779 ["Insert Timer String" org-timer t]
20780 ["Insert Timer Item" org-timer-item t])
20781 ("Logging work"
20782 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20783 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20784 ["Clock out" org-clock-out t]
20785 ["Clock cancel" org-clock-cancel t]
20786 "--"
20787 ["Mark as default task" org-clock-mark-default-task t]
20788 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20789 ["Goto running clock" org-clock-goto t]
20790 "--"
20791 ["Display times" org-clock-display t]
20792 ["Create clock table" org-clock-report t]
20793 "--"
20794 ["Record DONE time"
20795 (progn (setq org-log-done (not org-log-done))
20796 (message "Switching to %s will %s record a timestamp"
20797 (car org-done-keywords)
20798 (if org-log-done "automatically" "not")))
20799 :style toggle :selected org-log-done])
20800 "--"
20801 ["Agenda Command..." org-agenda t]
20802 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20803 ("File List for Agenda")
20804 ("Special views current file"
20805 ["TODO Tree" org-show-todo-tree t]
20806 ["Check Deadlines" org-check-deadlines t]
20807 ["Timeline" org-timeline t]
20808 ["Tags/Property tree" org-match-sparse-tree t])
20809 "--"
20810 ["Export/Publish..." org-export-dispatch t]
20811 ("LaTeX"
20812 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20813 :selected org-cdlatex-mode]
20814 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20815 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20816 ["Modify math symbol" org-cdlatex-math-modify
20817 (org-inside-LaTeX-fragment-p)]
20818 ["Insert citation" org-reftex-citation t]
20819 "--"
20820 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20821 "--"
20822 ("MobileOrg"
20823 ["Push Files and Views" org-mobile-push t]
20824 ["Get Captured and Flagged" org-mobile-pull t]
20825 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20826 "--"
20827 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20828 "--"
20829 ("Documentation"
20830 ["Show Version" org-version t]
20831 ["Info Documentation" org-info t])
20832 ("Customize"
20833 ["Browse Org Group" org-customize t]
20834 "--"
20835 ["Expand This Menu" org-create-customize-menu
20836 (fboundp 'customize-menu-create)])
20837 ["Send bug report" org-submit-bug-report t]
20838 "--"
20839 ("Refresh/Reload"
20840 ["Refresh setup current buffer" org-mode-restart t]
20841 ["Reload Org (after update)" org-reload t]
20842 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20843 ))
20845 (defun org-info (&optional node)
20846 "Read documentation for Org-mode in the info system.
20847 With optional NODE, go directly to that node."
20848 (interactive)
20849 (info (format "(org)%s" (or node ""))))
20851 ;;;###autoload
20852 (defun org-submit-bug-report ()
20853 "Submit a bug report on Org-mode via mail.
20855 Don't hesitate to report any problems or inaccurate documentation.
20857 If you don't have setup sending mail from (X)Emacs, please copy the
20858 output buffer into your mail program, as it gives us important
20859 information about your Org-mode version and configuration."
20860 (interactive)
20861 (require 'reporter)
20862 (org-load-modules-maybe)
20863 (org-require-autoloaded-modules)
20864 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20865 (reporter-submit-bug-report
20866 "emacs-orgmode@gnu.org"
20867 (org-version nil 'full)
20868 (let (list)
20869 (save-window-excursion
20870 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20871 (delete-other-windows)
20872 (erase-buffer)
20873 (insert "You are about to submit a bug report to the Org-mode mailing list.
20875 We would like to add your full Org-mode and Outline configuration to the
20876 bug report. This greatly simplifies the work of the maintainer and
20877 other experts on the mailing list.
20879 HOWEVER, some variables you have customized may contain private
20880 information. The names of customers, colleagues, or friends, might
20881 appear in the form of file names, tags, todo states, or search strings.
20882 If you answer yes to the prompt, you might want to check and remove
20883 such private information before sending the email.")
20884 (add-text-properties (point-min) (point-max) '(face org-warning))
20885 (when (yes-or-no-p "Include your Org-mode configuration ")
20886 (mapatoms
20887 (lambda (v)
20888 (and (boundp v)
20890 (or (and (symbol-value v)
20892 (and
20893 (get v 'custom-type) (get v 'standard-value)
20894 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20895 (push v list)))))
20896 (kill-buffer (get-buffer "*Warn about privacy*"))
20897 list))
20898 nil nil
20899 "Remember to cover the basics, that is, what you expected to happen and
20900 what in fact did happen. You don't know how to make a good report? See
20902 http://orgmode.org/manual/Feedback.html#Feedback
20904 Your bug report will be posted to the Org-mode mailing list.
20905 ------------------------------------------------------------------------")
20906 (save-excursion
20911 (defun org-install-agenda-files-menu ()
20912 (let ((bl (buffer-list)))
20913 (save-excursion
20914 (while bl
20915 (set-buffer (pop bl))
20916 (if (derived-mode-p 'org-mode) (setq bl nil)))
20917 (when (derived-mode-p 'org-mode)
20918 (easy-menu-change
20919 '("Org") "File List for Agenda"
20920 (append
20921 (list
20922 ["Edit File List" (org-edit-agenda-file-list) t]
20923 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20924 ["Remove Current File from List" org-remove-file t]
20925 ["Cycle through agenda files" org-cycle-agenda-files t]
20926 ["Occur in all agenda files" org-occur-in-agenda-files t]
20927 "--")
20928 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20930 ;;;; Documentation
20932 (defun org-require-autoloaded-modules ()
20933 (interactive)
20934 (mapc 'require
20935 '(org-agenda org-archive org-attach org-clock org-colview org-id
20936 org-remember org-table org-timer)))
20938 ;;;###autoload
20939 (defun org-reload (&optional uncompiled)
20940 "Reload all org lisp files.
20941 With prefix arg UNCOMPILED, load the uncompiled versions."
20942 (interactive "P")
20943 (require 'loadhist)
20944 (let* ((org-dir (org-find-library-dir "org"))
20945 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20947 (remove-re (mapconcat 'identity
20948 (mapcar (lambda (f) (concat "^" f "$"))
20949 (list (if (featurep 'xemacs)
20950 "org-colview"
20951 "org-colview-xemacs")
20952 "org" "org-loaddefs" "org-version"))
20954 (feats (delete-dups
20955 (mapcar 'file-name-sans-extension
20956 (mapcar 'file-name-nondirectory
20957 (delq nil
20958 (mapcar 'feature-file
20959 features))))))
20960 (lfeat (append
20961 (sort
20962 (setq feats
20963 (delq nil (mapcar
20964 (lambda (f)
20965 (if (and (string-match feature-re f)
20966 (not (string-match remove-re f)))
20967 f nil))
20968 feats)))
20969 'string-lessp)
20970 (list "org-version" "org")))
20971 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
20972 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20973 load-uncore load-misses)
20974 (setq load-misses
20975 (delq 't
20976 (mapcar (lambda (f)
20977 (or (org-load-noerror-mustsuffix (concat org-dir f))
20978 (and (string= org-dir contrib-dir)
20979 (org-load-noerror-mustsuffix (concat contrib-dir f)))
20980 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
20981 (add-to-list 'load-uncore f 'append)
20982 't)
20983 f))
20984 lfeat)))
20985 (if load-uncore
20987 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20988 (if load-misses
20990 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20993 ;;;###autoload
20994 (defun org-customize ()
20995 "Call the customize function with org as argument."
20996 (interactive)
20997 (org-load-modules-maybe)
20998 (org-require-autoloaded-modules)
20999 (customize-browse 'org))
21001 (defun org-create-customize-menu ()
21002 "Create a full customization menu for Org-mode, insert it into the menu."
21003 (interactive)
21004 (org-load-modules-maybe)
21005 (org-require-autoloaded-modules)
21006 (if (fboundp 'customize-menu-create)
21007 (progn
21008 (easy-menu-change
21009 '("Org") "Customize"
21010 `(["Browse Org group" org-customize t]
21011 "--"
21012 ,(customize-menu-create 'org)
21013 ["Set" Custom-set t]
21014 ["Save" Custom-save t]
21015 ["Reset to Current" Custom-reset-current t]
21016 ["Reset to Saved" Custom-reset-saved t]
21017 ["Reset to Standard Settings" Custom-reset-standard t]))
21019 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21021 ;;;; Miscellaneous stuff
21023 ;;; Generally useful functions
21025 (defun org-get-at-bol (property)
21026 "Get text property PROPERTY at beginning of line."
21027 (get-text-property (point-at-bol) property))
21029 (defun org-find-text-property-in-string (prop s)
21030 "Return the first non-nil value of property PROP in string S."
21031 (or (get-text-property 0 prop s)
21032 (get-text-property (or (next-single-property-change 0 prop s) 0)
21033 prop s)))
21035 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21036 "Display the given MESSAGE as a warning."
21037 (if (fboundp 'display-warning)
21038 (display-warning 'org message
21039 (if (featurep 'xemacs) 'warning :warning))
21040 (let ((buf (get-buffer-create "*Org warnings*")))
21041 (with-current-buffer buf
21042 (goto-char (point-max))
21043 (insert "Warning (Org): " message)
21044 (unless (bolp)
21045 (newline)))
21046 (display-buffer buf)
21047 (sit-for 0))))
21049 (defun org-eval (form)
21050 "Eval FORM and return result."
21051 (condition-case error
21052 (eval form)
21053 (error (format "%%![Error: %s]" error))))
21055 (defun org-in-clocktable-p ()
21056 "Check if the cursor is in a clocktable."
21057 (let ((pos (point)) start)
21058 (save-excursion
21059 (end-of-line 1)
21061 (setq start (match-beginning 0))
21063 (>= (match-end 0) pos)
21064 start))))
21066 (defun org-in-commented-line ()
21067 "Is point in a line starting with `#'?"
21068 (equal (char-after (point-at-bol)) ?#))
21070 (defun org-in-indented-comment-line ()
21071 "Is point in a line starting with `#' after some white space?"
21072 (save-excursion
21073 (save-match-data
21074 (goto-char (point-at-bol))
21077 (defun org-in-verbatim-emphasis ()
21078 (save-match-data
21079 (and (org-in-regexp org-emph-re 2)
21080 (>= (point) (match-beginning 3))
21081 (<= (point) (match-end 4))
21082 (member (match-string 3) '("=" "~")))))
21084 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21085 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21086 (if (and marker (marker-buffer marker)
21087 (buffer-live-p (marker-buffer marker)))
21088 (progn
21089 (org-pop-to-buffer-same-window (marker-buffer marker))
21090 (if (or (> marker (point-max)) (< marker (point-min)))
21091 (widen))
21092 (goto-char marker)
21093 (org-show-context 'org-goto))
21094 (if bookmark
21095 (bookmark-jump bookmark)
21096 (error "Cannot find location"))))
21098 (defun org-quote-csv-field (s)
21099 "Quote field for inclusion in CSV material."
21102 s))
21104 (defun org-force-self-insert (N)
21105 "Needed to enforce self-insert under remapping."
21106 (interactive "p")
21107 (self-insert-command N))
21109 (defun org-string-width (s)
21110 "Compute width of string, ignoring invisible characters.
21111 This ignores character with invisibility property `org-link', and also
21112 characters with property `org-cwidth', because these will become invisible
21113 upon the next fontification round."
21114 (let (b l)
21115 (when (or (eq t buffer-invisibility-spec)
21116 (assq 'org-link buffer-invisibility-spec))
21117 (while (setq b (text-property-any 0 (length s)
21118 'invisible 'org-link s))
21119 (setq s (concat (substring s 0 b)
21120 (substring s (or (next-single-property-change
21121 b 'invisible s) (length s)))))))
21122 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21123 (setq s (concat (substring s 0 b)
21124 (substring s (or (next-single-property-change
21125 b 'org-cwidth s) (length s))))))
21126 (setq l (string-width s) b -1)
21127 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21128 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21129 l))
21131 (defun org-shorten-string (s maxlength)
21132 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21133 If the string is shorter or has length MAXLENGTH, just return the
21134 original string. If it is longer, the functions finds a space in the
21135 string, breaks this string off at that locations and adds three dots
21136 as ellipsis. Including the ellipsis, the string will not be longer
21137 than MAXLENGTH. If finding a good breaking point in the string does
21138 not work, the string is just chopped off in the middle of a word
21139 if necessary."
21140 (if (<= (length s) maxlength)
21141 s
21142 (let* ((n (max (- maxlength 4) 1))
21144 (if (string-match re s)
21145 (concat (match-string 1 s) "...")
21146 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21148 (defun org-get-indentation (&optional line)
21149 "Get the indentation of the current line, interpreting tabs.
21150 When LINE is given, assume it represents a line and compute its indentation."
21151 (if line
21152 (if (string-match "^ *" (org-remove-tabs line))
21153 (match-end 0))
21154 (save-excursion
21155 (beginning-of-line 1)
21157 (current-column))))
21159 (defun org-get-string-indentation (s)
21160 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21161 (let ((n -1) (i 0) (w tab-width) c)
21162 (catch 'exit
21163 (while (< (setq n (1+ n)) (length s))
21164 (setq c (aref s n))
21165 (cond ((= c ?\ ) (setq i (1+ i)))
21167 (t (throw 'exit t)))))
21168 i))
21170 (defun org-remove-tabs (s &optional width)
21171 "Replace tabulators in S with spaces.
21172 Assumes that s is a single line, starting in column 0."
21173 (setq width (or width tab-width))
21175 (setq s (replace-match
21176 (make-string
21177 (- (* width (/ (+ (match-beginning 0) width) width))
21178 (match-beginning 0)) ?\ )
21179 t t s)))
21180 s)
21182 (defun org-fix-indentation (line ind)
21183 "Fix indentation in LINE.
21184 IND is a cons cell with target and minimum indentation.
21185 If the current indentation in LINE is smaller than the minimum,
21186 leave it alone. If it is larger than ind, set it to the target."
21187 (let* ((l (org-remove-tabs line))
21188 (i (org-get-indentation l))
21189 (i1 (car ind)) (i2 (cdr ind)))
21190 (if (>= i i2) (setq l (substring line i2)))
21191 (if (> i1 0)
21192 (concat (make-string i1 ?\ ) l)
21193 l)))
21195 (defun org-remove-indentation (code &optional n)
21196 "Remove the maximum common indentation from the lines in CODE.
21197 N may optionally be the number of spaces to remove."
21198 (with-temp-buffer
21199 (insert code)
21200 (org-do-remove-indentation n)
21201 (buffer-string)))
21203 (defun org-do-remove-indentation (&optional n)
21204 "Remove the maximum common indentation from the buffer."
21205 (untabify (point-min) (point-max))
21206 (let ((min 10000) re)
21207 (if n
21208 (setq min n)
21209 (goto-char (point-min))
21211 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21212 (unless (or (= min 0) (= min 10000))
21214 (goto-char (point-min))
21215 (while (re-search-forward re nil t)
21216 (replace-match "")
21217 (end-of-line 1))
21218 min)))
21220 (defun org-fill-template (template alist)
21221 "Find each %key of ALIST in TEMPLATE and replace it."
21222 (let ((case-fold-search nil)
21223 entry key value)
21224 (setq alist (sort (copy-sequence alist)
21225 (lambda (a b) (< (length (car a)) (length (car b))))))
21226 (while (setq entry (pop alist))
21227 (setq template
21228 (replace-regexp-in-string
21229 (concat "%" (regexp-quote (car entry)))
21230 (or (cdr entry) "") template t t)))
21231 template))
21233 (defun org-base-buffer (buffer)
21234 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21235 (if (not buffer)
21236 buffer
21237 (or (buffer-base-buffer buffer)
21238 buffer)))
21240 (defun org-trim (s)
21241 "Remove whitespace at beginning and end of string."
21244 s)
21246 (defun org-wrap (string &optional width lines)
21247 "Wrap string to either a number of lines, or a width in characters.
21248 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21249 that costs. If there is a word longer than WIDTH, the text is actually
21250 wrapped to the length of that word.
21251 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21252 many lines, whatever width that takes.
21253 The return value is a list of lines, without newlines at the end."
21255 (maxword (apply 'max (mapcar 'org-string-width words)))
21256 w ll)
21257 (cond (width
21258 (org-do-wrap words (max maxword width)))
21259 (lines
21260 (setq w maxword)
21261 (setq ll (org-do-wrap words maxword))
21262 (if (<= (length ll) lines)
21263 ll
21264 (setq ll words)
21265 (while (> (length ll) lines)
21266 (setq w (1+ w))
21267 (setq ll (org-do-wrap words w)))
21268 ll))
21269 (t (error "Cannot wrap this")))))
21271 (defun org-do-wrap (words width)
21272 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21273 (let (lines line)
21274 (while words
21275 (setq line (pop words))
21276 (while (and words (< (+ (length line) (length (car words))) width))
21277 (setq line (concat line " " (pop words))))
21278 (setq lines (push line lines)))
21279 (nreverse lines)))
21281 (defun org-split-string (string &optional separators)
21282 "Splits STRING into substrings at SEPARATORS.
21283 No empty strings are returned if there are matches at the beginning
21284 and end of string."
21286 (start 0)
21287 notfirst
21288 (list nil))
21289 (while (and (string-match rexp string
21290 (if (and notfirst
21291 (= start (match-beginning 0))
21292 (< start (length string)))
21293 (1+ start) start))
21294 (< (match-beginning 0) (length string)))
21295 (setq notfirst t)
21296 (or (eq (match-beginning 0) 0)
21297 (and (eq (match-beginning 0) (match-end 0))
21298 (eq (match-beginning 0) start))
21299 (setq list
21300 (cons (substring string start (match-beginning 0))
21301 list)))
21302 (setq start (match-end 0)))
21303 (or (eq start (length string))
21304 (setq list
21305 (cons (substring string start)
21306 list)))
21307 (nreverse list)))
21309 (defun org-quote-vert (s)
21311 (while (string-match "|" s)
21313 s)
21315 (defun org-uuidgen-p (s)
21316 "Is S an ID created by UUIDGEN?"
21317 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21319 (defun org-in-src-block-p (&optional inside)
21320 "Whether point is in a code source block.
21321 When INSIDE is non-nil, don't consider we are within a src block
21322 when point is at #+BEGIN_SRC or #+END_SRC."
21323 (let ((case-fold-search t) ov)
21324 (or (and (setq ov (overlays-at (point)))
21325 (memq 'org-block-background
21326 (overlay-properties (car ov))))
21327 (and (not inside)
21328 (save-match-data
21329 (save-excursion
21330 (beginning-of-line)
21333 (defun org-context ()
21334 "Return a list of contexts of the current cursor position.
21335 If several contexts apply, all are returned.
21336 Each context entry is a list with a symbol naming the context, and
21337 two positions indicating start and end of the context. Possible
21338 contexts are:
21340 :headline anywhere in a headline
21341 :headline-stars on the leading stars in a headline
21342 :todo-keyword on a TODO keyword (including DONE) in a headline
21343 :tags on the TAGS in a headline
21344 :priority on the priority cookie in a headline
21345 :item on the first line of a plain list item
21346 :item-bullet on the bullet/number of a plain list item
21347 :checkbox on the checkbox in a plain list item
21348 :table in an org-mode table
21349 :table-special on a special filed in a table
21350 :table-table in a table.el table
21351 :clocktable in a clocktable
21352 :src-block in a source block
21353 :link on a hyperlink
21354 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21355 :target on a <<target>>
21356 :radio-target on a <<<radio-target>>>
21357 :latex-fragment on a LaTeX fragment
21358 :latex-preview on a LaTeX fragment with overlaid preview image
21360 This function expects the position to be visible because it uses font-lock
21361 faces as a help to recognize the following contexts: :table-special, :link,
21362 and :keyword."
21363 (let* ((f (get-text-property (point) 'face))
21364 (faces (if (listp f) f (list f)))
21365 (case-fold-search t)
21366 (p (point)) clist o)
21367 ;; First the large context
21368 (cond
21369 ((org-at-heading-p t)
21370 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21371 (when (progn
21372 (beginning-of-line 1)
21373 (looking-at org-todo-line-tags-regexp))
21374 (push (org-point-in-group p 1 :headline-stars) clist)
21375 (push (org-point-in-group p 2 :todo-keyword) clist)
21376 (push (org-point-in-group p 4 :tags) clist))
21377 (goto-char p)
21380 (push (org-point-in-group p 0 :priority) clist)))
21382 ((org-at-item-p)
21383 (push (org-point-in-group p 2 :item-bullet) clist)
21384 (push (list :item (point-at-bol)
21385 (save-excursion (org-end-of-item) (point)))
21386 clist)
21387 (and (org-at-item-checkbox-p)
21388 (push (org-point-in-group p 0 :checkbox) clist)))
21390 ((org-at-table-p)
21391 (push (list :table (org-table-begin) (org-table-end)) clist)
21392 (if (memq 'org-formula faces)
21393 (push (list :table-special
21394 (previous-single-property-change p 'face)
21395 (next-single-property-change p 'face)) clist)))
21396 ((org-at-table-p 'any)
21397 (push (list :table-table) clist)))
21398 (goto-char p)
21400 (let ((case-fold-search t))
21401 ;; New the "medium" contexts: clocktables, source blocks
21402 (cond ((org-in-clocktable-p)
21403 (push (list :clocktable
21405 (search-backward "#+BEGIN: clocktable" nil t))
21406 (match-beginning 0))
21408 (match-end 0))) clist))
21409 ((org-in-src-block-p)
21410 (push (list :src-block
21412 (search-backward "#+BEGIN_SRC" nil t))
21413 (match-beginning 0))
21414 (and (search-forward "#+END_SRC" nil t)
21415 (match-beginning 0))) clist))))
21416 (goto-char p)
21418 ;; Now the small context
21419 (cond
21420 ((org-at-timestamp-p)
21421 (push (org-point-in-group p 0 :timestamp) clist))
21422 ((memq 'org-link faces)
21423 (push (list :link
21424 (previous-single-property-change p 'face)
21425 (next-single-property-change p 'face)) clist))
21426 ((memq 'org-special-keyword faces)
21427 (push (list :keyword
21428 (previous-single-property-change p 'face)
21429 (next-single-property-change p 'face)) clist))
21430 ((org-at-target-p)
21431 (push (org-point-in-group p 0 :target) clist)
21432 (goto-char (1- (match-beginning 0)))
21433 (if (looking-at org-radio-target-regexp)
21434 (push (org-point-in-group p 0 :radio-target) clist))
21435 (goto-char p))
21436 ((setq o (car (delq nil
21437 (mapcar
21438 (lambda (x)
21439 (if (memq x org-latex-fragment-image-overlays) x))
21440 (overlays-at (point))))))
21441 (push (list :latex-fragment
21442 (overlay-start o) (overlay-end o)) clist)
21443 (push (list :latex-preview
21444 (overlay-start o) (overlay-end o)) clist))
21445 ((org-inside-LaTeX-fragment-p)
21446 ;; FIXME: positions wrong.
21447 (push (list :latex-fragment (point) (point)) clist)))
21449 (setq clist (nreverse (delq nil clist)))
21450 clist))
21452 ;; FIXME: Compare with at-regexp-p Do we need both?
21453 (defun org-in-regexp (re &optional nlines visually)
21454 "Check if point is inside a match of regexp.
21455 Normally only the current line is checked, but you can include NLINES extra
21456 lines both before and after point into the search.
21457 If VISUALLY is set, require that the cursor is not after the match but
21458 really on, so that the block visually is on the match."
21459 (catch 'exit
21460 (let ((pos (point))
21461 (eol (point-at-eol (+ 1 (or nlines 0))))
21462 (inc (if visually 1 0)))
21463 (save-excursion
21464 (beginning-of-line (- 1 (or nlines 0)))
21465 (while (re-search-forward re eol t)
21466 (if (and (<= (match-beginning 0) pos)
21467 (>= (+ inc (match-end 0)) pos))
21468 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21470 (defun org-at-regexp-p (regexp)
21471 "Is point inside a match of REGEXP in the current line?"
21472 (catch 'exit
21473 (save-excursion
21474 (let ((pos (point)) (end (point-at-eol)))
21475 (beginning-of-line 1)
21476 (while (re-search-forward regexp end t)
21477 (if (and (<= (match-beginning 0) pos)
21478 (>= (match-end 0) pos))
21479 (throw 'exit t)))
21480 nil))))
21482 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21483 "Non-nil when point is between matches of START-RE and END-RE.
21485 Also return a non-nil value when point is on one of the matches.
21487 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21488 buffer positions. Default values are the positions of headlines
21489 surrounding the point.
21491 The functions returns a cons cell whose car (resp. cdr) is the
21492 position before START-RE (resp. after END-RE)."
21493 (save-match-data
21494 (let ((pos (point))
21495 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21496 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21497 beg end)
21498 (save-excursion
21499 ;; Point is on a block when on START-RE or if START-RE can be
21500 ;; found before it...
21501 (and (or (org-at-regexp-p start-re)
21502 (re-search-backward start-re limit-up t))
21503 (setq beg (match-beginning 0))
21504 ;; ... and END-RE after it...
21505 (goto-char (match-end 0))
21506 (re-search-forward end-re limit-down t)
21507 (> (setq end (match-end 0)) pos)
21508 ;; ... without another START-RE in-between.
21509 (goto-char (match-beginning 0))
21510 (not (re-search-backward start-re (1+ beg) t))
21511 ;; Return value.
21512 (cons beg end))))))
21514 (defun org-in-block-p (names)
21515 "Non-nil when point belongs to a block whose name belongs to NAMES.
21517 NAMES is a list of strings containing names of blocks.
21519 Return first block name matched, or nil. Beware that in case of
21520 nested blocks, the returned name may not belong to the closest
21521 block from point."
21522 (save-match-data
21523 (catch 'exit
21524 (let ((case-fold-search t)
21525 (lim-up (save-excursion (outline-previous-heading)))
21526 (lim-down (save-excursion (outline-next-heading))))
21527 (mapc (lambda (name)
21528 (let ((n (regexp-quote name)))
21529 (when (org-between-regexps-p
21532 lim-up lim-down)
21533 (throw 'exit n))))
21534 names))
21535 nil)))
21537 (defun org-occur-in-agenda-files (regexp &optional nlines)
21538 "Call `multi-occur' with buffers for all agenda files."
21540 (let* ((files (org-agenda-files))
21541 (tnames (mapcar 'file-truename files))
21542 (extra org-agenda-text-search-extra-files)
21543 f)
21544 (when (eq (car extra) 'agenda-archives)
21545 (setq extra (cdr extra))
21546 (setq files (org-add-archive-files files)))
21547 (while (setq f (pop extra))
21548 (unless (member (file-truename f) tnames)
21549 (add-to-list 'files f 'append)
21550 (add-to-list 'tnames (file-truename f) 'append)))
21551 (multi-occur
21552 (mapcar (lambda (x)
21553 (with-current-buffer
21554 (or (get-file-buffer x) (find-file-noselect x))
21555 (widen)
21556 (current-buffer)))
21557 files)
21558 regexp)))
21560 (if (boundp 'occur-mode-find-occurrence-hook)
21561 ;; Emacs 23
21562 (add-hook 'occur-mode-find-occurrence-hook
21563 (lambda ()
21564 (when (derived-mode-p 'org-mode)
21565 (org-reveal))))
21566 ;; Emacs 22
21567 (defadvice occur-mode-goto-occurrence
21568 (after org-occur-reveal activate)
21569 (and (derived-mode-p 'org-mode) (org-reveal)))
21570 (defadvice occur-mode-goto-occurrence-other-window
21571 (after org-occur-reveal activate)
21572 (and (derived-mode-p 'org-mode) (org-reveal)))
21573 (defadvice occur-mode-display-occurrence
21574 (after org-occur-reveal activate)
21575 (when (derived-mode-p 'org-mode)
21576 (let ((pos (occur-mode-find-occurrence)))
21577 (with-current-buffer (marker-buffer pos)
21578 (save-excursion
21579 (goto-char pos)
21580 (org-reveal)))))))
21582 (defun org-occur-link-in-agenda-files ()
21583 "Create a link and search for it in the agendas.
21584 The link is not stored in `org-stored-links', it is just created
21585 for the search purpose."
21586 (interactive)
21587 (let ((link (condition-case nil
21588 (org-store-link nil)
21589 (error "Unable to create a link to here"))))
21590 (org-occur-in-agenda-files (regexp-quote link))))
21592 (defun org-reverse-string (string)
21593 "Return the reverse of STRING."
21594 (apply 'string (reverse (string-to-list string))))
21596 (defsubst org-uniquify (list)
21597 "Non-destructively remove duplicate elements from LIST."
21598 (let ((res (copy-seq list))) (delete-dups res)))
21600 (defun org-uniquify-alist (alist)
21601 "Merge elements of ALIST with the same key.
21603 For example, in this alist:
21605 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21606 => '((a 1 3) (b 2))
21608 merge (a 1) and (a 3) into (a 1 3).
21610 The function returns the new ALIST."
21611 (let (rtn)
21612 (mapc
21613 (lambda (e)
21614 (let (n)
21615 (if (not (assoc (car e) rtn))
21616 (push e rtn)
21617 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21618 (setq rtn (assq-delete-all (car e) rtn))
21619 (push n rtn))))
21620 alist)
21621 rtn))
21623 (defun org-delete-all (elts list)
21624 "Remove all elements in ELTS from LIST."
21625 (while elts
21626 (setq list (delete (pop elts) list)))
21627 list)
21629 (defun org-count (cl-item cl-seq)
21630 "Count the number of occurrences of ITEM in SEQ.
21631 Taken from `count' in cl-seq.el with all keyword arguments removed."
21632 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21633 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21634 (while (< cl-start cl-end)
21635 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21636 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21637 (setq cl-start (1+ cl-start)))
21638 cl-count))
21640 (defun org-remove-if (predicate seq)
21641 "Remove everything from SEQ that fulfills PREDICATE."
21642 (let (res e)
21643 (while seq
21644 (setq e (pop seq))
21645 (if (not (funcall predicate e)) (push e res)))
21646 (nreverse res)))
21648 (defun org-remove-if-not (predicate seq)
21649 "Remove everything from SEQ that does not fulfill PREDICATE."
21650 (let (res e)
21651 (while seq
21652 (setq e (pop seq))
21653 (if (funcall predicate e) (push e res)))
21654 (nreverse res)))
21656 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21657 "Reduce two-argument FUNCTION across SEQ.
21658 Taken from `reduce' in cl-seq.el with all keyword arguments but
21660 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21661 (cadr (memq :initial-value cl-keys)))
21662 (cl-seq (pop cl-seq))
21663 (t (funcall cl-func)))))
21664 (while cl-seq
21665 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21666 cl-accum))
21668 (defun org-back-over-empty-lines ()
21669 "Move backwards over whitespace, to the beginning of the first empty line.
21670 Returns the number of empty lines passed."
21671 (let ((pos (point)))
21672 (if (cdr (assoc 'heading org-blank-before-new-entry))
21674 (unless (eobp)
21675 (forward-line -1)))
21676 (beginning-of-line 2)
21677 (goto-char (min (point) pos))
21678 (count-lines (point) pos)))
21680 (defun org-skip-whitespace ()
21683 (defun org-point-in-group (point group &optional context)
21684 "Check if POINT is in match-group GROUP.
21685 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21686 match. If the match group does not exist or point is not inside it,
21687 return nil."
21688 (and (match-beginning group)
21689 (>= point (match-beginning group))
21690 (<= point (match-end group))
21691 (if context
21692 (list context (match-beginning group) (match-end group))
21693 t)))
21695 (defun org-switch-to-buffer-other-window (&rest args)
21696 "Switch to buffer in a second window on the current frame.
21697 In particular, do not allow pop-up frames.
21698 Returns the newly created buffer."
21699 (org-no-popups
21700 (apply 'switch-to-buffer-other-window args)))
21702 (defun org-combine-plists (&rest plists)
21703 "Create a single property list from all plists in PLISTS.
21704 The process starts by copying the first list, and then setting properties
21705 from the other lists. Settings in the last list are the most significant
21706 ones and overrule settings in the other lists."
21707 (let ((rtn (copy-sequence (pop plists)))
21708 p v ls)
21709 (while plists
21710 (setq ls (pop plists))
21711 (while ls
21712 (setq p (pop ls) v (pop ls))
21713 (setq rtn (plist-put rtn p v))))
21714 rtn))
21716 (defun org-replace-escapes (string table)
21717 "Replace %-escapes in STRING with values in TABLE.
21719 The sequences in STRING may contain normal field width and padding information,
21721 so values can contain further %-escapes if they are define later in TABLE."
21722 (let ((tbl (copy-alist table))
21723 (case-fold-search nil)
21724 (pchg 0)
21725 e re rpl)
21726 (while (setq e (pop tbl))
21727 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21728 (when (and (cdr e) (string-match re (cdr e)))
21729 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21730 (safe "SREF"))
21731 (add-text-properties 0 3 (list 'sref sref) safe)
21732 (setcdr e (replace-match safe t t (cdr e)))))
21733 (while (string-match re string)
21734 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21735 (cdr e)))
21736 (setq string (replace-match rpl t t string))))
21737 (while (setq pchg (next-property-change pchg string))
21738 (let ((sref (get-text-property pchg 'sref string)))
21739 (when (and sref (string-match "SREF" string pchg))
21740 (setq string (replace-match sref t t string)))))
21741 string))
21743 (defun org-sublist (list start end)
21744 "Return a section of LIST, from START to END.
21745 Counting starts at 1."
21746 (let (rtn (c start))
21747 (setq list (nthcdr (1- start) list))
21748 (while (and list (<= c end))
21749 (push (pop list) rtn)
21750 (setq c (1+ c)))
21751 (nreverse rtn)))
21753 (defun org-find-base-buffer-visiting (file)
21754 "Like `find-buffer-visiting' but always return the base buffer and
21755 not an indirect buffer."
21756 (let ((buf (or (get-file-buffer file)
21757 (find-buffer-visiting file))))
21758 (if buf
21759 (or (buffer-base-buffer buf) buf)
21760 nil)))
21762 (defun org-image-file-name-regexp (&optional extensions)
21763 "Return regexp matching the file names of images.
21764 If EXTENSIONS is given, only match these."
21765 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21766 (image-file-name-regexp)
21767 (let ((image-file-name-extensions
21768 (or extensions
21769 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21770 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21772 (regexp-opt (nconc (mapcar 'upcase
21773 image-file-name-extensions)
21774 image-file-name-extensions)
21775 t)
21778 (defun org-file-image-p (file &optional extensions)
21779 "Return non-nil if FILE is an image."
21780 (save-match-data
21781 (string-match (org-image-file-name-regexp extensions) file)))
21783 (defun org-get-cursor-date (&optional with-time)
21784 "Return the date at cursor in as a time.
21785 This works in the calendar and in the agenda, anywhere else it just
21786 returns the current time.
21787 If WITH-TIME is non-nil, returns the time of the event at point (in
21788 the agenda) or the current time of the day."
21789 (let (date day defd tp tm hod mod)
21790 (when with-time
21791 (setq tp (get-text-property (point) 'time))
21793 (setq hod (string-to-number (match-string 1 tp))
21794 mod (string-to-number (match-string 2 tp))))
21795 (or tp (setq hod (nth 2 (decode-time (current-time)))
21796 mod (nth 1 (decode-time (current-time))))))
21797 (cond
21798 ((eq major-mode 'calendar-mode)
21799 (setq date (calendar-cursor-to-date)
21800 defd (encode-time 0 (or mod 0) (or hod 0)
21801 (nth 1 date) (nth 0 date) (nth 2 date))))
21802 ((eq major-mode 'org-agenda-mode)
21803 (setq day (get-text-property (point) 'day))
21804 (if day
21805 (setq date (calendar-gregorian-from-absolute day)
21806 defd (encode-time 0 (or mod 0) (or hod 0)
21807 (nth 1 date) (nth 0 date) (nth 2 date))))))
21808 (or defd (current-time))))
21810 (defun org-mark-subtree (&optional up)
21811 "Mark the current subtree.
21812 This puts point at the start of the current subtree, and mark at
21813 the end. If a numeric prefix UP is given, move up into the
21814 hierarchy of headlines by UP levels before marking the subtree."
21815 (interactive "P")
21816 (org-with-limited-levels
21817 (cond ((org-at-heading-p) (beginning-of-line))
21818 ((org-before-first-heading-p) (error "Not in a subtree"))
21819 (t (outline-previous-visible-heading 1))))
21820 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21821 (if (org-called-interactively-p 'any)
21822 (call-interactively 'org-mark-element)
21823 (org-mark-element)))
21826 ;;; Indentation
21828 (defun org-indent-line ()
21829 "Indent line depending on context."
21830 (interactive)
21831 (let* ((pos (point))
21832 (itemp (org-at-item-p))
21833 (case-fold-search t)
21835 (inline-task-p (and (featurep 'org-inlinetask)
21836 (org-inlinetask-in-task-p)))
21837 (inline-re (and inline-task-p
21838 (org-inlinetask-outline-regexp)))
21839 column)
21840 (if (and orgstruct-is-++ (eq pos (point)))
21841 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21842 (indent-according-to-mode))
21843 (beginning-of-line 1)
21844 (cond
21845 ;; Headings
21846 ((looking-at org-outline-regexp) (setq column 0))
21847 ;; Footnote definition
21848 ((looking-at org-footnote-definition-re) (setq column 0))
21849 ;; Literal examples
21851 (setq column (org-get-indentation))) ; do nothing
21852 ;; Lists
21853 ((ignore-errors (goto-char (org-in-item-p)))
21854 (setq column (if itemp
21855 (org-get-indentation)
21856 (org-list-item-body-column (point))))
21857 (goto-char pos))
21858 ;; Drawers
21860 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21861 (save-excursion
21862 (goto-char (1- (match-beginning 1)))
21863 (setq column (current-column))))
21864 ;; Special blocks
21866 (save-excursion
21867 (re-search-backward
21869 (setq column (org-get-indentation (match-string 0))))
21872 (save-excursion
21874 (setq column
21875 (cond ((equal (downcase (match-string 1)) "src")
21876 ;; src blocks: let `org-edit-src-exit' handle them
21877 (org-get-indentation))
21878 ((equal (downcase (match-string 1)) "example")
21879 (max (org-get-indentation)
21880 (org-get-indentation (match-string 0))))
21881 (t
21882 (org-get-indentation (match-string 0))))))
21883 ;; This line has nothing special, look at the previous relevant
21884 ;; line to compute indentation
21885 (t
21886 (beginning-of-line 0)
21887 (while (and (not (bobp))
21888 (not (looking-at org-table-line-regexp))
21889 (not (looking-at org-drawer-regexp))
21890 ;; When point started in an inline task, do not move
21891 ;; above task starting line.
21892 (not (and inline-task-p (looking-at inline-re)))
21893 ;; Skip drawers, blocks, empty lines, verbatim,
21894 ;; comments, tables, footnotes definitions, lists,
21895 ;; inline tasks.
21897 (re-search-backward org-drawer-regexp nil t))
21901 (looking-at org-footnote-definition-re)
21902 (and (not inline-task-p)
21903 (featurep 'org-inlinetask)
21904 (org-inlinetask-in-task-p)
21905 (or (org-inlinetask-goto-beginning) t))))
21906 (beginning-of-line 0))
21907 (cond
21908 ;; There was a list item above.
21909 ((save-excursion
21910 (and (ignore-errors (goto-char (org-in-item-p)))
21911 (goto-char
21912 (org-list-get-top-point (org-list-struct)))))
21913 (looking-at org-list-full-item-re)
21914 (setq column (length (match-string 0))))
21915 ;; There was an heading above.
21917 (if (not org-adapt-indentation)
21918 (setq column 0)
21919 (goto-char (match-end 0))
21920 (setq column (current-column))))
21921 ;; A drawer had started and is unfinished
21922 ((looking-at org-drawer-regexp)
21923 (goto-char (1- (match-beginning 1)))
21924 (setq column (current-column)))
21925 ;; Else, nothing noticeable found: get indentation and go on.
21926 (t (setq column (org-get-indentation))))))
21927 ;; Now apply indentation and move cursor accordingly
21928 (goto-char pos)
21929 (if (<= (current-column) (current-indentation))
21930 (org-indent-line-to column)
21931 (save-excursion (org-indent-line-to column)))
21932 ;; Special polishing for properties, see `org-property-format'
21933 (setq column (current-column))
21934 (beginning-of-line 1)
21935 (if (looking-at
21937 (replace-match (concat (match-string 1)
21938 (format org-property-format
21939 (match-string 2) (match-string 3)))
21940 t t))
21941 (org-move-to-column column))))
21943 (defun org-indent-drawer ()
21944 "Indent the drawer at point."
21945 (interactive)
21946 (let ((p (point))
21947 (e (and (save-excursion (re-search-forward ":END:" nil t))
21948 (match-end 0)))
21949 (folded
21950 (save-excursion
21951 (end-of-line)
21952 (when (overlays-at (point))
21953 (member 'invisible (overlay-properties
21954 (car (overlays-at (point)))))))))
21955 (when folded (org-cycle))
21956 (indent-for-tab-command)
21957 (while (and (move-beginning-of-line 2) (< (point) e))
21958 (indent-for-tab-command))
21959 (goto-char p)
21960 (when folded (org-cycle)))
21961 (message "Drawer at point indented"))
21963 (defun org-indent-block ()
21964 "Indent the block at point."
21965 (interactive)
21966 (let ((p (point))
21967 (case-fold-search t)
21969 (match-end 0)))
21970 (folded
21971 (save-excursion
21972 (end-of-line)
21973 (when (overlays-at (point))
21974 (member 'invisible (overlay-properties
21975 (car (overlays-at (point)))))))))
21976 (when folded (org-cycle))
21977 (indent-for-tab-command)
21978 (while (and (move-beginning-of-line 2) (< (point) e))
21979 (indent-for-tab-command))
21980 (goto-char p)
21981 (when folded (org-cycle)))
21982 (message "Block at point indented"))
21984 (defun org-indent-region (start end)
21985 "Indent region."
21986 (interactive "r")
21987 (save-excursion
21988 (let ((line-end (org-current-line end)))
21989 (goto-char start)
21990 (while (< (org-current-line) line-end)
21991 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21992 (t (call-interactively 'org-indent-line)))
21993 (move-beginning-of-line 2)))))
21996 ;;; Filling
21998 ;; We use our own fill-paragraph and auto-fill functions.
22000 ;; `org-fill-paragraph' relies on adaptive filling and context
22001 ;; checking. Appropriate `fill-prefix' is computed with
22002 ;; `org-adaptive-fill-function'.
22004 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22005 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22006 ;; `org-adaptive-fill-function' value. Internally,
22007 ;; `org-comment-line-break-function' breaks the line.
22009 ;; `org-setup-filling' installs filling and auto-filling related
22010 ;; variables during `org-mode' initialization.
22012 (defun org-setup-filling ()
22013 (interactive)
22014 ;; Prevent auto-fill from inserting unwanted new items.
22015 (when (boundp 'fill-nobreak-predicate)
22016 (org-set-local
22017 'fill-nobreak-predicate
22018 (org-uniquify
22019 (append fill-nobreak-predicate
22020 '(org-fill-paragraph-separate-nobreak-p
22021 org-fill-line-break-nobreak-p
22022 org-fill-paragraph-with-timestamp-nobreak-p)))))
22023 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22024 (org-set-local 'auto-fill-inhibit-regexp nil)
22025 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22026 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22027 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22029 (defvar org-element-paragraph-separate) ; org-element.el
22030 (defun org-fill-paragraph-separate-nobreak-p ()
22031 "Non-nil when a line break at point would insert a new item."
22032 (looking-at (substring org-element-paragraph-separate 1)))
22034 (defun org-fill-line-break-nobreak-p ()
22035 "Non-nil when a line break at point would create an Org line break."
22036 (save-excursion
22041 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22042 "Non-nil when a line break at point would insert a new item."
22043 (and (org-at-timestamp-p t)
22044 (not (looking-at org-ts-regexp-both))))
22046 (declare-function message-in-body-p "message" ())
22047 (defvar orgtbl-line-start-regexp) ; From org-table.el
22048 (defun org-adaptive-fill-function ()
22049 "Compute a fill prefix for the current line.
22050 Return fill prefix, as a string, or nil if current line isn't
22051 meant to be filled."
22052 (let (prefix)
22053 (catch 'exit
22054 (when (derived-mode-p 'message-mode)
22055 (save-excursion
22056 (beginning-of-line)
22057 (cond ((or (not (message-in-body-p))
22058 (looking-at orgtbl-line-start-regexp))
22059 (throw 'exit nil))
22060 ((looking-at message-cite-prefix-regexp)
22061 (throw 'exit (match-string-no-properties 0)))
22062 ((looking-at org-outline-regexp)
22063 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22064 (org-with-wide-buffer
22065 (let* ((p (line-beginning-position))
22066 (element (save-excursion
22067 (beginning-of-line)
22068 (or (ignore-errors (org-element-at-point))
22069 (user-error "An element cannot be parsed line %d"
22070 (line-number-at-pos (point))))))
22071 (type (org-element-type element))
22072 (post-affiliated (org-element-property :post-affiliated element)))
22073 (unless (and post-affiliated (< p post-affiliated))
22074 (case type
22076 (footnote-definition "")
22077 ((item plain-list)
22078 (make-string (org-list-item-body-column
22079 (or post-affiliated
22080 (org-element-property :begin element)))
22081 ? ))
22082 (paragraph
22083 ;; Fill prefix is usually the same as the current line,
22084 ;; except if the paragraph is at the beginning of an item.
22085 (let ((parent (org-element-property :parent element)))
22086 (cond ((eq (org-element-type parent) 'item)
22087 (make-string (org-list-item-body-column
22088 (org-element-property :begin parent))
22089 ? ))
22091 (match-string 0))
22092 (t ""))))
22093 (comment-block
22094 ;; Only fill contents if P is within block boundaries.
22095 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22096 (forward-line)
22097 (point)))
22098 (cend (save-excursion
22099 (goto-char (org-element-property :end element))
22101 (line-beginning-position))))
22102 (when (and (>= p cbeg) (< p cend))
22104 (match-string 0)
22105 "")))))))))))
22107 (declare-function message-goto-body "message" ())
22108 (defvar message-cite-prefix-regexp) ; From message.el
22109 (defun org-fill-paragraph (&optional justify)
22110 "Fill element at point, when applicable.
22112 This function only applies to comment blocks, comments, example
22113 blocks and paragraphs. Also, as a special case, re-align table
22114 when point is at one.
22116 If JUSTIFY is non-nil (interactively, with prefix argument),
22117 justify as well. If `sentence-end-double-space' is non-nil, then
22118 period followed by one space does not end a sentence, so don't
22119 break a line there. The variable `fill-column' controls the
22120 width for filling.
22122 For convenience, when point is at a plain list, an item or
22123 a footnote definition, try to fill the first paragraph within."
22124 (interactive)
22125 (if (and (derived-mode-p 'message-mode)
22126 (or (not (message-in-body-p))
22127 (save-excursion (move-beginning-of-line 1)
22128 (looking-at message-cite-prefix-regexp))))
22129 ;; First ensure filling is correct in message-mode.
22130 (let ((fill-paragraph-function
22131 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22132 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22133 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22134 (paragraph-separate
22135 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22136 (fill-paragraph nil))
22137 (with-syntax-table org-mode-transpose-word-syntax-table
22138 ;; Move to end of line in order to get the first paragraph
22139 ;; within a plain list or a footnote definition.
22140 (let ((element (save-excursion
22141 (end-of-line)
22142 (or (ignore-errors (org-element-at-point))
22143 (user-error "An element cannot be parsed line %d"
22144 (line-number-at-pos (point)))))))
22145 ;; First check if point is in a blank line at the beginning of
22146 ;; the buffer. In that case, ignore filling.
22147 (case (org-element-type element)
22148 ;; Use major mode filling function is src blocks.
22149 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22150 ;; Align Org tables, leave table.el tables as-is.
22151 (table-row (org-table-align) t)
22152 (table
22153 (when (eq (org-element-property :type element) 'org)
22154 (org-table-align))
22155 t)
22156 (paragraph
22157 ;; Paragraphs may contain `line-break' type objects.
22158 (let ((beg (max (point-min)
22159 (org-element-property :contents-begin element)))
22160 (end (min (point-max)
22161 (org-element-property :contents-end element))))
22162 ;; Do nothing if point is at an affiliated keyword.
22163 (if (< (line-end-position) beg) t
22164 (when (derived-mode-p 'message-mode)
22165 ;; In `message-mode', do not fill following citation
22166 ;; in current paragraph nor text before message body.
22167 (let ((body-start (save-excursion (message-goto-body))))
22168 (when body-start (setq beg (max body-start beg))))
22169 (when (save-excursion
22170 (re-search-forward
22171 (concat "^" message-cite-prefix-regexp) end t))
22172 (setq end (match-beginning 0))))
22173 ;; Fill paragraph, taking line breaks into account.
22174 ;; For that, slice the paragraph using line breaks as
22175 ;; separators, and fill the parts in reverse order to
22176 ;; avoid messing with markers.
22177 (save-excursion
22178 (goto-char end)
22179 (mapc
22180 (lambda (pos)
22181 (fill-region-as-paragraph pos (point) justify)
22182 (goto-char pos))
22183 ;; Find the list of ending positions for line breaks
22184 ;; in the current paragraph. Add paragraph
22185 ;; beginning to include first slice.
22186 (nreverse
22187 (cons beg
22188 (org-element-map
22189 (org-element--parse-objects
22190 beg end nil (org-element-restriction 'paragraph))
22191 'line-break
22192 (lambda (lb) (org-element-property :end lb)))))))
22193 t)))
22194 ;; Contents of `comment-block' type elements should be
22195 ;; filled as plain text, but only if point is within block
22196 ;; markers.
22197 (comment-block
22198 (let* ((case-fold-search t)
22199 (beg (save-excursion
22200 (goto-char (org-element-property :begin element))
22202 (forward-line)
22203 (point)))
22204 (end (save-excursion
22205 (goto-char (org-element-property :end element))
22207 (line-beginning-position))))
22208 (when (and (>= (point) beg) (< (point) end))
22209 (fill-region-as-paragraph
22210 (save-excursion
22211 (end-of-line)
22213 (line-beginning-position))
22214 (save-excursion
22215 (beginning-of-line)
22217 (line-beginning-position))
22218 justify)))
22219 t)
22220 ;; Fill comments.
22221 (comment (fill-comment-paragraph justify))
22222 ;; Ignore every other element.
22223 (otherwise t))))))
22225 (defun org-auto-fill-function ()
22226 "Auto-fill function."
22227 ;; Check if auto-filling is meaningful.
22228 (let ((fc (current-fill-column)))
22229 (when (and fc (> (current-column) fc))
22230 (let* ((fill-prefix (org-adaptive-fill-function))
22231 ;; Enforce empty fill prefix, if required. Otherwise, it
22232 ;; will be computed again.
22233 (adaptive-fill-mode (not (equal fill-prefix ""))))
22234 (when fill-prefix (do-auto-fill))))))
22236 (defun org-comment-line-break-function (&optional soft)
22237 "Break line at point and indent, continuing comment if within one.
22238 The inserted newline is marked hard if variable
22239 `use-hard-newlines' is true, unless optional argument SOFT is
22240 non-nil."
22242 (save-excursion (forward-char -1) (delete-horizontal-space))
22243 (delete-horizontal-space)
22244 (indent-to-left-margin)
22245 (insert-before-markers-and-inherit fill-prefix))
22248 ;;; Comments
22250 ;; Org comments syntax is quite complex. It requires the entire line
22251 ;; to be just a comment. Also, even with the right syntax at the
22252 ;; beginning of line, some some elements (i.e. verse-block or
22253 ;; example-block) don't accept comments. Usual Emacs comment commands
22254 ;; cannot cope with those requirements. Therefore, Org replaces them.
22256 ;; Org still relies on `comment-dwim', but cannot trust
22257 ;; `comment-only-p'. So, `comment-region-function' and
22258 ;; `uncomment-region-function' both point
22259 ;; to`org-comment-or-uncomment-region'. Eventually,
22260 ;; `org-insert-comment' takes care of insertion of comments at the
22261 ;; beginning of line.
22263 ;; `org-setup-comments-handling' install comments related variables
22264 ;; during `org-mode' initialization.
22266 (defun org-setup-comments-handling ()
22267 (interactive)
22268 (org-set-local 'comment-use-syntax nil)
22269 (org-set-local 'comment-start "# ")
22271 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22272 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22273 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22275 (defun org-insert-comment ()
22276 "Insert an empty comment above current line.
22277 If the line is empty, insert comment at its beginning."
22278 (beginning-of-line)
22280 (org-indent-line)
22281 (insert "# "))
22283 (defvar comment-empty-lines) ; From newcomment.el.
22284 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22285 "Comment or uncomment each non-blank line in the region.
22286 Uncomment each non-blank line between BEG and END if it only
22287 contains commented lines. Otherwise, comment them."
22288 (save-restriction
22289 ;; Restrict region
22290 (narrow-to-region (save-excursion (goto-char beg)
22292 (line-beginning-position))
22293 (save-excursion (goto-char end)
22295 (line-end-position)))
22296 (let ((uncommentp
22297 ;; UNCOMMENTP is non-nil when every non blank line between
22298 ;; BEG and END is a comment.
22299 (save-excursion
22300 (goto-char (point-min))
22301 (while (and (not (eobp))
22302 (let ((element (org-element-at-point)))
22303 (and (eq (org-element-type element) 'comment)
22304 (goto-char (min (point-max)
22305 (org-element-property
22306 :end element)))))))
22307 (eobp))))
22308 (if uncommentp
22309 ;; Only blank lines and comments in region: uncomment it.
22310 (save-excursion
22311 (goto-char (point-min))
22312 (while (not (eobp))
22314 (replace-match "" nil nil nil 1))
22315 (forward-line)))
22316 ;; Comment each line in region.
22317 (let ((min-indent (point-max)))
22318 ;; First find the minimum indentation across all lines.
22319 (save-excursion
22320 (goto-char (point-min))
22321 (while (and (not (eobp)) (not (zerop min-indent)))
22323 (setq min-indent (min min-indent (current-indentation))))
22324 (forward-line)))
22325 ;; Then loop over all lines.
22326 (save-excursion
22327 (goto-char (point-min))
22328 (while (not (eobp))
22330 ;; Don't get fooled by invisible text (e.g. link path)
22331 ;; when moving to column MIN-INDENT.
22332 (let ((buffer-invisibility-spec nil))
22333 (org-move-to-column min-indent t))
22334 (insert comment-start))
22335 (forward-line))))))))
22338 ;;; Planning
22340 ;; This section contains tools to operate on timestamp objects, as
22341 ;; returned by, e.g. `org-element-context'.
22343 (defun org-timestamp-has-time-p (timestamp)
22344 "Non-nil when TIMESTAMP has a time specified."
22345 (org-element-property :hour-start timestamp))
22347 (defun org-timestamp-format (timestamp format &optional end utc)
22348 "Format a TIMESTAMP element into a string.
22350 FORMAT is a format specifier to be passed to
22351 `format-time-string'.
22353 When optional argument END is non-nil, use end of date-range or
22354 time-range, if possible.
22356 When optional argument UTC is non-nil, time will be expressed as
22357 Universal Time."
22358 (format-time-string
22359 format
22360 (apply 'encode-time
22361 (cons 0
22362 (mapcar
22363 (lambda (prop) (or (org-element-property prop timestamp) 0))
22364 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22365 '(:minute-start :hour-start :day-start :month-start
22366 :year-start)))))
22367 utc))
22369 (defun org-timestamp-split-range (timestamp &optional end)
22370 "Extract a timestamp object from a date or time range.
22372 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22373 the end of the range. Otherwise, extract its start.
22375 Return a new timestamp object sharing the same parent as
22376 TIMESTAMP."
22377 (let ((type (org-element-property :type timestamp)))
22378 (if (memq type '(active inactive diary)) timestamp
22379 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22380 ;; Set new type.
22381 (org-element-put-property
22382 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22383 ;; Copy start properties over end properties if END is
22384 ;; non-nil. Otherwise, copy end properties over `start' ones.
22385 (let ((p-alist '((:minute-start . :minute-end)
22386 (:hour-start . :hour-end)
22387 (:day-start . :day-end)
22388 (:month-start . :month-end)
22389 (:year-start . :year-end))))
22390 (dolist (p-cell p-alist)
22391 (org-element-put-property
22392 split-ts
22393 (funcall (if end 'car 'cdr) p-cell)
22394 (org-element-property
22395 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22396 ;; Eventually refresh `:raw-value'.
22397 (org-element-put-property split-ts :raw-value nil)
22398 (org-element-put-property
22399 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22401 (defun org-timestamp-translate (timestamp &optional boundary)
22402 "Apply `org-translate-time' on a TIMESTAMP object.
22403 When optional argument BOUNDARY is non-nil, it is either the
22404 symbol `start' or `end'. In this case, only translate the
22405 starting or ending part of TIMESTAMP if it is a date or time
22406 range. Otherwise, translate both parts."
22407 (if (and (not boundary)
22408 (memq (org-element-property :type timestamp)
22409 '(active-range inactive-range)))
22410 (concat
22411 (org-translate-time
22412 (org-element-property :raw-value
22413 (org-timestamp-split-range timestamp)))
22414 "--"
22415 (org-translate-time
22416 (org-element-property :raw-value
22417 (org-timestamp-split-range timestamp t))))
22418 (org-translate-time
22419 (org-element-property
22420 :raw-value
22421 (if (not boundary) timestamp
22422 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22426 ;;; Other stuff.
22428 (defun org-toggle-fixed-width-section (arg)
22429 "Toggle the fixed-width export.
22430 If there is no active region, the QUOTE keyword at the current headline is
22431 inserted or removed. When present, it causes the text between this headline
22432 and the next to be exported as fixed-width text, and unmodified.
22433 If there is an active region, this command adds or removes a colon as the
22434 first character of this line. If the first character of a line is a colon,
22435 this line is also exported in fixed-width font."
22436 (interactive "P")
22437 (let* ((cc 0)
22438 (regionp (org-region-active-p))
22439 (beg (if regionp (region-beginning) (point)))
22440 (end (if regionp (region-end)))
22441 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22442 (case-fold-search nil)
22444 off)
22445 (if regionp
22446 (save-excursion
22447 (goto-char beg)
22448 (setq cc (current-column))
22449 (beginning-of-line 1)
22450 (setq off (looking-at re))
22451 (while (> nlines 0)
22452 (setq nlines (1- nlines))
22453 (beginning-of-line 1)
22454 (cond
22455 (arg
22456 (org-move-to-column cc t)
22458 (forward-line -1))
22459 ((and off (looking-at re))
22460 (replace-match "" t t nil 1))
22461 ((not off) (org-move-to-column cc t) (insert ": ")))
22462 (forward-line 1)))
22463 (save-excursion
22464 (org-back-to-heading)
22465 (cond
22466 ((looking-at (format org-heading-keyword-regexp-format
22467 org-quote-string))
22468 (goto-char (match-end 1))
22469 (looking-at (concat " +" org-quote-string))
22470 (replace-match "" t t)
22471 (when (eolp) (insert " ")))
22472 ((looking-at org-outline-regexp)
22473 (goto-char (match-end 0))
22474 (insert org-quote-string " ")))))))
22476 (defun org-reftex-citation ()
22477 "Use reftex-citation to insert a citation into the buffer.
22478 This looks for a line like
22480 #+BIBLIOGRAPHY: foo plain option:-d
22482 and derives from it that foo.bib is the bibliography file relevant
22483 for this document. It then installs the necessary environment for RefTeX
22484 to work in this buffer and calls `reftex-citation' to insert a citation
22485 into the buffer.
22487 Export of such citations to both LaTeX and HTML is handled by the contributed
22488 package org-exp-bibtex by Taru Karttunen."
22489 (interactive)
22490 (let ((reftex-docstruct-symbol 'rds)
22492 rds bib)
22493 (save-excursion
22494 (save-restriction
22495 (widen)
22496 (let ((case-fold-search t)
22498 (if (not (save-excursion
22499 (or (re-search-forward re nil t)
22500 (re-search-backward re nil t))))
22501 (error "No bibliography defined in file")
22502 (setq bib (concat (match-string 1) ".bib")
22503 rds (list (list 'bib bib)))))))
22504 (call-interactively 'reftex-citation)))
22506 ;;;; Functions extending outline functionality
22508 (defun org-beginning-of-line (&optional arg)
22509 "Go to the beginning of the current line. If that is invisible, continue
22510 to a visible line beginning. This makes the function of C-a more intuitive.
22511 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22512 first attempt, and only move to after the tags when the cursor is already
22513 beyond the end of the headline."
22514 (interactive "P")
22515 (let ((pos (point))
22516 (special (if (consp org-special-ctrl-a/e)
22517 (car org-special-ctrl-a/e)
22518 org-special-ctrl-a/e))
22519 refpos)
22520 (if (org-bound-and-true-p visual-line-mode)
22521 (beginning-of-visual-line 1)
22522 (beginning-of-line 1))
22523 (if (and arg (fboundp 'move-beginning-of-line))
22524 (call-interactively 'move-beginning-of-line)
22525 (if (bobp)
22526 nil
22527 (backward-char 1)
22528 (if (org-truely-invisible-p)
22529 (while (and (not (bobp)) (org-truely-invisible-p))
22530 (backward-char 1)
22531 (beginning-of-line 1))
22532 (forward-char 1))))
22533 (when special
22534 (cond
22535 ((and (looking-at org-complex-heading-regexp)
22536 (= (char-after (match-end 1)) ?\ ))
22537 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22538 (point-at-eol)))
22539 (goto-char
22540 (if (eq special t)
22541 (cond ((> pos refpos) refpos)
22542 ((= pos (point)) refpos)
22543 (t (point)))
22544 (cond ((> pos (point)) (point))
22545 ((not (eq last-command this-command)) (point))
22546 (t refpos)))))
22547 ((org-at-item-p)
22548 ;; Being at an item and not looking at an the item means point
22549 ;; was previously moved to beginning of a visual line, which
22550 ;; doesn't contain the item. Therefore, do nothing special,
22551 ;; just stay here.
22552 (when (looking-at org-list-full-item-re)
22553 ;; Set special position at first white space character after
22554 ;; bullet, and check-box, if any.
22555 (let ((after-bullet
22556 (let ((box (match-end 3)))
22557 (if (not box) (match-end 1)
22558 (let ((after (char-after box)))
22559 (if (and after (= after ? )) (1+ box) box))))))
22560 ;; Special case: Move point to special position when
22561 ;; currently after it or at beginning of line.
22562 (if (eq special t)
22563 (when (or (> pos after-bullet) (= (point) pos))
22564 (goto-char after-bullet))
22565 ;; Reversed case: Move point to special position when
22566 ;; point was already at beginning of line and command is
22567 ;; repeated.
22568 (when (and (= (point) pos) (eq last-command this-command))
22569 (goto-char after-bullet))))))))
22570 (org-no-warnings
22571 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22573 (defun org-end-of-line (&optional arg)
22574 "Go to the end of the line.
22575 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22576 tags on the first attempt, and only move to after the tags when
22577 the cursor is already beyond the end of the headline."
22578 (interactive "P")
22579 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22580 org-special-ctrl-a/e))
22581 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22582 'end-of-visual-line)
22583 ((fboundp 'move-end-of-line) 'move-end-of-line)
22584 (t 'end-of-line))))
22585 (if (or (not special) arg) (call-interactively move-fun)
22586 (let* ((element (save-excursion (beginning-of-line)
22587 (org-element-at-point)))
22588 (type (org-element-type element)))
22589 (cond
22590 ((memq type '(headline inlinetask))
22591 (let ((pos (point)))
22592 (beginning-of-line 1)
22594 (if (eq special t)
22595 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22596 (goto-char (match-beginning 1))
22597 (goto-char (match-end 0)))
22598 (if (or (< pos (match-end 0))
22599 (not (eq this-command last-command)))
22600 (goto-char (match-end 0))
22601 (goto-char (match-beginning 1))))
22602 (call-interactively move-fun))))
22603 ((org-element-property :hiddenp element)
22604 ;; If element is hidden, `move-end-of-line' would put point
22605 ;; after it. Use `end-of-line' to stay on current line.
22606 (call-interactively 'end-of-line))
22607 (t (call-interactively move-fun)))))
22608 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22610 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22611 (define-key org-mode-map "\C-e" 'org-end-of-line)
22613 (defun org-backward-sentence (&optional arg)
22614 "Go to beginning of sentence, or beginning of table field.
22615 This will call `backward-sentence' or `org-table-beginning-of-field',
22616 depending on context."
22617 (interactive "P")
22618 (cond
22619 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22620 (t (call-interactively 'backward-sentence))))
22622 (defun org-forward-sentence (&optional arg)
22623 "Go to end of sentence, or end of table field.
22624 This will call `forward-sentence' or `org-table-end-of-field',
22625 depending on context."
22626 (interactive "P")
22627 (cond
22628 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22629 (t (call-interactively 'forward-sentence))))
22631 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22632 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22634 (defun org-kill-line (&optional arg)
22635 "Kill line, to tags or end of line."
22636 (interactive "P")
22637 (cond
22638 ((or (not org-special-ctrl-k)
22639 (bolp)
22640 (not (org-at-heading-p)))
22641 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22642 org-ctrl-k-protect-subtree)
22643 (if (or (eq org-ctrl-k-protect-subtree 'error)
22644 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22645 (error "C-k aborted - would kill hidden subtree")))
22646 (call-interactively
22647 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22649 (kill-region (point) (match-beginning 1))
22650 (org-set-tags nil t))
22651 (t (kill-region (point) (point-at-eol)))))
22653 (define-key org-mode-map "\C-k" 'org-kill-line)
22655 (defun org-yank (&optional arg)
22656 "Yank. If the kill is a subtree, treat it specially.
22657 This command will look at the current kill and check if is a single
22658 subtree, or a series of subtrees[1]. If it passes the test, and if the
22659 cursor is at the beginning of a line or after the stars of a currently
22660 empty headline, then the yank is handled specially. How exactly depends
22661 on the value of the following variables, both set by default.
22663 org-yank-folded-subtrees
22664 When set, the subtree(s) will be folded after insertion, but only
22665 if doing so would now swallow text after the yanked text.
22667 org-yank-adjusted-subtrees
22668 When set, the subtree will be promoted or demoted in order to
22669 fit into the local outline tree structure, which means that the level
22670 will be adjusted so that it becomes the smaller one of the two
22671 *visible* surrounding headings.
22673 Any prefix to this command will cause `yank' to be called directly with
22675 will just
22676 plainly yank the text as it is.
22678 \[1] The test checks if the first non-white line is a heading
22679 and if there are no other headings with fewer stars."
22680 (interactive "P")
22681 (org-yank-generic 'yank arg))
22683 (defun org-yank-generic (command arg)
22684 "Perform some yank-like command.
22686 This function implements the behavior described in the `org-yank'
22687 documentation. However, it has been generalized to work for any
22688 interactive command with similar behavior."
22690 ;; pretend to be command COMMAND
22691 (setq this-command command)
22693 (if arg
22694 (call-interactively command)
22696 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22697 (and (org-kill-is-subtree-p)
22698 (or (bolp)
22700 (string-match
22702 (buffer-substring (point-at-bol) (point)))))))
22703 swallowp)
22704 (cond
22705 ((and subtreep org-yank-folded-subtrees)
22706 (let ((beg (point))
22707 end)
22708 (if (and subtreep org-yank-adjusted-subtrees)
22709 (org-paste-subtree nil nil 'for-yank)
22710 (call-interactively command))
22712 (setq end (point))
22713 (goto-char beg)
22714 (when (and (bolp) subtreep
22715 (not (setq swallowp
22716 (org-yank-folding-would-swallow-text beg end))))
22717 (org-with-limited-levels
22718 (or (looking-at org-outline-regexp)
22719 (re-search-forward org-outline-regexp-bol end t))
22720 (while (and (< (point) end) (looking-at org-outline-regexp))
22721 (hide-subtree)
22722 (org-cycle-show-empty-lines 'folded)
22723 (condition-case nil
22724 (outline-forward-same-level 1)
22725 (error (goto-char end))))))
22726 (when swallowp
22727 (message
22728 "Inserted text not folded because that would swallow text"))
22730 (goto-char end)
22732 (beginning-of-line 1)
22733 (push-mark beg 'nomsg)))
22734 ((and subtreep org-yank-adjusted-subtrees)
22735 (let ((beg (point-at-bol)))
22736 (org-paste-subtree nil nil 'for-yank)
22737 (push-mark beg 'nomsg)))
22738 (t
22739 (call-interactively command))))))
22741 (defun org-yank-folding-would-swallow-text (beg end)
22742 "Would hide-subtree at BEG swallow any text after END?"
22743 (let (level)
22744 (org-with-limited-levels
22745 (save-excursion
22746 (goto-char beg)
22747 (when (or (looking-at org-outline-regexp)
22748 (re-search-forward org-outline-regexp-bol end t))
22749 (setq level (org-outline-level)))
22750 (goto-char end)
22752 (if (or (eobp)
22753 (and (bolp) (looking-at org-outline-regexp)
22754 (<= (org-outline-level) level)))
22755 nil ; Nothing would be swallowed
22756 t))))) ; something would swallow
22758 (define-key org-mode-map "\C-y" 'org-yank)
22760 (defun org-truely-invisible-p ()
22761 "Check if point is at a character currently not visible.
22762 This version does not only check the character property, but also
22763 `visible-mode'."
22764 ;; Early versions of noutline don't have `outline-invisible-p'.
22765 (if (org-bound-and-true-p visible-mode)
22766 nil
22767 (outline-invisible-p)))
22769 (defun org-invisible-p2 ()
22770 "Check if point is at a character currently not visible."
22771 (save-excursion
22772 (if (and (eolp) (not (bobp))) (backward-char 1))
22773 ;; Early versions of noutline don't have `outline-invisible-p'.
22774 (outline-invisible-p)))
22776 (defun org-back-to-heading (&optional invisible-ok)
22777 "Call `outline-back-to-heading', but provide a better error message."
22778 (condition-case nil
22779 (outline-back-to-heading invisible-ok)
22780 (error (error "Before first headline at position %d in buffer %s"
22781 (point) (current-buffer)))))
22783 (defun org-before-first-heading-p ()
22784 "Before first heading?"
22785 (save-excursion
22786 (end-of-line)
22787 (null (re-search-backward org-outline-regexp-bol nil t))))
22789 (defun org-at-heading-p (&optional ignored)
22790 (outline-on-heading-p t))
22791 ;; Compatibility alias with Org versions < 7.8.03
22792 (defalias 'org-on-heading-p 'org-at-heading-p)
22794 (defun org-at-comment-p nil
22795 "Is cursor in a line starting with a # character?"
22796 (save-excursion
22797 (beginning-of-line)
22798 (looking-at "^#")))
22800 (defun org-at-drawer-p nil
22801 "Is cursor at a drawer keyword?"
22802 (save-excursion
22803 (move-beginning-of-line 1)
22804 (looking-at org-drawer-regexp)))
22806 (defun org-at-block-p nil
22807 "Is cursor at a block keyword?"
22808 (save-excursion
22809 (move-beginning-of-line 1)
22810 (looking-at org-block-regexp)))
22812 (defun org-point-at-end-of-empty-headline ()
22813 "If point is at the end of an empty headline, return t, else nil.
22814 If the heading only contains a TODO keyword, it is still still considered
22815 empty."
22817 (when org-todo-line-regexp
22818 (save-excursion
22819 (beginning-of-line 1)
22820 (let ((case-fold-search nil))
22821 (looking-at org-todo-line-regexp)
22822 (string= (match-string 3) ""))))))
22824 (defun org-at-heading-or-item-p ()
22825 (or (org-at-heading-p) (org-at-item-p)))
22827 (defun org-at-target-p ()
22828 (or (org-in-regexp org-radio-target-regexp)
22829 (org-in-regexp org-target-regexp)))
22830 ;; Compatibility alias with Org versions < 7.8.03
22831 (defalias 'org-on-target-p 'org-at-target-p)
22833 (defun org-up-heading-all (arg)
22834 "Move to the heading line of which the present line is a subheading.
22835 This function considers both visible and invisible heading lines.
22836 With argument, move up ARG levels."
22837 (if (fboundp 'outline-up-heading-all)
22838 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22839 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22841 (defun org-up-heading-safe ()
22842 "Move to the heading line of which the present line is a subheading.
22843 This version will not throw an error. It will return the level of the
22844 headline found, or nil if no higher level is found.
22846 Also, this function will be a lot faster than `outline-up-heading',
22847 because it relies on stars being the outline starters. This can really
22848 make a significant difference in outlines with very many siblings."
22849 (let (start-level re)
22850 (org-back-to-heading t)
22851 (setq start-level (funcall outline-level))
22852 (if (equal start-level 1)
22853 nil
22855 (if (re-search-backward re nil t)
22856 (funcall outline-level)))))
22858 (defun org-first-sibling-p ()
22859 "Is this heading the first child of its parents?"
22860 (interactive)
22861 (let ((re org-outline-regexp-bol)
22862 level l)
22863 (unless (org-at-heading-p t)
22864 (error "Not at a heading"))
22865 (setq level (funcall outline-level))
22866 (save-excursion
22867 (if (not (re-search-backward re nil t))
22868 t
22869 (setq l (funcall outline-level))
22870 (< l level)))))
22872 (defun org-goto-sibling (&optional previous)
22873 "Goto the next sibling, even if it is invisible.
22874 When PREVIOUS is set, go to the previous sibling instead. Returns t
22875 when a sibling was found. When none is found, return nil and don't
22876 move point."
22877 (let ((fun (if previous 're-search-backward 're-search-forward))
22878 (pos (point))
22879 (re org-outline-regexp-bol)
22880 level l)
22881 (when (condition-case nil (org-back-to-heading t) (error nil))
22882 (setq level (funcall outline-level))
22883 (catch 'exit
22884 (or previous (forward-char 1))
22885 (while (funcall fun re nil t)
22886 (setq l (funcall outline-level))
22887 (when (< l level) (goto-char pos) (throw 'exit nil))
22888 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22889 (goto-char pos)
22890 nil))))
22892 (defun org-show-siblings ()
22893 "Show all siblings of the current headline."
22894 (save-excursion
22895 (while (org-goto-sibling) (org-flag-heading nil)))
22896 (save-excursion
22897 (while (org-goto-sibling 'previous)
22898 (org-flag-heading nil))))
22900 (defun org-goto-first-child ()
22901 "Goto the first child, even if it is invisible.
22902 Return t when a child was found. Otherwise don't move point and
22903 return nil."
22904 (let (level (pos (point)) (re org-outline-regexp-bol))
22905 (when (condition-case nil (org-back-to-heading t) (error nil))
22906 (setq level (outline-level))
22907 (forward-char 1)
22908 (if (and (re-search-forward re nil t) (> (outline-level) level))
22909 (progn (goto-char (match-beginning 0)) t)
22910 (goto-char pos) nil))))
22912 (defun org-show-hidden-entry ()
22913 "Show an entry where even the heading is hidden."
22914 (save-excursion
22915 (org-show-entry)))
22917 (defun org-flag-heading (flag &optional entry)
22918 "Flag the current heading. FLAG non-nil means make invisible.
22919 When ENTRY is non-nil, show the entire entry."
22920 (save-excursion
22921 (org-back-to-heading t)
22922 ;; Check if we should show the entire entry
22923 (if entry
22924 (progn
22925 (org-show-entry)
22926 (save-excursion
22927 (and (outline-next-heading)
22928 (org-flag-heading nil))))
22929 (outline-flag-region (max (point-min) (1- (point)))
22930 (save-excursion (outline-end-of-heading) (point))
22931 flag))))
22933 (defun org-get-next-sibling ()
22934 "Move to next heading of the same level, and return point.
22935 If there is no such heading, return nil.
22936 This is like outline-next-sibling, but invisible headings are ok."
22937 (let ((level (funcall outline-level)))
22938 (outline-next-heading)
22939 (while (and (not (eobp)) (> (funcall outline-level) level))
22940 (outline-next-heading))
22941 (if (or (eobp) (< (funcall outline-level) level))
22942 nil
22943 (point))))
22945 (defun org-get-last-sibling ()
22946 "Move to previous heading of the same level, and return point.
22947 If there is no such heading, return nil."
22948 (let ((opoint (point))
22949 (level (funcall outline-level)))
22950 (outline-previous-heading)
22951 (when (and (/= (point) opoint) (outline-on-heading-p t))
22952 (while (and (> (funcall outline-level) level)
22953 (not (bobp)))
22954 (outline-previous-heading))
22955 (if (< (funcall outline-level) level)
22956 nil
22957 (point)))))
22959 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22960 "Goto to the end of a subtree."
22961 ;; This contains an exact copy of the original function, but it uses
22962 ;; `org-back-to-heading', to make it work also in invisible
22963 ;; trees. And is uses an invisible-ok argument.
22964 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22965 ;; Furthermore, when used inside Org, finding the end of a large subtree
22966 ;; with many children and grandchildren etc, this can be much faster
22967 ;; than the outline version.
22968 (org-back-to-heading invisible-ok)
22969 (let ((first t)
22970 (level (funcall outline-level)))
22971 (if (and (derived-mode-p 'org-mode) (< level 1000))
22972 ;; A true heading (not a plain list item), in Org-mode
22973 ;; This means we can easily find the end by looking
22974 ;; only for the right number of stars. Using a regexp to do
22975 ;; this is so much faster than using a Lisp loop.
22977 (forward-char 1)
22978 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22979 ;; something else, do it the slow way
22980 (while (and (not (eobp))
22981 (or first (> (funcall outline-level) level)))
22982 (setq first nil)
22983 (outline-next-heading)))
22984 (unless to-heading
22986 (progn
22987 ;; Go to end of line before heading
22988 (forward-char -1)
22990 ;; leave blank line before heading
22991 (forward-char -1))))))
22992 (point))
22994 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22995 "Use Org version in org-mode, for dramatic speed-up."
22996 (if (derived-mode-p 'org-mode)
22997 (progn
22998 (org-end-of-subtree nil t)
22999 (unless (eobp) (backward-char 1)))
23000 ad-do-it))
23002 (defun org-end-of-meta-data-and-drawers ()
23003 "Jump to the first text after meta data and drawers in the current entry.
23004 This will move over empty lines, lines with planning time stamps,
23005 clocking lines, and drawers."
23006 (org-back-to-heading t)
23007 (let ((end (save-excursion (outline-next-heading) (point)))
23010 (forward-line 1)
23011 (while (re-search-forward re end t)
23012 (if (not (match-end 1))
23013 ;; empty or planning line
23014 (forward-line 1)
23015 ;; a drawer, find the end
23017 (forward-line 1)))
23019 (point)))
23021 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23022 "Move forward to the ARG'th subheading at same level as this one.
23023 Stop at the first and last subheadings of a superior heading.
23024 Normally this only looks at visible headings, but when INVISIBLE-OK is
23025 non-nil it will also look at invisible ones."
23026 (interactive "p")
23027 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23028 (if (and arg (< arg 0))
23029 (goto-char (point-min))
23030 (outline-next-heading))
23031 (org-at-heading-p)
23032 (let ((level (- (match-end 0) (match-beginning 0) 1))
23033 (f (if (and arg (< arg 0))
23034 're-search-backward
23035 're-search-forward))
23036 (count (if arg (abs arg) 1))
23037 (result (point)))
23038 (while (and (prog1 (> count 0)
23039 (forward-char (if (and arg (< arg 0)) -1 1)))
23040 (funcall f org-outline-regexp-bol nil 'move))
23041 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23042 (cond ((< l level) (setq count 0))
23043 ((and (= l level)
23044 (or invisible-ok
23045 (progn
23046 (goto-char (line-beginning-position))
23047 (not (outline-invisible-p)))))
23048 (setq count (1- count))
23049 (when (eq l level)
23050 (setq result (point)))))))
23051 (goto-char result))
23052 (beginning-of-line 1)))
23054 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23055 "Move backward to the ARG'th subheading at same level as this one.
23056 Stop at the first and last subheadings of a superior heading."
23057 (interactive "p")
23058 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23060 (defun org-next-block (arg &optional backward block-regexp)
23061 "Jump to the next block.
23062 With a prefix argument ARG, jump forward ARG many source blocks.
23063 When BACKWARD is non-nil, jump to the previous block.
23064 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23065 (interactive "p")
23066 (let ((re (or block-regexp org-block-regexp))
23067 (re-search-fn (or (and backward 're-search-backward)
23068 're-search-forward)))
23069 (if (looking-at re) (forward-char 1))
23070 (condition-case nil
23071 (funcall re-search-fn re nil nil arg)
23072 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23073 (goto-char (match-beginning 0)) (org-show-context)))
23075 (defun org-previous-block (arg &optional block-regexp)
23076 "Jump to the previous block.
23077 With a prefix argument ARG, jump backward ARG many source blocks.
23078 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23079 (interactive "p")
23080 (org-next-block arg t block-regexp))
23082 (defun org-forward-element ()
23083 "Move forward by one element.
23084 Move to the next element at the same level, when possible."
23085 (interactive)
23086 (cond ((eobp) (user-error "Cannot move further down"))
23087 ((org-with-limited-levels (org-at-heading-p))
23088 (let ((origin (point)))
23089 (goto-char (org-end-of-subtree nil t))
23090 (unless (org-with-limited-levels (org-at-heading-p))
23091 (goto-char origin)
23092 (user-error "Cannot move further down"))))
23093 (t
23094 (let* ((elem (org-element-at-point))
23095 (end (org-element-property :end elem))
23096 (parent (org-element-property :parent elem)))
23097 (if (and parent (= (org-element-property :contents-end parent) end))
23098 (goto-char (org-element-property :end parent))
23099 (goto-char end))))))
23101 (defun org-backward-element ()
23102 "Move backward by one element.
23103 Move to the previous element at the same level, when possible."
23104 (interactive)
23105 (cond ((bobp) (user-error "Cannot move further up"))
23106 ((org-with-limited-levels (org-at-heading-p))
23107 ;; At a headline, move to the previous one, if any, or stay
23108 ;; here.
23109 (let ((origin (point)))
23110 (org-with-limited-levels (org-backward-heading-same-level 1))
23111 ;; When current headline has no sibling above, move to its
23112 ;; parent.
23113 (when (= (point) origin)
23114 (or (org-with-limited-levels (org-up-heading-safe))
23115 (progn (goto-char origin)
23116 (user-error "Cannot move further up"))))))
23117 (t
23118 (let* ((trail (org-element-at-point 'keep-trail))
23119 (elem (car trail))
23120 (prev-elem (nth 1 trail))
23121 (beg (org-element-property :begin elem)))
23122 (cond
23123 ;; Move to beginning of current element if point isn't
23124 ;; there already.
23125 ((/= (point) beg) (goto-char beg))
23126 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23127 ((org-before-first-heading-p) (goto-char (point-min)))
23128 (t (org-back-to-heading)))))))
23130 (defun org-up-element ()
23131 "Move to upper element."
23132 (interactive)
23133 (if (org-with-limited-levels (org-at-heading-p))
23134 (unless (org-up-heading-safe) (error "No surrounding element"))
23135 (let* ((elem (org-element-at-point))
23136 (parent (org-element-property :parent elem)))
23137 (if parent (goto-char (org-element-property :begin parent))
23138 (if (org-with-limited-levels (org-before-first-heading-p))
23139 (error "No surrounding element")
23140 (org-with-limited-levels (org-back-to-heading)))))))
23142 (defvar org-element-greater-elements)
23143 (defun org-down-element ()
23144 "Move to inner element."
23145 (interactive)
23146 (let ((element (org-element-at-point)))
23147 (cond
23148 ((memq (org-element-type element) '(plain-list table))
23149 (goto-char (org-element-property :contents-begin element))
23150 (forward-char))
23151 ((memq (org-element-type element) org-element-greater-elements)
23152 ;; If contents are hidden, first disclose them.
23153 (when (org-element-property :hiddenp element) (org-cycle))
23154 (goto-char (or (org-element-property :contents-begin element)
23155 (error "No content for this element"))))
23156 (t (error "No inner element")))))
23158 (defun org-drag-element-backward ()
23159 "Move backward element at point."
23160 (interactive)
23161 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23162 (let* ((trail (org-element-at-point 'keep-trail))
23163 (elem (car trail))
23164 (prev-elem (nth 1 trail)))
23165 ;; Error out if no previous element or previous element is
23166 ;; a parent of the current one.
23167 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23168 (error "Cannot drag element backward")
23169 (let ((pos (point)))
23170 (org-element-swap-A-B prev-elem elem)
23171 (goto-char (+ (org-element-property :begin prev-elem)
23172 (- pos (org-element-property :begin elem)))))))))
23174 (defun org-drag-element-forward ()
23175 "Move forward element at point."
23176 (interactive)
23177 (let* ((pos (point))
23178 (elem (org-element-at-point)))
23179 (when (= (point-max) (org-element-property :end elem))
23180 (error "Cannot drag element forward"))
23181 (goto-char (org-element-property :end elem))
23182 (let ((next-elem (org-element-at-point)))
23183 (when (or (org-element-nested-p elem next-elem)
23184 (and (eq (org-element-type next-elem) 'headline)
23185 (not (eq (org-element-type elem) 'headline))))
23186 (goto-char pos)
23187 (error "Cannot drag element forward"))
23188 ;; Compute new position of point: it's shifted by NEXT-ELEM
23189 ;; body's length (without final blanks) and by the length of
23190 ;; blanks between ELEM and NEXT-ELEM.
23191 (let ((size-next (- (save-excursion
23192 (goto-char (org-element-property :end next-elem))
23194 (forward-line)
23195 ;; Small correction if buffer doesn't end
23196 ;; with a newline character.
23197 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23198 (org-element-property :begin next-elem)))
23199 (size-blank (- (org-element-property :end elem)
23200 (save-excursion
23201 (goto-char (org-element-property :end elem))
23203 (forward-line)
23204 (point)))))
23205 (org-element-swap-A-B elem next-elem)
23206 (goto-char (+ pos size-next size-blank))))))
23208 (defun org-drag-line-forward (arg)
23209 "Drag the line at point ARG lines forward."
23210 (interactive "p")
23211 (dotimes (n (abs arg))
23212 (let ((c (current-column)))
23213 (if (< 0 arg)
23214 (progn
23215 (beginning-of-line 2)
23216 (transpose-lines 1)
23217 (beginning-of-line 0))
23218 (transpose-lines 1)
23219 (beginning-of-line -1))
23220 (org-move-to-column c))))
23222 (defun org-drag-line-backward (arg)
23223 "Drag the line at point ARG lines backward."
23224 (interactive "p")
23225 (org-drag-line-forward (- arg)))
23227 (defun org-mark-element ()
23228 "Put point at beginning of this element, mark at end.
23230 Interactively, if this command is repeated or (in Transient Mark
23231 mode) if the mark is active, it marks the next element after the
23232 ones already marked."
23233 (interactive)
23234 (let (deactivate-mark)
23235 (if (and (org-called-interactively-p 'any)
23236 (or (and (eq last-command this-command) (mark t))
23237 (and transient-mark-mode mark-active)))
23238 (set-mark
23239 (save-excursion
23240 (goto-char (mark))
23241 (goto-char (org-element-property :end (org-element-at-point)))))
23242 (let ((element (org-element-at-point)))
23243 (end-of-line)
23244 (push-mark (org-element-property :end element) t t)
23245 (goto-char (org-element-property :begin element))))))
23247 (defun org-narrow-to-element ()
23248 "Narrow buffer to current element."
23249 (interactive)
23250 (let ((elem (org-element-at-point)))
23251 (cond
23252 ((eq (car elem) 'headline)
23253 (narrow-to-region
23254 (org-element-property :begin elem)
23255 (org-element-property :end elem)))
23256 ((memq (car elem) org-element-greater-elements)
23257 (narrow-to-region
23258 (org-element-property :contents-begin elem)
23259 (org-element-property :contents-end elem)))
23260 (t
23261 (narrow-to-region
23262 (org-element-property :begin elem)
23263 (org-element-property :end elem))))))
23265 (defun org-transpose-element ()
23266 "Transpose current and previous elements, keeping blank lines between.
23267 Point is moved after both elements."
23268 (interactive)
23269 (org-skip-whitespace)
23270 (let ((end (org-element-property :end (org-element-at-point))))
23271 (org-drag-element-backward)
23272 (goto-char end)))
23274 (defun org-unindent-buffer ()
23275 "Un-indent the visible part of the buffer.
23276 Relative indentation (between items, inside blocks, etc.) isn't
23277 modified."
23278 (interactive)
23279 (unless (eq major-mode 'org-mode)
23280 (error "Cannot un-indent a buffer not in Org mode"))
23281 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23282 unindent-tree ; For byte-compiler.
23283 (unindent-tree
23284 (function
23285 (lambda (contents)
23286 (mapc
23287 (lambda (element)
23288 (if (memq (org-element-type element) '(headline section))
23289 (funcall unindent-tree (org-element-contents element))
23290 (save-excursion
23291 (save-restriction
23292 (narrow-to-region
23293 (org-element-property :begin element)
23294 (org-element-property :end element))
23295 (org-do-remove-indentation)))))
23296 (reverse contents))))))
23297 (funcall unindent-tree (org-element-contents parse-tree))))
23299 (defun org-show-subtree ()
23300 "Show everything after this heading at deeper levels."
23301 (interactive)
23302 (outline-flag-region
23303 (point)
23304 (save-excursion
23305 (org-end-of-subtree t t))
23306 nil))
23308 (defun org-show-entry ()
23309 "Show the body directly following this heading.
23310 Show the heading too, if it is currently invisible."
23311 (interactive)
23312 (save-excursion
23313 (condition-case nil
23314 (progn
23315 (org-back-to-heading t)
23316 (outline-flag-region
23317 (max (point-min) (1- (point)))
23318 (save-excursion
23319 (if (re-search-forward
23321 (match-beginning 1)
23322 (point-max)))
23323 nil)
23324 (org-cycle-hide-drawers 'children))
23325 (error nil))))
23327 (defun org-make-options-regexp (kwds &optional extra)
23328 "Make a regular expression for keyword lines."
23329 (concat
23335 ;; Make isearch reveal the necessary context
23336 (defun org-isearch-end ()
23337 "Reveal context after isearch exits."
23338 (when isearch-success ; only if search was successful
23339 (if (featurep 'xemacs)
23340 ;; Under XEmacs, the hook is run in the correct place,
23341 ;; we directly show the context.
23342 (org-show-context 'isearch)
23343 ;; In Emacs the hook runs *before* restoring the overlays.
23344 ;; So we have to use a one-time post-command-hook to do this.
23345 ;; (Emacs 22 has a special variable, see function `org-mode')
23346 (unless (and (boundp 'isearch-mode-end-hook-quit)
23347 isearch-mode-end-hook-quit)
23348 ;; Only when the isearch was not quitted.
23349 (org-add-hook 'post-command-hook 'org-isearch-post-command
23350 'append 'local)))
23351 (org-fix-ellipsis-at-bol)))
23353 (defun org-isearch-post-command ()
23354 "Remove self from hook, and show context."
23355 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23356 (org-show-context 'isearch))
23359 ;;;; Integration with and fixes for other packages
23361 ;;; Imenu support
23363 (defvar org-imenu-markers nil
23364 "All markers currently used by Imenu.")
23365 (make-variable-buffer-local 'org-imenu-markers)
23367 (defun org-imenu-new-marker (&optional pos)
23368 "Return a new marker for use by Imenu, and remember the marker."
23369 (let ((m (make-marker)))
23370 (move-marker m (or pos (point)))
23371 (push m org-imenu-markers)
23372 m))
23374 (defun org-imenu-get-tree ()
23375 "Produce the index for Imenu."
23376 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23377 (setq org-imenu-markers nil)
23378 (let* ((n org-imenu-depth)
23379 (re (concat "^" (org-get-limited-outline-regexp)))
23380 (subs (make-vector (1+ n) nil))
23381 (last-level 0)
23382 m level head0 head)
23383 (save-excursion
23384 (save-restriction
23385 (widen)
23386 (goto-char (point-max))
23387 (while (re-search-backward re nil t)
23388 (setq level (org-reduced-level (funcall outline-level)))
23389 (when (and (<= level n)
23390 (looking-at org-complex-heading-regexp)
23391 (setq head0 (org-match-string-no-properties 4)))
23392 (setq head (org-link-display-format head0)
23393 m (org-imenu-new-marker))
23394 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23395 (if (>= level last-level)
23396 (push (cons head m) (aref subs level))
23397 (push (cons head (aref subs (1+ level))) (aref subs level))
23398 (loop for i from (1+ level) to n do (aset subs i nil)))
23399 (setq last-level level)))))
23400 (aref subs 1)))
23402 (eval-after-load "imenu"
23403 '(progn
23404 (add-hook 'imenu-after-jump-hook
23405 (lambda ()
23406 (if (derived-mode-p 'org-mode)
23407 (org-show-context 'org-goto))))))
23409 (defun org-link-display-format (link)
23410 "Replace a link with its the description.
23411 If there is no description, use the link target."
23412 (save-match-data
23413 (if (string-match org-bracket-link-analytic-regexp link)
23414 (replace-match (if (match-end 5)
23415 (match-string 5 link)
23416 (concat (match-string 1 link)
23417 (match-string 3 link)))
23418 nil t link)
23419 link)))
23421 (defun org-toggle-link-display ()
23422 "Toggle the literal or descriptive display of links."
23423 (interactive)
23424 (if org-descriptive-links
23425 (progn (org-remove-from-invisibility-spec '(org-link))
23426 (org-restart-font-lock)
23427 (setq org-descriptive-links nil))
23428 (progn (add-to-invisibility-spec '(org-link))
23429 (org-restart-font-lock)
23430 (setq org-descriptive-links t))))
23432 ;; Speedbar support
23434 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23435 "Overlay marking the agenda restriction line in speedbar.")
23436 (overlay-put org-speedbar-restriction-lock-overlay
23437 'face 'org-agenda-restriction-lock)
23438 (overlay-put org-speedbar-restriction-lock-overlay
23439 'help-echo "Agendas are currently limited to this item.")
23440 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23442 (defun org-speedbar-set-agenda-restriction ()
23443 "Restrict future agenda commands to the location at point in speedbar.
23445 (interactive)
23446 (require 'org-agenda)
23447 (let (p m tp np dir txt)
23448 (cond
23449 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23450 'org-imenu t))
23451 (setq m (get-text-property p 'org-imenu-marker))
23452 (with-current-buffer (marker-buffer m)
23453 (goto-char m)
23454 (org-agenda-set-restriction-lock 'subtree)))
23455 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23456 'speedbar-function 'speedbar-find-file))
23457 (setq tp (previous-single-property-change
23458 (1+ p) 'speedbar-function)
23459 np (next-single-property-change
23460 tp 'speedbar-function)
23461 dir (speedbar-line-directory)
23462 txt (buffer-substring-no-properties (or tp (point-min))
23463 (or np (point-max))))
23464 (with-current-buffer (find-file-noselect
23465 (let ((default-directory dir))
23466 (expand-file-name txt)))
23467 (unless (derived-mode-p 'org-mode)
23468 (error "Cannot restrict to non-Org-mode file"))
23469 (org-agenda-set-restriction-lock 'file)))
23470 (t (error "Don't know how to restrict Org-mode's agenda")))
23471 (move-overlay org-speedbar-restriction-lock-overlay
23472 (point-at-bol) (point-at-eol))
23473 (setq current-prefix-arg nil)
23474 (org-agenda-maybe-redo)))
23476 (eval-after-load "speedbar"
23477 '(progn
23478 (speedbar-add-supported-extension ".org")
23479 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23480 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23481 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23482 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23483 (add-hook 'speedbar-visiting-tag-hook
23484 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23486 ;;; Fixes and Hacks for problems with other packages
23488 ;; Make flyspell not check words in links, to not mess up our keymap
23489 (defvar org-element-affiliated-keywords) ; From org-element.el
23490 (defvar org-element-block-name-alist) ; From org-element.el
23491 (defun org-mode-flyspell-verify ()
23492 "Don't let flyspell put overlays at active buttons, or on
23493 {todo,all-time,additional-option-like}-keywords."
23494 (require 'org-element) ; For `org-element-affiliated-keywords'
23495 (let ((pos (max (1- (point)) (point-min)))
23496 (word (thing-at-point 'word)))
23497 (and (not (get-text-property pos 'keymap))
23498 (not (get-text-property pos 'org-no-flyspell))
23499 (not (member word org-todo-keywords-1))
23500 (not (member word org-all-time-keywords))
23501 (not (member word org-options-keywords))
23502 (not (member word (mapcar 'car org-startup-options)))
23503 (not (member-ignore-case word org-element-affiliated-keywords))
23504 (not (member-ignore-case word (org-get-export-keywords)))
23505 (not (member-ignore-case
23506 word (mapcar 'car org-element-block-name-alist)))
23507 (not (member-ignore-case word '("BEGIN" "END" "ATTR"))))))
23509 (defun org-remove-flyspell-overlays-in (beg end)
23510 "Remove flyspell overlays in region."
23511 (and (org-bound-and-true-p flyspell-mode)
23512 (fboundp 'flyspell-delete-region-overlays)
23513 (flyspell-delete-region-overlays beg end))
23514 (add-text-properties beg end '(org-no-flyspell t)))
23516 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23517 (eval-after-load "bookmark"
23518 '(if (boundp 'bookmark-after-jump-hook)
23519 ;; We can use the hook
23520 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23521 ;; Hook not available, use advice
23522 (defadvice bookmark-jump (after org-make-visible activate)
23523 "Make the position visible."
23524 (org-bookmark-jump-unhide))))
23526 ;; Make sure saveplace shows the location if it was hidden
23527 (eval-after-load "saveplace"
23528 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23529 "Make the position visible."
23530 (org-bookmark-jump-unhide)))
23532 ;; Make sure ecb shows the location if it was hidden
23533 (eval-after-load "ecb"
23534 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23535 "Make hierarchy visible when jumping into location from ECB tree buffer."
23536 (if (derived-mode-p 'org-mode)
23537 (org-show-context))))
23539 (defun org-bookmark-jump-unhide ()
23540 "Unhide the current position, to show the bookmark location."
23541 (and (derived-mode-p 'org-mode)
23542 (or (outline-invisible-p)
23543 (save-excursion (goto-char (max (point-min) (1- (point))))
23544 (outline-invisible-p)))
23545 (org-show-context 'bookmark-jump)))
23547 ;; Make session.el ignore our circular variable
23548 (eval-after-load "session"
23549 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23551 ;;;; Finish up
23553 (provide 'org)
23555 (run-hooks 'org-load-hook)
23557 ;;; org.el ends here