| blob | f55c53eee5b2bc143148f4c8b7ae07eaa8ca41a5 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;
26 ;;; Commentary:
27 ;;
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
30 ;;
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
45 ;;
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
49 ;;
50 ;; http://orgmode.org/org.html#Installation
51 ;;
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
59 ;;
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
62 ;;
63 ;;; Code:
70 ;;;; Require other packages
85 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
86 ;; some places -- e.g. see the macro `org-with-limited-levels'.
87 ;;
88 ;; In Org buffers, the value of `outline-regexp' is that of
89 ;; `org-outline-regexp'. The only function still directly relying on
90 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
91 ;; job when `orgstruct-mode' is active.
96 "Regexp to match Org headlines.
97 This is similar to `org-outline-regexp' but additionally makes
101 "Matches a headline, putting stars and text into groups.
104 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
117 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
163 ;; load languages based on value of `org-babel-load-languages'
166 ;;;###autoload
168 "Load the languages defined in `org-babel-load-languages'."
180 org-babel-load-languages))
182 ;;;###autoload
184 "Load Emacs Lisp source code blocks in the Org-mode FILE.
185 This function exports the source code using `org-babel-tangle'
186 and then loads the resulting file using `load-file'. With prefix
187 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
188 file to byte-code before it is loaded."
198 ;; tangle if the org-mode file is newer than the elisp file
207 exported-file)))
210 "Languages which can be evaluated in Org-mode buffers.
211 This list can be used to load support for any of the languages
212 below, note that each language will depend on a different set of
213 system executables and/or Emacs modes. When a language is
215 with `org-babel-execute-src-block' bound by default to C-c
216 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
217 be set to remove code block evaluation from the C-c C-c
218 keybinding. By default only Emacs Lisp (which has no
219 requirements) is loaded."
224 :key-type
268 ;;;; Customization variables
270 "Remove ID property of clones of a subtree.
271 When non-nil, clones of a subtree don't inherit the ID property.
272 Otherwise they inherit the ID property with a new unique
273 identifier."
278 ;;; Version
281 ;;;###autoload
283 "Show the org-mode version in the echo area.
284 With prefix argument HERE, insert it at point.
285 When FULL is non-nil, use a verbose version string.
286 When MESSAGE is non-nil, display a message with the version."
299 org-version
300 git-version
303 org-install-dir
312 _version)))
316 ;;; Compatibility constants
318 ;;; The custom variables
321 "Outline-based notes management and organizer."
327 "Mode hook for Org-mode, run after the mode was turned on."
332 "Hook that is run after org.el has been loaded."
337 "Hook that is run after an Org log buffer is created."
347 "Load all extensions listed in `org-modules'."
352 org-modules)
356 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
361 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
362 "Modules that should always be loaded together with org.el.
364 If a description starts with <C>, the file is not part of Emacs
365 and loading it will require that you have downloaded and properly
366 installed the Org mode distribution.
368 You can also use this system to load external packages (i.e. neither Org
369 core modules, nor modules from the CONTRIB directory). Just add symbols
370 to the end of the list. If the package is called org-xyz.el, then you need
371 to add the symbol `xyz', and the package must have a call to:
373 \(provide 'org-xyz)
375 For export specific modules, see also `org-export-backends'."
380 :type
405 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
414 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
419 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
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."
1791 "Non-nil means use indirect buffer to display infile links.
1792 Activating internal links (from one location in a file to another location
1793 in the same file) normally just jumps to the location. When the link is
1795 is displayed in
1796 another window. When this option is set, the other window actually displays
1797 an indirect buffer clone of the current buffer, to avoid any visibility
1798 changes to the current buffer."
1803 "Non-nil means `org-open-file' will open non-existing files.
1804 When nil, an error will be generated.
1805 This variable applies only to external applications because they
1806 might choke on non-existing files. If the link is to a file that
1807 will be opened in Emacs, the variable is ignored."
1812 "Non-nil means a link to a directory really means to index.org.
1813 When nil, following a directory link will run dired or open a finder/explorer
1814 window on that directory."
1819 "Function and arguments to call for following mailto links.
1820 This is a list with the first element being a Lisp function, and the
1821 remaining elements being arguments to the function. In string arguments,
1822 %a will be replaced by the address, and %s will be replaced by the subject
1823 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1832 "Non-nil means ask for confirmation before executing shell links.
1833 Shell links can be dangerous: just think about a link
1835 [[shell:rm -rf ~/*][Google Search]]
1838 but really it would remove your entire home directory.
1839 Therefore we advise against setting this variable to nil.
1840 Just change it to `y-or-n-p' if you want to confirm with a
1848 'safe-local-variable
1852 "A regexp to skip confirmation for shell links."
1858 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1859 Elisp links can be dangerous: just think about a link
1864 but really it would remove your entire home directory.
1865 Therefore we advise against setting this variable to nil.
1866 Just change it to `y-or-n-p' if you want to confirm with a
1874 'safe-local-variable
1878 "A regexp to skip confirmation for Elisp links."
1887 "Default file applications on a UNIX or GNU/Linux system.
1898 "Default file applications on a MacOS X system.
1900 for some files for which the OS does not have a good default.
1908 'mswindows-shell-execute
1913 'mswindows-shell-execute
1916 "Default file applications on a Windows NT system.
1925 "External applications for opening `file:path' items in a document.
1926 Org-mode uses system defaults for different file types, but
1927 you can use this variable to set the application for a given file
1928 extension. The entries in this list are cons cells where the car identifies
1929 files and the cdr the corresponding command. Possible values for the
1930 file identifier are
1932 ways, depending on its contents:
1934 - Alphanumeric characters only:
1935 Match links with this file extension.
1937 to open PDFs with evince.
1939 - Regular expression: Match links where the
1940 filename matches the regexp. If you want to
1941 use groups here, use shy groups.
1945 to open *.html and *.xhtml with firefox.
1947 - Regular expression which contains (non-shy) groups:
1949 anything after that, matches the regexp.
1950 In a custom command string, %1, %2, etc. are replaced with
1951 the parts of the link that were matched by the groups.
1952 For backwards compatibility, if a command string is given
1953 that does not use any of the group matches, this case is
1954 handled identically to the second one (i.e. match against
1955 file name only).
1956 In a custom lisp form, you can access the group matches with
1957 (match-string n link).
1960 to open [[file:document.pdf::5]] with evince at page 5.
1962 `directory' Matches a directory
1963 `remote' Matches a remote file, accessible through tramp or efs.
1964 Remote files most likely should be visited through Emacs
1965 because external applications cannot handle such paths.
1966 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1967 so all files Emacs knows how to handle. Using this with
1968 command `emacs' will open most files in Emacs. Beware that this
1969 will also open html files inside Emacs, unless you add
1971 t Default for files not matched by any of the other options.
1972 `system' The system command to open files, like `open' on Windows
1973 and Mac OS X, and mailcap under GNU/Linux. This is the command
1974 that will be selected if you call `C-c C-o' with a double
1977 Possible values for the command are:
1978 `emacs' The file will be visited by the current Emacs process.
1979 `default' Use the default application for this file type, which is the
1980 association for t in the list, most likely in the system-specific
1981 part.
1982 This can be used to overrule an unwanted setting in the
1983 system-specific variable.
1985 This command is specified by the entry whose car is `system'.
1986 Most likely, the system-specific version of this variable
1987 does define this command, but you can overrule/replace it
1988 here.
1989 string A command to be executed by a shell; %s will be replaced
1990 by the path to the file.
1991 sexp A Lisp form which will be evaluated. The file path will
1992 be available in the Lisp variable `file'.
1993 For more examples, see the system specific constants
1994 `org-file-apps-defaults-macosx'
1995 `org-file-apps-defaults-windowsnt'
1996 `org-file-apps-defaults-gnu'."
2006 auto-mode))
2015 "The URL of the DOI server."
2021 "Options concerning refiling entries in Org-mode."
2026 "Directory with org files.
2027 This is just a default location to look for Org files. There is no need
2028 at all to put your files into this directory. It is only used in the
2029 following situations:
2031 1. When a capture template specifies a target file that is not an
2032 absolute path. The path will then be interpreted relative to
2033 `org-directory'
2034 2. When a capture note is filed away in an interactive way (when exiting the
2035 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2036 with `org-directory' as the default path."
2043 "Default target for storing notes.
2044 Used as a fall back file for org-remember.el and org-capture.el, for
2045 templates that do not specify a target file."
2051 file))
2054 "The default interface to be used for `org-goto'.
2055 Allowed values are:
2056 outline The interface shows an outline of the relevant file
2057 and the correct heading is found by moving through
2058 the outline or by searching with incremental search.
2059 outline-path-completion Headlines in the current buffer are offered via
2060 completion. This is the interface also used by
2061 the refile command."
2068 "Maximum target level when running `org-goto' with refile interface."
2073 "Non-nil means store new notes at the beginning of a file or entry.
2074 When nil, new notes will be filed to the end of a file or entry.
2075 This can also be a list with cons cells of regular expressions that
2076 are matched against file names, and values."
2087 "Information to record when a task is refiled.
2089 Possible values are:
2091 nil Don't add anything
2092 time Add a time stamp to the task
2093 note Prompt for a note and add it with template `org-log-note-headings'
2095 This option can also be set with on a per-file-basis with
2097 #+STARTUP: nologrefile
2098 #+STARTUP: logrefile
2099 #+STARTUP: lognoterefile
2101 You can have local logging settings for a subtree by setting the LOGGING
2102 property to one or more of these keywords.
2104 When bulk-refiling from the agenda, the value `note' is forbidden and
2105 will temporarily be changed to `time'."
2116 This is a list of cons cells. Each cell contains:
2117 - a specification of the files to be considered, either a list of files,
2118 or a symbol whose function or variable value will be used to retrieve
2119 a file name or a list of file names. If you use `org-agenda-files' for
2120 that, all agenda files will be scanned for targets. Nil means consider
2121 headings in the current buffer.
2122 - A specification of how to find candidate refile targets. This may be
2123 any of:
2125 This tag has to be present in all target headlines, inheritance will
2126 not be considered.
2128 todo keyword.
2130 headlines that are refiling targets.
2131 - a cons cell (:level . N). Any headline of level N is considered a target.
2132 Note that, when `org-odd-levels-only' is set, level corresponds to
2133 order in hierarchy, not to the number of stars.
2134 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2135 Note that, when `org-odd-levels-only' is set, level corresponds to
2136 order in hierarchy, not to the number of stars.
2138 Each element of this list generates a set of possible targets.
2139 The union of these sets is presented (with completion) to
2140 the user by `org-refile'.
2142 You can set the variable `org-refile-target-verify-function' to a function
2143 to verify each headline found by the simple criteria above.
2145 When this variable is nil, all top-level headlines in the current buffer
2146 are used, equivalent to the value `((nil . (:level . 1))'."
2162 "Function to verify if the headline at point should be a refile target.
2163 The function will be called without arguments, with point at the
2164 beginning of the headline. It should return t and leave point
2165 where it is if the headline is a valid target for refiling.
2167 If the target should not be selected, the function must return nil.
2168 In addition to this, it may move point to a place from where the search
2169 should be continued. For example, the function may decide that the entire
2170 subtree of the current entry should be excluded and move point to the end
2171 of the subtree."
2178 "Non-nil means cache refile targets to speed up the process.
2179 The cache for a particular file will be updated automatically when
2180 the buffer has been killed, or when any of the marker used for flagging
2181 refile targets no longer points at a live buffer.
2182 If you have added new entries to a buffer that might themselves be targets,
2183 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2184 find that easier, `C-u C-u C-u C-c C-w'."
2190 "Non-nil means provide refile targets as paths.
2191 So a level 3 headline will be available as level1/level2/level3.
2193 When the value is `file', also include the file name (without directory)
2194 into the path. In this case, you can also stop the completion after
2195 the file name, to get entries inserted as top level in the file.
2197 When `full-file-path', include the full file path."
2206 "Non-nil means complete the outline path in hierarchical steps.
2207 When Org-mode uses the refile interface to select an outline path
2208 \(see variable `org-refile-use-outline-path'), the completion of
2209 the path can be done is a single go, or if can be done in steps down
2210 the headline hierarchy. Going in steps is probably the best if you
2211 do not use a special completion package like `ido' or `icicles'.
2212 However, when using these packages, going in one step can be very
2213 fast, while still showing the whole path to the entry."
2218 "Non-nil means allow to create new nodes as refile targets.
2220 of an existing node. When the value of this variable is `confirm',
2221 new node creation must be confirmed by the user (recommended)
2222 When nil, the completion must match an existing entry.
2224 Note that, if the new heading is not seen by the criteria
2225 listed in `org-refile-targets', multiple instances of the same
2226 heading would be created by trying again to file under the new
2227 heading."
2235 "Non-nil means also refile active region within a subtree.
2237 By default `org-refile' doesn't allow refiling regions if they
2238 don't contain a set of subtrees, but it might be convenient to
2239 do so sometimes: in that case, the first line of the region is
2240 converted to a headline before refiling."
2246 "Options concerning TODO items in Org-mode."
2251 "Options concerning Progress logging in Org-mode."
2258 "The available interpretation symbols for customizing `org-todo-keywords'.
2262 "List of TODO entry keyword sequences and their interpretation.
2265 Each sequence starts with a symbol, either `sequence' or `type',
2266 indicating if the keywords should be interpreted as a sequence of
2267 action steps, or as different types of TODO items. The first
2268 keywords are states requiring action - these states will select a headline
2269 for inclusion into the global TODO list Org-mode produces. If one of
2272 the last keyword is treated as the only DONE state of the sequence.
2275 additional state where no keyword is present. For details about this
2276 cycling, see the manual.
2278 TODO keywords and interpretation can also be set on a per-file basis with
2279 the special #+SEQ_TODO and #+TYP_TODO lines.
2281 Each keyword can optionally specify a character for fast state selection
2282 \(in combination with the variable `org-use-fast-todo-selection')
2283 and specifiers for state change logging, using the same syntax that
2286 indicates to record a time stamp each time this state is selected.
2288 Each keyword may also specify if a timestamp or a note should be
2289 recorded when entering or leaving the state, by adding additional
2290 characters in the parenthesis after the keyword. This looks like this:
2292 record only the time of the state change. With X and Y being either
2294 Y when leaving the state if and only if the *target* state does not
2295 define X. You may omit any of the fast-selection key or X or /Y,
2296 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2298 For backward compatibility, this variable may also be just a list
2299 of keywords. In this case the interpretation (sequence or type) will be
2300 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2310 ;;Quick and dirty way to see
2311 ;;`org-todo-interpretations'. This takes the
2312 ;;place of item arguments
2313 :convert-widget
2320 org-todo-interpretation-widgets))
2321 widget))
2357 "Controls how TODO keywords are interpreted.
2358 This variable is in principle obsolete and is only used for
2359 backward compatibility, if the interpretation of todo keywords is
2360 not given already in `org-todo-keywords'. See that variable for
2361 more information."
2368 "Non-nil means use the fast todo selection scheme with C-c C-t.
2369 This variable describes if and under what circumstances the cycling
2370 mechanism for TODO keywords will be replaced by a single-key, direct
2371 selection scheme.
2373 When nil, fast selection is never used.
2375 When the symbol `prefix', it will be used when `org-todo' is called
2376 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2377 `C-u t' in an agenda buffer.
2379 When t, fast selection is used by default. In this case, the prefix
2380 argument forces cycling instead.
2382 In all cases, the special interface is only used if access keys have
2383 actually been assigned by the user, i.e. if keywords in the configuration
2384 are followed by a letter in parenthesis, like TODO(t)."
2392 "Non-nil means update todo statistics after insert and toggle.
2393 ALL-HEADLINES means update todo statistics by including headlines
2394 with no TODO keyword as well, counting them as not done.
2395 A list of TODO keywords means the same, but skip keywords that are
2396 not in this list.
2398 When this is set, todo statistics is updated in the parent of the
2399 current entry each time a todo state is changed."
2409 "Non-nil means TODO statistics covers just direct children.
2410 When nil, all entries in the subtree are considered.
2411 This has only an effect if `org-provide-todo-statistics' is set.
2412 To set this to nil for only a single subtree, use a COOKIE_DATA
2418 "Hook which is run after the state of a TODO item was changed.
2419 The new state (a string with a TODO keyword, or nil) is available in the
2420 Lisp variable `org-state'."
2425 "Hook for functions that are allowed to block a state change.
2427 Functions in this hook should not modify the buffer.
2428 Each function gets as its single argument a property list,
2429 see `org-trigger-hook' for more information about this list.
2431 If any of the functions in this hook returns nil, the state change
2435 "Hook for functions that are triggered by a state change.
2437 Each function gets as its single argument a property list with at
2438 least the following elements:
2440 (:type type-of-change :position pos-at-entry-start
2441 :from old-state :to new-state)
2443 Depending on the type, more properties may be present.
2445 This mechanism is currently implemented for:
2447 TODO state changes
2448 ------------------
2449 :type todo-state-change
2450 :from previous state (keyword as a string), or nil, or a symbol
2451 'todo' or 'done', to indicate the general type of state.
2455 "Non-nil means undone TODO entries will block switching the parent to DONE.
2456 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2457 be blocked if any prior sibling is not yet done.
2458 Finally, if the parent is blocked because of ordered siblings of its own,
2459 the child will also be blocked."
2471 "Non-nil means unchecked boxes will block switching the parent to DONE.
2472 When this is nil, checkboxes have no influence on switching TODO states.
2473 When non-nil, you first need to check off all check boxes before the TODO
2474 entry can be switched to DONE.
2475 This variable needs to be set before org.el is loaded, and you need to
2476 restart Emacs after a change to make the change effective. The only way
2477 to change is while Emacs is running is through the customize interface."
2489 "Non-nil means inserting a TODO heading is treated as state change.
2491 logging will apply if appropriate. When nil, the new TODO item will
2492 be inserted directly, and no logging will take place."
2497 "Non-nil means switching TODO states with S-cursor counts as state change.
2498 This is the default behavior. However, setting this to nil allows a
2499 convenient way to select a TODO state and bypass any logging associated
2500 with that."
2505 "Tag changes that should be triggered by TODO state changes.
2506 This is a list. Each entry is
2508 (state-change (tag . flag) .......)
2510 State-change can be a string with a state, and empty string to indicate the
2511 state that has no TODO keyword, or it can be one of the symbols `todo'
2512 or `done', meaning any not-done or done state, respectively."
2526 "Information to record when a task moves to the DONE state.
2528 Possible values are:
2530 nil Don't add anything, just change the keyword
2531 time Add a time stamp to the task
2532 note Prompt for a note and add it with template `org-log-note-headings'
2534 This option can also be set with on a per-file-basis with
2536 #+STARTUP: nologdone
2537 #+STARTUP: logdone
2538 #+STARTUP: lognotedone
2540 You can have local logging settings for a subtree by setting the LOGGING
2541 property to one or more of these keywords."
2549 ;; Normalize old uses of org-log-done.
2556 "Information to record when the scheduling date of a tasks is modified.
2558 Possible values are:
2560 nil Don't add anything, just change the date
2561 time Add a time stamp to the task
2562 note Prompt for a note and add it with template `org-log-note-headings'
2564 This option can also be set with on a per-file-basis with
2566 #+STARTUP: nologreschedule
2567 #+STARTUP: logreschedule
2568 #+STARTUP: lognotereschedule"
2577 "Information to record when the deadline date of a tasks is modified.
2579 Possible values are:
2581 nil Don't add anything, just change the date
2582 time Add a time stamp to the task
2583 note Prompt for a note and add it with template `org-log-note-headings'
2585 This option can also be set with on a per-file-basis with
2587 #+STARTUP: nologredeadline
2588 #+STARTUP: logredeadline
2589 #+STARTUP: lognoteredeadline
2591 You can have local logging settings for a subtree by setting the LOGGING
2592 property to one or more of these keywords."
2601 "Non-nil means record a note when clocking out of an item.
2602 This can also be configured on a per-file basis by adding one of
2603 the following lines anywhere in the buffer:
2605 #+STARTUP: lognoteclock-out
2606 #+STARTUP: nolognoteclock-out"
2612 "Non-nil means the CLOSED time stamp will contain date and time.
2613 When nil, only the date will be recorded."
2627 "Headings for notes added to entries.
2628 The value is an alist, with the car being a symbol indicating the note
2629 context, and the cdr is the heading to be used. The heading may also be the
2630 empty string.
2631 %t in the heading will be replaced by a time stamp.
2632 %T will be an active time stamp instead the default inactive one
2633 %d will be replaced by a short-format time stamp.
2634 %D will be replaced by an active short-format time stamp.
2635 %s will be replaced by the new TODO state, in double quotes.
2636 %S will be replaced by the old TODO state, in double quotes.
2637 %u will be replaced by the user name.
2638 %U will be replaced by the full user name.
2640 In fact, it is not a good idea to change the `state' entry, because
2641 agenda log mode depends on the format of these entries."
2647 "Heading when changing todo state (todo sequence only)"
2661 "Non-nil means insert state change notes and time stamps into a drawer.
2662 When nil, state changes notes will be inserted after the headline and
2663 any scheduling and clock lines, but not inside a drawer.
2665 The value of this variable should be the name of the drawer to use.
2666 LOGBOOK is proposed as the default drawer for this purpose, you can
2667 also set this to a string to define the drawer of your choice.
2671 A value of t or nil can also be set with on a per-file-basis with
2673 #+STARTUP: logdrawer
2674 #+STARTUP: nologdrawer
2676 If this variable is set, `org-log-state-notes-insert-after-drawers'
2677 will be ignored.
2679 You can set the property LOG_INTO_DRAWER to overrule this setting for
2680 a subtree."
2691 "Return the value of `org-log-into-drawer', but let properties overrule.
2692 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2693 used instead of the default value."
2702 "Non-nil means insert state change notes after any drawers in entry.
2703 Only the drawers that *immediately* follow the headline and the
2704 deadline/scheduled line are skipped.
2705 When nil, insert notes right after the heading and perhaps the line
2706 with deadline/scheduling if present.
2708 This variable will have no effect if `org-log-into-drawer' is
2709 set."
2715 "Non-nil means the latest state note will be directly after heading.
2716 When nil, the state change notes will be ordered according to time.
2718 This option can also be set with on a per-file-basis with
2720 #+STARTUP: logstatesreversed
2721 #+STARTUP: nologstatesreversed"
2727 "The TODO state to which a repeater should return the repeating task.
2728 By default this is the first task in a TODO sequence, or the previous state
2729 in a TODO_TYP set. But you can specify another task here.
2730 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2737 "Non-nil means record moving through the DONE state when triggering repeat.
2738 An auto-repeating task is immediately switched back to TODO when
2741 record a closing note, there will be no record of the task moving
2742 through DONE. This variable forces taking a note anyway.
2744 nil Don't force a record
2745 time Record a time stamp
2746 note Prompt for a note and add it with template `org-log-note-headings'
2748 This option can also be set with on a per-file-basis with
2750 #+STARTUP: nologrepeat
2751 #+STARTUP: logrepeat
2752 #+STARTUP: lognoterepeat
2754 You can have local logging settings for a subtree by setting the LOGGING
2755 property to one or more of these keywords."
2765 "Priorities in Org-mode."
2770 "Non-nil means priority commands are active.
2771 When nil, these commands will be disabled, so that you never accidentally
2772 set a priority."
2777 "The highest priority of TODO items. A character like ?A, ?B etc.
2778 Must have a smaller ASCII number than `org-lowest-priority'."
2783 "The lowest priority of TODO items. A character like ?A, ?B etc.
2784 Must have a larger ASCII number than `org-highest-priority'."
2789 "The default priority of TODO items.
2790 This is the priority an item gets if no explicit priority is given.
2791 When starting to cycle on an empty priority the first step in the cycle
2792 depends on `org-priority-start-cycle-with-default'. The resulting first
2793 step priority must not exceed the range from `org-highest-priority' to
2794 `org-lowest-priority' which means that `org-default-priority' has to be
2795 in this range exclusive or inclusive the range boundaries. Else the
2796 first step refuses to set the default and the second will fall back
2797 to (depending on the command used) the highest or lowest priority."
2802 "Non-nil means start with default priority when starting to cycle.
2803 When this is nil, the first step in the cycle will be (depending on the
2804 command used) one higher or lower than the default priority.
2805 See also `org-default-priority'."
2810 "Function to extract the priority from a string.
2811 The string is normally the headline. If this is nil Org computes the
2812 priority from the priority cookie like [#A] in the headline. It returns
2813 an integer, increasing by 1000 for each priority level.
2814 The user can set a different function here, which should take a string
2815 as an argument and return the numeric priority."
2823 "Options concerning time stamps and deadlines in Org-mode."
2828 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2829 When nil, these labeled time stamps are forces into the second line of an
2830 entry, just after the headline. When scheduling from the global TODO list,
2831 the time stamp will always be forced into the second line."
2836 "Formats for `format-time-string' which are used for time stamps.
2840 "Number of minutes to round time stamps to.
2841 These are two values, the first applies when first creating a time stamp.
2842 The second applies when changing it with the commands `S-up' and `S-down'.
2843 When changing the time stamp, this means that it will change in steps
2844 of N minutes, as given by the second value.
2846 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2847 numbers should be factors of 60, so for example 5, 10, 15.
2849 When this is larger than 1, you can still force an exact time stamp by using
2850 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2851 and by using a prefix arg to `S-up/down' to specify the exact number
2852 of minutes to shift."
2862 ;; Normalize old customizations of this variable.
2866 org-time-stamp-rounding-minutes)))
2869 "Non-nil means overlay custom formats over all time stamps.
2870 The formats are defined through the variable `org-time-stamp-custom-formats'.
2871 To turn this on on a per-file basis, insert anywhere in the file:
2872 #+STARTUP: customtime"
2880 "Custom formats for time stamps. See `format-time-string' for the syntax.
2881 These are overlaid over the default ISO format if the variable
2882 `org-display-custom-times' is set. Time like %H:%M should be at the
2883 end of the second format. The custom formats are also honored by export
2884 commands, if custom time display is turned on at the time of export."
2889 "Get the right format for a time string."
2894 f)))
2898 "The format string used when creating CLOCKSUM lines.
2899 This is also used when Org mode generates a time duration.
2901 The value can be a single format string containing two
2902 %-sequences, which will be filled with the number of hours and
2903 minutes in that order.
2905 Alternatively, the value can be a plist associating any of the
2906 keys :years, :months, :weeks, :days, :hours or :minutes with
2907 format strings. The time duration is formatted using only the
2908 time components that are needed and concatenating the results.
2909 If a time unit in absent, it falls back to the next smallest
2910 unit.
2912 The keys :require-years, :require-months, :require-days,
2913 :require-weeks, :require-hours, :require-minutes are also
2914 meaningful. A non-nil value for these keys indicates that the
2915 corresponding time component should always be included, even if
2916 its value is 0.
2919 For example,
2922 :require-minutes t)
2924 means durations longer than a day will be expressed in days,
2925 hours and minutes, and durations less than a day will always be
2926 expressed in hours and minutes (even for durations less than an
2927 hour).
2929 The value
2933 means durations longer than a day will be expressed in days and
2934 minutes, and durations less than a day will be expressed entirely
2935 in minutes (even for durations longer than an hour)."
2975 See `org-time-clocksum-format' for more on time clock formats."
2983 E.g. by default, one day is considered to be a 8 hours effort,
2984 so a task that has been clocked for 16 hours will be displayed
2985 as during 2 days in the clock display or in the clocktable.
2987 See `org-effort-durations' on how to set effort durations
2988 and `org-time-clocksum-format' for more on time clock formats."
2996 "The format string used when creating CLOCKSUM lines,
2997 or when Org mode generates a time duration, if
2998 `org-time-clocksum-use-fractional' is enabled.
3000 The value can be a single format string containing one
3001 %-sequence, which will be filled with the number of hours as
3002 a float.
3004 Alternatively, the value can be a plist associating any of the
3005 keys :years, :months, :weeks, :days, :hours or :minutes with
3006 a format string. The time duration is formatted using the
3007 largest time unit which gives a non-zero integer part. If all
3008 specified formats have zero integer part, the smallest time unit
3009 is used."
3026 "Number of days before expiration during which a deadline becomes active.
3027 This variable governs the display in sparse trees and in the agenda.
3028 When 0 or negative, it means use this number (the absolute value of it)
3029 even if a deadline has a different individual lead time specified.
3031 Custom commands can set this variable in the options section."
3037 "Number of days before a scheduled item becomes active.
3038 This variable governs the display in sparse trees and in the agenda.
3039 The default value (i.e. 0) means: don't delay scheduled item.
3040 When negative, it means use this number (the absolute value of it)
3041 even if a scheduled item has a different individual delay time
3042 specified.
3044 Custom commands can set this variable in the options section."
3052 "Non-nil means assume future for incomplete date input from user.
3053 This affects the following situations:
3054 1. The user gives a month but not a year.
3057 2. The user gives a day, but no month.
3060 it will be considered as *this* month.
3062 If you set this variable to the symbol `time', then also the following
3063 will work:
3065 3. If the user gives a time.
3066 If the time is before now, it will be interpreted as tomorrow.
3068 Currently none of this works for ISO week specifications.
3070 When this option is nil, the current day, month and year will always be
3071 used as defaults.
3073 See also `org-agenda-jump-prefer-future'."
3081 "Should the agenda jump command prefer the future for incomplete dates?
3082 The default is to do the same as configured in `org-read-date-prefer-future'.
3083 But you can also set a deviating value here.
3084 This may t or nil, or the symbol `org-read-date-prefer-future'."
3090 org-read-date-prefer-future)
3095 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3097 Depending on the system Emacs is running on, certain dates cannot
3098 be represented with the type used internally to represent time.
3099 Dates between 1970-1-1 and 2038-1-1 can always be represented
3100 correctly. Some systems allow for earlier dates, some for later,
3101 some for both. One way to find out it to insert any date into an
3102 Org buffer, putting the cursor on the year and hitting S-up and
3103 S-down to test the range.
3105 When this variable is set to t, the date/time prompt will not let
3106 you specify dates outside the 1970-2037 range, so it is certain that
3107 these dates will work in whatever version of Emacs you are
3108 running, and also that you can move a file from one Emacs implementation
3109 to another. WHenever Org is forcing the year for you, it will display
3110 a message and beep.
3112 When this variable is nil, Org will check if the date is
3113 representable in the specific Emacs implementation you are using.
3114 If not, it will force a year, usually the current year, and beep
3115 to remind you. Currently this setting is not recommended because
3116 the likelihood that you will open your Org files in an Emacs that
3117 has limited date range is not negligible.
3119 A workaround for this problem is to use diary sexp dates for time
3120 stamps outside of this range."
3126 "Non-nil means display current interpretation of date prompt live.
3127 This display will be in an overlay, in the minibuffer."
3132 "Non-nil means pop up a calendar when prompting for a date.
3133 In the calendar, the date can be selected with mouse-1. However, the
3134 minibuffer will also be active, and you can simply enter the date as well.
3135 When nil, only the minibuffer will be available."
3142 'org-read-date-minibuffer-setup-hook
3145 "Hook to be used to set up keys for the date/time interface.
3146 Add key definitions to `minibuffer-local-map', which will be a
3147 temporary copy.
3149 WARNING: This option is obsolete, you should use
3150 `org-read-date-minibuffer-local-map' to set up keys."
3155 "The hour when your day really ends. Must be an integer.
3156 This has influence for the following applications:
3158 the time given here, the day recognized as TODAY is actually yesterday.
3159 - When a date is read from the user and it is still before the time given
3160 here, the current date and time will be assumed to be yesterday, 23:59.
3161 Also, timestamps inserted in capture templates follow this rule.
3163 IMPORTANT: This is a feature whose implementation is and likely will
3164 remain incomplete. Really, it is only here because past midnight seems to
3165 be the favorite working time of John Wiegley :-)"
3170 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3171 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3173 23:59 of the previous day."
3179 "When non-nil, use the last clock out time for `org-todo'.
3180 Note that this option has precedence over the combined use of
3181 `org-use-effective-time' and `org-extend-today-until'."
3188 "Non-nil means S-down will increase the time in a time stamp.
3189 When nil, S-up will increase."
3194 "Non-nil means make the calendar window follow timestamp changes.
3195 When a timestamp is modified and the calendar window is visible, it will be
3196 moved to the new date."
3201 "Options concerning tags in Org-mode."
3206 "List of tags allowed in Org-mode files.
3207 When this list is nil, Org-mode will base TAG input on what is already in the
3208 buffer.
3209 The value of this variable is an alist, the car of each entry must be a
3210 keyword as a string, the cdr may be a character that is used to select
3211 that tag through the fast-tag-selection interface.
3212 See the manual for details."
3229 "List of tags that will always appear in all Org-mode files.
3230 This is in addition to any in buffer settings or customizations
3231 of `org-tag-alist'.
3232 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3233 The value of this variable is an alist, the car of each entry must be a
3234 keyword as a string, the cdr may be a character that is used to select
3235 that tag through the fast-tag-selection interface.
3236 See the manual for details.
3237 To disable these tags on a per-file basis, insert anywhere in the file:
3238 #+STARTUP: noptag"
3250 "If non-nil, always offer completion for all tags of all agenda files.
3251 Instead of customizing this variable directly, you might want to
3252 set it locally for capture buffers, because there no list of
3253 tags in that file can be created dynamically (there are none).
3255 (add-hook 'org-capture-mode-hook
3256 (lambda ()
3257 (set (make-local-variable
3258 'org-complete-tags-always-offer-all-agenda-tags)
3259 t)))"
3265 "List of tags that can be inherited by all entries in the file.
3266 The tags will be inherited if the variable `org-use-tag-inheritance'
3267 says they should be.
3271 "Non-nil means use fast tag selection scheme.
3272 This is a special interface to select and deselect tags with single keys.
3273 When nil, fast selection is never used.
3274 When the symbol `auto', fast selection is used if and only if selection
3275 characters for tags have been configured, either through the variable
3276 `org-tag-alist' or through a #+TAGS line in the buffer.
3277 When t, fast selection is always used and selection keys are assigned
3278 automatically if necessary."
3286 "Non-nil means fast tag selection exits after first change.
3287 When nil, you have to press RET to exit it.
3288 During fast tag selection, you can toggle this flag with `C-c'.
3289 This variable can also have the value `expert'. In this case, the window
3290 displaying the tags menu is not even shown, until you press C-c again."
3298 "Non-nil means fast tags selection interface will also offer TODO states.
3302 "The column to which tags should be indented in a headline.
3303 If this number is positive, it specifies the column. If it is negative,
3304 it means that the tags should be flushright to that column. For example,
3305 -80 works well for a normal 80 character screen.
3306 When 0, place tags directly after headline text, with only one space in
3307 between."
3312 "Non-nil keeps tags aligned when modifying headlines.
3313 Some operations (i.e. demoting) change the length of a headline and
3314 therefore shift the tags around. With this option turned on, after
3315 each such operation the tags are again aligned to `org-tags-column'."
3320 "Non-nil means tags in levels apply also for sublevels.
3321 When nil, only the tags directly given in a specific line apply there.
3322 This may also be a list of tags that should be inherited, or a regexp that
3323 matches tags that should be inherited. Additional control is possible
3324 with the variable `org-tags-exclude-from-inheritance' which gives an
3325 explicit list of tags to be excluded from inheritance, even if the value of
3326 `org-use-tag-inheritance' would select it for inheritance.
3328 If this option is t, a match early-on in a tree can lead to a large
3329 number of matches in the subtree when constructing the agenda or creating
3330 a sparse tree. If you only want to see the first match in a tree during
3331 a search, check out the variable `org-tags-match-list-sublevels'."
3340 "List of tags that should never be inherited.
3341 This is a way to exclude a few tags from inheritance. For way to do
3342 the opposite, to actively allow inheritance for selected tags,
3343 see the variable `org-use-tag-inheritance'."
3348 "Check if TAG is one that should be inherited."
3360 "Non-nil means list also sublevels of headlines matching a search.
3361 This variable applies to tags/property searches, and also to stuck
3362 projects because this search is based on a tags match as well.
3364 When set to the symbol `indented', sublevels are indented with
3365 leading dots.
3367 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3368 the sublevels of a headline matching a tag search often also match
3369 the same search. Listing all of them can create very long lists.
3370 Setting this variable to nil causes subtrees of a match to be skipped.
3372 This variable is semi-obsolete and probably should always be true. It
3373 is better to limit inheritance to certain tags using the variables
3374 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3382 "When set, tags are sorted using this function as a comparator."
3398 "Options concerning properties in Org-mode."
3403 "How property key/value pairs should be formatted by `indent-line'.
3404 When `indent-line' hits a property definition, it will format the line
3405 according to this format, mainly to make sure that the values are
3406 lined-up with respect to each other."
3411 "Alist of properties and functions to adjust inserted values.
3412 Elements of this alist must be of the form
3414 ([string] [function])
3416 where [string] must be a property name and [function] must be a
3417 lambda expression: this lambda expression must take one argument,
3418 the value to adjust, and return the new value as a string.
3422 and the clock summary:
3425 (let ((clocksum (org-clock-sum-current-item))
3426 (effort (org-duration-string-to-minutes
3428 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3435 "Non-nil means properties apply also for sublevels.
3437 This setting is chiefly used during property searches. Turning it on can
3438 cause significant overhead when doing a search, which is why it is not
3439 on by default.
3441 When nil, only the properties directly given in the current entry count.
3442 When t, every property is inherited. The value may also be a list of
3443 properties that should have inheritance, or a regular expression matching
3444 properties that should be inherited.
3446 However, note that some special properties use inheritance under special
3447 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3449 for valid values of a property.
3451 Note for programmers:
3452 When querying an entry with `org-entry-get', you can control if inheritance
3453 should be used. By default, `org-entry-get' looks only at the local
3454 properties. You can request inheritance by setting the inherit argument
3455 to t (to force inheritance) or to `selective' (to respect the setting
3456 in this variable)."
3465 "Check if PROPERTY is one that should be inherited."
3476 "The default column format, if no other format has been defined.
3477 This variable can be set on the per-file basis by inserting a line
3479 #+COLUMNS: %25ITEM ....."
3484 "The ellipses to be used when a field in column view is truncated.
3485 When this is the empty string, as many characters as possible are shown,
3486 but then there will be no visual indication that the field has been truncated.
3487 When this is a string of length N, the last N characters of a truncated
3488 field are replaced by this string. If the column is narrower than the
3489 ellipses string, only part of the ellipses string will be shown."
3494 "Function that modifies values for display in column view.
3495 For example, it can be used to cut out a certain part from a time stamp.
3496 The function must take 2 arguments:
3498 column-title The title of the column (*not* the property name)
3499 value The value that should be modified.
3501 The function should return the value that should be displayed,
3502 or nil if the normal value should be used."
3507 "The property that is being used to keep track of effort estimates.
3508 Effort estimates given in this property need to have the format H:MM."
3516 "List of property/value pairs that can be inherited by any entry.
3518 These are fixed values, for the preset properties. The user variable
3519 that can be used to add to this list is `org-global-properties'.
3521 The entries in this list are cons cells where the car is a property
3522 name and cdr is a string with the value. If the value represents
3527 "List of property/value pairs that can be inherited by any entry.
3529 This list will be combined with the constant `org-global-properties-fixed'.
3531 The entries in this list are cons cells where the car is a property
3532 name and cdr is a string with the value.
3534 You can set buffer-local values for the same purpose in the variable
3535 `org-file-properties' this by adding lines like
3537 #+PROPERTY: NAME VALUE"
3544 "List of property/value pairs that can be inherited by any entry.
3545 Valid for the current buffer.
3550 "Options concerning agenda views in Org-mode."
3555 "Variable used by org files to set a category for agenda display.
3556 Such files should use a file variable to set it, for example
3560 or contain a special line
3562 #+CATEGORY: ELisp
3564 If the file does not specify a category, then file's base name
3570 "The files to be used for agenda display.
3574 If an entry is a directory, all files in that directory that are matched by
3575 `org-agenda-file-regexp' will be part of the file list.
3577 If the value of the variable is not a list but a single file name, then
3578 the list of agenda files is actually stored and maintained in that file, one
3579 agenda file per line. In this file paths can be given relative to
3580 `org-directory'. Tilde expansion and environment variable substitution
3581 are also made."
3588 "Regular expression to match files for `org-agenda-files'.
3589 If any element in the list in that variable contains a directory instead
3590 of a normal file, all files in that directory that are matched by this
3591 regular expression will be included."
3596 "List of extra files to be searched by text search commands.
3597 These files will be searched in addition to the agenda files by the
3598 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3599 Note that these files will only be searched for text search commands,
3600 not for the other agenda views like todo lists, tag searches or the weekly
3601 agenda. This variable is intended to list notes and possibly archive files
3602 that should also be searched by these two commands.
3603 In fact, if the first element in the list is the symbol `agenda-archives',
3604 then all archive files of all agenda files will be added to the search
3605 scope."
3615 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3616 A nil value means to remove them, after a query, from the list."
3621 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3622 The command `org-calendar-goto-agenda' will be bound to this key. The
3623 default is the character `c' because then `c' can be used to switch back and
3624 forth between agenda and calendar."
3629 "The key to be installed in `calendar-mode-map' for adding diary entries.
3630 This option is irrelevant until `org-agenda-diary-file' has been configured
3631 to point to an Org-mode file. When that is the case, the command
3632 `org-agenda-diary-entry' will be bound to the key given here, by default
3633 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3634 if you want to continue doing this, you need to change this to a different
3635 key."
3640 "File to which to add new entries with the `i' key in agenda and calendar.
3641 When this is the symbol `diary-file', the functionality in the Emacs
3642 calendar will be used to add entries to the `diary-file'. But when this
3643 points to a file, `org-agenda-diary-entry' will be used instead."
3657 org-calendar-insert-diary-entry-key
3661 "Options for embedding LaTeX code into Org-mode."
3669 "Options for creating images from LaTeX fragments.
3670 This is a property list with the following properties:
3672 `default' means use the foreground of the default face.
3673 `auto' means use the foreground from the text face.
3675 `default' means use the background of the default face.
3676 `auto' means use the background from the text face.
3677 :scale a scaling factor for the size of the images, to get more pixels
3678 :html-foreground, :html-background, :html-scale
3679 the same numbers for HTML export.
3680 :matchers a list indicating which matchers should be used to
3681 find LaTeX fragments. Valid members of this list are:
3692 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3693 When nil, just push out a message."
3700 Use this to specify additional executable file say a jar file.
3702 When using MathToWeb as the converter, specify the full-path to
3703 your mathtoweb.jar file."
3711 "Command to convert LaTeX fragments to MathML.
3712 Replace format-specifiers in the command as noted below and use
3713 `shell-command' to convert LaTeX to MathML.
3714 %j: Executable file in fully expanded form as specified by
3715 `org-latex-to-mathml-jar-file'.
3716 %I: Input LaTeX file in fully expanded form
3717 %o: Output MathML file
3718 This command is used by `org-create-math-formula'.
3720 When using MathToWeb as the converter, set this to
3729 "Program to convert LaTeX fragments with.
3731 dvipng Process the LaTeX fragments to dvi file, then convert
3732 dvi files to png files using dvipng.
3733 This will also include processing of non-math environments.
3734 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3735 to convert pdf files to png files"
3743 "Path to store latex preview images.
3744 A relative path here creates many directories relative to the
3745 processed org files paths. An absolute path puts all preview
3746 images at the same place."
3752 "Return t if `org-latex-to-mathml-convert-command' is usable."
3755 org-latex-to-mathml-convert-command)
3757 org-latex-to-mathml-convert-command))))
3762 t))))))
3769 \[PACKAGES]
3770 \[DEFAULT-PACKAGES]
3771 % The settings below are copied from fullpage.sty
3784 "The document header used for processing LaTeX fragments.
3785 It is imperative that this header make sure that no page number
3786 appears on the page. The package defined in the variables
3787 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3789 header, or they will be appended."
3794 "Set the packages alist and make sure it has 3 elements per entry."
3798 x))
3799 val)))
3802 "Get the packages alist and make sure it has 3 elements per entry."
3806 x))
3826 "Alist of default packages to be inserted in the header.
3828 Change this only if one of the packages here causes an
3829 incompatibility with another package you are using.
3831 The packages in this list are needed by one part or another of
3832 Org mode to function properly:
3834 - inputenc, fontenc: for basic font and character selection
3835 - amstext: for subscript and superscript
3836 - textcomp, marvosymb, wasysym, latexsym, amssym: for various
3837 symbols used for interpreting the entities in `org-entities'.
3838 You can skip some of these packages if you don't use any of the
3839 symbols in it.
3840 - ulem: for underline and strike-through
3841 - graphicx: for including images
3842 - float, wrapfig: for figure placement
3843 - longtable: for long tables
3844 - hyperref: for cross references
3846 Therefore you should not modify this variable unless you know
3847 what you are doing. The one reason to change it anyway is that
3848 you might be loading some other package that conflicts with one
3849 of the default packages. Each cell is of the format
3851 the package also needs to be included when compiling LaTeX
3852 snippets into images for inclusion into non-LaTeX output."
3867 "Alist of packages to be inserted in every LaTeX header.
3869 These will be inserted after `org-latex-default-packages-alist'.
3870 Each cell is of the format:
3874 SNIPPET-FLAG, when t, indicates that this package is also needed
3875 when turning LaTeX snippets into images for inclusion into
3876 non-LaTeX output.
3878 Make sure that you only list packages here which:
3880 - you want in every file
3881 - do not conflict with the setup in `org-format-latex-header'.
3882 - do not conflict with the default packages in
3883 `org-latex-default-packages-alist'."
3897 "Settings for Org-mode appearance."
3902 "Non-nil means fontify only the stars in each headline.
3903 When nil, the entire headline is fontified.
3904 Changing it requires restart of `font-lock-mode' to become effective
3905 also in regions already fontified."
3910 "Non-nil means hide the first N-1 stars in a headline.
3911 This works by using the face `org-hide' for these stars. This
3912 face is white for a light background, and black for a dark
3913 background. You may have to customize the face `org-hide' to
3914 make this work.
3915 Changing it requires restart of `font-lock-mode' to become effective
3916 also in regions already fontified.
3917 You may also set this on a per-file basis by adding one of the following
3918 lines to the buffer:
3920 #+STARTUP: hidestars
3921 #+STARTUP: showstars"
3926 "List of symbols corresponding to keywords to be hidden the org buffer.
3927 For example, a value '(title) for this list will make the document's title
3928 appear in the buffer without the initial #+TITLE: keyword."
3937 "List of properties (as strings) with a special meaning.
3938 The default use of these custom properties is to let the user
3939 hide them with `org-toggle-custom-properties-visibility'."
3946 "Non-nil means change the face of a headline if it is marked DONE.
3947 Normally, only the TODO/DONE keyword indicates the state of a headline.
3948 When this is non-nil, the headline after the keyword is set to the
3949 `org-headline-done' as an additional indication."
3954 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3955 Changing this variable requires a restart of Emacs to take effect."
3960 "Non-nil means fontify the whole line for headings.
3961 This is useful when setting a background color for the
3962 org-level-* faces."
3967 "Non-nil means highlight LaTeX related syntax in the buffer.
3968 When non nil, the value should be a list containing any of the
3969 following symbols:
3970 `latex' Highlight LaTeX snippets and environments.
3971 `script' Highlight subscript and superscript.
3972 `entities' Highlight entities."
3984 "Non-nil mean font-lock should hide the emphasis marker characters."
3989 "Non-nil means show entities as UTF8 characters.
3996 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4002 "Regular expression for matching emphasis.
4003 After a match, the match groups contain these elements:
4004 0 The match of the full regular expression, including the characters
4005 before and after the proper match
4006 1 The character before the proper match, or empty at beginning of line
4007 2 The proper match, including the leading and trailing markers
4008 3 The leading marker like * or /, indicating the type of highlighting
4009 4 The text between the emphasis markers, not including the markers
4016 "Set variable and compute the emphasis regular expression."
4020 org-emphasis-alist org-emphasis-regexp-components)
4032 ;; make sure special characters appear at the right position in the class
4044 ;; Make the regexp
4052 body1
4064 body1
4070 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4071 ;; set this option proved cumbersome. See this message/thread:
4072 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4075 "Components used to build the regular expression for emphasis.
4076 This is a list with five entries. Terminology: In an emphasis string
4080 specify what is allowed/forbidden in each part:
4082 pre Chars allowed as prematch. Beginning of line will be allowed too.
4083 post Chars allowed as postmatch. End of line will be allowed too.
4084 border The chars *forbidden* as border characters.
4086 non-shy groups here, and don't allow newline here.
4087 newline The maximum number of newlines allowed in an emphasis exp.
4098 "Alist of characters and faces to emphasize text.
4099 Text starting and ending with a special character will be emphasized,
4100 for example *bold*, _underlined_ and /italic/. This variable sets the
4101 marker characters and the face to be used by font-lock for highlighting
4102 in Org-mode Emacs buffers.
4104 You need to reload Org or to restart Emacs after customizing this."
4119 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4122 ;;; Miscellaneous options
4125 "Completion in Org-mode."
4130 "Non-nil means use ido completion wherever possible.
4131 Note that `ido-mode' must be active for this variable to be relevant.
4132 If you decide to turn this variable on, you might well want to turn off
4133 `org-outline-path-complete-in-steps'.
4134 See also `org-completion-use-iswitchb'."
4139 "Non-nil means use iswitchb completion wherever possible.
4140 Note that `iswitchb-mode' must be active for this variable to be relevant.
4141 If you decide to turn this variable on, you might well want to turn off
4142 `org-outline-path-complete-in-steps'.
4143 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4149 Normal means, no org-mode-specific context."
4153 ;;; Functions and variables from their packages
4154 ;; Declared here to avoid compiler warnings
4156 ;; XEmacs only
4162 ;; Emacs only
4165 ;; Various packages
4184 org-agenda-format-item "org-agenda"
4211 ;;; Autoload and prepare some org modules
4213 ;; Some table stuff that needs to be defined here, because it is used
4214 ;; by the functions setting up org-mode or checking for table context.
4227 "Detect the first line outside a table when searching from within it.
4230 ;; Autoload the functions in org-table.el that are needed by functions here.
4239 ;;;###autoload
4241 "Unconditionally turn on `orgtbl-mode'."
4246 "Return t if the cursor is inside an org-type table.
4247 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4252 org-table-line-regexp)))
4253 nil))
4257 "Return t if and only if we are at a table.el table."
4264 "If there is a table.el table nearby, recognize it and move into it."
4270 nil
4280 t
4285 t)
4286 nil)
4287 nil))
4290 "Return t if the cursor is inside a hline in a table."
4295 nil))
4298 "Apply FUNCTION to the start of all tables in the buffer."
4308 ;; Exclude tables in src/example/verbatim/clocktable blocks
4316 ;; Declare and autoload functions from org-agenda.el
4328 "Return t when point (or POS) is in #+TBLFM line."
4343 "Return non-nil if clock is currently running.
4344 The return value is actually the clock marker."
4349 org-clock-update-time-maybe
4350 org-clocktable-shift)))
4353 "Check if the current buffer contains the running clock.
4354 If yes, offer to stop it and to save the buffer with the changes."
4363 "Check if this line starts a clock table, if yes, shift the time block."
4367 ;;;###autoload
4369 "Set up hooks for clock persistence."
4374 ;; Define the variable already here, to make sure we have it.
4376 "Non-nil if Org-Indent mode is enabled.
4379 ;; Autoload archiving code
4380 ;; The stuff that is needed for cycling and tags has to be defined here.
4383 "Options concerning archiving in Org-mode."
4388 "The location where subtrees should be archived.
4390 The value of this variable is a string, consisting of two parts,
4391 separated by a double-colon. The first part is a filename and
4392 the second part is a headline.
4394 When the filename is omitted, archiving happens in the same file.
4395 %s in the filename will be replaced by the current file
4396 name (without the directory part). Archiving to a different file
4397 is useful to keep archived entries from contributing to the
4398 Org-mode Agenda.
4400 The archived entries will be filed as subtrees of the specified
4401 headline. When the headline is omitted, the subtrees are simply
4402 filed away at the end of the file, as top-level entries. Also in
4403 the heading you can use %s to represent the file name, this can be
4404 useful when using the same archive for a number of different files.
4406 Here are a few examples:
4408 If the current file is Projects.org, archive in file
4409 Projects.org_archive, as top-level trees. This is the default.
4412 Archive in the current file, under the top-level headline
4416 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4419 Archive in file ~/org/archive.org (absolute path), under headlines
4424 items to the datetree. Items are placed in either the CLOSED
4425 date of the item, or the current date if there is no CLOSED date.
4426 The heading will be a subentry to the current date. There doesn't
4427 need to be a heading, but there always needs to be a slash after
4428 datetree. For example, to store archived items directly in the
4432 Archive in file ./basement (relative path), as level 3 trees
4435 You may set this option on a per-file basis by adding to the buffer a
4436 line like
4438 #+ARCHIVE: basement::** Finished Tasks
4440 You may also define it locally for a subtree by setting an ARCHIVE property
4441 in the entry. If such a property is found in an entry, or anywhere up
4442 the hierarchy, it will be used."
4447 "The tag that marks a subtree as archived.
4448 An archived subtree does not open during visibility cycling, and does
4449 not contribute to the agenda listings.
4450 After changing this, font-lock must be restarted in the relevant buffers to
4451 get the proper fontification."
4457 "Non-nil means the agenda will skip any items located in archived trees.
4458 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4459 variable is no longer recommended, you should leave it at the value t.
4460 Instead, use the key `v' to cycle the archives-mode in the agenda."
4466 "Non-nil means ignore archived trees when creating column view."
4472 "Non-nil means `org-cycle' will open archived trees.
4473 An archived tree is a tree marked with the tag ARCHIVE.
4474 When nil, archived trees will stay folded. You can still open them with
4475 normal outline commands like `show-all', but not with the cycling commands."
4481 "Non-nil means sparse tree construction shows matches in archived trees.
4482 When nil, matches in these trees are highlighted, but the trees are kept in
4483 collapsed state."
4489 "The default date type when building a sparse tree.
4490 When this is nil, a date is a scheduled or a deadline timestamp.
4491 Otherwise, these types are allowed:
4493 all: all timestamps
4494 active: only active timestamps (<...>)
4495 inactive: only inactive timestamps (<...)
4496 scheduled: only scheduled timestamps
4497 deadline: only deadline timestamps"
4509 "Re-hide all archived subtrees after a visibility state change."
4520 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4523 "Cycle subtree even if it is archived."
4530 "Re-hide all archived subtrees after a visibility state change."
4547 flag)))
4555 ;; Autoload Column View Code
4563 org-columns-get-format-and-top-level
4564 org-columns-compute
4565 org-columns-remove-overlays))
4567 ;; Autoload ID code
4575 org-id-copy
4576 org-id-get-with-outline-path-completion
4577 org-id-get-with-outline-drilling))
4579 ;;; Variables for pre-computed regular expressions, all buffer local
4597 "Matches a headline and puts everything into groups:
4598 group 1: the stars
4599 group 2: The todo keyword, maybe
4600 group 3: Priority cookie
4601 group 4: True headline
4605 "Printf format to make regexp to match an exact headline.
4606 This regexp will match the headline of any node which has the
4607 exact headline text that is put into the format, but may have any
4611 "Matches a headline and puts TODO state into group 2 if present.
4663 "Regular expression to match a plain time or time range.
4664 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4665 groups carry important information:
4666 0 the full match
4667 1 the first time, range or not
4675 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4676 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4677 groups carry important information:
4678 0 the full match
4679 7 hours of duration
4688 "Regular expression to match a timestamp time or time range.
4689 After a match, the following groups carry important information:
4690 0 the full match
4691 1 date plus weekday, for back referencing to make sure both times are on the same day
4692 2 the first time, range or not
4753 "Variable associated with STARTUP options for org-mode.
4754 Each element is a list of three items: the startup options (as written
4755 in the #+STARTUP line), the corresponding variable, and the value to set
4756 this variable to if the option is found. An optional forth element PUSH
4760 "Update PROPS with KEY and VAL."
4774 "Printf format for a regexp matching a headline with some keyword.
4775 This regexp will match the headline of any node which has the
4776 exact keyword that is put into the format. The keyword isn't in
4780 "Printf format for a regexp matching a headline, possibly with some keyword.
4781 This regexp can match any headline with the specified keyword, or
4782 without a keyword. The keyword isn't in any group by default,
4786 "When non-nil (the default), use group tags.
4787 This can be turned on/off through `org-toggle-tags-groups'."
4793 "Toggle support for group tags.
4794 Support for group tags is controlled by the option
4795 `org-group-tags', which is non-nil by default."
4799 org-group-tags)
4807 "Precompute regular expressions used for tags in the current buffer."
4813 tags ftags key value)
4830 ftags
4834 ;; Process the file tags.
4838 ;; Process the tags.
4839 ;; FIXME
4849 org-tag-groups-alist)
4872 ;; Return a list with tag variables
4876 "Precompute regular expressions used in the current buffer."
4894 kwds kws0 kwsa key log value cat arch const links hw dws
4895 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4903 ext-setup-or-nil
4910 ;; Append setupfile tags to existing tags
4913 org-tag-alist
4915 org-tag-groups-alist
4933 ;; general TODO-like setup
4942 links)))
4949 props))))
4956 l var val)
4974 ;; Prevent checking in Gnus messages
4986 ;; search for property blocks
4995 props)))))))
5010 ;; Process the TODO keywords
5012 ;; Use the global values as if they had been given locally.
5024 kws)))
5027 kwsa nil
5030 ;; 1 2
5038 kw)
5040 kws0)
5057 ;; Compute the regular expressions and other local variables.
5058 ;; Using `org-outline-regexp-bol' would complicate them much,
5059 ;; because of the fixed white space at the end of that string.
5067 org-drawer-regexp
5071 org-not-done-keywords
5073 org-todo-regexp
5077 org-not-done-regexp
5081 org-not-done-heading-regexp
5083 org-todo-line-regexp
5085 org-complex-heading-regexp
5092 org-complex-heading-regexp-format
5097 ;; Stats cookies can be stuck to body.
5104 org-todo-line-tags-regexp
5111 org-deadline-time-regexp
5113 org-deadline-time-hour-regexp
5116 org-deadline-line-regexp
5118 org-scheduled-regexp
5120 org-scheduled-time-regexp
5122 org-scheduled-time-hour-regexp
5125 org-closed-time-regexp
5127 org-keyword-time-regexp
5133 org-keyword-time-not-clock-regexp
5139 org-maybe-keyword-time-regexp
5145 org-all-time-keywords
5148 org-clock-string org-closed-string)))
5153 "Return the contents of FILE, as a string."
5164 "Extract the log state setting from a TODO keyword string.
5178 "Remove a pair of parenthesis at the end of each string in LIST."
5182 x))
5183 list))
5186 "Assign fast keys to a keyword-key alist.
5187 Respect keys that are already there."
5205 ;;; Some variables used in various places
5212 "Function to be called when `C-c C-c' is used.
5216 ;; FIXME: Occasionally check by commenting these, to make sure
5217 ;; no other functions uses these, forgetting to let-bind them.
5222 ;; Defined somewhere in this file, but used before definition.
5228 ;;;; Define the Org-mode
5230 ;; We use a before-change function to check if a table might need
5231 ;; an update.
5233 "Indicates that a table might need an update.
5234 This variable is set by `org-before-change-function'.
5237 "Every change indicates that a table might need an update."
5252 (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"))
5255 ;; Other stuff we need.
5261 ;; (require 'org-macs) moved higher up in the file before it is first used
5263 ;; (require 'org-compat) moved higher up in the file before it is first used
5271 ;; babel
5274 ;;;###autoload
5276 "Outline-based notes management and organizer, alias
5279 Org-mode develops organizational tasks around a NOTES file which
5280 contains information about projects as plain text. Org-mode is
5281 implemented on top of outline-mode, which is ideal to keep the content
5282 of large files well structured. It supports ToDo items, deadlines and
5283 time stamps, which magically appear in the diary listing of the Emacs
5284 calendar. Tables are easily created with a built-in table editor.
5285 Plain text URL-like links connect to websites, emails (VM), Usenet
5286 messages (Gnus), BBDB entries, and any files related to the project.
5287 For printing and sharing of notes, an Org-mode file (or a part of it)
5288 can be exported as a structured ASCII or HTML file.
5290 The following commands are available:
5294 ;; Get rid of Outline menus, they are not needed
5295 ;; Need to do this here because define-derived-mode sets up
5296 ;; the keymap so late. Still, it is a waste to call this each time
5297 ;; we switch another buffer into org-mode.
5300 ;; Assume this is Greg's port, it uses easymenu
5326 org-display-table 4
5329 org-ellipsis)))
5335 ;; tag faces set outside customize.... force initialization.
5337 ;; Calc embedded
5339 ;; Modify a few syntax entries
5346 ;; Activate before-change-function
5350 ;; Check for running clock before killing a buffer
5352 ;; Initialize macros templates.
5354 ;; Initialize radio targets.
5356 ;; Indentation.
5359 ;; Filling and auto-filling.
5361 ;; Comments.
5363 ;; Beginning/end of defun
5366 ;; Next error for sparse trees
5368 ;; Make sure dependence stuff works reliably, even for users who set it
5369 ;; too late :-(
5381 ;; Align options lines
5383 'align-mode-rules-list
5388 ;; Imenu
5392 ;; Make isearch reveal context
5395 ;; Emacs 21 and XEmacs make use of the hook
5397 ;; Emacs 22 deals with this through a special variable
5402 ;; Setup the pcomplete hooks
5415 ;; If empty file that did not turn on org-mode automatically, make it to.
5431 ;; Try to set org-hide correctly
5434 ;; Update `customize-package-emacs-version-alist'
5444 org-emphasis-alist)
5445 st))
5458 "unspecified-bg"
5471 "Current time, possibly rounded to ROUNDING-MINUTES.
5472 When ROUNDING-MINUTES is not an integer, fall back on the car of
5473 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5474 the rounding returns a past time."
5486 res))))
5489 "Return today date, considering `org-extend-today-until'."
5494 ;;;; Font-Lock stuff, including the activators
5525 "Regular expression used to analyze links.
5526 Here is what the match groups contain after a match:
5527 1: http:
5528 2: http
5529 3: path
5530 4: [desc]
5541 "Create a regular expression which will match a balanced sexp.
5542 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5543 as single character strings.
5544 The regexp returned will match the entire expression including the
5545 delimiters. It will also define a single group which contains the
5546 match except for the outermost delimiters. The maximum depth of
5547 stacked delimiters is N. Escaping delimiters is not possible."
5576 "Update the link regular expressions.
5577 This should be called after the variable `org-link-types' has changed."
5581 org-link-re-with-space
5587 org-link-re-with-space2
5593 org-link-re-with-space3
5598 org-angle-link-re
5604 org-plain-link-re
5608 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5609 org-bracket-link-regexp
5611 org-bracket-link-analytic-regexp
5619 org-bracket-link-analytic-regexp++
5627 org-any-link-re
5636 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5639 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5640 "Regular expression matching time strings for analysis.
5641 This one does not require the space after the date, so it can be used
5643 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5660 "Regular expression matching a time stamp or time stamp range.
5666 "Run through the buffer and add overlays to emphasized strings."
5675 'face
5688 rtn))
5691 "Insert or change an emphasis, i.e. a font like bold or italic.
5692 If there is an active region, change that region to a new emphasis.
5693 If there is no region, just insert the marker characters and position
5694 the cursor between them.
5695 CHAR should be the marker character. If it is a space, it means to
5696 remove the emphasis of the selected region.
5697 If CHAR is not given (for example in an interactive call) it will be
5698 prompted for."
5741 "Run through the buffer and add overlays to links."
5750 nil
5757 t)))
5765 t)))
5768 "When non-nil, fontify code in code blocks."
5775 "When non-nil, allow promoting a top level subtree.
5776 The leading star of the top level headline will be replaced
5777 by a #."
5788 "Fontify #+ lines and blocks."
5791 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5792 limit t)
5800 end end1 quoting block-type ovl)
5803 ;; a single line of backend-specific content
5811 ; for backend-specific code
5812 t)
5814 ;; Truly a block
5827 beg end
5835 ;; remove old background overlays
5840 ;; add a background overlay
5855 t))
5875 t)
5881 ;; just any other in-buffer setting, but not indented
5885 t)
5889 "Run through the buffer and add overlays to links."
5898 t)))
5901 "Run through the buffer and add overlays to footnotes."
5908 'keymap org-mouse-map
5909 'help-echo
5911 "Footnote definition"
5913 'font-lock-fontified t
5914 'font-lock-multiline t
5918 "Run through the buffer and add overlays to bracketed links."
5931 ;; We need to remove the invisible property here. Table narrowing
5932 ;; may have made some of this invisible.
5950 t)))
5953 "Run through the buffer and add overlays to dates."
5966 t)))
5975 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5979 "Run through the buffer and add overlays to target matches."
5987 'keymap org-mouse-map
5991 t)))))
5994 "Find all radio targets in this file and update the regular expression."
6009 t)))
6017 "Compute regular expression for LaTeX, entities and sub/superscript.
6018 Result depends on variable `org-highlight-latex-and-related'."
6020 'org-latex-and-related-regexp
6032 org-latex-regexps)))))
6039 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6040 LIMIT bounds the search for syntax to highlight. Stop at first
6041 highlighted object, if any. Return t if some highlighting was
6042 done, nil otherwise."
6051 1
6059 nil)))
6062 "Restart `font-lock-mode', to force refontification."
6068 "Return a list of all targets in this file.
6069 When optional argument RADIO is non-nil, only find radio
6070 targets."
6075 ;; Make sure point is really within the object.
6080 rtn)))
6083 "Make regular expression matching all strings in TARGETS.
6084 The regular expression finds the targets also if there is a line break
6085 between words."
6094 x)
6095 targets
6107 t)))
6110 "Compute the outline level of the heading at point.
6111 If this is called at a normal headline, the level is the number of stars.
6112 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6117 0
6124 "Return a regexp matching a PROPERTY line.
6125 Match group 3 will be set to the value if it exists."
6132 "Regular expression matching a property line.
6133 There are four matching groups:
6134 1: :PROPKEY: including the leading and trailing colon,
6135 2: PROPKEY without the leading and trailing colon,
6136 3: PROPVAL without leading or trailing spaces,
6137 4: the indentation of the current line,
6144 "Functions that can manipulate `org-font-lock-extra-keywords'.
6145 This is called after `org-font-lock-extra-keywords' is defined, but before
6146 it is installed to be used by font lock. This can be useful if something
6150 "Run `org-font-lock-hook' within LIMIT."
6154 "Set font lock defaults for the current buffer."
6159 ;; Call the hook
6161 ;; Headlines
6168 ;; Table lines
6171 ;; Table internals
6176 ;; Drawers
6179 ;; Properties
6183 ;; Links
6191 ;; Targets.
6193 ;; Diary sexps.
6195 ;; Macro
6198 ;; TODO keyword
6200 org-todo-regexp)
6202 ;; DONE
6210 nil)
6211 ;; Priorities
6213 ;; Tags
6215 ;; Tags groups
6221 ;; Special keywords
6226 ;; Emphasis
6231 ;; Checkboxes
6232 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6237 ;; Description list items
6240 ;; ARCHIVEd headings
6242 org-outline-regexp-bol
6245 ;; Specials
6249 ;; Code
6251 ;; COMMENT
6257 ;; Blocks and meta lines
6261 ;; Now set the full font-lock-keywords
6268 "Toggle the composition display of entities as UTF8 characters."
6284 "Display or hide properties in `org-custom-properties'."
6301 org-custom-properties)))))))
6304 "Find an entity to fontify."
6310 limit t)
6325 nil))))
6328 "Fontify string S like in Org-mode."
6340 "Get the right face for match N in font-lock matching of headlines."
6353 "Get the right face for a TODO keyword KWD.
6354 If KWD is a number, get the corresponding match group."
6362 "Create a face list that inherits INHERIT, but sets the foreground color.
6363 When FACE-OR-COLOR is not a string, just return it."
6367 face-or-color)
6368 face-or-color))
6371 "Add the special tag faces."
6380 "Add the special priority faces."
6388 org-priority-faces)))
6393 "Get the right face for a TODO keyword KWD.
6394 If KWD is a number, get the corresponding match group."
6401 "Remove fontification and activation overlays from links."
6406 deactivate-mark buffer-file-name buffer-file-truename)
6410 invisible t intangible t
6411 org-no-flyspell t org-emphasis t))
6421 "Remove specific display properties that have been added by font lock.
6422 The will remove the raise properties that are used to show superscripts
6423 and subscripts."
6433 "Add raise properties to sub/superscripts."
6437 org-match-substring-regexp
6438 org-match-substring-with-braces-regexp)
6439 limit t)
6449 ;; Handle a_b^c
6452 t
6454 'display
6470 t)))))
6472 ;;;; Visibility cycling, including org-goto and indirect buffer
6474 ;;; Cycling
6485 ;;;###autoload
6487 "TAB-action and visibility cycling for Org-mode.
6489 This is the command invoked in Org-mode by the TAB key. Its main purpose
6490 is outline visibility cycling, but it also invokes other actions
6491 in special contexts.
6493 - When this function is called with a prefix argument, rotate the entire
6494 buffer through 3 states (global cycling)
6495 1. OVERVIEW: Show only top-level headlines.
6496 2. CONTENTS: Show all headlines of all levels, but no body text.
6497 3. SHOW ALL: Show everything.
6498 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6499 determined by the variable `org-startup-folded', and by any VISIBILITY
6500 properties in the buffer.
6501 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6502 including any drawers.
6504 - When inside a table, re-align the table and move to the next field.
6506 - When point is at the beginning of a headline, rotate the subtree started
6507 by this line through 3 different states (local cycling)
6508 1. FOLDED: Only the main headline is shown.
6509 2. CHILDREN: The main headline and the direct children are shown.
6510 From this state, you can move to one of the children
6511 and zoom in further.
6512 3. SUBTREE: Show the entire subtree, including body text.
6513 If there is no subtree, switch directly from CHILDREN to FOLDED.
6515 - When point is at the beginning of an empty headline and the variable
6516 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6517 of the headline by demoting and promoting it to likely levels. This
6518 speeds up creation document structure by pressing TAB once or several
6519 times right after creating a new headline.
6521 - When there is a numeric prefix, go up to a heading with level ARG, do
6522 a `show-subtree' and return to the previous cursor position. If ARG
6523 is negative, go up that many levels.
6525 - When point is not at the beginning of a headline, execute the global
6526 binding for TAB, which is re-indenting the line. See the option
6527 `org-cycle-emulate-tab' for details.
6529 - Special case: if point is at the beginning of the buffer and there is
6530 no headline in line 1, this function will act as if called with prefix arg
6531 (C-u TAB, same as S-TAB) also when called without prefix arg.
6532 But only if also the variable `org-cycle-global-at-bob' is t."
6543 org-inlinetask-min-level
6548 limit-level)))
6551 outline-regexp
6559 org-cycle-hook))
6563 ;; special case: use global cycling
6577 ;; Table: enter it or move to the next field.
6588 ;; Global cycling: delegate to `org-cycle-internal-global'.
6591 ;; Drawers: delegate to `org-flag-drawer'.
6599 ;; Show-subtree, ARG levels up from here.
6607 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6615 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6622 ;; From there: TAB emulation and template completion.
6644 t
6653 "Do the global cycling action."
6654 ;; Hack to avoid display of messages for .org attachments in Gnus
6660 ;; We just created the overview - now do table of contents
6661 ;; This can be slow in very large buffers, so indicate action
6671 ;; We just showed the table of contents - now show everything
6679 ;; Default action: go to overview
6687 "Do the local cycling action."
6690 ;; First, determine end of headline (EOH), end of subtree or item
6691 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6711 ;; Determine end invisible part of buffer (EOL)
6713 ;; XEmacs doesn't have `next-single-char-property-change'
6723 ;; Find out what to do next and set `this-command'
6726 ;; Nothing is hidden behind this heading
6739 org-cycle-skip-children-state-if-no-children))))
6740 ;; Entire subtree is hidden in one line: children view
6747 ;; FIXME: This slows down the func way too much.
6748 ;; How keep drawers hidden in subtree anyway?
6749 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6750 ;; (org-cycle-hide-drawers 'subtree))
6752 ;; Fold every list in subtree to top-level items.
6775 ;; We just showed the children, or no children are there,
6776 ;; now show everything.
6785 ;; Default action: hide the subtree.
6793 ;;;###autoload
6795 "Cycle the global visibility. For details see `org-cycle'.
6797 With a numeric prefix, show all headlines up to that level."
6813 "Set the visibility required by startup options and properties."
6828 "Switch subtree visibilities according to :VISIBILITY: property."
6835 nil t)
6859 ;; This function uses outline-regexp instead of the more fundamental
6860 ;; org-outline-regexp so that org-cycle-global works outside of Org
6861 ;; buffers, where outline-regexp is needed.
6863 "Switch to overview mode, showing only top-level headlines.
6864 Really, this shows all headlines with level equal or greater than the level
6865 of the first headline in the buffer. This is important, because if the
6866 first headline is not level one, then (hide-sublevels 1) gives confusing
6867 results."
6881 "Show all headlines in the buffer, like a table of contents.
6882 With numerical argument N, show content up to level N."
6885 ;; Visit all headings and show their offspring
6892 t)
6901 "Adjust the window after a change in outline visibility.
6902 This function is the default value of the hook `org-cycle-hook'."
6912 "Remove outline overlays that do not contain non-white stuff."
6922 "Fix visibility issues after moving a subtree."
6923 ;; First, find a reasonable region to look at:
6924 ;; Start two siblings above, end three below
6942 ;; Properly fold already folded siblings
6953 "Show empty lines above all visible headlines.
6954 The region to be covered depends on STATE when called through
6955 `org-cycle-hook'. Lisp program can use t for STATE to get the
6956 entire buffer covered. Note that an empty line is only shown if there
6957 are at least `org-cycle-separator-lines' empty lines before the headline."
6967 beg end b e)
6991 ;; Never hide empty lines at the end of the file.
7001 "Move to the parent and re-show empty lines before visible headlines."
7007 "Return `org-agenda-files' list, plus all open org-mode files.
7008 This is useful for operations that need to scan all of a user's
7009 open and agenda-wise Org files."
7017 files))
7020 "Return the beginning position of the current entry."
7024 "Return the end position of the current entry."
7028 "Re-hide all drawers after a visibility state change."
7043 "Re-hide inline task when switching to 'contents visibility state."
7046 org-inlinetask-min-level)
7050 "When FLAG is non-nil, hide the drawer we are within.
7051 Otherwise make it visible."
7063 "Is the end of the current subtree visible?"
7068 "Move cursor to the first headline and recenter the headline.
7069 Optional argument N means put the headline into the Nth line of the window."
7075 ;;; Saving and restoring visibility
7078 "Return a list of the locations of all outline overlays.
7079 These are overlays with the `invisible' property value `outline'.
7080 The return value is a list of cons cells, with start and stop
7081 positions for each overlay.
7082 If USE-MARKERS is set, return the positions as markers."
7100 "Create visibility overlays for all positions in DATA.
7101 DATA should have been made by `org-outline-overlay-data'."
7109 data)))))
7111 ;;; Folding of blocks
7118 "Call FUNCTION at the head of all source blocks in the current buffer.
7119 Optional arguments START and END can be used to limit the range."
7131 "Toggle the visibility of all blocks in the current buffer."
7135 "Fold all blocks in the current buffer."
7141 "Unfold all blocks in the current buffer."
7147 "Toggle visibility of block at point."
7158 "Toggle the visibility of the current block."
7165 ov)
7181 ;; make the block accessible to isearch
7183 ov 'isearch-open-invisible
7194 ;; org-tab-after-check-for-cycling-hook
7196 ;; Remove overlays when changing major mode
7201 ;;; Org-goto
7207 "Set the keymap `org-goto'."
7211 mouse-drag-region universal-argument org-occur))
7212 cmd)
7228 nil)
7229 (org-defkey map "q" 'org-goto-quit)
7230 (org-defkey map "n" 'outline-next-visible-heading)
7231 (org-defkey map "p" 'outline-previous-visible-heading)
7232 (org-defkey map "f" 'outline-forward-same-level)
7233 (org-defkey map "b" 'outline-backward-same-level)
7234 (org-defkey map "u" 'outline-up-heading))
7235 (org-defkey map "/" 'org-occur)
7236 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7237 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7238 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7239 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7240 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7241 map)))
7243 (defconst org-goto-help
7244 "Browse buffer copy, to find location or copy text.%s
7245 RET=jump to location C-g=quit and return to previous location
7246 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7248 (defvar org-goto-start-pos) ; dynamically scoped parameter
7250 (defun org-goto (&optional alternative-interface)
7251 "Look up a different location in the current file, keeping current visibility.
7253 When you want look-up or go to a different location in a
7254 document, the fastest way is often to fold the entire buffer and
7255 then dive into the tree. This method has the disadvantage, that
7256 the previous location will be folded, which may not be what you
7257 want.
7259 This command works around this by showing a copy of the current
7260 buffer in an indirect buffer, in overview mode. You can dive
7261 into the tree in that copy, use org-occur and incremental search
7262 to find a location. When pressing RET or `Q', the command
7263 returns to the original buffer in which the visibility is still
7264 unchanged. After RET it will also jump to the location selected
7265 in the indirect buffer and expose the headline hierarchy above.
7267 With a prefix argument, use the alternative interface: e.g. if
7268 `org-goto-interface' is 'outline use 'outline-path-completion."
7269 (interactive "P")
7270 (org-goto-map)
7271 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7272 (org-refile-use-outline-path t)
7273 (org-refile-target-verify-function nil)
7274 (interface
7275 (if (not alternative-interface)
7276 org-goto-interface
7277 (if (eq org-goto-interface 'outline)
7278 'outline-path-completion
7279 'outline)))
7280 (org-goto-start-pos (point))
7281 (selected-point
7282 (if (eq interface 'outline)
7283 (car (org-get-location (current-buffer) org-goto-help))
7284 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7285 (org-refile-check-position pa)
7286 (nth 3 pa)))))
7287 (if selected-point
7288 (progn
7289 (org-mark-ring-push org-goto-start-pos)
7290 (goto-char selected-point)
7291 (if (or (outline-invisible-p) (org-invisible-p2))
7292 (org-show-context 'org-goto)))
7293 (message "Quit"))))
7295 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7296 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7297 (defvar org-goto-local-auto-isearch-map) ; defined below
7299 (defun org-get-location (buf help)
7300 "Let the user select a location in the Org-mode buffer BUF.
7301 This function uses a recursive edit. It returns the selected position
7302 or nil."
7303 (org-no-popups
7304 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7305 (isearch-hide-immediately nil)
7306 (isearch-search-fun-function
7307 (lambda () 'org-goto-local-search-headings))
7308 (org-goto-selected-point org-goto-exit-command))
7309 (save-excursion
7310 (save-window-excursion
7311 (delete-other-windows)
7312 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7313 (org-pop-to-buffer-same-window
7314 (condition-case nil
7315 (make-indirect-buffer (current-buffer) "*org-goto*")
7316 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7317 (with-output-to-temp-buffer "*Org Help*"
7318 (princ (format help (if org-goto-auto-isearch
7319 " Just type for auto-isearch."
7320 " n/p/f/b/u to navigate, q to quit."))))
7321 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7322 (setq buffer-read-only nil)
7323 (let ((org-startup-truncated t)
7324 (org-startup-folded nil)
7325 (org-startup-align-all-tables nil))
7326 (org-mode)
7327 (org-overview))
7328 (setq buffer-read-only t)
7329 (if (and (boundp 'org-goto-start-pos)
7330 (integer-or-marker-p org-goto-start-pos))
7331 (let ((org-show-hierarchy-above t)
7332 (org-show-siblings t)
7333 (org-show-following-heading t))
7334 (goto-char org-goto-start-pos)
7335 (and (outline-invisible-p) (org-show-context)))
7336 (goto-char (point-min)))
7337 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7338 (message "Select location and press RET")
7339 (use-local-map org-goto-map)
7340 (recursive-edit)))
7341 (kill-buffer "*org-goto*")
7342 (cons org-goto-selected-point org-goto-exit-command))))
7344 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7345 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7346 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7347 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7349 (defun org-goto-local-search-headings (string bound noerror)
7350 "Search and make sure that any matches are in headlines."
7351 (catch 'return
7352 (while (if isearch-forward
7353 (search-forward string bound noerror)
7354 (search-backward string bound noerror))
7355 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7356 (and (member :headline context)
7357 (not (member :tags context))))
7358 (throw 'return (point))))))
7360 (defun org-goto-local-auto-isearch ()
7361 "Start isearch."
7362 (interactive)
7363 (goto-char (point-min))
7364 (let ((keys (this-command-keys)))
7365 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7366 (isearch-mode t)
7367 (isearch-process-search-char (string-to-char keys)))))
7369 (defun org-goto-ret (&optional arg)
7370 "Finish `org-goto' by going to the new location."
7371 (interactive "P")
7372 (setq org-goto-selected-point (point)
7373 org-goto-exit-command 'return)
7374 (throw 'exit nil))
7376 (defun org-goto-left ()
7377 "Finish `org-goto' by going to the new location."
7378 (interactive)
7379 (if (org-at-heading-p)
7380 (progn
7381 (beginning-of-line 1)
7382 (setq org-goto-selected-point (point)
7383 org-goto-exit-command 'left)
7384 (throw 'exit nil))
7385 (user-error "Not on a heading")))
7387 (defun org-goto-right ()
7388 "Finish `org-goto' by going to the new location."
7389 (interactive)
7390 (if (org-at-heading-p)
7391 (progn
7392 (setq org-goto-selected-point (point)
7393 org-goto-exit-command 'right)
7394 (throw 'exit nil))
7395 (user-error "Not on a heading")))
7397 (defun org-goto-quit ()
7398 "Finish `org-goto' without cursor motion."
7399 (interactive)
7400 (setq org-goto-selected-point nil)
7401 (setq org-goto-exit-command 'quit)
7402 (throw 'exit nil))
7404 ;;; Indirect buffer display of subtrees
7406 (defvar org-indirect-dedicated-frame nil
7407 "This is the frame being used for indirect tree display.")
7408 (defvar org-last-indirect-buffer nil)
7410 (defun org-tree-to-indirect-buffer (&optional arg)
7411 "Create indirect buffer and narrow it to current subtree.
7412 With a numerical prefix ARG, go up to this level and then take that tree.
7413 If ARG is negative, go up that many levels.
7415 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7416 indirect buffer previously made with this command, to avoid proliferation of
7417 indirect buffers. However, when you call the command with a \
7419 when `org-indirect-buffer-display' is `new-frame', the last buffer
7420 is kept so that you can work with several indirect buffers at the same time.
7421 If `org-indirect-buffer-display' is `dedicated-frame', the \
7423 requests that a new frame be made for the new buffer, so that the dedicated
7424 frame is not changed."
7425 (interactive "P")
7426 (let ((cbuf (current-buffer))
7427 (cwin (selected-window))
7428 (pos (point))
7429 beg end level heading ibuf)
7430 (save-excursion
7431 (org-back-to-heading t)
7432 (when (numberp arg)
7433 (setq level (org-outline-level))
7434 (if (< arg 0) (setq arg (+ level arg)))
7435 (while (> (setq level (org-outline-level)) arg)
7436 (org-up-heading-safe)))
7437 (setq beg (point)
7438 heading (org-get-heading))
7439 (org-end-of-subtree t t)
7440 (if (org-at-heading-p) (backward-char 1))
7441 (setq end (point)))
7442 (if (and (buffer-live-p org-last-indirect-buffer)
7443 (not (eq org-indirect-buffer-display 'new-frame))
7444 (not arg))
7445 (kill-buffer org-last-indirect-buffer))
7446 (setq ibuf (org-get-indirect-buffer cbuf)
7447 org-last-indirect-buffer ibuf)
7448 (cond
7449 ((or (eq org-indirect-buffer-display 'new-frame)
7450 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7451 (select-frame (make-frame))
7452 (delete-other-windows)
7453 (org-pop-to-buffer-same-window ibuf)
7454 (org-set-frame-title heading))
7455 ((eq org-indirect-buffer-display 'dedicated-frame)
7456 (raise-frame
7457 (select-frame (or (and org-indirect-dedicated-frame
7458 (frame-live-p org-indirect-dedicated-frame)
7459 org-indirect-dedicated-frame)
7460 (setq org-indirect-dedicated-frame (make-frame)))))
7461 (delete-other-windows)
7462 (org-pop-to-buffer-same-window ibuf)
7463 (org-set-frame-title (concat "Indirect: " heading)))
7464 ((eq org-indirect-buffer-display 'current-window)
7465 (org-pop-to-buffer-same-window ibuf))
7466 ((eq org-indirect-buffer-display 'other-window)
7467 (pop-to-buffer ibuf))
7468 (t (error "Invalid value")))
7469 (if (featurep 'xemacs)
7470 (save-excursion (org-mode) (turn-on-font-lock)))
7471 (narrow-to-region beg end)
7472 (show-all)
7473 (goto-char pos)
7474 (run-hook-with-args 'org-cycle-hook 'all)
7475 (and (window-live-p cwin) (select-window cwin))))
7477 (defun org-get-indirect-buffer (&optional buffer)
7478 (setq buffer (or buffer (current-buffer)))
7479 (let ((n 1) (base (buffer-name buffer)) bname)
7480 (while (buffer-live-p
7481 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7482 (setq n (1+ n)))
7483 (condition-case nil
7484 (make-indirect-buffer buffer bname 'clone)
7485 (error (make-indirect-buffer buffer bname)))))
7487 (defun org-set-frame-title (title)
7488 "Set the title of the current frame to the string TITLE."
7489 ;; FIXME: how to name a single frame in XEmacs???
7490 (unless (featurep 'xemacs)
7491 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7493 ;;;; Structure editing
7495 ;;; Inserting headlines
7497 (defun org-previous-line-empty-p (&optional next)
7498 "Is the previous line a blank line?
7499 When NEXT is non-nil, check the next line instead."
7500 (save-excursion
7501 (and (not (bobp))
7502 (or (beginning-of-line (if next 2 0)) t)
7503 (save-match-data
7506 (defun org-insert-heading (&optional arg invisible-ok)
7507 "Insert a new heading or item with same depth at point.
7508 If point is in a plain list and ARG is nil, create a new list item.
7509 With one universal prefix argument, insert a heading even in lists.
7510 With two universal prefix arguments, insert the heading at the end
7511 of the parent subtree.
7513 If point is at the beginning of a headline, insert a sibling before
7514 the current headline. If point is not at the beginning, split the line
7515 and create a new headline with the text in the current line after point
7516 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7518 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7519 This is important for non-interactive uses of the command."
7520 (interactive "P")
7521 (if (org-called-interactively-p 'any) (org-reveal))
7522 (let ((itemp (org-in-item-p)))
7523 (cond
7524 ((or (= (buffer-size) 0)
7525 (and (not (save-excursion
7526 (and (ignore-errors (org-back-to-heading invisible-ok))
7527 (org-at-heading-p))))
7528 (or arg (not itemp))))
7529 (insert
7531 (if (org-in-src-block-p) ",* " "* "))
7532 (run-hooks 'org-insert-heading-hook))
7533 ((or arg
7534 (and (not itemp) org-insert-heading-respect-content)
7535 (not (org-insert-item
7536 (save-excursion
7537 (and itemp
7538 (goto-char itemp)
7539 (looking-at org-list-full-item-re)
7540 (match-string 3))))))
7541 (let (begn endn)
7542 (when (org-buffer-narrowed-p)
7543 (setq begn (point-min) endn (point-max))
7544 (widen))
7545 (let* ((empty-line-p nil)
7546 (eops (equal arg '(16))) ; insert at end of parent subtree
7547 (org-insert-heading-respect-content
7548 (or (not (null arg)) org-insert-heading-respect-content))
7549 (level nil)
7550 (on-heading (org-at-heading-p))
7551 ;; Get a level to fall back on
7552 (fix-level
7553 (save-excursion
7554 (org-back-to-heading t)
7555 (looking-at org-outline-regexp)
7556 (make-string (1- (length (match-string 0))) ?*)))
7557 (on-empty-line
7559 (head (save-excursion
7560 (condition-case nil
7561 (progn
7562 (org-back-to-heading invisible-ok)
7563 (when (and (not on-heading)
7564 (featurep 'org-inlinetask)
7565 (integerp org-inlinetask-min-level)
7566 (>= (length (match-string 0))
7567 org-inlinetask-min-level))
7568 ;; Find a heading level before the inline task
7569 (while (and (setq level (org-up-heading-safe))
7570 (>= level org-inlinetask-min-level)))
7571 (if (org-at-heading-p)
7572 (org-back-to-heading invisible-ok)
7573 (error "This should not happen")))
7574 (unless (and (save-excursion
7575 (save-match-data
7576 (org-backward-heading-same-level 1 invisible-ok))
7577 (= (point) (match-beginning 0)))
7578 (not (org-previous-line-empty-p t)))
7579 (setq empty-line-p (org-previous-line-empty-p)))
7580 (match-string 0))
7581 (error (or fix-level "* ")))))
7582 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7583 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7584 pos hide-previous previous-pos)
7585 (if ;; At the beginning of a heading, open a new line for insertion
7586 (and (bolp) (org-at-heading-p)
7587 (not eops)
7588 (or (bobp)
7589 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7590 (open-line (if blank 2 1))
7591 (save-excursion
7592 (setq previous-pos (point-at-bol))
7593 (end-of-line)
7594 (setq hide-previous (outline-invisible-p)))
7595 (and org-insert-heading-respect-content
7596 (save-excursion
7597 (while (outline-invisible-p)
7598 (org-show-subtree)
7599 (org-up-heading-safe))))
7600 (let ((split
7601 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7602 (save-excursion
7603 (let ((p (point)))
7604 (goto-char (point-at-bol))
7605 (and (looking-at org-complex-heading-regexp)
7606 (match-beginning 4)
7607 (> p (match-beginning 4)))))))
7608 tags pos)
7609 (cond
7610 ;; Insert a new line, possibly at end of parent subtree
7611 ((and (not arg) (not on-heading) (not on-empty-line)
7612 (not (save-excursion
7613 (beginning-of-line 1)
7614 (or (looking-at org-list-full-item-re)
7615 ;; Don't convert :end: lines to headline
7618 (beginning-of-line 1))
7619 (org-insert-heading-respect-content
7620 (if (not eops)
7621 (progn
7622 (org-end-of-subtree nil t)
7624 (while (and (not (bobp))
7625 ;; Don't delete spaces in empty headlines
7626 (not (looking-back org-outline-regexp))
7628 (backward-delete-char 1)))
7629 (let ((p (point)))
7630 (org-up-heading-safe)
7631 (if (= p (point))
7632 (goto-char (point-max))
7633 (org-end-of-subtree nil t))))
7634 (when (featurep 'org-inlinetask)
7635 (while (and (not (eobp))
7637 (>= (length (match-string 1))
7638 org-inlinetask-min-level))
7639 (org-end-of-subtree nil t)))
7640 (or (bolp) (newline))
7641 (or (org-previous-line-empty-p)
7642 (and blank (newline)))
7643 (if (or empty-line-p eops) (open-line 1)))
7644 ;; Insert a headling containing text after point
7645 ((org-at-heading-p)
7646 (when hide-previous
7647 (show-children)
7648 (org-show-entry))
7650 (setq tags (and (match-end 2) (match-string 2)))
7651 (and (match-end 1)
7652 (delete-region (match-beginning 1) (match-end 1)))
7653 (setq pos (point-at-bol))
7654 (or split (end-of-line 1))
7655 (delete-horizontal-space)
7657 (buffer-substring (point-at-bol) (point)))
7658 (insert " "))
7659 (newline (if blank 2 1))
7660 (when tags
7661 (save-excursion
7662 (goto-char pos)
7663 (end-of-line 1)
7664 (insert " " tags)
7665 (org-set-tags nil 'align))))
7666 (t
7667 (or split (end-of-line 1))
7668 (newline (cond ((and blank (not on-empty-line)) 2)
7669 (blank 1)
7670 (on-empty-line 0) (t 1)))))))
7671 (insert head) (just-one-space)
7672 (setq pos (point))
7673 (end-of-line 1)
7674 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7675 (when (and org-insert-heading-respect-content hide-previous)
7676 (save-excursion
7677 (goto-char previous-pos)
7678 (hide-subtree)))
7679 (when (and begn endn)
7680 (narrow-to-region (min (point) begn) (max (point) endn)))
7681 (run-hooks 'org-insert-heading-hook)))))))
7683 (defun org-get-heading (&optional no-tags no-todo)
7684 "Return the heading of the current entry, without the stars.
7685 When NO-TAGS is non-nil, don't include tags.
7686 When NO-TODO is non-nil, don't include TODO keywords."
7687 (save-excursion
7688 (org-back-to-heading t)
7689 (cond
7690 ((and no-tags no-todo)
7691 (looking-at org-complex-heading-regexp)
7692 (match-string 4))
7693 (no-tags
7694 (looking-at (concat org-outline-regexp
7697 (match-string 1))
7698 (no-todo
7699 (looking-at org-todo-line-regexp)
7700 (match-string 3))
7701 (t (looking-at org-heading-regexp)
7702 (match-string 2)))))
7704 (defvar orgstruct-mode) ; defined below
7706 (defun org-heading-components ()
7707 "Return the components of the current heading.
7708 This is a list with the following elements:
7709 - the level as an integer
7710 - the reduced level, different if `org-odd-levels-only' is set.
7711 - the TODO keyword, or nil
7712 - the priority character, like ?A, or nil if no priority is given
7713 - the headline text itself, or the tags string if no headline text
7714 - the tags string, or nil."
7715 (save-excursion
7716 (org-back-to-heading t)
7717 (if (let (case-fold-search)
7718 (looking-at
7719 (if orgstruct-mode
7720 org-heading-regexp
7721 org-complex-heading-regexp)))
7722 (if orgstruct-mode
7723 (list (length (match-string 1))
7724 (org-reduced-level (length (match-string 1)))
7725 nil
7726 nil
7727 (match-string 2)
7728 nil)
7729 (list (length (match-string 1))
7730 (org-reduced-level (length (match-string 1)))
7731 (org-match-string-no-properties 2)
7732 (and (match-end 3) (aref (match-string 3) 2))
7733 (org-match-string-no-properties 4)
7734 (org-match-string-no-properties 5))))))
7736 (defun org-get-entry ()
7737 "Get the entry text, after heading, entire subtree."
7738 (save-excursion
7739 (org-back-to-heading t)
7740 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7742 (defun org-insert-heading-after-current ()
7743 "Insert a new heading with same level as current, after current subtree."
7744 (interactive)
7745 (org-back-to-heading)
7746 (org-insert-heading)
7747 (org-move-subtree-down)
7748 (end-of-line 1))
7750 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7751 "Insert heading with `org-insert-heading-respect-content' set to t."
7752 (interactive "P")
7753 (let ((org-insert-heading-respect-content t))
7754 (org-insert-heading arg invisible-ok)))
7756 (defun org-insert-todo-heading-respect-content (&optional force-state)
7757 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7758 (interactive "P")
7759 (let ((org-insert-heading-respect-content t))
7760 (org-insert-todo-heading force-state t)))
7762 (defun org-insert-todo-heading (arg &optional force-heading)
7763 "Insert a new heading with the same level and TODO state as current heading.
7764 If the heading has no TODO state, or if the state is DONE, use the first
7765 state (TODO by default). Also one prefix arg, force first state. With two
7766 prefix args, force inserting at the end of the parent subtree."
7767 (interactive "P")
7768 (when (or force-heading (not (org-insert-item 'checkbox)))
7769 (org-insert-heading (or (and (equal arg '(16)) '(16))
7770 force-heading))
7771 (save-excursion
7772 (org-back-to-heading)
7773 (outline-previous-heading)
7774 (looking-at org-todo-line-regexp))
7775 (let*
7776 ((new-mark-x
7777 (if (or arg
7778 (not (match-beginning 2))
7779 (member (match-string 2) org-done-keywords))
7780 (car org-todo-keywords-1)
7781 (match-string 2)))
7782 (new-mark
7783 (or
7784 (run-hook-with-args-until-success
7785 'org-todo-get-default-hook new-mark-x nil)
7786 new-mark-x)))
7787 (beginning-of-line 1)
7788 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7789 (if org-treat-insert-todo-heading-as-state-change
7790 (org-todo new-mark)
7791 (insert new-mark " "))))
7792 (when org-provide-todo-statistics
7793 (org-update-parent-todo-statistics))))
7795 (defun org-insert-subheading (arg)
7796 "Insert a new subheading and demote it.
7797 Works for outline headings and for plain lists alike."
7798 (interactive "P")
7799 (org-insert-heading arg)
7800 (cond
7801 ((org-at-heading-p) (org-do-demote))
7802 ((org-at-item-p) (org-indent-item))))
7804 (defun org-insert-todo-subheading (arg)
7805 "Insert a new subheading with TODO keyword or checkbox and demote it.
7806 Works for outline headings and for plain lists alike."
7807 (interactive "P")
7808 (org-insert-todo-heading arg)
7809 (cond
7810 ((org-at-heading-p) (org-do-demote))
7811 ((org-at-item-p) (org-indent-item))))
7813 ;;; Promotion and Demotion
7815 (defvar org-after-demote-entry-hook nil
7816 "Hook run after an entry has been demoted.
7817 The cursor will be at the beginning of the entry.
7818 When a subtree is being demoted, the hook will be called for each node.")
7820 (defvar org-after-promote-entry-hook nil
7821 "Hook run after an entry has been promoted.
7822 The cursor will be at the beginning of the entry.
7823 When a subtree is being promoted, the hook will be called for each node.")
7825 (defun org-promote-subtree ()
7826 "Promote the entire subtree.
7827 See also `org-promote'."
7828 (interactive)
7829 (save-excursion
7830 (org-with-limited-levels (org-map-tree 'org-promote)))
7831 (org-fix-position-after-promote))
7833 (defun org-demote-subtree ()
7834 "Demote the entire subtree. See `org-demote'.
7835 See also `org-promote'."
7836 (interactive)
7837 (save-excursion
7838 (org-with-limited-levels (org-map-tree 'org-demote)))
7839 (org-fix-position-after-promote))
7842 (defun org-do-promote ()
7843 "Promote the current heading higher up the tree.
7844 If the region is active in `transient-mark-mode', promote all headings
7845 in the region."
7846 (interactive)
7847 (save-excursion
7848 (if (org-region-active-p)
7849 (org-map-region 'org-promote (region-beginning) (region-end))
7850 (org-promote)))
7851 (org-fix-position-after-promote))
7853 (defun org-do-demote ()
7854 "Demote the current heading lower down the tree.
7855 If the region is active in `transient-mark-mode', demote all headings
7856 in the region."
7857 (interactive)
7858 (save-excursion
7859 (if (org-region-active-p)
7860 (org-map-region 'org-demote (region-beginning) (region-end))
7861 (org-demote)))
7862 (org-fix-position-after-promote))
7864 (defun org-fix-position-after-promote ()
7865 "Make sure that after pro/demotion cursor position is right."
7866 (let ((pos (point)))
7867 (when (save-excursion
7868 (beginning-of-line 1)
7869 (looking-at org-todo-line-regexp)
7870 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7871 (cond ((eobp) (insert " "))
7872 ((eolp) (insert " "))
7873 ((equal (char-after) ?\ ) (forward-char 1))))))
7875 (defun org-current-level ()
7876 "Return the level of the current entry, or nil if before the first headline.
7877 The level is the number of stars at the beginning of the headline."
7878 (save-excursion
7879 (org-with-limited-levels
7880 (if (ignore-errors (org-back-to-heading t))
7881 (funcall outline-level)))))
7883 (defun org-get-previous-line-level ()
7884 "Return the outline depth of the last headline before the current line.
7885 Returns 0 for the first headline in the buffer, and nil if before the
7886 first headline."
7887 (let ((current-level (org-current-level))
7888 (prev-level (when (> (line-number-at-pos) 1)
7889 (save-excursion
7890 (beginning-of-line 0)
7891 (org-current-level)))))
7892 (cond ((null current-level) nil) ; Before first headline
7893 ((null prev-level) 0) ; At first headline
7894 (prev-level))))
7896 (defun org-reduced-level (l)
7897 "Compute the effective level of a heading.
7898 This takes into account the setting of `org-odd-levels-only'."
7899 (cond
7900 ((zerop l) 0)
7901 (org-odd-levels-only (1+ (floor (/ l 2))))
7902 (t l)))
7904 (defun org-level-increment ()
7905 "Return the number of stars that will be added or removed at a
7906 time to headlines when structure editing, based on the value of
7907 `org-odd-levels-only'."
7908 (if org-odd-levels-only 2 1))
7910 (defun org-get-valid-level (level &optional change)
7911 "Rectify a level change under the influence of `org-odd-levels-only'
7912 LEVEL is a current level, CHANGE is by how much the level should be
7913 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7914 even level numbers will become the next higher odd number."
7915 (if org-odd-levels-only
7916 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7917 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7918 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7919 (max 1 (+ level (or change 0)))))
7921 (if (boundp 'define-obsolete-function-alias)
7922 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7923 (define-obsolete-function-alias 'org-get-legal-level
7924 'org-get-valid-level)
7925 (define-obsolete-function-alias 'org-get-legal-level
7926 'org-get-valid-level "23.1")))
7928 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7929 ;; ̀org-with-limited-levels'
7930 (defun org-promote ()
7931 "Promote the current heading higher up the tree.
7932 If the region is active in `transient-mark-mode', promote all headings
7933 in the region."
7934 (org-back-to-heading t)
7935 (let* ((level (save-match-data (funcall outline-level)))
7936 (after-change-functions (remove 'flyspell-after-change-function
7937 after-change-functions))
7938 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7939 (diff (abs (- level (length up-head) -1))))
7940 (cond ((and (= level 1) org-called-with-limited-levels
7941 org-allow-promoting-top-level-subtree)
7942 (replace-match "# " nil t))
7943 ((= level 1)
7944 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7945 (t (replace-match up-head nil t)))
7946 ;; Fixup tag positioning
7947 (unless (= level 1)
7948 (and org-auto-align-tags (org-set-tags nil t))
7949 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7950 (run-hooks 'org-after-promote-entry-hook)))
7952 (defun org-demote ()
7953 "Demote the current heading lower down the tree.
7954 If the region is active in `transient-mark-mode', demote all headings
7955 in the region."
7956 (org-back-to-heading t)
7957 (let* ((level (save-match-data (funcall outline-level)))
7958 (after-change-functions (remove 'flyspell-after-change-function
7959 after-change-functions))
7960 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7961 (diff (abs (- level (length down-head) -1))))
7962 (replace-match down-head nil t)
7963 ;; Fixup tag positioning
7964 (and org-auto-align-tags (org-set-tags nil t))
7965 (if org-adapt-indentation (org-fixup-indentation diff))
7966 (run-hooks 'org-after-demote-entry-hook)))
7968 (defun org-cycle-level ()
7969 "Cycle the level of an empty headline through possible states.
7970 This goes first to child, then to parent, level, then up the hierarchy.
7971 After top level, it switches back to sibling level."
7972 (interactive)
7973 (let ((org-adapt-indentation nil))
7974 (when (org-point-at-end-of-empty-headline)
7975 (setq this-command 'org-cycle-level) ; Only needed for caching
7976 (let ((cur-level (org-current-level))
7977 (prev-level (org-get-previous-line-level)))
7978 (cond
7979 ;; If first headline in file, promote to top-level.
7980 ((= prev-level 0)
7981 (loop repeat (/ (- cur-level 1) (org-level-increment))
7982 do (org-do-promote)))
7983 ;; If same level as prev, demote one.
7984 ((= prev-level cur-level)
7985 (org-do-demote))
7986 ;; If parent is top-level, promote to top level if not already.
7987 ((= prev-level 1)
7988 (loop repeat (/ (- cur-level 1) (org-level-increment))
7989 do (org-do-promote)))
7990 ;; If top-level, return to prev-level.
7991 ((= cur-level 1)
7992 (loop repeat (/ (- prev-level 1) (org-level-increment))
7993 do (org-do-demote)))
7994 ;; If less than prev-level, promote one.
7995 ((< cur-level prev-level)
7996 (org-do-promote))
7997 ;; If deeper than prev-level, promote until higher than
7998 ;; prev-level.
7999 ((> cur-level prev-level)
8000 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8001 do (org-do-promote))))
8002 t))))
8004 (defun org-map-tree (fun)
8005 "Call FUN for every heading underneath the current one."
8006 (org-back-to-heading)
8007 (let ((level (funcall outline-level)))
8008 (save-excursion
8009 (funcall fun)
8010 (while (and (progn
8011 (outline-next-heading)
8012 (> (funcall outline-level) level))
8013 (not (eobp)))
8014 (funcall fun)))))
8016 (defun org-map-region (fun beg end)
8017 "Call FUN for every heading between BEG and END."
8018 (let ((org-ignore-region t))
8019 (save-excursion
8020 (setq end (copy-marker end))
8021 (goto-char beg)
8022 (if (and (re-search-forward org-outline-regexp-bol nil t)
8023 (< (point) end))
8024 (funcall fun))
8025 (while (and (progn
8026 (outline-next-heading)
8027 (< (point) end))
8028 (not (eobp)))
8029 (funcall fun)))))
8031 (defvar org-property-end-re) ; silence byte-compiler
8032 (defun org-fixup-indentation (diff)
8033 "Change the indentation in the current entry by DIFF.
8034 However, if any line in the current entry has no indentation, or if it
8035 would end up with no indentation after the change, nothing at all is done."
8036 (save-excursion
8037 (let ((end (save-excursion (outline-next-heading)
8038 (point-marker)))
8039 (prohibit (if (> diff 0)
8042 col)
8043 (unless (save-excursion (end-of-line 1)
8044 (re-search-forward prohibit end t))
8045 (while (and (< (point) end)
8047 (goto-char (match-end 0))
8048 (setq col (current-column))
8049 (if (< diff 0) (replace-match ""))
8050 (org-indent-to-column (+ diff col))))
8051 (move-marker end nil))))
8053 (defun org-convert-to-odd-levels ()
8054 "Convert an org-mode file with all levels allowed to one with odd levels.
8055 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8056 level 5 etc."
8057 (interactive)
8058 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8059 (let ((outline-level 'org-outline-level)
8060 (org-odd-levels-only nil) n)
8061 (save-excursion
8062 (goto-char (point-min))
8064 (setq n (- (length (match-string 0)) 2))
8065 (while (>= (setq n (1- n)) 0)
8066 (org-demote))
8067 (end-of-line 1))))))
8069 (defun org-convert-to-oddeven-levels ()
8070 "Convert an org-mode file with only odd levels to one with odd/even levels.
8071 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8072 file contains a section with an even level, conversion would
8073 destroy the structure of the file. An error is signaled in this
8074 case."
8075 (interactive)
8076 (goto-char (point-min))
8077 ;; First check if there are no even levels
8079 (org-show-context t)
8080 (error "Not all levels are odd in this file. Conversion not possible"))
8081 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8082 (let ((outline-regexp org-outline-regexp)
8083 (outline-level 'org-outline-level)
8084 (org-odd-levels-only nil) n)
8085 (save-excursion
8086 (goto-char (point-min))
8088 (setq n (/ (1- (length (match-string 0))) 2))
8089 (while (>= (setq n (1- n)) 0)
8090 (org-promote))
8091 (end-of-line 1))))))
8093 (defun org-tr-level (n)
8094 "Make N odd if required."
8095 (if org-odd-levels-only (1+ (/ n 2)) n))
8097 ;;; Vertical tree motion, cutting and pasting of subtrees
8099 (defun org-move-subtree-up (&optional arg)
8100 "Move the current subtree up past ARG headlines of the same level."
8101 (interactive "p")
8102 (org-move-subtree-down (- (prefix-numeric-value arg))))
8104 (defun org-move-subtree-down (&optional arg)
8105 "Move the current subtree down past ARG headlines of the same level."
8106 (interactive "p")
8107 (setq arg (prefix-numeric-value arg))
8108 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8109 'org-get-last-sibling))
8110 (ins-point (make-marker))
8111 (cnt (abs arg))
8112 (col (current-column))
8113 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8114 ;; Select the tree
8115 (org-back-to-heading)
8116 (setq beg0 (point))
8117 (save-excursion
8118 (setq ne-beg (org-back-over-empty-lines))
8119 (setq beg (point)))
8120 (save-match-data
8121 (save-excursion (outline-end-of-heading)
8122 (setq folded (outline-invisible-p)))
8123 (outline-end-of-subtree))
8124 (outline-next-heading)
8125 (setq ne-end (org-back-over-empty-lines))
8126 (setq end (point))
8127 (goto-char beg0)
8128 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8129 ;; include less whitespace
8130 (save-excursion
8131 (goto-char beg)
8132 (forward-line (- ne-beg ne-end))
8133 (setq beg (point))))
8134 ;; Find insertion point, with error handling
8135 (while (> cnt 0)
8136 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8137 (progn (goto-char beg0)
8138 (user-error "Cannot move past superior level or buffer limit")))
8139 (setq cnt (1- cnt)))
8140 (if (> arg 0)
8141 ;; Moving forward - still need to move over subtree
8142 (progn (org-end-of-subtree t t)
8143 (save-excursion
8144 (org-back-over-empty-lines)
8145 (or (bolp) (newline)))))
8146 (setq ne-ins (org-back-over-empty-lines))
8147 (move-marker ins-point (point))
8148 (setq txt (buffer-substring beg end))
8149 (org-save-markers-in-region beg end)
8150 (delete-region beg end)
8151 (org-remove-empty-overlays-at beg)
8152 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8153 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8155 (let ((bbb (point)))
8156 (insert-before-markers txt)
8157 (org-reinstall-markers-in-region bbb)
8158 (move-marker ins-point bbb))
8160 (setq ins-end (point))
8161 (goto-char ins-point)
8162 (org-skip-whitespace)
8163 (when (and (< arg 0)
8164 (org-first-sibling-p)
8165 (> ne-ins ne-beg))
8166 ;; Move whitespace back to beginning
8167 (save-excursion
8168 (goto-char ins-end)
8169 (let ((kill-whole-line t))
8170 (kill-line (- ne-ins ne-beg)) (point)))
8172 (move-marker ins-point nil)
8173 (if folded
8174 (hide-subtree)
8175 (org-show-entry)
8176 (show-children)
8177 (org-cycle-hide-drawers 'children))
8178 (org-clean-visibility-after-subtree-move)
8179 ;; move back to the initial column we were at
8180 (move-to-column col)))
8182 (defvar org-subtree-clip ""
8183 "Clipboard for cut and paste of subtrees.
8184 This is actually only a copy of the kill, because we use the normal kill
8185 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8187 (defvar org-subtree-clip-folded nil
8188 "Was the last copied subtree folded?
8189 This is used to fold the tree back after pasting.")
8191 (defun org-cut-subtree (&optional n)
8192 "Cut the current subtree into the clipboard.
8193 With prefix arg N, cut this many sequential subtrees.
8194 This is a short-hand for marking the subtree and then cutting it."
8195 (interactive "p")
8196 (org-copy-subtree n 'cut))
8198 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8199 "Cut the current subtree into the clipboard.
8200 With prefix arg N, cut this many sequential subtrees.
8201 This is a short-hand for marking the subtree and then copying it.
8202 If CUT is non-nil, actually cut the subtree.
8203 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8204 of some markers in the region, even if CUT is non-nil. This is
8205 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8206 (interactive "p")
8207 (let (beg end folded (beg0 (point)))
8208 (if (org-called-interactively-p 'any)
8209 (org-back-to-heading nil) ; take what looks like a subtree
8210 (org-back-to-heading t)) ; take what is really there
8211 (setq beg (point))
8213 (save-match-data
8214 (if nosubtrees
8215 (outline-next-heading)
8216 (save-excursion (outline-end-of-heading)
8217 (setq folded (outline-invisible-p)))
8218 (condition-case nil
8219 (org-forward-heading-same-level (1- n) t)
8220 (error nil))
8221 (org-end-of-subtree t t)))
8222 (setq end (point))
8223 (goto-char beg0)
8224 (when (> end beg)
8225 (setq org-subtree-clip-folded folded)
8226 (when (or cut force-store-markers)
8227 (org-save-markers-in-region beg end))
8228 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8229 (setq org-subtree-clip (current-kill 0))
8230 (message "%s: Subtree(s) with %d characters"
8231 (if cut "Cut" "Copied")
8232 (length org-subtree-clip)))))
8234 (defun org-paste-subtree (&optional level tree for-yank)
8235 "Paste the clipboard as a subtree, with modification of headline level.
8236 The entire subtree is promoted or demoted in order to match a new headline
8237 level.
8239 If the cursor is at the beginning of a headline, the same level as
8240 that headline is used to paste the tree.
8242 If not, the new level is derived from the *visible* headings
8243 before and after the insertion point, and taken to be the inferior headline
8244 level of the two. So if the previous visible heading is level 3 and the
8245 next is level 4 (or vice versa), level 4 will be used for insertion.
8246 This makes sure that the subtree remains an independent subtree and does
8247 not swallow low level entries.
8249 You can also force a different level, either by using a numeric prefix
8250 argument, or by inserting the heading marker by hand. For example, if the
8253 If optional TREE is given, use this text instead of the kill ring.
8255 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8256 move back over whitespace before inserting, and move point to the end of
8257 the inserted text when done."
8258 (interactive "P")
8259 (setq tree (or tree (and kill-ring (current-kill 0))))
8260 (unless (org-kill-is-subtree-p tree)
8261 (user-error "%s"
8262 (substitute-command-keys
8264 (org-with-limited-levels
8265 (let* ((visp (not (outline-invisible-p)))
8266 (txt tree)
8268 (old-level (if (string-match org-outline-regexp-bol txt)
8269 (- (match-end 0) (match-beginning 0) 1)
8270 -1))
8271 (force-level (cond (level (prefix-numeric-value level))
8273 (string-match
8275 (point-at-bol) (point))))
8276 (- (match-end 1) (match-beginning 1)))
8277 ((and (bolp)
8278 (looking-at org-outline-regexp))
8279 (- (match-end 0) (point) 1))))
8280 (previous-level (save-excursion
8281 (condition-case nil
8282 (progn
8283 (outline-previous-visible-heading 1)
8284 (if (looking-at ^re_)
8285 (- (match-end 0) (match-beginning 0) 1)
8286 1))
8287 (error 1))))
8288 (next-level (save-excursion
8289 (condition-case nil
8290 (progn
8291 (or (looking-at org-outline-regexp)
8292 (outline-next-visible-heading 1))
8293 (if (looking-at ^re_)
8294 (- (match-end 0) (match-beginning 0) 1)
8295 1))
8296 (error 1))))
8297 (new-level (or force-level (max previous-level next-level)))
8298 (shift (if (or (= old-level -1)
8299 (= new-level -1)
8300 (= old-level new-level))
8301 0
8302 (- new-level old-level)))
8303 (delta (if (> shift 0) -1 1))
8304 (func (if (> shift 0) 'org-demote 'org-promote))
8305 (org-odd-levels-only nil)
8306 beg end newend)
8307 ;; Remove the forced level indicator
8308 (if force-level
8309 (delete-region (point-at-bol) (point)))
8310 ;; Paste
8311 (beginning-of-line (if (bolp) 1 2))
8312 (setq beg (point))
8313 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8314 (insert-before-markers txt)
8316 (setq newend (point))
8317 (org-reinstall-markers-in-region beg)
8318 (setq end (point))
8319 (goto-char beg)
8321 (setq beg (point))
8322 (if (and (outline-invisible-p) visp)
8323 (save-excursion (outline-show-heading)))
8324 ;; Shift if necessary
8325 (unless (= shift 0)
8326 (save-restriction
8327 (narrow-to-region beg end)
8328 (while (not (= shift 0))
8329 (org-map-region func (point-min) (point-max))
8330 (setq shift (+ delta shift)))
8331 (goto-char (point-min))
8332 (setq newend (point-max))))
8333 (when (or (org-called-interactively-p 'interactive) for-yank)
8334 (message "Clipboard pasted as level %d subtree" new-level))
8335 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8336 kill-ring
8337 (eq org-subtree-clip (current-kill 0))
8338 org-subtree-clip-folded)
8339 ;; The tree was folded before it was killed/copied
8340 (hide-subtree))
8341 (and for-yank (goto-char newend)))))
8343 (defun org-kill-is-subtree-p (&optional txt)
8344 "Check if the current kill is an outline subtree, or a set of trees.
8345 Returns nil if kill does not start with a headline, or if the first
8346 headline level is not the largest headline level in the tree.
8347 So this will actually accept several entries of equal levels as well,
8348 which is OK for `org-paste-subtree'.
8349 If optional TXT is given, check this string instead of the current kill."
8350 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8351 (re (org-get-limited-outline-regexp))
8352 (^re (concat "^" re))
8353 (start-level (and kill
8354 (string-match
8356 kill)
8357 (- (match-end 2) (match-beginning 2) 1)))
8358 (start (1+ (or (match-beginning 2) -1))))
8359 (if (not start-level)
8360 (progn
8361 nil) ;; does not even start with a heading
8362 (catch 'exit
8363 (while (setq start (string-match ^re kill (1+ start)))
8364 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8365 (throw 'exit nil)))
8366 t))))
8368 (defvar org-markers-to-move nil
8369 "Markers that should be moved with a cut-and-paste operation.
8370 Those markers are stored together with their positions relative to
8371 the start of the region.")
8373 (defun org-save-markers-in-region (beg end)
8374 "Check markers in region.
8375 If these markers are between BEG and END, record their position relative
8376 to BEG, so that after moving the block of text, we can put the markers back
8377 into place.
8378 This function gets called just before an entry or tree gets cut from the
8379 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8380 called immediately, to move the markers with the entries."
8381 (setq org-markers-to-move nil)
8382 (when (featurep 'org-clock)
8383 (org-clock-save-markers-for-cut-and-paste beg end))
8384 (when (featurep 'org-agenda)
8385 (org-agenda-save-markers-for-cut-and-paste beg end)))
8387 (defun org-check-and-save-marker (marker beg end)
8388 "Check if MARKER is between BEG and END.
8389 If yes, remember the marker and the distance to BEG."
8390 (when (and (marker-buffer marker)
8391 (equal (marker-buffer marker) (current-buffer)))
8392 (if (and (>= marker beg) (< marker end))
8393 (push (cons marker (- marker beg)) org-markers-to-move))))
8395 (defun org-reinstall-markers-in-region (beg)
8396 "Move all remembered markers to their position relative to BEG."
8397 (mapc (lambda (x)
8398 (move-marker (car x) (+ beg (cdr x))))
8399 org-markers-to-move)
8400 (setq org-markers-to-move nil))
8402 (defun org-narrow-to-subtree ()
8403 "Narrow buffer to the current subtree."
8404 (interactive)
8405 (save-excursion
8406 (save-match-data
8407 (org-with-limited-levels
8408 (narrow-to-region
8409 (progn (org-back-to-heading t) (point))
8410 (progn (org-end-of-subtree t t)
8411 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8412 (point)))))))
8414 (defun org-narrow-to-block ()
8415 "Narrow buffer to the current block."
8416 (interactive)
8417 (let* ((case-fold-search t)
8420 (if blockp
8421 (narrow-to-region (car blockp) (cdr blockp))
8422 (user-error "Not in a block"))))
8424 (eval-when-compile
8425 (defvar org-property-drawer-re))
8427 (defvar org-property-start-re) ;; defined below
8428 (defun org-clone-subtree-with-time-shift (n &optional shift)
8429 "Clone the task (subtree) at point N times.
8430 The clones will be inserted as siblings.
8432 In interactive use, the user will be prompted for the number of
8433 clones to be produced. If the entry has a timestamp, the user
8434 will also be prompted for a time shift, which may be a repeater
8435 as used in time stamps, for example `+3d'. To disable this,
8436 you can call the function with a universal prefix argument.
8438 When a valid repeater is given and the entry contains any time
8439 stamps, the clones will become a sequence in time, with time
8440 stamps in the subtree shifted for each clone produced. If SHIFT
8441 is nil or the empty string, time stamps will be left alone. The
8442 ID property of the original subtree is removed.
8444 If the original subtree did contain time stamps with a repeater,
8445 the following will happen:
8446 - the repeater will be removed in each clone
8447 - an additional clone will be produced, with the current, unshifted
8448 date(s) in the entry.
8449 - the original entry will be placed *after* all the clones, with
8450 repeater intact.
8451 - the start days in the repeater in the original entry will be shifted
8452 to past the last clone.
8453 In this way you can spell out a number of instances of a repeating task,
8454 and still retain the repeater to cover future instances of the task."
8455 (interactive "nNumber of clones to produce: ")
8456 (let ((shift
8457 (or shift
8458 (if (and (not (equal current-prefix-arg '(4)))
8459 (save-excursion
8460 (re-search-forward org-ts-regexp-both
8461 (save-excursion
8462 (org-end-of-subtree t)
8463 (point)) t)))
8464 (read-from-minibuffer
8465 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8466 ""))) ;; No time shift
8467 (n-no-remove -1)
8468 (drawer-re org-drawer-regexp)
8469 beg end template task idprop
8470 shift-n shift-what doshift nmin nmax)
8471 (if (not (and (integerp n) (> n 0)))
8472 (error "Invalid number of replications %s" n))
8475 shift)))
8476 (error "Invalid shift specification %s" shift))
8477 (when doshift
8478 (setq shift-n (string-to-number (match-string 1 shift))
8479 shift-what (cdr (assoc (match-string 2 shift)
8480 '(("d" . day) ("w" . week)
8481 ("m" . month) ("y" . year))))))
8482 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8483 (setq nmin 1 nmax n)
8484 (org-back-to-heading t)
8485 (setq beg (point))
8486 (setq idprop (org-entry-get nil "ID"))
8487 (org-end-of-subtree t t)
8489 (setq end (point))
8490 (setq template (buffer-substring beg end))
8491 (when (and doshift
8493 (delete-region beg end)
8494 (setq end beg)
8495 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8496 (goto-char end)
8497 (loop for n from nmin to nmax do
8498 ;; prepare clone
8499 (with-temp-buffer
8500 (insert template)
8501 (org-mode)
8502 (goto-char (point-min))
8503 (org-show-subtree)
8504 (and idprop (if org-clone-delete-id
8505 (org-entry-delete nil "ID")
8506 (org-id-get-create t)))
8507 (unless (= n 0)
8509 (kill-whole-line))
8510 (goto-char (point-min))
8511 (while (re-search-forward drawer-re nil t)
8512 (mapc (lambda (d)
8513 (org-remove-empty-drawer-at d (point))) org-drawers)))
8514 (goto-char (point-min))
8515 (when doshift
8516 (while (re-search-forward org-ts-regexp-both nil t)
8517 (org-timestamp-change (* n shift-n) shift-what))
8518 (unless (= n n-no-remove)
8519 (goto-char (point-min))
8520 (while (re-search-forward org-ts-regexp nil t)
8521 (save-excursion
8522 (goto-char (match-beginning 0))
8524 (delete-region (match-beginning 1) (match-end 1)))))))
8525 (setq task (buffer-string)))
8526 (insert task))
8527 (goto-char beg)))
8529 ;;; Outline Sorting
8531 (defun org-sort (with-case)
8532 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8533 Optional argument WITH-CASE means sort case-sensitively."
8534 (interactive "P")
8535 (cond
8536 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8537 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8538 (t
8539 (org-call-with-arg 'org-sort-entries with-case))))
8541 (defun org-sort-remove-invisible (s)
8542 "Remove invisible links from string S."
8543 (remove-text-properties 0 (length s) org-rm-props s)
8544 (while (string-match org-bracket-link-regexp s)
8545 (setq s (replace-match (if (match-end 2)
8546 (match-string 3 s)
8547 (match-string 1 s)) t t s)))
8548 (let ((st (format " %s " s)))
8549 (while (string-match org-emph-re st)
8550 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8551 (setq s (substring st 1 -1)))
8552 s)
8554 (defvar org-priority-regexp) ; defined later in the file
8556 (defvar org-after-sorting-entries-or-items-hook nil
8557 "Hook that is run after a bunch of entries or items have been sorted.
8558 When children are sorted, the cursor is in the parent line when this
8559 hook gets called. When a region or a plain list is sorted, the cursor
8560 will be in the first entry of the sorted region/list.")
8562 (defun org-sort-entries
8563 (&optional with-case sorting-type getkey-func compare-func property)
8564 "Sort entries on a certain level of an outline tree.
8565 If there is an active region, the entries in the region are sorted.
8566 Else, if the cursor is before the first entry, sort the top-level items.
8567 Else, the children of the entry at point are sorted.
8569 Sorting can be alphabetically, numerically, by date/time as given by
8570 a time stamp, by a property, by priority order, or by a custom function.
8572 The command prompts for the sorting type unless it has been given to the
8573 function through the SORTING-TYPE argument, which needs to be a character,
8574 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8575 precise meaning of each character:
8577 n Numerically, by converting the beginning of the entry/item to a number.
8578 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8579 o By order of TODO keywords.
8580 t By date/time, either the first active time stamp in the entry, or, if
8581 none exist, by the first inactive one.
8582 s By the scheduled date/time.
8583 d By deadline date/time.
8584 c By creation time, which is assumed to be the first inactive time stamp
8585 at the beginning of a line.
8586 p By priority according to the cookie.
8587 r By the value of a property.
8589 Capital letters will reverse the sort order.
8591 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8592 called with point at the beginning of the record. It must return either
8593 a string or a number that should serve as the sorting key for that record.
8595 Comparing entries ignores case by default. However, with an optional argument
8596 WITH-CASE, the sorting considers case as well.
8598 Sorting is done against the visible part of the headlines, it ignores hidden
8599 links."
8600 (interactive "P")
8601 (let ((case-func (if with-case 'identity 'downcase))
8602 (cmstr
8603 ;; The clock marker is lost when using `sort-subr', let's
8604 ;; store the clocking string.
8605 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8606 (save-excursion
8607 (goto-char org-clock-marker)
8608 (looking-back "^.*") (match-string-no-properties 0))))
8609 start beg end stars re re2
8610 txt what tmp)
8611 ;; Find beginning and end of region to sort
8612 (cond
8613 ((org-region-active-p)
8614 ;; we will sort the region
8615 (setq end (region-end)
8616 what "region")
8617 (goto-char (region-beginning))
8618 (if (not (org-at-heading-p)) (outline-next-heading))
8619 (setq start (point)))
8620 ((or (org-at-heading-p)
8621 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8622 ;; we will sort the children of the current headline
8623 (org-back-to-heading)
8624 (setq start (point)
8625 end (progn (org-end-of-subtree t t)
8627 (org-back-over-empty-lines)
8628 (point))
8629 what "children")
8630 (goto-char start)
8631 (show-subtree)
8632 (outline-next-heading))
8633 (t
8634 ;; we will sort the top-level entries in this file
8635 (goto-char (point-min))
8636 (or (org-at-heading-p) (outline-next-heading))
8637 (setq start (point))
8638 (goto-char (point-max))
8639 (beginning-of-line 1)
8641 ;; File ends in a non-white line
8642 (end-of-line 1)
8644 (setq end (point-max))
8645 (setq what "top-level")
8646 (goto-char start)
8647 (show-all)))
8649 (setq beg (point))
8650 (if (>= beg end) (user-error "Nothing to sort"))
8653 (setq stars (match-string 1)
8654 re (concat "^" (regexp-quote stars) " +")
8656 txt (buffer-substring beg end))
8658 (if (and (not (equal stars "*")) (string-match re2 txt))
8659 (user-error "Region to sort contains a level above the first entry"))
8661 (unless sorting-type
8662 (message
8663 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8665 A/N/P/R/O/F/T/S/D/C means reversed:"
8666 what)
8667 (setq sorting-type (read-char-exclusive))
8669 (unless getkey-func
8670 (and (= (downcase sorting-type) ?f)
8671 (setq getkey-func
8672 (org-icompleting-read "Sort using function: "
8673 obarray 'fboundp t nil nil))
8674 (setq getkey-func (intern getkey-func))))
8676 (and (= (downcase sorting-type) ?r)
8677 (not property)
8678 (setq property
8679 (org-icompleting-read "Property: "
8680 (mapcar 'list (org-buffer-property-keys t))
8681 nil t))))
8683 (message "Sorting entries...")
8685 (save-restriction
8686 (narrow-to-region start end)
8687 (let ((dcst (downcase sorting-type))
8688 (case-fold-search nil)
8689 (now (current-time)))
8690 (sort-subr
8691 (/= dcst sorting-type)
8692 ;; This function moves to the beginning character of the "record" to
8693 ;; be sorted.
8694 (lambda nil
8695 (if (re-search-forward re nil t)
8696 (goto-char (match-beginning 0))
8697 (goto-char (point-max))))
8698 ;; This function moves to the last character of the "record" being
8699 ;; sorted.
8700 (lambda nil
8701 (save-match-data
8702 (condition-case nil
8703 (outline-forward-same-level 1)
8704 (error
8705 (goto-char (point-max))))))
8706 ;; This function returns the value that gets sorted against.
8707 (lambda nil
8708 (cond
8709 ((= dcst ?n)
8710 (if (looking-at org-complex-heading-regexp)
8711 (string-to-number (org-sort-remove-invisible (match-string 4)))
8712 nil))
8713 ((= dcst ?a)
8714 (if (looking-at org-complex-heading-regexp)
8715 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8716 nil))
8717 ((= dcst ?t)
8718 (let ((end (save-excursion (outline-next-heading) (point))))
8719 (if (or (re-search-forward org-ts-regexp end t)
8720 (re-search-forward org-ts-regexp-both end t))
8721 (org-time-string-to-seconds (match-string 0))
8722 (org-float-time now))))
8723 ((= dcst ?c)
8724 (let ((end (save-excursion (outline-next-heading) (point))))
8725 (if (re-search-forward
8727 end t)
8728 (org-time-string-to-seconds (match-string 0))
8729 (org-float-time now))))
8730 ((= dcst ?s)
8731 (let ((end (save-excursion (outline-next-heading) (point))))
8732 (if (re-search-forward org-scheduled-time-regexp end t)
8733 (org-time-string-to-seconds (match-string 1))
8734 (org-float-time now))))
8735 ((= dcst ?d)
8736 (let ((end (save-excursion (outline-next-heading) (point))))
8737 (if (re-search-forward org-deadline-time-regexp end t)
8738 (org-time-string-to-seconds (match-string 1))
8739 (org-float-time now))))
8740 ((= dcst ?p)
8741 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8742 (string-to-char (match-string 2))
8743 org-default-priority))
8744 ((= dcst ?r)
8745 (or (org-entry-get nil property) ""))
8746 ((= dcst ?o)
8747 (if (looking-at org-complex-heading-regexp)
8748 (- 9999 (length (member (match-string 2)
8749 org-todo-keywords-1)))))
8750 ((= dcst ?f)
8751 (if getkey-func
8752 (progn
8753 (setq tmp (funcall getkey-func))
8754 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8755 tmp)
8756 (error "Invalid key function `%s'" getkey-func)))
8757 (t (error "Invalid sorting type `%c'" sorting-type))))
8758 nil
8759 (cond
8760 ((= dcst ?a) 'string<)
8761 ((= dcst ?f) compare-func)
8762 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8763 (run-hooks 'org-after-sorting-entries-or-items-hook)
8764 ;; Reset the clock marker if needed
8765 (when cmstr
8766 (save-excursion
8767 (goto-char start)
8768 (search-forward cmstr nil t)
8769 (move-marker org-clock-marker (point))))
8770 (message "Sorting entries...done")))
8772 (defun org-do-sort (table what &optional with-case sorting-type)
8773 "Sort TABLE of WHAT according to SORTING-TYPE.
8774 The user will be prompted for the SORTING-TYPE if the call to this
8775 function does not specify it. WHAT is only for the prompt, to indicate
8776 what is being sorted. The sorting key will be extracted from
8777 the car of the elements of the table.
8778 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8779 (unless sorting-type
8780 (message
8781 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8782 what)
8783 (setq sorting-type (read-char-exclusive)))
8784 (let ((dcst (downcase sorting-type))
8785 extractfun comparefun)
8786 ;; Define the appropriate functions
8787 (cond
8788 ((= dcst ?n)
8789 (setq extractfun 'string-to-number
8790 comparefun (if (= dcst sorting-type) '< '>)))
8791 ((= dcst ?a)
8792 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8793 (lambda(x) (downcase (org-sort-remove-invisible x))))
8794 comparefun (if (= dcst sorting-type)
8795 'string<
8796 (lambda (a b) (and (not (string< a b))
8797 (not (string= a b)))))))
8798 ((= dcst ?t)
8799 (setq extractfun
8800 (lambda (x)
8801 (if (or (string-match org-ts-regexp x)
8802 (string-match org-ts-regexp-both x))
8803 (org-float-time
8804 (org-time-string-to-time (match-string 0 x)))
8805 0))
8806 comparefun (if (= dcst sorting-type) '< '>)))
8807 (t (error "Invalid sorting type `%c'" sorting-type)))
8809 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8810 table)
8811 (lambda (a b) (funcall comparefun (car a) (car b))))))
8814 ;;; The orgstruct minor mode
8816 ;; Define a minor mode which can be used in other modes in order to
8817 ;; integrate the org-mode structure editing commands.
8819 ;; This is really a hack, because the org-mode structure commands use
8820 ;; keys which normally belong to the major mode. Here is how it
8821 ;; works: The minor mode defines all the keys necessary to operate the
8822 ;; structure commands, but wraps the commands into a function which
8823 ;; tests if the cursor is currently at a headline or a plain list
8824 ;; item. If that is the case, the structure command is used,
8825 ;; temporarily setting many Org-mode variables like regular
8826 ;; expressions for filling etc. However, when any of those keys is
8827 ;; used at a different location, function uses `key-binding' to look
8828 ;; up if the key has an associated command in another currently active
8829 ;; keymap (minor modes, major mode, global), and executes that
8830 ;; command. There might be problems if any of the keys is otherwise
8831 ;; used as a prefix key.
8833 (defcustom orgstruct-heading-prefix-regexp nil
8834 "Regexp that matches the custom prefix of Org headlines in
8835 orgstruct(++)-mode."
8836 :group 'org
8837 :version "24.4"
8838 :package-version '(Org . "8.0")
8839 :type 'string)
8840 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8842 (defcustom orgstruct-setup-hook nil
8843 "Hook run after orgstruct-mode-map is filled."
8844 :group 'org
8845 :version "24.4"
8846 :package-version '(Org . "8.0")
8847 :type 'hook)
8849 (defvar orgstruct-initialized nil)
8851 (defvar org-local-vars nil
8852 "List of local variables, for use by `orgstruct-mode'.")
8854 ;;;###autoload
8855 (define-minor-mode orgstruct-mode
8856 "Toggle the minor mode `orgstruct-mode'.
8857 This mode is for using Org-mode structure commands in other
8858 modes. The following keys behave as if Org-mode were active, if
8859 the cursor is on a headline, or on a plain list item (both as
8860 defined by Org-mode)."
8861 nil " OrgStruct" (make-sparse-keymap)
8862 (funcall (if orgstruct-mode
8863 'add-to-invisibility-spec
8864 'remove-from-invisibility-spec)
8865 '(outline . t))
8866 (when orgstruct-mode
8867 (org-load-modules-maybe)
8868 (unless orgstruct-initialized
8869 (orgstruct-setup)
8870 (setq orgstruct-initialized t))))
8872 ;;;###autoload
8873 (defun turn-on-orgstruct ()
8874 "Unconditionally turn on `orgstruct-mode'."
8875 (orgstruct-mode 1))
8877 (defvar org-fb-vars nil)
8878 (make-variable-buffer-local 'org-fb-vars)
8879 (defun orgstruct++-mode (&optional arg)
8880 "Toggle `orgstruct-mode', the enhanced version of it.
8881 In addition to setting orgstruct-mode, this also exports all
8882 indentation and autofilling variables from org-mode into the
8883 buffer. It will also recognize item context in multiline items."
8884 (interactive "P")
8885 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8886 (if (< arg 1)
8887 (progn (orgstruct-mode -1)
8888 (mapc (lambda(v)
8889 (org-set-local (car v)
8890 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8891 org-fb-vars))
8892 (orgstruct-mode 1)
8893 (setq org-fb-vars nil)
8894 (unless org-local-vars
8895 (setq org-local-vars (org-get-local-variables)))
8896 (let (var val)
8897 (mapc
8898 (lambda (x)
8899 (when (string-match
8901 (symbol-name (car x)))
8902 (setq var (car x) val (nth 1 x))
8903 (push (list var `(quote ,(eval var))) org-fb-vars)
8904 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8905 org-local-vars)
8906 (org-set-local 'orgstruct-is-++ t))))
8908 (defvar orgstruct-is-++ nil
8909 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8910 (make-variable-buffer-local 'orgstruct-is-++)
8912 ;;;###autoload
8913 (defun turn-on-orgstruct++ ()
8914 "Unconditionally turn on `orgstruct++-mode'."
8915 (orgstruct++-mode 1))
8917 (defun orgstruct-error ()
8918 "Error when there is no default binding for a structure key."
8919 (interactive)
8920 (funcall (if (fboundp 'user-error)
8921 'user-error
8922 'error)
8923 "This key has no function outside structure elements"))
8925 (defun orgstruct-setup ()
8926 "Setup orgstruct keymap."
8927 (dolist (cell '((org-demote . t)
8928 (org-metaleft . t)
8929 (org-metaright . t)
8930 (org-promote . t)
8931 (org-shiftmetaleft . t)
8932 (org-shiftmetaright . t)
8933 org-backward-element
8934 org-backward-heading-same-level
8935 org-ctrl-c-ret
8936 org-ctrl-c-minus
8937 org-ctrl-c-star
8938 org-cycle
8939 org-forward-heading-same-level
8940 org-insert-heading
8941 org-insert-heading-respect-content
8942 org-kill-note-or-show-branches
8943 org-mark-subtree
8944 org-meta-return
8945 org-metadown
8946 org-metaup
8947 org-narrow-to-subtree
8948 org-promote-subtree
8949 org-reveal
8950 org-shiftdown
8951 org-shiftleft
8952 org-shiftmetadown
8953 org-shiftmetaup
8954 org-shiftright
8955 org-shifttab
8956 org-shifttab
8957 org-shiftup
8958 org-show-subtree
8959 org-sort
8960 org-up-element
8961 outline-demote
8962 outline-next-visible-heading
8963 outline-previous-visible-heading
8964 outline-promote
8965 outline-up-heading
8966 show-children))
8967 (let ((f (or (car-safe cell) cell))
8968 (disable-when-heading-prefix (cdr-safe cell)))
8969 (when (fboundp f)
8970 (let ((new-bindings))
8971 (dolist (binding (nconc (where-is-internal f org-mode-map)
8972 (where-is-internal f outline-mode-map)))
8973 (push binding new-bindings)
8974 ;; TODO use local-function-key-map
8975 (dolist (rep '(("<tab>" . "TAB")
8976 ("<return>" . "RET")
8977 ("<escape>" . "ESC")
8978 ("<delete>" . "DEL")))
8979 (setq binding (read-kbd-macro
8980 (let ((case-fold-search))
8981 (replace-regexp-in-string
8982 (regexp-quote (cdr rep))
8983 (car rep)
8984 (key-description binding)))))
8985 (pushnew binding new-bindings :test 'equal)))
8986 (dolist (binding new-bindings)
8987 (let ((key (lookup-key orgstruct-mode-map binding)))
8988 (when (or (not key) (numberp key))
8989 (condition-case nil
8990 (org-defkey orgstruct-mode-map
8991 binding
8992 (orgstruct-make-binding f binding disable-when-heading-prefix))
8993 (error nil)))))))))
8994 (run-hooks 'orgstruct-setup-hook))
8996 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
8997 "Create a function for binding in the structure minor mode.
8998 FUN is the command to call inside a table. KEY is the key that
8999 should be checked in for a command to execute outside of tables.
9000 Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
9001 if `orgstruct-heading-prefix-regexp' is non-nil."
9002 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9003 (let ((nname name)
9004 (i 0))
9005 (while (fboundp (intern nname))
9006 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9007 (setq name (intern nname)))
9008 (eval
9009 (let ((bindings '((org-heading-regexp
9010 (concat "^"
9011 orgstruct-heading-prefix-regexp
9013 (org-outline-regexp
9015 (org-outline-regexp-bol
9016 (concat "^" org-outline-regexp))
9017 (outline-regexp org-outline-regexp)
9019 (outline-level 'org-outline-level)
9020 (outline-heading-alist))))
9021 `(defun ,name (arg)
9023 "Outside of structure, run the binding of `"
9024 (key-description key) "'."
9025 (when disable-when-heading-prefix
9026 (concat
9029 "`" (symbol-name fun) "'.")))
9030 (interactive "p")
9031 (let* ((disable
9032 ,(when disable-when-heading-prefix
9033 '(and orgstruct-heading-prefix-regexp
9034 (not (string= orgstruct-heading-prefix-regexp "")))))
9035 (fallback
9036 (or disable
9037 (not
9038 (let* ,bindings
9039 (org-context-p 'headline 'item
9040 ,(when (memq fun
9041 '(org-insert-heading
9042 org-insert-heading-respect-content
9043 org-meta-return))
9044 '(when orgstruct-is-++
9045 'item-body))))))))
9046 (if fallback
9047 (let* ((orgstruct-mode)
9048 (binding
9049 (loop with key = ,key
9050 for rep in
9051 '(nil
9056 do
9057 (when rep
9058 (setq key (read-kbd-macro
9059 (let ((case-fold-search))
9060 (replace-regexp-in-string
9061 (car rep)
9062 (cdr rep)
9063 (key-description key))))))
9064 thereis (key-binding key))))
9065 (if (keymapp binding)
9066 (set-temporary-overlay-map binding)
9067 (let ((func (or binding
9068 (unless disable
9069 'orgstruct-error))))
9070 (when func
9071 (call-interactively func)))))
9072 (org-run-like-in-org-mode
9073 (lambda ()
9074 (interactive)
9075 (let* ,bindings
9076 (call-interactively ',fun)))))))))
9077 name))
9079 (defun org-contextualize-keys (alist contexts)
9080 "Return valid elements in ALIST depending on CONTEXTS.
9082 `org-agenda-custom-commands' or `org-capture-templates' are the
9083 values used for ALIST, and `org-agenda-custom-commands-contexts'
9084 or `org-capture-templates-contexts' are the associated contexts
9085 definitions."
9086 (let ((contexts
9087 ;; normalize contexts
9088 (mapcar
9089 (lambda(c) (cond ((listp (cadr c))
9090 (list (car c) (car c) (cadr c)))
9091 ((string= "" (cadr c))
9092 (list (car c) (car c) (caddr c)))
9093 (t c))) contexts))
9094 (a alist) c r s)
9095 ;; loop over all commands or templates
9096 (while (setq c (pop a))
9097 (let (vrules repl)
9098 (cond
9099 ((not (assoc (car c) contexts))
9100 (push c r))
9101 ((and (assoc (car c) contexts)
9102 (setq vrules (org-contextualize-validate-key
9103 (car c) contexts)))
9104 (mapc (lambda (vr)
9105 (when (not (equal (car vr) (cadr vr)))
9106 (setq repl vr))) vrules)
9107 (if (not repl) (push c r)
9108 (push (cadr repl) s)
9109 (push
9110 (cons (car c)
9111 (cdr (or (assoc (cadr repl) alist)
9112 (error "Undefined key `%s' as contextual replacement for `%s'"
9113 (cadr repl) (car c)))))
9114 r))))))
9115 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9116 (delq
9117 nil
9118 (delete-dups
9119 (mapcar (lambda (x)
9120 (let ((tpl (car x)))
9121 (when (not (delq
9122 nil
9123 (mapcar (lambda(y)
9124 (equal y tpl)) s))) x)))
9125 (reverse r))))))
9127 (defun org-contextualize-validate-key (key contexts)
9128 "Check CONTEXTS for agenda or capture KEY."
9129 (let (r rr res)
9130 (while (setq r (pop contexts))
9131 (mapc
9132 (lambda (rr)
9133 (when
9134 (and (equal key (car r))
9135 (if (functionp rr) (funcall rr)
9136 (or (and (eq (car rr) 'in-file)
9137 (buffer-file-name)
9138 (string-match (cdr rr) (buffer-file-name)))
9139 (and (eq (car rr) 'in-mode)
9140 (string-match (cdr rr) (symbol-name major-mode)))
9141 (and (eq (car rr) 'in-buffer)
9142 (string-match (cdr rr) (buffer-name)))
9143 (when (and (eq (car rr) 'not-in-file)
9144 (buffer-file-name))
9145 (not (string-match (cdr rr) (buffer-file-name))))
9146 (when (eq (car rr) 'not-in-mode)
9147 (not (string-match (cdr rr) (symbol-name major-mode))))
9148 (when (eq (car rr) 'not-in-buffer)
9149 (not (string-match (cdr rr) (buffer-name)))))))
9150 (push r res)))
9151 (car (last r))))
9152 (delete-dups (delq nil res))))
9154 (defun org-context-p (&rest contexts)
9155 "Check if local context is any of CONTEXTS.
9156 Possible values in the list of contexts are `table', `headline', and `item'."
9157 (let ((pos (point)))
9158 (goto-char (point-at-bol))
9159 (prog1 (or (and (memq 'table contexts)
9161 (and (memq 'headline contexts)
9162 (looking-at org-outline-regexp))
9163 (and (memq 'item contexts)
9165 (and (memq 'item-body contexts)
9166 (org-in-item-p)))
9167 (goto-char pos))))
9169 (defun org-get-local-variables ()
9170 "Return a list of all local variables in an Org mode buffer."
9171 (let (varlist)
9172 (with-current-buffer (get-buffer-create "*Org tmp*")
9173 (erase-buffer)
9174 (org-mode)
9175 (setq varlist (buffer-local-variables)))
9176 (kill-buffer "*Org tmp*")
9177 (delq nil
9178 (mapcar
9179 (lambda (x)
9180 (setq x
9181 (if (symbolp x)
9182 (list x)
9183 (list (car x) (cdr x))))
9184 (if (and (not (get (car x) 'org-state))
9185 (string-match
9186 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9187 (symbol-name (car x))))
9188 x nil))
9189 varlist))))
9191 (defun org-clone-local-variables (from-buffer &optional regexp)
9192 "Clone local variables from FROM-BUFFER.
9193 Optional argument REGEXP selects variables to clone."
9194 (mapc
9195 (lambda (pair)
9196 (and (symbolp (car pair))
9197 (or (null regexp)
9198 (string-match regexp (symbol-name (car pair))))
9199 (set (make-local-variable (car pair))
9200 (cdr pair))))
9201 (buffer-local-variables from-buffer)))
9203 ;;;###autoload
9204 (defun org-run-like-in-org-mode (cmd)
9205 "Run a command, pretending that the current buffer is in Org-mode.
9206 This will temporarily bind local variables that are typically bound in
9207 Org-mode to the values they have in Org-mode, and then interactively
9208 call CMD."
9209 (org-load-modules-maybe)
9210 (unless org-local-vars
9211 (setq org-local-vars (org-get-local-variables)))
9212 (let (binds)
9213 (dolist (var org-local-vars)
9214 (when (or (not (boundp (car var)))
9215 (eq (symbol-value (car var))
9216 (default-value (car var))))
9217 (push (list (car var) `(quote ,(cadr var))) binds)))
9218 (eval `(let ,binds
9219 (call-interactively (quote ,cmd))))))
9221 ;;;; Archiving
9223 (defun org-get-category (&optional pos force-refresh)
9224 "Get the category applying to position POS."
9225 (save-match-data
9226 (if force-refresh (org-refresh-category-properties))
9227 (let ((pos (or pos (point))))
9228 (or (get-text-property pos 'org-category)
9229 (progn (org-refresh-category-properties)
9230 (get-text-property pos 'org-category))))))
9232 (defun org-refresh-category-properties ()
9233 "Refresh category text properties in the buffer."
9234 (let ((case-fold-search t)
9235 (inhibit-read-only t)
9236 (def-cat (cond
9237 ((null org-category)
9238 (if buffer-file-name
9239 (file-name-sans-extension
9240 (file-name-nondirectory buffer-file-name))
9241 "???"))
9242 ((symbolp org-category) (symbol-name org-category))
9243 (t org-category)))
9244 beg end cat pos optionp)
9245 (org-with-silent-modifications
9246 (save-excursion
9247 (save-restriction
9248 (widen)
9249 (goto-char (point-min))
9250 (put-text-property (point) (point-max) 'org-category def-cat)
9251 (while (re-search-forward
9253 (setq pos (match-end 0)
9254 optionp (equal (char-after (match-beginning 0)) ?#)
9255 cat (org-trim (match-string 2)))
9256 (if optionp
9257 (setq beg (point-at-bol) end (point-max))
9258 (org-back-to-heading t)
9259 (setq beg (point) end (org-end-of-subtree t t)))
9260 (put-text-property beg end 'org-category cat)
9261 (put-text-property beg end 'org-category-position beg)
9262 (goto-char pos)))))))
9264 (defun org-refresh-properties (dprop tprop)
9265 "Refresh buffer text properties.
9266 DPROP is the drawer property and TPROP is the corresponding text
9267 property to set."
9268 (let ((case-fold-search t)
9269 (inhibit-read-only t) p)
9270 (org-with-silent-modifications
9271 (save-excursion
9272 (save-restriction
9273 (widen)
9274 (goto-char (point-min))
9276 (setq p (org-match-string-no-properties 1))
9277 (save-excursion
9278 (org-back-to-heading t)
9279 (put-text-property
9280 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9283 ;;;; Link Stuff
9285 ;;; Link abbreviations
9287 (defun org-link-expand-abbrev (link)
9288 "Apply replacements as defined in `org-link-abbrev-alist'."
9290 (let* ((key (match-string 1 link))
9291 (as (or (assoc key org-link-abbrev-alist-local)
9292 (assoc key org-link-abbrev-alist)))
9293 (tag (and (match-end 2) (match-string 3 link)))
9294 rpl)
9295 (if (not as)
9296 link
9297 (setq rpl (cdr as))
9298 (cond
9299 ((symbolp rpl) (funcall rpl tag))
9301 (replace-match
9302 (save-match-data
9303 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9304 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9305 ((string-match "%h" rpl)
9306 (replace-match (url-hexify-string (or tag "")) t t rpl))
9307 (t (concat rpl tag)))))
9308 link))
9310 ;;; Storing and inserting links
9312 (defvar org-insert-link-history nil
9313 "Minibuffer history for links inserted with `org-insert-link'.")
9315 (defvar org-stored-links nil
9316 "Contains the links stored with `org-store-link'.")
9318 (defvar org-store-link-plist nil
9319 "Plist with info about the most recently link created with `org-store-link'.")
9321 (defvar org-link-protocols nil
9322 "Link protocols added to Org-mode using `org-add-link-type'.")
9324 (defvar org-store-link-functions nil
9325 "List of functions that are called to create and store a link.
9326 Each function will be called in turn until one returns a non-nil
9327 value. Each function should check if it is responsible for creating
9328 this link (for example by looking at the major mode).
9329 If not, it must exit and return nil.
9330 If yes, it should return a non-nil value after a calling
9331 `org-store-link-props' with a list of properties and values.
9332 Special properties are:
9336 This is obligatory as well.
9337 :description Optional default description for the second pair
9338 of brackets in an Org-mode link. The user can still change
9339 this when inserting this link into an Org-mode buffer.
9341 In addition to these, any additional properties can be specified
9342 and then used in capture templates.")
9344 (defun org-add-link-type (type &optional follow export)
9345 "Add TYPE to the list of `org-link-types'.
9346 Re-compute all regular expressions depending on `org-link-types'
9348 FOLLOW and EXPORT are two functions.
9350 FOLLOW should take the link path as the single argument and do whatever
9351 is necessary to follow the link, for example find a file or display
9352 a mail message.
9354 EXPORT should format the link path for export to one of the export formats.
9355 It should be a function accepting three arguments:
9358 desc the description of the link, if any, or a description added by
9359 org-export-normalize-links if there is none
9360 format the export format, a symbol like `html' or `latex' or `ascii'..
9362 The function may use the FORMAT information to return different values
9363 depending on the format. The return value will be put literally into
9364 the exported file. If the return value is nil, this means Org should
9365 do what it normally does with links which do not have EXPORT defined.
9367 Org-mode has a built-in default for exporting links. If you are happy with
9368 this default, there is no need to define an export function for the link
9369 type. For a simple example of an export function, see `org-bbdb.el'."
9370 (add-to-list 'org-link-types type t)
9371 (org-make-link-regexps)
9372 (if (assoc type org-link-protocols)
9373 (setcdr (assoc type org-link-protocols) (list follow export))
9374 (push (list type follow export) org-link-protocols)))
9376 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9377 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9379 ;;;###autoload
9380 (defun org-store-link (arg)
9382 This link is added to `org-stored-links' and can later be inserted
9385 For some link types, a prefix arg is interpreted.
9386 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9387 For file links, arg negates `org-context-in-file-links'.
9389 A double prefix arg force skipping storing functions that are not
9390 part of Org's core.
9392 A triple prefix arg force storing a link for each line in the
9393 active region."
9394 (interactive "P")
9395 (org-load-modules-maybe)
9396 (if (and (equal arg '(64)) (org-region-active-p))
9397 (save-excursion
9398 (let ((end (region-end)))
9399 (goto-char (region-beginning))
9400 (set-mark (point))
9401 (while (< (point-at-eol) end)
9402 (move-end-of-line 1) (activate-mark)
9403 (let (current-prefix-arg)
9404 (call-interactively 'org-store-link))
9405 (move-beginning-of-line 2)
9406 (set-mark (point)))))
9407 (org-with-limited-levels
9408 (setq org-store-link-plist nil)
9409 (let (link cpltxt desc description search
9410 txt custom-id agenda-link sfuns sfunsn)
9411 (cond
9413 ;; Store a link using an external link type
9414 ((and (not (equal arg '(16)))
9415 (setq sfuns
9416 (delq
9417 nil (mapcar (lambda (f)
9418 (let (fs) (if (funcall f) (push f fs))))
9419 org-store-link-functions))
9420 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9421 (or (and (cdr sfuns)
9422 (funcall (intern
9423 (completing-read
9424 "Which function for creating the link? "
9425 sfunsn t (car sfunsn)))))
9426 (funcall (caar sfuns)))
9427 (setq link (plist-get org-store-link-plist :link)
9428 desc (or (plist-get org-store-link-plist
9429 :description) link))))
9431 ;; Store a link from a source code buffer
9432 ((org-src-edit-buffer-p)
9433 (let (label gc)
9434 (while (or (not label)
9435 (save-excursion
9436 (save-restriction
9437 (widen)
9438 (goto-char (point-min))
9439 (re-search-forward
9440 (regexp-quote (format org-coderef-label-format label))
9441 nil t))))
9442 (when label (message "Label exists already") (sit-for 2))
9443 (setq label (read-string "Code line label: " label)))
9444 (end-of-line 1)
9445 (setq link (format org-coderef-label-format label))
9446 (setq gc (- 79 (length link)))
9447 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9448 (insert link)
9449 (setq link (concat "(" label ")") desc nil)))
9451 ;; We are in the agenda, link to referenced location
9452 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9453 (let ((m (or (get-text-property (point) 'org-hd-marker)
9454 (get-text-property (point) 'org-marker))))
9455 (when m
9456 (org-with-point-at m
9457 (setq agenda-link
9458 (if (org-called-interactively-p 'any)
9459 (call-interactively 'org-store-link)
9460 (org-store-link nil)))))))
9462 ((eq major-mode 'calendar-mode)
9463 (let ((cd (calendar-cursor-to-date)))
9464 (setq link
9465 (format-time-string
9466 (car org-time-stamp-formats)
9467 (apply 'encode-time
9468 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9469 nil nil nil))))
9470 (org-store-link-props :type "calendar" :date cd)))
9472 ((eq major-mode 'help-mode)
9473 (setq link (concat "help:" (save-excursion
9474 (goto-char (point-min))
9475 (looking-at "^[^ ]+")
9476 (match-string 0))))
9477 (org-store-link-props :type "help"))
9479 ((eq major-mode 'w3-mode)
9480 (setq cpltxt (if (and (buffer-name)
9481 (not (string-match "Untitled" (buffer-name))))
9482 (buffer-name)
9483 (url-view-url t))
9484 link (url-view-url t))
9485 (org-store-link-props :type "w3" :url (url-view-url t)))
9487 ((eq major-mode 'image-mode)
9488 (setq cpltxt (concat "file:"
9489 (abbreviate-file-name buffer-file-name))
9490 link cpltxt)
9491 (org-store-link-props :type "image" :file buffer-file-name))
9493 ;; In dired, store a link to the file of the current line
9494 ((eq major-mode 'dired-mode)
9495 (let ((file (dired-get-filename nil t)))
9496 (setq file (if file
9497 (abbreviate-file-name
9498 (expand-file-name (dired-get-filename nil t)))
9499 ;; otherwise, no file so use current directory.
9500 default-directory))
9501 (setq cpltxt (concat "file:" file)
9502 link cpltxt)))
9504 ((setq search (run-hook-with-args-until-success
9505 'org-create-file-search-functions))
9506 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9507 "::" search))
9508 (setq cpltxt (or description link)))
9510 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9511 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9512 (cond
9513 ;; Store a link using the target at point
9515 (setq cpltxt
9516 (concat "file:"
9517 (abbreviate-file-name
9518 (buffer-file-name (buffer-base-buffer)))
9519 "::" (match-string 1))
9520 link cpltxt))
9521 ((and (featurep 'org-id)
9522 (or (eq org-id-link-to-org-use-id t)
9523 (and (org-called-interactively-p 'any)
9524 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9525 (and (eq org-id-link-to-org-use-id
9526 'create-if-interactive-and-no-custom-id)
9527 (not custom-id))))
9528 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9529 ;; Store a link using the ID at point
9530 (setq link (condition-case nil
9531 (prog1 (org-id-store-link)
9532 (setq desc (plist-get org-store-link-plist
9533 :description)))
9534 (error
9535 ;; Probably before first headline, link only to file
9536 (concat "file:"
9537 (abbreviate-file-name
9538 (buffer-file-name (buffer-base-buffer))))))))
9539 (t
9540 ;; Just link to current headline
9541 (setq cpltxt (concat "file:"
9542 (abbreviate-file-name
9543 (buffer-file-name (buffer-base-buffer)))))
9544 ;; Add a context search string
9545 (when (org-xor org-context-in-file-links arg)
9546 (let* ((ee (org-element-at-point))
9547 (et (org-element-type ee))
9548 (ev (plist-get (cadr ee) :value))
9549 (ek (plist-get (cadr ee) :key))
9550 (eok (and (stringp ek) (string-match "name" ek))))
9551 (setq txt (cond
9552 ((org-at-heading-p) nil)
9553 ((and (eq et 'keyword) eok) ev)
9554 ((org-region-active-p)
9555 (buffer-substring (region-beginning) (region-end)))))
9557 (setq cpltxt
9558 (concat cpltxt "::"
9559 (condition-case nil
9560 (org-make-org-heading-search-string txt)
9561 (error "")))
9562 desc (or (and (eq et 'keyword) eok ev)
9563 (nth 4 (ignore-errors (org-heading-components)))
9564 "NONE")))))
9566 (setq cpltxt (substring cpltxt 0 -2)))
9567 (setq link cpltxt))))
9569 ((buffer-file-name (buffer-base-buffer))
9570 ;; Just link to this file here.
9571 (setq cpltxt (concat "file:"
9572 (abbreviate-file-name
9573 (buffer-file-name (buffer-base-buffer)))))
9574 ;; Add a context string.
9575 (when (org-xor org-context-in-file-links arg)
9576 (setq txt (if (org-region-active-p)
9577 (buffer-substring (region-beginning) (region-end))
9578 (buffer-substring (point-at-bol) (point-at-eol))))
9579 ;; Only use search option if there is some text.
9581 (setq cpltxt
9582 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9583 desc "NONE")))
9584 (setq link cpltxt))
9586 ((org-called-interactively-p 'interactive)
9587 (user-error "No method for storing a link from this buffer"))
9589 (t (setq link nil)))
9591 ;; We're done setting link and desc, clean up
9592 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9593 (setq link (or link cpltxt)
9594 desc (or desc cpltxt))
9595 (cond ((equal desc "NONE") (setq desc nil))
9596 ((string-match org-bracket-link-analytic-regexp desc)
9597 (let ((d0 (match-string 3 desc))
9598 (p0 (match-string 5 desc)))
9599 (setq desc
9600 (replace-regexp-in-string
9601 org-bracket-link-regexp
9602 (concat (or p0 d0)
9603 (if (equal (length (match-string 0 desc))
9604 (length desc)) "*" "")) desc)))))
9606 ;; Return the link
9607 (if (not (and (or (org-called-interactively-p 'any)
9608 executing-kbd-macro) link))
9609 (or agenda-link (and link (org-make-link-string link desc)))
9610 (push (list link desc) org-stored-links)
9611 (message "Stored: %s" (or desc link))
9612 (when custom-id
9613 (setq link (concat "file:" (abbreviate-file-name
9614 (buffer-file-name)) "::#" custom-id))
9615 (push (list link desc) org-stored-links)))))))
9617 (defun org-store-link-props (&rest plist)
9618 "Store link properties, extract names and addresses."
9619 (let (x adr)
9620 (when (setq x (plist-get plist :from))
9621 (setq adr (mail-extract-address-components x))
9622 (setq plist (plist-put plist :fromname (car adr)))
9623 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9624 (when (setq x (plist-get plist :to))
9625 (setq adr (mail-extract-address-components x))
9626 (setq plist (plist-put plist :toname (car adr)))
9627 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9628 (let ((from (plist-get plist :from))
9629 (to (plist-get plist :to)))
9630 (when (and from to org-from-is-user-regexp)
9631 (setq plist
9632 (plist-put plist :fromto
9633 (if (string-match org-from-is-user-regexp from)
9634 (concat "to %t")
9635 (concat "from %f"))))))
9636 (setq org-store-link-plist plist))
9638 (defun org-add-link-props (&rest plist)
9639 "Add these properties to the link property list."
9640 (let (key value)
9641 (while plist
9642 (setq key (pop plist) value (pop plist))
9643 (setq org-store-link-plist
9644 (plist-put org-store-link-plist key value)))))
9646 (defun org-email-link-description (&optional fmt)
9647 "Return the description part of an email link.
9648 This takes information from `org-store-link-plist' and formats it
9649 according to FMT (default from `org-email-link-description-format')."
9650 (setq fmt (or fmt org-email-link-description-format))
9651 (let* ((p org-store-link-plist)
9652 (to (plist-get p :toaddress))
9653 (from (plist-get p :fromaddress))
9654 (table
9655 (list
9656 (cons "%c" (plist-get p :fromto))
9657 (cons "%F" (plist-get p :from))
9658 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9659 (cons "%T" (plist-get p :to))
9660 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9661 (cons "%s" (plist-get p :subject))
9662 (cons "%d" (plist-get p :date))
9663 (cons "%m" (plist-get p :message-id)))))
9664 (when (string-match "%c" fmt)
9665 ;; Check if the user wrote this message
9666 (if (and org-from-is-user-regexp from to
9667 (save-match-data (string-match org-from-is-user-regexp from)))
9668 (setq fmt (replace-match "to %t" t t fmt))
9669 (setq fmt (replace-match "from %f" t t fmt))))
9670 (org-replace-escapes fmt table)))
9672 (defun org-make-org-heading-search-string (&optional string)
9673 "Make search string for the current headline or STRING."
9674 (let ((s (or string
9675 (and (derived-mode-p 'org-mode)
9676 (save-excursion
9677 (org-back-to-heading t)
9678 (org-element-property :raw-value (org-element-at-point))))))
9679 (lines org-context-in-file-links))
9680 (or string (setq s (concat "*" s))) ; Add * for headlines
9682 (when (and string (integerp lines) (> lines 0))
9684 (when (< lines (length slines))
9685 (setq s (mapconcat
9686 'identity
9687 (reverse (nthcdr (- (length slines) lines)
9691 (defun org-make-link-string (link &optional description)
9692 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9694 (error "Empty link"))
9695 (when (and description
9696 (stringp description)
9698 (setq description nil))
9699 (when (stringp description)
9700 ;; Remove brackets from the description, they are fatal.
9702 (setq description (replace-match "{" t t description)))
9704 (setq description (replace-match "}" t t description))))
9705 (when (equal link description)
9706 ;; No description needed, it is identical
9707 (setq description nil))
9708 (when (and (not description)
9709 (not (string-match (org-image-file-name-regexp) link))
9710 (not (equal link (org-link-escape link))))
9711 (setq description (org-extract-attributes link)))
9712 (setq link
9713 (cond ((string-match (org-image-file-name-regexp) link) link)
9714 ((string-match org-link-types-re link)
9715 (concat (match-string 1 link)
9716 (org-link-escape (substring link (match-end 1)))))
9717 (t (org-link-escape link))))
9718 (concat "[[" link "]"
9719 (if description (concat "[" description "]") "")
9720 "]"))
9722 (defconst org-link-escape-chars
9723 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9724 "List of characters that should be escaped in link.
9725 This is the list that is used for internal purposes.")
9727 (defconst org-link-escape-chars-browser
9729 "List of escapes for characters that are problematic in links.
9730 This is the list that is used before handing over to the browser.")
9732 (defun org-link-escape (text &optional table merge)
9733 "Return percent escaped representation of TEXT.
9734 TEXT is a string with the text to escape.
9735 Optional argument TABLE is a list with characters that should be
9736 escaped. When nil, `org-link-escape-chars' is used.
9737 If optional argument MERGE is set, merge TABLE into
9738 `org-link-escape-chars'."
9739 (cond
9740 ((and table merge)
9741 (mapc (lambda (defchr)
9742 (unless (member defchr table)
9743 (setq table (cons defchr table)))) org-link-escape-chars))
9744 ((null table)
9745 (setq table org-link-escape-chars)))
9746 (mapconcat
9747 (lambda (char)
9748 (if (or (member char table)
9749 (and (or (< char 32) (= char 37) (> char 126))
9750 org-url-hexify-p))
9751 (mapconcat (lambda (sequence-element)
9752 (format "%%%.2X" sequence-element))
9753 (or (encode-coding-char char 'utf-8)
9754 (error "Unable to percent escape character: %s"
9755 (char-to-string char))) "")
9756 (char-to-string char))) text ""))
9758 (defun org-link-unescape (str)
9759 "Unhex hexified Unicode strings as returned from the JavaScript function
9760 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9761 (unless (and (null str) (string= "" str))
9762 (let ((pos 0) (case-fold-search t) unhexed)
9764 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9765 (setq str (replace-match unhexed t t str))
9766 (setq pos (+ pos (length unhexed))))))
9767 str)
9769 (defun org-link-unescape-compound (hex)
9770 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9771 Note: this function also decodes single byte encodings like
9772 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9773 (save-match-data
9774 (let* ((bytes (cdr (split-string hex "%")))
9775 (ret "")
9776 (eat 0)
9777 (sum 0))
9778 (while bytes
9779 (let* ((val (string-to-number (pop bytes) 16))
9780 (shift-xor
9781 (if (= 0 eat)
9782 (cond
9783 ((>= val 252) (cons 6 252))
9784 ((>= val 248) (cons 5 248))
9785 ((>= val 240) (cons 4 240))
9786 ((>= val 224) (cons 3 224))
9787 ((>= val 192) (cons 2 192))
9788 (t (cons 0 0)))
9789 (cons 6 128))))
9790 (if (>= val 192) (setq eat (car shift-xor)))
9791 (setq val (logxor val (cdr shift-xor)))
9792 (setq sum (+ (lsh sum (car shift-xor)) val))
9793 (if (> eat 0) (setq eat (- eat 1)))
9794 (cond
9795 ((= 0 eat) ;multi byte
9796 (setq ret (concat ret (org-char-to-string sum)))
9797 (setq sum 0))
9798 ((not bytes) ; single byte(s)
9799 (setq ret (org-link-unescape-single-byte-sequence hex))))
9800 )) ;; end (while bytes
9801 ret )))
9803 (defun org-link-unescape-single-byte-sequence (hex)
9804 "Unhexify hex-encoded single byte character sequences."
9805 (mapconcat (lambda (byte)
9806 (char-to-string (string-to-number byte 16)))
9807 (cdr (split-string hex "%")) ""))
9809 (defun org-xor (a b)
9810 "Exclusive or."
9811 (if a (not b) b))
9813 (defun org-fixup-message-id-for-http (s)
9814 "Replace special characters in a message id, so it can be used in an http query."
9815 (when (string-match "%" s)
9816 (setq s (mapconcat (lambda (c)
9817 (if (eq c ?%)
9818 "%25"
9819 (char-to-string c)))
9820 s "")))
9821 (while (string-match "<" s)
9822 (setq s (replace-match "%3C" t t s)))
9823 (while (string-match ">" s)
9824 (setq s (replace-match "%3E" t t s)))
9825 (while (string-match "@" s)
9826 (setq s (replace-match "%40" t t s)))
9827 s)
9829 (defun org-link-prettify (link)
9830 "Return a human-readable representation of LINK.
9831 The car of LINK must be a raw link the cdr of LINK must be either
9832 a link description or nil."
9833 (let ((desc (or (cadr link) "<no description>")))
9834 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9835 "<" (car link) ">")))
9837 ;;;###autoload
9838 (defun org-insert-link-global ()
9839 "Insert a link like Org-mode does.
9840 This command can be called in any mode to insert a link in Org-mode syntax."
9841 (interactive)
9842 (org-load-modules-maybe)
9843 (org-run-like-in-org-mode 'org-insert-link))
9845 (defun org-insert-all-links (&optional keep)
9846 "Insert all links in `org-stored-links'."
9847 (interactive "P")
9848 (let ((links (copy-sequence org-stored-links)) l)
9849 (while (setq l (if keep (pop links) (pop org-stored-links)))
9850 (insert "- ")
9851 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9854 (defun org-link-fontify-links-to-this-file ()
9855 "Fontify links to the current file in `org-stored-links'."
9856 (let ((f (buffer-file-name)) a b)
9857 (setq a (mapcar (lambda(l)
9858 (let ((ll (car l)))
9860 (equal f (expand-file-name (match-string 1 ll))))
9861 ll)))
9862 org-stored-links))
9863 (when (featurep 'org-id)
9864 (setq b (mapcar (lambda(l)
9865 (let ((ll (car l)))
9867 (equal f (expand-file-name
9868 (or (org-id-find-id-file
9869 (match-string 1 ll)) ""))))
9870 ll)))
9871 org-stored-links)))
9872 (mapcar (lambda(l)
9873 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9874 (delq nil (append a b)))))
9876 (defvar org-link-links-in-this-file nil)
9877 (defun org-insert-link (&optional complete-file link-location default-description)
9878 "Insert a link. At the prompt, enter the link.
9880 Completion can be used to insert any of the link protocol prefixes like
9881 http or ftp in use.
9883 The history can be used to select a link previously stored with
9884 `org-store-link'. When the empty string is entered (i.e. if you just
9885 press RET at the prompt), the link defaults to the most recently
9886 stored link. As SPC triggers completion in the minibuffer, you need to
9887 use M-SPC or C-q SPC to force the insertion of a space character.
9889 You will also be prompted for a description, and if one is given, it will
9890 be displayed in the buffer instead of the link.
9892 If there is already a link at point, this command will allow you to edit link
9893 and description parts.
9896 be selected using completion. The path to the file will be relative to the
9897 current directory if the file is in the current directory or a subdirectory.
9898 Otherwise, the link will be the absolute path as completed in the minibuffer
9899 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9900 option `org-link-file-path-type'.
9903 the current directory or below.
9906 `org-keep-stored-link-after-insertion'.
9908 If `org-make-link-description-function' is non-nil, this function will be
9909 called with the link target, and the result will be the default
9910 link description.
9912 If the LINK-LOCATION parameter is non-nil, this value will be
9913 used as the link location instead of reading one interactively.
9915 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9916 be used as the default description."
9917 (interactive "P")
9918 (let* ((wcf (current-window-configuration))
9919 (origbuf (current-buffer))
9920 (region (if (org-region-active-p)
9921 (buffer-substring (region-beginning) (region-end))))
9922 (remove (and region (list (region-beginning) (region-end))))
9923 (desc region)
9924 tmphist ; byte-compile incorrectly complains about this
9925 (link link-location)
9926 (abbrevs org-link-abbrev-alist-local)
9927 entry file all-prefixes auto-desc)
9928 (cond
9929 (link-location) ; specified by arg, just use it.
9930 ((org-in-regexp org-bracket-link-regexp 1)
9931 ;; We do have a link at point, and we are going to edit it.
9932 (setq remove (list (match-beginning 0) (match-end 0)))
9933 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9934 (setq link (read-string "Link: "
9935 (org-link-unescape
9936 (org-match-string-no-properties 1)))))
9937 ((or (org-in-regexp org-angle-link-re)
9938 (org-in-regexp org-plain-link-re))
9939 ;; Convert to bracket link
9940 (setq remove (list (match-beginning 0) (match-end 0))
9941 link (read-string "Link: "
9942 (org-remove-angle-brackets (match-string 0)))))
9943 ((member complete-file '((4) (16)))
9944 ;; Completing read for file names.
9945 (setq link (org-file-complete-link complete-file)))
9946 (t
9947 ;; Read link, with completion for stored links.
9948 (org-link-fontify-links-to-this-file)
9949 (org-switch-to-buffer-other-window "*Org Links*")
9950 (with-current-buffer "*Org Links*"
9951 (erase-buffer)
9952 (insert "Insert a link.
9954 (when org-stored-links
9956 (insert (mapconcat 'org-link-prettify
9958 (goto-char (point-min)))
9959 (let ((cw (selected-window)))
9960 (select-window (get-buffer-window "*Org Links*" 'visible))
9961 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9962 (unless (pos-visible-in-window-p (point-max))
9963 (org-fit-window-to-buffer))
9964 (and (window-live-p cw) (select-window cw)))
9965 ;; Fake a link history, containing the stored links.
9966 (setq tmphist (append (mapcar 'car org-stored-links)
9967 org-insert-link-history))
9968 (setq all-prefixes (append (mapcar 'car abbrevs)
9969 (mapcar 'car org-link-abbrev-alist)
9970 org-link-types))
9971 (unwind-protect
9972 (progn
9973 (setq link
9974 (org-completing-read
9975 "Link: "
9976 (append
9977 (mapcar (lambda (x) (concat x ":"))
9978 all-prefixes)
9979 (mapcar 'car org-stored-links))
9980 nil nil nil
9981 'tmphist
9982 (caar org-stored-links)))
9984 (user-error "No link selected"))
9985 (mapc (lambda(l)
9986 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9987 org-stored-links)
9988 (if (or (member link all-prefixes)
9989 (and (equal ":" (substring link -1))
9990 (member (substring link 0 -1) all-prefixes)
9991 (setq link (substring link 0 -1))))
9992 (setq link (with-current-buffer origbuf
9993 (org-link-try-special-completion link)))))
9994 (set-window-configuration wcf)
9995 (kill-buffer "*Org Links*"))
9996 (setq entry (assoc link org-stored-links))
9997 (or entry (push link org-insert-link-history))
9998 (setq desc (or desc (nth 1 entry)))))
10000 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10001 (not org-keep-stored-link-after-insertion))
10002 (setq org-stored-links (delq (assoc link org-stored-links)
10003 org-stored-links)))
10005 (if (string-match org-plain-link-re link)
10006 ;; URL-like link, normalize the use of angular brackets.
10007 (setq link (org-remove-angle-brackets link)))
10009 ;; Check if we are linking to the current file with a search
10010 ;; option If yes, simplify the link by using only the search
10011 ;; option.
10012 (when (and buffer-file-name
10014 (let* ((path (match-string 1 link))
10015 (case-fold-search nil)
10016 (search (match-string 2 link)))
10017 (save-match-data
10018 (if (equal (file-truename buffer-file-name) (file-truename path))
10019 ;; We are linking to this same file, with a search option
10020 (setq link search)))))
10022 ;; Check if we can/should use a relative path. If yes, simplify the link
10024 (let* ((type (match-string 1 link))
10025 (path (match-string 2 link))
10026 (origpath path)
10027 (case-fold-search nil))
10028 (cond
10029 ((or (eq org-link-file-path-type 'absolute)
10030 (equal complete-file '(16)))
10031 (setq path (abbreviate-file-name (expand-file-name path))))
10032 ((eq org-link-file-path-type 'noabbrev)
10033 (setq path (expand-file-name path)))
10034 ((eq org-link-file-path-type 'relative)
10035 (setq path (file-relative-name path)))
10036 (t
10037 (save-match-data
10038 (if (string-match (concat "^" (regexp-quote
10039 (expand-file-name
10040 (file-name-as-directory
10041 default-directory))))
10042 (expand-file-name path))
10043 ;; We are linking a file with relative path name.
10044 (setq path (substring (expand-file-name path)
10045 (match-end 0)))
10046 (setq path (abbreviate-file-name (expand-file-name path)))))))
10047 (setq link (concat type path))
10048 (if (equal desc origpath)
10049 (setq desc path))))
10051 (if org-make-link-description-function
10052 (setq desc
10053 (or (condition-case nil
10054 (funcall org-make-link-description-function link desc)
10055 (error (progn (message "Can't get link description from `%s'"
10056 (symbol-name org-make-link-description-function))
10057 (sit-for 2) nil)))
10058 (read-string "Description: " default-description)))
10059 (if default-description (setq desc default-description)
10060 (setq desc (or (and auto-desc desc)
10061 (read-string "Description: " desc)))))
10064 (if remove (apply 'delete-region remove))
10065 (insert (org-make-link-string link desc))))
10067 (defun org-link-try-special-completion (type)
10068 "If there is completion support for link type TYPE, offer it."
10069 (let ((fun (intern (concat "org-" type "-complete-link"))))
10070 (if (functionp fun)
10071 (funcall fun)
10072 (read-string "Link (no completion support): " (concat type ":")))))
10074 (defun org-file-complete-link (&optional arg)
10075 "Create a file link using completion."
10076 (let (file link)
10077 (setq file (org-iread-file-name "File: "))
10078 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10079 (pwd1 (file-name-as-directory (abbreviate-file-name
10080 (expand-file-name ".")))))
10081 (cond
10082 ((equal arg '(16))
10083 (setq link (concat
10084 "file:"
10085 (abbreviate-file-name (expand-file-name file)))))
10087 (setq link (concat "file:" (match-string 1 file))))
10089 (expand-file-name file))
10090 (setq link (concat
10091 "file:" (match-string 1 (expand-file-name file)))))
10092 (t (setq link (concat "file:" file)))))
10093 link))
10095 (defun org-iread-file-name (&rest args)
10096 "Read-file-name using `ido-mode' speedup if available.
10097 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10098 See `read-file-name' for a description of parameters."
10099 (org-without-partial-completion
10100 (if (and org-completion-use-ido
10101 (fboundp 'ido-read-file-name)
10102 (boundp 'ido-mode) ido-mode
10103 (listp (second args)))
10104 (let ((ido-enter-matching-directory nil))
10105 (apply 'ido-read-file-name args))
10106 (apply 'read-file-name args))))
10108 (defun org-completing-read (&rest args)
10109 "Completing-read with SPACE being a normal character."
10110 (let ((enable-recursive-minibuffers t)
10111 (minibuffer-local-completion-map
10112 (copy-keymap minibuffer-local-completion-map)))
10113 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10114 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10115 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10116 (apply 'org-icompleting-read args)))
10118 (defun org-completing-read-no-i (&rest args)
10119 (let (org-completion-use-ido org-completion-use-iswitchb)
10120 (apply 'org-completing-read args)))
10122 (defun org-iswitchb-completing-read (prompt choices &rest args)
10123 "Use iswitch as a completing-read replacement to choose from choices.
10124 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10125 from."
10126 (let* ((iswitchb-use-virtual-buffers nil)
10127 (iswitchb-make-buflist-hook
10128 (lambda ()
10129 (setq iswitchb-temp-buflist choices))))
10130 (iswitchb-read-buffer prompt)))
10132 (defun org-icompleting-read (&rest args)
10133 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10134 (org-without-partial-completion
10135 (if (and org-completion-use-ido
10136 (fboundp 'ido-completing-read)
10137 (boundp 'ido-mode) ido-mode
10138 (listp (second args)))
10139 (let ((ido-enter-matching-directory nil))
10140 (apply 'ido-completing-read (concat (car args))
10141 (if (consp (car (nth 1 args)))
10142 (mapcar 'car (nth 1 args))
10143 (nth 1 args))
10144 (cddr args)))
10145 (if (and org-completion-use-iswitchb
10146 (boundp 'iswitchb-mode) iswitchb-mode
10147 (listp (second args)))
10148 (apply 'org-iswitchb-completing-read (concat (car args))
10149 (if (consp (car (nth 1 args)))
10150 (mapcar 'car (nth 1 args))
10151 (nth 1 args))
10152 (cddr args))
10153 (apply 'completing-read args)))))
10155 (defun org-extract-attributes (s)
10156 "Extract the attributes cookie from a string and set as text property."
10157 (let (a attr (start 0) key value)
10158 (save-match-data
10160 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10162 (setq key (match-string 1 a) value (match-string 2 a)
10163 start (match-end 0)
10164 attr (plist-put attr (intern key) value))))
10165 (org-add-props s nil 'org-attr attr))
10166 s))
10168 ;;; Opening/following a link
10170 (defvar org-link-search-failed nil)
10172 (defvar org-open-link-functions nil
10173 "Hook for functions finding a plain text link.
10174 These functions must take a single argument, the link content.
10175 They will be called for links that look like [[link text][description]]
10179 These functions will be called *before* Org attempts to resolve the
10180 link by doing text searches in the current buffer - so if you want a
10182 handle this as a special case.
10184 When the function does handle the link, it must return a non-nil value.
10185 If it decides that it is not responsible for this link, it must return
10186 nil to indicate that that Org-mode can continue with other options
10187 like exact and fuzzy text search.")
10189 (defun org-next-link (&optional search-backward)
10190 "Move forward to the next link.
10191 If the link is in hidden text, expose it."
10192 (interactive "P")
10193 (when (and org-link-search-failed (eq this-command last-command))
10194 (goto-char (point-min))
10195 (message "Link search wrapped back to beginning of buffer"))
10196 (setq org-link-search-failed nil)
10197 (let* ((pos (point))
10198 (ct (org-context))
10199 (a (assoc :link ct))
10200 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10201 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10202 ((looking-at org-any-link-re)
10203 ;; Don't stay stuck at link without an org-link face
10204 (forward-char (if search-backward -1 1))))
10205 (if (funcall srch-fun org-any-link-re nil t)
10206 (progn
10207 (goto-char (match-beginning 0))
10208 (if (outline-invisible-p) (org-show-context)))
10209 (goto-char pos)
10210 (setq org-link-search-failed t)
10211 (message "No further link found"))))
10213 (defun org-previous-link ()
10214 "Move backward to the previous link.
10215 If the link is in hidden text, expose it."
10216 (interactive)
10217 (funcall 'org-next-link t))
10219 (defun org-translate-link (s)
10220 "Translate a link string if a translation function has been defined."
10221 (if (and org-link-translation-function
10222 (fboundp org-link-translation-function)
10224 (progn
10225 (setq s (funcall org-link-translation-function
10226 (match-string 1 s) (match-string 2 s)))
10227 (concat (car s) ":" (cdr s)))
10228 s))
10230 (defun org-translate-link-from-planner (type path)
10231 "Translate a link from Emacs Planner syntax so that Org can follow it.
10232 This is still an experimental function, your mileage may vary."
10233 (cond
10234 ((member type '("http" "https" "news" "ftp"))
10235 ;; standard Internet links are the same.
10236 nil)
10237 ((and (equal type "irc") (string-match "^//" path))
10238 ;; Planner has two / at the beginning of an irc link, we have 1.
10239 ;; We should have zero, actually....
10240 (setq path (substring path 1)))
10241 ((and (equal type "lisp") (string-match "^/" path))
10242 ;; Planner has a slash, we do not.
10243 (setq type "elisp" path (substring path 1)))
10245 ;; A typical message link. Planner has the id after the final slash,
10246 ;; we separate it with a hash mark
10247 (setq path (concat (match-string 1 path) "#"
10248 (org-remove-angle-brackets (match-string 2 path))))))
10249 (cons type path))
10251 (defun org-find-file-at-mouse (ev)
10252 "Open file link or URL at mouse."
10253 (interactive "e")
10254 (mouse-set-point ev)
10255 (org-open-at-point 'in-emacs))
10257 (defun org-open-at-mouse (ev)
10258 "Open file link or URL at mouse.
10259 See the docstring of `org-open-file' for details."
10260 (interactive "e")
10261 (mouse-set-point ev)
10262 (if (eq major-mode 'org-agenda-mode)
10263 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10264 (org-open-at-point))
10266 (defvar org-window-config-before-follow-link nil
10267 "The window configuration before following a link.
10268 This is saved in case the need arises to restore it.")
10270 (defvar org-open-link-marker (make-marker)
10271 "Marker pointing to the location where `org-open-at-point; was called.")
10273 ;;;###autoload
10274 (defun org-open-at-point-global ()
10275 "Follow a link like Org-mode does.
10276 This command can be called in any mode to follow a link that has
10277 Org-mode syntax."
10278 (interactive)
10279 (org-run-like-in-org-mode 'org-open-at-point))
10281 ;;;###autoload
10282 (defun org-open-link-from-string (s &optional arg reference-buffer)
10283 "Open a link in the string S, as if it was in Org-mode."
10285 (let ((reference-buffer (or reference-buffer (current-buffer))))
10286 (with-temp-buffer
10287 (let ((org-inhibit-startup (not reference-buffer)))
10288 (org-mode)
10289 (insert s)
10290 (goto-char (point-min))
10291 (when reference-buffer
10292 (setq org-link-abbrev-alist-local
10293 (with-current-buffer reference-buffer
10294 org-link-abbrev-alist-local)))
10295 (org-open-at-point arg reference-buffer)))))
10297 (defvar org-open-at-point-functions nil
10298 "Hook that is run when following a link at point.
10300 Functions in this hook must return t if they identify and follow
10301 a link at point. If they don't find anything interesting at point,
10302 they must return nil.")
10304 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10305 (defun org-open-at-point (&optional arg reference-buffer)
10306 "Open link at or after point.
10307 If there is no link at point, this function will search forward up to
10308 the end of the current line.
10309 Normally, files will be opened by an appropriate application. If the
10310 optional prefix argument ARG is non-nil, Emacs will visit the file.
10311 With a double prefix argument, try to open outside of Emacs, in the
10312 application the system uses for this file type."
10313 (interactive "P")
10314 ;; if in a code block, then open the block's results
10315 (unless (call-interactively #'org-babel-open-src-block-result)
10316 (org-load-modules-maybe)
10317 (move-marker org-open-link-marker (point))
10318 (setq org-window-config-before-follow-link (current-window-configuration))
10319 (org-remove-occur-highlights nil nil t)
10320 (cond
10321 ((and (org-at-heading-p)
10322 (not (org-at-timestamp-p t))
10323 (not (org-in-regexp
10328 (not (get-text-property (point) 'org-linked-text)))
10329 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10330 (lk0 (car lkall))
10331 (lk (if (stringp lk0) (list lk0) lk0))
10332 (lkend (cdr lkall)))
10333 (mapcar (lambda(l)
10334 (search-forward l nil lkend)
10335 (goto-char (match-beginning 0))
10336 (org-open-at-point))
10337 lk))
10338 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10339 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10340 ((and (org-at-timestamp-p t)
10341 (not (org-in-regexp org-bracket-link-regexp)))
10342 (org-follow-timestamp-link))
10343 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10344 (not (org-in-regexp org-any-link-re)))
10345 (org-footnote-action))
10346 (t
10347 (let (type path link line search (pos (point)))
10348 (catch 'match
10349 (save-excursion
10351 (when (org-in-regexp org-bracket-link-regexp 1)
10352 (setq link (org-extract-attributes
10353 (org-link-unescape (org-match-string-no-properties 1))))
10355 (setq link (replace-match " " t t link)))
10356 (setq link (org-link-expand-abbrev link))
10357 (cond
10358 ((or (file-name-absolute-p link)
10360 (setq type "file" path link))
10361 ((string-match org-link-re-with-space3 link)
10362 (setq type (match-string 1 link) path (match-string 2 link)))
10364 (setq type "help" path (match-string 1 link)))
10365 (t (setq type "thisfile" path link)))
10366 (throw 'match t)))
10368 (when (get-text-property (point) 'org-linked-text)
10369 (setq type "thisfile"
10370 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10371 (1+ (point)) (point))
10372 path (buffer-substring
10373 (or (previous-single-property-change pos 'org-linked-text)
10374 (point-min))
10375 (or (next-single-property-change pos 'org-linked-text)
10376 (point-max)))
10377 ;; Ensure we will search for a <<<radio>>> link, not
10378 ;; a simple reference like <<ref>>
10379 path (concat "<" path))
10380 (throw 'match t))
10382 (save-excursion
10383 (when (or (org-in-regexp org-angle-link-re)
10384 (let ((match (org-in-regexp org-plain-link-re)))
10385 ;; Check a plain link is not within a bracket link
10386 (and match
10387 (save-excursion
10388 (progn
10389 (goto-char (car match))
10390 (not (org-in-regexp org-bracket-link-regexp))))))
10391 (let ((line_ending (save-excursion (end-of-line) (point))))
10392 ;; We are in a line before a plain or bracket link
10393 (or (re-search-forward org-plain-link-re line_ending t)
10394 (re-search-forward org-bracket-link-regexp line_ending t))))
10395 (setq type (match-string 1)
10396 path (org-link-unescape (match-string 2)))
10397 (throw 'match t)))
10398 (save-excursion
10400 (setq type "tags"
10401 path (match-string 1))
10402 (while (string-match ":" path)
10403 (setq path (replace-match "+" t t path)))
10404 (throw 'match t)))
10406 (setq type "tree-match"
10407 path (match-string 1))
10408 (throw 'match t)))
10409 (unless path
10410 (user-error "No link found"))
10412 ;; switch back to reference buffer
10413 ;; needed when if called in a temporary buffer through
10414 ;; org-open-link-from-string
10415 (with-current-buffer (or reference-buffer (current-buffer))
10417 ;; Remove any trailing spaces in path
10419 (setq path (replace-match "" t t path)))
10420 (if (and org-link-translation-function
10421 (fboundp org-link-translation-function))
10422 ;; Check if we need to translate the link
10423 (let ((tmp (funcall org-link-translation-function type path)))
10424 (setq type (car tmp) path (cdr tmp))))
10426 (cond
10428 ((assoc type org-link-protocols)
10429 (funcall (nth 1 (assoc type org-link-protocols)) path))
10431 ((equal type "help")
10432 (let ((f-or-v (intern path)))
10433 (cond ((fboundp f-or-v)
10434 (describe-function f-or-v))
10435 ((boundp f-or-v)
10436 (describe-variable f-or-v))
10437 (t (error "Not a known function or variable")))))
10439 ((equal type "mailto")
10440 (let ((cmd (car org-link-mailto-program))
10441 (args (cdr org-link-mailto-program)) args1
10442 (address path) (subject "") a)
10444 (setq address (match-string 1 path)
10445 subject (org-link-escape (match-string 2 path))))
10446 (while args
10447 (cond
10448 ((not (stringp (car args))) (push (pop args) args1))
10449 (t (setq a (pop args))
10450 (if (string-match "%a" a)
10451 (setq a (replace-match address t t a)))
10452 (if (string-match "%s" a)
10453 (setq a (replace-match subject t t a)))
10454 (push a args1))))
10455 (apply cmd (nreverse args1))))
10457 ((member type '("http" "https" "ftp" "news"))
10458 (browse-url
10459 (concat type ":"
10460 (if (org-string-match-p
10461 (concat "[[:nonascii:]"
10462 org-link-escape-chars-browser "]")
10463 path)
10464 (org-link-escape path org-link-escape-chars-browser)
10465 path))))
10467 ((string= type "doi")
10468 (browse-url
10469 (concat org-doi-server-url
10470 (if (org-string-match-p
10471 (concat "[[:nonascii:]"
10472 org-link-escape-chars-browser "]")
10473 path)
10474 (org-link-escape path org-link-escape-chars-browser)
10475 path))))
10477 ((member type '("message"))
10478 (browse-url (concat type ":" path)))
10480 ((string= type "tags")
10481 (org-tags-view arg path))
10483 ((string= type "tree-match")
10486 ((string= type "file")
10488 (setq line (string-to-number (match-string 1 path))
10489 path (substring path 0 (match-beginning 0)))
10491 (setq search (match-string 1 path)
10492 path (substring path 0 (match-beginning 0)))))
10493 (if (string-match "[*?{]" (file-name-nondirectory path))
10494 (dired path)
10495 (org-open-file path arg line search)))
10497 ((string= type "shell")
10498 (let ((buf (generate-new-buffer "*Org Shell Output"))
10499 (cmd path))
10500 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10501 (string-match org-confirm-shell-link-not-regexp cmd))
10502 (not org-confirm-shell-link-function)
10503 (funcall org-confirm-shell-link-function
10505 (org-add-props cmd nil
10506 'face 'org-warning))))
10507 (progn
10508 (message "Executing %s" cmd)
10509 (shell-command cmd buf)
10510 (if (featurep 'midnight)
10511 (setq clean-buffer-list-kill-buffer-names
10512 (cons buf clean-buffer-list-kill-buffer-names))))
10513 (error "Abort"))))
10515 ((string= type "elisp")
10516 (let ((cmd path))
10517 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10518 (string-match org-confirm-elisp-link-not-regexp cmd))
10519 (not org-confirm-elisp-link-function)
10520 (funcall org-confirm-elisp-link-function
10522 (org-add-props cmd nil
10523 'face 'org-warning))))
10524 (message "%s => %s" cmd
10525 (if (equal (string-to-char cmd) ?\()
10526 (eval (read cmd))
10527 (call-interactively (read cmd))))
10528 (error "Abort"))))
10530 ((and (string= type "thisfile")
10531 (run-hook-with-args-until-success
10532 'org-open-link-functions path)))
10534 ((string= type "thisfile")
10535 (if arg
10536 (switch-to-buffer-other-window
10537 (org-get-buffer-for-internal-link (current-buffer)))
10538 (org-mark-ring-push))
10539 (let ((cmd `(org-link-search
10540 ,path
10541 ,(cond ((equal arg '(4)) ''occur)
10542 ((equal arg '(16)) ''org-occur))
10543 ,pos)))
10544 (condition-case nil (let ((org-link-search-inhibit-query t))
10545 (eval cmd))
10546 (error (progn (widen) (eval cmd))))))
10548 (t (browse-url-at-point)))))))
10549 (move-marker org-open-link-marker nil)
10550 (run-hook-with-args 'org-follow-link-hook)))
10552 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10553 "Offer links in the current entry and return the selected link.
10554 If there is only one link, return it.
10555 If NTH is an integer, return the NTH link found.
10556 If ZERO is a string, check also this string for a link, and if
10557 there is one, return it."
10558 (with-current-buffer buffer
10559 (save-excursion
10560 (save-restriction
10561 (widen)
10562 (goto-char marker)
10566 (cnt ?0)
10567 (in-emacs (if (integerp nth) nil nth))
10568 have-zero end links link c)
10569 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10570 (push (match-string 0 zero) links)
10571 (setq cnt (1- cnt) have-zero t))
10572 (save-excursion
10573 (org-back-to-heading t)
10574 (setq end (save-excursion (outline-next-heading) (point)))
10575 (while (re-search-forward re end t)
10576 (push (match-string 0) links))
10577 (setq links (org-uniquify (reverse links))))
10578 (cond
10579 ((null links)
10580 (message "No links"))
10581 ((equal (length links) 1)
10582 (setq link (car links)))
10583 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10584 (setq link (nth (if have-zero nth (1- nth)) links)))
10585 (t ; we have to select a link
10586 (save-excursion
10587 (save-window-excursion
10588 (delete-other-windows)
10589 (with-output-to-temp-buffer "*Select Link*"
10590 (mapc (lambda (l)
10591 (if (not (string-match org-bracket-link-regexp l))
10593 (org-remove-angle-brackets l)))
10594 (if (match-end 3)
10596 (match-string 3 l) (match-string 1 l)))
10598 (match-string 1 l))))))
10599 links))
10600 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10601 (message "Select link to open, RET to open all:")
10602 (setq c (read-char-exclusive))
10603 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10604 (when (equal c ?q) (error "Abort"))
10605 (if (equal c ?\C-m)
10606 (setq link links)
10607 (setq nth (- c ?0))
10608 (if have-zero (setq nth (1+ nth)))
10609 (unless (and (integerp nth) (>= (length links) nth))
10610 (user-error "Invalid link selection"))
10611 (setq link (nth (1- nth) links)))))
10612 (cons link end))))))
10614 ;; Add special file links that specify the way of opening
10616 (org-add-link-type "file+sys" 'org-open-file-with-system)
10617 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10618 (defun org-open-file-with-system (path)
10619 "Open file at PATH using the system way of opening it."
10620 (org-open-file path 'system))
10621 (defun org-open-file-with-emacs (path)
10622 "Open file at PATH in Emacs."
10623 (org-open-file path 'emacs))
10626 ;;; File search
10628 (defvar org-create-file-search-functions nil
10629 "List of functions to construct the right search string for a file link.
10630 These functions are called in turn with point at the location to
10631 which the link should point.
10633 A function in the hook should first test if it would like to
10634 handle this file type, for example by checking the `major-mode'
10635 or the file extension. If it decides not to handle this file, it
10636 should just return nil to give other functions a chance. If it
10637 does handle the file, it must return the search string to be used
10638 when following the link. The search string will be part of the
10639 file link, given after a double colon, and `org-open-at-point'
10640 will automatically search for it. If special measures must be
10641 taken to make the search successful, another function should be
10642 added to the companion hook `org-execute-file-search-functions',
10643 which see.
10645 A function in this hook may also use `setq' to set the variable
10646 `description' to provide a suggestion for the descriptive text to
10647 be used for this link when it gets inserted into an Org-mode
10650 (defvar org-execute-file-search-functions nil
10651 "List of functions to execute a file search triggered by a link.
10653 Functions added to this hook must accept a single argument, the
10654 search string that was part of the file link, the part after the
10655 double colon. The function must first check if it would like to
10656 handle this search, for example by checking the `major-mode' or
10657 the file extension. If it decides not to handle this search, it
10658 should just return nil to give other functions a chance. If it
10659 does handle the search, it must return a non-nil value to keep
10660 other functions from trying.
10662 Each function can access the current prefix argument through the
10663 variable `current-prefix-arg'. Note that a single prefix is used
10664 to force opening a link in Emacs, so it may be good to only use a
10665 numeric or double prefix to guide the search function.
10667 In case this is needed, a function in this hook can also restore
10668 the window configuration before `org-open-at-point' was called using:
10670 (set-window-configuration org-window-config-before-follow-link)")
10672 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10673 (defun org-link-search (s &optional type avoid-pos stealth)
10674 "Search for a link search option.
10675 If S is surrounded by forward slashes, it is interpreted as a
10676 regular expression. In org-mode files, this will create an `org-occur'
10677 sparse tree. In ordinary files, `occur' will be used to list matches.
10678 If the current buffer is in `dired-mode', grep will be used to search
10679 in all files. If AVOID-POS is given, ignore matches near that position.
10681 When optional argument STEALTH is non-nil, do not modify
10682 visibility around point, thus ignoring
10683 `org-show-hierarchy-above', `org-show-following-heading' and
10684 `org-show-siblings' variables."
10685 (let ((case-fold-search t)
10689 org-emphasis-alist)
10691 (pos (point))
10692 (pre nil) (post nil)
10693 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10694 (cond
10695 ;; First check if there are any special search functions
10696 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10697 ;; Now try the builtin stuff
10698 ((and (equal (string-to-char s0) ?#)
10699 (> (length s0) 1)
10700 (save-excursion
10701 (goto-char (point-min))
10702 (and
10703 (re-search-forward
10706 (setq type 'dedicated
10707 pos (match-beginning 0))))
10708 ;; There is an exact target for this
10709 (goto-char pos)
10710 (org-back-to-heading t)))
10711 ((save-excursion
10712 (goto-char (point-min))
10713 (and
10714 (re-search-forward
10715 (concat "<<" (regexp-quote s0) ">>") nil t)
10716 (setq type 'dedicated
10717 pos (match-beginning 0))))
10718 ;; There is an exact target for this
10719 (goto-char pos))
10720 ((save-excursion
10721 (goto-char (point-min))
10722 (and
10723 (re-search-forward
10725 (setq type 'dedicated pos (match-beginning 0))))
10726 ;; Found an element with a matching #+name affiliated keyword.
10727 (goto-char pos))
10729 (save-excursion
10730 (goto-char (point-min))
10731 (and
10732 (re-search-forward
10733 (concat "[^[]" (regexp-quote
10734 (format org-coderef-label-format
10735 (match-string 1 s0))))
10736 nil t)
10737 (setq type 'dedicated
10738 pos (1+ (match-beginning 0))))))
10739 ;; There is a coderef target for this
10740 (goto-char pos))
10742 ;; A regular expression
10743 (cond
10744 ((derived-mode-p 'org-mode)
10745 (org-occur (match-string 1 s)))
10746 (t (org-do-occur (match-string 1 s)))))
10747 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10748 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10749 (goto-char (point-min))
10750 (cond
10751 ((let (case-fold-search)
10752 (re-search-forward (format org-complex-heading-regexp-format
10753 (regexp-quote s))
10754 nil t))
10755 ;; OK, found a match
10756 (setq type 'dedicated)
10757 (goto-char (match-beginning 0)))
10758 ((and (not org-link-search-inhibit-query)
10759 (eq org-link-search-must-match-exact-headline 'query-to-create)
10760 (y-or-n-p "No match - create this as a new heading? "))
10761 (goto-char (point-max))
10762 (or (bolp) (newline))
10764 (beginning-of-line 0))
10765 (t
10766 (goto-char pos)
10767 (error "No match"))))
10768 (t
10769 ;; A normal search string
10770 (when (equal (string-to-char s) ?*)
10771 ;; Anchor on headlines, post may include tags.
10774 s (substring s 1)))
10775 (remove-text-properties
10776 0 (length s)
10777 '(face nil mouse-face nil keymap nil fontified nil) s)
10778 ;; Make a series of regular expressions to find a match
10789 re4 (concat "[^a-zA-Z_]" re4_)
10791 re1 (concat pre re2 post)
10792 re3 (concat pre (if pre re4_ re4) post)
10793 re5 (concat pre ".*" re4)
10794 re2 (concat pre re2)
10795 re2a (concat pre (if pre re2a_ re2a))
10796 re4 (concat pre (if pre re4_ re4))
10800 (cond
10801 ((eq type 'org-occur) (org-occur reall))
10802 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10803 (t (goto-char (point-min))
10804 (setq type 'fuzzy)
10805 (if (or (and (org-search-not-self 1 re0 nil t)
10806 (setq type 'dedicated))
10807 (org-search-not-self 1 re1 nil t)
10808 (org-search-not-self 1 re2 nil t)
10809 (org-search-not-self 1 re2a nil t)
10810 (org-search-not-self 1 re3 nil t)
10811 (org-search-not-self 1 re4 nil t)
10812 (org-search-not-self 1 re5 nil t))
10813 (goto-char (match-beginning 1))
10814 (goto-char pos)
10815 (error "No match"))))))
10816 (and (derived-mode-p 'org-mode)
10817 (not stealth)
10818 (org-show-context 'link-search))
10819 type))
10821 (defun org-search-not-self (group &rest args)
10822 "Execute `re-search-forward', but only accept matches that do not
10823 enclose the position of `org-open-link-marker'."
10824 (let ((m org-open-link-marker))
10825 (catch 'exit
10826 (while (apply 're-search-forward args)
10827 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10828 (goto-char (match-end group))
10829 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10830 (> (match-beginning 0) (marker-position m))
10831 (< (match-end 0) (marker-position m)))
10832 (save-match-data
10833 (or (not (org-in-regexp
10834 org-bracket-link-analytic-regexp 1))
10835 (not (match-end 4)) ; no description
10836 (and (<= (match-beginning 4) (point))
10837 (>= (match-end 4) (point))))))
10838 (throw 'exit (point))))))))
10840 (defun org-get-buffer-for-internal-link (buffer)
10841 "Return a buffer to be used for displaying the link target of internal links."
10842 (cond
10843 ((not org-display-internal-link-with-indirect-buffer)
10844 buffer)
10845 ((string-match "(Clone)$" (buffer-name buffer))
10846 (message "Buffer is already a clone, not making another one")
10847 ;; we also do not modify visibility in this case
10848 buffer)
10849 (t ; make a new indirect buffer for displaying the link
10850 (let* ((bn (buffer-name buffer))
10851 (ibn (concat bn "(Clone)"))
10852 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10853 (with-current-buffer ib (org-overview))
10854 ib))))
10856 (defun org-do-occur (regexp &optional cleanup)
10857 "Call the Emacs command `occur'.
10858 If CLEANUP is non-nil, remove the printout of the regular expression
10859 in the *Occur* buffer. This is useful if the regex is long and not useful
10860 to read."
10861 (occur regexp)
10862 (when cleanup
10863 (let ((cwin (selected-window)) win beg end)
10864 (when (setq win (get-buffer-window "*Occur*"))
10865 (select-window win))
10866 (goto-char (point-min))
10867 (when (re-search-forward "match[a-z]+" nil t)
10868 (setq beg (match-end 0))
10870 (setq end (1- (match-beginning 0)))))
10871 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10872 (goto-char (point-min))
10873 (select-window cwin))))
10875 ;;; The mark ring for links jumps
10877 (defvar org-mark-ring nil
10878 "Mark ring for positions before jumps in Org-mode.")
10879 (defvar org-mark-ring-last-goto nil
10880 "Last position in the mark ring used to go back.")
10881 ;; Fill and close the ring
10882 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10883 (loop for i from 1 to org-mark-ring-length do
10884 (push (make-marker) org-mark-ring))
10885 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10886 org-mark-ring)
10888 (defun org-mark-ring-push (&optional pos buffer)
10889 "Put the current position or POS into the mark ring and rotate it."
10890 (interactive)
10891 (setq pos (or pos (point)))
10892 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10893 (move-marker (car org-mark-ring)
10894 (or pos (point))
10895 (or buffer (current-buffer)))
10896 (message "%s"
10897 (substitute-command-keys
10900 (defun org-mark-ring-goto (&optional n)
10901 "Jump to the previous position in the mark ring.
10902 With prefix arg N, jump back that many stored positions. When
10903 called several times in succession, walk through the entire ring.
10904 Org-mode commands jumping to a different position in the current file,
10905 or to another Org-mode file, automatically push the old position
10906 onto the ring."
10907 (interactive "p")
10908 (let (p m)
10909 (if (eq last-command this-command)
10910 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10911 (setq p org-mark-ring))
10912 (setq org-mark-ring-last-goto p)
10913 (setq m (car p))
10914 (org-pop-to-buffer-same-window (marker-buffer m))
10915 (goto-char m)
10916 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10918 (defun org-remove-angle-brackets (s)
10919 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10920 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10921 s)
10922 (defun org-add-angle-brackets (s)
10923 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10924 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10925 s)
10926 (defun org-remove-double-quotes (s)
10929 s)
10931 ;;; Following specific links
10933 (defun org-follow-timestamp-link ()
10934 "Open an agenda view for the time-stamp date/range at point."
10935 (cond
10936 ((org-at-date-range-p t)
10937 (let ((org-agenda-start-on-weekday)
10938 (t1 (match-string 1))
10939 (t2 (match-string 2)) tt1 tt2)
10940 (setq tt1 (time-to-days (org-time-string-to-time t1))
10941 tt2 (time-to-days (org-time-string-to-time t2)))
10942 (let ((org-agenda-buffer-tmp-name
10943 (format "*Org Agenda(a:%s)"
10944 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10945 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10946 ((org-at-timestamp-p t)
10947 (let ((org-agenda-buffer-tmp-name
10948 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10949 (org-agenda-list nil (time-to-days (org-time-string-to-time
10950 (substring (match-string 1) 0 10)))
10951 1)))
10952 (t (error "This should not happen"))))
10955 ;;; Following file links
10956 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10957 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10958 (declare-function mailcap-mime-info
10959 "mailcap" (string &optional request no-decode))
10960 (defvar org-wait nil)
10961 (defun org-open-file (path &optional in-emacs line search)
10962 "Open the file at PATH.
10963 First, this expands any special file name abbreviations. Then the
10964 configuration variable `org-file-apps' is checked if it contains an
10965 entry for this file type, and if yes, the corresponding command is launched.
10967 If no application is found, Emacs simply visits the file.
10969 With optional prefix argument IN-EMACS, Emacs will visit the file.
10971 prefix arg, Org tries to avoid opening in Emacs
10972 and to use an external application to visit the file.
10974 Optional LINE specifies a line to go to, optional SEARCH a string
10975 to search for. If LINE or SEARCH is given, the file will be
10976 opened in Emacs, unless an entry from org-file-apps that makes
10977 use of groups in a regexp matches.
10979 If you want to change the way frames are used when following a
10980 link, please customize `org-link-frame-setup'.
10982 If the file does not exist, an error is thrown."
10983 (let* ((file (if (equal path "")
10984 buffer-file-name
10985 (substitute-in-file-name (expand-file-name path))))
10986 (file-apps (append org-file-apps (org-default-apps)))
10987 (apps (org-remove-if
10988 'org-file-apps-entry-match-against-dlink-p file-apps))
10989 (apps-dlink (org-remove-if-not
10990 'org-file-apps-entry-match-against-dlink-p file-apps))
10991 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10992 (dirp (if remp nil (file-directory-p file)))
10993 (file (if (and dirp org-open-directory-means-index-dot-org)
10994 (concat (file-name-as-directory file) "index.org")
10995 file))
10996 (a-m-a-p (assq 'auto-mode apps))
10997 (dfile (downcase file))
10998 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10999 (link (cond ((and (eq line nil)
11000 (eq search nil))
11001 file)
11002 (line
11003 (concat file "::" (number-to-string line)))
11004 (search
11005 (concat file "::" search))))
11006 (dlink (downcase link))
11007 (old-buffer (current-buffer))
11008 (old-pos (point))
11009 (old-mode major-mode)
11010 ext cmd link-match-data)
11012 (setq ext (match-string 1 dfile))
11014 (setq ext (match-string 1 dfile))))
11015 (cond
11016 ((member in-emacs '((16) system))
11017 (setq cmd (cdr (assoc 'system apps))))
11018 (in-emacs (setq cmd 'emacs))
11019 (t
11020 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11021 (and dirp (cdr (assoc 'directory apps)))
11022 ; first, try matching against apps-dlink
11023 ; if we get a match here, store the match data for later
11024 (let ((match (assoc-default dlink apps-dlink
11025 'string-match)))
11026 (if match
11027 (progn (setq link-match-data (match-data))
11028 match)
11029 (progn (setq in-emacs (or in-emacs line search))
11030 nil))) ; if we have no match in apps-dlink,
11031 ; always open the file in emacs if line or search
11032 ; is given (for backwards compatibility)
11033 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11034 'string-match)
11035 (cdr (assoc ext apps))
11036 (cdr (assoc t apps))))))
11037 (when (eq cmd 'system)
11038 (setq cmd (cdr (assoc 'system apps))))
11039 (when (eq cmd 'default)
11040 (setq cmd (cdr (assoc t apps))))
11041 (when (eq cmd 'mailcap)
11042 (require 'mailcap)
11043 (mailcap-parse-mailcaps)
11044 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11045 (command (mailcap-mime-info mime-type)))
11046 (if (stringp command)
11047 (setq cmd command)
11048 (setq cmd 'emacs))))
11049 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11050 (not (file-exists-p file))
11051 (not org-open-non-existing-files))
11052 (user-error "No such file: %s" file))
11053 (cond
11055 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11057 (setq cmd (replace-match "%s" t t cmd)))
11058 (while (string-match "%s" cmd)
11059 (setq cmd (replace-match
11060 (save-match-data
11061 (shell-quote-argument
11062 (convert-standard-filename file)))
11063 t t cmd)))
11065 ;; Replace "%1", "%2" etc. in command with group matches from regex
11066 (save-match-data
11067 (let ((match-index 1)
11068 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11069 (set-match-data link-match-data)
11070 (while (<= match-index number-of-groups)
11071 (let ((regex (concat "%" (number-to-string match-index)))
11072 (replace-with (match-string match-index dlink)))
11073 (while (string-match regex cmd)
11074 (setq cmd (replace-match replace-with t t cmd))))
11075 (setq match-index (+ match-index 1)))))
11077 (save-window-excursion
11078 (message "Running %s...done" cmd)
11079 (start-process-shell-command cmd nil cmd)
11080 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11081 ((or (stringp cmd)
11082 (eq cmd 'emacs))
11083 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11084 (widen)
11085 (if line (org-goto-line line)
11086 (if search (org-link-search search))))
11087 ((consp cmd)
11088 (let ((file (convert-standard-filename file)))
11089 (save-match-data
11090 (set-match-data link-match-data)
11091 (eval cmd))))
11092 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11093 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11094 (or (not (equal old-buffer (current-buffer)))
11095 (not (equal old-pos (point))))
11096 (org-mark-ring-push old-pos old-buffer))))
11098 (defun org-file-apps-entry-match-against-dlink-p (entry)
11099 "This function returns non-nil if `entry' uses a regular
11100 expression which should be matched against the whole link by
11101 org-open-file.
11103 It assumes that is the case when the entry uses a regular
11104 expression which has at least one grouping construct and the
11105 action is either a lisp form or a command string containing
11106 '%1', i.e. using at least one subexpression match as a
11107 parameter."
11108 (let ((selector (car entry))
11109 (action (cdr entry)))
11110 (if (stringp selector)
11111 (and (> (regexp-opt-depth selector) 0)
11112 (or (and (stringp action)
11113 (string-match "%[0-9]" action))
11114 (consp action)))
11115 nil)))
11117 (defun org-default-apps ()
11118 "Return the default applications for this operating system."
11119 (cond
11120 ((eq system-type 'darwin)
11121 org-file-apps-defaults-macosx)
11122 ((eq system-type 'windows-nt)
11123 org-file-apps-defaults-windowsnt)
11124 (t org-file-apps-defaults-gnu)))
11126 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11127 "Convert extensions to regular expressions in the cars of LIST.
11128 Also, weed out any non-string entries, because the return value is used
11129 only for regexp matching.
11130 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11131 point to the symbol `emacs', indicating that the file should
11132 be opened in Emacs."
11133 (append
11134 (delq nil
11135 (mapcar (lambda (x)
11136 (if (not (stringp (car x)))
11137 nil
11139 x
11141 list))
11142 (if add-auto-mode
11143 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11145 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11146 (defun org-file-remote-p (file)
11147 "Test whether FILE specifies a location on a remote system.
11148 Return non-nil if the location is indeed remote.
11152 (cond ((fboundp 'file-remote-p)
11153 (file-remote-p file))
11154 ((fboundp 'tramp-handle-file-remote-p)
11155 (tramp-handle-file-remote-p file))
11156 ((and (boundp 'ange-ftp-name-format)
11157 (string-match (car ange-ftp-name-format) file))
11158 t)))
11161 ;;;; Refiling
11163 (defun org-get-org-file ()
11164 "Read a filename, with default directory `org-directory'."
11165 (let ((default (or org-default-notes-file remember-data-file)))
11166 (read-file-name (format "File name [%s]: " default)
11167 (file-name-as-directory org-directory)
11168 default)))
11170 (defun org-notes-order-reversed-p ()
11171 "Check if the current file should receive notes in reversed order."
11172 (cond
11173 ((not org-reverse-note-order) nil)
11174 ((eq t org-reverse-note-order) t)
11175 ((not (listp org-reverse-note-order)) nil)
11176 (t (catch 'exit
11177 (let ((all org-reverse-note-order)
11178 entry)
11179 (while (setq entry (pop all))
11180 (if (string-match (car entry) buffer-file-name)
11181 (throw 'exit (cdr entry))))
11182 nil)))))
11184 (defvar org-refile-target-table nil
11185 "The list of refile targets, created by `org-refile'.")
11187 (defvar org-agenda-new-buffers nil
11188 "Buffers created to visit agenda files.")
11190 (defvar org-refile-cache nil
11191 "Cache for refile targets.")
11193 (defvar org-refile-markers nil
11194 "All the markers used for caching refile locations.")
11196 (defun org-refile-marker (pos)
11197 "Get a new refile marker, but only if caching is in use."
11198 (if (not org-refile-use-cache)
11199 pos
11200 (let ((m (make-marker)))
11201 (move-marker m pos)
11202 (push m org-refile-markers)
11203 m)))
11205 (defun org-refile-cache-clear ()
11206 "Clear the refile cache and disable all the markers."
11207 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11208 (setq org-refile-markers nil)
11209 (setq org-refile-cache nil)
11210 (message "Refile cache has been cleared"))
11212 (defun org-refile-cache-check-set (set)
11213 "Check if all the markers in the cache still have live buffers."
11214 (let (marker)
11215 (catch 'exit
11216 (while (and set (setq marker (nth 3 (pop set))))
11217 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11218 (when (and marker (null (marker-buffer marker)))
11219 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11220 (sit-for 3)
11221 (throw 'exit nil)))
11222 t)))
11224 (defun org-refile-cache-put (set &rest identifiers)
11225 "Push the refile targets SET into the cache, under IDENTIFIERS."
11226 (let* ((key (sha1 (prin1-to-string identifiers)))
11227 (entry (assoc key org-refile-cache)))
11228 (if entry
11229 (setcdr entry set)
11230 (push (cons key set) org-refile-cache))))
11232 (defun org-refile-cache-get (&rest identifiers)
11233 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11234 (cond
11235 ((not org-refile-cache) nil)
11236 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11237 (t
11238 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11239 org-refile-cache))))
11240 (and set (org-refile-cache-check-set set) set)))))
11242 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11243 "Produce a table with refile targets."
11244 (let ((case-fold-search nil)
11245 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11246 (entries (or org-refile-targets '((nil . (:level . 1)))))
11247 targets tgs txt re files f desc descre fast-path-p level pos0)
11248 (message "Getting targets...")
11249 (with-current-buffer (or default-buffer (current-buffer))
11250 (while (setq entry (pop entries))
11251 (setq files (car entry) desc (cdr entry))
11252 (setq fast-path-p nil)
11253 (cond
11254 ((null files) (setq files (list (current-buffer))))
11255 ((eq files 'org-agenda-files)
11256 (setq files (org-agenda-files 'unrestricted)))
11257 ((and (symbolp files) (fboundp files))
11258 (setq files (funcall files)))
11259 ((and (symbolp files) (boundp files))
11260 (setq files (symbol-value files))))
11261 (if (stringp files) (setq files (list files)))
11262 (cond
11263 ((eq (car desc) :tag)
11265 ((eq (car desc) :todo)
11267 ((eq (car desc) :regexp)
11268 (setq descre (cdr desc)))
11269 ((eq (car desc) :level)
11271 (if org-odd-levels-only
11272 (1- (* 2 (cdr desc)))
11273 (cdr desc)))
11275 ((eq (car desc) :maxlevel)
11276 (setq fast-path-p t)
11278 (if org-odd-levels-only
11279 (1- (* 2 (cdr desc)))
11280 (cdr desc)))
11282 (t (error "Bad refiling target description %s" desc)))
11283 (while (setq f (pop files))
11284 (with-current-buffer
11285 (if (bufferp f) f (org-get-agenda-file-buffer f))
11286 (or
11287 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11288 (progn
11289 (if (bufferp f) (setq f (buffer-file-name
11290 (buffer-base-buffer f))))
11291 (setq f (and f (expand-file-name f)))
11292 (if (eq org-refile-use-outline-path 'file)
11293 (push (list (file-name-nondirectory f) f nil nil) tgs))
11294 (save-excursion
11295 (save-restriction
11296 (widen)
11297 (goto-char (point-min))
11298 (while (re-search-forward descre nil t)
11299 (goto-char (setq pos0 (point-at-bol)))
11300 (catch 'next
11301 (when org-refile-target-verify-function
11302 (save-match-data
11303 (or (funcall org-refile-target-verify-function)
11304 (throw 'next t))))
11305 (when (and (looking-at org-complex-heading-regexp)
11306 (not (member (match-string 4) excluded-entries))
11307 (match-string 4))
11308 (setq level (org-reduced-level
11309 (- (match-end 1) (match-beginning 1)))
11310 txt (org-link-display-format (match-string 4))
11312 re (format org-complex-heading-regexp-format
11313 (regexp-quote (match-string 4))))
11314 (when org-refile-use-outline-path
11315 (setq txt (mapconcat
11316 'org-protect-slash
11317 (append
11318 (if (eq org-refile-use-outline-path
11319 'file)
11320 (list (file-name-nondirectory
11321 (buffer-file-name
11322 (buffer-base-buffer))))
11323 (if (eq org-refile-use-outline-path
11324 'full-file-path)
11325 (list (buffer-file-name
11326 (buffer-base-buffer)))))
11327 (org-get-outline-path fast-path-p
11328 level txt)
11329 (list txt))
11330 "/")))
11331 (push (list txt f re (org-refile-marker (point)))
11332 tgs)))
11333 (when (= (point) pos0)
11334 ;; verification function has not moved point
11335 (goto-char (point-at-eol))))))))
11336 (when org-refile-use-cache
11337 (org-refile-cache-put tgs (buffer-file-name) descre))
11338 (setq targets (append tgs targets))))))
11339 (message "Getting targets...done")
11340 (nreverse targets)))
11342 (defun org-protect-slash (s)
11343 (while (string-match "/" s)
11345 s)
11347 (defvar org-olpa (make-vector 20 nil))
11349 (defun org-get-outline-path (&optional fastp level heading)
11350 "Return the outline path to the current entry, as a list.
11352 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11353 routine which makes outline path derivations for an entire file,
11354 avoiding backtracing. Refile target collection makes use of that."
11355 (if fastp
11356 (progn
11357 (if (> level 19)
11358 (error "Outline path failure, more than 19 levels"))
11359 (loop for i from level upto 19 do
11360 (aset org-olpa i nil))
11361 (prog1
11362 (delq nil (append org-olpa nil))
11363 (aset org-olpa level heading)))
11364 (let (rtn case-fold-search)
11365 (save-excursion
11366 (save-restriction
11367 (widen)
11368 (while (org-up-heading-safe)
11369 (when (looking-at org-complex-heading-regexp)
11370 (push (org-trim
11371 (replace-regexp-in-string
11372 ;; Remove statistical/checkboxes cookies
11374 (org-match-string-no-properties 4)))
11375 rtn)))
11376 rtn)))))
11378 (defun org-format-outline-path (path &optional width prefix separator)
11379 "Format the outline path PATH for display.
11380 WIDTH is the maximum number of characters that is available.
11381 PREFIX is a prefix to be included in the returned string,
11382 such as the file name.
11383 SEPARATOR is inserted between the different parts of the path,
11385 (setq width (or width 79))
11386 (if prefix (setq width (- width (length prefix))))
11387 (if (not path)
11388 (or prefix "")
11389 (let* ((nsteps (length path))
11390 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11391 (maxwidth (if (<= total-width width)
11392 10000 ;; everything fits
11393 ;; we need to shorten the level headings
11394 (/ (- width nsteps) nsteps)))
11395 (org-odd-levels-only nil)
11396 (n 0)
11397 (total (1+ (length prefix))))
11398 (setq maxwidth (max maxwidth 10))
11399 (concat prefix
11400 (if prefix (or separator "/"))
11401 (mapconcat
11402 (lambda (h)
11403 (setq n (1+ n))
11404 (if (and (= n nsteps) (< maxwidth 10000))
11405 (setq maxwidth (- total-width total)))
11406 (if (< (length h) maxwidth)
11407 (progn (setq total (+ total (length h) 1)) h)
11408 (setq h (substring h 0 (- maxwidth 2))
11409 total (+ total maxwidth 1))
11411 (setq h (substring h 0 (match-beginning 0))))
11412 (setq h (concat h "..")))
11413 (org-add-props h nil 'face
11414 (nth (% (1- n) org-n-level-faces)
11415 org-level-faces))
11416 h)
11417 path (or separator "/"))))))
11419 (defun org-display-outline-path (&optional file current separator just-return-string)
11420 "Display the current outline path in the echo area.
11422 If FILE is non-nil, prepend the output with the file name.
11423 If CURRENT is non-nil, append the current heading to the output.
11424 SEPARATOR is passed through to `org-format-outline-path'. It separates
11426 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11427 (interactive "P")
11428 (let* (case-fold-search
11429 message-log-max ; Don't populate the *Messages* buffer
11430 (bfn (buffer-file-name (buffer-base-buffer)))
11431 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11432 res)
11433 (if current (setq path (append path
11434 (save-excursion
11435 (org-back-to-heading t)
11436 (if (looking-at org-complex-heading-regexp)
11437 (list (match-string 4)))))))
11438 (setq res
11439 (org-format-outline-path
11440 path
11441 (1- (frame-width))
11442 (and file bfn (concat (file-name-nondirectory bfn) separator))
11443 separator))
11444 (if just-return-string
11445 (org-no-properties res)
11446 (message "%s" res))))
11448 (defvar org-refile-history nil
11449 "History for refiling operations.")
11451 (defvar org-after-refile-insert-hook nil
11452 "Hook run after `org-refile' has inserted its stuff at the new location.
11453 Note that this is still *before* the stuff will be removed from
11454 the *old* location.")
11456 (defvar org-capture-last-stored-marker)
11457 (defvar org-refile-keep nil
11458 "Non-nil means `org-refile' will copy instead of refile.")
11460 (defun org-copy ()
11461 "Like `org-refile', but copy."
11462 (interactive)
11463 (let ((org-refile-keep t))
11464 (funcall 'org-refile nil nil nil "Copy")))
11466 (defun org-refile (&optional goto default-buffer rfloc msg)
11467 "Move the entry or entries at point to another heading.
11468 The list of target headings is compiled using the information in
11469 `org-refile-targets', which see.
11471 At the target location, the entry is filed as a subitem of the target
11472 heading. Depending on `org-reverse-note-order', the new subitem will
11473 either be the first or the last subitem.
11475 If there is an active region, all entries in that region will be moved.
11476 However, the region must fulfill the requirement that the first heading
11477 is the first one sets the top-level of the moved text - at most siblings
11478 below it are allowed.
11480 With prefix arg GOTO, the command will only visit the target location
11481 and not actually move anything.
11484 go to the location where the last refiling operation has put the subtree.
11485 With a prefix argument of `2', refile to the running clock.
11487 RFLOC can be a refile location obtained in a different way.
11492 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11494 If you are using target caching (see `org-refile-use-cache'),
11495 you have to clear the target cache in order to find new targets.
11496 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11497 prefix argument (`C-u C-u C-u C-c C-w')."
11499 (interactive "P")
11500 (if (member goto '(0 (64)))
11501 (org-refile-cache-clear)
11502 (let* ((actionmsg (or msg "Refile"))
11503 (cbuf (current-buffer))
11504 (regionp (org-region-active-p))
11505 (region-start (and regionp (region-beginning)))
11506 (region-end (and regionp (region-end)))
11507 (region-length (and regionp (- region-end region-start)))
11508 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11509 pos it nbuf file re level reversed)
11510 (setq last-command nil)
11511 (when regionp
11512 (goto-char region-start)
11513 (or (bolp) (goto-char (point-at-bol)))
11514 (setq region-start (point))
11515 (unless (or (org-kill-is-subtree-p
11516 (buffer-substring region-start region-end))
11517 (prog1 org-refile-active-region-within-subtree
11518 (org-toggle-heading)))
11519 (user-error "The region is not a (sequence of) subtree(s)")))
11520 (if (equal goto '(16))
11521 (org-refile-goto-last-stored)
11522 (when (or
11523 (and (equal goto 2)
11524 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11525 (prog1
11526 (setq it (list (or org-clock-heading "running clock")
11527 (buffer-file-name
11528 (marker-buffer org-clock-hd-marker))
11529 ""
11530 (marker-position org-clock-hd-marker)))
11531 (setq goto nil)))
11532 (setq it (or rfloc
11533 (let (heading-text)
11534 (save-excursion
11535 (unless goto
11536 (org-back-to-heading t)
11537 (setq heading-text
11538 (nth 4 (org-heading-components))))
11540 (org-refile-get-location
11541 (cond (goto "Goto")
11542 (regionp (concat actionmsg " region to"))
11545 default-buffer
11546 (and (not (equal '(4) goto))
11547 org-refile-allow-creating-parent-nodes)
11548 goto))))))
11549 (setq file (nth 1 it)
11550 re (nth 2 it)
11551 pos (nth 3 it))
11552 (if (and (not goto)
11553 pos
11554 (equal (buffer-file-name) file)
11555 (if regionp
11556 (and (>= pos region-start)
11557 (<= pos region-end))
11558 (and (>= pos (point))
11559 (< pos (save-excursion
11560 (org-end-of-subtree t t))))))
11561 (error "Cannot refile to position inside the tree or region"))
11563 (setq nbuf (or (find-buffer-visiting file)
11564 (find-file-noselect file)))
11565 (if goto
11566 (progn
11567 (org-pop-to-buffer-same-window nbuf)
11568 (goto-char pos)
11569 (org-show-context 'org-goto))
11570 (if regionp
11571 (progn
11572 (org-kill-new (buffer-substring region-start region-end))
11573 (org-save-markers-in-region region-start region-end))
11574 (org-copy-subtree 1 nil t))
11575 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11576 (find-file-noselect file)))
11577 (setq reversed (org-notes-order-reversed-p))
11578 (save-excursion
11579 (save-restriction
11580 (widen)
11581 (if pos
11582 (progn
11583 (goto-char pos)
11584 (looking-at org-outline-regexp)
11585 (setq level (org-get-valid-level (funcall outline-level) 1))
11586 (goto-char
11587 (if reversed
11588 (or (outline-next-heading) (point-max))
11589 (or (save-excursion (org-get-next-sibling))
11590 (org-end-of-subtree t t)
11591 (point-max)))))
11592 (setq level 1)
11593 (if (not reversed)
11594 (goto-char (point-max))
11595 (goto-char (point-min))
11596 (or (outline-next-heading) (goto-char (point-max)))))
11597 (if (not (bolp)) (newline))
11598 (org-paste-subtree level)
11599 (when org-log-refile
11600 (org-add-log-setup 'refile nil nil 'findpos
11601 org-log-refile)
11602 (unless (eq org-log-refile 'note)
11603 (save-excursion (org-add-log-note))))
11604 (and org-auto-align-tags
11605 (let ((org-loop-over-headlines-in-active-region nil))
11606 (org-set-tags nil t)))
11607 (with-demoted-errors
11608 (bookmark-set "org-refile-last-stored"))
11609 ;; If we are refiling for capture, make sure that the
11610 ;; last-capture pointers point here
11611 (when (org-bound-and-true-p org-refile-for-capture)
11612 (with-demoted-errors
11613 (bookmark-set "org-capture-last-stored-marker"))
11614 (move-marker org-capture-last-stored-marker (point)))
11615 (if (fboundp 'deactivate-mark) (deactivate-mark))
11616 (run-hooks 'org-after-refile-insert-hook))))
11617 (unless org-refile-keep
11618 (if regionp
11619 (delete-region (point) (+ (point) region-length))
11620 (org-cut-subtree)))
11621 (when (featurep 'org-inlinetask)
11622 (org-inlinetask-remove-END-maybe))
11623 (setq org-markers-to-move nil)
11626 (defun org-refile-goto-last-stored ()
11627 "Go to the location where the last refile was stored."
11628 (interactive)
11629 (bookmark-jump "org-refile-last-stored")
11630 (message "This is the location of the last refile"))
11632 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11633 no-exclude)
11634 "Prompt the user for a refile location, using PROMPT.
11635 PROMPT should not be suffixed with a colon and a space, because
11636 this function appends the default value from
11637 `org-refile-history' automatically, if that is not empty.
11638 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11639 this is used for the GOTO interface."
11640 (let ((org-refile-targets org-refile-targets)
11641 (org-refile-use-outline-path org-refile-use-outline-path)
11642 excluded-entries)
11643 (when (and (derived-mode-p 'org-mode)
11644 (not org-refile-use-cache)
11645 (not no-exclude))
11646 (org-map-tree
11647 (lambda()
11648 (setq excluded-entries
11649 (append excluded-entries (list (org-get-heading t t)))))))
11650 (setq org-refile-target-table
11651 (org-refile-get-targets default-buffer excluded-entries)))
11652 (unless org-refile-target-table
11653 (user-error "No refile targets"))
11654 (let* ((cbuf (current-buffer))
11655 (partial-completion-mode nil)
11656 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11657 (cfunc (if (and org-refile-use-outline-path
11658 org-outline-path-complete-in-steps)
11659 'org-olpath-completing-read
11660 'org-icompleting-read))
11661 (extra (if org-refile-use-outline-path "/" ""))
11662 (cbnex (concat (buffer-name) extra))
11663 (filename (and cfn (expand-file-name cfn)))
11664 (tbl (mapcar
11665 (lambda (x)
11666 (if (and (not (member org-refile-use-outline-path
11667 '(file full-file-path)))
11668 (not (equal filename (nth 1 x))))
11669 (cons (concat (car x) extra " ("
11670 (file-name-nondirectory (nth 1 x)) ")")
11671 (cdr x))
11672 (cons (concat (car x) extra) (cdr x))))
11673 org-refile-target-table))
11674 (completion-ignore-case t)
11675 cdef
11676 (prompt (concat prompt
11677 (or (and (car org-refile-history)
11678 (concat " (default " (car org-refile-history) ")"))
11679 (and (assoc cbnex tbl) (setq cdef cbnex)
11680 (concat " (default " cbnex ")"))) ": "))
11681 pa answ parent-target child parent old-hist)
11682 (setq old-hist org-refile-history)
11683 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11684 nil 'org-refile-history (or cdef (car org-refile-history))))
11685 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11686 (org-refile-check-position pa)
11687 (if pa
11688 (progn
11689 (when (or (not org-refile-history)
11690 (not (eq old-hist org-refile-history))
11691 (not (equal (car pa) (car org-refile-history))))
11692 (setq org-refile-history
11693 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11694 org-refile-history
11695 (cdr org-refile-history))))
11696 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11697 (pop org-refile-history)))
11698 pa)
11700 (progn
11701 (setq parent (match-string 1 answ)
11702 child (match-string 2 answ))
11703 (setq parent-target (or (assoc parent tbl)
11704 (assoc (concat parent "/") tbl)))
11705 (when (and parent-target
11706 (or (eq new-nodes t)
11707 (and (eq new-nodes 'confirm)
11709 child)))))
11710 (org-refile-new-child parent-target child)))
11711 (user-error "Invalid target location")))))
11713 (declare-function org-string-nw-p "org-macs" (s))
11714 (defun org-refile-check-position (refile-pointer)
11715 "Check if the refile pointer matches the headline to which it points."
11716 (let* ((file (nth 1 refile-pointer))
11717 (re (nth 2 refile-pointer))
11718 (pos (nth 3 refile-pointer))
11719 buffer)
11720 (if (and (not (markerp pos)) (not file))
11721 (user-error "Please save the buffer to a file before refiling")
11722 (when (org-string-nw-p re)
11723 (setq buffer (if (markerp pos)
11724 (marker-buffer pos)
11725 (or (find-buffer-visiting file)
11726 (find-file-noselect file))))
11727 (with-current-buffer buffer
11728 (save-excursion
11729 (save-restriction
11730 (widen)
11731 (goto-char pos)
11732 (beginning-of-line 1)
11733 (unless (org-looking-at-p re)
11734 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11736 (defun org-refile-new-child (parent-target child)
11737 "Use refile target PARENT-TARGET to add new CHILD below it."
11738 (unless parent-target
11739 (error "Cannot find parent for new node"))
11740 (let ((file (nth 1 parent-target))
11741 (pos (nth 3 parent-target))
11742 level)
11743 (with-current-buffer (or (find-buffer-visiting file)
11744 (find-file-noselect file))
11745 (save-excursion
11746 (save-restriction
11747 (widen)
11748 (if pos
11749 (goto-char pos)
11750 (goto-char (point-max))
11751 (if (not (bolp)) (newline)))
11752 (when (looking-at org-outline-regexp)
11753 (setq level (funcall outline-level))
11754 (org-end-of-subtree t t))
11755 (org-back-over-empty-lines)
11757 (if pos (org-get-valid-level level 1) 1) ?*)
11759 (beginning-of-line 0)
11760 (list (concat (car parent-target) "/" child) file "" (point)))))))
11762 (defun org-olpath-completing-read (prompt collection &rest args)
11763 "Read an outline path like a file name."
11764 (let ((thetable collection)
11765 (org-completion-use-ido nil) ; does not work with ido.
11766 (org-completion-use-iswitchb nil)) ; or iswitchb
11767 (apply
11768 'org-icompleting-read prompt
11769 (lambda (string predicate &optional flag)
11770 (let (rtn r f (l (length string)))
11771 (cond
11772 ((eq flag nil)
11773 ;; try completion
11774 (try-completion string thetable))
11775 ((eq flag t)
11776 ;; all-completions
11777 (setq rtn (all-completions string thetable predicate))
11778 (mapcar
11779 (lambda (x)
11780 (setq r (substring x l))
11781 (if (string-match " ([^)]*)$" x)
11782 (setq f (match-string 0 x))
11783 (setq f ""))
11784 (if (string-match "/" r)
11785 (concat string (substring r 0 (match-end 0)) f)
11786 x))
11787 rtn))
11788 ((eq flag 'lambda)
11789 ;; exact match?
11790 (assoc string thetable)))))
11791 args)))
11793 ;;;; Dynamic blocks
11795 (defun org-find-dblock (name)
11796 "Find the first dynamic block with name NAME in the buffer.
11797 If not found, stay at current position and return nil."
11798 (let ((case-fold-search t) pos)
11799 (save-excursion
11800 (goto-char (point-min))
11801 (setq pos (and (re-search-forward
11803 (match-beginning 0))))
11804 (if pos (goto-char pos))
11805 pos))
11807 (defconst org-dblock-start-re
11809 "Matches the start line of a dynamic block, with parameters.")
11812 "Matches the end of a dynamic block.")
11814 (defun org-create-dblock (plist)
11815 "Create a dynamic block section, with parameters taken from PLIST.
11816 PLIST must contain a :name entry which is used as name of the block."
11818 (end-of-line 1)
11819 (newline))
11820 (let ((col (current-column))
11821 (name (plist-get plist :name)))
11822 (insert "#+BEGIN: " name)
11823 (while plist
11824 (if (eq (car plist) :name)
11825 (setq plist (cddr plist))
11826 (insert " " (prin1-to-string (pop plist)))))
11828 (beginning-of-line -2)))
11830 (defun org-prepare-dblock ()
11831 "Prepare dynamic block for refresh.
11832 This empties the block, puts the cursor at the insert position and returns
11833 the property list including an extra property :name with the block name."
11834 (unless (looking-at org-dblock-start-re)
11835 (user-error "Not at a dynamic block"))
11836 (let* ((begdel (1+ (match-end 0)))
11837 (name (org-no-properties (match-string 1)))
11838 (params (append (list :name name)
11839 (read (concat "(" (match-string 3) ")")))))
11840 (save-excursion
11841 (beginning-of-line 1)
11843 (setq params (plist-put params :indentation-column (current-column))))
11844 (unless (re-search-forward org-dblock-end-re nil t)
11845 (error "Dynamic block not terminated"))
11846 (setq params
11847 (append params
11848 (list :content (buffer-substring
11849 begdel (match-beginning 0)))))
11850 (delete-region begdel (match-beginning 0))
11851 (goto-char begdel)
11852 (open-line 1)
11853 params))
11855 (defun org-map-dblocks (&optional command)
11856 "Apply COMMAND to all dynamic blocks in the current buffer.
11857 If COMMAND is not given, use `org-update-dblock'."
11858 (let ((cmd (or command 'org-update-dblock)))
11859 (save-excursion
11860 (goto-char (point-min))
11861 (while (re-search-forward org-dblock-start-re nil t)
11862 (goto-char (match-beginning 0))
11863 (save-excursion
11864 (condition-case nil
11865 (funcall cmd)
11866 (error (message "Error during update of dynamic block"))))
11867 (unless (re-search-forward org-dblock-end-re nil t)
11868 (error "Dynamic block not terminated"))))))
11870 (defun org-dblock-update (&optional arg)
11871 "User command for updating dynamic blocks.
11872 Update the dynamic block at point. With prefix ARG, update all dynamic
11873 blocks in the buffer."
11874 (interactive "P")
11875 (if arg
11876 (org-update-all-dblocks)
11877 (or (looking-at org-dblock-start-re)
11878 (org-beginning-of-dblock))
11879 (org-update-dblock)))
11881 (defun org-update-dblock ()
11882 "Update the dynamic block at point.
11883 This means to empty the block, parse for parameters and then call
11884 the correct writing function."
11885 (interactive)
11886 (save-window-excursion
11887 (let* ((pos (point))
11888 (line (org-current-line))
11889 (params (org-prepare-dblock))
11890 (name (plist-get params :name))
11891 (indent (plist-get params :indentation-column))
11892 (cmd (intern (concat "org-dblock-write:" name))))
11893 (message "Updating dynamic block `%s' at line %d..." name line)
11894 (funcall cmd params)
11895 (message "Updating dynamic block `%s' at line %d...done" name line)
11896 (goto-char pos)
11897 (when (and indent (> indent 0))
11898 (setq indent (make-string indent ?\ ))
11899 (save-excursion
11900 (org-beginning-of-dblock)
11901 (forward-line 1)
11902 (while (not (looking-at org-dblock-end-re))
11903 (insert indent)
11904 (beginning-of-line 2))
11905 (when (looking-at org-dblock-end-re)
11907 (replace-match ""))
11908 (insert indent)))))))
11910 (defun org-beginning-of-dblock ()
11911 "Find the beginning of the dynamic block at point.
11912 Error if there is no such block at point."
11913 (let ((pos (point))
11914 beg)
11915 (end-of-line 1)
11916 (if (and (re-search-backward org-dblock-start-re nil t)
11917 (setq beg (match-beginning 0))
11918 (re-search-forward org-dblock-end-re nil t)
11919 (> (match-end 0) pos))
11920 (goto-char beg)
11921 (goto-char pos)
11922 (error "Not in a dynamic block"))))
11924 (defun org-update-all-dblocks ()
11925 "Update all dynamic blocks in the buffer.
11926 This function can be used in a hook."
11927 (interactive)
11928 (when (derived-mode-p 'org-mode)
11929 (org-map-dblocks 'org-update-dblock)))
11932 ;;;; Completion
11934 (defun org-get-export-keywords ()
11935 "Return a list of all currently understood export keywords.
11936 Export keywords include options, block names, attributes and
11937 keywords relative to each registered export back-end."
11938 (delq nil
11939 (let (keywords)
11940 (mapc
11941 (lambda (back-end)
11942 (let ((props (cdr back-end)))
11943 ;; Back-end name (for keywords, like #+LATEX:)
11944 (push (upcase (symbol-name (car back-end))) keywords)
11945 ;; Back-end options.
11946 (mapc (lambda (option) (push (cadr option) keywords))
11947 (plist-get (cdr back-end) :options-alist))))
11948 (org-bound-and-true-p org-export-registered-backends))
11949 keywords)))
11951 (defconst org-options-keywords
11952 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11953 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11954 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11955 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11956 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11958 (defcustom org-structure-template-alist
11973 ("L" "#+LaTeX: "
11977 ("H" "#+HTML: "
11980 ("A" "#+ASCII: ")
11981 ("i" "#+INDEX: ?"
11982 "#+INDEX: ?")
11983 ("I" "#+INCLUDE: %file ?"
11985 "Structure completion elements.
11986 This is a list of abbreviation keys and values. The value gets inserted
11987 if you type `<' followed by the key and then press the completion key,
11988 usually `M-TAB'. %file will be replaced by a file name after prompting
11989 for the file using completion. The cursor will be placed at the position
11990 of the `?` in the template.
11991 There are two templates for each key, the first uses the original Org syntax,
11992 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11993 the default when the /org-mtags.el/ module has been loaded. See also the
11994 variable `org-mtags-prefer-muse-templates'."
11995 :group 'org-completion
11996 :type '(repeat
11997 (string :tag "Key")
11998 (string :tag "Template")
11999 (string :tag "Muse Template")))
12001 (defun org-try-structure-completion ()
12002 "Try to complete a structure template before point.
12004 expands them."
12005 (let ((l (buffer-substring (point-at-bol) (point)))
12006 a)
12009 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12010 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12011 (match-beginning 1)) a)
12012 t)))
12014 (defun org-complete-expand-structure-template (start cell)
12015 "Expand a structure template."
12016 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12017 (rpl (nth (if musep 2 1) cell))
12018 (ind ""))
12019 (delete-region start (point))
12021 (cond
12022 ((bolp))
12024 (setq ind (buffer-substring (point-at-bol) (point))))
12025 (t (newline))))
12026 (setq start (point))
12027 (if (string-match "%file" rpl)
12028 (setq rpl (replace-match
12029 (concat
12031 (save-match-data
12032 (abbreviate-file-name (read-file-name "Include file: ")))
12034 t t rpl)))
12037 (insert rpl)
12040 ;;;; TODO, DEADLINE, Comments
12042 (defun org-toggle-comment ()
12043 "Change the COMMENT state of an entry."
12044 (interactive)
12045 (save-excursion
12046 (org-back-to-heading)
12047 (let (case-fold-search)
12048 (cond
12049 ((looking-at (format org-heading-keyword-regexp-format
12050 org-comment-string))
12051 (goto-char (match-end 1))
12052 (looking-at (concat " +" org-comment-string))
12053 (replace-match "" t t)
12054 (when (eolp) (insert " ")))
12055 ((looking-at org-outline-regexp)
12056 (goto-char (match-end 0))
12057 (insert org-comment-string " "))))))
12059 (defvar org-last-todo-state-is-todo nil
12060 "This is non-nil when the last TODO state change led to a TODO state.
12061 If the last change removed the TODO tag or switched to DONE, then
12062 this is nil.")
12064 (defvar org-setting-tags nil) ; dynamically skipped
12066 (defvar org-todo-setup-filter-hook nil
12067 "Hook for functions that pre-filter todo specs.
12068 Each function takes a todo spec and returns either nil or the spec
12069 transformed into canonical form." )
12071 (defvar org-todo-get-default-hook nil
12072 "Hook for functions that get a default item for todo.
12073 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12074 nil or a string to be used for the todo mark." )
12076 (defvar org-agenda-headline-snapshot-before-repeat)
12078 (defun org-current-effective-time ()
12079 "Return current time adjusted for `org-extend-today-until' variable."
12080 (let* ((ct (org-current-time))
12081 (dct (decode-time ct))
12082 (ct1
12083 (cond
12084 (org-use-last-clock-out-time-as-effective-time
12085 (or (org-clock-get-last-clock-out-time) ct))
12086 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12087 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12088 (t ct))))
12089 ct1))
12091 (defun org-todo-yesterday (&optional arg)
12092 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12093 (interactive "P")
12094 (if (eq major-mode 'org-agenda-mode)
12095 (apply 'org-agenda-todo-yesterday arg)
12096 (let* ((hour (third (decode-time
12097 (org-current-time))))
12098 (org-extend-today-until (1+ hour)))
12099 (org-todo arg))))
12101 (defvar org-block-entry-blocking ""
12102 "First entry preventing the TODO state change.")
12104 (defun org-todo (&optional arg)
12105 "Change the TODO state of an item.
12106 The state of an item is given by a keyword at the start of the heading,
12107 like
12108 *** TODO Write paper
12109 *** DONE Call mom
12111 The different keywords are specified in the variable `org-todo-keywords'.
12113 So for this example: when the item starts with TODO, it is changed to DONE.
12114 When it starts with DONE, the DONE is removed. And when neither TODO nor
12115 DONE are present, add TODO at the beginning of the heading.
12118 state.
12119 With numeric prefix arg, switch to that state.
12121 keywords (nextset).
12123 With a numeric prefix arg of 0, inhibit note taking for the change.
12125 For calling through lisp, arg is also interpreted in the following way:
12126 'none -> empty state
12128 'done -> switch to DONE
12129 'nextset -> switch to the next set of keywords
12130 'previousset -> switch to the previous set of keywords
12132 really is a member of `org-todo-keywords'."
12133 (interactive "P")
12134 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12135 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12136 'region-start-level 'region))
12137 org-loop-over-headlines-in-active-region)
12138 (org-map-entries
12139 `(org-todo ,arg)
12140 org-loop-over-headlines-in-active-region
12141 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12142 (if (equal arg '(16)) (setq arg 'nextset))
12143 (let ((org-blocker-hook org-blocker-hook)
12144 commentp
12145 case-fold-search)
12146 (when (equal arg '(64))
12147 (setq arg nil org-blocker-hook nil))
12148 (when (and org-blocker-hook
12149 (or org-inhibit-blocking
12150 (org-entry-get nil "NOBLOCKING")))
12151 (setq org-blocker-hook nil))
12152 (save-excursion
12153 (catch 'exit
12154 (org-back-to-heading t)
12156 (org-toggle-comment)
12157 (setq commentp t))
12158 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12161 (let* ((match-data (match-data))
12162 (startpos (point-at-bol))
12163 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12164 (org-log-done org-log-done)
12165 (org-log-repeat org-log-repeat)
12166 (org-todo-log-states org-todo-log-states)
12167 (org-inhibit-logging
12168 (if (equal arg 0)
12169 (progn (setq arg nil) 'note) org-inhibit-logging))
12170 (this (match-string 1))
12171 (hl-pos (match-beginning 0))
12172 (head (org-get-todo-sequence-head this))
12173 (ass (assoc head org-todo-kwd-alist))
12174 (interpret (nth 1 ass))
12175 (done-word (nth 3 ass))
12176 (final-done-word (nth 4 ass))
12177 (org-last-state (or this ""))
12178 (completion-ignore-case t)
12179 (member (member this org-todo-keywords-1))
12180 (tail (cdr member))
12181 (org-state (cond
12182 ((and org-todo-key-trigger
12183 (or (and (equal arg '(4))
12184 (eq org-use-fast-todo-selection 'prefix))
12185 (and (not arg) org-use-fast-todo-selection
12186 (not (eq org-use-fast-todo-selection
12187 'prefix)))))
12188 ;; Use fast selection
12189 (org-fast-todo-selection))
12190 ((and (equal arg '(4))
12191 (or (not org-use-fast-todo-selection)
12192 (not org-todo-key-trigger)))
12193 ;; Read a state with completion
12194 (org-icompleting-read
12195 "State: " (mapcar 'list org-todo-keywords-1)
12196 nil t))
12197 ((eq arg 'right)
12198 (if this
12199 (if tail (car tail) nil)
12200 (car org-todo-keywords-1)))
12201 ((eq arg 'left)
12202 (if (equal member org-todo-keywords-1)
12203 nil
12204 (if this
12205 (nth (- (length org-todo-keywords-1)
12206 (length tail) 2)
12207 org-todo-keywords-1)
12208 (org-last org-todo-keywords-1))))
12209 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12210 (setq arg nil))) ; hack to fall back to cycling
12211 (arg
12212 ;; user or caller requests a specific state
12213 (cond
12214 ((equal arg "") nil)
12215 ((eq arg 'none) nil)
12216 ((eq arg 'done) (or done-word (car org-done-keywords)))
12217 ((eq arg 'nextset)
12218 (or (car (cdr (member head org-todo-heads)))
12219 (car org-todo-heads)))
12220 ((eq arg 'previousset)
12221 (let ((org-todo-heads (reverse org-todo-heads)))
12222 (or (car (cdr (member head org-todo-heads)))
12223 (car org-todo-heads))))
12224 ((car (member arg org-todo-keywords-1)))
12225 ((stringp arg)
12226 (user-error "State `%s' not valid in this file" arg))
12227 ((nth (1- (prefix-numeric-value arg))
12228 org-todo-keywords-1))))
12229 ((null member) (or head (car org-todo-keywords-1)))
12230 ((equal this final-done-word) nil) ;; -> make empty
12231 ((null tail) nil) ;; -> first entry
12232 ((memq interpret '(type priority))
12233 (if (eq this-command last-command)
12234 (car tail)
12235 (if (> (length tail) 0)
12236 (or done-word (car org-done-keywords))
12237 nil)))
12238 (t
12239 (car tail))))
12240 (org-state (or
12241 (run-hook-with-args-until-success
12242 'org-todo-get-default-hook org-state org-last-state)
12243 org-state))
12244 (next (if org-state (concat " " org-state " ") " "))
12245 (change-plist (list :type 'todo-state-change :from this :to org-state
12246 :position startpos))
12247 dolog now-done-p)
12248 (when org-blocker-hook
12249 (setq org-last-todo-state-is-todo
12250 (not (member this org-done-keywords)))
12251 (unless (save-excursion
12252 (save-match-data
12253 (org-with-wide-buffer
12254 (run-hook-with-args-until-failure
12255 'org-blocker-hook change-plist))))
12256 (if (org-called-interactively-p 'interactive)
12258 this org-state org-block-entry-blocking)
12259 ;; fail silently
12261 this org-state org-block-entry-blocking)
12262 (throw 'exit nil))))
12263 (store-match-data match-data)
12264 (replace-match next t t)
12265 (unless (pos-visible-in-window-p hl-pos)
12266 (message "TODO state changed to %s" (org-trim next)))
12267 (unless head
12268 (setq head (org-get-todo-sequence-head org-state)
12269 ass (assoc head org-todo-kwd-alist)
12270 interpret (nth 1 ass)
12271 done-word (nth 3 ass)
12272 final-done-word (nth 4 ass)))
12273 (when (memq arg '(nextset previousset))
12274 (message "Keyword-Set %d/%d: %s"
12275 (- (length org-todo-sets) -1
12276 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12277 (length org-todo-sets)
12278 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12279 (setq org-last-todo-state-is-todo
12280 (not (member org-state org-done-keywords)))
12281 (setq now-done-p (and (member org-state org-done-keywords)
12282 (not (member this org-done-keywords))))
12283 (and logging (org-local-logging logging))
12284 (when (and (or org-todo-log-states org-log-done)
12285 (not (eq org-inhibit-logging t))
12286 (not (memq arg '(nextset previousset))))
12287 ;; we need to look at recording a time and note
12288 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12289 (nth 2 (assoc this org-todo-log-states))))
12290 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12291 (setq dolog 'time))
12292 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12293 (and org-state
12294 (member org-state org-not-done-keywords)
12295 (not (member this org-not-done-keywords))))
12296 ;; This is now a todo state and was not one before
12297 ;; If there was a CLOSED time stamp, get rid of it.
12298 (org-add-planning-info nil nil 'closed))
12299 (when (and now-done-p org-log-done)
12300 ;; It is now done, and it was not done before
12301 (org-add-planning-info 'closed (org-current-effective-time))
12302 (if (and (not dolog) (eq 'note org-log-done))
12303 (org-add-log-setup 'done org-state this 'findpos 'note)))
12304 (when (and org-state dolog)
12305 ;; This is a non-nil state, and we need to log it
12306 (org-add-log-setup 'state org-state this 'findpos dolog)))
12307 ;; Fixup tag positioning
12308 (org-todo-trigger-tag-changes org-state)
12309 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12310 (when org-provide-todo-statistics
12311 (org-update-parent-todo-statistics))
12312 (run-hooks 'org-after-todo-state-change-hook)
12313 (if (and arg (not (member org-state org-done-keywords)))
12314 (setq head (org-get-todo-sequence-head org-state)))
12315 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12316 ;; Do we need to trigger a repeat?
12317 (when now-done-p
12318 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12319 ;; This is for the agenda, take a snapshot of the headline.
12320 (save-match-data
12321 (setq org-agenda-headline-snapshot-before-repeat
12322 (org-get-heading))))
12323 (org-auto-repeat-maybe org-state))
12324 ;; Fixup cursor location if close to the keyword
12325 (if (and (outline-on-heading-p)
12326 (not (bolp))
12327 (save-excursion (beginning-of-line 1)
12328 (looking-at org-todo-line-regexp))
12329 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12330 (progn
12331 (goto-char (or (match-end 2) (match-end 1)))
12332 (and (looking-at " ") (just-one-space))))
12333 (when org-trigger-hook
12334 (save-excursion
12335 (run-hook-with-args 'org-trigger-hook change-plist)))
12336 (when commentp (org-toggle-comment))))))))
12338 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12339 "Block turning an entry into a TODO, using the hierarchy.
12340 This checks whether the current task should be blocked from state
12341 changes. Such blocking occurs when:
12343 1. The task has children which are not all in a completed state.
12345 2. A task has a parent with the property :ORDERED:, and there
12346 are siblings prior to the current task with incomplete
12347 status.
12349 3. The parent of the task is blocked because it has siblings that should
12350 be done first, or is child of a block grandparent TODO entry."
12352 (if (not org-enforce-todo-dependencies)
12353 t ; if locally turned off don't block
12354 (catch 'dont-block
12355 ;; If this is not a todo state change, or if this entry is already DONE,
12356 ;; do not block
12357 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12358 (member (plist-get change-plist :from)
12359 (cons 'done org-done-keywords))
12360 (member (plist-get change-plist :to)
12361 (cons 'todo org-not-done-keywords))
12362 (not (plist-get change-plist :to)))
12363 (throw 'dont-block t))
12364 ;; If this task has children, and any are undone, it's blocked
12365 (save-excursion
12366 (org-back-to-heading t)
12367 (let ((this-level (funcall outline-level)))
12368 (outline-next-heading)
12369 (let ((child-level (funcall outline-level)))
12370 (while (and (not (eobp))
12371 (> child-level this-level))
12372 ;; this todo has children, check whether they are all
12373 ;; completed
12374 (if (and (not (org-entry-is-done-p))
12375 (org-entry-is-todo-p))
12376 (progn (setq org-block-entry-blocking (org-get-heading))
12377 (throw 'dont-block nil)))
12378 (outline-next-heading)
12379 (setq child-level (funcall outline-level))))))
12380 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12381 ;; any previous siblings are undone, it's blocked
12382 (save-excursion
12383 (org-back-to-heading t)
12384 (let* ((pos (point))
12385 (parent-pos (and (org-up-heading-safe) (point))))
12386 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12387 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12388 (forward-line 1)
12389 (re-search-forward org-not-done-heading-regexp pos t))
12390 (setq org-block-entry-blocking (match-string 0))
12391 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12392 ;; Search further up the hierarchy, to see if an ancestor is blocked
12393 (while t
12394 (goto-char parent-pos)
12395 (if (not (looking-at org-not-done-heading-regexp))
12396 (throw 'dont-block t)) ; do not block, parent is not a TODO
12397 (setq pos (point))
12398 (setq parent-pos (and (org-up-heading-safe) (point)))
12399 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12400 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12401 (forward-line 1)
12402 (re-search-forward org-not-done-heading-regexp pos t)
12403 (setq org-block-entry-blocking (org-get-heading)))
12404 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12406 (defcustom org-track-ordered-property-with-tag nil
12407 "Should the ORDERED property also be shown as a tag?
12408 The ORDERED property decides if an entry should require subtasks to be
12409 completed in sequence. Since a property is not very visible, setting
12410 this option means that toggling the ORDERED property with the command
12411 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12412 not relevant for the behavior, but it makes things more visible.
12414 Note that toggling the tag with tags commands will not change the property
12415 and therefore not influence behavior!
12417 This can be t, meaning the tag ORDERED should be used, It can also be a
12418 string to select a different tag for this task."
12419 :group 'org-todo
12420 :type '(choice
12421 (const :tag "No tracking" nil)
12422 (const :tag "Track with ORDERED tag" t)
12423 (string :tag "Use other tag")))
12425 (defun org-toggle-ordered-property ()
12426 "Toggle the ORDERED property of the current entry.
12427 For better visibility, you can track the value of this property with a tag.
12428 See variable `org-track-ordered-property-with-tag'."
12429 (interactive)
12430 (let* ((t1 org-track-ordered-property-with-tag)
12431 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12432 (save-excursion
12433 (org-back-to-heading)
12434 (if (org-entry-get nil "ORDERED")
12435 (progn
12436 (org-delete-property "ORDERED" "PROPERTIES")
12437 (and tag (org-toggle-tag tag 'off))
12438 (message "Subtasks can be completed in arbitrary order"))
12439 (org-entry-put nil "ORDERED" "t")
12440 (and tag (org-toggle-tag tag 'on))
12441 (message "Subtasks must be completed in sequence")))))
12443 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12444 (defun org-block-todo-from-checkboxes (change-plist)
12445 "Block turning an entry into a TODO, using checkboxes.
12446 This checks whether the current task should be blocked from state
12447 changes because there are unchecked boxes in this entry."
12448 (if (not org-enforce-todo-checkbox-dependencies)
12449 t ; if locally turned off don't block
12450 (catch 'dont-block
12451 ;; If this is not a todo state change, or if this entry is already DONE,
12452 ;; do not block
12453 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12454 (member (plist-get change-plist :from)
12455 (cons 'done org-done-keywords))
12456 (member (plist-get change-plist :to)
12457 (cons 'todo org-not-done-keywords))
12458 (not (plist-get change-plist :to)))
12459 (throw 'dont-block t))
12460 ;; If this task has checkboxes that are not checked, it's blocked
12461 (save-excursion
12462 (org-back-to-heading t)
12463 (let ((beg (point)) end)
12464 (outline-next-heading)
12465 (setq end (point))
12466 (goto-char beg)
12467 (if (org-list-search-forward
12468 (concat (org-item-beginning-re)
12471 end t)
12472 (progn
12473 (if (boundp 'org-blocked-by-checkboxes)
12474 (setq org-blocked-by-checkboxes t))
12475 (throw 'dont-block nil)))))
12476 t))) ; do not block
12478 (defun org-entry-blocked-p ()
12479 "Is the current entry blocked?"
12480 (org-with-silent-modifications
12481 (if (org-entry-get nil "NOBLOCKING")
12482 nil ;; Never block this entry
12483 (not (run-hook-with-args-until-failure
12484 'org-blocker-hook
12485 (list :type 'todo-state-change
12486 :position (point)
12487 :from 'todo
12488 :to 'done))))))
12490 (defun org-update-statistics-cookies (all)
12491 "Update the statistics cookie, either from TODO or from checkboxes.
12492 This should be called with the cursor in a line with a statistics cookie."
12493 (interactive "P")
12494 (if all
12495 (progn
12496 (org-update-checkbox-count 'all)
12497 (org-map-entries 'org-update-parent-todo-statistics))
12498 (if (not (org-at-heading-p))
12499 (org-update-checkbox-count)
12500 (let ((pos (point-marker))
12501 end l1 l2)
12502 (ignore-errors (org-back-to-heading t))
12503 (if (not (org-at-heading-p))
12504 (org-update-checkbox-count)
12505 (setq l1 (org-outline-level))
12506 (setq end (save-excursion
12507 (outline-next-heading)
12508 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12509 (point)))
12510 (if (and (save-excursion
12511 (re-search-forward
12513 (not (save-excursion (re-search-forward
12515 (org-update-checkbox-count)
12516 (if (and l2 (> l2 l1))
12517 (progn
12518 (goto-char end)
12519 (org-update-parent-todo-statistics))
12520 (goto-char pos)
12521 (beginning-of-line 1)
12522 (while (re-search-forward
12524 (point-at-eol) t)
12525 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12526 (goto-char pos)
12527 (move-marker pos nil)))))
12529 (defvar org-entry-property-inherited-from) ;; defined below
12530 (defun org-update-parent-todo-statistics ()
12531 "Update any statistics cookie in the parent of the current headline.
12532 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12533 the entire subtree and this will travel up the hierarchy and update
12534 statistics everywhere."
12535 (let* ((prop (save-excursion (org-up-heading-safe)
12536 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12537 (recursive (or (not org-hierarchical-todo-statistics)
12539 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12540 0))
12541 (first t)
12543 level ltoggle l1 new ndel
12544 (cnt-all 0) (cnt-done 0) is-percent kwd
12545 checkbox-beg ov ovs ove cookie-present)
12546 (catch 'exit
12547 (save-excursion
12548 (beginning-of-line 1)
12549 (setq ltoggle (funcall outline-level))
12550 ;; Three situations are to consider:
12552 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12553 ;; to the top-level ancestor on the headline;
12555 ;; 2. If parent has "recursive" property, repeat up to the
12556 ;; headline setting that property, taking inheritance into
12557 ;; account;
12559 ;; 3. Else, move up to direct parent and proceed only once.
12560 (while (and (setq level (org-up-heading-safe))
12561 (or recursive first)
12562 (>= (point) lim))
12563 (setq first nil cookie-present nil)
12564 (unless (and level
12565 (not (string-match
12567 (downcase (or (org-entry-get nil "COOKIE_DATA")
12568 "")))))
12569 (throw 'exit nil))
12570 (while (re-search-forward box-re (point-at-eol) t)
12571 (setq cnt-all 0 cnt-done 0 cookie-present t)
12572 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12573 (save-match-data
12574 (unless (outline-next-heading) (throw 'exit nil))
12575 (while (and (looking-at org-complex-heading-regexp)
12576 (> (setq l1 (length (match-string 1))) level))
12577 (setq kwd (and (or recursive (= l1 ltoggle))
12578 (match-string 2)))
12579 (if (or (eq org-provide-todo-statistics 'all-headlines)
12580 (and (listp org-provide-todo-statistics)
12581 (or (member kwd org-provide-todo-statistics)
12582 (member kwd org-done-keywords))))
12583 (setq cnt-all (1+ cnt-all))
12584 (if (eq org-provide-todo-statistics t)
12585 (and kwd (setq cnt-all (1+ cnt-all)))))
12586 (and (member kwd org-done-keywords)
12587 (setq cnt-done (1+ cnt-done)))
12588 (outline-next-heading)))
12589 (setq new
12590 (if is-percent
12591 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12592 (format "[%d/%d]" cnt-done cnt-all))
12593 ndel (- (match-end 0) checkbox-beg))
12594 ;; handle overlays when updating cookie from column view
12595 (when (setq ov (car (overlays-at checkbox-beg)))
12596 (setq ovs (overlay-start ov) ove (overlay-end ov))
12597 (delete-overlay ov))
12598 (goto-char checkbox-beg)
12599 (insert new)
12600 (delete-region (point) (+ (point) ndel))
12601 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12602 (when ov (move-overlay ov ovs ove)))
12603 (when cookie-present
12604 (run-hook-with-args 'org-after-todo-statistics-hook
12605 cnt-done (- cnt-all cnt-done))))))
12606 (run-hooks 'org-todo-statistics-hook)))
12608 (defvar org-after-todo-statistics-hook nil
12609 "Hook that is called after a TODO statistics cookie has been updated.
12610 Each function is called with two arguments: the number of not-done entries
12611 and the number of done entries.
12613 For example, the following function, when added to this hook, will switch
12614 an entry to DONE when all children are done, and back to TODO when new
12615 entries are set to a TODO status. Note that this hook is only called
12616 when there is a statistics cookie in the headline!
12618 (defun org-summary-todo (n-done n-not-done)
12620 (let (org-log-done org-log-states) ; turn off logging
12622 ")
12624 (defvar org-todo-statistics-hook nil
12625 "Hook that is run whenever Org thinks TODO statistics should be updated.
12626 This hook runs even if there is no statistics cookie present, in which case
12627 `org-after-todo-statistics-hook' would not run.")
12629 (defun org-todo-trigger-tag-changes (state)
12630 "Apply the changes defined in `org-todo-state-tags-triggers'."
12631 (let ((l org-todo-state-tags-triggers)
12632 changes)
12633 (when (or (not state) (equal state ""))
12634 (setq changes (append changes (cdr (assoc "" l)))))
12635 (when (and (stringp state) (> (length state) 0))
12636 (setq changes (append changes (cdr (assoc state l)))))
12637 (when (member state org-not-done-keywords)
12638 (setq changes (append changes (cdr (assoc 'todo l)))))
12639 (when (member state org-done-keywords)
12640 (setq changes (append changes (cdr (assoc 'done l)))))
12641 (dolist (c changes)
12642 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12644 (defun org-local-logging (value)
12645 "Get logging settings from a property VALUE."
12646 (let* (words w a)
12647 ;; directly set the variables, they are already local.
12648 (setq org-log-done nil
12649 org-log-repeat nil
12650 org-todo-log-states nil)
12651 (setq words (org-split-string value))
12652 (while (setq w (pop words))
12653 (cond
12654 ((setq a (assoc w org-startup-options))
12655 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12656 (set (nth 1 a) (nth 2 a))))
12657 ((setq a (org-extract-log-state-settings w))
12658 (and (member (car a) org-todo-keywords-1)
12659 (push a org-todo-log-states)))))))
12661 (defun org-get-todo-sequence-head (kwd)
12662 "Return the head of the TODO sequence to which KWD belongs.
12663 If KWD is not set, check if there is a text property remembering the
12664 right sequence."
12665 (let (p)
12666 (cond
12667 ((not kwd)
12668 (or (get-text-property (point-at-bol) 'org-todo-head)
12669 (progn
12670 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12671 nil (point-at-eol)))
12672 (get-text-property p 'org-todo-head))))
12673 ((not (member kwd org-todo-keywords-1))
12674 (car org-todo-keywords-1))
12675 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12677 (defun org-fast-todo-selection ()
12678 "Fast TODO keyword selection with single keys.
12679 Returns the new TODO keyword, or nil if no state change should occur."
12680 (let* ((fulltable org-todo-key-alist)
12681 (done-keywords org-done-keywords) ;; needed for the faces.
12682 (maxlen (apply 'max (mapcar
12683 (lambda (x)
12684 (if (stringp (car x)) (string-width (car x)) 0))
12685 fulltable)))
12686 (expert nil)
12687 (fwidth (+ maxlen 3 1 3))
12688 (ncol (/ (- (window-width) 4) fwidth))
12689 tg cnt e c tbl
12690 groups ingroup)
12691 (save-excursion
12692 (save-window-excursion
12693 (if expert
12694 (set-buffer (get-buffer-create " *Org todo*"))
12695 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12696 (erase-buffer)
12697 (org-set-local 'org-done-keywords done-keywords)
12698 (setq tbl fulltable cnt 0)
12699 (while (setq e (pop tbl))
12700 (cond
12701 ((equal e '(:startgroup))
12702 (push '() groups) (setq ingroup t)
12703 (when (not (= cnt 0))
12704 (setq cnt 0)
12706 (insert "{ "))
12707 ((equal e '(:endgroup))
12708 (setq ingroup nil cnt 0)
12710 ((equal e '(:newline))
12711 (when (not (= cnt 0))
12712 (setq cnt 0)
12714 (setq e (car tbl))
12715 (while (equal (car tbl) '(:newline))
12717 (setq tbl (cdr tbl)))))
12718 (t
12719 (setq tg (car e) c (cdr e))
12720 (if ingroup (push tg (car groups)))
12721 (setq tg (org-add-props tg nil 'face
12722 (org-get-todo-face tg)))
12723 (if (and (= cnt 0) (not ingroup)) (insert " "))
12724 (insert "[" c "] " tg (make-string
12725 (- fwidth 4 (length tg)) ?\ ))
12726 (when (= (setq cnt (1+ cnt)) ncol)
12728 (if ingroup (insert " "))
12729 (setq cnt 0)))))
12731 (goto-char (point-min))
12732 (if (not expert) (org-fit-window-to-buffer))
12733 (message "[a-z..]:Set [SPC]:clear")
12734 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12735 (cond
12736 ((or (= c ?\C-g)
12737 (and (= c ?q) (not (rassoc c fulltable))))
12738 (setq quit-flag t))
12739 ((= c ?\ ) nil)
12740 ((setq e (rassoc c fulltable) tg (car e))
12741 tg)
12742 (t (setq quit-flag t)))))))
12744 (defun org-entry-is-todo-p ()
12745 (member (org-get-todo-state) org-not-done-keywords))
12747 (defun org-entry-is-done-p ()
12748 (member (org-get-todo-state) org-done-keywords))
12750 (defun org-get-todo-state ()
12751 "Return the TODO keyword of the current subtree."
12752 (save-excursion
12753 (org-back-to-heading t)
12754 (and (looking-at org-todo-line-regexp)
12755 (match-end 2)
12756 (match-string 2))))
12758 (defun org-at-date-range-p (&optional inactive-ok)
12759 "Is the cursor inside a date range?"
12760 (interactive)
12761 (save-excursion
12762 (catch 'exit
12763 (let ((pos (point)))
12765 (skip-chars-backward "<[")
12766 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12767 (>= (match-end 0) pos)
12768 (throw 'exit t))
12770 (skip-chars-backward "<[")
12771 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12772 (>= (match-end 0) pos)
12773 (throw 'exit t)))
12774 nil)))
12776 (defun org-get-repeat (&optional tagline)
12777 "Check if there is a deadline/schedule with repeater in this entry."
12778 (save-match-data
12779 (save-excursion
12780 (org-back-to-heading t)
12781 (and (re-search-forward (if tagline
12783 org-repeat-re)
12784 (org-entry-end-position) t)
12785 (match-string-no-properties 1)))))
12787 (defvar org-last-changed-timestamp)
12788 (defvar org-last-inserted-timestamp)
12789 (defvar org-log-post-message)
12790 (defvar org-log-note-purpose)
12791 (defvar org-log-note-how)
12792 (defvar org-log-note-extra)
12793 (defun org-auto-repeat-maybe (done-word)
12794 "Check if the current headline contains a repeated deadline/schedule.
12795 If yes, set TODO state back to what it was and change the base date
12796 of repeating deadline/scheduled time stamps to new date.
12797 This function is run automatically after each state change to a DONE state."
12798 ;; last-state is dynamically scoped into this function
12799 (let* ((repeat (org-get-repeat))
12800 (aa (assoc org-last-state org-todo-kwd-alist))
12801 (interpret (nth 1 aa))
12802 (head (nth 2 aa))
12803 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12804 (msg "Entry repeats: ")
12805 (org-log-done nil)
12806 (org-todo-log-states nil)
12807 re type n what ts time to-state)
12808 (when repeat
12809 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12810 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12811 org-todo-repeat-to-state))
12812 (unless (and to-state (member to-state org-todo-keywords-1))
12813 (setq to-state (if (eq interpret 'type) org-last-state head)))
12814 (org-todo to-state)
12815 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12816 (org-entry-put nil "LAST_REPEAT" (format-time-string
12817 (org-time-stamp-format t t))))
12818 (when org-log-repeat
12819 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12820 (memq 'org-add-log-note post-command-hook))
12821 ;; OK, we are already setup for some record
12822 (if (eq org-log-repeat 'note)
12823 ;; make sure we take a note, not only a time stamp
12824 (setq org-log-note-how 'note))
12825 ;; Set up for taking a record
12826 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12827 org-last-state
12828 'findpos org-log-repeat)))
12829 (org-back-to-heading t)
12830 (org-add-planning-info nil nil 'closed)
12834 (while (re-search-forward
12835 re (save-excursion (outline-next-heading) (point)) t)
12836 (setq type (if (match-end 1) org-scheduled-string
12837 (if (match-end 3) org-deadline-string "Plain:"))
12838 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12840 (setq n (string-to-number (match-string 2 ts))
12841 what (match-string 3 ts))
12842 (if (equal what "w") (setq n (* n 7) what "d"))
12844 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12845 ;; Preparation, see if we need to modify the start date for the change
12846 (when (match-end 1)
12847 (setq time (save-match-data (org-time-string-to-time ts)))
12848 (cond
12849 ((equal (match-string 1 ts) ".")
12850 ;; Shift starting date to today
12851 (org-timestamp-change
12852 (- (org-today) (time-to-days time))
12853 'day))
12854 ((equal (match-string 1 ts) "+")
12855 (let ((nshiftmax 10) (nshift 0))
12856 (while (or (= nshift 0)
12857 (<= (time-to-days time)
12858 (time-to-days (current-time))))
12859 (when (= (incf nshift) nshiftmax)
12860 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12861 (error "Abort")))
12862 (org-timestamp-change n (cdr (assoc what whata)))
12863 (org-at-timestamp-p t)
12864 (setq ts (match-string 1))
12865 (setq time (save-match-data (org-time-string-to-time ts)))))
12866 (org-timestamp-change (- n) (cdr (assoc what whata)))
12867 ;; rematch, so that we have everything in place for the real shift
12868 (org-at-timestamp-p t)
12869 (setq ts (match-string 1))
12871 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12872 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12873 (setq org-log-post-message msg)
12874 (message "%s" msg))))
12876 (defun org-show-todo-tree (arg)
12877 "Make a compact tree which shows all headlines marked with TODO.
12878 The tree will show the lines where the regexp matches, and all higher
12879 headlines above the match.
12881 With a numeric prefix N, construct a sparse tree for the Nth element
12882 of `org-todo-keywords-1'."
12883 (interactive "P")
12884 (let ((case-fold-search nil)
12885 (kwd-re
12886 (cond ((null arg) org-not-done-regexp)
12887 ((equal arg '(4))
12888 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12889 (mapcar 'list org-todo-keywords-1))))
12893 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12894 (regexp-quote (nth (1- (prefix-numeric-value arg))
12895 org-todo-keywords-1)))
12896 (t (user-error "Invalid prefix argument: %s" arg)))))
12897 (message "%d TODO entries found"
12898 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12900 (defun org-deadline (arg &optional time)
12902 With one universal prefix argument, remove any deadline from the item.
12903 With two universal prefix arguments, prompt for a warning delay.
12904 With argument TIME, set the deadline at the corresponding date. TIME
12906 (interactive "P")
12907 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12908 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12909 'region-start-level 'region))
12910 org-loop-over-headlines-in-active-region)
12911 (org-map-entries
12912 `(org-deadline ',arg ,time)
12913 org-loop-over-headlines-in-active-region
12914 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12915 (let* ((old-date (org-entry-get nil "DEADLINE"))
12916 (old-date-time (if old-date (org-time-string-to-time old-date)))
12917 (repeater (and old-date
12918 (string-match
12920 old-date)
12921 (match-string 1 old-date))))
12922 (cond
12923 ((equal arg '(4))
12924 (when (and old-date org-log-redeadline)
12925 (org-add-log-setup 'deldeadline nil old-date 'findpos
12926 org-log-redeadline))
12927 (org-remove-timestamp-with-keyword org-deadline-string)
12928 (message "Item no longer has a deadline."))
12929 ((equal arg '(16))
12930 (save-excursion
12931 (if (re-search-forward
12932 org-deadline-time-regexp
12933 (save-excursion (outline-next-heading) (point)) t)
12934 (let* ((rpl0 (match-string 1))
12935 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12936 (replace-match
12937 (concat org-deadline-string
12938 " <" rpl
12939 (format " -%dd"
12940 (abs
12941 (- (time-to-days
12942 (save-match-data
12943 (org-read-date nil t nil "Warn starting from" old-date-time)))
12944 (time-to-days old-date-time))))
12945 ">") t t))
12946 (user-error "No deadline information to update"))))
12947 (t
12948 (org-add-planning-info 'deadline time 'closed)
12949 (when (and old-date org-log-redeadline
12950 (not (equal old-date
12951 (substring org-last-inserted-timestamp 1 -1))))
12952 (org-add-log-setup 'redeadline nil old-date 'findpos
12953 org-log-redeadline))
12954 (when repeater
12955 (save-excursion
12956 (org-back-to-heading t)
12957 (when (re-search-forward (concat org-deadline-string " "
12958 org-last-inserted-timestamp)
12959 (save-excursion
12960 (outline-next-heading) (point)) t)
12961 (goto-char (1- (match-end 0)))
12962 (insert " " repeater)
12963 (setq org-last-inserted-timestamp
12964 (concat (substring org-last-inserted-timestamp 0 -1)
12965 " " repeater
12966 (substring org-last-inserted-timestamp -1))))))
12967 (message "Deadline on %s" org-last-inserted-timestamp))))))
12969 (defun org-schedule (arg &optional time)
12970 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12971 With one universal prefix argument, remove any scheduling date from the item.
12972 With two universal prefix arguments, prompt for a delay cookie.
12973 With argument TIME, scheduled at the corresponding date. TIME can
12975 (interactive "P")
12976 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12977 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12978 'region-start-level 'region))
12979 org-loop-over-headlines-in-active-region)
12980 (org-map-entries
12981 `(org-schedule ',arg ,time)
12982 org-loop-over-headlines-in-active-region
12983 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12984 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12985 (old-date-time (if old-date (org-time-string-to-time old-date)))
12986 (repeater (and old-date
12987 (string-match
12989 old-date)
12990 (match-string 1 old-date))))
12991 (cond
12992 ((equal arg '(4))
12993 (progn
12994 (when (and old-date org-log-reschedule)
12995 (org-add-log-setup 'delschedule nil old-date 'findpos
12996 org-log-reschedule))
12997 (org-remove-timestamp-with-keyword org-scheduled-string)
12998 (message "Item is no longer scheduled.")))
12999 ((equal arg '(16))
13000 (save-excursion
13001 (if (re-search-forward
13002 org-scheduled-time-regexp
13003 (save-excursion (outline-next-heading) (point)) t)
13004 (let* ((rpl0 (match-string 1))
13005 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13006 (replace-match
13007 (concat org-scheduled-string
13008 " <" rpl
13009 (format " -%dd"
13010 (abs
13011 (- (time-to-days
13012 (save-match-data
13013 (org-read-date nil t nil "Delay until" old-date-time)))
13014 (time-to-days old-date-time))))
13015 ">") t t))
13016 (user-error "No scheduled information to update"))))
13017 (t
13018 (org-add-planning-info 'scheduled time 'closed)
13019 (when (and old-date org-log-reschedule
13020 (not (equal old-date
13021 (substring org-last-inserted-timestamp 1 -1))))
13022 (org-add-log-setup 'reschedule nil old-date 'findpos
13023 org-log-reschedule))
13024 (when repeater
13025 (save-excursion
13026 (org-back-to-heading t)
13027 (when (re-search-forward (concat org-scheduled-string " "
13028 org-last-inserted-timestamp)
13029 (save-excursion
13030 (outline-next-heading) (point)) t)
13031 (goto-char (1- (match-end 0)))
13032 (insert " " repeater)
13033 (setq org-last-inserted-timestamp
13034 (concat (substring org-last-inserted-timestamp 0 -1)
13035 " " repeater
13036 (substring org-last-inserted-timestamp -1))))))
13037 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13039 (defun org-get-scheduled-time (pom &optional inherit)
13040 "Get the scheduled time as a time tuple, of a format suitable
13041 for calling org-schedule with, or if there is no scheduling,
13042 returns nil."
13043 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13044 (when time
13045 (apply 'encode-time (org-parse-time-string time)))))
13047 (defun org-get-deadline-time (pom &optional inherit)
13048 "Get the deadline as a time tuple, of a format suitable for
13049 calling org-deadline with, or if there is no scheduling, returns
13050 nil."
13051 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13052 (when time
13053 (apply 'encode-time (org-parse-time-string time)))))
13055 (defun org-remove-timestamp-with-keyword (keyword)
13056 "Remove all time stamps with KEYWORD in the current entry."
13058 beg)
13059 (save-excursion
13060 (org-back-to-heading t)
13061 (setq beg (point))
13062 (outline-next-heading)
13063 (while (re-search-backward re beg t)
13064 (replace-match "")
13066 (equal (char-before) ?\ ))
13067 (backward-delete-char 1)
13069 (point-at-bol) (point-at-eol)))
13070 (delete-region (point-at-bol)
13071 (min (point-max) (1+ (point-at-eol))))))))))
13073 (defun org-add-planning-info (what &optional time &rest remove)
13074 "Insert new timestamp with keyword in the line directly after the headline.
13075 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13076 If non is given, the user is prompted for a date.
13077 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13078 be removed."
13079 (interactive)
13080 (let (org-time-was-given org-end-time-was-given ts
13081 end default-time default-input)
13083 (catch 'exit
13084 (when (and (memq what '(scheduled deadline))
13085 (or (not time)
13086 (and (stringp time)
13087 (string-match "^[-+]+[0-9]" time))))
13088 ;; Try to get a default date/time from existing timestamp
13089 (save-excursion
13090 (org-back-to-heading t)
13091 (setq end (save-excursion (outline-next-heading) (point)))
13092 (when (re-search-forward (if (eq what 'scheduled)
13093 org-scheduled-time-regexp
13094 org-deadline-time-regexp)
13095 end t)
13096 (setq ts (match-string 1)
13097 default-time
13098 (apply 'encode-time (org-parse-time-string ts))
13099 default-input (and ts (org-get-compact-tod ts))))))
13100 (when what
13101 (setq time
13102 (if (stringp time)
13103 ;; This is a string (relative or absolute), set proper date
13104 (apply 'encode-time
13105 (org-read-date-analyze
13106 time default-time (decode-time default-time)))
13107 ;; If necessary, get the time from the user
13108 (or time (org-read-date nil 'to-time nil nil
13109 default-time default-input)))))
13111 (when (and org-insert-labeled-timestamps-at-point
13112 (member what '(scheduled deadline)))
13113 (insert
13114 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13115 (org-insert-time-stamp time org-time-was-given
13116 nil nil nil (list org-end-time-was-given))
13117 (setq what nil))
13118 (save-excursion
13119 (save-restriction
13120 (let (col list elt ts buffer-invisibility-spec)
13121 (org-back-to-heading t)
13123 (goto-char (match-end 1))
13124 (setq col (current-column))
13125 (goto-char (match-end 0))
13127 (when (and (not what)
13128 (not (looking-at
13130 org-keyword-time-not-clock-regexp))))
13131 ;; Nothing to add, nothing to remove...... :-)
13132 (throw 'exit nil))
13133 (if (and (not (looking-at org-outline-regexp))
13136 (not (equal (match-string 1) org-clock-string)))
13137 (narrow-to-region (match-beginning 0) (match-end 0))
13139 (backward-char 1)
13140 (narrow-to-region (point) (point))
13141 (and org-adapt-indentation (org-indent-to-column col)))
13142 ;; Check if we have to remove something.
13143 (setq list (cons what remove))
13144 (while list
13145 (setq elt (pop list))
13146 (when (or (and (eq elt 'scheduled)
13147 (re-search-forward org-scheduled-time-regexp nil t))
13148 (and (eq elt 'deadline)
13149 (re-search-forward org-deadline-time-regexp nil t))
13150 (and (eq elt 'closed)
13151 (re-search-forward org-closed-time-regexp nil t)))
13152 (replace-match "")
13153 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13155 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13156 (when what
13157 (insert
13158 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13159 (cond ((eq what 'scheduled) org-scheduled-string)
13160 ((eq what 'deadline) org-deadline-string)
13161 ((eq what 'closed) org-closed-string))
13162 " ")
13163 (setq ts (org-insert-time-stamp
13164 time
13165 (or org-time-was-given
13166 (and (eq what 'closed) org-log-done-with-time))
13167 (eq what 'closed)
13168 nil nil (list org-end-time-was-given)))
13169 (insert
13170 (if (not (or (bolp) (eq (char-before) ?\ )
13171 (memq (char-after) '(32 10))
13172 (eobp))) " " ""))
13173 (end-of-line 1))
13174 (goto-char (point-min))
13175 (widen)
13178 (delete-region (1- (point)) (point-at-eol)))
13179 ts))))))
13181 (defvar org-log-note-marker (make-marker))
13182 (defvar org-log-note-purpose nil)
13183 (defvar org-log-note-state nil)
13184 (defvar org-log-note-previous-state nil)
13185 (defvar org-log-note-how nil)
13186 (defvar org-log-note-extra nil)
13187 (defvar org-log-note-window-configuration nil)
13188 (defvar org-log-note-return-to (make-marker))
13189 (defvar org-log-note-effective-time nil
13190 "Remembered current time so that dynamically scoped
13191 `org-extend-today-until' affects tha timestamps in state change
13192 log")
13194 (defvar org-log-post-message nil
13195 "Message to be displayed after a log note has been stored.
13196 The auto-repeater uses this.")
13198 (defun org-add-note ()
13199 "Add a note to the current entry.
13200 This is done in the same way as adding a state change note."
13201 (interactive)
13202 (org-add-log-setup 'note nil nil 'findpos nil))
13204 (defvar org-property-end-re)
13205 (defun org-add-log-setup (&optional purpose state prev-state
13206 findpos how extra)
13207 "Set up the post command hook to take a note.
13208 If this is about to TODO state change, the new state is expected in STATE.
13209 When FINDPOS is non-nil, find the correct position for the note in
13210 the current entry. If not, assume that it can be inserted at point.
13211 HOW is an indicator what kind of note should be created.
13212 EXTRA is additional text that will be inserted into the notes buffer."
13213 (let* ((org-log-into-drawer (org-log-into-drawer))
13214 (drawer (cond ((stringp org-log-into-drawer)
13215 org-log-into-drawer)
13216 (org-log-into-drawer "LOGBOOK"))))
13217 (save-restriction
13218 (save-excursion
13219 (when findpos
13220 (org-back-to-heading t)
13221 (narrow-to-region (point) (save-excursion
13222 (outline-next-heading) (point)))
13226 (goto-char (match-end 0))
13227 (cond
13228 (drawer
13230 nil t)
13231 (progn
13232 (goto-char (match-end 0))
13233 (or org-log-states-order-reversed
13234 (and (re-search-forward org-property-end-re nil t)
13235 (goto-char (1- (match-beginning 0))))))
13237 (beginning-of-line 0)
13238 (org-indent-line)
13239 (beginning-of-line 2)
13240 (org-indent-line)
13241 (end-of-line 0)))
13242 ((and org-log-state-notes-insert-after-drawers
13243 (save-excursion
13244 (forward-line) (looking-at org-drawer-regexp)))
13245 (forward-line)
13246 (while (looking-at org-drawer-regexp)
13247 (goto-char (match-end 0))
13248 (re-search-forward org-property-end-re (point-max) t)
13249 (forward-line))
13250 (forward-line -1)))
13251 (unless org-log-states-order-reversed
13253 (org-skip-over-state-notes)
13255 (move-marker org-log-note-marker (point))
13256 (setq org-log-note-purpose purpose
13257 org-log-note-state state
13258 org-log-note-previous-state prev-state
13259 org-log-note-how how
13260 org-log-note-extra extra
13261 org-log-note-effective-time (org-current-effective-time))
13262 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13264 (defun org-skip-over-state-notes ()
13265 "Skip past the list of State notes in an entry."
13267 (when (ignore-errors (goto-char (org-in-item-p)))
13268 (let* ((struct (org-list-struct))
13269 (prevs (org-list-prevs-alist struct)))
13271 (goto-char (or (org-list-get-next-item (point) struct prevs)
13272 (org-list-get-item-end (point) struct)))))))
13274 (defun org-add-log-note (&optional purpose)
13275 "Pop up a window for taking a note, and add this note later at point."
13276 (remove-hook 'post-command-hook 'org-add-log-note)
13277 (setq org-log-note-window-configuration (current-window-configuration))
13278 (delete-other-windows)
13279 (move-marker org-log-note-return-to (point))
13280 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13281 (goto-char org-log-note-marker)
13282 (org-switch-to-buffer-other-window "*Org Note*")
13283 (erase-buffer)
13284 (if (memq org-log-note-how '(time state))
13285 (let (current-prefix-arg) (org-store-log-note))
13286 (let ((org-inhibit-startup t)) (org-mode))
13287 (insert (format "# Insert note for %s.
13289 (cond
13290 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13291 ((eq org-log-note-purpose 'done) "closed todo item")
13292 ((eq org-log-note-purpose 'state)
13294 (or org-log-note-previous-state "")
13295 (or org-log-note-state "")))
13296 ((eq org-log-note-purpose 'reschedule)
13297 "rescheduling")
13298 ((eq org-log-note-purpose 'delschedule)
13299 "no longer scheduled")
13300 ((eq org-log-note-purpose 'redeadline)
13301 "changing deadline")
13302 ((eq org-log-note-purpose 'deldeadline)
13303 "removing deadline")
13304 ((eq org-log-note-purpose 'refile)
13305 "refiling")
13306 ((eq org-log-note-purpose 'note)
13307 "this entry")
13308 (t (error "This should not happen")))))
13309 (if org-log-note-extra (insert org-log-note-extra))
13310 (org-set-local 'org-finish-function 'org-store-log-note)
13311 (run-hooks 'org-log-buffer-setup-hook)))
13313 (defvar org-note-abort nil) ; dynamically scoped
13314 (defun org-store-log-note ()
13315 "Finish taking a log note, and insert it to where it belongs."
13316 (let ((txt (buffer-string)))
13317 (kill-buffer (current-buffer))
13318 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13319 lines ind bul)
13321 (setq txt (replace-match "" t t txt)))
13323 (setq txt (replace-match "" t t txt)))
13326 (setq note
13327 (org-replace-escapes
13328 note
13329 (list (cons "%u" (user-login-name))
13330 (cons "%U" user-full-name)
13331 (cons "%t" (format-time-string
13332 (org-time-stamp-format 'long 'inactive)
13333 org-log-note-effective-time))
13334 (cons "%T" (format-time-string
13335 (org-time-stamp-format 'long nil)
13336 org-log-note-effective-time))
13337 (cons "%d" (format-time-string
13338 (org-time-stamp-format nil 'inactive)
13339 org-log-note-effective-time))
13340 (cons "%D" (format-time-string
13341 (org-time-stamp-format nil nil)
13342 org-log-note-effective-time))
13343 (cons "%s" (if org-log-note-state
13345 ""))
13346 (cons "%S" (if org-log-note-previous-state
13350 (push note lines))
13351 (when (or current-prefix-arg org-note-abort)
13352 (when org-log-into-drawer
13353 (org-remove-empty-drawer-at
13354 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13355 org-log-note-marker))
13356 (setq lines nil))
13357 (when lines
13358 (with-current-buffer (marker-buffer org-log-note-marker)
13359 (save-excursion
13360 (goto-char org-log-note-marker)
13361 (move-marker org-log-note-marker nil)
13362 (end-of-line 1)
13364 (setq ind (save-excursion
13365 (if (ignore-errors (goto-char (org-in-item-p)))
13366 (let ((struct (org-list-struct)))
13367 (org-list-get-ind
13368 (org-list-get-top-point struct) struct))
13370 (cond
13371 ((and (org-at-heading-p)
13372 org-adapt-indentation)
13373 (1+ (org-current-level)))
13374 ((org-at-heading-p) 0)
13375 (t (org-get-indentation))))))
13376 (setq bul (org-list-bullet-string "-"))
13377 (org-indent-line-to ind)
13378 (insert bul (pop lines))
13379 (let ((ind-body (+ (length bul) ind)))
13380 (while lines
13382 (org-indent-line-to ind-body)
13383 (insert (pop lines))))
13384 (message "Note stored")
13385 (org-back-to-heading t)
13386 (org-cycle-hide-drawers 'children))
13387 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13388 ;; from within `org-add-log-note' because `buffer-undo-list'
13389 ;; is then modified outside of `org-with-remote-undo'.
13390 (when (eq this-command 'org-agenda-todo)
13391 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13392 ;; Don't add undo information when called from `org-agenda-todo'
13393 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13394 (set-window-configuration org-log-note-window-configuration)
13395 (with-current-buffer (marker-buffer org-log-note-return-to)
13396 (goto-char org-log-note-return-to))
13397 (move-marker org-log-note-return-to nil)
13398 (and org-log-post-message (message "%s" org-log-post-message))))
13400 (defun org-remove-empty-drawer-at (drawer pos)
13401 "Remove an empty drawer DRAWER at position POS.
13402 POS may also be a marker."
13403 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13404 (save-excursion
13405 (save-restriction
13406 (widen)
13407 (goto-char pos)
13408 (if (org-in-regexp
13410 (replace-match ""))))))
13412 (defvar org-ts-type nil)
13413 (defun org-sparse-tree (&optional arg type)
13414 "Create a sparse tree, prompt for the details.
13415 This command can create sparse trees. You first need to select the type
13416 of match used to create the tree:
13418 t Show all TODO entries.
13419 T Show entries with a specific TODO keyword.
13420 m Show entries selected by a tags/property match.
13421 p Enter a property name and its value (both with completion on existing
13422 names/values) and show entries with that property.
13423 r Show entries matching a regular expression (`/' can be used as well).
13424 b Show deadlines and scheduled items before a date.
13425 a Show deadlines and scheduled items after a date.
13426 d Show deadlines due within `org-deadline-warning-days'.
13427 D Show deadlines and scheduled items between a date range."
13428 (interactive "P")
13429 (let (ans kwd value ts-type)
13430 (setq type (or type org-sparse-tree-default-date-type))
13431 (setq org-ts-type type)
13432 (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"
13433 (cond ((eq type 'all) "all timestamps")
13434 ((eq type 'scheduled) "only scheduled")
13435 ((eq type 'deadline) "only deadline")
13436 ((eq type 'active) "only active timestamps")
13437 ((eq type 'inactive) "only inactive timestamps")
13438 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13439 ((eq type 'closed) "with a closed time-stamp")
13440 (t "scheduled/deadline")))
13441 (setq ans (read-char-exclusive))
13442 (cond
13443 ((equal ans ?c)
13444 (org-sparse-tree
13445 arg (cadr (member type '(scheduled-or-deadline
13446 all scheduled deadline active inactive closed)))))
13447 ((equal ans ?d)
13448 (call-interactively 'org-check-deadlines))
13449 ((equal ans ?b)
13450 (call-interactively 'org-check-before-date))
13451 ((equal ans ?a)
13452 (call-interactively 'org-check-after-date))
13453 ((equal ans ?D)
13454 (call-interactively 'org-check-dates-range))
13455 ((equal ans ?t)
13456 (call-interactively 'org-show-todo-tree))
13457 ((equal ans ?T)
13458 (org-show-todo-tree '(4)))
13459 ((member ans '(?T ?m))
13460 (call-interactively 'org-match-sparse-tree))
13461 ((member ans '(?p ?P))
13462 (setq kwd (org-icompleting-read "Property: "
13463 (mapcar 'list (org-buffer-property-keys))))
13464 (setq value (org-icompleting-read "Value: "
13465 (mapcar 'list (org-property-values kwd))))
13468 (org-match-sparse-tree arg (concat kwd "=" value)))
13469 ((member ans '(?r ?R ?/))
13470 (call-interactively 'org-occur))
13473 (defvar org-occur-highlights nil
13474 "List of overlays used for occur matches.")
13475 (make-variable-buffer-local 'org-occur-highlights)
13476 (defvar org-occur-parameters nil
13477 "Parameters of the active org-occur calls.
13478 This is a list, each call to org-occur pushes as cons cell,
13479 containing the regular expression and the callback, onto the list.
13480 The list can contain several entries if `org-occur' has been called
13481 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13482 will only contain one set of parameters. When the highlights are
13483 removed (for example with `C-c C-c', or with the next edit (depending
13484 on `org-remove-highlights-with-change'), this variable is emptied
13485 as well.")
13486 (make-variable-buffer-local 'org-occur-parameters)
13488 (defun org-occur (regexp &optional keep-previous callback)
13489 "Make a compact tree which shows all matches of REGEXP.
13490 The tree will show the lines where the regexp matches, and all higher
13491 headlines above the match. It will also show the heading after the match,
13492 to make sure editing the matching entry is easy.
13493 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13494 call to `org-occur' will be kept, to allow stacking of calls to this
13495 command.
13496 If CALLBACK is non-nil, it is a function which is called to confirm
13497 that the match should indeed be shown."
13499 (when (equal regexp "")
13500 (user-error "Regexp cannot be empty"))
13501 (unless keep-previous
13502 (org-remove-occur-highlights nil nil t))
13503 (push (cons regexp callback) org-occur-parameters)
13504 (let ((cnt 0))
13505 (save-excursion
13506 (goto-char (point-min))
13507 (if (or (not keep-previous) ; do not want to keep
13508 (not org-occur-highlights)) ; no previous matches
13509 ;; hide everything
13510 (org-overview))
13511 (while (re-search-forward regexp nil t)
13512 (when (or (not callback)
13513 (save-match-data (funcall callback)))
13514 (setq cnt (1+ cnt))
13515 (when org-highlight-sparse-tree-matches
13516 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13517 (org-show-context 'occur-tree))))
13518 (when org-remove-highlights-with-change
13519 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13520 nil 'local))
13521 (unless org-sparse-tree-open-archived-trees
13522 (org-hide-archived-subtrees (point-min) (point-max)))
13523 (run-hooks 'org-occur-hook)
13524 (if (org-called-interactively-p 'interactive)
13525 (message "%d match(es) for regexp %s" cnt regexp))
13526 cnt))
13528 (defun org-occur-next-match (&optional n reset)
13529 "Function for `next-error-function' to find sparse tree matches.
13530 N is the number of matches to move, when negative move backwards.
13531 RESET is entirely ignored - this function always goes back to the
13532 starting point when no match is found."
13533 (let* ((limit (if (< n 0) (point-min) (point-max)))
13534 (search-func (if (< n 0)
13535 'previous-single-char-property-change
13536 'next-single-char-property-change))
13537 (n (abs n))
13538 (pos (point))
13539 p1)
13540 (catch 'exit
13541 (while (setq p1 (funcall search-func (point) 'org-type))
13542 (when (equal p1 limit)
13543 (goto-char pos)
13544 (error "No more matches"))
13545 (when (equal (get-char-property p1 'org-type) 'org-occur)
13546 (setq n (1- n))
13547 (when (= n 0)
13548 (goto-char p1)
13549 (throw 'exit (point))))
13550 (goto-char p1))
13551 (goto-char p1)
13552 (error "No more matches"))))
13554 (defun org-show-context (&optional key)
13555 "Make sure point and context are visible.
13556 How much context is shown depends upon the variables
13557 `org-show-hierarchy-above', `org-show-following-heading',
13558 `org-show-entry-below' and `org-show-siblings'."
13559 (let ((heading-p (org-at-heading-p t))
13560 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13561 (following-p (org-get-alist-option org-show-following-heading key))
13562 (entry-p (org-get-alist-option org-show-entry-below key))
13563 (siblings-p (org-get-alist-option org-show-siblings key)))
13564 ;; Show heading or entry text
13565 (if (and heading-p (not entry-p))
13566 (org-flag-heading nil) ; only show the heading
13567 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13568 (org-show-hidden-entry))) ; show entire entry
13569 (when following-p
13570 ;; Show next sibling, or heading below text
13571 (save-excursion
13572 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13573 (org-flag-heading nil))))
13574 (when siblings-p (org-show-siblings))
13575 (when hierarchy-p
13576 ;; show all higher headings, possibly with siblings
13577 (save-excursion
13578 (while (and (condition-case nil
13579 (progn (org-up-heading-all 1) t)
13580 (error nil))
13581 (not (bobp)))
13582 (org-flag-heading nil)
13583 (when siblings-p (org-show-siblings)))))
13584 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13586 (defvar org-reveal-start-hook nil
13587 "Hook run before revealing a location.")
13589 (defun org-reveal (&optional siblings)
13590 "Show current entry, hierarchy above it, and the following headline.
13591 This can be used to show a consistent set of context around locations
13592 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13593 not t for the search context.
13595 With optional argument SIBLINGS, on each level of the hierarchy all
13596 siblings are shown. This repairs the tree structure to what it would
13597 look like when opened with hierarchical calls to `org-cycle'.
13599 go to the parent and show the
13600 entire tree."
13601 (interactive "P")
13602 (run-hooks 'org-reveal-start-hook)
13603 (let ((org-show-hierarchy-above t)
13604 (org-show-following-heading t)
13605 (org-show-siblings (if siblings t org-show-siblings)))
13606 (org-show-context nil))
13607 (when (equal siblings '(16))
13608 (save-excursion
13609 (when (org-up-heading-safe)
13610 (org-show-subtree)
13611 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13613 (defun org-highlight-new-match (beg end)
13614 "Highlight from BEG to END and mark the highlight is an occur headline."
13615 (let ((ov (make-overlay beg end)))
13616 (overlay-put ov 'face 'secondary-selection)
13617 (overlay-put ov 'org-type 'org-occur)
13618 (push ov org-occur-highlights)))
13620 (defun org-remove-occur-highlights (&optional beg end noremove)
13621 "Remove the occur highlights from the buffer.
13622 BEG and END are ignored. If NOREMOVE is nil, remove this function
13623 from the `before-change-functions' in the current buffer."
13624 (interactive)
13625 (unless org-inhibit-highlight-removal
13626 (mapc 'delete-overlay org-occur-highlights)
13627 (setq org-occur-highlights nil)
13628 (setq org-occur-parameters nil)
13629 (unless noremove
13630 (remove-hook 'before-change-functions
13631 'org-remove-occur-highlights 'local))))
13633 ;;;; Priorities
13636 "Regular expression matching the priority indicator.")
13638 (defvar org-remove-priority-next-time nil)
13640 (defun org-priority-up ()
13641 "Increase the priority of the current item."
13642 (interactive)
13643 (org-priority 'up))
13645 (defun org-priority-down ()
13646 "Decrease the priority of the current item."
13647 (interactive)
13648 (org-priority 'down))
13650 (defun org-priority (&optional action show)
13651 "Change the priority of an item.
13652 ACTION can be `set', `up', `down', or a character."
13653 (interactive "P")
13654 (if (equal action '(4))
13655 (org-show-priority)
13656 (unless org-enable-priority-commands
13657 (user-error "Priority commands are disabled"))
13658 (setq action (or action 'set))
13659 (let (current new news have remove)
13660 (save-excursion
13661 (org-back-to-heading t)
13662 (if (looking-at org-priority-regexp)
13663 (setq current (string-to-char (match-string 2))
13664 have t))
13665 (cond
13666 ((eq action 'remove)
13667 (setq remove t new ?\ ))
13668 ((or (eq action 'set)
13669 (if (featurep 'xemacs) (characterp action) (integerp action)))
13670 (if (not (eq action 'set))
13671 (setq new action)
13672 (message "Priority %c-%c, SPC to remove: "
13673 org-highest-priority org-lowest-priority)
13674 (save-match-data
13675 (setq new (read-char-exclusive))))
13676 (if (and (= (upcase org-highest-priority) org-highest-priority)
13677 (= (upcase org-lowest-priority) org-lowest-priority))
13678 (setq new (upcase new)))
13679 (cond ((equal new ?\ ) (setq remove t))
13680 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13681 (user-error "Priority must be between `%c' and `%c'"
13682 org-highest-priority org-lowest-priority))))
13683 ((eq action 'up)
13684 (setq new (if have
13685 (1- current) ; normal cycling
13686 ;; last priority was empty
13687 (if (eq last-command this-command)
13688 org-lowest-priority ; wrap around empty to lowest
13689 ;; default
13690 (if org-priority-start-cycle-with-default
13691 org-default-priority
13692 (1- org-default-priority))))))
13693 ((eq action 'down)
13694 (setq new (if have
13695 (1+ current) ; normal cycling
13696 ;; last priority was empty
13697 (if (eq last-command this-command)
13698 org-highest-priority ; wrap around empty to highest
13699 ;; default
13700 (if org-priority-start-cycle-with-default
13701 org-default-priority
13702 (1+ org-default-priority))))))
13703 (t (user-error "Invalid action")))
13704 (if (or (< (upcase new) org-highest-priority)
13705 (> (upcase new) org-lowest-priority))
13706 (if (and (memq action '(up down))
13707 (not have) (not (eq last-command this-command)))
13708 ;; `new' is from default priority
13709 (error
13710 "The default can not be set, see `org-default-priority' why")
13711 ;; normal cycling: `new' is beyond highest/lowest priority
13712 ;; and is wrapped around to the empty priority
13713 (setq remove t)))
13714 (setq news (format "%c" new))
13715 (if have
13716 (if remove
13717 (replace-match "" t t nil 1)
13718 (replace-match news t t nil 2))
13719 (if remove
13720 (user-error "No priority cookie found in line")
13721 (let ((case-fold-search nil))
13722 (looking-at org-todo-line-regexp))
13723 (if (match-end 2)
13724 (progn
13725 (goto-char (match-end 2))
13726 (insert " [#" news "]"))
13727 (goto-char (match-beginning 3))
13728 (insert "[#" news "] "))))
13729 (org-preserve-lc (org-set-tags nil 'align)))
13730 (if remove
13731 (message "Priority removed")
13732 (message "Priority of current item set to %s" news)))))
13734 (defun org-show-priority ()
13735 "Show the priority of the current item.
13736 This priority is composed of the main priority given with the [#A] cookies,
13737 and by additional input from the age of a schedules or deadline entry."
13738 (interactive)
13739 (let ((pri (if (eq major-mode 'org-agenda-mode)
13740 (org-get-at-bol 'priority)
13741 (save-excursion
13742 (save-match-data
13743 (beginning-of-line)
13744 (and (looking-at org-heading-regexp)
13745 (org-get-priority (match-string 0))))))))
13746 (message "Priority is %d" (if pri pri -1000))))
13748 (defun org-get-priority (s)
13749 "Find priority cookie and return priority."
13750 (save-match-data
13751 (if (functionp org-get-priority-function)
13752 (funcall org-get-priority-function)
13753 (if (not (string-match org-priority-regexp s))
13754 (* 1000 (- org-lowest-priority org-default-priority))
13755 (* 1000 (- org-lowest-priority
13756 (string-to-char (match-string 2 s))))))))
13758 ;;;; Tags
13760 (defvar org-agenda-archives-mode)
13761 (defvar org-map-continue-from nil
13762 "Position from where mapping should continue.
13763 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13765 (defvar org-scanner-tags nil
13766 "The current tag list while the tags scanner is running.")
13767 (defvar org-trust-scanner-tags nil
13768 "Should `org-get-tags-at' use the tags for the scanner.
13769 This is for internal dynamical scoping only.
13770 When this is non-nil, the function `org-get-tags-at' will return the value
13771 of `org-scanner-tags' instead of building the list by itself. This
13772 can lead to large speed-ups when the tags scanner is used in a file with
13773 many entries, and when the list of tags is retrieved, for example to
13774 obtain a list of properties. Building the tags list for each entry in such
13775 a file becomes an N^2 operation - but with this variable set, it scales
13776 as N.")
13778 (defun org-scan-tags (action matcher todo-only &optional start-level)
13779 "Sca headline tags with inheritance and produce output ACTION.
13781 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13782 or `agenda' to produce an entry list for an agenda view. It can also be
13783 a Lisp form or a function that should be called at each matched headline, in
13784 this case the return value is a list of all return values from these calls.
13786 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13787 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13788 only lines with a not-done TODO keyword are included in the output.
13789 This should be the same variable that was scoped into
13790 and set by `org-make-tags-matcher' when it constructed MATCHER.
13792 START-LEVEL can be a string with asterisks, reducing the scope to
13793 headlines matching this string."
13794 (require 'org-agenda)
13795 (let* ((re (concat "^"
13796 (if start-level
13797 ;; Get the correct level to match
13799 org-outline-regexp)
13803 (props (list 'face 'default
13804 'done-face 'org-agenda-done
13805 'undone-face 'default
13806 'mouse-face 'highlight
13807 'org-not-done-regexp org-not-done-regexp
13808 'org-todo-regexp org-todo-regexp
13809 'org-complex-heading-regexp org-complex-heading-regexp
13810 'help-echo
13811 (format "mouse-2 or RET jump to org file %s"
13812 (abbreviate-file-name
13813 (or (buffer-file-name (buffer-base-buffer))
13814 (buffer-name (buffer-base-buffer)))))))
13815 (org-map-continue-from nil)
13816 lspos tags tags-list
13817 (tags-alist (list (cons 0 org-file-tags)))
13818 (llast 0) rtn rtn1 level category i txt
13819 todo marker entry priority)
13820 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13821 (setq action (list 'lambda nil action)))
13822 (save-excursion
13823 (goto-char (point-min))
13824 (when (eq action 'sparse-tree)
13825 (org-overview)
13826 (org-remove-occur-highlights))
13827 (while (let (case-fold-search)
13828 (re-search-forward re nil t))
13829 (setq org-map-continue-from nil)
13830 (catch :skip
13831 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13832 tags (if (match-end 4) (org-match-string-no-properties 4)))
13833 (goto-char (setq lspos (match-beginning 0)))
13834 (setq level (org-reduced-level (org-outline-level))
13835 category (org-get-category))
13836 (setq i llast llast level)
13837 ;; remove tag lists from same and sublevels
13838 (while (>= i level)
13839 (when (setq entry (assoc i tags-alist))
13840 (setq tags-alist (delete entry tags-alist)))
13841 (setq i (1- i)))
13842 ;; add the next tags
13843 (when tags
13844 (setq tags (org-split-string tags ":")
13845 tags-alist
13846 (cons (cons level tags) tags-alist)))
13847 ;; compile tags for current headline
13848 (setq tags-list
13849 (if org-use-tag-inheritance
13850 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13851 tags)
13852 org-scanner-tags tags-list)
13853 (when org-use-tag-inheritance
13854 (setcdr (car tags-alist)
13855 (mapcar (lambda (x)
13856 (setq x (copy-sequence x))
13857 (org-add-prop-inherited x))
13858 (cdar tags-alist))))
13859 (when (and tags org-use-tag-inheritance
13860 (or (not (eq t org-use-tag-inheritance))
13861 org-tags-exclude-from-inheritance))
13862 ;; selective inheritance, remove uninherited ones
13863 (setcdr (car tags-alist)
13864 (org-remove-uninherited-tags (cdar tags-alist))))
13865 (when (and
13867 ;; eval matcher only when the todo condition is OK
13868 (and (or (not todo-only) (member todo org-not-done-keywords))
13869 (let ((case-fold-search t) (org-trust-scanner-tags t))
13870 (eval matcher)))
13872 ;; Call the skipper, but return t if it does not skip,
13873 ;; so that the `and' form continues evaluating
13874 (progn
13875 (unless (eq action 'sparse-tree) (org-agenda-skip))
13876 t)
13878 ;; Check if timestamps are deselecting this entry
13879 (or (not todo-only)
13880 (and (member todo org-not-done-keywords)
13881 (or (not org-agenda-tags-todo-honor-ignore-options)
13882 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13884 ;; select this headline
13885 (cond
13886 ((eq action 'sparse-tree)
13887 (and org-highlight-sparse-tree-matches
13888 (org-get-heading) (match-end 0)
13889 (org-highlight-new-match
13890 (match-beginning 1) (match-end 1)))
13891 (org-show-context 'tags-tree))
13892 ((eq action 'agenda)
13893 (setq txt (org-agenda-format-item
13894 ""
13895 (concat
13896 (if (eq org-tags-match-list-sublevels 'indented)
13897 (make-string (1- level) ?.) "")
13898 (org-get-heading))
13899 level category
13900 tags-list)
13901 priority (org-get-priority txt))
13902 (goto-char lspos)
13903 (setq marker (org-agenda-new-marker))
13904 (org-add-props txt props
13905 'org-marker marker 'org-hd-marker marker 'org-category category
13906 'todo-state todo
13907 'priority priority 'type "tagsmatch")
13908 (push txt rtn))
13909 ((functionp action)
13910 (setq org-map-continue-from nil)
13911 (save-excursion
13912 (setq rtn1 (funcall action))
13913 (push rtn1 rtn)))
13914 (t (user-error "Invalid action")))
13916 ;; if we are to skip sublevels, jump to end of subtree
13917 (unless org-tags-match-list-sublevels
13918 (org-end-of-subtree t)
13919 (backward-char 1))))
13920 ;; Get the correct position from where to continue
13921 (if org-map-continue-from
13922 (goto-char org-map-continue-from)
13923 (and (= (point) lspos) (end-of-line 1)))))
13924 (when (and (eq action 'sparse-tree)
13925 (not org-sparse-tree-open-archived-trees))
13926 (org-hide-archived-subtrees (point-min) (point-max)))
13927 (nreverse rtn)))
13929 (defun org-remove-uninherited-tags (tags)
13930 "Remove all tags that are not inherited from the list TAGS."
13931 (cond
13932 ((eq org-use-tag-inheritance t)
13933 (if org-tags-exclude-from-inheritance
13934 (org-delete-all org-tags-exclude-from-inheritance tags)
13935 tags))
13936 ((not org-use-tag-inheritance) nil)
13937 ((stringp org-use-tag-inheritance)
13938 (delq nil (mapcar
13939 (lambda (x)
13940 (if (and (string-match org-use-tag-inheritance x)
13941 (not (member x org-tags-exclude-from-inheritance)))
13942 x nil))
13943 tags)))
13944 ((listp org-use-tag-inheritance)
13945 (delq nil (mapcar
13946 (lambda (x)
13947 (if (member x org-use-tag-inheritance) x nil))
13948 tags)))))
13950 (defun org-match-sparse-tree (&optional todo-only match)
13951 "Create a sparse tree according to tags string MATCH.
13952 MATCH can contain positive and negative selection of tags, like
13954 If optional argument TODO-ONLY is non-nil, only select lines that are
13955 also TODO lines."
13956 (interactive "P")
13957 (org-agenda-prepare-buffers (list (current-buffer)))
13958 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13960 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13962 (defvar org-cached-props nil)
13963 (defun org-cached-entry-get (pom property)
13964 (if (or (eq t org-use-property-inheritance)
13965 (and (stringp org-use-property-inheritance)
13966 (string-match org-use-property-inheritance property))
13967 (and (listp org-use-property-inheritance)
13968 (member property org-use-property-inheritance)))
13969 ;; Caching is not possible, check it directly
13970 (org-entry-get pom property 'inherit)
13971 ;; Get all properties, so that we can do complicated checks easily
13972 (cdr (assoc property (or org-cached-props
13973 (setq org-cached-props
13974 (org-entry-properties pom)))))))
13976 (defun org-global-tags-completion-table (&optional files)
13977 "Return the list of all tags in all agenda buffer/files.
13978 Optional FILES argument is a list of files which can be used
13979 instead of the agenda files."
13980 (save-excursion
13981 (org-uniquify
13982 (delq nil
13983 (apply 'append
13984 (mapcar
13985 (lambda (file)
13986 (set-buffer (find-file-noselect file))
13987 (append (org-get-buffer-tags)
13988 (mapcar (lambda (x) (if (stringp (car-safe x))
13989 (list (car-safe x)) nil))
13990 org-tag-alist)))
13991 (if (and files (car files))
13992 files
13993 (org-agenda-files))))))))
13995 (defun org-make-tags-matcher (match)
13996 "Create the TAGS/TODO matcher form for the selection string MATCH.
13998 The variable `todo-only' is scoped dynamically into this function.
13999 It will be set to t if the matcher restricts matching to TODO entries,
14000 otherwise will not be touched.
14002 Returns a cons of the selection string MATCH and the constructed
14003 lisp form implementing the matcher. The matcher is to be evaluated
14004 at an Org entry, with point on the headline, and returns t if the
14005 entry matches the selection string MATCH. The returned lisp form
14006 references two variables with information about the entry, which
14007 must be bound around the form's evaluation: todo, the TODO keyword
14008 at the entry (or nil of none); and tags-list, the list of all tags
14009 at the entry including inherited ones. Additionally, the category
14010 of the entry (if any) must be specified as the text property
14011 'org-category on the headline.
14013 See also `org-scan-tags'.
14014 "
14015 (declare (special todo-only))
14016 (unless (boundp 'todo-only)
14017 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14018 (unless match
14019 ;; Get a new match request, with completion against the global
14020 ;; tags table and the local tags in current buffer
14021 (let ((org-last-tags-completion-table
14022 (org-uniquify
14023 (delq nil (append (org-get-buffer-tags)
14024 (org-global-tags-completion-table))))))
14025 (setq match (org-completing-read-no-i
14026 "Match: " 'org-tags-completion-function nil nil nil
14027 'org-tags-history))))
14029 ;; Parse the string and create a lisp form
14030 (let ((match0 match)
14031 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14032 minus tag mm
14033 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14034 orterms term orlist re-p str-p level-p level-op time-p
14035 prop-p pn pv po gv rest)
14036 ;; Expand group tags
14037 (setq match (org-tags-expand match))
14038 (if (string-match "/+" match)
14039 ;; match contains also a todo-matching request
14040 (progn
14041 (setq tagsmatch (substring match 0 (match-beginning 0))
14042 todomatch (substring match (match-end 0)))
14043 (if (string-match "^!" todomatch)
14044 (setq todo-only t todomatch (substring todomatch 1)))
14046 (setq todomatch nil)))
14047 ;; only matching tags
14048 (setq tagsmatch match todomatch nil))
14050 ;; Make the tags matcher
14052 (setq tagsmatcher t)
14053 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14054 (while (setq term (pop orterms))
14056 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14057 (while (string-match re term)
14058 (setq rest (substring term (match-end 0))
14059 minus (and (match-end 1)
14060 (equal (match-string 1 term) "-"))
14061 tag (save-match-data (replace-regexp-in-string
14063 (match-string 2 term)))
14064 re-p (equal (string-to-char tag) ?{)
14065 level-p (match-end 4)
14066 prop-p (match-end 5)
14067 mm (cond
14068 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14069 (level-p
14070 (setq level-op (org-op-to-function (match-string 3 term)))
14071 `(,level-op level ,(string-to-number
14072 (match-string 4 term))))
14073 (prop-p
14074 (setq pn (match-string 5 term)
14075 po (match-string 6 term)
14076 pv (match-string 7 term)
14077 re-p (equal (string-to-char pv) ?{)
14079 time-p (save-match-data
14081 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14082 (if time-p (setq pv (org-matcher-time pv)))
14083 (setq po (org-op-to-function po (if time-p 'time str-p)))
14084 (cond
14085 ((equal pn "CATEGORY")
14086 (setq gv '(get-text-property (point) 'org-category)))
14087 ((equal pn "TODO")
14088 (setq gv 'todo))
14089 (t
14090 (setq gv `(org-cached-entry-get nil ,pn))))
14091 (if re-p
14092 (if (eq po 'org<>)
14093 `(not (string-match ,pv (or ,gv "")))
14094 `(string-match ,pv (or ,gv "")))
14095 (if str-p
14096 `(,po (or ,gv "") ,pv)
14097 `(,po (string-to-number (or ,gv ""))
14098 ,(string-to-number pv) ))))
14099 (t `(member ,tag tags-list)))
14100 mm (if minus (list 'not mm) mm)
14101 term rest)
14102 (push mm tagsmatcher))
14103 (push (if (> (length tagsmatcher) 1)
14104 (cons 'and tagsmatcher)
14105 (car tagsmatcher))
14106 orlist)
14107 (setq tagsmatcher nil))
14108 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14109 (setq tagsmatcher
14110 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14111 ;; Make the todo matcher
14113 (setq todomatcher t)
14114 (setq orterms (org-split-string todomatch "|") orlist nil)
14115 (while (setq term (pop orterms))
14116 (while (string-match re term)
14117 (setq minus (and (match-end 1)
14118 (equal (match-string 1 term) "-"))
14119 kwd (match-string 2 term)
14120 re-p (equal (string-to-char kwd) ?{)
14121 term (substring term (match-end 0))
14122 mm (if re-p
14123 `(string-match ,(substring kwd 1 -1) todo)
14124 (list 'equal 'todo kwd))
14125 mm (if minus (list 'not mm) mm))
14126 (push mm todomatcher))
14127 (push (if (> (length todomatcher) 1)
14128 (cons 'and todomatcher)
14129 (car todomatcher))
14130 orlist)
14131 (setq todomatcher nil))
14132 (setq todomatcher (if (> (length orlist) 1)
14133 (cons 'or orlist) (car orlist))))
14135 ;; Return the string and lisp forms of the matcher
14136 (setq matcher (if todomatcher
14137 (list 'and tagsmatcher todomatcher)
14138 tagsmatcher))
14139 (when todo-only
14140 (setq matcher (list 'and '(member todo org-not-done-keywords)
14141 matcher)))
14142 (cons match0 matcher)))
14144 (defun org-tags-expand (match &optional single-as-list downcased)
14145 "Expand group tags in MATCH.
14147 This replaces every group tag in MATCH with a regexp tag search.
14149 will be replaced like this:
14155 Replacing by a regexp preserves the structure of the match.
14156 E.g., this expansion
14163 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14164 assumed to be a single group tag, and the function will return
14165 the list of tags in this group.
14167 When DOWNCASE is non-nil, expand downcased TAGS."
14168 (if org-group-tags
14169 (let* ((case-fold-search t)
14170 (stable org-mode-syntax-table)
14171 (tal (or org-tag-groups-alist-for-agenda
14172 org-tag-groups-alist))
14173 (tal (if downcased
14174 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14175 (tml (mapcar 'car tal))
14176 (rtnmatch match) rpl)
14177 ;; @ and _ are allowed as word-components in tags
14178 (modify-syntax-entry ?@ "w" stable)
14179 (modify-syntax-entry ?_ "w" stable)
14180 (while (and tml
14181 (string-match
14184 (let* ((dir (match-string 1 rtnmatch))
14185 (tag (match-string 2 rtnmatch))
14186 (tag (if downcased (downcase tag) tag)))
14187 (setq tml (delete tag tml))
14188 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14189 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14191 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14192 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14193 (if single-as-list
14194 (or (reverse rpl) (list rtnmatch))
14195 rtnmatch))
14196 (if single-as-list (list (if downcased (downcase match) match))
14197 match)))
14199 (defun org-op-to-function (op &optional stringp)
14200 "Turn an operator into the appropriate function."
14201 (setq op
14202 (cond
14203 ((equal op "<" ) '(< string< org-time<))
14204 ((equal op ">" ) '(> org-string> org-time>))
14205 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14206 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14207 ((member op '("=" "==")) '(= string= org-time=))
14208 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14209 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14211 (defun org<> (a b) (not (= a b)))
14212 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14213 (defun org-string>= (a b) (not (string< a b)))
14214 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14215 (defun org-string<> (a b) (not (string= a b)))
14216 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14217 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14218 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14219 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14220 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14221 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14222 (defun org-2ft (s)
14223 "Convert S to a floating point time.
14224 If S is already a number, just return it. If it is a string, parse
14225 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14226 (cond
14227 ((numberp s) s)
14228 ((stringp s)
14229 (condition-case nil
14230 (float-time (apply 'encode-time (org-parse-time-string s)))
14231 (error 0.)))
14232 (t 0.)))
14234 (defun org-time-today ()
14235 "Time in seconds today at 0:00.
14236 Returns the float number of seconds since the beginning of the
14237 epoch to the beginning of today (00:00)."
14238 (float-time (apply 'encode-time
14239 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14241 (defun org-matcher-time (s)
14242 "Interpret a time comparison value."
14243 (save-match-data
14244 (cond
14245 ((string= s "<now>") (float-time))
14246 ((string= s "<today>") (org-time-today))
14247 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14248 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14250 (+ (org-time-today)
14251 (* (string-to-number (match-string 1 s))
14252 (cdr (assoc (match-string 2 s)
14253 '(("d" . 86400.0) ("w" . 604800.0)
14254 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14255 (t (org-2ft s)))))
14257 (defun org-match-any-p (re list)
14258 "Does re match any element of list?"
14259 (setq list (mapcar (lambda (x) (string-match re x)) list))
14260 (delq nil list))
14262 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14263 (defvar org-tags-overlay (make-overlay 1 1))
14264 (org-detach-overlay org-tags-overlay)
14266 (defun org-get-local-tags-at (&optional pos)
14267 "Get a list of tags defined in the current headline."
14268 (org-get-tags-at pos 'local))
14270 (defun org-get-local-tags ()
14271 "Get a list of tags defined in the current headline."
14272 (org-get-tags-at nil 'local))
14274 (defun org-get-tags-at (&optional pos local)
14275 "Get a list of all headline tags applicable at POS.
14276 POS defaults to point. If tags are inherited, the list contains
14277 the targets in the same sequence as the headlines appear, i.e.
14278 the tags of the current headline come last.
14279 When LOCAL is non-nil, only return tags from the current headline,
14280 ignore inherited ones."
14281 (interactive)
14282 (if (and org-trust-scanner-tags
14283 (or (not pos) (equal pos (point)))
14284 (not local))
14285 org-scanner-tags
14286 (let (tags ltags lastpos parent)
14287 (save-excursion
14288 (save-restriction
14289 (widen)
14290 (goto-char (or pos (point)))
14291 (save-match-data
14292 (catch 'done
14293 (condition-case nil
14294 (progn
14295 (org-back-to-heading t)
14296 (while (not (equal lastpos (point)))
14297 (setq lastpos (point))
14298 (when (looking-at
14300 (setq ltags (org-split-string
14301 (org-match-string-no-properties 1) ":"))
14302 (when parent
14303 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14304 (setq tags (append
14305 (if parent
14306 (org-remove-uninherited-tags ltags)
14307 ltags)
14308 tags)))
14309 (or org-use-tag-inheritance (throw 'done t))
14310 (if local (throw 'done t))
14311 (or (org-up-heading-safe) (error nil))
14312 (setq parent t)))
14313 (error nil)))))
14314 (if local
14315 tags
14316 (reverse (delete-dups
14317 (reverse (append
14318 (org-remove-uninherited-tags
14319 org-file-tags) tags)))))))))
14321 (defun org-add-prop-inherited (s)
14322 (add-text-properties 0 (length s) '(inherited t) s)
14323 s)
14325 (defun org-toggle-tag (tag &optional onoff)
14326 "Toggle the tag TAG for the current line.
14327 If ONOFF is `on' or `off', don't toggle but set to this state."
14328 (let (res current)
14329 (save-excursion
14330 (org-back-to-heading t)
14332 (point-at-eol) t)
14333 (progn
14334 (setq current (match-string 1))
14335 (replace-match ""))
14336 (setq current ""))
14337 (setq current (nreverse (org-split-string current ":")))
14338 (cond
14339 ((eq onoff 'on)
14340 (setq res t)
14341 (or (member tag current) (push tag current)))
14342 ((eq onoff 'off)
14343 (or (not (member tag current)) (setq current (delete tag current))))
14344 (t (if (member tag current)
14345 (setq current (delete tag current))
14346 (setq res t)
14347 (push tag current))))
14348 (end-of-line 1)
14349 (if current
14350 (progn
14351 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14352 (org-set-tags nil t))
14353 (delete-horizontal-space))
14354 (run-hooks 'org-after-tags-change-hook))
14355 res))
14357 (defun org-align-tags-here (to-col)
14358 ;; Assumes that this is a headline
14359 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14360 (beginning-of-line 1)
14362 (< pos (match-beginning 2)))
14363 (progn
14364 (setq tags-l (- (match-end 2) (match-beginning 2)))
14365 (goto-char (match-beginning 1))
14366 (insert " ")
14367 (delete-region (point) (1+ (match-beginning 2)))
14368 (setq ncol (max (current-column)
14369 (1+ col)
14370 (if (> to-col 0)
14371 to-col
14372 (- (abs to-col) tags-l))))
14373 (setq p (point))
14374 (insert (make-string (- ncol (current-column)) ?\ ))
14375 (setq ncol (current-column))
14376 (when indent-tabs-mode (tabify p (point-at-eol)))
14377 (org-move-to-column (min ncol col) t))
14378 (goto-char pos))))
14380 (defun org-set-tags-command (&optional arg just-align)
14381 "Call the set-tags command for the current entry."
14382 (interactive "P")
14383 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14384 (org-set-tags arg just-align)
14385 (save-excursion
14386 (unless (and (org-region-active-p)
14387 org-loop-over-headlines-in-active-region)
14388 (org-back-to-heading t))
14389 (org-set-tags arg just-align))))
14391 (defun org-set-tags-to (data)
14392 "Set the tags of the current entry to DATA, replacing the current tags.
14393 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14394 If DATA is nil or the empty string, any tags will be removed."
14395 (interactive "sTags: ")
14396 (setq data
14397 (cond
14398 ((eq data nil) "")
14399 ((equal data "") "")
14400 ((stringp data)
14401 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14402 ":"))
14403 ((listp data)
14404 (concat ":" (mapconcat 'identity data ":") ":"))))
14405 (when data
14406 (save-excursion
14407 (org-back-to-heading t)
14408 (when (looking-at org-complex-heading-regexp)
14409 (if (match-end 5)
14410 (progn
14411 (goto-char (match-beginning 5))
14412 (insert data)
14413 (delete-region (point) (point-at-eol))
14414 (org-set-tags nil 'align))
14415 (goto-char (point-at-eol))
14416 (insert " " data)
14417 (org-set-tags nil 'align)))
14418 (beginning-of-line 1)
14420 (delete-region (match-beginning 1) (match-end 1))))))
14422 (defun org-align-all-tags ()
14423 "Align the tags i all headings."
14424 (interactive)
14425 (save-excursion
14426 (or (ignore-errors (org-back-to-heading t))
14427 (outline-next-heading))
14428 (if (org-at-heading-p)
14429 (org-set-tags t)
14430 (message "No headings"))))
14432 (defvar org-indent-indentation-per-level)
14433 (defun org-set-tags (&optional arg just-align)
14434 "Set the tags for the current headline.
14435 With prefix ARG, realign all tags in headings in the current buffer."
14436 (interactive "P")
14437 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14438 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14439 'region-start-level 'region))
14440 org-loop-over-headlines-in-active-region)
14441 (org-map-entries
14442 ;; We don't use ARG and JUST-ALIGN here these args are not
14443 ;; useful when looping over headlines
14444 `(org-set-tags)
14445 org-loop-over-headlines-in-active-region
14446 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14447 (let* ((re org-outline-regexp-bol)
14448 (current (unless arg (org-get-tags-string)))
14449 (col (current-column))
14450 (org-setting-tags t)
14451 table current-tags inherited-tags ; computed below when needed
14452 tags p0 c0 c1 rpl di tc level)
14453 (if arg
14454 (save-excursion
14455 (goto-char (point-min))
14456 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14457 (while (re-search-forward re nil t)
14458 (org-set-tags nil t)
14459 (end-of-line 1)))
14460 (message "All tags realigned to column %d" org-tags-column))
14461 (if just-align
14462 (setq tags current)
14463 ;; Get a new set of tags from the user
14464 (save-excursion
14465 (setq table (append org-tag-persistent-alist
14466 (or org-tag-alist (org-get-buffer-tags))
14467 (and
14468 org-complete-tags-always-offer-all-agenda-tags
14469 (org-global-tags-completion-table
14470 (org-agenda-files))))
14471 org-last-tags-completion-table table
14472 current-tags (org-split-string current ":")
14473 inherited-tags (nreverse
14474 (nthcdr (length current-tags)
14475 (nreverse (org-get-tags-at))))
14476 tags
14477 (if (or (eq t org-use-fast-tag-selection)
14478 (and org-use-fast-tag-selection
14479 (delq nil (mapcar 'cdr table))))
14480 (org-fast-tag-selection
14481 current-tags inherited-tags table
14482 (if org-fast-tag-selection-include-todo
14483 org-todo-key-alist))
14484 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14485 (org-trim
14486 (org-icompleting-read "Tags: "
14487 'org-tags-completion-function
14488 nil nil current 'org-tags-history))))))
14489 (while (string-match "[-+&]+" tags)
14490 ;; No boolean logic, just a list
14491 (setq tags (replace-match ":" t t tags))))
14493 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14495 (if org-tags-sort-function
14496 (setq tags (mapconcat 'identity
14497 (sort (org-split-string
14498 tags (org-re "[^[:alnum:]_@#%]+"))
14499 org-tags-sort-function) ":")))
14502 (setq tags "")
14503 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14504 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14506 ;; Insert new tags at the correct column
14507 (beginning-of-line 1)
14508 (setq level (or (and (looking-at org-outline-regexp)
14509 (- (match-end 0) (point) 1))
14510 1))
14511 (cond
14512 ((and (equal current "") (equal tags "")))
14513 ((re-search-forward
14515 (point-at-eol) t)
14516 (if (equal tags "")
14517 (setq rpl "")
14518 (goto-char (match-beginning 0))
14519 (setq c0 (current-column)
14520 ;; compute offset for the case of org-indent-mode active
14521 di (if org-indent-mode
14522 (* (1- org-indent-indentation-per-level) (1- level))
14523 0)
14524 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14525 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14526 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14527 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14528 (replace-match rpl t t)
14529 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14530 tags)
14531 (t (error "Tags alignment failed")))
14532 (org-move-to-column col)
14533 (unless just-align
14534 (run-hooks 'org-after-tags-change-hook))))))
14536 (defun org-change-tag-in-region (beg end tag off)
14537 "Add or remove TAG for each entry in the region.
14538 This works in the agenda, and also in an org-mode buffer."
14539 (interactive
14540 (list (region-beginning) (region-end)
14541 (let ((org-last-tags-completion-table
14542 (if (derived-mode-p 'org-mode)
14543 (org-uniquify
14544 (delq nil (append (org-get-buffer-tags)
14545 (org-global-tags-completion-table))))
14546 (org-global-tags-completion-table))))
14547 (org-icompleting-read
14548 "Tag: " 'org-tags-completion-function nil nil nil
14549 'org-tags-history))
14550 (progn
14552 (equal (read-char-exclusive) ?r))))
14553 (if (fboundp 'deactivate-mark) (deactivate-mark))
14554 (let ((agendap (equal major-mode 'org-agenda-mode))
14555 l1 l2 m buf pos newhead (cnt 0))
14556 (goto-char end)
14557 (setq l2 (1- (org-current-line)))
14558 (goto-char beg)
14559 (setq l1 (org-current-line))
14560 (loop for l from l1 to l2 do
14561 (org-goto-line l)
14562 (setq m (get-text-property (point) 'org-hd-marker))
14563 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14564 (and agendap m))
14565 (setq buf (if agendap (marker-buffer m) (current-buffer))
14566 pos (if agendap m (point)))
14567 (with-current-buffer buf
14568 (save-excursion
14569 (save-restriction
14570 (goto-char pos)
14571 (setq cnt (1+ cnt))
14572 (org-toggle-tag tag (if off 'off 'on))
14573 (setq newhead (org-get-heading)))))
14574 (and agendap (org-agenda-change-all-lines newhead m))))
14575 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14577 (defun org-tags-completion-function (string predicate &optional flag)
14578 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14579 (confirm (lambda (x) (stringp (car x)))))
14581 (setq s1 (match-string 1 string)
14582 s2 (match-string 2 string))
14583 (setq s1 "" s2 string))
14584 (cond
14585 ((eq flag nil)
14586 ;; try completion
14587 (setq rtn (try-completion s2 ctable confirm))
14588 (if (stringp rtn)
14589 (setq rtn
14590 (concat s1 s2 (substring rtn (length s2))
14591 (if (and org-add-colon-after-tag-completion
14592 (assoc rtn ctable))
14593 ":" ""))))
14594 rtn)
14595 ((eq flag t)
14596 ;; all-completions
14597 (all-completions s2 ctable confirm))
14598 ((eq flag 'lambda)
14599 ;; exact match?
14600 (assoc s2 ctable)))))
14602 (defun org-fast-tag-insert (kwd tags face &optional end)
14603 "Insert KDW, and the TAGS, the latter with face FACE.
14604 Also insert END."
14605 (insert (format "%-12s" (concat kwd ":"))
14606 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14607 (or end "")))
14609 (defun org-fast-tag-show-exit (flag)
14610 (save-excursion
14611 (org-goto-line 3)
14613 (replace-match ""))
14614 (when flag
14615 (end-of-line 1)
14616 (org-move-to-column (- (window-width) 19) t)
14617 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14619 (defun org-set-current-tags-overlay (current prefix)
14620 "Add an overlay to CURRENT tag with PREFIX."
14621 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14622 (if (featurep 'xemacs)
14623 (org-overlay-display org-tags-overlay (concat prefix s)
14624 'secondary-selection)
14625 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14626 (org-overlay-display org-tags-overlay (concat prefix s)))))
14628 (defvar org-last-tag-selection-key nil)
14629 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14630 "Fast tag selection with single keys.
14631 CURRENT is the current list of tags in the headline, INHERITED is the
14632 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14633 possibly with grouping information. TODO-TABLE is a similar table with
14634 TODO keywords, should these have keys assigned to them.
14635 If the keys are nil, a-z are automatically assigned.
14636 Returns the new tags string, or nil to not change the current settings."
14637 (let* ((fulltable (append table todo-table))
14638 (maxlen (apply 'max (mapcar
14639 (lambda (x)
14640 (if (stringp (car x)) (string-width (car x)) 0))
14641 fulltable)))
14642 (buf (current-buffer))
14643 (expert (eq org-fast-tag-selection-single-key 'expert))
14644 (buffer-tags nil)
14645 (fwidth (+ maxlen 3 1 3))
14646 (ncol (/ (- (window-width) 4) fwidth))
14647 (i-face 'org-done)
14648 (c-face 'org-todo)
14649 tg cnt e c char c1 c2 ntable tbl rtn
14650 ov-start ov-end ov-prefix
14651 (exit-after-next org-fast-tag-selection-single-key)
14652 (done-keywords org-done-keywords)
14653 groups ingroup)
14654 (save-excursion
14655 (beginning-of-line 1)
14656 (if (looking-at
14658 (setq ov-start (match-beginning 1)
14659 ov-end (match-end 1)
14660 ov-prefix "")
14661 (setq ov-start (1- (point-at-eol))
14662 ov-end (1+ ov-start))
14664 (setq ov-prefix
14665 (concat
14666 (buffer-substring (1- (point)) (point))
14667 (if (> (current-column) org-tags-column)
14668 " "
14669 (make-string (- org-tags-column (current-column)) ?\ ))))))
14670 (move-overlay org-tags-overlay ov-start ov-end)
14671 (save-window-excursion
14672 (if expert
14673 (set-buffer (get-buffer-create " *Org tags*"))
14674 (delete-other-windows)
14675 (split-window-vertically)
14676 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14677 (erase-buffer)
14678 (org-set-local 'org-done-keywords done-keywords)
14681 (org-fast-tag-show-exit exit-after-next)
14682 (org-set-current-tags-overlay current ov-prefix)
14683 (setq tbl fulltable char ?a cnt 0)
14684 (while (setq e (pop tbl))
14685 (cond
14686 ((equal (car e) :startgroup)
14687 (push '() groups) (setq ingroup t)
14688 (when (not (= cnt 0))
14689 (setq cnt 0)
14691 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14692 ((equal (car e) :endgroup)
14693 (setq ingroup nil cnt 0)
14695 ((equal e '(:newline))
14696 (when (not (= cnt 0))
14697 (setq cnt 0)
14699 (setq e (car tbl))
14700 (while (equal (car tbl) '(:newline))
14702 (setq tbl (cdr tbl)))))
14703 ((equal e '(:grouptags)) nil)
14704 (t
14705 (setq tg (copy-sequence (car e)) c2 nil)
14706 (if (cdr e)
14707 (setq c (cdr e))
14708 ;; automatically assign a character.
14709 (setq c1 (string-to-char
14710 (downcase (substring
14711 tg (if (= (string-to-char tg) ?@) 1 0)))))
14712 (if (or (rassoc c1 ntable) (rassoc c1 table))
14713 (while (or (rassoc char ntable) (rassoc char table))
14714 (setq char (1+ char)))
14715 (setq c2 c1))
14716 (setq c (or c2 char)))
14717 (if ingroup (push tg (car groups)))
14718 (setq tg (org-add-props tg nil 'face
14719 (cond
14720 ((not (assoc tg table))
14721 (org-get-todo-face tg))
14722 ((member tg current) c-face)
14723 ((member tg inherited) i-face))))
14724 (if (equal (caar tbl) :grouptags)
14725 (org-add-props tg nil 'face 'org-tag-group))
14726 (if (and (= cnt 0) (not ingroup)) (insert " "))
14727 (insert "[" c "] " tg (make-string
14728 (- fwidth 4 (length tg)) ?\ ))
14729 (push (cons tg c) ntable)
14730 (when (= (setq cnt (1+ cnt)) ncol)
14732 (if ingroup (insert " "))
14733 (setq cnt 0)))))
14734 (setq ntable (nreverse ntable))
14736 (goto-char (point-min))
14737 (if (not expert) (org-fit-window-to-buffer))
14738 (setq rtn
14739 (catch 'exit
14740 (while t
14741 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14742 (if (not groups) "no " "")
14743 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14744 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14745 (setq org-last-tag-selection-key c)
14746 (cond
14748 ((= c ?!)
14749 (setq groups (not groups))
14750 (goto-char (point-min))
14751 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14752 ((= c ?\C-c)
14753 (if (not expert)
14754 (org-fast-tag-show-exit
14755 (setq exit-after-next (not exit-after-next)))
14756 (setq expert nil)
14757 (delete-other-windows)
14758 (set-window-buffer (split-window-vertically) " *Org tags*")
14759 (org-switch-to-buffer-other-window " *Org tags*")
14760 (org-fit-window-to-buffer)))
14761 ((or (= c ?\C-g)
14762 (and (= c ?q) (not (rassoc c ntable))))
14763 (org-detach-overlay org-tags-overlay)
14764 (setq quit-flag t))
14765 ((= c ?\ )
14766 (setq current nil)
14767 (if exit-after-next (setq exit-after-next 'now)))
14769 (condition-case nil
14770 (setq tg (org-icompleting-read
14771 "Tag: "
14772 (or buffer-tags
14773 (with-current-buffer buf
14774 (org-get-buffer-tags)))))
14775 (quit (setq tg "")))
14777 (add-to-list 'buffer-tags (list tg))
14778 (if (member tg current)
14779 (setq current (delete tg current))
14780 (push tg current)))
14781 (if exit-after-next (setq exit-after-next 'now)))
14782 ((setq e (rassoc c todo-table) tg (car e))
14783 (with-current-buffer buf
14784 (save-excursion (org-todo tg)))
14785 (if exit-after-next (setq exit-after-next 'now)))
14786 ((setq e (rassoc c ntable) tg (car e))
14787 (if (member tg current)
14788 (setq current (delete tg current))
14789 (loop for g in groups do
14790 (if (member tg g)
14791 (mapc (lambda (x)
14792 (setq current (delete x current)))
14793 g)))
14794 (push tg current))
14795 (if exit-after-next (setq exit-after-next 'now))))
14797 ;; Create a sorted list
14798 (setq current
14799 (sort current
14800 (lambda (a b)
14801 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14802 (if (eq exit-after-next 'now) (throw 'exit t))
14803 (goto-char (point-min))
14804 (beginning-of-line 2)
14805 (delete-region (point) (point-at-eol))
14806 (org-fast-tag-insert "Current" current c-face)
14807 (org-set-current-tags-overlay current ov-prefix)
14808 (while (re-search-forward
14810 (setq tg (match-string 1))
14811 (add-text-properties
14812 (match-beginning 1) (match-end 1)
14813 (list 'face
14814 (cond
14815 ((member tg current) c-face)
14816 ((member tg inherited) i-face)
14817 (t (get-text-property (match-beginning 1) 'face))))))
14818 (goto-char (point-min)))))
14819 (org-detach-overlay org-tags-overlay)
14820 (if rtn
14821 (mapconcat 'identity current ":")
14822 nil))))
14824 (defun org-get-tags-string ()
14825 "Get the TAGS string in the current headline."
14826 (unless (org-at-heading-p t)
14827 (user-error "Not on a heading"))
14828 (save-excursion
14829 (beginning-of-line 1)
14831 (org-match-string-no-properties 1)
14832 "")))
14834 (defun org-get-tags ()
14835 "Get the list of tags specified in the current headline."
14836 (org-split-string (org-get-tags-string) ":"))
14838 (defun org-get-buffer-tags ()
14839 "Get a table of all tags used in the buffer, for completion."
14840 (let (tags)
14841 (save-excursion
14842 (goto-char (point-min))
14843 (while (re-search-forward
14845 (when (equal (char-after (point-at-bol 0)) ?*)
14846 (mapc (lambda (x) (add-to-list 'tags x))
14847 (org-split-string (org-match-string-no-properties 1) ":")))))
14848 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14849 (mapcar 'list tags)))
14851 ;;;; The mapping API
14853 (defun org-map-entries (func &optional match scope &rest skip)
14854 "Call FUNC at each headline selected by MATCH in SCOPE.
14856 FUNC is a function or a lisp form. The function will be called without
14857 arguments, with the cursor positioned at the beginning of the headline.
14858 The return values of all calls to the function will be collected and
14859 returned as a list.
14861 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14862 does not need to preserve point. After evaluation, the cursor will be
14863 moved to the end of the line (presumably of the headline of the
14864 processed entry) and search continues from there. Under some
14865 circumstances, this may not produce the wanted results. For example,
14866 if you have removed (e.g. archived) the current (sub)tree it could
14867 mean that the next entry will be skipped entirely. In such cases, you
14868 can specify the position from where search should continue by making
14869 FUNC set the variable `org-map-continue-from' to the desired buffer
14870 position.
14872 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14873 Only headlines that are matched by this query will be considered during
14874 the iteration. When MATCH is nil or t, all headlines will be
14875 visited by the iteration.
14877 SCOPE determines the scope of this command. It can be any of:
14879 nil The current buffer, respecting the restriction if any
14880 tree The subtree started with the entry at point
14881 region The entries within the active region, if any
14882 region-start-level
14883 The entries within the active region, but only those at
14884 the same level than the first one.
14885 file The current buffer, without restriction
14886 file-with-archives
14887 The current buffer, and any archives associated with it
14888 agenda All agenda files
14889 agenda-with-archives
14890 All agenda files with any archive files associated with them
14891 \(file1 file2 ...)
14892 If this is a list, all files in the list will be scanned
14894 The remaining args are treated as settings for the skipping facilities of
14895 the scanner. The following items can be given here:
14897 archive skip trees with the archive tag
14898 comment skip trees with the COMMENT keyword
14899 function or Emacs Lisp form:
14900 will be used as value for `org-agenda-skip-function', so
14901 whenever the function returns a position, FUNC will not be
14902 called for that entry and search will continue from the
14903 position returned
14905 If your function needs to retrieve the tags including inherited tags
14906 at the *current* entry, you can use the value of the variable
14907 `org-scanner-tags' which will be much faster than getting the value
14908 with `org-get-tags-at'. If your function gets properties with
14909 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14910 to t around the call to `org-entry-properties' to get the same speedup.
14911 Note that if your function moves around to retrieve tags and properties at
14912 a *different* entry, you cannot use these techniques."
14913 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14914 (not (org-region-active-p)))
14915 (let* ((org-agenda-archives-mode nil) ; just to make sure
14916 (org-agenda-skip-archived-trees (memq 'archive skip))
14917 (org-agenda-skip-comment-trees (memq 'comment skip))
14918 (org-agenda-skip-function
14919 (car (org-delete-all '(comment archive) skip)))
14920 (org-tags-match-list-sublevels t)
14921 (start-level (eq scope 'region-start-level))
14922 matcher file res
14923 org-todo-keywords-for-agenda
14924 org-done-keywords-for-agenda
14925 org-todo-keyword-alist-for-agenda
14926 org-drawers-for-agenda
14927 org-tag-alist-for-agenda
14928 todo-only)
14930 (cond
14931 ((eq match t) (setq matcher t))
14932 ((eq match nil) (setq matcher t))
14933 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14935 (save-window-excursion
14936 (save-restriction
14937 (cond ((eq scope 'tree)
14938 (org-back-to-heading t)
14939 (org-narrow-to-subtree)
14940 (setq scope nil))
14941 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14942 (org-region-active-p))
14943 ;; If needed, set start-level to a string like "2"
14944 (when start-level
14945 (save-excursion
14946 (goto-char (region-beginning))
14947 (unless (org-at-heading-p) (outline-next-heading))
14948 (setq start-level (org-current-level))))
14949 (narrow-to-region (region-beginning)
14950 (save-excursion
14951 (goto-char (region-end))
14952 (unless (and (bolp) (org-at-heading-p))
14953 (outline-next-heading))
14954 (point)))
14955 (setq scope nil)))
14957 (if (not scope)
14958 (progn
14959 (org-agenda-prepare-buffers
14960 (list (buffer-file-name (current-buffer))))
14961 (setq res (org-scan-tags func matcher todo-only start-level)))
14962 ;; Get the right scope
14963 (cond
14964 ((and scope (listp scope) (symbolp (car scope)))
14965 (setq scope (eval scope)))
14966 ((eq scope 'agenda)
14967 (setq scope (org-agenda-files t)))
14968 ((eq scope 'agenda-with-archives)
14969 (setq scope (org-agenda-files t))
14970 (setq scope (org-add-archive-files scope)))
14971 ((eq scope 'file)
14972 (setq scope (list (buffer-file-name))))
14973 ((eq scope 'file-with-archives)
14974 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14975 (org-agenda-prepare-buffers scope)
14976 (while (setq file (pop scope))
14977 (with-current-buffer (org-find-base-buffer-visiting file)
14978 (save-excursion
14979 (save-restriction
14980 (widen)
14981 (goto-char (point-min))
14982 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14983 res)))
14985 ;;;; Properties
14987 ;;; Setting and retrieving properties
14989 (defconst org-special-properties
14990 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14991 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14992 "The special properties valid in Org-mode.
14994 These are properties that are not defined in the property drawer,
14995 but in some other way.")
14997 (defconst org-default-properties
14998 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14999 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15000 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15001 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15002 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15003 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15004 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15005 "Some properties that are used by Org-mode for various purposes.
15006 Being in this list makes sure that they are offered for completion.")
15009 "Regular expression matching the first line of a property drawer.")
15012 "Regular expression matching the last line of a property drawer.")
15015 "Regular expression matching the first line of a property drawer.")
15018 "Regular expression matching the first line of a property drawer.")
15020 (defconst org-property-drawer-re
15023 "Matches an entire property drawer.")
15025 (defconst org-clock-drawer-re
15028 "Matches an entire clock drawer.")
15030 (defun org-property-action ()
15031 "Do an action on properties."
15032 (interactive)
15033 (let (c)
15034 (org-at-property-p)
15035 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15036 (setq c (read-char-exclusive))
15037 (cond
15038 ((equal c ?s)
15039 (call-interactively 'org-set-property))
15040 ((equal c ?d)
15041 (call-interactively 'org-delete-property))
15042 ((equal c ?D)
15043 (call-interactively 'org-delete-property-globally))
15044 ((equal c ?c)
15045 (call-interactively 'org-compute-property-at-point))
15046 (t (user-error "No such property action %c" c)))))
15048 (defun org-inc-effort ()
15049 "Increment the value of the effort property in the current entry."
15050 (interactive)
15051 (org-set-effort nil t))
15053 (defvar org-clock-effort) ;; Defined in org-clock.el
15054 (defvar org-clock-current-task) ;; Defined in org-clock.el
15055 (defun org-set-effort (&optional value increment)
15056 "Set the effort property of the current entry.
15057 With numerical prefix arg, use the nth allowed value, 0 stands for the
15058 10th allowed value.
15060 When INCREMENT is non-nil, set the property to the next allowed value."
15061 (interactive "P")
15062 (if (equal value 0) (setq value 10))
15063 (let* ((completion-ignore-case t)
15064 (prop org-effort-property)
15065 (cur (org-entry-get nil prop))
15066 (allowed (org-property-get-allowed-values nil prop 'table))
15067 (existing (mapcar 'list (org-property-values prop)))
15068 (heading (nth 4 (org-heading-components)))
15069 rpl
15070 (val (cond
15071 ((stringp value) value)
15072 ((and allowed (integerp value))
15073 (or (car (nth (1- value) allowed))
15074 (car (org-last allowed))))
15075 ((and allowed increment)
15076 (or (caadr (member (list cur) allowed))
15077 (user-error "Allowed effort values are not set")))
15078 (allowed
15079 (message "Select 1-9,0, [RET%s]: %s"
15080 (if cur (concat "=" cur) "")
15081 (mapconcat 'car allowed " "))
15082 (setq rpl (read-char-exclusive))
15084 cur
15085 (setq rpl (- rpl ?0))
15086 (if (equal rpl 0) (setq rpl 10))
15087 (if (and (> rpl 0) (<= rpl (length allowed)))
15088 (car (nth (1- rpl) allowed))
15089 (org-completing-read "Effort: " allowed nil))))
15090 (t
15091 (let (org-completion-use-ido org-completion-use-iswitchb)
15092 (org-completing-read
15094 (concat "[" cur "]") "")
15095 ": ")
15096 existing nil nil "" nil cur))))))
15097 (unless (equal (org-entry-get nil prop) val)
15098 (org-entry-put nil prop val))
15099 (save-excursion
15100 (org-back-to-heading t)
15101 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15102 (when (string= heading org-clock-current-task)
15103 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15104 (org-clock-update-mode-line))
15105 (message "%s is now %s" prop val)))
15107 (defun org-at-property-p ()
15108 "Is cursor inside a property drawer?"
15109 (save-excursion
15110 (when (equal 'node-property (car (org-element-at-point)))
15111 (beginning-of-line 1)
15112 (looking-at org-property-re))))
15114 (defun org-get-property-block (&optional beg end force)
15115 "Return the (beg . end) range of the body of the property drawer.
15116 BEG and END are the beginning and end of the current subtree, or of
15117 the part before the first headline. If they are not given, they will
15118 be found. If the drawer does not exist and FORCE is non-nil, create
15119 the drawer."
15120 (catch 'exit
15121 (save-excursion
15122 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15123 (progn (org-back-to-heading t) (point))))
15124 (end (or end (and (not (outline-next-heading)) (point-max))
15125 (point))))
15126 (goto-char beg)
15127 (if (re-search-forward org-property-start-re end t)
15128 (setq beg (1+ (match-end 0)))
15129 (if force
15130 (save-excursion
15131 (org-insert-property-drawer)
15132 (setq end (progn (outline-next-heading) (point))))
15133 (throw 'exit nil))
15134 (goto-char beg)
15135 (if (re-search-forward org-property-start-re end t)
15136 (setq beg (1+ (match-end 0)))))
15137 (if (re-search-forward org-property-end-re end t)
15138 (setq end (match-beginning 0))
15139 (or force (throw 'exit nil))
15140 (goto-char beg)
15141 (setq end beg)
15142 (org-indent-line)
15144 (cons beg end)))))
15146 (defun org-entry-properties (&optional pom which specific)
15147 "Get all properties of the entry at point-or-marker POM.
15148 This includes the TODO keyword, the tags, time strings for deadline,
15149 scheduled, and clocking, and any additional properties defined in the
15150 entry. The return value is an alist, keys may occur multiple times
15151 if the property key was used several times.
15152 POM may also be nil, in which case the current entry is used.
15153 If WHICH is nil or `all', get all properties. If WHICH is
15154 `special' or `standard', only get that subclass. If WHICH
15155 is a string only get exactly this property. SPECIFIC can be a string, the
15156 specific property we are interested in. Specifying it can speed
15157 things up because then unnecessary parsing is avoided."
15158 (setq which (or which 'all))
15159 (org-with-point-at pom
15160 (let ((clockstr (substring org-clock-string 0 -1))
15161 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15162 (case-fold-search nil)
15163 beg end range props sum-props key key1 value string clocksum clocksumt)
15164 (save-excursion
15165 (when (condition-case nil
15166 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15167 (error nil))
15168 (setq beg (point))
15169 (setq sum-props (get-text-property (point) 'org-summaries))
15170 (setq clocksum (get-text-property (point) :org-clock-minutes)
15171 clocksumt (get-text-property (point) :org-clock-minutes-today))
15172 (outline-next-heading)
15173 (setq end (point))
15174 (when (memq which '(all special))
15175 ;; Get the special properties, like TODO and tags
15176 (goto-char beg)
15177 (when (and (or (not specific) (string= specific "TODO"))
15178 (looking-at org-todo-line-regexp) (match-end 2))
15179 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15180 (when (and (or (not specific) (string= specific "PRIORITY"))
15181 (looking-at org-priority-regexp))
15182 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15183 (when (or (not specific) (string= specific "FILE"))
15184 (push (cons "FILE" buffer-file-name) props))
15185 (when (and (or (not specific) (string= specific "TAGS"))
15186 (setq value (org-get-tags-string))
15188 (push (cons "TAGS" value) props))
15189 (when (and (or (not specific) (string= specific "ALLTAGS"))
15190 (setq value (org-get-tags-at)))
15191 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15192 ":"))
15193 props))
15194 (when (or (not specific) (string= specific "BLOCKED"))
15195 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15196 (when (or (not specific)
15197 (member specific
15198 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15199 "TIMESTAMP" "TIMESTAMP_IA")))
15200 (catch 'match
15201 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15202 (setq key (if (match-end 1)
15203 (substring (org-match-string-no-properties 1)
15204 0 -1))
15205 string (if (equal key clockstr)
15206 (org-trim
15207 (buffer-substring-no-properties
15208 (match-beginning 3) (goto-char
15209 (point-at-eol))))
15210 (substring (org-match-string-no-properties 3)
15211 1 -1)))
15212 ;; Get the correct property name from the key. This is
15213 ;; necessary if the user has configured time keywords.
15214 (setq key1 (concat key ":"))
15215 (cond
15216 ((not key)
15217 (setq key
15218 (if (= (char-after (match-beginning 3)) ?\[)
15219 "TIMESTAMP_IA" "TIMESTAMP")))
15220 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15221 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15222 ((equal key1 org-closed-string) (setq key "CLOSED"))
15223 ((equal key1 org-clock-string) (setq key "CLOCK")))
15224 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15225 (progn
15226 (push (cons key string) props)
15227 ;; no need to search further if match is found
15228 (throw 'match t))
15229 (when (or (equal key "CLOCK") (not (assoc key props)))
15230 (push (cons key string) props)))))))
15232 (when (memq which '(all standard))
15233 ;; Get the standard properties, like :PROP: ...
15234 (setq range (org-get-property-block beg end))
15235 (when range
15236 (goto-char (car range))
15237 (while (re-search-forward org-property-re
15238 (cdr range) t)
15239 (setq key (org-match-string-no-properties 2)
15240 value (org-trim (or (org-match-string-no-properties 3) "")))
15241 (unless (member key excluded)
15242 (push (cons key (or value "")) props)))))
15243 (if clocksum
15244 (push (cons "CLOCKSUM"
15245 (org-columns-number-to-string (/ (float clocksum) 60.)
15246 'add_times))
15247 props))
15248 (if clocksumt
15249 (push (cons "CLOCKSUM_T"
15250 (org-columns-number-to-string (/ (float clocksumt) 60.)
15251 'add_times))
15252 props))
15253 (unless (assoc "CATEGORY" props)
15254 (push (cons "CATEGORY" (org-get-category)) props))
15255 (append sum-props (nreverse props)))))))
15257 (defun org-entry-get (pom property &optional inherit literal-nil)
15258 "Get value of PROPERTY for entry or content at point-or-marker POM.
15259 If INHERIT is non-nil and the entry does not have the property,
15260 then also check higher levels of the hierarchy.
15261 If INHERIT is the symbol `selective', use inheritance only if the setting
15262 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15263 If the property is present but empty, the return value is the empty string.
15264 If the property is not present at all, nil is returned.
15267 do not interpret it as the list atom nil. This is used for inheritance
15269 (org-with-point-at pom
15270 (if (and inherit (if (eq inherit 'selective)
15271 (org-property-inherit-p property)
15272 t))
15273 (org-entry-get-with-inheritance property literal-nil)
15274 (if (member property org-special-properties)
15275 ;; We need a special property. Use `org-entry-properties' to
15276 ;; retrieve it, but specify the wanted property
15277 (cdr (assoc property (org-entry-properties nil 'special property)))
15278 (let ((range (org-get-property-block)))
15279 (when (and range (not (eq (car range) (cdr range))))
15280 (let* ((props (list (or (assoc property org-file-properties)
15281 (assoc property org-global-properties)
15282 (assoc property org-global-properties-fixed))))
15283 (ap (lambda (key)
15284 (when (re-search-forward
15285 (org-re-property key) (cdr range) t)
15286 (setq props
15287 (org-update-property-plist
15288 key
15289 (if (match-end 3)
15290 (org-match-string-no-properties 3) "")
15291 props)))))
15292 val)
15293 (goto-char (car range))
15294 (funcall ap property)
15295 (goto-char (car range))
15296 (while (funcall ap (concat property "+")))
15297 (setq val (cdr (assoc property props)))
15298 (when val (if literal-nil val (org-not-nil val))))))))))
15300 (defun org-property-or-variable-value (var &optional inherit)
15301 "Check if there is a property fixing the value of VAR.
15302 If yes, return this value. If not, return the current value of the variable."
15303 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15305 (read prop)
15306 (symbol-value var))))
15308 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15309 "Delete the property PROPERTY from entry at point-or-marker POM.
15310 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15311 an empty drawer to delete."
15312 (org-with-point-at pom
15313 (if (member property org-special-properties)
15314 nil ; cannot delete these properties.
15315 (let ((range (org-get-property-block)))
15316 (if (and range
15317 (goto-char (car range))
15318 (re-search-forward
15319 (org-re-property property)
15320 (cdr range) t))
15321 (progn
15322 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15323 (and delete-empty-drawer
15324 (org-remove-empty-drawer-at
15325 delete-empty-drawer (car range)))
15326 t)
15327 nil)))))
15329 ;; Multi-values properties are properties that contain multiple values
15330 ;; These values are assumed to be single words, separated by whitespace.
15331 (defun org-entry-add-to-multivalued-property (pom property value)
15332 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15333 (let* ((old (org-entry-get pom property))
15335 (setq value (org-entry-protect-space value))
15336 (unless (member value values)
15337 (setq values (append values (list value)))
15338 (org-entry-put pom property
15339 (mapconcat 'identity values " ")))))
15341 (defun org-entry-remove-from-multivalued-property (pom property value)
15342 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15343 (let* ((old (org-entry-get pom property))
15345 (setq value (org-entry-protect-space value))
15346 (when (member value values)
15347 (setq values (delete value values))
15348 (org-entry-put pom property
15349 (mapconcat 'identity values " ")))))
15351 (defun org-entry-member-in-multivalued-property (pom property value)
15352 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15353 (let* ((old (org-entry-get pom property))
15355 (setq value (org-entry-protect-space value))
15356 (member value values)))
15358 (defun org-entry-get-multivalued-property (pom property)
15359 "Return a list of values in a multivalued property."
15360 (let* ((value (org-entry-get pom property))
15362 (mapcar 'org-entry-restore-space values)))
15364 (defun org-entry-put-multivalued-property (pom property &rest values)
15365 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15366 VALUES should be a list of strings. Spaces will be protected."
15367 (org-entry-put pom property
15368 (mapconcat 'org-entry-protect-space values " "))
15369 (let* ((value (org-entry-get pom property))
15371 (mapcar 'org-entry-restore-space values)))
15373 (defun org-entry-protect-space (s)
15374 "Protect spaces and newline in string S."
15375 (while (string-match " " s)
15376 (setq s (replace-match "%20" t t s)))
15378 (setq s (replace-match "%0A" t t s)))
15379 s)
15381 (defun org-entry-restore-space (s)
15382 "Restore spaces and newline in string S."
15383 (while (string-match "%20" s)
15384 (setq s (replace-match " " t t s)))
15385 (while (string-match "%0A" s)
15387 s)
15389 (defvar org-entry-property-inherited-from (make-marker)
15390 "Marker pointing to the entry from where a property was inherited.
15391 Each call to `org-entry-get-with-inheritance' will set this marker to the
15392 location of the entry where the inheritance search matched. If there was
15393 no match, the marker will point nowhere.
15394 Note that also `org-entry-get' calls this function, if the INHERIT flag
15395 is set.")
15397 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15398 "Get PROPERTY of entry or content at point, search higher levels if needed.
15399 The search will stop at the first ancestor which has the property defined.
15401 should be considered as undefined (this is the meaning of nil here).
15403 (move-marker org-entry-property-inherited-from nil)
15404 (let (tmp)
15405 (save-excursion
15406 (save-restriction
15407 (widen)
15408 (catch 'ex
15409 (while t
15410 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15411 (or (ignore-errors (org-back-to-heading t))
15412 (goto-char (point-min)))
15413 (move-marker org-entry-property-inherited-from (point))
15414 (throw 'ex tmp))
15415 (or (ignore-errors (org-up-heading-safe))
15416 (throw 'ex nil))))))
15417 (setq tmp (or tmp
15418 (cdr (assoc property org-file-properties))
15419 (cdr (assoc property org-global-properties))
15420 (cdr (assoc property org-global-properties-fixed))))
15421 (if literal-nil tmp (org-not-nil tmp))))
15423 (defvar org-property-changed-functions nil
15424 "Hook called when the value of a property has changed.
15425 Each hook function should accept two arguments, the name of the property
15426 and the new value.")
15428 (defun org-entry-put (pom property value)
15429 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15430 (org-with-point-at pom
15431 (org-back-to-heading t)
15432 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15433 range)
15434 (cond
15435 ((equal property "TODO")
15437 (not (member value org-todo-keywords-1)))
15439 (if (or (not value)
15441 (setq value 'none))
15442 (org-todo value)
15443 (org-set-tags nil 'align))
15444 ((equal property "PRIORITY")
15446 (string-to-char value) ?\ ))
15447 (org-set-tags nil 'align))
15448 ((equal property "CLOCKSUM")
15449 (if (not (re-search-forward
15451 (error "Cannot find a clock log")
15452 (goto-char (- (match-end 1) 2))
15453 (cond
15454 ((eq value 'earlier) (org-timestamp-down))
15455 ((eq value 'later) (org-timestamp-up)))
15456 (org-clock-sum-current-item)))
15457 ((equal property "SCHEDULED")
15458 (if (re-search-forward org-scheduled-time-regexp end t)
15459 (cond
15460 ((eq value 'earlier) (org-timestamp-change -1 'day))
15461 ((eq value 'later) (org-timestamp-change 1 'day))
15462 (t (call-interactively 'org-schedule)))
15463 (call-interactively 'org-schedule)))
15464 ((equal property "DEADLINE")
15465 (if (re-search-forward org-deadline-time-regexp end t)
15466 (cond
15467 ((eq value 'earlier) (org-timestamp-change -1 'day))
15468 ((eq value 'later) (org-timestamp-change 1 'day))
15469 (t (call-interactively 'org-deadline)))
15470 (call-interactively 'org-deadline)))
15471 ((member property org-special-properties)
15472 (error "The %s property can not yet be set with `org-entry-put'"
15473 property))
15474 (t ; a non-special property
15475 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15476 (setq range (org-get-property-block beg end 'force))
15477 (goto-char (car range))
15478 (if (re-search-forward
15479 (org-re-property property) (cdr range) t)
15480 (progn
15481 (delete-region (match-beginning 0) (match-end 0))
15482 (goto-char (match-beginning 0)))
15483 (goto-char (cdr range))
15485 (backward-char 1)
15486 (org-indent-line))
15487 (insert ":" property ":")
15488 (and value (insert " " value))
15489 (org-indent-line)))))
15490 (run-hook-with-args 'org-property-changed-functions property value)))
15492 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15493 "Get all property keys in the current buffer.
15494 With INCLUDE-SPECIALS, also list the special properties that reflect things
15495 like tags and TODO state.
15496 With INCLUDE-DEFAULTS, also include properties that has special meaning
15497 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15498 and others.
15499 With INCLUDE-COLUMNS, also include property names given in COLUMN
15500 formats in the current buffer."
15501 (let (rtn range cfmt s p)
15502 (save-excursion
15503 (save-restriction
15504 (widen)
15505 (goto-char (point-min))
15506 (while (re-search-forward org-property-start-re nil t)
15507 (setq range (org-get-property-block))
15508 (goto-char (car range))
15509 (while (re-search-forward org-property-re
15510 (cdr range) t)
15511 (add-to-list 'rtn (org-match-string-no-properties 2)))
15512 (outline-next-heading))))
15514 (when include-specials
15515 (setq rtn (append org-special-properties rtn)))
15517 (when include-defaults
15518 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15519 (add-to-list 'rtn org-effort-property))
15521 (when include-columns
15522 (save-excursion
15523 (save-restriction
15524 (widen)
15525 (goto-char (point-min))
15526 (while (re-search-forward
15528 nil t)
15529 (setq cfmt (match-string 2) s 0)
15531 cfmt s)
15532 (setq s (match-end 0)
15533 p (match-string 1 cfmt))
15534 (unless (or (equal p "ITEM")
15535 (member p org-special-properties))
15536 (add-to-list 'rtn (match-string 1 cfmt))))))))
15538 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15540 (defun org-property-values (key)
15541 "Return a list of all values of property KEY in the current buffer."
15542 (save-excursion
15543 (save-restriction
15544 (widen)
15545 (goto-char (point-min))
15546 (let ((re (org-re-property key))
15547 values)
15548 (while (re-search-forward re nil t)
15549 (add-to-list 'values (org-trim (match-string 3))))
15550 (delete "" values)))))
15552 (defun org-insert-property-drawer ()
15553 "Insert a property drawer into the current entry."
15554 (org-back-to-heading t)
15555 (looking-at org-outline-regexp)
15556 (let ((indent (if org-adapt-indentation
15557 (- (match-end 0) (match-beginning 0))
15558 0))
15559 (beg (point))
15561 end hiddenp)
15562 (outline-next-heading)
15563 (setq end (point))
15564 (goto-char beg)
15565 (while (re-search-forward re end t))
15566 (setq hiddenp (outline-invisible-p))
15567 (end-of-line 1)
15570 (if (member (match-string 1) '("CLOCK:" ":END:"))
15571 ;; just skip this line
15572 (beginning-of-line 2)
15573 ;; Drawer start, find the end
15575 (beginning-of-line 1)))
15576 (org-skip-over-state-notes)
15578 (if (eq (char-before) ?*) (forward-char 1))
15580 (beginning-of-line 0)
15581 (org-indent-to-column indent)
15582 (beginning-of-line 2)
15583 (org-indent-to-column indent)
15584 (beginning-of-line 0)
15585 (if hiddenp
15586 (save-excursion
15587 (org-back-to-heading t)
15588 (hide-entry))
15589 (org-flag-drawer t))))
15591 (defun org-insert-drawer (&optional arg drawer)
15592 "Insert a drawer at point.
15594 Optional argument DRAWER, when non-nil, is a string representing
15595 drawer's name. Otherwise, the user is prompted for a name.
15597 If a region is active, insert the drawer around that region
15598 instead.
15600 Point is left between drawer's boundaries."
15601 (interactive "P")
15602 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15603 "LOGBOOK"))
15604 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15605 ;; internally by Org. They are meant to be inserted
15606 ;; automatically.
15607 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15608 ;; Remove system drawers from list. Note: For some reason,
15609 ;; `org-completing-read' ignores the predicate while
15610 ;; `completing-read' handles it fine.
15611 (drawer (if arg "PROPERTIES"
15612 (or drawer
15613 (completing-read
15614 "Drawer: " org-drawers
15615 (lambda (d) (not (member d system-drawers))))))))
15616 (cond
15617 ;; With C-u, fall back on `org-insert-property-drawer'
15618 (arg (org-insert-property-drawer))
15619 ;; With an active region, insert a drawer at point.
15620 ((not (org-region-active-p))
15621 (progn
15624 (forward-line -2)))
15625 ;; Otherwise, insert the drawer at point
15626 (t
15627 (let ((rbeg (region-beginning))
15628 (rend (copy-marker (region-end))))
15629 (unwind-protect
15630 (progn
15631 (goto-char rbeg)
15632 (beginning-of-line)
15633 (when (save-excursion
15634 (re-search-forward org-outline-regexp-bol rend t))
15635 (user-error "Drawers cannot contain headlines"))
15636 ;; Position point at the beginning of the first
15637 ;; non-blank line in region. Insert drawer's opening
15638 ;; there, then indent it.
15639 (org-skip-whitespace)
15640 (beginning-of-line)
15642 (forward-line -1)
15643 (indent-for-tab-command)
15644 ;; Move point to the beginning of the first blank line
15645 ;; after the last non-blank line in region. Insert
15646 ;; drawer's closing, then indent it.
15647 (goto-char rend)
15650 (deactivate-mark t)
15651 (indent-for-tab-command)
15653 ;; Clear marker, whatever the outcome of insertion is.
15654 (set-marker rend nil)))))))
15656 (defvar org-property-set-functions-alist nil
15657 "Property set function alist.
15658 Each entry should have the following format:
15660 (PROPERTY . READ-FUNCTION)
15662 The read function will be called with the same argument as
15663 `org-completing-read'.")
15665 (defun org-set-property-function (property)
15666 "Get the function that should be used to set PROPERTY.
15667 This is computed according to `org-property-set-functions-alist'."
15668 (or (cdr (assoc property org-property-set-functions-alist))
15669 'org-completing-read))
15671 (defun org-read-property-value (property)
15672 "Read PROPERTY value from user."
15673 (let* ((completion-ignore-case t)
15674 (allowed (org-property-get-allowed-values nil property 'table))
15675 (cur (org-entry-get nil property))
15676 (prompt (concat property " value"
15678 (concat " [" cur "]") "") ": "))
15679 (set-function (org-set-property-function property))
15680 (val (if allowed
15681 (funcall set-function prompt allowed nil
15682 (not (get-text-property 0 'org-unrestricted
15683 (caar allowed))))
15684 (let (org-completion-use-ido org-completion-use-iswitchb)
15685 (funcall set-function prompt
15686 (mapcar 'list (org-property-values property))
15687 nil nil "" nil cur)))))
15688 (if (equal val "")
15689 cur
15690 val)))
15692 (defvar org-last-set-property nil)
15693 (defvar org-last-set-property-value nil)
15694 (defun org-read-property-name ()
15695 "Read a property name."
15696 (let* ((completion-ignore-case t)
15697 (keys (org-buffer-property-keys nil t t))
15698 (default-prop (or (save-excursion
15699 (save-match-data
15700 (beginning-of-line)
15702 (null (string= (match-string 1) "END"))
15703 (match-string 1))))
15704 org-last-set-property))
15705 (property (org-icompleting-read
15706 (concat "Property"
15707 (if default-prop (concat " [" default-prop "]") "")
15708 ": ")
15709 (mapcar 'list keys)
15710 nil nil nil nil
15711 default-prop)))
15712 (if (member property keys)
15713 property
15714 (or (cdr (assoc (downcase property)
15715 (mapcar (lambda (x) (cons (downcase x) x))
15716 keys)))
15717 property))))
15719 (defun org-set-property-and-value (use-last)
15720 "Allow to set [PROPERTY]: [value] direction from prompt.
15721 When use-default, don't even ask, just use the last
15723 (interactive "P")
15724 (let* ((completion-ignore-case t)
15725 (pv (or (and use-last org-last-set-property-value)
15726 (org-completing-read
15728 nil nil nil nil nil
15729 org-last-set-property-value)))
15730 prop val)
15732 (setq prop (match-string 1 pv)
15733 val (match-string 2 pv))
15734 (org-set-property prop val))))
15736 (defun org-set-property (property value)
15737 "In the current entry, set PROPERTY to VALUE.
15738 When called interactively, this will prompt for a property name, offering
15739 completion on existing and default properties. And then it will prompt
15740 for a value, offering completion either on allowed values (via an inherited
15741 xxx_ALL property) or on existing values in other instances of this property
15742 in the current file."
15743 (interactive (list nil nil))
15744 (let* ((property (or property (org-read-property-name)))
15745 (value (or value (org-read-property-value property)))
15746 (fn (cdr (assoc property org-properties-postprocess-alist))))
15747 (setq org-last-set-property property)
15748 (setq org-last-set-property-value (concat property ": " value))
15749 ;; Possibly postprocess the inserted value:
15750 (when fn (setq value (funcall fn value)))
15751 (unless (equal (org-entry-get nil property) value)
15752 (org-entry-put nil property value))))
15754 (defun org-delete-property (property &optional delete-empty-drawer)
15755 "In the current entry, delete PROPERTY.
15756 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15757 an empty drawer to delete."
15758 (interactive
15759 (let* ((completion-ignore-case t)
15760 (prop (org-icompleting-read "Property: "
15761 (org-entry-properties nil 'standard))))
15762 (list prop)))
15763 (message "Property %s %s" property
15764 (if (org-entry-delete nil property delete-empty-drawer)
15765 "deleted"
15766 "was not present in the entry")))
15768 (defun org-delete-property-globally (property)
15769 "Remove PROPERTY globally, from all entries."
15770 (interactive
15771 (let* ((completion-ignore-case t)
15772 (prop (org-icompleting-read
15773 "Globally remove property: "
15774 (mapcar 'list (org-buffer-property-keys)))))
15775 (list prop)))
15776 (save-excursion
15777 (save-restriction
15778 (widen)
15779 (goto-char (point-min))
15780 (let ((cnt 0))
15781 (while (re-search-forward
15782 (org-re-property property)
15783 nil t)
15784 (setq cnt (1+ cnt))
15785 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15788 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15790 (defun org-compute-property-at-point ()
15791 "Compute the property at point.
15792 This looks for an enclosing column format, extracts the operator and
15793 then applies it to the property in the column format's scope."
15794 (interactive)
15795 (unless (org-at-property-p)
15796 (user-error "Not at a property"))
15797 (let ((prop (org-match-string-no-properties 2)))
15798 (org-columns-get-format-and-top-level)
15799 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15800 (user-error "No operator defined for property %s" prop))
15801 (org-columns-compute prop)))
15803 (defvar org-property-allowed-value-functions nil
15804 "Hook for functions supplying allowed values for a specific property.
15805 The functions must take a single argument, the name of the property, and
15807 the values, this means that these values are intended as defaults for
15808 completion, but that other values should be allowed too.
15809 The functions must return nil if they are not responsible for this
15810 property.")
15812 (defun org-property-get-allowed-values (pom property &optional table)
15813 "Get allowed values for the property PROPERTY.
15814 When TABLE is non-nil, return an alist that can directly be used for
15815 completion."
15816 (let (vals)
15817 (cond
15818 ((equal property "TODO")
15819 (setq vals (org-with-point-at pom
15820 (append org-todo-keywords-1 '("")))))
15821 ((equal property "PRIORITY")
15822 (let ((n org-lowest-priority))
15823 (while (>= n org-highest-priority)
15824 (push (char-to-string n) vals)
15825 (setq n (1- n)))))
15826 ((member property org-special-properties))
15827 ((setq vals (run-hook-with-args-until-success
15828 'org-property-allowed-value-functions property)))
15829 (t
15830 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15832 (setq vals (car (read-from-string (concat "(" vals ")"))))
15833 (setq vals (mapcar (lambda (x)
15834 (cond ((stringp x) x)
15835 ((numberp x) (number-to-string x))
15836 ((symbolp x) (symbol-name x))
15837 (t "???")))
15838 vals)))))
15839 (when (member ":ETC" vals)
15840 (setq vals (remove ":ETC" vals))
15841 (org-add-props (car vals) '(org-unrestricted t)))
15842 (if table (mapcar 'list vals) vals)))
15844 (defun org-property-previous-allowed-value (&optional previous)
15845 "Switch to the next allowed value for this property."
15846 (interactive)
15847 (org-property-next-allowed-value t))
15849 (defun org-property-next-allowed-value (&optional previous)
15850 "Switch to the next allowed value for this property."
15851 (interactive)
15852 (unless (org-at-property-p)
15853 (user-error "Not at a property"))
15854 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15855 (key (match-string 2))
15856 (value (match-string 3))
15857 (allowed (or (org-property-get-allowed-values (point) key)
15858 (and (member value '("[ ]" "[-]" "[X]"))
15859 '("[ ]" "[X]"))))
15860 (heading (save-match-data (nth 4 (org-heading-components))))
15861 nval)
15862 (unless allowed
15863 (user-error "Allowed values for this property have not been defined"))
15864 (if previous (setq allowed (reverse allowed)))
15865 (if (member value allowed)
15866 (setq nval (car (cdr (member value allowed)))))
15867 (setq nval (or nval (car allowed)))
15868 (if (equal nval value)
15869 (user-error "Only one allowed value for this property"))
15870 (org-at-property-p)
15871 (replace-match (concat " :" key ": " nval) t t)
15872 (org-indent-line)
15873 (beginning-of-line 1)
15875 (when (equal prop org-effort-property)
15876 (save-excursion
15877 (org-back-to-heading t)
15878 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15879 (when (string= org-clock-current-task heading)
15880 (setq org-clock-effort nval)
15881 (org-clock-update-mode-line)))
15882 (run-hook-with-args 'org-property-changed-functions key nval)))
15884 (defun org-find-olp (path &optional this-buffer)
15885 "Return a marker pointing to the entry at outline path OLP.
15886 If anything goes wrong, throw an error.
15887 You can wrap this call to catch the error like this:
15889 (condition-case msg
15890 (org-mobile-locate-entry (match-string 4))
15891 (error (nth 1 msg)))
15893 The return value will then be either a string with the error message,
15894 or a marker if everything is OK.
15896 If THIS-BUFFER is set, the outline path does not contain a file,
15897 only headings."
15898 (let* ((file (if this-buffer buffer-file-name (pop path)))
15899 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15900 (level 1)
15901 (lmin 1)
15902 (lmax 1)
15903 limit re end found pos heading cnt flevel)
15904 (unless buffer (error "File not found :%s" file))
15905 (with-current-buffer buffer
15906 (save-excursion
15907 (save-restriction
15908 (widen)
15909 (setq limit (point-max))
15910 (goto-char (point-min))
15911 (while (setq heading (pop path))
15912 (setq re (format org-complex-heading-regexp-format
15913 (regexp-quote heading)))
15914 (setq cnt 0 pos (point))
15915 (while (re-search-forward re end t)
15916 (setq level (- (match-end 1) (match-beginning 1)))
15917 (if (and (>= level lmin) (<= level lmax))
15918 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15919 (when (= cnt 0) (error "Heading not found on level %d: %s"
15920 lmax heading))
15921 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15922 lmax heading))
15923 (goto-char found)
15924 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15925 (setq end (save-excursion (org-end-of-subtree t t))))
15926 (when (org-at-heading-p)
15927 (point-marker)))))))
15929 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15930 "Find node HEADING in BUFFER.
15931 Return a marker to the heading if it was found, or nil if not.
15932 If POS-ONLY is set, return just the position instead of a marker.
15934 The heading text must match exact, but it may have a TODO keyword,
15935 a priority cookie and tags in the standard locations."
15936 (with-current-buffer (or buffer (current-buffer))
15937 (save-excursion
15938 (save-restriction
15939 (widen)
15940 (goto-char (point-min))
15941 (let (case-fold-search)
15942 (if (re-search-forward
15943 (format org-complex-heading-regexp-format
15944 (regexp-quote heading)) nil t)
15945 (if pos-only
15946 (match-beginning 0)
15947 (move-marker (make-marker) (match-beginning 0)))))))))
15949 (defun org-find-exact-heading-in-directory (heading &optional dir)
15950 "Find Org node headline HEADING in all .org files in directory DIR.
15951 When the target headline is found, return a marker to this location."
15952 (let ((files (directory-files (or dir default-directory)
15954 file visiting m buffer)
15955 (catch 'found
15956 (while (setq file (pop files))
15957 (message "trying %s" file)
15958 (setq visiting (org-find-base-buffer-visiting file))
15959 (setq buffer (or visiting (find-file-noselect file)))
15960 (setq m (org-find-exact-headline-in-buffer
15961 heading buffer))
15962 (when (and (not m) (not visiting)) (kill-buffer buffer))
15963 (and m (throw 'found m))))))
15965 (defun org-find-entry-with-id (ident)
15966 "Locate the entry that contains the ID property with exact value IDENT.
15967 IDENT can be a string, a symbol or a number, this function will search for
15968 the string representation of it.
15969 Return the position where this entry starts, or nil if there is no such entry."
15970 (interactive "sID: ")
15971 (let ((id (cond
15972 ((stringp ident) ident)
15973 ((symbol-name ident) (symbol-name ident))
15974 ((numberp ident) (number-to-string ident))
15975 (t (error "IDENT %s must be a string, symbol or number" ident))))
15976 (case-fold-search nil))
15977 (save-excursion
15978 (save-restriction
15979 (widen)
15980 (goto-char (point-min))
15981 (when (re-search-forward
15983 nil t)
15984 (org-back-to-heading t)
15985 (point))))))
15987 ;;;; Timestamps
15989 (defvar org-last-changed-timestamp nil)
15990 (defvar org-last-inserted-timestamp nil
15991 "The last time stamp inserted with `org-insert-time-stamp'.")
15992 (defvar org-time-was-given) ; dynamically scoped parameter
15993 (defvar org-end-time-was-given) ; dynamically scoped parameter
15994 (defvar org-ts-what) ; dynamically scoped parameter
15996 (defun org-time-stamp (arg &optional inactive)
15997 "Prompt for a date/time and insert a time stamp.
15998 If the user specifies a time like HH:MM or if this command is
15999 called with at least one prefix argument, the time stamp contains
16000 the date and the time. Otherwise, only the date is be included.
16002 All parts of a date not specified by the user is filled in from
16003 the current date/time. So if you just press return without
16004 typing anything, the time stamp will represent the current
16005 date/time.
16007 If there is already a timestamp at the cursor, it will be
16008 modified.
16010 With two universal prefix arguments, insert an active timestamp
16011 with the current time without prompting the user."
16012 (interactive "P")
16013 (let* ((ts nil)
16014 (default-time
16015 ;; Default time is either today, or, when entering a range,
16016 ;; the range start.
16017 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16018 (save-excursion
16019 (re-search-backward
16021 (- (point) 20) t)))
16022 (apply 'encode-time (org-parse-time-string (match-string 1)))
16023 (current-time)))
16024 (default-input (and ts (org-get-compact-tod ts)))
16025 (repeater (save-excursion
16026 (save-match-data
16027 (beginning-of-line)
16028 (when (re-search-forward
16030 (save-excursion (progn (end-of-line) (point))) t)
16031 (match-string 0)))))
16032 org-time-was-given org-end-time-was-given time)
16033 (cond
16034 ((and (org-at-timestamp-p t)
16035 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16036 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16037 (insert "--")
16038 (setq time (let ((this-command this-command))
16039 (org-read-date arg 'totime nil nil
16040 default-time default-input inactive)))
16041 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16042 ((org-at-timestamp-p t)
16043 (setq time (let ((this-command this-command))
16044 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16045 (when (org-at-timestamp-p t) ; just to get the match data
16046 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16047 (replace-match "")
16048 (setq org-last-changed-timestamp
16049 (org-insert-time-stamp
16050 time (or org-time-was-given arg)
16051 inactive nil nil (list org-end-time-was-given)))
16052 (when repeater (goto-char (1- (point))) (insert " " repeater)
16053 (setq org-last-changed-timestamp
16054 (concat (substring org-last-inserted-timestamp 0 -1)
16055 " " repeater ">"))))
16056 (message "Timestamp updated"))
16057 ((equal arg '(16))
16058 (org-insert-time-stamp (current-time) t))
16059 (t
16060 (setq time (let ((this-command this-command))
16061 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16062 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16063 nil nil (list org-end-time-was-given))))))
16065 ;; FIXME: can we use this for something else, like computing time differences?
16066 (defun org-get-compact-tod (s)
16067 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16068 (let* ((t1 (match-string 1 s))
16069 (h1 (string-to-number (match-string 2 s)))
16070 (m1 (string-to-number (match-string 3 s)))
16071 (t2 (and (match-end 4) (match-string 5 s)))
16072 (h2 (and t2 (string-to-number (match-string 6 s))))
16073 (m2 (and t2 (string-to-number (match-string 7 s))))
16074 dh dm)
16075 (if (not t2)
16076 t1
16077 (setq dh (- h2 h1) dm (- m2 m1))
16078 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16079 (concat t1 "+" (number-to-string dh)
16080 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
16082 (defun org-time-stamp-inactive (&optional arg)
16083 "Insert an inactive time stamp.
16084 An inactive time stamp is enclosed in square brackets instead of angle
16085 brackets. It is inactive in the sense that it does not trigger agenda entries,
16086 does not link to the calendar and cannot be changed with the S-cursor keys.
16087 So these are more for recording a certain time/date."
16088 (interactive "P")
16089 (org-time-stamp arg 'inactive))
16091 (defvar org-date-ovl (make-overlay 1 1))
16092 (overlay-put org-date-ovl 'face 'org-date-selected)
16093 (org-detach-overlay org-date-ovl)
16095 (defvar org-ans1) ; dynamically scoped parameter
16096 (defvar org-ans2) ; dynamically scoped parameter
16098 (defvar org-plain-time-of-day-regexp) ; defined below
16100 (defvar org-overriding-default-time nil) ; dynamically scoped
16101 (defvar org-read-date-overlay nil)
16102 (defvar org-dcst nil) ; dynamically scoped
16103 (defvar org-read-date-history nil)
16104 (defvar org-read-date-final-answer nil)
16105 (defvar org-read-date-analyze-futurep nil)
16106 (defvar org-read-date-analyze-forced-year nil)
16107 (defvar org-read-date-inactive)
16109 (defvar org-read-date-minibuffer-local-map
16110 (let ((map (make-sparse-keymap)))
16111 (set-keymap-parent map minibuffer-local-map)
16112 (org-defkey map (kbd ".")
16113 (lambda () (interactive)
16114 ;; Are we at the beginning of the prompt?
16115 (if (looking-back "^[^:]+: ")
16116 (org-eval-in-calendar '(calendar-goto-today))
16117 (insert "."))))
16118 (org-defkey map (kbd "C-.")
16119 (lambda () (interactive)
16120 (org-eval-in-calendar '(calendar-goto-today))))
16121 (org-defkey map [(meta shift left)]
16122 (lambda () (interactive)
16123 (org-eval-in-calendar '(calendar-backward-month 1))))
16124 (org-defkey map [(meta shift right)]
16125 (lambda () (interactive)
16126 (org-eval-in-calendar '(calendar-forward-month 1))))
16127 (org-defkey map [(meta shift up)]
16128 (lambda () (interactive)
16129 (org-eval-in-calendar '(calendar-backward-year 1))))
16130 (org-defkey map [(meta shift down)]
16131 (lambda () (interactive)
16132 (org-eval-in-calendar '(calendar-forward-year 1))))
16133 (org-defkey map [?\e (shift left)]
16134 (lambda () (interactive)
16135 (org-eval-in-calendar '(calendar-backward-month 1))))
16136 (org-defkey map [?\e (shift right)]
16137 (lambda () (interactive)
16138 (org-eval-in-calendar '(calendar-forward-month 1))))
16139 (org-defkey map [?\e (shift up)]
16140 (lambda () (interactive)
16141 (org-eval-in-calendar '(calendar-backward-year 1))))
16142 (org-defkey map [?\e (shift down)]
16143 (lambda () (interactive)
16144 (org-eval-in-calendar '(calendar-forward-year 1))))
16145 (org-defkey map [(shift up)]
16146 (lambda () (interactive)
16147 (org-eval-in-calendar '(calendar-backward-week 1))))
16148 (org-defkey map [(shift down)]
16149 (lambda () (interactive)
16150 (org-eval-in-calendar '(calendar-forward-week 1))))
16151 (org-defkey map [(shift left)]
16152 (lambda () (interactive)
16153 (org-eval-in-calendar '(calendar-backward-day 1))))
16154 (org-defkey map [(shift right)]
16155 (lambda () (interactive)
16156 (org-eval-in-calendar '(calendar-forward-day 1))))
16157 (org-defkey map "!"
16158 (lambda () (interactive)
16159 (org-eval-in-calendar '(diary-view-entries))
16160 (message "")))
16161 (org-defkey map ">"
16162 (lambda () (interactive)
16163 (org-eval-in-calendar '(scroll-calendar-left 1))))
16164 (org-defkey map "<"
16165 (lambda () (interactive)
16166 (org-eval-in-calendar '(scroll-calendar-right 1))))
16167 (org-defkey map "\C-v"
16168 (lambda () (interactive)
16169 (org-eval-in-calendar
16170 '(calendar-scroll-left-three-months 1))))
16171 (org-defkey map "\M-v"
16172 (lambda () (interactive)
16173 (org-eval-in-calendar
16174 '(calendar-scroll-right-three-months 1))))
16175 map)
16176 "Keymap for minibuffer commands when using `org-read-date'.")
16178 (defun org-read-date (&optional org-with-time to-time from-string prompt
16179 default-time default-input inactive)
16180 "Read a date, possibly a time, and make things smooth for the user.
16181 The prompt will suggest to enter an ISO date, but you can also enter anything
16182 which will at least partially be understood by `parse-time-string'.
16183 Unrecognized parts of the date will default to the current day, month, year,
16184 hour and minute. If this command is called to replace a timestamp at point,
16185 or to enter the second timestamp of a range, the default time is taken
16186 from the existing stamp. Furthermore, the command prefers the future,
16187 so if you are giving a date where the year is not given, and the day-month
16188 combination is already past in the current year, it will assume you
16189 mean next year. For details, see the manual. A few examples:
16191 3-2-5 --> 2003-02-05
16192 feb 15 --> currentyear-02-15
16193 2/15 --> currentyear-02-15
16194 sep 12 9 --> 2009-09-12
16195 12:45 --> today 12:45
16196 22 sept 0:34 --> currentyear-09-22 0:34
16197 12 --> currentyear-currentmonth-12
16198 Fri --> nearest Friday after today
16199 -Tue --> last Tuesday
16200 etc.
16202 Furthermore you can specify a relative date by giving, as the *first* thing
16203 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16204 change in days weeks, months, years.
16205 With a single plus or minus, the date is relative to today. With a double
16206 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16207 +4d --> four days from today
16208 +4 --> same as above
16209 +2w --> two weeks from today
16210 ++5 --> five days from default date
16212 The function understands only English month and weekday abbreviations.
16214 While prompting, a calendar is popped up - you can also select the
16215 date with the mouse (button 1). The calendar shows a period of three
16216 months. To scroll it to other months, use the keys `>' and `<'.
16217 If you don't like the calendar, turn it off with
16218 \(setq org-read-date-popup-calendar nil)
16220 With optional argument TO-TIME, the date will immediately be converted
16221 to an internal time.
16222 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16223 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16224 still enter a time, and this function will inform the calling routine
16225 about this change. The calling routine may then choose to change the
16226 format used to insert the time stamp into the buffer to include the time.
16227 With optional argument FROM-STRING, read from this string instead from
16228 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16229 the time/date that is used for everything that is not specified by the
16230 user."
16231 (require 'parse-time)
16232 (let* ((org-time-stamp-rounding-minutes
16233 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16234 (org-dcst org-display-custom-times)
16235 (ct (org-current-time))
16236 (org-def (or org-overriding-default-time default-time ct))
16237 (org-defdecode (decode-time org-def))
16238 (dummy (progn
16239 (when (< (nth 2 org-defdecode) org-extend-today-until)
16240 (setcar (nthcdr 2 org-defdecode) -1)
16241 (setcar (nthcdr 1 org-defdecode) 59)
16242 (setq org-def (apply 'encode-time org-defdecode)
16243 org-defdecode (decode-time org-def)))))
16244 (mouse-autoselect-window nil) ; Don't let the mouse jump
16245 (calendar-frame-setup nil)
16246 (calendar-setup nil)
16247 (calendar-move-hook nil)
16248 (calendar-view-diary-initially-flag nil)
16249 (calendar-view-holidays-initially-flag nil)
16250 (timestr (format-time-string
16251 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16252 (prompt (concat (if prompt (concat prompt " ") "")
16253 (format "Date+time [%s]: " timestr)))
16254 ans (org-ans0 "") org-ans1 org-ans2 final)
16256 (cond
16257 (from-string (setq ans from-string))
16258 (org-read-date-popup-calendar
16259 (save-excursion
16260 (save-window-excursion
16261 (calendar)
16262 (org-eval-in-calendar '(setq cursor-type nil) t)
16263 (unwind-protect
16264 (progn
16265 (calendar-forward-day (- (time-to-days org-def)
16266 (calendar-absolute-from-gregorian
16267 (calendar-current-date))))
16268 (org-eval-in-calendar nil t)
16269 (let* ((old-map (current-local-map))
16270 (map (copy-keymap calendar-mode-map))
16271 (minibuffer-local-map
16272 (copy-keymap org-read-date-minibuffer-local-map)))
16273 (org-defkey map (kbd "RET") 'org-calendar-select)
16274 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16275 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16276 (unwind-protect
16277 (progn
16278 (use-local-map map)
16279 (setq org-read-date-inactive inactive)
16280 (add-hook 'post-command-hook 'org-read-date-display)
16281 (setq org-ans0 (read-string prompt default-input
16282 'org-read-date-history nil))
16283 ;; org-ans0: from prompt
16284 ;; org-ans1: from mouse click
16285 ;; org-ans2: from calendar motion
16286 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16287 (remove-hook 'post-command-hook 'org-read-date-display)
16288 (use-local-map old-map)
16289 (when org-read-date-overlay
16290 (delete-overlay org-read-date-overlay)
16291 (setq org-read-date-overlay nil)))))
16292 (bury-buffer "*Calendar*")))))
16294 (t ; Naked prompt only
16295 (unwind-protect
16296 (setq ans (read-string prompt default-input
16297 'org-read-date-history timestr))
16298 (when org-read-date-overlay
16299 (delete-overlay org-read-date-overlay)
16300 (setq org-read-date-overlay nil)))))
16302 (setq final (org-read-date-analyze ans org-def org-defdecode))
16304 (when org-read-date-analyze-forced-year
16305 (message "Year was forced into %s"
16306 (if org-read-date-force-compatible-dates
16307 "compatible range (1970-2037)"
16308 "range representable on this machine"))
16309 (ding))
16311 ;; One round trip to get rid of 34th of August and stuff like that....
16312 (setq final (decode-time (apply 'encode-time final)))
16314 (setq org-read-date-final-answer ans)
16316 (if to-time
16317 (apply 'encode-time final)
16318 (if (and (boundp 'org-time-was-given) org-time-was-given)
16319 (format "%04d-%02d-%02d %02d:%02d"
16320 (nth 5 final) (nth 4 final) (nth 3 final)
16321 (nth 2 final) (nth 1 final))
16322 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16324 (defvar org-def)
16325 (defvar org-defdecode)
16326 (defvar org-with-time)
16327 (defun org-read-date-display ()
16328 "Display the current date prompt interpretation in the minibuffer."
16329 (when org-read-date-display-live
16330 (when org-read-date-overlay
16331 (delete-overlay org-read-date-overlay))
16332 (when (minibufferp (current-buffer))
16333 (save-excursion
16334 (end-of-line 1)
16335 (while (not (equal (buffer-substring
16336 (max (point-min) (- (point) 4)) (point))
16337 " "))
16338 (insert " ")))
16339 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16340 " " (or org-ans1 org-ans2)))
16341 (org-end-time-was-given nil)
16342 (f (org-read-date-analyze ans org-def org-defdecode))
16343 (fmts (if org-dcst
16344 org-time-stamp-custom-formats
16345 org-time-stamp-formats))
16346 (fmt (if (or org-with-time
16347 (and (boundp 'org-time-was-given) org-time-was-given))
16348 (cdr fmts)
16349 (car fmts)))
16350 (txt (format-time-string fmt (apply 'encode-time f)))
16351 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16352 (txt (concat "=> " txt)))
16353 (when (and org-end-time-was-given
16354 (string-match org-plain-time-of-day-regexp txt))
16355 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16356 org-end-time-was-given
16357 (substring txt (match-end 0)))))
16358 (when org-read-date-analyze-futurep
16359 (setq txt (concat txt " (=>F)")))
16360 (setq org-read-date-overlay
16361 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16362 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16364 (defun org-read-date-analyze (ans org-def org-defdecode)
16365 "Analyze the combined answer of the date prompt."
16366 ;; FIXME: cleanup and comment
16367 (let ((nowdecode (decode-time (current-time)))
16368 delta deltan deltaw deltadef year month day
16369 hour minute second wday pm h2 m2 tl wday1
16370 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16371 (setq org-read-date-analyze-futurep nil
16372 org-read-date-analyze-forced-year nil)
16374 (setq ans "+0"))
16376 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16377 (setq ans (replace-match "" t t ans)
16378 deltan (car delta)
16379 deltaw (nth 1 delta)
16380 deltadef (nth 2 delta)))
16382 ;; Check if there is an iso week date in there. If yes, store the
16383 ;; info and postpone interpreting it until the rest of the parsing
16384 ;; is done.
16385 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16386 (setq iso-year (if (match-end 1)
16387 (org-small-year-to-year
16388 (string-to-number (match-string 1 ans))))
16389 iso-weekday (if (match-end 3)
16390 (string-to-number (match-string 3 ans)))
16391 iso-week (string-to-number (match-string 2 ans)))
16392 (setq ans (replace-match "" t t ans)))
16394 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16395 (when (string-match
16397 (setq year (if (match-end 2)
16398 (string-to-number (match-string 2 ans))
16399 (progn (setq kill-year t)
16400 (string-to-number (format-time-string "%Y"))))
16401 month (string-to-number (match-string 3 ans))
16402 day (string-to-number (match-string 4 ans)))
16403 (if (< year 100) (setq year (+ 2000 year)))
16405 t nil ans)))
16407 ;; Help matching dotted european dates
16408 (when (string-match
16409 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16410 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16411 (setq kill-year t)
16412 (string-to-number (format-time-string "%Y")))
16413 day (string-to-number (match-string 1 ans))
16414 month (string-to-number (match-string 2 ans))
16415 ans (replace-match (format "%04d-%02d-%02d" year month day)
16416 t nil ans)))
16418 ;; Help matching american dates, like 5/30 or 5/30/7
16419 (when (string-match
16420 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16421 (setq year (if (match-end 4)
16422 (string-to-number (match-string 4 ans))
16423 (progn (setq kill-year t)
16424 (string-to-number (format-time-string "%Y"))))
16425 month (string-to-number (match-string 1 ans))
16426 day (string-to-number (match-string 2 ans)))
16427 (if (< year 100) (setq year (+ 2000 year)))
16429 t nil ans)))
16430 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16431 ;; If there is a time with am/pm, and *no* time without it, we convert
16432 ;; so that matching will be successful.
16433 (loop for i from 1 to 2 do ; twice, for end time as well
16436 (setq hour (string-to-number (match-string 1 ans))
16437 minute (if (match-end 3)
16438 (string-to-number (match-string 3 ans))
16439 0)
16440 pm (equal ?p
16441 (string-to-char (downcase (match-string 4 ans)))))
16442 (if (and (= hour 12) (not pm))
16443 (setq hour 0)
16444 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16445 (setq ans (replace-match (format "%02d:%02d" hour minute)
16446 t t ans))))
16448 ;; Check if a time range is given as a duration
16449 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16450 (setq hour (string-to-number (match-string 1 ans))
16451 h2 (+ hour (string-to-number (match-string 3 ans)))
16452 minute (string-to-number (match-string 2 ans))
16453 m2 (+ minute (if (match-end 5) (string-to-number
16454 (match-string 5 ans))0)))
16455 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16456 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16457 t t ans)))
16459 ;; Check if there is a time range
16460 (when (boundp 'org-end-time-was-given)
16461 (setq org-time-was-given nil)
16462 (when (and (string-match org-plain-time-of-day-regexp ans)
16463 (match-end 8))
16464 (setq org-end-time-was-given (match-string 8 ans))
16465 (setq ans (concat (substring ans 0 (match-beginning 7))
16466 (substring ans (match-end 7))))))
16468 (setq tl (parse-time-string ans)
16469 day (or (nth 3 tl) (nth 3 org-defdecode))
16470 month (or (nth 4 tl)
16471 (if (and org-read-date-prefer-future
16472 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16473 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16474 (nth 4 org-defdecode)))
16475 year (or (and (not kill-year) (nth 5 tl))
16476 (if (and org-read-date-prefer-future
16477 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16478 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16479 (nth 5 org-defdecode)))
16480 hour (or (nth 2 tl) (nth 2 org-defdecode))
16481 minute (or (nth 1 tl) (nth 1 org-defdecode))
16482 second (or (nth 0 tl) 0)
16483 wday (nth 6 tl))
16485 (when (and (eq org-read-date-prefer-future 'time)
16486 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16487 (equal day (nth 3 nowdecode))
16488 (equal month (nth 4 nowdecode))
16489 (equal year (nth 5 nowdecode))
16490 (nth 2 tl)
16491 (or (< (nth 2 tl) (nth 2 nowdecode))
16492 (and (= (nth 2 tl) (nth 2 nowdecode))
16493 (nth 1 tl)
16494 (< (nth 1 tl) (nth 1 nowdecode)))))
16495 (setq day (1+ day)
16496 futurep t))
16498 ;; Special date definitions below
16499 (cond
16500 (iso-week
16501 ;; There was an iso week
16502 (require 'cal-iso)
16503 (setq futurep nil)
16504 (setq year (or iso-year year)
16505 day (or iso-weekday wday 1)
16506 wday nil ; to make sure that the trigger below does not match
16507 iso-date (calendar-gregorian-from-absolute
16508 (calendar-absolute-from-iso
16509 (list iso-week day year))))
16510 ; FIXME: Should we also push ISO weeks into the future?
16511 ; (when (and org-read-date-prefer-future
16512 ; (not iso-year)
16513 ; (< (calendar-absolute-from-gregorian iso-date)
16514 ; (time-to-days (current-time))))
16515 ; (setq year (1+ year)
16516 ; iso-date (calendar-gregorian-from-absolute
16517 ; (calendar-absolute-from-iso
16518 ; (list iso-week day year)))))
16519 (setq month (car iso-date)
16520 year (nth 2 iso-date)
16521 day (nth 1 iso-date)))
16522 (deltan
16523 (setq futurep nil)
16524 (unless deltadef
16525 (let ((now (decode-time (current-time))))
16526 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16527 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16528 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16529 ((equal deltaw "m") (setq month (+ month deltan)))
16530 ((equal deltaw "y") (setq year (+ year deltan)))))
16531 ((and wday (not (nth 3 tl)))
16532 ;; Weekday was given, but no day, so pick that day in the week
16533 ;; on or after the derived date.
16534 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16535 (unless (equal wday wday1)
16536 (setq day (+ day (% (- wday wday1 -7) 7))))))
16537 (if (and (boundp 'org-time-was-given)
16538 (nth 2 tl))
16539 (setq org-time-was-given t))
16540 (if (< year 100) (setq year (+ 2000 year)))
16541 ;; Check of the date is representable
16542 (if org-read-date-force-compatible-dates
16543 (progn
16544 (if (< year 1970)
16545 (setq year 1970 org-read-date-analyze-forced-year t))
16546 (if (> year 2037)
16547 (setq year 2037 org-read-date-analyze-forced-year t)))
16548 (condition-case nil
16549 (ignore (encode-time second minute hour day month year))
16550 (error
16551 (setq year (nth 5 org-defdecode))
16552 (setq org-read-date-analyze-forced-year t))))
16553 (setq org-read-date-analyze-futurep futurep)
16554 (list second minute hour day month year)))
16556 (defvar parse-time-weekdays)
16557 (defun org-read-date-get-relative (s today default)
16558 "Check string S for special relative date string.
16559 TODAY and DEFAULT are internal times, for today and for a default.
16560 Return shift list (N what def-flag)
16562 N is the number of WHATs to shift.
16563 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16564 the DEFAULT date rather than TODAY."
16565 (require 'parse-time)
16566 (when (and
16567 (string-match
16568 (concat
16573 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16574 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16575 (string-to-char (substring (match-string 1 s) -1))
16576 ?+))
16577 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16578 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16579 (what (if (match-end 3) (match-string 3 s) "d"))
16580 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16581 (date (if rel default today))
16582 (wday (nth 6 (decode-time date)))
16583 delta)
16584 (if wday1
16585 (progn
16586 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16587 (if (= delta 0) (setq delta 7))
16588 (if (= dir ?-)
16589 (progn
16590 (setq delta (- delta 7))
16591 (if (= delta 0) (setq delta -7))))
16592 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16593 (list delta "d" rel))
16594 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16596 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16597 "Turn a user-specified date into the internal representation.
16598 The internal representation needed by the calendar is (month day year).
16599 This is a wrapper to handle the brain-dead convention in calendar that
16600 user function argument order change dependent on argument order."
16601 (if (boundp 'calendar-date-style)
16602 (cond
16603 ((eq calendar-date-style 'american)
16604 (list arg1 arg2 arg3))
16605 ((eq calendar-date-style 'european)
16606 (list arg2 arg1 arg3))
16607 ((eq calendar-date-style 'iso)
16608 (list arg2 arg3 arg1)))
16609 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16610 (if (org-bound-and-true-p european-calendar-style)
16611 (list arg2 arg1 arg3)
16612 (list arg1 arg2 arg3)))))
16614 (defun org-eval-in-calendar (form &optional keepdate)
16615 "Eval FORM in the calendar window and return to current window.
16616 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16617 otherwise stick to the current value of `org-ans2'."
16618 (let ((sf (selected-frame))
16619 (sw (selected-window)))
16620 (select-window (get-buffer-window "*Calendar*" t))
16621 (eval form)
16622 (when (and (not keepdate) (calendar-cursor-to-date))
16623 (let* ((date (calendar-cursor-to-date))
16624 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16625 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16626 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16627 (select-window sw)
16628 (org-select-frame-set-input-focus sf)))
16630 (defun org-calendar-select ()
16631 "Return to `org-read-date' with the date currently selected.
16632 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16633 (interactive)
16634 (when (calendar-cursor-to-date)
16635 (let* ((date (calendar-cursor-to-date))
16636 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16637 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16638 (if (active-minibuffer-window) (exit-minibuffer))))
16640 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16641 "Insert a date stamp for the date given by the internal TIME.
16642 WITH-HM means use the stamp format that includes the time of the day.
16643 INACTIVE means use square brackets instead of angular ones, so that the
16644 stamp will not contribute to the agenda.
16645 PRE and POST are optional strings to be inserted before and after the
16646 stamp.
16647 The command returns the inserted time stamp."
16648 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16649 stamp)
16650 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16651 (insert-before-markers (or pre ""))
16652 (when (listp extra)
16653 (setq extra (car extra))
16654 (if (and (stringp extra)
16656 (setq extra (format "-%02d:%02d"
16657 (string-to-number (match-string 1 extra))
16658 (string-to-number (match-string 2 extra))))
16659 (setq extra nil)))
16660 (when extra
16661 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16662 (insert-before-markers (setq stamp (format-time-string fmt time)))
16663 (insert-before-markers (or post ""))
16664 (setq org-last-inserted-timestamp stamp)))
16666 (defun org-toggle-time-stamp-overlays ()
16667 "Toggle the use of custom time stamp formats."
16668 (interactive)
16669 (setq org-display-custom-times (not org-display-custom-times))
16670 (unless org-display-custom-times
16671 (let ((p (point-min)) (bmp (buffer-modified-p)))
16672 (while (setq p (next-single-property-change p 'display))
16673 (if (and (get-text-property p 'display)
16674 (eq (get-text-property p 'face) 'org-date))
16675 (remove-text-properties
16676 p (setq p (next-single-property-change p 'display))
16677 '(display t))))
16678 (set-buffer-modified-p bmp)))
16679 (if (featurep 'xemacs)
16680 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16681 (org-restart-font-lock)
16682 (setq org-table-may-need-update t)
16683 (if org-display-custom-times
16684 (message "Time stamps are overlaid with custom format")
16685 (message "Time stamp overlays removed")))
16687 (defun org-display-custom-time (beg end)
16688 "Overlay modified time stamp format over timestamp between BEG and END."
16689 (let* ((ts (buffer-substring beg end))
16690 t1 w1 with-hm tf time str w2 (off 0))
16691 (save-match-data
16692 (setq t1 (org-parse-time-string ts t))
16693 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16694 (setq off (- (match-end 0) (match-beginning 0)))))
16695 (setq end (- end off))
16696 (setq w1 (- end beg)
16697 with-hm (and (nth 1 t1) (nth 2 t1))
16698 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16699 time (org-fix-decoded-time t1)
16700 str (org-add-props
16701 (format-time-string
16702 (substring tf 1 -1) (apply 'encode-time time))
16703 nil 'mouse-face 'highlight)
16704 w2 (length str))
16705 (if (not (= w2 w1))
16706 (add-text-properties (1+ beg) (+ 2 beg)
16707 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16708 (if (featurep 'xemacs)
16709 (progn
16710 (put-text-property beg end 'invisible t)
16711 (put-text-property beg end 'end-glyph (make-glyph str)))
16712 (put-text-property beg end 'display str))))
16714 (defun org-translate-time (string)
16715 "Translate all timestamps in STRING to custom format.
16716 But do this only if the variable `org-display-custom-times' is set."
16717 (when org-display-custom-times
16718 (save-match-data
16719 (let* ((start 0)
16720 (re org-ts-regexp-both)
16721 t1 with-hm inactive tf time str beg end)
16722 (while (setq start (string-match re string start))
16723 (setq beg (match-beginning 0)
16724 end (match-end 0)
16725 t1 (save-match-data
16726 (org-parse-time-string (substring string beg end) t))
16727 with-hm (and (nth 1 t1) (nth 2 t1))
16728 inactive (equal (substring string beg (1+ beg)) "[")
16729 tf (funcall (if with-hm 'cdr 'car)
16730 org-time-stamp-custom-formats)
16731 time (org-fix-decoded-time t1)
16732 str (format-time-string
16733 (concat
16734 (if inactive "[" "<") (substring tf 1 -1)
16735 (if inactive "]" ">"))
16736 (apply 'encode-time time))
16737 string (replace-match str t t string)
16738 start (+ start (length str)))))))
16739 string)
16741 (defun org-fix-decoded-time (time)
16742 "Set 0 instead of nil for the first 6 elements of time.
16743 Don't touch the rest."
16744 (let ((n 0))
16745 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16747 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16749 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16750 "Difference between TIMESTAMP-STRING and now in days.
16751 If SECONDS is non-nil, return the difference in seconds."
16752 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16753 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16754 (funcall fdiff (current-time)))))
16756 (defun org-deadline-close (timestamp-string &optional ndays)
16757 "Is the time in TIMESTAMP-STRING close to the current date?"
16758 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16759 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16760 (not (org-entry-is-done-p))))
16762 (defun org-get-wdays (ts &optional delay zero-delay)
16763 "Get the deadline lead time appropriate for timestring TS.
16764 When DELAY is non-nil, get the delay time for scheduled items
16765 instead of the deadline lead time. When ZERO-DELAY is non-nil
16766 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16767 don't try to find the delay cookie in the scheduled timestamp."
16768 (let ((tv (if delay org-scheduled-delay-days
16769 org-deadline-warning-days)))
16770 (cond
16771 ((or (and delay (< tv 0))
16772 (and delay zero-delay (<= tv 0))
16773 (and (not delay) (<= tv 0)))
16774 ;; Enforce this value no matter what
16775 (- tv))
16777 ;; lead time is specified.
16778 (floor (* (string-to-number (match-string 1 ts))
16779 (cdr (assoc (match-string 2 ts)
16780 '(("d" . 1) ("w" . 7)
16781 ("m" . 30.4) ("y" . 365.25)
16782 ("h" . 0.041667)))))))
16783 ;; go for the default.
16784 (t tv))))
16786 (defun org-calendar-select-mouse (ev)
16787 "Return to `org-read-date' with the date currently selected.
16788 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16789 (interactive "e")
16790 (mouse-set-point ev)
16791 (when (calendar-cursor-to-date)
16792 (let* ((date (calendar-cursor-to-date))
16793 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16794 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16795 (if (active-minibuffer-window) (exit-minibuffer))))
16797 (defun org-check-deadlines (ndays)
16798 "Check if there are any deadlines due or past due.
16799 A deadline is considered due if it happens within `org-deadline-warning-days'
16800 days from today's date. If the deadline appears in an entry marked DONE,
16801 it is not shown. The prefix arg NDAYS can be used to test that many
16803 (interactive "P")
16804 (let* ((org-warn-days
16805 (cond
16806 ((equal ndays '(4)) 100000)
16807 (ndays (prefix-numeric-value ndays))
16808 (t (abs org-deadline-warning-days))))
16809 (case-fold-search nil)
16811 (callback
16812 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16814 (message "%d deadlines past-due or due within %d days"
16815 (org-occur regexp nil callback)
16816 org-warn-days)))
16818 (defsubst org-re-timestamp (type)
16819 "Return a regexp for timestamp TYPE.
16820 Allowed values for TYPE are:
16822 all: all timestamps
16823 active: only active timestamps (<...>)
16824 inactive: only inactive timestamps ([...])
16825 scheduled: only scheduled timestamps
16826 deadline: only deadline timestamps
16827 closed: only closed time-stamps
16829 When TYPE is nil, fall back on returning a regexp that matches
16830 both scheduled and deadline timestamps."
16831 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16832 ((eq type 'active) org-ts-regexp)
16836 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16837 ((eq type 'scheduled-or-deadline)
16840 (defun org-check-before-date (date)
16841 "Check if there are deadlines or scheduled entries before DATE."
16842 (interactive (list (org-read-date)))
16843 (let ((case-fold-search nil)
16844 (regexp (org-re-timestamp org-ts-type))
16845 (callback
16846 (lambda () (time-less-p
16847 (org-time-string-to-time (match-string 1))
16848 (org-time-string-to-time date)))))
16849 (message "%d entries before %s"
16850 (org-occur regexp nil callback) date)))
16852 (defun org-check-after-date (date)
16853 "Check if there are deadlines or scheduled entries after DATE."
16854 (interactive (list (org-read-date)))
16855 (let ((case-fold-search nil)
16856 (regexp (org-re-timestamp org-ts-type))
16857 (callback
16858 (lambda () (not
16859 (time-less-p
16860 (org-time-string-to-time (match-string 1))
16861 (org-time-string-to-time date))))))
16862 (message "%d entries after %s"
16863 (org-occur regexp nil callback) date)))
16865 (defun org-check-dates-range (start-date end-date)
16866 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16867 (interactive (list (org-read-date nil nil nil "Range starts")
16868 (org-read-date nil nil nil "Range end")))
16869 (let ((case-fold-search nil)
16870 (regexp (org-re-timestamp org-ts-type))
16871 (callback
16872 (lambda ()
16873 (let ((match (match-string 1)))
16874 (and
16875 (not (time-less-p
16876 (org-time-string-to-time match)
16877 (org-time-string-to-time start-date)))
16878 (time-less-p
16879 (org-time-string-to-time match)
16880 (org-time-string-to-time end-date)))))))
16881 (message "%d entries between %s and %s"
16882 (org-occur regexp nil callback) start-date end-date)))
16884 (defun org-evaluate-time-range (&optional to-buffer)
16885 "Evaluate a time range by computing the difference between start and end.
16886 Normally the result is just printed in the echo area, but with prefix arg
16887 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16888 If the time range is actually in a table, the result is inserted into the
16889 next column.
16890 For time difference computation, a year is assumed to be exactly 365
16891 days in order to avoid rounding problems."
16892 (interactive "P")
16893 (or
16894 (org-clock-update-time-maybe)
16895 (save-excursion
16896 (unless (org-at-date-range-p t)
16897 (goto-char (point-at-bol))
16898 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16899 (if (not (org-at-date-range-p t))
16900 (user-error "Not at a time-stamp range, and none found in current line")))
16901 (let* ((ts1 (match-string 1))
16902 (ts2 (match-string 2))
16903 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16904 (match-end (match-end 0))
16905 (time1 (org-time-string-to-time ts1))
16906 (time2 (org-time-string-to-time ts2))
16907 (t1 (org-float-time time1))
16908 (t2 (org-float-time time2))
16909 (diff (abs (- t2 t1)))
16910 (negative (< (- t2 t1) 0))
16911 ;; (ys (floor (* 365 24 60 60)))
16912 (ds (* 24 60 60))
16913 (hs (* 60 60))
16914 (fy "%dy %dd %02d:%02d")
16915 (fy1 "%dy %dd")
16916 (fd "%dd %02d:%02d")
16917 (fd1 "%dd")
16918 (fh "%02d:%02d")
16919 y d h m align)
16920 (if havetime
16921 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16922 y 0
16923 d (floor (/ diff ds)) diff (mod diff ds)
16924 h (floor (/ diff hs)) diff (mod diff hs)
16925 m (floor (/ diff 60)))
16926 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16927 y 0
16928 d (floor (+ (/ diff ds) 0.5))
16929 h 0 m 0))
16930 (if (not to-buffer)
16931 (message "%s" (org-make-tdiff-string y d h m))
16932 (if (org-at-table-p)
16933 (progn
16934 (goto-char match-end)
16935 (setq align t)
16936 (and (looking-at " *|") (goto-char (match-end 0))))
16937 (goto-char match-end))
16938 (if (looking-at
16940 (replace-match ""))
16941 (if negative (insert " -"))
16942 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16943 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16944 (insert " " (format fh h m))))
16945 (if align (org-table-align))
16946 (message "Time difference inserted")))))
16948 (defun org-make-tdiff-string (y d h m)
16949 (let ((fmt "")
16950 (l nil))
16951 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16952 l (push y l)))
16953 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16954 l (push d l)))
16955 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16956 l (push h l)))
16957 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16958 l (push m l)))
16959 (apply 'format fmt (nreverse l))))
16961 (defun org-time-string-to-time (s &optional buffer pos)
16962 "Convert a timestamp string into internal time."
16963 (condition-case errdata
16964 (apply 'encode-time (org-parse-time-string s))
16966 s (if (not (and buffer pos))
16967 ""
16968 (format " at %d in buffer `%s'" pos buffer))
16969 (cdr errdata)))))
16971 (defun org-time-string-to-seconds (s)
16972 "Convert a timestamp string to a number of seconds."
16973 (org-float-time (org-time-string-to-time s)))
16975 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16976 "Convert a time stamp to an absolute day number.
16977 If there is a specifier for a cyclic time stamp, get the closest
16978 date to DAYNR.
16979 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16980 The variable `date' is bound by the calendar when this is called."
16981 (cond
16983 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16984 daynr
16985 (+ daynr 1000)))
16987 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16988 (time-to-days (current-time))) (match-string 0 s)
16989 prefer show-all))
16990 (t (time-to-days
16991 (condition-case errdata
16992 (apply 'encode-time (org-parse-time-string s))
16994 s (if (not (and buffer pos))
16995 ""
16996 (format " at %d in buffer `%s'" pos buffer))
16997 (cdr errdata))))))))
16999 (defun org-days-to-iso-week (days)
17000 "Return the iso week number."
17001 (require 'cal-iso)
17002 (car (calendar-iso-from-absolute days)))
17004 (defun org-small-year-to-year (year)
17005 "Convert 2-digit years into 4-digit years.
17006 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17007 The year 2000 cannot be abbreviated. Any year larger than 99
17008 is returned unchanged."
17009 (if (< year 38)
17010 (setq year (+ 2000 year))
17011 (if (< year 100)
17012 (setq year (+ 1900 year))))
17013 year)
17015 (defun org-time-from-absolute (d)
17016 "Return the time corresponding to date D.
17017 D may be an absolute day number, or a calendar-type list (month day year)."
17018 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17019 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17021 (defun org-calendar-holiday ()
17022 "List of holidays, for Diary display in Org-mode."
17023 (require 'holidays)
17024 (let ((hl (funcall
17025 (if (fboundp 'calendar-check-holidays)
17026 'calendar-check-holidays 'check-calendar-holidays) date)))
17027 (if hl (mapconcat 'identity hl "; "))))
17029 (defun org-diary-sexp-entry (sexp entry date)
17030 "Process a SEXP diary ENTRY for DATE."
17031 (require 'diary-lib)
17032 (let ((result (if calendar-debug-sexp
17033 (let ((stack-trace-on-error t))
17034 (eval (car (read-from-string sexp))))
17035 (condition-case nil
17036 (eval (car (read-from-string sexp)))
17037 (error
17038 (beep)
17039 (message "Bad sexp at line %d in %s: %s"
17040 (org-current-line)
17041 (buffer-file-name) sexp)
17042 (sleep-for 2))))))
17043 (cond ((stringp result) (split-string result "; "))
17044 ((and (consp result)
17045 (not (consp (cdr result)))
17046 (stringp (cdr result))) (cdr result))
17047 ((and (consp result)
17048 (stringp (car result))) result)
17049 (result entry))))
17051 (defun org-diary-to-ical-string (frombuf)
17052 "Get iCalendar entries from diary entries in buffer FROMBUF.
17053 This uses the icalendar.el library."
17054 (let* ((tmpdir (if (featurep 'xemacs)
17055 (temp-directory)
17056 temporary-file-directory))
17057 (tmpfile (make-temp-name
17058 (expand-file-name "orgics" tmpdir)))
17059 buf rtn b e)
17060 (with-current-buffer frombuf
17061 (icalendar-export-region (point-min) (point-max) tmpfile)
17062 (setq buf (find-buffer-visiting tmpfile))
17063 (set-buffer buf)
17064 (goto-char (point-min))
17065 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17066 (setq b (match-beginning 0)))
17067 (goto-char (point-max))
17068 (if (re-search-backward "^END:VEVENT" nil t)
17069 (setq e (match-end 0)))
17071 (kill-buffer buf)
17072 (delete-file tmpfile)
17073 rtn))
17075 (defun org-closest-date (start current change prefer show-all)
17076 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17077 When PREFER is `past', return a date that is either CURRENT or past.
17078 When PREFER is `future', return a date that is either CURRENT or future.
17079 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17080 ;; Make the proper lists from the dates
17081 (catch 'exit
17082 (let ((a1 '(("h" . hour)
17083 ("d" . day)
17084 ("w" . week)
17085 ("m" . month)
17086 ("y" . year)))
17087 (shour (nth 2 (org-parse-time-string start)))
17088 dn dw sday cday n1 n2 n0
17089 d m y y1 y2 date1 date2 nmonths nm ny m2)
17091 (setq start (org-date-to-gregorian start)
17092 current (org-date-to-gregorian
17093 (if show-all
17094 current
17095 (time-to-days (current-time))))
17096 sday (calendar-absolute-from-gregorian start)
17097 cday (calendar-absolute-from-gregorian current))
17099 (if (<= cday sday) (throw 'exit sday))
17102 (setq dn (string-to-number (match-string 1 change))
17103 dw (cdr (assoc (match-string 2 change) a1)))
17104 (user-error "Invalid change specifier: %s" change))
17105 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17106 (cond
17107 ((eq dw 'hour)
17108 (let ((missing-hours
17109 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17110 dn)))
17111 (setq n1 (if (zerop missing-hours) cday
17112 (- cday (1+ (floor (/ missing-hours 24)))))
17113 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17114 ((eq dw 'day)
17115 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17116 n2 (+ n1 dn)))
17117 ((eq dw 'year)
17118 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17119 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17120 (setq date1 (list m d y1)
17121 n1 (calendar-absolute-from-gregorian date1)
17122 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17123 n2 (calendar-absolute-from-gregorian date2)))
17124 ((eq dw 'month)
17125 ;; approx number of month between the two dates
17126 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17127 ;; How often does dn fit in there?
17128 (setq d (nth 1 start) m (car start) y (nth 2 start)
17129 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17130 m (+ m nm)
17131 ny (floor (/ m 12))
17132 y (+ y ny)
17133 m (- m (* ny 12)))
17134 (while (> m 12) (setq m (- m 12) y (1+ y)))
17135 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17136 (setq m2 (+ m dn) y2 y)
17137 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17138 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17139 (while (<= n2 cday)
17140 (setq n1 n2 m m2 y y2)
17141 (setq m2 (+ m dn) y2 y)
17142 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17143 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17144 ;; Make sure n1 is the earlier date
17145 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17146 (if show-all
17147 (cond
17148 ((eq prefer 'past) (if (= cday n2) n2 n1))
17149 ((eq prefer 'future) (if (= cday n1) n1 n2))
17150 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17151 (cond
17152 ((eq prefer 'past) (if (= cday n2) n2 n1))
17153 ((eq prefer 'future) (if (= cday n1) n1 n2))
17154 (t (if (= cday n1) n1 n2)))))))
17156 (defun org-date-to-gregorian (date)
17157 "Turn any specification of DATE into a Gregorian date for the calendar."
17158 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17159 ((and (listp date) (= (length date) 3)) date)
17160 ((stringp date)
17161 (setq date (org-parse-time-string date))
17162 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17163 ((listp date)
17164 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17166 (defun org-parse-time-string (s &optional nodefault)
17167 "Parse the standard Org-mode time string.
17168 This should be a lot faster than the normal `parse-time-string'.
17169 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17170 hour and minute fields will be nil if not given."
17171 (cond ((string-match org-ts-regexp0 s)
17172 (list 0
17173 (if (or (match-beginning 8) (not nodefault))
17174 (string-to-number (or (match-string 8 s) "0")))
17175 (if (or (match-beginning 7) (not nodefault))
17176 (string-to-number (or (match-string 7 s) "0")))
17177 (string-to-number (match-string 4 s))
17178 (string-to-number (match-string 3 s))
17179 (string-to-number (match-string 2 s))
17180 nil nil nil))
17181 ((string-match "^<[^>]+>$" s)
17182 (decode-time (seconds-to-time (org-matcher-time s))))
17183 (t (error "Not a standard Org-mode time string: %s" s))))
17185 (defun org-timestamp-up (&optional arg)
17186 "Increase the date item at the cursor by one.
17187 If the cursor is on the year, change the year. If it is on the month,
17188 the day or the time, change that.
17189 With prefix ARG, change by that many units."
17190 (interactive "p")
17191 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17193 (defun org-timestamp-down (&optional arg)
17194 "Decrease the date item at the cursor by one.
17195 If the cursor is on the year, change the year. If it is on the month,
17196 the day or the time, change that.
17197 With prefix ARG, change by that many units."
17198 (interactive "p")
17199 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17201 (defun org-timestamp-up-day (&optional arg)
17202 "Increase the date in the time stamp by one day.
17203 With prefix ARG, change that many days."
17204 (interactive "p")
17205 (if (and (not (org-at-timestamp-p t))
17206 (org-at-heading-p))
17207 (org-todo 'up)
17208 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17210 (defun org-timestamp-down-day (&optional arg)
17211 "Decrease the date in the time stamp by one day.
17212 With prefix ARG, change that many days."
17213 (interactive "p")
17214 (if (and (not (org-at-timestamp-p t))
17215 (org-at-heading-p))
17216 (org-todo 'down)
17217 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17219 (defun org-at-timestamp-p (&optional inactive-ok)
17220 "Determine if the cursor is in or at a timestamp."
17221 (interactive)
17222 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17223 (pos (point))
17224 (ans (or (looking-at tsr)
17225 (save-excursion
17227 (if (> (point) (point-min)) (backward-char 1))
17228 (and (looking-at tsr)
17229 (> (- (match-end 0) pos) -1))))))
17230 (and ans
17231 (boundp 'org-ts-what)
17232 (setq org-ts-what
17233 (cond
17234 ((= pos (match-beginning 0)) 'bracket)
17235 ;; Point is considered to be "on the bracket" whether
17236 ;; it's really on it or right after it.
17237 ((= pos (1- (match-end 0))) 'bracket)
17238 ((= pos (match-end 0)) 'after)
17239 ((org-pos-in-match-range pos 2) 'year)
17240 ((org-pos-in-match-range pos 3) 'month)
17241 ((org-pos-in-match-range pos 7) 'hour)
17242 ((org-pos-in-match-range pos 8) 'minute)
17243 ((or (org-pos-in-match-range pos 4)
17244 (org-pos-in-match-range pos 5)) 'day)
17245 ((and (> pos (or (match-end 8) (match-end 5)))
17246 (< pos (match-end 0)))
17247 (- pos (or (match-end 8) (match-end 5))))
17248 (t 'day))))
17249 ans))
17251 (defun org-toggle-timestamp-type ()
17252 "Toggle the type (<active> or [inactive]) of a time stamp."
17253 (interactive)
17254 (when (org-at-timestamp-p t)
17255 (let ((beg (match-beginning 0)) (end (match-end 0))
17256 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17257 (save-excursion
17258 (goto-char beg)
17259 (while (re-search-forward "[][<>]" end t)
17260 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17261 t t)))
17262 (message "Timestamp is now %sactive"
17263 (if (equal (char-after beg) ?<) "" "in")))))
17265 (defun org-at-clock-log-p nil
17266 "Is the cursor on the clock log line?"
17267 (save-excursion
17268 (move-beginning-of-line 1)
17271 (defvar org-clock-history) ; defined in org-clock.el
17272 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17273 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17274 "Change the date in the time stamp at point.
17275 The date will be changed by N times WHAT. WHAT can be `day', `month',
17276 `year', `minute', `second'. If WHAT is not given, the cursor position
17277 in the timestamp determines what will be changed.
17279 (let ((origin (point)) origin-cat
17280 with-hm inactive
17281 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17282 org-ts-what
17283 extra rem
17284 ts time time0 fixnext clrgx)
17285 (if (not (org-at-timestamp-p t))
17286 (user-error "Not at a timestamp"))
17287 (if (and (not what) (eq org-ts-what 'bracket))
17288 (org-toggle-timestamp-type)
17289 ;; Point isn't on brackets. Remember the part of the time-stamp
17290 ;; the point was in. Indeed, size of time-stamps may change,
17291 ;; but point must be kept in the same category nonetheless.
17292 (setq origin-cat org-ts-what)
17293 (if (and (not what) (not (eq org-ts-what 'day))
17294 org-display-custom-times
17295 (get-text-property (point) 'display)
17296 (not (get-text-property (1- (point)) 'display)))
17297 (setq org-ts-what 'day))
17298 (setq org-ts-what (or what org-ts-what)
17299 inactive (= (char-after (match-beginning 0)) ?\[)
17300 ts (match-string 0))
17301 (replace-match "")
17302 (when (string-match
17303 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17304 ts)
17305 (setq extra (match-string 1 ts))
17306 (if suppress-tmp-delay
17307 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17309 (setq with-hm t))
17310 (setq time0 (org-parse-time-string ts))
17311 (when (and updown
17312 (eq org-ts-what 'minute)
17313 (not current-prefix-arg))
17314 ;; This looks like s-up and s-down. Change by one rounding step.
17315 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17316 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17317 (setcar (cdr time0) (+ (nth 1 time0)
17318 (if (> n 0) (- rem) (- dm rem))))))
17319 (setq time
17320 (encode-time (or (car time0) 0)
17321 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17322 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17323 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17324 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17325 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17326 (nthcdr 6 time0)))
17327 (when (and (member org-ts-what '(hour minute))
17328 extra
17330 (setq extra (org-modify-ts-extra
17331 extra
17332 (if (eq org-ts-what 'hour) 2 5)
17333 n dm)))
17334 (when (integerp org-ts-what)
17335 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17336 (if (eq what 'calendar)
17337 (let ((cal-date (org-get-date-from-calendar)))
17338 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17339 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17340 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17341 (setcar time0 (or (car time0) 0))
17342 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17343 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17344 (setq time (apply 'encode-time time0))))
17345 ;; Insert the new time-stamp, and ensure point stays in the same
17346 ;; category as before (i.e. not after the last position in that
17347 ;; category).
17348 (let ((pos (point)))
17349 ;; Stay before inserted string. `save-excursion' is of no use.
17350 (setq org-last-changed-timestamp
17351 (org-insert-time-stamp time with-hm inactive nil nil extra))
17352 (goto-char pos))
17353 (save-match-data
17354 (looking-at org-ts-regexp3)
17355 (goto-char (cond
17356 ;; `day' category ends before `hour' if any, or at
17357 ;; the end of the day name.
17358 ((eq origin-cat 'day)
17359 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17360 ((eq origin-cat 'hour) (min (match-end 7) origin))
17361 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17362 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17363 ;; `year' and `month' have both fixed size: point
17364 ;; couldn't have moved into another part.
17365 (t origin))))
17366 ;; Update clock if on a CLOCK line.
17367 (org-clock-update-time-maybe)
17368 ;; Maybe adjust the closest clock in `org-clock-history'
17369 (when org-clock-adjust-closest
17370 (if (not (and (org-at-clock-log-p)
17371 (< 1 (length (delq nil (mapcar 'marker-position
17372 org-clock-history))))))
17373 (message "No clock to adjust")
17374 (cond ((save-excursion ; fix previous clock?
17375 (re-search-backward org-ts-regexp0 nil t)
17378 ((save-excursion ; fix next clock?
17379 (re-search-backward org-ts-regexp0 nil t)
17382 (save-window-excursion
17383 ;; Find closest clock to point, adjust the previous/next one in history
17384 (let* ((p (save-excursion (org-back-to-heading t)))
17385 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17386 (clfixnth
17387 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17388 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17389 (if (not clfixpos)
17390 (message "No clock to adjust")
17391 (save-excursion
17392 (org-goto-marker-or-bmk clfixpos)
17393 (org-show-subtree)
17394 (when (re-search-forward clrgx nil t)
17395 (goto-char (match-beginning 1))
17396 (let (org-clock-adjust-closest)
17397 (org-timestamp-change n org-ts-what updown))
17398 (message "Clock adjusted in %s for heading: %s"
17399 (file-name-nondirectory (buffer-file-name))
17400 (org-get-heading t t)))))))))
17401 ;; Try to recenter the calendar window, if any.
17402 (if (and org-calendar-follow-timestamp-change
17403 (get-buffer-window "*Calendar*" t)
17404 (memq org-ts-what '(day month year)))
17405 (org-recenter-calendar (time-to-days time))))))
17407 (defun org-modify-ts-extra (s pos n dm)
17408 "Change the different parts of the lead-time and repeat fields in timestamp."
17409 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17410 ng h m new rem)
17411 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17412 (cond
17413 ((or (org-pos-in-match-range pos 2)
17414 (org-pos-in-match-range pos 3))
17415 (setq m (string-to-number (match-string 3 s))
17416 h (string-to-number (match-string 2 s)))
17417 (if (org-pos-in-match-range pos 2)
17418 (setq h (+ h n))
17419 (setq n (* dm (org-no-warnings (signum n))))
17420 (when (not (= 0 (setq rem (% m dm))))
17421 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17422 (setq m (+ m n)))
17423 (if (< m 0) (setq m (+ m 60) h (1- h)))
17424 (if (> m 59) (setq m (- m 60) h (1+ h)))
17425 (setq h (min 24 (max 0 h)))
17426 (setq ng 1 new (format "-%02d:%02d" h m)))
17427 ((org-pos-in-match-range pos 6)
17428 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17429 ((org-pos-in-match-range pos 5)
17430 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17432 ((org-pos-in-match-range pos 9)
17433 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17434 ((org-pos-in-match-range pos 8)
17435 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17437 (when ng
17438 (setq s (concat
17439 (substring s 0 (match-beginning ng))
17440 new
17441 (substring s (match-end ng))))))
17442 s))
17444 (defun org-recenter-calendar (date)
17445 "If the calendar is visible, recenter it to DATE."
17446 (let ((cwin (get-buffer-window "*Calendar*" t)))
17447 (when cwin
17448 (let ((calendar-move-hook nil))
17449 (with-selected-window cwin
17450 (calendar-goto-date (if (listp date) date
17451 (calendar-gregorian-from-absolute date))))))))
17453 (defun org-goto-calendar (&optional arg)
17454 "Go to the Emacs calendar at the current date.
17455 If there is a time stamp in the current line, go to that date.
17456 A prefix ARG can be used to force the current date."
17457 (interactive "P")
17458 (let ((tsr org-ts-regexp) diff
17459 (calendar-move-hook nil)
17460 (calendar-view-holidays-initially-flag nil)
17461 (calendar-view-diary-initially-flag nil))
17462 (if (or (org-at-timestamp-p)
17463 (save-excursion
17464 (beginning-of-line 1)
17465 (looking-at (concat ".*" tsr))))
17466 (let ((d1 (time-to-days (current-time)))
17467 (d2 (time-to-days
17468 (org-time-string-to-time (match-string 1)))))
17469 (setq diff (- d2 d1))))
17470 (calendar)
17471 (calendar-goto-today)
17472 (if (and diff (not arg)) (calendar-forward-day diff))))
17474 (defun org-get-date-from-calendar ()
17475 "Return a list (month day year) of date at point in calendar."
17476 (with-current-buffer "*Calendar*"
17477 (save-match-data
17478 (calendar-cursor-to-date))))
17480 (defun org-date-from-calendar ()
17481 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17482 If there is already a time stamp at the cursor position, update it."
17483 (interactive)
17484 (if (org-at-timestamp-p t)
17485 (org-timestamp-change 0 'calendar)
17486 (let ((cal-date (org-get-date-from-calendar)))
17487 (org-insert-time-stamp
17488 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17490 (defcustom org-effort-durations
17491 `(("h" . 60)
17492 ("d" . ,(* 60 8))
17493 ("w" . ,(* 60 8 5))
17494 ("m" . ,(* 60 8 5 4))
17495 ("y" . ,(* 60 8 5 40)))
17496 "Conversion factor to minutes for an effort modifier.
17498 Each entry has the form (MODIFIER . MINUTES).
17500 In an effort string, a number followed by MODIFIER is multiplied
17501 by the specified number of MINUTES to obtain an effort in
17502 minutes.
17506 :group 'org-agenda
17507 :version "24.1"
17508 :type '(alist :key-type (string :tag "Modifier")
17509 :value-type (number :tag "Minutes")))
17511 (defun org-minutes-to-clocksum-string (m)
17512 "Format number of minutes as a clocksum string.
17513 The format is determined by `org-time-clocksum-format',
17514 `org-time-clocksum-use-fractional' and
17515 `org-time-clocksum-fractional-format' and
17516 `org-time-clocksum-use-effort-durations'."
17517 (let ((clocksum "")
17518 (m (round m)) ; Don't allow fractions of minutes
17519 h d w mo y fmt n)
17520 (setq h (if org-time-clocksum-use-effort-durations
17521 (cdr (assoc "h" org-effort-durations)) 60)
17522 d (if org-time-clocksum-use-effort-durations
17523 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17524 w (if org-time-clocksum-use-effort-durations
17525 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17526 mo (if org-time-clocksum-use-effort-durations
17527 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17528 y (if org-time-clocksum-use-effort-durations
17529 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17530 ;; fractional format
17531 (if org-time-clocksum-use-fractional
17532 (cond
17533 ;; single format string
17534 ((stringp org-time-clocksum-fractional-format)
17535 (format org-time-clocksum-fractional-format (/ m (float h))))
17536 ;; choice of fractional formats for different time units
17537 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17538 (> (/ (truncate m) (* y d h)) 0))
17539 (format fmt (/ m (* y d (float h)))))
17540 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17541 (> (/ (truncate m) (* mo d h)) 0))
17542 (format fmt (/ m (* mo d (float h)))))
17543 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17544 (> (/ (truncate m) (* w d h)) 0))
17545 (format fmt (/ m (* w d (float h)))))
17546 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17547 (> (/ (truncate m) (* d h)) 0))
17548 (format fmt (/ m (* d (float h)))))
17549 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17550 (> (/ (truncate m) h) 0))
17551 (format fmt (/ m (float h))))
17552 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17553 (format fmt m))
17554 ;; fall back to smallest time unit with a format
17555 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17556 (format fmt (/ m (float h))))
17557 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17558 (format fmt (/ m (* d (float h)))))
17559 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17560 (format fmt (/ m (* w d (float h)))))
17561 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17562 (format fmt (/ m (* mo d (float h)))))
17563 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17564 (format fmt (/ m (* y d (float h))))))
17565 ;; standard (non-fractional) format, with single format string
17566 (if (stringp org-time-clocksum-format)
17567 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17568 ;; separate formats components
17569 (and (setq fmt (plist-get org-time-clocksum-format :years))
17570 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17571 (plist-get org-time-clocksum-format :require-years))
17572 (setq clocksum (concat clocksum (format fmt n))
17573 m (- m (* n y d h))))
17574 (and (setq fmt (plist-get org-time-clocksum-format :months))
17575 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17576 (plist-get org-time-clocksum-format :require-months))
17577 (setq clocksum (concat clocksum (format fmt n))
17578 m (- m (* n mo d h))))
17579 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17580 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17581 (plist-get org-time-clocksum-format :require-weeks))
17582 (setq clocksum (concat clocksum (format fmt n))
17583 m (- m (* n w d h))))
17584 (and (setq fmt (plist-get org-time-clocksum-format :days))
17585 (or (> (setq n (/ (truncate m) (* d h))) 0)
17586 (plist-get org-time-clocksum-format :require-days))
17587 (setq clocksum (concat clocksum (format fmt n))
17588 m (- m (* n d h))))
17589 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17590 (or (> (setq n (/ (truncate m) h)) 0)
17591 (plist-get org-time-clocksum-format :require-hours))
17592 (setq clocksum (concat clocksum (format fmt n))
17593 m (- m (* n h))))
17594 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17595 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17596 (setq clocksum (concat clocksum (format fmt m))))
17597 ;; return formatted time duration
17598 clocksum))))
17600 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17601 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17602 "Org mode version 8.0")
17604 (defun org-hours-to-clocksum-string (n)
17605 (org-minutes-to-clocksum-string (* n 60)))
17607 (defun org-hh:mm-string-to-minutes (s)
17608 "Convert a string H:MM to a number of minutes.
17609 If the string is just a number, interpret it as minutes.
17610 In fact, the first hh:mm or number in the string will be taken,
17611 there can be extra stuff in the string.
17612 If no number is found, the return value is 0."
17613 (cond
17614 ((integerp s) s)
17616 (+ (* (string-to-number (match-string 1 s)) 60)
17617 (string-to-number (match-string 2 s))))
17619 (string-to-number (match-string 1 s)))
17620 (t 0)))
17622 (defcustom org-image-actual-width t
17623 "Should we use the actual width of images when inlining them?
17625 When set to `t', always use the image width.
17627 When set to a number, use imagemagick (when available) to set
17628 the image's width to this value.
17630 When set to a number in a list, try to get the width from any
17631 #+ATTR.* keyword if it matches a width specification like
17633 #+ATTR_HTML: :width 300px
17635 and fall back on that number if none is found.
17637 When set to nil, try to get the width from an #+ATTR.* keyword
17638 and fall back on the original width if none is found.
17640 This requires Emacs >= 24.1, build with imagemagick support."
17641 :group 'org-appearance
17642 :version "24.4"
17643 :package-version '(Org . "8.0")
17644 :type '(choice
17645 (const :tag "Use the image width" t)
17646 (integer :tag "Use a number of pixels")
17647 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17648 (const :tag "Use #+ATTR* or don't resize" nil)))
17650 (defcustom org-agenda-inhibit-startup nil
17651 "Inhibit startup when preparing agenda buffers.
17652 When this variable is `t' (the default), the initialization of
17653 the Org agenda buffers is inhibited: e.g. the visibility state
17654 is not set, the tables are not re-aligned, etc."
17655 :type 'boolean
17656 :version "24.3"
17657 :group 'org-agenda)
17659 (defun org-duration-string-to-minutes (s &optional output-to-string)
17660 "Convert a duration string S to minutes.
17662 A bare number is interpreted as minutes, modifiers can be set by
17663 customizing `org-effort-durations' (which see).
17665 Entries containing a colon are interpreted as H:MM by
17666 `org-hh:mm-string-to-minutes'."
17667 (let ((result 0)
17669 (regexp-opt (mapcar 'car org-effort-durations))
17671 (while (string-match re s)
17672 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17673 (string-to-number (match-string 1 s))))
17674 (setq s (replace-match "" nil t s)))
17675 (setq result (floor result))
17676 (incf result (org-hh:mm-string-to-minutes s))
17677 (if output-to-string (number-to-string result) result)))
17679 ;;;; Files
17681 (defun org-save-all-org-buffers ()
17682 "Save all Org-mode buffers without user confirmation."
17683 (interactive)
17684 (message "Saving all Org-mode buffers...")
17685 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17686 (when (featurep 'org-id) (org-id-locations-save))
17687 (message "Saving all Org-mode buffers... done"))
17689 (defun org-revert-all-org-buffers ()
17690 "Revert all Org-mode buffers.
17691 Prompt for confirmation when there are unsaved changes.
17692 Be sure you know what you are doing before letting this function
17693 overwrite your changes.
17695 This function is useful in a setup where one tracks org files
17696 with a version control system, to revert on one machine after pulling
17697 changes from another. I believe the procedure must be like this:
17699 1. M-x org-save-all-org-buffers
17700 2. Pull changes from the other machine, resolve conflicts
17701 3. M-x org-revert-all-org-buffers"
17702 (interactive)
17703 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17704 (user-error "Abort"))
17705 (save-excursion
17706 (save-window-excursion
17707 (mapc
17708 (lambda (b)
17709 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17710 (with-current-buffer b buffer-file-name))
17711 (org-pop-to-buffer-same-window b)
17712 (revert-buffer t 'no-confirm)))
17713 (buffer-list))
17714 (when (and (featurep 'org-id) org-id-track-globally)
17715 (org-id-locations-load)))))
17717 ;;;; Agenda files
17719 ;;;###autoload
17720 (defun org-switchb (&optional arg)
17721 "Switch between Org buffers.
17722 With one prefix argument, restrict available buffers to files.
17723 With two prefix arguments, restrict available buffers to agenda files.
17725 Defaults to `iswitchb' for buffer name completion.
17726 Set `org-completion-use-ido' to make it use ido instead."
17727 (interactive "P")
17728 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17729 ((equal arg '(16)) (org-buffer-list 'agenda))
17730 (t (org-buffer-list))))
17731 (org-completion-use-iswitchb org-completion-use-iswitchb)
17732 (org-completion-use-ido org-completion-use-ido))
17733 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17734 (setq org-completion-use-iswitchb t))
17735 (org-pop-to-buffer-same-window
17736 (org-icompleting-read "Org buffer: "
17737 (mapcar 'list (mapcar 'buffer-name blist))
17738 nil t))))
17740 ;;; Define some older names previously used for this functionality
17741 ;;;###autoload
17742 (defalias 'org-ido-switchb 'org-switchb)
17743 ;;;###autoload
17744 (defalias 'org-iswitchb 'org-switchb)
17746 (defun org-buffer-list (&optional predicate exclude-tmp)
17747 "Return a list of Org buffers.
17748 PREDICATE can be `export', `files' or `agenda'.
17750 export restrict the list to Export buffers.
17751 files restrict the list to buffers visiting Org files.
17752 agenda restrict the list to buffers visiting agenda files.
17754 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17755 (let* ((bfn nil)
17756 (agenda-files (and (eq predicate 'agenda)
17757 (mapcar 'file-truename (org-agenda-files t))))
17758 (filter
17759 (cond
17760 ((eq predicate 'files)
17761 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17762 ((eq predicate 'export)
17763 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17764 ((eq predicate 'agenda)
17765 (lambda (b)
17766 (with-current-buffer b
17767 (and (derived-mode-p 'org-mode)
17768 (setq bfn (buffer-file-name b))
17769 (member (file-truename bfn) agenda-files)))))
17770 (t (lambda (b) (with-current-buffer b
17771 (or (derived-mode-p 'org-mode)
17772 (string-match "\*Org .*Export"
17773 (buffer-name b)))))))))
17774 (delq nil
17775 (mapcar
17776 (lambda(b)
17777 (if (and (funcall filter b)
17778 (or (not exclude-tmp)
17779 (not (string-match "tmp" (buffer-name b)))))
17780 b
17781 nil))
17782 (buffer-list)))))
17784 (defun org-agenda-files (&optional unrestricted archives)
17785 "Get the list of agenda files.
17786 Optional UNRESTRICTED means return the full list even if a restriction
17787 is currently in place.
17788 When ARCHIVES is t, include all archive files that are really being
17789 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17790 `org-agenda-archives-mode' is t."
17791 (let ((files
17792 (cond
17793 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17794 ((stringp org-agenda-files) (org-read-agenda-file-list))
17795 ((listp org-agenda-files) org-agenda-files)
17796 (t (error "Invalid value of `org-agenda-files'")))))
17797 (setq files (apply 'append
17798 (mapcar (lambda (f)
17799 (if (file-directory-p f)
17800 (directory-files
17801 f t org-agenda-file-regexp)
17802 (list f)))
17803 files)))
17804 (when org-agenda-skip-unavailable-files
17805 (setq files (delq nil
17806 (mapcar (function
17807 (lambda (file)
17808 (and (file-readable-p file) file)))
17809 files))))
17810 (when (or (eq archives t)
17811 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17812 (setq files (org-add-archive-files files)))
17813 files))
17815 (defun org-agenda-file-p (&optional file)
17816 "Return non-nil, if FILE is an agenda file.
17817 If FILE is omitted, use the file associated with the current
17818 buffer."
17819 (member (or file (buffer-file-name))
17820 (org-agenda-files t)))
17822 (defun org-edit-agenda-file-list ()
17823 "Edit the list of agenda files.
17824 Depending on setup, this either uses customize to edit the variable
17825 `org-agenda-files', or it visits the file that is holding the list. In the
17826 latter case, the buffer is set up in a way that saving it automatically kills
17827 the buffer and restores the previous window configuration."
17828 (interactive)
17829 (if (stringp org-agenda-files)
17830 (let ((cw (current-window-configuration)))
17831 (find-file org-agenda-files)
17832 (org-set-local 'org-window-configuration cw)
17833 (org-add-hook 'after-save-hook
17834 (lambda ()
17835 (set-window-configuration
17836 (prog1 org-window-configuration
17837 (kill-buffer (current-buffer))))
17838 (org-install-agenda-files-menu)
17839 (message "New agenda file list installed"))
17840 nil 'local)
17841 (message "%s" (substitute-command-keys
17843 (customize-variable 'org-agenda-files)))
17845 (defun org-store-new-agenda-file-list (list)
17846 "Set new value for the agenda file list and save it correctly."
17847 (if (stringp org-agenda-files)
17848 (let ((fe (org-read-agenda-file-list t)) b u)
17849 (while (setq b (find-buffer-visiting org-agenda-files))
17850 (kill-buffer b))
17851 (with-temp-file org-agenda-files
17852 (insert
17853 (mapconcat
17854 (lambda (f) ;; Keep un-expanded entries.
17855 (if (setq u (assoc f fe))
17856 (cdr u)
17857 f))
17860 (let ((org-mode-hook nil) (org-inhibit-startup t)
17861 (org-insert-mode-line-in-empty-file nil))
17862 (setq org-agenda-files list)
17863 (customize-save-variable 'org-agenda-files org-agenda-files))))
17865 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17866 "Read the list of agenda files from a file.
17867 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17868 filenames, used by `org-store-new-agenda-file-list' to write back
17869 un-expanded file names."
17870 (when (file-directory-p org-agenda-files)
17871 (error "`org-agenda-files' cannot be a single directory"))
17872 (when (stringp org-agenda-files)
17873 (with-temp-buffer
17874 (insert-file-contents org-agenda-files)
17875 (mapcar
17876 (lambda (f)
17877 (let ((e (expand-file-name (substitute-in-file-name f)
17878 org-directory)))
17879 (if pair-with-expansion
17880 (cons e f)
17881 e)))
17884 ;;;###autoload
17885 (defun org-cycle-agenda-files ()
17886 "Cycle through the files in `org-agenda-files'.
17887 If the current buffer visits an agenda file, find the next one in the list.
17888 If the current buffer does not, find the first agenda file."
17889 (interactive)
17890 (let* ((fs (org-agenda-files t))
17891 (files (append fs (list (car fs))))
17892 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17893 file)
17894 (unless files (user-error "No agenda files"))
17895 (catch 'exit
17896 (while (setq file (pop files))
17897 (if (equal (file-truename file) tcf)
17898 (when (car files)
17899 (find-file (car files))
17900 (throw 'exit t))))
17901 (find-file (car fs)))
17902 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17904 (defun org-agenda-file-to-front (&optional to-end)
17905 "Move/add the current file to the top of the agenda file list.
17906 If the file is not present in the list, it is added to the front. If it is
17907 present, it is moved there. With optional argument TO-END, add/move to the
17908 end of the list."
17909 (interactive "P")
17910 (let ((org-agenda-skip-unavailable-files nil)
17911 (file-alist (mapcar (lambda (x)
17912 (cons (file-truename x) x))
17913 (org-agenda-files t)))
17914 (ctf (file-truename
17915 (or buffer-file-name
17916 (user-error "Please save the current buffer to a file"))))
17917 x had)
17918 (setq x (assoc ctf file-alist) had x)
17920 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17921 (if to-end
17922 (setq file-alist (append (delq x file-alist) (list x)))
17923 (setq file-alist (cons x (delq x file-alist))))
17924 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17925 (org-install-agenda-files-menu)
17926 (message "File %s to %s of agenda file list"
17927 (if had "moved" "added") (if to-end "end" "front"))))
17929 (defun org-remove-file (&optional file)
17930 "Remove current file from the list of files in variable `org-agenda-files'.
17931 These are the files which are being checked for agenda entries.
17932 Optional argument FILE means use this file instead of the current."
17933 (interactive)
17934 (let* ((org-agenda-skip-unavailable-files nil)
17935 (file (or file buffer-file-name
17936 (user-error "Current buffer does not visit a file")))
17937 (true-file (file-truename file))
17938 (afile (abbreviate-file-name file))
17939 (files (delq nil (mapcar
17940 (lambda (x)
17941 (if (equal true-file
17942 (file-truename x))
17943 nil x))
17944 (org-agenda-files t)))))
17945 (if (not (= (length files) (length (org-agenda-files t))))
17946 (progn
17947 (org-store-new-agenda-file-list files)
17948 (org-install-agenda-files-menu)
17949 (message "Removed file: %s" afile))
17950 (message "File was not in list: %s (not removed)" afile))))
17952 (defun org-file-menu-entry (file)
17953 (vector file (list 'find-file file) t))
17955 (defun org-check-agenda-file (file)
17956 "Make sure FILE exists. If not, ask user what to do."
17957 (when (not (file-exists-p file))
17958 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17959 (abbreviate-file-name file))
17960 (let ((r (downcase (read-char-exclusive))))
17961 (cond
17962 ((equal r ?r)
17963 (org-remove-file file)
17964 (throw 'nextfile t))
17965 (t (error "Abort"))))))
17967 (defun org-get-agenda-file-buffer (file)
17968 "Get a buffer visiting FILE. If the buffer needs to be created, add
17969 it to the list of buffers which might be released later."
17970 (let ((buf (org-find-base-buffer-visiting file)))
17971 (if buf
17972 buf ; just return it
17973 ;; Make a new buffer and remember it
17974 (setq buf (find-file-noselect file))
17975 (if buf (push buf org-agenda-new-buffers))
17976 buf)))
17978 (defun org-release-buffers (blist)
17979 "Release all buffers in list, asking the user for confirmation when needed.
17980 When a buffer is unmodified, it is just killed. When modified, it is saved
17981 \(if the user agrees) and then killed."
17982 (let (buf file)
17983 (while (setq buf (pop blist))
17984 (setq file (buffer-file-name buf))
17985 (when (and (buffer-modified-p buf)
17986 file
17987 (y-or-n-p (format "Save file %s? " file)))
17988 (with-current-buffer buf (save-buffer)))
17989 (kill-buffer buf))))
17991 (defun org-agenda-prepare-buffers (files)
17992 "Create buffers for all agenda files, protect archived trees and comments."
17993 (interactive)
17994 (let ((pa '(:org-archived t))
17995 (pc '(:org-comment t))
17996 (pall '(:org-archived t :org-comment t))
17997 (inhibit-read-only t)
17998 (org-inhibit-startup org-agenda-inhibit-startup)
17999 (rea (concat ":" org-archive-tag ":"))
18000 file re)
18001 (setq org-tag-alist-for-agenda nil
18002 org-tag-groups-alist-for-agenda nil)
18003 (save-excursion
18004 (save-restriction
18005 (while (setq file (pop files))
18006 (catch 'nextfile
18007 (if (bufferp file)
18008 (set-buffer file)
18009 (org-check-agenda-file file)
18010 (set-buffer (org-get-agenda-file-buffer file)))
18011 (widen)
18012 (org-set-regexps-and-options-for-tags)
18013 (goto-char (point-min))
18014 (let ((case-fold-search t))
18015 (when (search-forward "#+setupfile" nil t)
18016 ;; Don't set all regexps and options systematically as
18017 ;; this is only run for setting agenda tags from setup
18018 ;; file
18019 (org-set-regexps-and-options)))
18020 (org-refresh-category-properties)
18021 (org-refresh-properties org-effort-property 'org-effort)
18022 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
18023 (setq org-todo-keywords-for-agenda
18024 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18025 (setq org-done-keywords-for-agenda
18026 (append org-done-keywords-for-agenda org-done-keywords))
18027 (setq org-todo-keyword-alist-for-agenda
18028 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18029 (setq org-drawers-for-agenda
18030 (append org-drawers-for-agenda org-drawers))
18031 (setq org-tag-alist-for-agenda
18032 (org-uniquify
18033 (append org-tag-alist-for-agenda
18034 org-tag-alist
18035 org-tag-persistent-alist)))
18036 (if org-group-tags
18037 (setq org-tag-groups-alist-for-agenda
18038 (org-uniquify-alist
18039 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18040 (org-with-silent-modifications
18041 (save-excursion
18042 (remove-text-properties (point-min) (point-max) pall)
18043 (when org-agenda-skip-archived-trees
18044 (goto-char (point-min))
18045 (while (re-search-forward rea nil t)
18046 (if (org-at-heading-p t)
18047 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18048 (goto-char (point-min))
18049 (setq re (format org-heading-keyword-regexp-format
18050 org-comment-string))
18051 (while (re-search-forward re nil t)
18052 (add-text-properties
18053 (match-beginning 0) (org-end-of-subtree t) pc))))))))
18054 (setq org-todo-keywords-for-agenda
18055 (org-uniquify org-todo-keywords-for-agenda))
18056 (setq org-todo-keyword-alist-for-agenda
18057 (org-uniquify org-todo-keyword-alist-for-agenda))))
18059 \f
18060 ;;;; CDLaTeX minor mode
18062 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18063 "Keymap for the minor `org-cdlatex-mode'.")
18065 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18066 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18067 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18068 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18069 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18071 (defvar org-cdlatex-texmathp-advice-is-done nil
18072 "Flag remembering if we have applied the advice to texmathp already.")
18074 (define-minor-mode org-cdlatex-mode
18075 "Toggle the minor `org-cdlatex-mode'.
18076 This mode supports entering LaTeX environment and math in LaTeX fragments
18077 in Org-mode.
18079 nil " OCDL" nil
18080 (when org-cdlatex-mode
18081 (require 'cdlatex)
18082 (run-hooks 'cdlatex-mode-hook)
18083 (cdlatex-compute-tables))
18084 (unless org-cdlatex-texmathp-advice-is-done
18085 (setq org-cdlatex-texmathp-advice-is-done t)
18086 (defadvice texmathp (around org-math-always-on activate)
18087 "Always return t in org-mode buffers.
18088 This is because we want to insert math symbols without dollars even outside
18089 the LaTeX math segments. If Orgmode thinks that point is actually inside
18090 an embedded LaTeX fragment, let texmathp do its job.
18092 (interactive)
18093 (let (p)
18094 (cond
18095 ((not (derived-mode-p 'org-mode)) ad-do-it)
18096 ((eq this-command 'cdlatex-math-symbol)
18097 (setq ad-return-value t
18098 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18099 (t
18100 (let ((p (org-inside-LaTeX-fragment-p)))
18101 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18102 (setq ad-return-value t
18103 texmathp-why '("Org-mode embedded math" . 0))
18104 (if p ad-do-it)))))))))
18106 (defun turn-on-org-cdlatex ()
18107 "Unconditionally turn on `org-cdlatex-mode'."
18108 (org-cdlatex-mode 1))
18110 (defun org-try-cdlatex-tab ()
18111 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18112 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18113 - inside a LaTeX fragment, or
18114 - after the first word in a line, where an abbreviation expansion could
18115 insert a LaTeX environment."
18116 (when org-cdlatex-mode
18117 (cond
18118 ;; Before any word on the line: No expansion possible.
18120 ;; Just after first word on the line: Expand it. Make sure it
18121 ;; cannot happen on headlines, though.
18122 ((save-excursion
18123 (skip-chars-backward "a-zA-Z0-9*")
18125 (and (bolp) (not (org-at-heading-p))))
18126 (cdlatex-tab) t)
18127 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18129 (defun org-cdlatex-underscore-caret (&optional arg)
18130 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18131 Revert to the normal definition outside of these fragments."
18132 (interactive "P")
18133 (if (org-inside-LaTeX-fragment-p)
18134 (call-interactively 'cdlatex-sub-superscript)
18135 (let (org-cdlatex-mode)
18136 (call-interactively (key-binding (vector last-input-event))))))
18138 (defun org-cdlatex-math-modify (&optional arg)
18139 "Execute `cdlatex-math-modify' in LaTeX fragments.
18140 Revert to the normal definition outside of these fragments."
18141 (interactive "P")
18142 (if (org-inside-LaTeX-fragment-p)
18143 (call-interactively 'cdlatex-math-modify)
18144 (let (org-cdlatex-mode)
18145 (call-interactively (key-binding (vector last-input-event))))))
18148 \f
18149 ;;;; LaTeX fragments
18151 (defvar org-latex-regexps
18153 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18156 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18160 "Regular expressions for matching embedded LaTeX.")
18162 (defun org-inside-LaTeX-fragment-p ()
18163 "Test if point is inside a LaTeX fragment.
18165 sequence appearing also before point.
18166 Even though the matchers for math are configurable, this function assumes
18168 delimiters are skipped when they have been removed by customization.
18169 The return value is nil, or a cons cell with the delimiter and the
18170 position of this delimiter.
18172 This function does a reasonably good job, but can locally be fooled by
18173 for example currency specifications. For example it will assume being in
18175 fragments that are properly closed, but during editing, we have to live
18176 with the uncertainty caused by missing closing delimiters. This function
18177 looks only before point, not after."
18178 (catch 'exit
18179 (let ((pos (point))
18180 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18181 (lim (progn
18183 (point)))
18184 dd-on str (start 0) m re)
18185 (goto-char pos)
18186 (when dodollar
18188 re (nth 1 (assoc "$" org-latex-regexps)))
18189 (while (string-match re str start)
18190 (cond
18191 ((= (match-end 0) (length str))
18192 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18193 ((= (match-end 0) (- (length str) 5))
18194 (throw 'exit nil))
18195 (t (setq start (match-end 0))))))
18196 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18197 (goto-char pos)
18198 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18199 (and (match-beginning 2) (throw 'exit nil))
18200 ;; count $$
18202 (setq dd-on (not dd-on)))
18203 (goto-char pos)
18204 (if dd-on (cons "$$" m))))))
18206 (defun org-inside-latex-macro-p ()
18207 "Is point inside a LaTeX macro or its arguments?"
18208 (save-match-data
18209 (org-in-regexp
18212 (defvar org-latex-fragment-image-overlays nil
18213 "List of overlays carrying the images of latex fragments.")
18214 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18216 (defun org-remove-latex-fragment-image-overlays ()
18217 "Remove all overlays with LaTeX fragment images in current buffer."
18218 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18219 (setq org-latex-fragment-image-overlays nil))
18221 (defun org-preview-latex-fragment (&optional subtree)
18222 "Preview the LaTeX fragment at point, or all locally or globally.
18223 If the cursor is in a LaTeX fragment, create the image and overlay
18224 it over the source code. If there is no fragment at point, display
18225 all fragments in the current text, from one headline to the next. With
18226 prefix SUBTREE, display all fragments in the current subtree. With a
18228 the cursor is before the first headline,
18229 display all fragments in the buffer.
18231 (interactive "P")
18232 (unless buffer-file-name
18233 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18234 (when (display-graphic-p)
18235 (org-remove-latex-fragment-image-overlays)
18236 (save-excursion
18237 (save-restriction
18238 (let (beg end at msg)
18239 (cond
18240 ((or (equal subtree '(16))
18241 (not (save-excursion
18242 (re-search-backward org-outline-regexp-bol nil t))))
18243 (setq beg (point-min) end (point-max)
18244 msg "Creating images for buffer...%s"))
18245 ((equal subtree '(4))
18246 (org-back-to-heading)
18247 (setq beg (point) end (org-end-of-subtree t)
18248 msg "Creating images for subtree...%s"))
18249 (t
18250 (if (setq at (org-inside-LaTeX-fragment-p))
18251 (goto-char (max (point-min) (- (cdr at) 2)))
18252 (org-back-to-heading))
18253 (setq beg (point) end (progn (outline-next-heading) (point))
18254 msg (if at "Creating image...%s"
18255 "Creating images for entry...%s"))))
18256 (message msg "")
18257 (narrow-to-region beg end)
18258 (goto-char beg)
18259 (org-format-latex
18260 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18261 (file-name-nondirectory
18262 buffer-file-name)))
18263 default-directory 'overlays msg at 'forbuffer
18264 org-latex-create-formula-image-program)
18265 (message msg "done. Use `C-c C-c' to remove images."))))))
18267 (defun org-format-latex (prefix &optional dir overlays msg at
18268 forbuffer processing-type)
18269 "Replace LaTeX fragments with links to an image, and produce images.
18270 Some of the options can be changed using the variable
18271 `org-format-latex-options'."
18272 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18273 (let* ((prefixnodir (file-name-nondirectory prefix))
18274 (absprefix (expand-file-name prefix dir))
18275 (todir (file-name-directory absprefix))
18276 (opt org-format-latex-options)
18277 (optnew org-format-latex-options)
18278 (matchers (plist-get opt :matchers))
18279 (re-list org-latex-regexps)
18280 (cnt 0) txt hash link beg end re e checkdir
18281 string
18282 m n block-type block linkfile movefile ov)
18283 ;; Check the different regular expressions
18284 (while (setq e (pop re-list))
18285 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18287 (when (member m matchers)
18288 (goto-char (point-min))
18289 (while (re-search-forward re nil t)
18290 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18291 (or (not overlays)
18292 (not (eq (get-char-property (match-beginning n)
18293 'org-overlay-type)
18294 'org-latex-overlay))))
18295 (cond
18296 ((eq processing-type 'verbatim))
18297 ((eq processing-type 'mathjax)
18298 ;; Prepare for MathJax processing.
18299 (setq string (match-string n))
18300 (when (member m '("$" "$1"))
18301 (save-excursion
18302 (delete-region (match-beginning n) (match-end n))
18303 (goto-char (match-beginning n))
18305 ((or (eq processing-type 'dvipng)
18306 (eq processing-type 'imagemagick))
18307 ;; Process to an image.
18308 (setq txt (match-string n)
18309 beg (match-beginning n) end (match-end n)
18310 cnt (1+ cnt))
18311 (let ((face (face-at-point))
18312 (fg (plist-get opt :foreground))
18313 (bg (plist-get opt :background))
18314 ;; Ensure full list is printed.
18315 print-length print-level)
18316 (when forbuffer
18317 ;; Get the colors from the face at point.
18318 (goto-char beg)
18319 (when (eq fg 'auto)
18320 (setq fg (face-attribute face :foreground nil 'default)))
18321 (when (eq bg 'auto)
18322 (setq bg (face-attribute face :background nil 'default)))
18323 (setq optnew (copy-sequence opt))
18324 (plist-put optnew :foreground fg)
18325 (plist-put optnew :background bg))
18326 (setq hash (sha1 (prin1-to-string
18327 (list org-format-latex-header
18328 org-latex-default-packages-alist
18329 org-latex-packages-alist
18330 org-format-latex-options
18331 forbuffer txt fg bg)))
18332 linkfile (format "%s_%s.png" prefix hash)
18333 movefile (format "%s_%s.png" absprefix hash)))
18334 (setq link (concat block "[[file:" linkfile "]]" block))
18335 (if msg (message msg cnt))
18336 (goto-char beg)
18337 (unless checkdir ; Ensure the directory exists.
18338 (setq checkdir t)
18339 (or (file-directory-p todir) (make-directory todir t)))
18340 (unless (file-exists-p movefile)
18341 (org-create-formula-image
18342 txt movefile optnew forbuffer processing-type))
18343 (if overlays
18344 (progn
18345 (mapc (lambda (o)
18346 (if (eq (overlay-get o 'org-overlay-type)
18347 'org-latex-overlay)
18348 (delete-overlay o)))
18349 (overlays-in beg end))
18350 (setq ov (make-overlay beg end))
18351 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18352 (if (featurep 'xemacs)
18353 (progn
18354 (overlay-put ov 'invisible t)
18355 (overlay-put
18356 ov 'end-glyph
18357 (make-glyph (vector 'png :file movefile))))
18358 (overlay-put
18359 ov 'display
18360 (list 'image :type 'png :file movefile :ascent 'center)))
18361 (push ov org-latex-fragment-image-overlays)
18362 (goto-char end))
18363 (delete-region beg end)
18364 (insert (org-add-props link
18365 (list 'org-latex-src
18366 (replace-regexp-in-string
18368 'org-latex-src-embed-type
18369 (if block-type 'paragraph 'character))))))
18370 ((eq processing-type 'mathml)
18371 ;; Process to MathML
18372 (unless (save-match-data (org-format-latex-mathml-available-p))
18373 (user-error "LaTeX to MathML converter not configured"))
18374 (setq txt (match-string n)
18375 beg (match-beginning n) end (match-end n)
18376 cnt (1+ cnt))
18377 (if msg (message msg cnt))
18378 (goto-char beg)
18379 (delete-region beg end)
18380 (insert (org-format-latex-as-mathml
18381 txt block-type prefix dir)))
18382 (t
18383 (error "Unknown conversion type %s for LaTeX fragments"
18384 processing-type)))))))))
18386 (defun org-create-math-formula (latex-frag &optional mathml-file)
18387 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18388 Use `org-latex-to-mathml-convert-command'. If the conversion is
18390 elements otherwise return nil. When MATHML-FILE is specified,
18391 write the results in to that file. When invoked as an
18392 interactive command, prompt for LATEX-FRAG, with initial value
18393 set to the current active region and echo the results for user
18394 inspection."
18395 (interactive (list (let ((frag (when (org-region-active-p)
18396 (buffer-substring-no-properties
18397 (region-beginning) (region-end)))))
18398 (read-string "LaTeX Fragment: " frag nil frag))))
18399 (unless latex-frag (error "Invalid LaTeX fragment"))
18400 (let* ((tmp-in-file (file-relative-name
18401 (make-temp-name (expand-file-name "ltxmathml-in"))))
18402 (ignore (write-region latex-frag nil tmp-in-file))
18403 (tmp-out-file (file-relative-name
18404 (make-temp-name (expand-file-name "ltxmathml-out"))))
18405 (cmd (format-spec
18406 org-latex-to-mathml-convert-command
18407 `((?j . ,(shell-quote-argument
18408 (expand-file-name org-latex-to-mathml-jar-file)))
18409 (?I . ,(shell-quote-argument tmp-in-file))
18410 (?o . ,(shell-quote-argument tmp-out-file)))))
18411 mathml shell-command-output)
18412 (when (org-called-interactively-p 'any)
18413 (unless (org-format-latex-mathml-available-p)
18414 (user-error "LaTeX to MathML converter not configured")))
18415 (message "Running %s" cmd)
18416 (setq shell-command-output (shell-command-to-string cmd))
18417 (setq mathml
18418 (when (file-readable-p tmp-out-file)
18419 (with-current-buffer (find-file-noselect tmp-out-file t)
18420 (goto-char (point-min))
18421 (when (re-search-forward
18422 (concat
18423 (regexp-quote
18426 (regexp-quote "</math>")) nil t)
18427 (prog1 (match-string 0) (kill-buffer))))))
18428 (cond
18429 (mathml
18430 (setq mathml
18432 (when mathml-file
18433 (write-region mathml nil mathml-file))
18434 (when (org-called-interactively-p 'any)
18435 (message mathml)))
18436 ((message "LaTeX to MathML conversion failed")
18437 (message shell-command-output)))
18438 (delete-file tmp-in-file)
18439 (when (file-exists-p tmp-out-file)
18440 (delete-file tmp-out-file))
18441 mathml))
18443 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18444 prefix &optional dir)
18445 "Use `org-create-math-formula' but check local cache first."
18446 (let* ((absprefix (expand-file-name prefix dir))
18447 (print-length nil) (print-level nil)
18448 (formula-id (concat
18449 "formula-"
18450 (sha1
18451 (prin1-to-string
18452 (list latex-frag
18453 org-latex-to-mathml-convert-command)))))
18454 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18455 (formula-cache-dir (file-name-directory formula-cache)))
18457 (unless (file-directory-p formula-cache-dir)
18458 (make-directory formula-cache-dir t))
18460 (unless (file-exists-p formula-cache)
18461 (org-create-math-formula latex-frag formula-cache))
18463 (if (file-exists-p formula-cache)
18464 ;; Successful conversion. Return the link to MathML file.
18465 (org-add-props
18466 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18468 'org-latex-src-embed-type (if latex-frag-type
18469 'paragraph 'character)))
18470 ;; Failed conversion. Return the LaTeX fragment verbatim
18471 latex-frag)))
18473 (defun org-create-formula-image (string tofile options buffer &optional type)
18474 "Create an image from LaTeX source using dvipng or convert.
18475 This function calls either `org-create-formula-image-with-dvipng'
18476 or `org-create-formula-image-with-imagemagick' depending on the
18477 value of `org-latex-create-formula-image-program' or on the value
18478 of the optional TYPE variable.
18480 Note: ultimately these two function should be combined as they
18481 share a good deal of logic."
18482 (org-check-external-command
18483 "latex" "needed to convert LaTeX fragments to images")
18484 (funcall
18485 (case (or type org-latex-create-formula-image-program)
18486 ('dvipng
18487 (org-check-external-command
18488 "dvipng" "needed to convert LaTeX fragments to images")
18489 #'org-create-formula-image-with-dvipng)
18490 ('imagemagick
18491 (org-check-external-command
18492 "convert" "you need to install imagemagick")
18493 #'org-create-formula-image-with-imagemagick)
18494 (t (error
18495 "Invalid value of `org-latex-create-formula-image-program'")))
18496 string tofile options buffer))
18498 (declare-function org-export--get-global-options "ox" (&optional backend))
18499 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18500 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18501 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18502 (defun org-create-formula--latex-header ()
18503 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18504 (let ((info (org-combine-plists (org-export--get-global-options 'latex)
18505 (org-export--get-inbuffer-options 'latex))))
18506 (org-latex-guess-babel-language
18507 (org-latex-guess-inputenc
18508 (org-splice-latex-header
18509 org-format-latex-header
18510 org-latex-default-packages-alist
18511 org-latex-packages-alist t
18512 (plist-get info :latex-header)))
18513 info)))
18515 ;; This function borrows from Ganesh Swami's latex2png.el
18516 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18517 "This calls dvipng."
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 (dvifile (concat texfilebase ".dvi"))
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 "Transparent")))
18536 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18537 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18538 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18539 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18540 (let ((latex-header (org-create-formula--latex-header)))
18541 (with-temp-file texfile
18542 (insert latex-header)
18544 (let ((dir default-directory))
18545 (condition-case nil
18546 (progn
18547 (cd tmpdir)
18548 (call-process "latex" nil nil nil texfile))
18549 (error nil))
18550 (cd dir))
18551 (if (not (file-exists-p dvifile))
18552 (progn (message "Failed to create dvi file from %s" texfile) nil)
18553 (condition-case nil
18554 (if (featurep 'xemacs)
18555 (call-process "dvipng" nil nil nil
18556 "-fg" fg "-bg" bg
18557 "-T" "tight"
18558 "-o" pngfile
18559 dvifile)
18560 (call-process "dvipng" nil nil nil
18561 "-fg" fg "-bg" bg
18562 "-D" dpi
18563 ;;"-x" scale "-y" scale
18564 "-T" "tight"
18565 "-o" pngfile
18566 dvifile))
18567 (error nil))
18568 (if (not (file-exists-p pngfile))
18569 (if org-format-latex-signal-error
18570 (error "Failed to create png file from %s" texfile)
18571 (message "Failed to create png file from %s" texfile)
18572 nil)
18573 ;; Use the requested file name and clean up
18574 (copy-file pngfile tofile 'replace)
18575 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18576 (if (file-exists-p (concat texfilebase e))
18577 (delete-file (concat texfilebase e))))
18578 pngfile))))
18580 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18581 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18582 "This calls convert, which is included into imagemagick."
18583 (require 'ox-latex)
18584 (let* ((tmpdir (if (featurep 'xemacs)
18585 (temp-directory)
18586 temporary-file-directory))
18587 (texfilebase (make-temp-name
18588 (expand-file-name "orgtex" tmpdir)))
18589 (texfile (concat texfilebase ".tex"))
18590 (pdffile (concat texfilebase ".pdf"))
18591 (pngfile (concat texfilebase ".png"))
18592 (fnh (if (featurep 'xemacs)
18593 (font-height (face-font 'default))
18594 (face-attribute 'default :height nil)))
18595 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18596 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18597 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18598 "black"))
18599 (bg (or (plist-get options (if buffer :background :html-background))
18600 "white")))
18601 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18602 (setq fg (org-latex-color-format fg)))
18603 (if (eq bg 'default) (setq bg (org-latex-color :background))
18604 (setq bg (org-latex-color-format
18605 (if (string= bg "Transparent") "white" bg))))
18606 (let ((latex-header (org-create-formula--latex-header)))
18607 (with-temp-file texfile
18608 (insert latex-header)
18614 string
18617 (org-latex-compile texfile t)
18618 (if (not (file-exists-p pdffile))
18619 (progn (message "Failed to create pdf file from %s" texfile) nil)
18620 (condition-case nil
18621 (if (featurep 'xemacs)
18622 (call-process "convert" nil nil nil
18623 "-density" "96"
18624 "-trim"
18625 "-antialias"
18626 pdffile
18627 "-quality" "100"
18628 ;; "-sharpen" "0x1.0"
18629 pngfile)
18630 (call-process "convert" nil nil nil
18631 "-density" dpi
18632 "-trim"
18633 "-antialias"
18634 pdffile
18635 "-quality" "100"
18636 ;; "-sharpen" "0x1.0"
18637 pngfile))
18638 (error nil))
18639 (if (not (file-exists-p pngfile))
18640 (if org-format-latex-signal-error
18641 (error "Failed to create png file from %s" texfile)
18642 (message "Failed to create png file from %s" texfile)
18643 nil)
18644 ;; Use the requested file name and clean up
18645 (copy-file pngfile tofile 'replace)
18646 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18647 (if (file-exists-p (concat texfilebase e))
18648 (delete-file (concat texfilebase e))))
18649 pngfile))))
18651 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18652 "Fill a LaTeX header template TPL.
18653 In the template, the following place holders will be recognized:
18656 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18658 [NO-PACKAGES] do not include PKG
18659 [EXTRA] the string EXTRA
18660 [NO-EXTRA] do not include EXTRA
18662 For backward compatibility, if both the positive and the negative place
18664 assumed to be present at the end of the template.
18665 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18666 EXTRA is a string.
18667 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18668 (let (rpl (end ""))
18670 (setq rpl (if (or (match-end 1) (not def-pkg))
18671 "" (org-latex-packages-to-string def-pkg snippets-p t))
18672 tpl (replace-match rpl t t tpl))
18673 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18676 (setq rpl (if (or (match-end 1) (not pkg))
18677 "" (org-latex-packages-to-string pkg snippets-p t))
18678 tpl (replace-match rpl t t tpl))
18679 (if pkg (setq end
18681 (org-latex-packages-to-string pkg snippets-p)))))
18684 (setq rpl (if (or (match-end 1) (not extra))
18686 tpl (replace-match rpl t t tpl))
18692 tpl)))
18694 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18696 (setq pkg (mapconcat (lambda(p)
18697 (cond
18698 ((stringp p) p)
18699 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18700 (format "%% Package %s omitted" (cadr p)))
18701 ((equal "" (car p))
18703 (t
18705 (car p) (cadr p)))))
18706 pkg
18710 (defun org-dvipng-color (attr)
18711 "Return a RGB color specification for dvipng."
18712 (apply 'format "rgb %s %s %s"
18713 (mapcar 'org-normalize-color
18714 (if (featurep 'xemacs)
18715 (color-rgb-components
18716 (face-property 'default
18717 (cond ((eq attr :foreground) 'foreground)
18718 ((eq attr :background) 'background))))
18719 (color-values (face-attribute 'default attr nil))))))
18721 (defun org-dvipng-color-format (color-name)
18722 "Convert COLOR-NAME to a RGB color value for dvipng."
18723 (apply 'format "rgb %s %s %s"
18724 (mapcar 'org-normalize-color
18725 (color-values color-name))))
18727 (defun org-latex-color (attr)
18728 "Return a RGB color for the LaTeX color package."
18729 (apply 'format "%s,%s,%s"
18730 (mapcar 'org-normalize-color
18731 (if (featurep 'xemacs)
18732 (color-rgb-components
18733 (face-property 'default
18734 (cond ((eq attr :foreground) 'foreground)
18735 ((eq attr :background) 'background))))
18736 (color-values (face-attribute 'default attr nil))))))
18738 (defun org-latex-color-format (color-name)
18739 "Convert COLOR-NAME to a RGB color value."
18740 (apply 'format "%s,%s,%s"
18741 (mapcar 'org-normalize-color
18742 (color-values color-name))))
18744 (defun org-normalize-color (value)
18745 "Return string to be used as color value for an RGB component."
18746 (format "%g" (/ value 65535.0)))
18749 \f
18750 ;; Image display
18752 (defvar org-inline-image-overlays nil)
18753 (make-variable-buffer-local 'org-inline-image-overlays)
18755 (defun org-toggle-inline-images (&optional include-linked)
18756 "Toggle the display of inline images.
18757 INCLUDE-LINKED is passed to `org-display-inline-images'."
18758 (interactive "P")
18759 (if org-inline-image-overlays
18760 (progn
18761 (org-remove-inline-images)
18762 (message "Inline image display turned off"))
18763 (org-display-inline-images include-linked)
18764 (if (and (org-called-interactively-p)
18765 org-inline-image-overlays)
18766 (message "%d images displayed inline"
18767 (length org-inline-image-overlays))
18768 (message "No images to display inline"))))
18770 (defun org-redisplay-inline-images ()
18771 "Refresh the display of inline images."
18772 (interactive)
18773 (if (not org-inline-image-overlays)
18774 (org-toggle-inline-images)
18775 (org-toggle-inline-images)
18776 (org-toggle-inline-images)))
18778 (defun org-display-inline-images (&optional include-linked refresh beg end)
18779 "Display inline images.
18780 Normally only links without a description part are inlined, because this
18781 is how it will work for export. When INCLUDE-LINKED is set, also links
18782 with a description part will be inlined. This can be nice for a quick
18783 look at those images, but it does not reflect what exported files will look
18784 like.
18785 When REFRESH is set, refresh existing images between BEG and END.
18786 This will create new image displays only if necessary.
18787 BEG and END default to the buffer boundaries."
18788 (interactive "P")
18789 (when (display-graphic-p)
18790 (unless refresh
18791 (org-remove-inline-images)
18792 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18793 (save-excursion
18794 (save-restriction
18795 (widen)
18796 (setq beg (or beg (point-min)) end (or end (point-max)))
18797 (goto-char beg)
18799 (substring (org-image-file-name-regexp) 0 -2)
18801 (case-fold-search t)
18802 old file ov img type attrwidth width)
18803 (while (re-search-forward re end t)
18804 (setq old (get-char-property-and-overlay (match-beginning 1)
18805 'org-image-overlay)
18806 file (expand-file-name
18807 (concat (or (match-string 3) "") (match-string 4))))
18808 (when (image-type-available-p 'imagemagick)
18809 (setq attrwidth (if (or (listp org-image-actual-width)
18810 (null org-image-actual-width))
18811 (save-excursion
18812 (save-match-data
18813 (when (re-search-backward
18815 (save-excursion
18817 (string-to-number (match-string 1))))))
18818 width (cond ((eq org-image-actual-width t) nil)
18819 ((null org-image-actual-width) attrwidth)
18820 ((numberp org-image-actual-width)
18821 org-image-actual-width)
18822 ((listp org-image-actual-width)
18823 (or attrwidth (car org-image-actual-width))))
18824 type (if width 'imagemagick)))
18825 (when (file-exists-p file)
18826 (if (and (car-safe old) refresh)
18827 (image-refresh (overlay-get (cdr old) 'display))
18828 (setq img (save-match-data (create-image file type nil :width width)))
18829 (when img
18830 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18831 (overlay-put ov 'display img)
18832 (overlay-put ov 'face 'default)
18833 (overlay-put ov 'org-image-overlay t)
18834 (overlay-put ov 'modification-hooks
18835 (list 'org-display-inline-remove-overlay))
18836 (push ov org-inline-image-overlays))))))))))
18838 (define-obsolete-function-alias
18839 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18841 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18842 "Remove inline-display overlay if a corresponding region is modified."
18843 (let ((inhibit-modification-hooks t))
18844 (when (and ov after)
18845 (delete ov org-inline-image-overlays)
18846 (delete-overlay ov))))
18848 (defun org-remove-inline-images ()
18849 "Remove inline display of images."
18850 (interactive)
18851 (mapc 'delete-overlay org-inline-image-overlays)
18852 (setq org-inline-image-overlays nil))
18854 ;;;; Key bindings
18856 ;; Outline functions from `outline-mode-prefix-map'
18857 ;; that can be remapped in Org:
18858 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18859 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18860 (define-key org-mode-map [remap outline-forward-same-level]
18861 'org-forward-heading-same-level)
18862 (define-key org-mode-map [remap outline-backward-same-level]
18863 'org-backward-heading-same-level)
18864 (define-key org-mode-map [remap show-branches]
18865 'org-kill-note-or-show-branches)
18866 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18867 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18868 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18870 ;; Outline functions from `outline-mode-prefix-map' that can not
18871 ;; be remapped in Org:
18872 ;;
18873 ;; - the column "key binding" shows whether the Outline function is still
18874 ;; available in Org mode on the same key that it has been bound to in
18875 ;; Outline mode:
18876 ;; - "overridden": key used for a different functionality in Org mode
18877 ;; - else: key still bound to the same Outline function in Org mode
18878 ;;
18879 ;; | Outline function | key binding | Org replacement |
18880 ;; |------------------------------------+-------------+-----------------------|
18881 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18882 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18883 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18884 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18885 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18886 ;; | `show-entry' | overridden | no replacement |
18887 ;; | `show-children' | `C-c C-i' | visibility cycling |
18888 ;; | `show-branches' | `C-c C-k' | still same function |
18889 ;; | `show-subtree' | overridden | visibility cycling |
18890 ;; | `show-all' | overridden | no replacement |
18891 ;; | `hide-subtree' | overridden | visibility cycling |
18892 ;; | `hide-body' | overridden | no replacement |
18893 ;; | `hide-entry' | overridden | visibility cycling |
18894 ;; | `hide-leaves' | overridden | no replacement |
18895 ;; | `hide-sublevels' | overridden | no replacement |
18896 ;; | `hide-other' | overridden | no replacement |
18898 ;; Make `C-c C-x' a prefix key
18899 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18901 ;; TAB key with modifiers
18902 (org-defkey org-mode-map "\C-i" 'org-cycle)
18903 (org-defkey org-mode-map [(tab)] 'org-cycle)
18904 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18906 ;; The following line is necessary under Suse GNU/Linux
18907 (unless (featurep 'xemacs)
18908 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18909 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18910 (define-key org-mode-map [backtab] 'org-shifttab)
18912 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18913 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18914 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18916 ;; Cursor keys with modifiers
18917 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18918 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18919 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18920 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18922 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18923 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18924 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18925 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18927 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18928 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18929 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18930 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18932 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18933 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18934 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18935 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18937 ;; Babel keys
18938 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18939 (mapc (lambda (pair)
18940 (define-key org-babel-map (car pair) (cdr pair)))
18941 org-babel-key-bindings)
18943 ;;; Extra keys for tty access.
18944 ;; We only set them when really needed because otherwise the
18945 ;; menus don't show the simple keys
18947 (when (or org-use-extra-keys
18948 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18949 (not window-system))
18950 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18951 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18952 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18953 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18954 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18955 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18956 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18957 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18958 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18959 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18960 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18961 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18962 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18963 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18964 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18965 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18966 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18967 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18968 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18969 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18970 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18971 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18972 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18973 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18974 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18975 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18976 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18977 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18979 ;; All the other keys
18981 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18982 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18983 (if (boundp 'narrow-map)
18984 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18985 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18986 (if (boundp 'narrow-map)
18987 (org-defkey narrow-map "b" 'org-narrow-to-block)
18988 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18989 (if (boundp 'narrow-map)
18990 (org-defkey narrow-map "e" 'org-narrow-to-element)
18991 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18992 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18993 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18994 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18995 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18996 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18997 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18998 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18999 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19000 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19001 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19002 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19003 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19004 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19005 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19006 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19007 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19008 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19009 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19010 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19011 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19012 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19013 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19014 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19015 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19016 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19017 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19019 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19020 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19021 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19022 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19023 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19024 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19025 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19026 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19027 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19028 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19029 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19030 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19031 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19032 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19033 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19034 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19035 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19036 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19037 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19038 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19039 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19041 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19042 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19043 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19044 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19045 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19046 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19047 (org-defkey org-mode-map "\C-c^" 'org-sort)
19048 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19049 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19050 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19051 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19052 (org-defkey org-mode-map "\C-m" 'org-return)
19053 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19054 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19055 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19056 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19057 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19058 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19059 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19060 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19061 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19062 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19063 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19064 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19065 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19066 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19067 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19068 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19069 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19070 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19071 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19072 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19073 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19074 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19075 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19077 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19078 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19079 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19081 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19082 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19083 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19084 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19085 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19086 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19087 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19088 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19089 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19090 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19091 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19092 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19093 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19095 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19096 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19097 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19098 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19099 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19100 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19101 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19102 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19103 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19105 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19106 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19107 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19108 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19109 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19111 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19113 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19115 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19116 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19118 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19121 (when (featurep 'xemacs)
19122 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19125 (defconst org-speed-commands-default
19126 '(
19127 ("Outline Navigation")
19128 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19129 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19130 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19131 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19132 ("F" . org-next-block)
19133 ("B" . org-previous-block)
19134 ("u" . (org-speed-move-safe 'outline-up-heading))
19135 ("j" . org-goto)
19136 ("g" . (org-refile t))
19137 ("Outline Visibility")
19138 ("c" . org-cycle)
19139 ("C" . org-shifttab)
19140 (" " . org-display-outline-path)
19141 ("s" . org-narrow-to-subtree)
19142 ("=" . org-columns)
19143 ("Outline Structure Editing")
19144 ("U" . org-shiftmetaup)
19145 ("D" . org-shiftmetadown)
19146 ("r" . org-metaright)
19147 ("l" . org-metaleft)
19148 ("R" . org-shiftmetaright)
19149 ("L" . org-shiftmetaleft)
19150 ("i" . (progn (forward-char 1) (call-interactively
19151 'org-insert-heading-respect-content)))
19152 ("^" . org-sort)
19153 ("w" . org-refile)
19154 ("a" . org-archive-subtree-default-with-confirmation)
19155 ("@" . org-mark-subtree)
19156 ("#" . org-toggle-comment)
19157 ("Clock Commands")
19158 ("I" . org-clock-in)
19159 ("O" . org-clock-out)
19160 ("Meta Data Editing")
19161 ("t" . org-todo)
19162 ("," . (org-priority))
19163 ("0" . (org-priority ?\ ))
19164 ("1" . (org-priority ?A))
19165 ("2" . (org-priority ?B))
19166 ("3" . (org-priority ?C))
19167 (":" . org-set-tags-command)
19168 ("e" . org-set-effort)
19169 ("E" . org-inc-effort)
19170 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19171 (org-entry-put (point) "APPT_WARNTIME" m)))
19172 ("Agenda Views etc")
19173 ("v" . org-agenda)
19174 ("/" . org-sparse-tree)
19175 ("Misc")
19176 ("o" . org-open-at-point)
19177 ("?" . org-speed-command-help)
19178 ("<" . (org-agenda-set-restriction-lock 'subtree))
19179 (">" . (org-agenda-remove-restriction-lock))
19180 )
19181 "The default speed commands.")
19183 (defun org-print-speed-command (e)
19184 (if (> (length (car e)) 1)
19185 (progn
19187 (princ (car e))
19189 (princ (make-string (length (car e)) ?-))
19191 (princ (car e))
19192 (princ " ")
19193 (if (symbolp (cdr e))
19194 (princ (symbol-name (cdr e)))
19195 (prin1 (cdr e)))
19198 (defun org-speed-command-help ()
19199 "Show the available speed commands."
19200 (interactive)
19201 (if (not org-use-speed-commands)
19202 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19203 (with-output-to-temp-buffer "*Help*"
19205 (mapc 'org-print-speed-command org-speed-commands-user)
19208 (mapc 'org-print-speed-command org-speed-commands-default))
19209 (with-current-buffer "*Help*"
19210 (setq truncate-lines t))))
19212 (defun org-speed-move-safe (cmd)
19213 "Execute CMD, but make sure that the cursor always ends up in a headline.
19214 If not, return to the original position and throw an error."
19215 (interactive)
19216 (let ((pos (point)))
19217 (call-interactively cmd)
19218 (unless (and (bolp) (org-at-heading-p))
19219 (goto-char pos)
19220 (error "Boundary reached while executing %s" cmd))))
19222 (defvar org-self-insert-command-undo-counter 0)
19224 (defvar org-table-auto-blank-field) ; defined in org-table.el
19225 (defvar org-speed-command nil)
19227 (define-obsolete-function-alias
19228 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19230 (defun org-speed-command-activate (keys)
19231 "Hook for activating single-letter speed commands.
19232 `org-speed-commands-default' specifies a minimal command set.
19233 Use `org-speed-commands-user' for further customization."
19234 (when (or (and (bolp) (looking-at org-outline-regexp))
19235 (and (functionp org-use-speed-commands)
19236 (funcall org-use-speed-commands)))
19237 (cdr (assoc keys (append org-speed-commands-user
19238 org-speed-commands-default)))))
19240 (define-obsolete-function-alias
19241 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19243 (defun org-babel-speed-command-activate (keys)
19244 "Hook for activating single-letter code block commands."
19245 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19246 (cdr (assoc keys org-babel-key-bindings))))
19248 (defcustom org-speed-command-hook
19249 '(org-speed-command-default-hook org-babel-speed-command-hook)
19250 "Hook for activating speed commands at strategic locations.
19251 Hook functions are called in sequence until a valid handler is
19252 found.
19254 Each hook takes a single argument, a user-pressed command key
19255 which is also a `self-insert-command' from the global map.
19257 Within the hook, examine the cursor position and the command key
19258 and return nil or a valid handler as appropriate. Handler could
19259 be one of an interactive command, a function, or a form.
19261 Set `org-use-speed-commands' to non-nil value to enable this
19262 hook. The default setting is `org-speed-command-activate'."
19263 :group 'org-structure
19264 :version "24.1"
19265 :type 'hook)
19267 (defun org-self-insert-command (N)
19268 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19269 If the cursor is in a table looking at whitespace, the whitespace is
19270 overwritten, and the table is not marked as requiring realignment."
19271 (interactive "p")
19272 (org-check-before-invisible-edit 'insert)
19273 (cond
19274 ((and org-use-speed-commands
19275 (setq org-speed-command
19276 (run-hook-with-args-until-success
19277 'org-speed-command-hook (this-command-keys))))
19278 (cond
19279 ((commandp org-speed-command)
19280 (setq this-command org-speed-command)
19281 (call-interactively org-speed-command))
19282 ((functionp org-speed-command)
19283 (funcall org-speed-command))
19284 ((and org-speed-command (listp org-speed-command))
19285 (eval org-speed-command))
19286 (t (let (org-use-speed-commands)
19287 (call-interactively 'org-self-insert-command)))))
19288 ((and
19289 (org-table-p)
19290 (progn
19291 ;; check if we blank the field, and if that triggers align
19292 (and (featurep 'org-table) org-table-auto-blank-field
19293 (member last-command
19294 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19296 ;; got extra space, this field does not determine column width
19297 (let (org-table-may-need-update) (org-table-blank-field))
19298 ;; no extra space, this field may determine column width
19299 (org-table-blank-field)))
19300 t)
19301 (eq N 1)
19303 (let (org-table-may-need-update)
19304 (goto-char (1- (match-end 0)))
19305 (backward-delete-char 1)
19306 (goto-char (match-beginning 0))
19307 (self-insert-command N)))
19308 (t
19309 (setq org-table-may-need-update t)
19310 (self-insert-command N)
19311 (org-fix-tags-on-the-fly)
19312 (if org-self-insert-cluster-for-undo
19313 (if (not (eq last-command 'org-self-insert-command))
19314 (setq org-self-insert-command-undo-counter 1)
19315 (if (>= org-self-insert-command-undo-counter 20)
19316 (setq org-self-insert-command-undo-counter 1)
19317 (and (> org-self-insert-command-undo-counter 0)
19318 buffer-undo-list (listp buffer-undo-list)
19319 (not (cadr buffer-undo-list)) ; remove nil entry
19320 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19321 (setq org-self-insert-command-undo-counter
19322 (1+ org-self-insert-command-undo-counter))))))))
19324 (defun org-check-before-invisible-edit (kind)
19325 "Check is editing if kind KIND would be dangerous with invisible text around.
19326 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19327 ;; First, try to get out of here as quickly as possible, to reduce overhead
19328 (if (and org-catch-invisible-edits
19329 (or (not (boundp 'visible-mode)) (not visible-mode))
19330 (or (get-char-property (point) 'invisible)
19331 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19332 ;; OK, we need to take a closer look
19333 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19334 (invisible-before-point (if (bobp) nil (get-char-property
19335 (1- (point)) 'invisible)))
19336 (border-and-ok-direction
19337 (or
19338 ;; Check if we are acting predictably before invisible text
19339 (and invisible-at-point (not invisible-before-point)
19340 (memq kind '(insert delete-backward)))
19341 ;; Check if we are acting predictably after invisible text
19342 ;; This works not well, and I have turned it off. It seems
19343 ;; better to always show and stop after invisible text.
19344 ;; (and (not invisible-at-point) invisible-before-point
19345 ;; (memq kind '(insert delete)))
19346 )))
19347 (when (or (memq invisible-at-point '(outline org-hide-block t))
19348 (memq invisible-before-point '(outline org-hide-block t)))
19349 (if (eq org-catch-invisible-edits 'error)
19350 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19351 (if (and org-custom-properties-overlays
19352 (y-or-n-p "Display invisible properties in this buffer? "))
19353 (org-toggle-custom-properties-visibility)
19354 ;; Make the area visible
19355 (save-excursion
19356 (if invisible-before-point
19357 (goto-char (previous-single-char-property-change
19358 (point) 'invisible)))
19359 (org-cycle))
19360 (cond
19361 ((eq org-catch-invisible-edits 'show)
19362 ;; That's it, we do the edit after showing
19363 (message
19364 "Unfolding invisible region around point before editing")
19365 (sit-for 1))
19366 ((and (eq org-catch-invisible-edits 'smart)
19367 border-and-ok-direction)
19368 (message "Unfolding invisible region around point before editing"))
19369 (t
19370 ;; Don't do the edit, make the user repeat it in full visibility
19371 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19373 (defun org-fix-tags-on-the-fly ()
19374 (when (and (equal (char-after (point-at-bol)) ?*)
19375 (org-at-heading-p))
19376 (org-align-tags-here org-tags-column)))
19378 (defun org-delete-backward-char (N)
19379 "Like `delete-backward-char', insert whitespace at field end in tables.
19380 When deleting backwards, in tables this function will insert whitespace in
19382 still be marked for re-alignment if the field did fill the entire column,
19383 because, in this case the deletion might narrow the column."
19384 (interactive "p")
19385 (save-match-data
19386 (org-check-before-invisible-edit 'delete-backward)
19387 (if (and (org-table-p)
19388 (eq N 1)
19389 (string-match "|" (buffer-substring (point-at-bol) (point)))
19390 (looking-at ".*?|"))
19391 (let ((pos (point))
19393 (c org-table-may-need-update))
19394 (backward-delete-char N)
19395 (if (not overwrite-mode)
19396 (progn
19397 (skip-chars-forward "^|")
19398 (insert " ")
19399 (goto-char (1- pos))))
19400 ;; noalign: if there were two spaces at the end, this field
19401 ;; does not determine the width of the column.
19402 (if noalign (setq org-table-may-need-update c)))
19403 (backward-delete-char N)
19404 (org-fix-tags-on-the-fly))))
19406 (defun org-delete-char (N)
19407 "Like `delete-char', but insert whitespace at field end in tables.
19408 When deleting characters, in tables this function will insert whitespace in
19410 still be marked for re-alignment if the field did fill the entire column,
19411 because, in this case the deletion might narrow the column."
19412 (interactive "p")
19413 (save-match-data
19414 (org-check-before-invisible-edit 'delete)
19415 (if (and (org-table-p)
19416 (not (bolp))
19417 (not (= (char-after) ?|))
19418 (eq N 1))
19419 (if (looking-at ".*?|")
19420 (let ((pos (point))
19422 (c org-table-may-need-update))
19423 (replace-match
19424 (concat (substring (match-string 0) 1 -1) " |") nil t)
19425 (goto-char pos)
19426 ;; noalign: if there were two spaces at the end, this field
19427 ;; does not determine the width of the column.
19428 (if noalign (setq org-table-may-need-update c)))
19429 (delete-char N))
19430 (delete-char N)
19431 (org-fix-tags-on-the-fly))))
19433 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19434 (put 'org-self-insert-command 'delete-selection t)
19435 (put 'orgtbl-self-insert-command 'delete-selection t)
19436 (put 'org-delete-char 'delete-selection 'supersede)
19437 (put 'org-delete-backward-char 'delete-selection 'supersede)
19438 (put 'org-yank 'delete-selection 'yank)
19440 ;; Make `flyspell-mode' delay after some commands
19441 (put 'org-self-insert-command 'flyspell-delayed t)
19442 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19443 (put 'org-delete-char 'flyspell-delayed t)
19444 (put 'org-delete-backward-char 'flyspell-delayed t)
19446 ;; Make pabbrev-mode expand after org-mode commands
19447 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19448 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19450 ;; How to do this: Measure non-white length of current string
19451 ;; If equal to column width, we should realign.
19453 (defun org-remap (map &rest commands)
19454 "In MAP, remap the functions given in COMMANDS.
19455 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19456 (let (new old)
19457 (while commands
19458 (setq old (pop commands) new (pop commands))
19459 (if (fboundp 'command-remapping)
19460 (org-defkey map (vector 'remap old) new)
19461 (substitute-key-definition old new map global-map)))))
19463 (defun org-transpose-words ()
19464 "Transpose words for Org.
19465 This uses the `org-mode-transpose-word-syntax-table' syntax
19466 table, which interprets characters in `org-emphasis-alist' as
19467 word constituants."
19468 (interactive)
19469 (with-syntax-table org-mode-transpose-word-syntax-table
19470 (call-interactively 'transpose-words)))
19471 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19473 (when (eq org-enable-table-editor 'optimized)
19474 ;; If the user wants maximum table support, we need to hijack
19475 ;; some standard editing functions
19476 (org-remap org-mode-map
19477 'self-insert-command 'org-self-insert-command
19478 'delete-char 'org-delete-char
19479 'delete-backward-char 'org-delete-backward-char)
19480 (org-defkey org-mode-map "|" 'org-force-self-insert))
19482 (defvar org-ctrl-c-ctrl-c-hook nil
19483 "Hook for functions attaching themselves to `C-c C-c'.
19485 This can be used to add additional functionality to the C-c C-c
19486 key which executes context-dependent commands. This hook is run
19487 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19488 run after the last test.
19490 Each function will be called with no arguments. The function
19491 must check if the context is appropriate for it to act. If yes,
19492 it should do its thing and then return a non-nil value. If the
19493 context is wrong, just do nothing and return nil.")
19495 (defvar org-ctrl-c-ctrl-c-final-hook nil
19496 "Hook for functions attaching themselves to `C-c C-c'.
19498 This can be used to add additional functionality to the C-c C-c
19499 key which executes context-dependent commands. This hook is run
19500 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19501 before the first test.
19503 Each function will be called with no arguments. The function
19504 must check if the context is appropriate for it to act. If yes,
19505 it should do its thing and then return a non-nil value. If the
19506 context is wrong, just do nothing and return nil.")
19508 (defvar org-tab-first-hook nil
19509 "Hook for functions to attach themselves to TAB.
19510 See `org-ctrl-c-ctrl-c-hook' for more information.
19511 This hook runs as the first action when TAB is pressed, even before
19512 `org-cycle' messes around with the `outline-regexp' to cater for
19513 inline tasks and plain list item folding.
19514 If any function in this hook returns t, any other actions that
19515 would have been caused by TAB (such as table field motion or visibility
19516 cycling) will not occur.")
19518 (defvar org-tab-after-check-for-table-hook nil
19519 "Hook for functions to attach themselves to TAB.
19520 See `org-ctrl-c-ctrl-c-hook' for more information.
19521 This hook runs after it has been established that the cursor is not in a
19522 table, but before checking if the cursor is in a headline or if global cycling
19523 should be done.
19524 If any function in this hook returns t, not other actions like visibility
19525 cycling will be done.")
19527 (defvar org-tab-after-check-for-cycling-hook nil
19528 "Hook for functions to attach themselves to TAB.
19529 See `org-ctrl-c-ctrl-c-hook' for more information.
19530 This hook runs after it has been established that not table field motion and
19531 not visibility should be done because of current context. This is probably
19532 the place where a package like yasnippets can hook in.")
19534 (defvar org-tab-before-tab-emulation-hook nil
19535 "Hook for functions to attach themselves to TAB.
19536 See `org-ctrl-c-ctrl-c-hook' for more information.
19537 This hook runs after every other options for TAB have been exhausted, but
19540 (defvar org-metaleft-hook nil
19541 "Hook for functions attaching themselves to `M-left'.
19542 See `org-ctrl-c-ctrl-c-hook' for more information.")
19543 (defvar org-metaright-hook nil
19544 "Hook for functions attaching themselves to `M-right'.
19545 See `org-ctrl-c-ctrl-c-hook' for more information.")
19546 (defvar org-metaup-hook nil
19547 "Hook for functions attaching themselves to `M-up'.
19548 See `org-ctrl-c-ctrl-c-hook' for more information.")
19549 (defvar org-metadown-hook nil
19550 "Hook for functions attaching themselves to `M-down'.
19551 See `org-ctrl-c-ctrl-c-hook' for more information.")
19552 (defvar org-shiftmetaleft-hook nil
19553 "Hook for functions attaching themselves to `M-S-left'.
19554 See `org-ctrl-c-ctrl-c-hook' for more information.")
19555 (defvar org-shiftmetaright-hook nil
19556 "Hook for functions attaching themselves to `M-S-right'.
19557 See `org-ctrl-c-ctrl-c-hook' for more information.")
19558 (defvar org-shiftmetaup-hook nil
19559 "Hook for functions attaching themselves to `M-S-up'.
19560 See `org-ctrl-c-ctrl-c-hook' for more information.")
19561 (defvar org-shiftmetadown-hook nil
19562 "Hook for functions attaching themselves to `M-S-down'.
19563 See `org-ctrl-c-ctrl-c-hook' for more information.")
19564 (defvar org-metareturn-hook nil
19565 "Hook for functions attaching themselves to `M-RET'.
19566 See `org-ctrl-c-ctrl-c-hook' for more information.")
19567 (defvar org-shiftup-hook nil
19568 "Hook for functions attaching themselves to `S-up'.
19569 See `org-ctrl-c-ctrl-c-hook' for more information.")
19570 (defvar org-shiftup-final-hook nil
19571 "Hook for functions attaching themselves to `S-up'.
19572 This one runs after all other options except shift-select have been excluded.
19573 See `org-ctrl-c-ctrl-c-hook' for more information.")
19574 (defvar org-shiftdown-hook nil
19575 "Hook for functions attaching themselves to `S-down'.
19576 See `org-ctrl-c-ctrl-c-hook' for more information.")
19577 (defvar org-shiftdown-final-hook nil
19578 "Hook for functions attaching themselves to `S-down'.
19579 This one runs after all other options except shift-select have been excluded.
19580 See `org-ctrl-c-ctrl-c-hook' for more information.")
19581 (defvar org-shiftleft-hook nil
19582 "Hook for functions attaching themselves to `S-left'.
19583 See `org-ctrl-c-ctrl-c-hook' for more information.")
19584 (defvar org-shiftleft-final-hook nil
19585 "Hook for functions attaching themselves to `S-left'.
19586 This one runs after all other options except shift-select have been excluded.
19587 See `org-ctrl-c-ctrl-c-hook' for more information.")
19588 (defvar org-shiftright-hook nil
19589 "Hook for functions attaching themselves to `S-right'.
19590 See `org-ctrl-c-ctrl-c-hook' for more information.")
19591 (defvar org-shiftright-final-hook nil
19592 "Hook for functions attaching themselves to `S-right'.
19593 This one runs after all other options except shift-select have been excluded.
19594 See `org-ctrl-c-ctrl-c-hook' for more information.")
19596 (defun org-modifier-cursor-error ()
19597 "Throw an error, a modified cursor command was applied in wrong context."
19598 (user-error "This command is active in special context like tables, headlines or items"))
19600 (defun org-shiftselect-error ()
19601 "Throw an error because Shift-Cursor command was applied in wrong context."
19602 (if (and (boundp 'shift-select-mode) shift-select-mode)
19603 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19604 (user-error "This command works only in special context like headlines or timestamps")))
19606 (defun org-call-for-shift-select (cmd)
19607 (let ((this-command-keys-shift-translated t))
19608 (call-interactively cmd)))
19610 (defun org-shifttab (&optional arg)
19611 "Global visibility cycling or move to previous table field.
19612 Call `org-table-previous-field' within a table.
19613 When ARG is nil, cycle globally through visibility states.
19614 When ARG is a numeric prefix, show contents of this level."
19615 (interactive "P")
19616 (cond
19617 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19618 ((integerp arg)
19619 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19620 (message "Content view to level: %d" arg)
19621 (org-content (prefix-numeric-value arg2))
19622 (org-cycle-show-empty-lines t)
19623 (setq org-cycle-global-status 'overview)))
19624 (t (call-interactively 'org-global-cycle))))
19626 (defun org-shiftmetaleft ()
19627 "Promote subtree or delete table column.
19628 Calls `org-promote-subtree', `org-outdent-item-tree', or
19629 `org-table-delete-column', depending on context. See the
19630 individual commands for more information."
19631 (interactive)
19632 (cond
19633 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19634 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19635 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19636 ((if (not (org-region-active-p)) (org-at-item-p)
19637 (save-excursion (goto-char (region-beginning))
19638 (org-at-item-p)))
19639 (call-interactively 'org-outdent-item-tree))
19640 (t (org-modifier-cursor-error))))
19642 (defun org-shiftmetaright ()
19643 "Demote subtree or insert table column.
19644 Calls `org-demote-subtree', `org-indent-item-tree', or
19645 `org-table-insert-column', depending on context. See the
19646 individual commands for more information."
19647 (interactive)
19648 (cond
19649 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19650 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19651 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19652 ((if (not (org-region-active-p)) (org-at-item-p)
19653 (save-excursion (goto-char (region-beginning))
19654 (org-at-item-p)))
19655 (call-interactively 'org-indent-item-tree))
19656 (t (org-modifier-cursor-error))))
19658 (defun org-shiftmetaup (&optional arg)
19659 "Move subtree up or kill table row.
19660 Calls `org-move-subtree-up' or `org-table-kill-row' or
19661 `org-move-item-up' or `org-timestamp-up', depending on context.
19662 See the individual commands for more information."
19663 (interactive "P")
19664 (cond
19665 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19666 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19667 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19668 ((org-at-item-p) (call-interactively 'org-move-item-up))
19669 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19670 (call-interactively 'org-timestamp-up)))
19671 (t (call-interactively 'org-drag-line-backward))))
19673 (defun org-shiftmetadown (&optional arg)
19674 "Move subtree down or insert table row.
19675 Calls `org-move-subtree-down' or `org-table-insert-row' or
19676 `org-move-item-down' or `org-timestamp-up', depending on context.
19677 See the individual commands for more information."
19678 (interactive "P")
19679 (cond
19680 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19681 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19682 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19683 ((org-at-item-p) (call-interactively 'org-move-item-down))
19684 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19685 (call-interactively 'org-timestamp-down)))
19686 (t (call-interactively 'org-drag-line-forward))))
19688 (defsubst org-hidden-tree-error ()
19689 (user-error
19690 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19692 (defun org-metaleft (&optional arg)
19693 "Promote heading or move table column to left.
19694 Calls `org-do-promote' or `org-table-move-column', depending on context.
19695 With no specific context, calls the Emacs default `backward-word'.
19696 See the individual commands for more information."
19697 (interactive "P")
19698 (cond
19699 ((run-hook-with-args-until-success 'org-metaleft-hook))
19700 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19701 ((org-with-limited-levels
19702 (or (org-at-heading-p)
19703 (and (org-region-active-p)
19704 (save-excursion
19705 (goto-char (region-beginning))
19706 (org-at-heading-p)))))
19707 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19708 (call-interactively 'org-do-promote))
19709 ;; At an inline task.
19710 ((org-at-heading-p)
19711 (call-interactively 'org-inlinetask-promote))
19712 ((or (org-at-item-p)
19713 (and (org-region-active-p)
19714 (save-excursion
19715 (goto-char (region-beginning))
19716 (org-at-item-p))))
19717 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19718 (call-interactively 'org-outdent-item))
19719 (t (call-interactively 'backward-word))))
19721 (defun org-metaright (&optional arg)
19722 "Demote a subtree, a list item or move table column to right.
19723 In front of a drawer or a block keyword, indent it correctly.
19724 With no specific context, calls the Emacs default `forward-word'.
19725 See the individual commands for more information."
19726 (interactive "P")
19727 (cond
19728 ((run-hook-with-args-until-success 'org-metaright-hook))
19729 ((org-at-table-p) (call-interactively 'org-table-move-column))
19730 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19731 ((org-at-block-p) (call-interactively 'org-indent-block))
19732 ((org-with-limited-levels
19733 (or (org-at-heading-p)
19734 (and (org-region-active-p)
19735 (save-excursion
19736 (goto-char (region-beginning))
19737 (org-at-heading-p)))))
19738 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19739 (call-interactively 'org-do-demote))
19740 ;; At an inline task.
19741 ((org-at-heading-p)
19742 (call-interactively 'org-inlinetask-demote))
19743 ((or (org-at-item-p)
19744 (and (org-region-active-p)
19745 (save-excursion
19746 (goto-char (region-beginning))
19747 (org-at-item-p))))
19748 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19749 (call-interactively 'org-indent-item))
19750 (t (call-interactively 'forward-word))))
19752 (defun org-check-for-hidden (what)
19753 "Check if there are hidden headlines/items in the current visual line.
19754 WHAT can be either `headlines' or `items'. If the current line is
19755 an outline or item heading and it has a folded subtree below it,
19756 this function returns t, nil otherwise."
19757 (let ((re (cond
19758 ((eq what 'headlines) org-outline-regexp-bol)
19759 ((eq what 'items) (org-item-beginning-re))
19760 (t (error "This should not happen"))))
19761 beg end)
19762 (save-excursion
19763 (catch 'exit
19764 (unless (org-region-active-p)
19765 (setq beg (point-at-bol))
19766 (beginning-of-line 2)
19767 (while (and (not (eobp)) ;; this is like `next-line'
19768 (get-char-property (1- (point)) 'invisible))
19769 (beginning-of-line 2))
19770 (setq end (point))
19771 (goto-char beg)
19772 (goto-char (point-at-eol))
19773 (setq end (max end (point)))
19774 (while (re-search-forward re end t)
19775 (if (get-char-property (match-beginning 0) 'invisible)
19776 (throw 'exit t))))
19777 nil))))
19779 (defun org-metaup (&optional arg)
19780 "Move subtree up or move table row up.
19781 Calls `org-move-subtree-up' or `org-table-move-row' or
19782 `org-move-item-up', depending on context. See the individual commands
19783 for more information."
19784 (interactive "P")
19785 (cond
19786 ((run-hook-with-args-until-success 'org-metaup-hook))
19787 ((org-region-active-p)
19788 (let* ((a (min (region-beginning) (region-end)))
19789 (b (1- (max (region-beginning) (region-end))))
19790 (c (save-excursion (goto-char a)
19791 (move-beginning-of-line 0)))
19792 (d (save-excursion (goto-char a)
19793 (move-end-of-line 0) (point))))
19794 (transpose-regions a b c d)
19795 (goto-char c)))
19796 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19797 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19798 ((org-at-item-p) (call-interactively 'org-move-item-up))
19799 (t (org-drag-element-backward))))
19801 (defun org-metadown (&optional arg)
19802 "Move subtree down or move table row down.
19803 Calls `org-move-subtree-down' or `org-table-move-row' or
19804 `org-move-item-down', depending on context. See the individual
19805 commands for more information."
19806 (interactive "P")
19807 (cond
19808 ((run-hook-with-args-until-success 'org-metadown-hook))
19809 ((org-region-active-p)
19810 (let* ((a (min (region-beginning) (region-end)))
19811 (b (max (region-beginning) (region-end)))
19812 (c (save-excursion (goto-char b)
19813 (move-beginning-of-line 1)))
19814 (d (save-excursion (goto-char b)
19815 (move-end-of-line 1) (1+ (point)))))
19816 (transpose-regions a b c d)
19817 (goto-char d)))
19818 ((org-at-table-p) (call-interactively 'org-table-move-row))
19819 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19820 ((org-at-item-p) (call-interactively 'org-move-item-down))
19821 (t (org-drag-element-forward))))
19823 (defun org-shiftup (&optional arg)
19824 "Increase item in timestamp or increase priority of current headline.
19825 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19826 depending on context. See the individual commands for more information."
19827 (interactive "P")
19828 (cond
19829 ((run-hook-with-args-until-success 'org-shiftup-hook))
19830 ((and org-support-shift-select (org-region-active-p))
19831 (org-call-for-shift-select 'previous-line))
19832 ((org-at-timestamp-p t)
19833 (call-interactively (if org-edit-timestamp-down-means-later
19834 'org-timestamp-down 'org-timestamp-up)))
19835 ((and (not (eq org-support-shift-select 'always))
19836 org-enable-priority-commands
19837 (org-at-heading-p))
19838 (call-interactively 'org-priority-up))
19839 ((and (not org-support-shift-select) (org-at-item-p))
19840 (call-interactively 'org-previous-item))
19841 ((org-clocktable-try-shift 'up arg))
19842 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19843 (org-support-shift-select
19844 (org-call-for-shift-select 'previous-line))
19845 (t (org-shiftselect-error))))
19847 (defun org-shiftdown (&optional arg)
19848 "Decrease item in timestamp or decrease priority of current headline.
19849 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19850 depending on context. See the individual commands for more information."
19851 (interactive "P")
19852 (cond
19853 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19854 ((and org-support-shift-select (org-region-active-p))
19855 (org-call-for-shift-select 'next-line))
19856 ((org-at-timestamp-p t)
19857 (call-interactively (if org-edit-timestamp-down-means-later
19858 'org-timestamp-up 'org-timestamp-down)))
19859 ((and (not (eq org-support-shift-select 'always))
19860 org-enable-priority-commands
19861 (org-at-heading-p))
19862 (call-interactively 'org-priority-down))
19863 ((and (not org-support-shift-select) (org-at-item-p))
19864 (call-interactively 'org-next-item))
19865 ((org-clocktable-try-shift 'down arg))
19866 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19867 (org-support-shift-select
19868 (org-call-for-shift-select 'next-line))
19869 (t (org-shiftselect-error))))
19871 (defun org-shiftright (&optional arg)
19872 "Cycle the thing at point or in the current line, depending on context.
19873 Depending on context, this does one of the following:
19875 - switch a timestamp at point one day into the future
19876 - on a headline, switch to the next TODO keyword.
19877 - on an item, switch entire list to the next bullet type
19878 - on a property line, switch to the next allowed value
19879 - on a clocktable definition line, move time block into the future"
19880 (interactive "P")
19881 (cond
19882 ((run-hook-with-args-until-success 'org-shiftright-hook))
19883 ((and org-support-shift-select (org-region-active-p))
19884 (org-call-for-shift-select 'forward-char))
19885 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19886 ((and (not (eq org-support-shift-select 'always))
19887 (org-at-heading-p))
19888 (let ((org-inhibit-logging
19889 (not org-treat-S-cursor-todo-selection-as-state-change))
19890 (org-inhibit-blocking
19891 (not org-treat-S-cursor-todo-selection-as-state-change)))
19892 (org-call-with-arg 'org-todo 'right)))
19893 ((or (and org-support-shift-select
19894 (not (eq org-support-shift-select 'always))
19895 (org-at-item-bullet-p))
19896 (and (not org-support-shift-select) (org-at-item-p)))
19897 (org-call-with-arg 'org-cycle-list-bullet nil))
19898 ((and (not (eq org-support-shift-select 'always))
19899 (org-at-property-p))
19900 (call-interactively 'org-property-next-allowed-value))
19901 ((org-clocktable-try-shift 'right arg))
19902 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19903 (org-support-shift-select
19904 (org-call-for-shift-select 'forward-char))
19905 (t (org-shiftselect-error))))
19907 (defun org-shiftleft (&optional arg)
19908 "Cycle the thing at point or in the current line, depending on context.
19909 Depending on context, this does one of the following:
19911 - switch a timestamp at point one day into the past
19912 - on a headline, switch to the previous TODO keyword.
19913 - on an item, switch entire list to the previous bullet type
19914 - on a property line, switch to the previous allowed value
19915 - on a clocktable definition line, move time block into the past"
19916 (interactive "P")
19917 (cond
19918 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19919 ((and org-support-shift-select (org-region-active-p))
19920 (org-call-for-shift-select 'backward-char))
19921 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19922 ((and (not (eq org-support-shift-select 'always))
19923 (org-at-heading-p))
19924 (let ((org-inhibit-logging
19925 (not org-treat-S-cursor-todo-selection-as-state-change))
19926 (org-inhibit-blocking
19927 (not org-treat-S-cursor-todo-selection-as-state-change)))
19928 (org-call-with-arg 'org-todo 'left)))
19929 ((or (and org-support-shift-select
19930 (not (eq org-support-shift-select 'always))
19931 (org-at-item-bullet-p))
19932 (and (not org-support-shift-select) (org-at-item-p)))
19933 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19934 ((and (not (eq org-support-shift-select 'always))
19935 (org-at-property-p))
19936 (call-interactively 'org-property-previous-allowed-value))
19937 ((org-clocktable-try-shift 'left arg))
19938 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19939 (org-support-shift-select
19940 (org-call-for-shift-select 'backward-char))
19941 (t (org-shiftselect-error))))
19943 (defun org-shiftcontrolright ()
19944 "Switch to next TODO set."
19945 (interactive)
19946 (cond
19947 ((and org-support-shift-select (org-region-active-p))
19948 (org-call-for-shift-select 'forward-word))
19949 ((and (not (eq org-support-shift-select 'always))
19950 (org-at-heading-p))
19951 (org-call-with-arg 'org-todo 'nextset))
19952 (org-support-shift-select
19953 (org-call-for-shift-select 'forward-word))
19954 (t (org-shiftselect-error))))
19956 (defun org-shiftcontrolleft ()
19957 "Switch to previous TODO set."
19958 (interactive)
19959 (cond
19960 ((and org-support-shift-select (org-region-active-p))
19961 (org-call-for-shift-select 'backward-word))
19962 ((and (not (eq org-support-shift-select 'always))
19963 (org-at-heading-p))
19964 (org-call-with-arg 'org-todo 'previousset))
19965 (org-support-shift-select
19966 (org-call-for-shift-select 'backward-word))
19967 (t (org-shiftselect-error))))
19969 (defun org-shiftcontrolup (&optional n)
19970 "Change timestamps synchronously up in CLOCK log lines.
19971 Optional argument N tells to change by that many units."
19972 (interactive "P")
19973 (cond ((and (not org-support-shift-select)
19974 (org-at-clock-log-p)
19975 (org-at-timestamp-p t))
19976 (org-clock-timestamps-up n))
19977 (t (org-shiftselect-error))))
19979 (defun org-shiftcontroldown (&optional n)
19980 "Change timestamps synchronously down in CLOCK log lines.
19981 Optional argument N tells to change by that many units."
19982 (interactive "P")
19983 (cond ((and (not org-support-shift-select)
19984 (org-at-clock-log-p)
19985 (org-at-timestamp-p t))
19986 (org-clock-timestamps-down n))
19987 (t (org-shiftselect-error))))
19989 (defun org-ctrl-c-ret ()
19990 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19991 (interactive)
19992 (cond
19993 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19994 (t (call-interactively 'org-insert-heading))))
19996 (defun org-find-visible ()
19997 (let ((s (point)))
19998 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19999 (get-char-property s 'invisible)))
20000 s))
20001 (defun org-find-invisible ()
20002 (let ((s (point)))
20003 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20004 (not (get-char-property s 'invisible))))
20005 s))
20007 (defun org-copy-visible (beg end)
20008 "Copy the visible parts of the region."
20009 (interactive "r")
20010 (let (snippets s)
20011 (save-excursion
20012 (save-restriction
20013 (narrow-to-region beg end)
20014 (setq s (goto-char (point-min)))
20015 (while (not (= (point) (point-max)))
20016 (goto-char (org-find-invisible))
20017 (push (buffer-substring s (point)) snippets)
20018 (setq s (goto-char (org-find-visible))))))
20019 (kill-new (apply 'concat (nreverse snippets)))))
20021 (defun org-copy-special ()
20022 "Copy region in table or copy current subtree.
20023 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20024 See the individual commands for more information."
20025 (interactive)
20026 (call-interactively
20027 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20029 (defun org-cut-special ()
20030 "Cut region in table or cut current subtree.
20031 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20032 See the individual commands for more information."
20033 (interactive)
20034 (call-interactively
20035 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20037 (defun org-paste-special (arg)
20038 "Paste rectangular region into table, or past subtree relative to level.
20039 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20040 See the individual commands for more information."
20041 (interactive "P")
20042 (if (org-at-table-p)
20043 (org-table-paste-rectangle)
20044 (org-paste-subtree arg)))
20046 (defsubst org-in-fixed-width-region-p ()
20047 "Is point in a fixed-width region?"
20048 (save-match-data
20049 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20051 (defun org-edit-special (&optional arg)
20052 "Call a special editor for the element at point.
20053 When at a table, call the formula editor with `org-table-edit-formulas'.
20054 When in a source code block, call `org-edit-src-code'.
20055 When in a fixed-width region, call `org-edit-fixed-width-region'.
20056 When at an #+INCLUDE keyword, visit the included file.
20057 On a link, call `ffap' to visit the link at point.
20058 Otherwise, return a user error."
20059 (interactive "P")
20060 (let ((element (org-element-at-point)))
20061 (assert (not buffer-read-only) nil
20062 "Buffer is read-only: %s" (buffer-name))
20063 (case (org-element-type element)
20064 (src-block
20065 (if (not arg) (org-edit-src-code)
20066 (let* ((info (org-babel-get-src-block-info))
20067 (lang (nth 0 info))
20068 (params (nth 2 info))
20069 (session (cdr (assq :session params))))
20070 (if (not session) (org-edit-src-code)
20071 ;; At a src-block with a session and function called with
20072 ;; an ARG: switch to the buffer related to the inferior
20073 ;; process.
20074 (switch-to-buffer
20075 (funcall (intern (concat "org-babel-prep-session:" lang))
20076 session params))))))
20077 (keyword
20078 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20079 (find-file
20080 (org-remove-double-quotes
20081 (car (org-split-string (org-element-property :value element)))))
20082 (user-error "No special environment to edit here")))
20083 (table
20084 (if (eq (org-element-property :type element) 'table.el)
20085 (org-edit-src-code)
20086 (call-interactively 'org-table-edit-formulas)))
20087 ;; Only Org tables contain `table-row' type elements.
20088 (table-row (call-interactively 'org-table-edit-formulas))
20089 ((example-block export-block) (org-edit-src-code))
20090 (fixed-width (org-edit-fixed-width-region))
20091 (otherwise
20092 ;; No notable element at point. Though, we may be at a link,
20093 ;; which is an object. Thus, scan deeper.
20094 (if (eq (org-element-type (org-element-context element)) 'link)
20095 (call-interactively 'ffap)
20096 (user-error "No special environment to edit here"))))))
20098 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20099 (defun org-ctrl-c-ctrl-c (&optional arg)
20100 "Set tags in headline, or update according to changed information at point.
20102 This command does many different things, depending on context:
20104 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20105 this is what we do.
20107 - If the cursor is on a statistics cookie, update it.
20109 - If the cursor is in a headline, prompt for tags and insert them
20110 into the current line, aligned to `org-tags-column'. When called
20111 with prefix arg, realign all tags in the current buffer.
20113 - If the cursor is in one of the special #+KEYWORD lines, this
20114 triggers scanning the buffer for these lines and updating the
20115 information.
20117 - If the cursor is inside a table, realign the table. This command
20118 works even if the automatic table editor has been turned off.
20120 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20121 the entire table.
20123 - If the cursor is at a footnote reference or definition, jump to
20124 the corresponding definition or references, respectively.
20126 - If the cursor is a the beginning of a dynamic block, update it.
20128 - If the current buffer is a capture buffer, close note and file it.
20130 - If the cursor is on a <<<target>>>, update radio targets and
20131 corresponding links in this buffer.
20133 - If the cursor is on a numbered item in a plain list, renumber the
20134 ordered list.
20136 - If the cursor is on a checkbox, toggle it.
20138 - If the cursor is on a code block, evaluate it. The variable
20139 `org-confirm-babel-evaluate' can be used to control prompting
20140 before code block evaluation, by default every code block
20141 evaluation requires confirmation. Code block evaluation can be
20142 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20143 (interactive "P")
20144 (cond
20145 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20146 org-occur-highlights
20147 org-latex-fragment-image-overlays)
20148 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20149 (org-remove-occur-highlights)
20150 (org-remove-latex-fragment-image-overlays)
20151 (message "Temporary highlights/overlays removed from current buffer"))
20152 ((and (local-variable-p 'org-finish-function (current-buffer))
20153 (fboundp org-finish-function))
20154 (funcall org-finish-function))
20155 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20156 (t
20157 (let* ((context (org-element-context)) (type (org-element-type context)))
20158 ;; Test if point is within a blank line.
20160 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20161 (user-error "C-c C-c can do nothing useful at this location"))
20162 ;; For convenience: at the first line of a paragraph on the
20163 ;; same line as an item, apply function on that item instead.
20164 (when (eq type 'paragraph)
20165 (let ((parent (org-element-property :parent context)))
20166 (when (and (eq (org-element-type parent) 'item)
20167 (= (point-at-bol) (org-element-property :begin parent)))
20168 (setq context parent type 'item))))
20169 ;; Act according to type of element or object at point.
20170 (case type
20171 (clock (org-clock-update-time-maybe))
20172 (dynamic-block
20173 (save-excursion
20174 (goto-char (org-element-property :post-affiliated context))
20175 (org-update-dblock)))
20176 (footnote-definition
20177 (goto-char (org-element-property :post-affiliated context))
20178 (call-interactively 'org-footnote-action))
20179 (footnote-reference (call-interactively 'org-footnote-action))
20180 ((headline inlinetask)
20181 (save-excursion (goto-char (org-element-property :begin context))
20182 (call-interactively 'org-set-tags)))
20183 (item
20184 ;; At an item: a double C-u set checkbox to "[-]"
20185 ;; unconditionally, whereas a single one will toggle its
20186 ;; presence. Without an universal argument, if the item
20187 ;; has a checkbox, toggle it. Otherwise repair the list.
20188 (let* ((box (org-element-property :checkbox context))
20189 (struct (org-element-property :structure context))
20190 (old-struct (copy-tree struct))
20191 (parents (org-list-parents-alist struct))
20192 (prevs (org-list-prevs-alist struct))
20193 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20194 (org-list-set-checkbox
20195 (org-element-property :begin context) struct
20196 (cond ((equal arg '(16)) "[-]")
20197 ((and (not box) (equal arg '(4))) "[ ]")
20198 ((or (not box) (equal arg '(4))) nil)
20199 ((eq box 'on) "[ ]")
20200 (t "[X]")))
20201 ;; Mimic `org-list-write-struct' but with grabbing
20202 ;; a return value from `org-list-struct-fix-box'.
20203 (org-list-struct-fix-ind struct parents 2)
20204 (org-list-struct-fix-item-end struct)
20205 (org-list-struct-fix-bul struct prevs)
20206 (org-list-struct-fix-ind struct parents)
20207 (let ((block-item
20208 (org-list-struct-fix-box struct parents prevs orderedp)))
20209 (if (and box (equal struct old-struct))
20210 (if (equal arg '(16))
20211 (message "Checkboxes already reset")
20212 (user-error "Cannot toggle this checkbox: %s"
20213 (if (eq box 'on)
20214 "all subitems checked"
20215 "unchecked subitems")))
20216 (org-list-struct-apply-struct struct old-struct)
20217 (org-update-checkbox-count-maybe))
20218 (when block-item
20219 (message "Checkboxes were removed due to empty box at line %d"
20220 (org-current-line block-item))))))
20221 (keyword
20222 (let ((org-inhibit-startup-visibility-stuff t)
20223 (org-startup-align-all-tables nil))
20224 (when (boundp 'org-table-coordinate-overlays)
20225 (mapc 'delete-overlay org-table-coordinate-overlays)
20226 (setq org-table-coordinate-overlays nil))
20227 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20228 (message "Local setup has been refreshed"))
20229 (plain-list
20230 ;; At a plain list, with a double C-u argument, set
20231 ;; checkboxes of each item to "[-]", whereas a single one
20232 ;; will toggle their presence according to the state of the
20233 ;; first item in the list. Without an argument, repair the
20234 ;; list.
20235 (let* ((begin (org-element-property :contents-begin context))
20236 (beginm (move-marker (make-marker) begin))
20237 (struct (org-element-property :structure context))
20238 (old-struct (copy-tree struct))
20239 (first-box (save-excursion
20240 (goto-char begin)
20241 (looking-at org-list-full-item-re)
20242 (match-string-no-properties 3)))
20243 (new-box (cond ((equal arg '(16)) "[-]")
20244 ((equal arg '(4)) (unless first-box "[ ]"))
20245 ((equal first-box "[X]") "[ ]")
20246 (t "[X]"))))
20247 (cond
20248 (arg
20249 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20250 (org-list-get-all-items
20251 begin struct (org-list-prevs-alist struct))))
20252 ((and first-box (eq (point) begin))
20253 ;; For convenience, when point is at bol on the first
20254 ;; item of the list and no argument is provided, simply
20255 ;; toggle checkbox of that item, if any.
20256 (org-list-set-checkbox begin struct new-box)))
20257 (org-list-write-struct
20258 struct (org-list-parents-alist struct) old-struct)
20259 (org-update-checkbox-count-maybe)
20260 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20261 ((property-drawer node-property)
20262 (call-interactively 'org-property-action))
20263 ((radio-target target)
20264 (call-interactively 'org-update-radio-target-regexp))
20265 (statistics-cookie
20266 (call-interactively 'org-update-statistics-cookies))
20267 ((table table-cell table-row)
20268 ;; At a table, recalculate every field and align it. Also
20269 ;; send the table if necessary. If the table has
20270 ;; a `table.el' type, just give up. At a table row or
20271 ;; cell, maybe recalculate line but always align table.
20272 (if (eq (org-element-property :type context) 'table.el)
20273 (message "Use C-c ' to edit table.el tables")
20274 (let ((org-enable-table-editor t))
20275 (if (or (eq type 'table)
20276 ;; Check if point is at a TBLFM line.
20277 (and (eq type 'table-row)
20278 (= (point) (org-element-property :end context))))
20279 (save-excursion
20280 (if (org-at-TBLFM-p)
20281 (progn (require 'org-table)
20282 (org-table-calc-current-TBLFM))
20283 (goto-char (org-element-property :contents-begin context))
20284 (org-call-with-arg 'org-table-recalculate (or arg t))
20285 (orgtbl-send-table 'maybe)))
20286 (org-table-maybe-eval-formula)
20287 (cond (arg (call-interactively 'org-table-recalculate))
20288 ((org-table-maybe-recalculate-line))
20289 (t (org-table-align)))))))
20290 (timestamp (org-timestamp-change 0 'day))
20291 (otherwise
20292 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20293 (user-error
20294 "C-c C-c can do nothing useful at this location")))))))))
20296 (defun org-mode-restart ()
20297 "Restart Org-mode, to scan again for special lines.
20298 Also updates the keyword regular expressions."
20299 (interactive)
20300 (org-mode)
20301 (message "Org-mode restarted"))
20303 (defun org-kill-note-or-show-branches ()
20304 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20305 (interactive)
20306 (if (not org-finish-function)
20307 (progn
20308 (hide-subtree)
20309 (call-interactively 'show-branches))
20310 (let ((org-note-abort t))
20311 (funcall org-finish-function))))
20313 (defun org-open-line (n)
20314 "Insert a new row in tables, call `open-line' elsewhere."
20315 (interactive "*p")
20316 (if (org-at-table-p)
20317 (org-table-insert-row)
20318 (open-line n)))
20320 (defun org-return (&optional indent)
20321 "Goto next table row or insert a newline.
20322 Calls `org-table-next-row' or `newline', depending on context.
20323 See the individual commands for more information."
20324 (interactive)
20325 (let (org-ts-what)
20326 (cond
20327 ((or (bobp) (org-in-src-block-p))
20328 (if indent (newline-and-indent) (newline)))
20329 ((org-at-table-p)
20330 (org-table-justify-field-maybe)
20331 (call-interactively 'org-table-next-row))
20332 ;; when `newline-and-indent' is called within a list, make sure
20333 ;; text moved stays inside the item.
20334 ((and (org-in-item-p) indent)
20335 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20336 (progn
20337 (save-match-data (newline))
20338 (org-indent-line-to (length (match-string 0))))
20339 (let ((ind (org-get-indentation)))
20340 (newline)
20341 (if (org-looking-back org-list-end-re)
20342 (org-indent-line)
20343 (org-indent-line-to ind)))))
20344 ((and org-return-follows-link
20345 (org-at-timestamp-p t)
20346 (not (eq org-ts-what 'after)))
20347 (org-follow-timestamp-link))
20348 ((and org-return-follows-link
20349 (let ((tprop (get-text-property (point) 'face)))
20350 (or (eq tprop 'org-link)
20351 (and (listp tprop) (memq 'org-link tprop)))))
20352 (call-interactively 'org-open-at-point))
20353 ((and (org-at-heading-p)
20354 (looking-at
20356 (org-show-entry)
20357 (end-of-line 1)
20358 (newline))
20359 (t (if indent (newline-and-indent) (newline))))))
20361 (defun org-return-indent ()
20362 "Goto next table row or insert a newline and indent.
20363 Calls `org-table-next-row' or `newline-and-indent', depending on
20364 context. See the individual commands for more information."
20365 (interactive)
20366 (org-return t))
20368 (defun org-ctrl-c-star ()
20369 "Compute table, or change heading status of lines.
20370 Calls `org-table-recalculate' or `org-toggle-heading',
20371 depending on context."
20372 (interactive)
20373 (cond
20374 ((org-at-table-p)
20375 (call-interactively 'org-table-recalculate))
20376 (t
20377 ;; Convert all lines in region to list items
20378 (call-interactively 'org-toggle-heading))))
20380 (defun org-ctrl-c-minus ()
20381 "Insert separator line in table or modify bullet status of line.
20382 Also turns a plain line or a region of lines into list items.
20383 Calls `org-table-insert-hline', `org-toggle-item', or
20384 `org-cycle-list-bullet', depending on context."
20385 (interactive)
20386 (cond
20387 ((org-at-table-p)
20388 (call-interactively 'org-table-insert-hline))
20389 ((org-region-active-p)
20390 (call-interactively 'org-toggle-item))
20391 ((org-in-item-p)
20392 (call-interactively 'org-cycle-list-bullet))
20393 (t
20394 (call-interactively 'org-toggle-item))))
20396 (defun org-toggle-item (arg)
20397 "Convert headings or normal lines to items, items to normal lines.
20398 If there is no active region, only the current line is considered.
20400 If the first non blank line in the region is a headline, convert
20401 all headlines to items, shifting text accordingly.
20403 If it is an item, convert all items to normal lines.
20405 If it is normal text, change region into a list of items.
20406 With a prefix argument ARG, change the region in a single item."
20407 (interactive "P")
20408 (let ((shift-text
20409 (function
20410 ;; Shift text in current section to IND, from point to END.
20411 ;; The function leaves point to END line.
20412 (lambda (ind end)
20413 (let ((min-i 1000) (end (copy-marker end)))
20414 ;; First determine the minimum indentation (MIN-I) of
20415 ;; the text.
20416 (save-excursion
20417 (catch 'exit
20418 (while (< (point) end)
20419 (let ((i (org-get-indentation)))
20420 (cond
20421 ;; Skip blank lines and inline tasks.
20423 ((looking-at org-outline-regexp-bol))
20424 ;; We can't find less than 0 indentation.
20425 ((zerop i) (throw 'exit (setq min-i 0)))
20426 ((< i min-i) (setq min-i i))))
20427 (forward-line))))
20428 ;; Then indent each line so that a line indented to
20429 ;; MIN-I becomes indented to IND. Ignore blank lines
20430 ;; and inline tasks in the process.
20431 (let ((delta (- ind min-i)))
20432 (while (< (point) end)
20434 (looking-at org-outline-regexp-bol))
20435 (org-indent-line-to (+ (org-get-indentation) delta)))
20436 (forward-line)))))))
20437 (skip-blanks
20438 (function
20439 ;; Return beginning of first non-blank line, starting from
20440 ;; line at POS.
20441 (lambda (pos)
20442 (save-excursion
20443 (goto-char pos)
20445 (point-at-bol)))))
20446 beg end)
20447 ;; Determine boundaries of changes.
20448 (if (org-region-active-p)
20449 (setq beg (funcall skip-blanks (region-beginning))
20450 end (copy-marker (region-end)))
20451 (setq beg (funcall skip-blanks (point-at-bol))
20452 end (copy-marker (point-at-eol))))
20453 ;; Depending on the starting line, choose an action on the text
20454 ;; between BEG and END.
20455 (org-with-limited-levels
20456 (save-excursion
20457 (goto-char beg)
20458 (cond
20459 ;; Case 1. Start at an item: de-itemize. Note that it only
20460 ;; happens when a region is active: `org-ctrl-c-minus'
20461 ;; would call `org-cycle-list-bullet' otherwise.
20462 ((org-at-item-p)
20463 (while (< (point) end)
20464 (when (org-at-item-p)
20466 (delete-region (point) (match-end 0)))
20467 (forward-line)))
20468 ;; Case 2. Start at an heading: convert to items.
20469 ((org-at-heading-p)
20470 (let* ((bul (org-list-bullet-string "-"))
20471 (bul-len (length bul))
20472 ;; Indentation of the first heading. It should be
20473 ;; relative to the indentation of its parent, if any.
20474 (start-ind (save-excursion
20475 (cond
20476 ((not org-adapt-indentation) 0)
20477 ((not (outline-previous-heading)) 0)
20478 (t (length (match-string 0))))))
20479 ;; Level of first heading. Further headings will be
20480 ;; compared to it to determine hierarchy in the list.
20481 (ref-level (org-reduced-level (org-outline-level))))
20482 (while (< (point) end)
20483 (let* ((level (org-reduced-level (org-outline-level)))
20484 (delta (max 0 (- level ref-level))))
20485 ;; If current headline is less indented than the first
20486 ;; one, set it as reference, in order to preserve
20487 ;; subtrees.
20488 (when (< level ref-level) (setq ref-level level))
20489 (replace-match bul t t)
20490 (org-indent-line-to (+ start-ind (* delta bul-len)))
20491 ;; Ensure all text down to END (or SECTION-END) belongs
20492 ;; to the newly created item.
20493 (let ((section-end (save-excursion
20494 (or (outline-next-heading) (point)))))
20495 (forward-line)
20496 (funcall shift-text
20497 (+ start-ind (* (1+ delta) bul-len))
20498 (min end section-end)))))))
20499 ;; Case 3. Normal line with ARG: make the first line of region
20500 ;; an item, and shift indentation of others lines to
20501 ;; set them as item's body.
20502 (arg (let* ((bul (org-list-bullet-string "-"))
20503 (bul-len (length bul))
20504 (ref-ind (org-get-indentation)))
20506 (insert bul)
20507 (forward-line)
20508 (while (< (point) end)
20509 ;; Ensure that lines less indented than first one
20510 ;; still get included in item body.
20511 (funcall shift-text
20512 (+ ref-ind bul-len)
20513 (min end (save-excursion (or (outline-next-heading)
20514 (point)))))
20515 (forward-line))))
20516 ;; Case 4. Normal line without ARG: turn each non-item line
20517 ;; into an item.
20518 (t
20519 (while (< (point) end)
20520 (unless (or (org-at-heading-p) (org-at-item-p))
20522 (replace-match
20524 (forward-line))))))))
20526 (defun org-toggle-heading (&optional nstars)
20527 "Convert headings to normal text, or items or text to headings.
20528 If there is no active region, only convert the current line.
20531 point into heading.
20533 In a region:
20535 - If the first non blank line is a headline, remove the stars
20536 from all headlines in the region.
20538 - If it is a normal line, turn each and every normal line (i.e.,
20539 not an heading or an item) in the region into headings. If you
20540 want to convert only the first line of this region, use one
20541 universal prefix argument.
20543 - If it is a plain list item, turn all plain list items into headings.
20545 When converting a line into a heading, the number of stars is chosen
20546 such that the lines become children of the current entry. However,
20547 when a numeric prefix argument is given, its value determines the
20548 number of stars to add."
20549 (interactive "P")
20550 (let ((skip-blanks
20551 (function
20552 ;; Return beginning of first non-blank line, starting from
20553 ;; line at POS.
20554 (lambda (pos)
20555 (save-excursion
20556 (goto-char pos)
20557 (while (org-at-comment-p) (forward-line))
20559 (point-at-bol)))))
20560 beg end toggled)
20561 ;; Determine boundaries of changes. If a universal prefix has
20562 ;; been given, put the list in a region. If region ends at a bol,
20563 ;; do not consider the last line to be in the region.
20565 (when (and current-prefix-arg (org-at-item-p))
20566 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20567 (org-mark-element))
20569 (if (org-region-active-p)
20570 (setq beg (funcall skip-blanks (region-beginning))
20571 end (copy-marker (save-excursion
20572 (goto-char (region-end))
20573 (if (bolp) (point) (point-at-eol)))))
20574 (setq beg (funcall skip-blanks (point-at-bol))
20575 end (copy-marker (point-at-eol))))
20576 ;; Ensure inline tasks don't count as headings.
20577 (org-with-limited-levels
20578 (save-excursion
20579 (goto-char beg)
20580 (cond
20581 ;; Case 1. Started at an heading: de-star headings.
20582 ((org-at-heading-p)
20583 (while (< (point) end)
20584 (when (org-at-heading-p t)
20585 (looking-at org-outline-regexp) (replace-match "")
20586 (setq toggled t))
20587 (forward-line)))
20588 ;; Case 2. Started at an item: change items into headlines.
20589 ;; One star will be added by `org-list-to-subtree'.
20590 ((org-at-item-p)
20591 (let* ((stars (make-string
20592 ;; subtract the star that will be added again by
20593 ;; `org-list-to-subtree'
20594 (if (numberp nstars) (1- nstars)
20595 (or (org-current-level) 0))
20596 ?*))
20597 (add-stars
20598 (cond (nstars "") ; stars from prefix only
20599 ((equal stars "") "") ; before first heading
20600 (org-odd-levels-only "*") ; inside heading, odd
20601 (t "")))) ; inside heading, oddeven
20602 (while (< (point) end)
20603 (when (org-at-item-p)
20604 ;; Pay attention to cases when region ends before list.
20605 (let* ((struct (org-list-struct))
20606 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20607 (save-restriction
20608 (narrow-to-region (point) list-end)
20609 (insert
20610 (org-list-to-subtree
20611 (org-list-parse-list t)
20612 '(:istart (concat stars add-stars (funcall get-stars depth))
20613 :icount (concat stars add-stars (funcall get-stars depth)))))))
20614 (setq toggled t))
20615 (forward-line))))
20616 ;; Case 3. Started at normal text: make every line an heading,
20617 ;; skipping headlines and items.
20618 (t (let* ((stars
20619 (make-string
20620 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20621 (add-stars
20622 (cond (nstars "") ; stars from prefix only
20623 ((equal stars "") "*") ; before first heading
20624 (org-odd-levels-only "**") ; inside heading, odd
20625 (t "*"))) ; inside heading, oddeven
20626 (rpl (concat stars add-stars " "))
20627 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20628 (while (< (point) (if (equal nstars '(4)) lend end))
20629 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20631 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20632 (forward-line)))))))
20633 (unless toggled (message "Cannot toggle heading from here"))))
20635 (defun org-meta-return (&optional arg)
20636 "Insert a new heading or wrap a region in a table.
20637 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20638 See the individual commands for more information."
20639 (interactive "P")
20640 (org-check-before-invisible-edit 'insert)
20641 (cond
20642 ((run-hook-with-args-until-success 'org-metareturn-hook))
20643 ((or (org-at-drawer-p) (org-in-drawer-p) (org-at-property-p))
20644 (newline-and-indent))
20645 ((org-at-table-p)
20646 (call-interactively 'org-table-wrap-region))
20647 (t (call-interactively 'org-insert-heading))))
20649 ;;; Menu entries
20651 (defsubst org-in-subtree-not-table-p ()
20652 "Are we in a subtree and not in a table?"
20653 (and (not (org-before-first-heading-p))
20654 (not (org-at-table-p))))
20656 ;; Define the Org-mode menus
20657 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20658 '("Tbl"
20659 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20660 ["Next Field" org-cycle (org-at-table-p)]
20661 ["Previous Field" org-shifttab (org-at-table-p)]
20662 ["Next Row" org-return (org-at-table-p)]
20663 "--"
20664 ["Blank Field" org-table-blank-field (org-at-table-p)]
20665 ["Edit Field" org-table-edit-field (org-at-table-p)]
20666 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20667 "--"
20668 ("Column"
20669 ["Move Column Left" org-metaleft (org-at-table-p)]
20670 ["Move Column Right" org-metaright (org-at-table-p)]
20671 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20672 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20673 ("Row"
20674 ["Move Row Up" org-metaup (org-at-table-p)]
20675 ["Move Row Down" org-metadown (org-at-table-p)]
20676 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20677 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20678 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20679 "--"
20680 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20681 ("Rectangle"
20682 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20683 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20684 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20685 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20686 "--"
20687 ("Calculate"
20688 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20689 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20690 ["Edit Formulas" org-edit-special (org-at-table-p)]
20691 "--"
20692 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20693 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20694 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20695 "--"
20696 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20697 "--"
20698 ["Sum Column/Rectangle" org-table-sum
20699 (or (org-at-table-p) (org-region-active-p))]
20700 ["Which Column?" org-table-current-column (org-at-table-p)])
20701 ["Debug Formulas"
20702 org-table-toggle-formula-debugger
20703 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20704 ["Show Col/Row Numbers"
20705 org-table-toggle-coordinate-overlays
20706 :style toggle
20707 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20708 "--"
20709 ["Create" org-table-create (and (not (org-at-table-p))
20710 org-enable-table-editor)]
20711 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20712 ["Import from File" org-table-import (not (org-at-table-p))]
20713 ["Export to File" org-table-export (org-at-table-p)]
20714 "--"
20715 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20717 (easy-menu-define org-org-menu org-mode-map "Org menu"
20718 '("Org"
20719 ("Show/Hide"
20720 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20721 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20722 ["Sparse Tree..." org-sparse-tree t]
20723 ["Reveal Context" org-reveal t]
20724 ["Show All" show-all t]
20725 "--"
20726 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20727 "--"
20728 ["New Heading" org-insert-heading t]
20729 ("Navigate Headings"
20730 ["Up" outline-up-heading t]
20731 ["Next" outline-next-visible-heading t]
20732 ["Previous" outline-previous-visible-heading t]
20733 ["Next Same Level" outline-forward-same-level t]
20734 ["Previous Same Level" outline-backward-same-level t]
20735 "--"
20736 ["Jump" org-goto t])
20737 ("Edit Structure"
20738 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20739 "--"
20740 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20741 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20742 "--"
20743 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20744 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20745 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20746 "--"
20747 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20748 "--"
20749 ["Copy visible text" org-copy-visible t]
20750 "--"
20751 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20752 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20753 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20754 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20755 "--"
20756 ["Sort Region/Children" org-sort t]
20757 "--"
20758 ["Convert to odd levels" org-convert-to-odd-levels t]
20759 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20760 ("Editing"
20761 ["Emphasis..." org-emphasize t]
20762 ["Edit Source Example" org-edit-special t]
20763 "--"
20764 ["Footnote new/jump" org-footnote-action t]
20765 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20766 ("Archive"
20767 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20768 "--"
20769 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20770 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20771 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20772 )
20773 "--"
20774 ("Hyperlinks"
20775 ["Store Link (Global)" org-store-link t]
20776 ["Find existing link to here" org-occur-link-in-agenda-files t]
20777 ["Insert Link" org-insert-link t]
20778 ["Follow Link" org-open-at-point t]
20779 "--"
20780 ["Next link" org-next-link t]
20781 ["Previous link" org-previous-link t]
20782 "--"
20783 ["Descriptive Links"
20784 org-toggle-link-display
20785 :style radio
20786 :selected org-descriptive-links
20787 ]
20788 ["Literal Links"
20789 org-toggle-link-display
20790 :style radio
20791 :selected (not org-descriptive-links)])
20792 "--"
20793 ("TODO Lists"
20794 ["TODO/DONE/-" org-todo t]
20795 ("Select keyword"
20796 ["Next keyword" org-shiftright (org-at-heading-p)]
20797 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20798 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20799 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20800 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20801 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20802 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20803 "--"
20804 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20805 :selected org-enforce-todo-dependencies :style toggle :active t]
20806 "Settings for tree at point"
20807 ["Do Children sequentially" org-toggle-ordered-property :style radio
20808 :selected (org-entry-get nil "ORDERED")
20809 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20810 ["Do Children parallel" org-toggle-ordered-property :style radio
20811 :selected (not (org-entry-get nil "ORDERED"))
20812 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20813 "--"
20814 ["Set Priority" org-priority t]
20815 ["Priority Up" org-shiftup t]
20816 ["Priority Down" org-shiftdown t]
20817 "--"
20818 ["Get news from all feeds" org-feed-update-all t]
20819 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20820 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20821 ("TAGS and Properties"
20822 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20823 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20824 "--"
20825 ["Set property" org-set-property (not (org-before-first-heading-p))]
20826 ["Column view of properties" org-columns t]
20827 ["Insert Column View DBlock" org-insert-columns-dblock t])
20828 ("Dates and Scheduling"
20829 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20830 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20831 ("Change Date"
20832 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20833 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20834 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20835 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20836 ["Compute Time Range" org-evaluate-time-range t]
20837 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20838 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20839 "--"
20840 ["Custom time format" org-toggle-time-stamp-overlays
20841 :style radio :selected org-display-custom-times]
20842 "--"
20843 ["Goto Calendar" org-goto-calendar t]
20844 ["Date from Calendar" org-date-from-calendar t]
20845 "--"
20846 ["Start/Restart Timer" org-timer-start t]
20847 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20848 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20849 ["Insert Timer String" org-timer t]
20850 ["Insert Timer Item" org-timer-item t])
20851 ("Logging work"
20852 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20853 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20854 ["Clock out" org-clock-out t]
20855 ["Clock cancel" org-clock-cancel t]
20856 "--"
20857 ["Mark as default task" org-clock-mark-default-task t]
20858 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20859 ["Goto running clock" org-clock-goto t]
20860 "--"
20861 ["Display times" org-clock-display t]
20862 ["Create clock table" org-clock-report t]
20863 "--"
20864 ["Record DONE time"
20865 (progn (setq org-log-done (not org-log-done))
20866 (message "Switching to %s will %s record a timestamp"
20867 (car org-done-keywords)
20868 (if org-log-done "automatically" "not")))
20869 :style toggle :selected org-log-done])
20870 "--"
20871 ["Agenda Command..." org-agenda t]
20872 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20873 ("File List for Agenda")
20874 ("Special views current file"
20875 ["TODO Tree" org-show-todo-tree t]
20876 ["Check Deadlines" org-check-deadlines t]
20877 ["Timeline" org-timeline t]
20878 ["Tags/Property tree" org-match-sparse-tree t])
20879 "--"
20880 ["Export/Publish..." org-export-dispatch t]
20881 ("LaTeX"
20882 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20883 :selected org-cdlatex-mode]
20884 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20885 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20886 ["Modify math symbol" org-cdlatex-math-modify
20887 (org-inside-LaTeX-fragment-p)]
20888 ["Insert citation" org-reftex-citation t]
20889 "--"
20890 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20891 "--"
20892 ("MobileOrg"
20893 ["Push Files and Views" org-mobile-push t]
20894 ["Get Captured and Flagged" org-mobile-pull t]
20895 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20896 "--"
20897 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20898 "--"
20899 ("Documentation"
20900 ["Show Version" org-version t]
20901 ["Info Documentation" org-info t])
20902 ("Customize"
20903 ["Browse Org Group" org-customize t]
20904 "--"
20905 ["Expand This Menu" org-create-customize-menu
20906 (fboundp 'customize-menu-create)])
20907 ["Send bug report" org-submit-bug-report t]
20908 "--"
20909 ("Refresh/Reload"
20910 ["Refresh setup current buffer" org-mode-restart t]
20911 ["Reload Org (after update)" org-reload t]
20912 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20913 ))
20915 (defun org-info (&optional node)
20916 "Read documentation for Org-mode in the info system.
20917 With optional NODE, go directly to that node."
20918 (interactive)
20919 (info (format "(org)%s" (or node ""))))
20921 ;;;###autoload
20922 (defun org-submit-bug-report ()
20923 "Submit a bug report on Org-mode via mail.
20925 Don't hesitate to report any problems or inaccurate documentation.
20927 If you don't have setup sending mail from (X)Emacs, please copy the
20928 output buffer into your mail program, as it gives us important
20929 information about your Org-mode version and configuration."
20930 (interactive)
20931 (require 'reporter)
20932 (org-load-modules-maybe)
20933 (org-require-autoloaded-modules)
20934 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20935 (reporter-submit-bug-report
20936 "emacs-orgmode@gnu.org"
20937 (org-version nil 'full)
20938 (let (list)
20939 (save-window-excursion
20940 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20941 (delete-other-windows)
20942 (erase-buffer)
20943 (insert "You are about to submit a bug report to the Org-mode mailing list.
20945 We would like to add your full Org-mode and Outline configuration to the
20946 bug report. This greatly simplifies the work of the maintainer and
20947 other experts on the mailing list.
20949 HOWEVER, some variables you have customized may contain private
20950 information. The names of customers, colleagues, or friends, might
20951 appear in the form of file names, tags, todo states, or search strings.
20952 If you answer yes to the prompt, you might want to check and remove
20953 such private information before sending the email.")
20954 (add-text-properties (point-min) (point-max) '(face org-warning))
20955 (when (yes-or-no-p "Include your Org-mode configuration ")
20956 (mapatoms
20957 (lambda (v)
20958 (and (boundp v)
20960 (or (and (symbol-value v)
20962 (and
20963 (get v 'custom-type) (get v 'standard-value)
20964 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20965 (push v list)))))
20966 (kill-buffer (get-buffer "*Warn about privacy*"))
20967 list))
20968 nil nil
20969 "Remember to cover the basics, that is, what you expected to happen and
20970 what in fact did happen. You don't know how to make a good report? See
20972 http://orgmode.org/manual/Feedback.html#Feedback
20974 Your bug report will be posted to the Org-mode mailing list.
20975 ------------------------------------------------------------------------")
20976 (save-excursion
20981 (defun org-install-agenda-files-menu ()
20982 (let ((bl (buffer-list)))
20983 (save-excursion
20984 (while bl
20985 (set-buffer (pop bl))
20986 (if (derived-mode-p 'org-mode) (setq bl nil)))
20987 (when (derived-mode-p 'org-mode)
20988 (easy-menu-change
20989 '("Org") "File List for Agenda"
20990 (append
20991 (list
20992 ["Edit File List" (org-edit-agenda-file-list) t]
20993 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20994 ["Remove Current File from List" org-remove-file t]
20995 ["Cycle through agenda files" org-cycle-agenda-files t]
20996 ["Occur in all agenda files" org-occur-in-agenda-files t]
20997 "--")
20998 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21000 ;;;; Documentation
21002 (defun org-require-autoloaded-modules ()
21003 (interactive)
21004 (mapc 'require
21005 '(org-agenda org-archive org-attach org-clock org-colview org-id
21006 org-remember org-table org-timer)))
21008 ;;;###autoload
21009 (defun org-reload (&optional uncompiled)
21010 "Reload all org lisp files.
21011 With prefix arg UNCOMPILED, load the uncompiled versions."
21012 (interactive "P")
21013 (require 'loadhist)
21014 (let* ((org-dir (org-find-library-dir "org"))
21015 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21017 (remove-re (mapconcat 'identity
21018 (mapcar (lambda (f) (concat "^" f "$"))
21019 (list (if (featurep 'xemacs)
21020 "org-colview"
21021 "org-colview-xemacs")
21022 "org" "org-loaddefs" "org-version"))
21024 (feats (delete-dups
21025 (mapcar 'file-name-sans-extension
21026 (mapcar 'file-name-nondirectory
21027 (delq nil
21028 (mapcar 'feature-file
21029 features))))))
21030 (lfeat (append
21031 (sort
21032 (setq feats
21033 (delq nil (mapcar
21034 (lambda (f)
21035 (if (and (string-match feature-re f)
21036 (not (string-match remove-re f)))
21037 f nil))
21038 feats)))
21039 'string-lessp)
21040 (list "org-version" "org")))
21041 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21042 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21043 load-uncore load-misses)
21044 (setq load-misses
21045 (delq 't
21046 (mapcar (lambda (f)
21047 (or (org-load-noerror-mustsuffix (concat org-dir f))
21048 (and (string= org-dir contrib-dir)
21049 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21050 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21051 (add-to-list 'load-uncore f 'append)
21052 't)
21053 f))
21054 lfeat)))
21055 (if load-uncore
21057 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21058 (if load-misses
21060 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21063 ;;;###autoload
21064 (defun org-customize ()
21065 "Call the customize function with org as argument."
21066 (interactive)
21067 (org-load-modules-maybe)
21068 (org-require-autoloaded-modules)
21069 (customize-browse 'org))
21071 (defun org-create-customize-menu ()
21072 "Create a full customization menu for Org-mode, insert it into the menu."
21073 (interactive)
21074 (org-load-modules-maybe)
21075 (org-require-autoloaded-modules)
21076 (if (fboundp 'customize-menu-create)
21077 (progn
21078 (easy-menu-change
21079 '("Org") "Customize"
21080 `(["Browse Org group" org-customize t]
21081 "--"
21082 ,(customize-menu-create 'org)
21083 ["Set" Custom-set t]
21084 ["Save" Custom-save t]
21085 ["Reset to Current" Custom-reset-current t]
21086 ["Reset to Saved" Custom-reset-saved t]
21087 ["Reset to Standard Settings" Custom-reset-standard t]))
21089 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21091 ;;;; Miscellaneous stuff
21093 ;;; Generally useful functions
21095 (defun org-get-at-bol (property)
21096 "Get text property PROPERTY at beginning of line."
21097 (get-text-property (point-at-bol) property))
21099 (defun org-find-text-property-in-string (prop s)
21100 "Return the first non-nil value of property PROP in string S."
21101 (or (get-text-property 0 prop s)
21102 (get-text-property (or (next-single-property-change 0 prop s) 0)
21103 prop s)))
21105 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21106 "Display the given MESSAGE as a warning."
21107 (if (fboundp 'display-warning)
21108 (display-warning 'org message
21109 (if (featurep 'xemacs) 'warning :warning))
21110 (let ((buf (get-buffer-create "*Org warnings*")))
21111 (with-current-buffer buf
21112 (goto-char (point-max))
21113 (insert "Warning (Org): " message)
21114 (unless (bolp)
21115 (newline)))
21116 (display-buffer buf)
21117 (sit-for 0))))
21119 (defun org-eval (form)
21120 "Eval FORM and return result."
21121 (condition-case error
21122 (eval form)
21123 (error (format "%%![Error: %s]" error))))
21125 (defun org-in-clocktable-p ()
21126 "Check if the cursor is in a clocktable."
21127 (let ((pos (point)) start)
21128 (save-excursion
21129 (end-of-line 1)
21131 (setq start (match-beginning 0))
21133 (>= (match-end 0) pos)
21134 start))))
21136 (defun org-in-commented-line ()
21137 "Is point in a line starting with `#'?"
21138 (equal (char-after (point-at-bol)) ?#))
21140 (defun org-in-indented-comment-line ()
21141 "Is point in a line starting with `#' after some white space?"
21142 (save-excursion
21143 (save-match-data
21144 (goto-char (point-at-bol))
21147 (defun org-in-verbatim-emphasis ()
21148 (save-match-data
21149 (and (org-in-regexp org-emph-re 2)
21150 (>= (point) (match-beginning 3))
21151 (<= (point) (match-end 4))
21152 (member (match-string 3) '("=" "~")))))
21154 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21155 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21156 (if (and marker (marker-buffer marker)
21157 (buffer-live-p (marker-buffer marker)))
21158 (progn
21159 (org-pop-to-buffer-same-window (marker-buffer marker))
21160 (if (or (> marker (point-max)) (< marker (point-min)))
21161 (widen))
21162 (goto-char marker)
21163 (org-show-context 'org-goto))
21164 (if bookmark
21165 (bookmark-jump bookmark)
21166 (error "Cannot find location"))))
21168 (defun org-quote-csv-field (s)
21169 "Quote field for inclusion in CSV material."
21172 s))
21174 (defun org-force-self-insert (N)
21175 "Needed to enforce self-insert under remapping."
21176 (interactive "p")
21177 (self-insert-command N))
21179 (defun org-string-width (s)
21180 "Compute width of string, ignoring invisible characters.
21181 This ignores character with invisibility property `org-link', and also
21182 characters with property `org-cwidth', because these will become invisible
21183 upon the next fontification round."
21184 (let (b l)
21185 (when (or (eq t buffer-invisibility-spec)
21186 (assq 'org-link buffer-invisibility-spec))
21187 (while (setq b (text-property-any 0 (length s)
21188 'invisible 'org-link s))
21189 (setq s (concat (substring s 0 b)
21190 (substring s (or (next-single-property-change
21191 b 'invisible s) (length s)))))))
21192 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21193 (setq s (concat (substring s 0 b)
21194 (substring s (or (next-single-property-change
21195 b 'org-cwidth s) (length s))))))
21196 (setq l (string-width s) b -1)
21197 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21198 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21199 l))
21201 (defun org-shorten-string (s maxlength)
21202 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21203 If the string is shorter or has length MAXLENGTH, just return the
21204 original string. If it is longer, the functions finds a space in the
21205 string, breaks this string off at that locations and adds three dots
21206 as ellipsis. Including the ellipsis, the string will not be longer
21207 than MAXLENGTH. If finding a good breaking point in the string does
21208 not work, the string is just chopped off in the middle of a word
21209 if necessary."
21210 (if (<= (length s) maxlength)
21211 s
21212 (let* ((n (max (- maxlength 4) 1))
21214 (if (string-match re s)
21215 (concat (match-string 1 s) "...")
21216 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21218 (defun org-get-indentation (&optional line)
21219 "Get the indentation of the current line, interpreting tabs.
21220 When LINE is given, assume it represents a line and compute its indentation."
21221 (if line
21222 (if (string-match "^ *" (org-remove-tabs line))
21223 (match-end 0))
21224 (save-excursion
21225 (beginning-of-line 1)
21227 (current-column))))
21229 (defun org-get-string-indentation (s)
21230 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21231 (let ((n -1) (i 0) (w tab-width) c)
21232 (catch 'exit
21233 (while (< (setq n (1+ n)) (length s))
21234 (setq c (aref s n))
21235 (cond ((= c ?\ ) (setq i (1+ i)))
21237 (t (throw 'exit t)))))
21238 i))
21240 (defun org-remove-tabs (s &optional width)
21241 "Replace tabulators in S with spaces.
21242 Assumes that s is a single line, starting in column 0."
21243 (setq width (or width tab-width))
21245 (setq s (replace-match
21246 (make-string
21247 (- (* width (/ (+ (match-beginning 0) width) width))
21248 (match-beginning 0)) ?\ )
21249 t t s)))
21250 s)
21252 (defun org-fix-indentation (line ind)
21253 "Fix indentation in LINE.
21254 IND is a cons cell with target and minimum indentation.
21255 If the current indentation in LINE is smaller than the minimum,
21256 leave it alone. If it is larger than ind, set it to the target."
21257 (let* ((l (org-remove-tabs line))
21258 (i (org-get-indentation l))
21259 (i1 (car ind)) (i2 (cdr ind)))
21260 (if (>= i i2) (setq l (substring line i2)))
21261 (if (> i1 0)
21262 (concat (make-string i1 ?\ ) l)
21263 l)))
21265 (defun org-remove-indentation (code &optional n)
21266 "Remove the maximum common indentation from the lines in CODE.
21267 N may optionally be the number of spaces to remove."
21268 (with-temp-buffer
21269 (insert code)
21270 (org-do-remove-indentation n)
21271 (buffer-string)))
21273 (defun org-do-remove-indentation (&optional n)
21274 "Remove the maximum common indentation from the buffer."
21275 (untabify (point-min) (point-max))
21276 (let ((min 10000) re)
21277 (if n
21278 (setq min n)
21279 (goto-char (point-min))
21281 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21282 (unless (or (= min 0) (= min 10000))
21284 (goto-char (point-min))
21285 (while (re-search-forward re nil t)
21286 (replace-match "")
21287 (end-of-line 1))
21288 min)))
21290 (defun org-fill-template (template alist)
21291 "Find each %key of ALIST in TEMPLATE and replace it."
21292 (let ((case-fold-search nil)
21293 entry key value)
21294 (setq alist (sort (copy-sequence alist)
21295 (lambda (a b) (< (length (car a)) (length (car b))))))
21296 (while (setq entry (pop alist))
21297 (setq template
21298 (replace-regexp-in-string
21299 (concat "%" (regexp-quote (car entry)))
21300 (or (cdr entry) "") template t t)))
21301 template))
21303 (defun org-base-buffer (buffer)
21304 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21305 (if (not buffer)
21306 buffer
21307 (or (buffer-base-buffer buffer)
21308 buffer)))
21310 (defun org-trim (s)
21311 "Remove whitespace at beginning and end of string."
21314 s)
21316 (defun org-wrap (string &optional width lines)
21317 "Wrap string to either a number of lines, or a width in characters.
21318 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21319 that costs. If there is a word longer than WIDTH, the text is actually
21320 wrapped to the length of that word.
21321 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21322 many lines, whatever width that takes.
21323 The return value is a list of lines, without newlines at the end."
21325 (maxword (apply 'max (mapcar 'org-string-width words)))
21326 w ll)
21327 (cond (width
21328 (org-do-wrap words (max maxword width)))
21329 (lines
21330 (setq w maxword)
21331 (setq ll (org-do-wrap words maxword))
21332 (if (<= (length ll) lines)
21333 ll
21334 (setq ll words)
21335 (while (> (length ll) lines)
21336 (setq w (1+ w))
21337 (setq ll (org-do-wrap words w)))
21338 ll))
21339 (t (error "Cannot wrap this")))))
21341 (defun org-do-wrap (words width)
21342 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21343 (let (lines line)
21344 (while words
21345 (setq line (pop words))
21346 (while (and words (< (+ (length line) (length (car words))) width))
21347 (setq line (concat line " " (pop words))))
21348 (setq lines (push line lines)))
21349 (nreverse lines)))
21351 (defun org-split-string (string &optional separators)
21352 "Splits STRING into substrings at SEPARATORS.
21353 No empty strings are returned if there are matches at the beginning
21354 and end of string."
21356 (start 0)
21357 notfirst
21358 (list nil))
21359 (while (and (string-match rexp string
21360 (if (and notfirst
21361 (= start (match-beginning 0))
21362 (< start (length string)))
21363 (1+ start) start))
21364 (< (match-beginning 0) (length string)))
21365 (setq notfirst t)
21366 (or (eq (match-beginning 0) 0)
21367 (and (eq (match-beginning 0) (match-end 0))
21368 (eq (match-beginning 0) start))
21369 (setq list
21370 (cons (substring string start (match-beginning 0))
21371 list)))
21372 (setq start (match-end 0)))
21373 (or (eq start (length string))
21374 (setq list
21375 (cons (substring string start)
21376 list)))
21377 (nreverse list)))
21379 (defun org-quote-vert (s)
21381 (while (string-match "|" s)
21383 s)
21385 (defun org-uuidgen-p (s)
21386 "Is S an ID created by UUIDGEN?"
21387 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21389 (defun org-in-src-block-p (&optional inside)
21390 "Whether point is in a code source block.
21391 When INSIDE is non-nil, don't consider we are within a src block
21392 when point is at #+BEGIN_SRC or #+END_SRC."
21393 (let ((case-fold-search t) ov)
21394 (or (and (setq ov (overlays-at (point)))
21395 (memq 'org-block-background
21396 (overlay-properties (car ov))))
21397 (and (not inside)
21398 (save-match-data
21399 (save-excursion
21400 (beginning-of-line)
21403 (defun org-context ()
21404 "Return a list of contexts of the current cursor position.
21405 If several contexts apply, all are returned.
21406 Each context entry is a list with a symbol naming the context, and
21407 two positions indicating start and end of the context. Possible
21408 contexts are:
21410 :headline anywhere in a headline
21411 :headline-stars on the leading stars in a headline
21412 :todo-keyword on a TODO keyword (including DONE) in a headline
21413 :tags on the TAGS in a headline
21414 :priority on the priority cookie in a headline
21415 :item on the first line of a plain list item
21416 :item-bullet on the bullet/number of a plain list item
21417 :checkbox on the checkbox in a plain list item
21418 :table in an org-mode table
21419 :table-special on a special filed in a table
21420 :table-table in a table.el table
21421 :clocktable in a clocktable
21422 :src-block in a source block
21423 :link on a hyperlink
21424 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21425 :target on a <<target>>
21426 :radio-target on a <<<radio-target>>>
21427 :latex-fragment on a LaTeX fragment
21428 :latex-preview on a LaTeX fragment with overlaid preview image
21430 This function expects the position to be visible because it uses font-lock
21431 faces as a help to recognize the following contexts: :table-special, :link,
21432 and :keyword."
21433 (let* ((f (get-text-property (point) 'face))
21434 (faces (if (listp f) f (list f)))
21435 (case-fold-search t)
21436 (p (point)) clist o)
21437 ;; First the large context
21438 (cond
21439 ((org-at-heading-p t)
21440 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21441 (when (progn
21442 (beginning-of-line 1)
21443 (looking-at org-todo-line-tags-regexp))
21444 (push (org-point-in-group p 1 :headline-stars) clist)
21445 (push (org-point-in-group p 2 :todo-keyword) clist)
21446 (push (org-point-in-group p 4 :tags) clist))
21447 (goto-char p)
21450 (push (org-point-in-group p 0 :priority) clist)))
21452 ((org-at-item-p)
21453 (push (org-point-in-group p 2 :item-bullet) clist)
21454 (push (list :item (point-at-bol)
21455 (save-excursion (org-end-of-item) (point)))
21456 clist)
21457 (and (org-at-item-checkbox-p)
21458 (push (org-point-in-group p 0 :checkbox) clist)))
21460 ((org-at-table-p)
21461 (push (list :table (org-table-begin) (org-table-end)) clist)
21462 (if (memq 'org-formula faces)
21463 (push (list :table-special
21464 (previous-single-property-change p 'face)
21465 (next-single-property-change p 'face)) clist)))
21466 ((org-at-table-p 'any)
21467 (push (list :table-table) clist)))
21468 (goto-char p)
21470 (let ((case-fold-search t))
21471 ;; New the "medium" contexts: clocktables, source blocks
21472 (cond ((org-in-clocktable-p)
21473 (push (list :clocktable
21475 (search-backward "#+BEGIN: clocktable" nil t))
21476 (match-beginning 0))
21478 (match-end 0))) clist))
21479 ((org-in-src-block-p)
21480 (push (list :src-block
21482 (search-backward "#+BEGIN_SRC" nil t))
21483 (match-beginning 0))
21484 (and (search-forward "#+END_SRC" nil t)
21485 (match-beginning 0))) clist))))
21486 (goto-char p)
21488 ;; Now the small context
21489 (cond
21490 ((org-at-timestamp-p)
21491 (push (org-point-in-group p 0 :timestamp) clist))
21492 ((memq 'org-link faces)
21493 (push (list :link
21494 (previous-single-property-change p 'face)
21495 (next-single-property-change p 'face)) clist))
21496 ((memq 'org-special-keyword faces)
21497 (push (list :keyword
21498 (previous-single-property-change p 'face)
21499 (next-single-property-change p 'face)) clist))
21500 ((org-at-target-p)
21501 (push (org-point-in-group p 0 :target) clist)
21502 (goto-char (1- (match-beginning 0)))
21503 (if (looking-at org-radio-target-regexp)
21504 (push (org-point-in-group p 0 :radio-target) clist))
21505 (goto-char p))
21506 ((setq o (car (delq nil
21507 (mapcar
21508 (lambda (x)
21509 (if (memq x org-latex-fragment-image-overlays) x))
21510 (overlays-at (point))))))
21511 (push (list :latex-fragment
21512 (overlay-start o) (overlay-end o)) clist)
21513 (push (list :latex-preview
21514 (overlay-start o) (overlay-end o)) clist))
21515 ((org-inside-LaTeX-fragment-p)
21516 ;; FIXME: positions wrong.
21517 (push (list :latex-fragment (point) (point)) clist)))
21519 (setq clist (nreverse (delq nil clist)))
21520 clist))
21522 ;; FIXME: Compare with at-regexp-p Do we need both?
21523 (defun org-in-regexp (re &optional nlines visually)
21524 "Check if point is inside a match of regexp.
21525 Normally only the current line is checked, but you can include NLINES extra
21526 lines both before and after point into the search.
21527 If VISUALLY is set, require that the cursor is not after the match but
21528 really on, so that the block visually is on the match."
21529 (catch 'exit
21530 (let ((pos (point))
21531 (eol (point-at-eol (+ 1 (or nlines 0))))
21532 (inc (if visually 1 0)))
21533 (save-excursion
21534 (beginning-of-line (- 1 (or nlines 0)))
21535 (while (re-search-forward re eol t)
21536 (if (and (<= (match-beginning 0) pos)
21537 (>= (+ inc (match-end 0)) pos))
21538 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21540 (defun org-at-regexp-p (regexp)
21541 "Is point inside a match of REGEXP in the current line?"
21542 (catch 'exit
21543 (save-excursion
21544 (let ((pos (point)) (end (point-at-eol)))
21545 (beginning-of-line 1)
21546 (while (re-search-forward regexp end t)
21547 (if (and (<= (match-beginning 0) pos)
21548 (>= (match-end 0) pos))
21549 (throw 'exit t)))
21550 nil))))
21552 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21553 "Non-nil when point is between matches of START-RE and END-RE.
21555 Also return a non-nil value when point is on one of the matches.
21557 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21558 buffer positions. Default values are the positions of headlines
21559 surrounding the point.
21561 The functions returns a cons cell whose car (resp. cdr) is the
21562 position before START-RE (resp. after END-RE)."
21563 (save-match-data
21564 (let ((pos (point))
21565 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21566 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21567 beg end)
21568 (save-excursion
21569 ;; Point is on a block when on START-RE or if START-RE can be
21570 ;; found before it...
21571 (and (or (org-at-regexp-p start-re)
21572 (re-search-backward start-re limit-up t))
21573 (setq beg (match-beginning 0))
21574 ;; ... and END-RE after it...
21575 (goto-char (match-end 0))
21576 (re-search-forward end-re limit-down t)
21577 (> (setq end (match-end 0)) pos)
21578 ;; ... without another START-RE in-between.
21579 (goto-char (match-beginning 0))
21580 (not (re-search-backward start-re (1+ beg) t))
21581 ;; Return value.
21582 (cons beg end))))))
21584 (defun org-in-block-p (names)
21585 "Non-nil when point belongs to a block whose name belongs to NAMES.
21587 NAMES is a list of strings containing names of blocks.
21589 Return first block name matched, or nil. Beware that in case of
21590 nested blocks, the returned name may not belong to the closest
21591 block from point."
21592 (save-match-data
21593 (catch 'exit
21594 (let ((case-fold-search t)
21595 (lim-up (save-excursion (outline-previous-heading)))
21596 (lim-down (save-excursion (outline-next-heading))))
21597 (mapc (lambda (name)
21598 (let ((n (regexp-quote name)))
21599 (when (org-between-regexps-p
21602 lim-up lim-down)
21603 (throw 'exit n))))
21604 names))
21605 nil)))
21607 (defun org-in-drawer-p ()
21608 "Is point within a drawer?"
21609 (save-match-data
21610 (let ((case-fold-search t)
21611 (lim-up (save-excursion (outline-previous-heading)))
21612 (lim-down (save-excursion (outline-next-heading))))
21613 (org-between-regexps-p
21616 lim-up lim-down))))
21618 (defun org-occur-in-agenda-files (regexp &optional nlines)
21619 "Call `multi-occur' with buffers for all agenda files."
21621 (let* ((files (org-agenda-files))
21622 (tnames (mapcar 'file-truename files))
21623 (extra org-agenda-text-search-extra-files)
21624 f)
21625 (when (eq (car extra) 'agenda-archives)
21626 (setq extra (cdr extra))
21627 (setq files (org-add-archive-files files)))
21628 (while (setq f (pop extra))
21629 (unless (member (file-truename f) tnames)
21630 (add-to-list 'files f 'append)
21631 (add-to-list 'tnames (file-truename f) 'append)))
21632 (multi-occur
21633 (mapcar (lambda (x)
21634 (with-current-buffer
21635 (or (get-file-buffer x) (find-file-noselect x))
21636 (widen)
21637 (current-buffer)))
21638 files)
21639 regexp)))
21641 (if (boundp 'occur-mode-find-occurrence-hook)
21642 ;; Emacs 23
21643 (add-hook 'occur-mode-find-occurrence-hook
21644 (lambda ()
21645 (when (derived-mode-p 'org-mode)
21646 (org-reveal))))
21647 ;; Emacs 22
21648 (defadvice occur-mode-goto-occurrence
21649 (after org-occur-reveal activate)
21650 (and (derived-mode-p 'org-mode) (org-reveal)))
21651 (defadvice occur-mode-goto-occurrence-other-window
21652 (after org-occur-reveal activate)
21653 (and (derived-mode-p 'org-mode) (org-reveal)))
21654 (defadvice occur-mode-display-occurrence
21655 (after org-occur-reveal activate)
21656 (when (derived-mode-p 'org-mode)
21657 (let ((pos (occur-mode-find-occurrence)))
21658 (with-current-buffer (marker-buffer pos)
21659 (save-excursion
21660 (goto-char pos)
21661 (org-reveal)))))))
21663 (defun org-occur-link-in-agenda-files ()
21664 "Create a link and search for it in the agendas.
21665 The link is not stored in `org-stored-links', it is just created
21666 for the search purpose."
21667 (interactive)
21668 (let ((link (condition-case nil
21669 (org-store-link nil)
21670 (error "Unable to create a link to here"))))
21671 (org-occur-in-agenda-files (regexp-quote link))))
21673 (defun org-reverse-string (string)
21674 "Return the reverse of STRING."
21675 (apply 'string (reverse (string-to-list string))))
21677 (defsubst org-uniquify (list)
21678 "Non-destructively remove duplicate elements from LIST."
21679 (let ((res (copy-sequence list))) (delete-dups res)))
21681 (defun org-uniquify-alist (alist)
21682 "Merge elements of ALIST with the same key.
21684 For example, in this alist:
21686 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21687 => '((a 1 3) (b 2))
21689 merge (a 1) and (a 3) into (a 1 3).
21691 The function returns the new ALIST."
21692 (let (rtn)
21693 (mapc
21694 (lambda (e)
21695 (let (n)
21696 (if (not (assoc (car e) rtn))
21697 (push e rtn)
21698 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21699 (setq rtn (assq-delete-all (car e) rtn))
21700 (push n rtn))))
21701 alist)
21702 rtn))
21704 (defun org-delete-all (elts list)
21705 "Remove all elements in ELTS from LIST."
21706 (while elts
21707 (setq list (delete (pop elts) list)))
21708 list)
21710 (defun org-count (cl-item cl-seq)
21711 "Count the number of occurrences of ITEM in SEQ.
21712 Taken from `count' in cl-seq.el with all keyword arguments removed."
21713 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21714 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21715 (while (< cl-start cl-end)
21716 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21717 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21718 (setq cl-start (1+ cl-start)))
21719 cl-count))
21721 (defun org-remove-if (predicate seq)
21722 "Remove everything from SEQ that fulfills PREDICATE."
21723 (let (res e)
21724 (while seq
21725 (setq e (pop seq))
21726 (if (not (funcall predicate e)) (push e res)))
21727 (nreverse res)))
21729 (defun org-remove-if-not (predicate seq)
21730 "Remove everything from SEQ that does not fulfill PREDICATE."
21731 (let (res e)
21732 (while seq
21733 (setq e (pop seq))
21734 (if (funcall predicate e) (push e res)))
21735 (nreverse res)))
21737 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21738 "Reduce two-argument FUNCTION across SEQ.
21739 Taken from `reduce' in cl-seq.el with all keyword arguments but
21741 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21742 (cadr (memq :initial-value cl-keys)))
21743 (cl-seq (pop cl-seq))
21744 (t (funcall cl-func)))))
21745 (while cl-seq
21746 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21747 cl-accum))
21749 (defun org-every (pred seq)
21750 "Return true if PREDICATE is true of every element of SEQ.
21751 Adapted from `every' in cl.el."
21752 (catch 'org-every
21753 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21754 t))
21756 (defun org-some (pred seq)
21757 "Return true if PREDICATE is true of any element of SEQ.
21758 Adapted from `some' in cl.el."
21759 (catch 'org-some
21760 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21761 nil))
21763 (defun org-back-over-empty-lines ()
21764 "Move backwards over whitespace, to the beginning of the first empty line.
21765 Returns the number of empty lines passed."
21766 (let ((pos (point)))
21767 (if (cdr (assoc 'heading org-blank-before-new-entry))
21769 (unless (eobp)
21770 (forward-line -1)))
21771 (beginning-of-line 2)
21772 (goto-char (min (point) pos))
21773 (count-lines (point) pos)))
21775 (defun org-skip-whitespace ()
21778 (defun org-point-in-group (point group &optional context)
21779 "Check if POINT is in match-group GROUP.
21780 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21781 match. If the match group does not exist or point is not inside it,
21782 return nil."
21783 (and (match-beginning group)
21784 (>= point (match-beginning group))
21785 (<= point (match-end group))
21786 (if context
21787 (list context (match-beginning group) (match-end group))
21788 t)))
21790 (defun org-switch-to-buffer-other-window (&rest args)
21791 "Switch to buffer in a second window on the current frame.
21792 In particular, do not allow pop-up frames.
21793 Returns the newly created buffer."
21794 (org-no-popups
21795 (apply 'switch-to-buffer-other-window args)))
21797 (defun org-combine-plists (&rest plists)
21798 "Create a single property list from all plists in PLISTS.
21799 The process starts by copying the first list, and then setting properties
21800 from the other lists. Settings in the last list are the most significant
21801 ones and overrule settings in the other lists."
21802 (let ((rtn (copy-sequence (pop plists)))
21803 p v ls)
21804 (while plists
21805 (setq ls (pop plists))
21806 (while ls
21807 (setq p (pop ls) v (pop ls))
21808 (setq rtn (plist-put rtn p v))))
21809 rtn))
21811 (defun org-replace-escapes (string table)
21812 "Replace %-escapes in STRING with values in TABLE.
21814 The sequences in STRING may contain normal field width and padding information,
21816 so values can contain further %-escapes if they are define later in TABLE."
21817 (let ((tbl (copy-alist table))
21818 (case-fold-search nil)
21819 (pchg 0)
21820 e re rpl)
21821 (while (setq e (pop tbl))
21822 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21823 (when (and (cdr e) (string-match re (cdr e)))
21824 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21825 (safe "SREF"))
21826 (add-text-properties 0 3 (list 'sref sref) safe)
21827 (setcdr e (replace-match safe t t (cdr e)))))
21828 (while (string-match re string)
21829 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21830 (cdr e)))
21831 (setq string (replace-match rpl t t string))))
21832 (while (setq pchg (next-property-change pchg string))
21833 (let ((sref (get-text-property pchg 'sref string)))
21834 (when (and sref (string-match "SREF" string pchg))
21835 (setq string (replace-match sref t t string)))))
21836 string))
21838 (defun org-sublist (list start end)
21839 "Return a section of LIST, from START to END.
21840 Counting starts at 1."
21841 (let (rtn (c start))
21842 (setq list (nthcdr (1- start) list))
21843 (while (and list (<= c end))
21844 (push (pop list) rtn)
21845 (setq c (1+ c)))
21846 (nreverse rtn)))
21848 (defun org-find-base-buffer-visiting (file)
21849 "Like `find-buffer-visiting' but always return the base buffer and
21850 not an indirect buffer."
21851 (let ((buf (or (get-file-buffer file)
21852 (find-buffer-visiting file))))
21853 (if buf
21854 (or (buffer-base-buffer buf) buf)
21855 nil)))
21857 (defun org-image-file-name-regexp (&optional extensions)
21858 "Return regexp matching the file names of images.
21859 If EXTENSIONS is given, only match these."
21860 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21861 (image-file-name-regexp)
21862 (let ((image-file-name-extensions
21863 (or extensions
21864 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21865 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21867 (regexp-opt (nconc (mapcar 'upcase
21868 image-file-name-extensions)
21869 image-file-name-extensions)
21870 t)
21873 (defun org-file-image-p (file &optional extensions)
21874 "Return non-nil if FILE is an image."
21875 (save-match-data
21876 (string-match (org-image-file-name-regexp extensions) file)))
21878 (defun org-get-cursor-date (&optional with-time)
21879 "Return the date at cursor in as a time.
21880 This works in the calendar and in the agenda, anywhere else it just
21881 returns the current time.
21882 If WITH-TIME is non-nil, returns the time of the event at point (in
21883 the agenda) or the current time of the day."
21884 (let (date day defd tp tm hod mod)
21885 (when with-time
21886 (setq tp (get-text-property (point) 'time))
21888 (setq hod (string-to-number (match-string 1 tp))
21889 mod (string-to-number (match-string 2 tp))))
21890 (or tp (setq hod (nth 2 (decode-time (current-time)))
21891 mod (nth 1 (decode-time (current-time))))))
21892 (cond
21893 ((eq major-mode 'calendar-mode)
21894 (setq date (calendar-cursor-to-date)
21895 defd (encode-time 0 (or mod 0) (or hod 0)
21896 (nth 1 date) (nth 0 date) (nth 2 date))))
21897 ((eq major-mode 'org-agenda-mode)
21898 (setq day (get-text-property (point) 'day))
21899 (if day
21900 (setq date (calendar-gregorian-from-absolute day)
21901 defd (encode-time 0 (or mod 0) (or hod 0)
21902 (nth 1 date) (nth 0 date) (nth 2 date))))))
21903 (or defd (current-time))))
21905 (defun org-mark-subtree (&optional up)
21906 "Mark the current subtree.
21907 This puts point at the start of the current subtree, and mark at
21908 the end. If a numeric prefix UP is given, move up into the
21909 hierarchy of headlines by UP levels before marking the subtree."
21910 (interactive "P")
21911 (org-with-limited-levels
21912 (cond ((org-at-heading-p) (beginning-of-line))
21913 ((org-before-first-heading-p) (user-error "Not in a subtree"))
21914 (t (outline-previous-visible-heading 1))))
21915 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21916 (if (org-called-interactively-p 'any)
21917 (call-interactively 'org-mark-element)
21918 (org-mark-element)))
21921 ;;; Indentation
21923 (defun org-indent-line ()
21924 "Indent line depending on context."
21925 (interactive)
21926 (let* ((pos (point))
21927 (itemp (org-at-item-p))
21928 (case-fold-search t)
21930 (inline-task-p (and (featurep 'org-inlinetask)
21931 (org-inlinetask-in-task-p)))
21932 (inline-re (and inline-task-p
21933 (org-inlinetask-outline-regexp)))
21934 column)
21935 (if (and orgstruct-is-++ (eq pos (point)))
21936 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21937 (indent-according-to-mode))
21938 (beginning-of-line 1)
21939 (cond
21940 ;; Headings
21941 ((looking-at org-outline-regexp) (setq column 0))
21942 ;; Footnote definition
21943 ((looking-at org-footnote-definition-re) (setq column 0))
21944 ;; Literal examples
21946 (setq column (org-get-indentation))) ; do nothing
21947 ;; Lists
21948 ((ignore-errors (goto-char (org-in-item-p)))
21949 (setq column (if itemp
21950 (org-get-indentation)
21951 (org-list-item-body-column (point))))
21952 (goto-char pos))
21953 ;; Drawers
21955 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21956 (save-excursion
21957 (goto-char (1- (match-beginning 1)))
21958 (setq column (current-column))))
21959 ;; Special blocks
21961 (save-excursion
21962 (re-search-backward
21964 (setq column (org-get-indentation (match-string 0))))
21967 (save-excursion
21969 (setq column
21970 (cond ((equal (downcase (match-string 1)) "src")
21971 ;; src blocks: let `org-edit-src-exit' handle them
21972 (org-get-indentation))
21973 ((equal (downcase (match-string 1)) "example")
21974 (max (org-get-indentation)
21975 (org-get-indentation (match-string 0))))
21976 (t
21977 (org-get-indentation (match-string 0))))))
21978 ;; This line has nothing special, look at the previous relevant
21979 ;; line to compute indentation
21980 (t
21981 (beginning-of-line 0)
21982 (while (and (not (bobp))
21983 (not (looking-at org-table-line-regexp))
21984 (not (looking-at org-drawer-regexp))
21985 ;; When point started in an inline task, do not move
21986 ;; above task starting line.
21987 (not (and inline-task-p (looking-at inline-re)))
21988 ;; Skip drawers, blocks, empty lines, verbatim,
21989 ;; comments, tables, footnotes definitions, lists,
21990 ;; inline tasks.
21992 (re-search-backward org-drawer-regexp nil t))
21996 (looking-at org-footnote-definition-re)
21997 (and (not inline-task-p)
21998 (featurep 'org-inlinetask)
21999 (org-inlinetask-in-task-p)
22000 (or (org-inlinetask-goto-beginning) t))))
22001 (beginning-of-line 0))
22002 (cond
22003 ;; There was a list item above.
22004 ((save-excursion
22005 (and (ignore-errors (goto-char (org-in-item-p)))
22006 (goto-char
22007 (org-list-get-top-point (org-list-struct)))))
22008 (looking-at org-list-full-item-re)
22009 (setq column (length (match-string 0))))
22010 ;; There was an heading above.
22012 (if (not org-adapt-indentation)
22013 (setq column 0)
22014 (goto-char (match-end 0))
22015 (setq column (current-column))))
22016 ;; A drawer had started and is unfinished
22017 ((looking-at org-drawer-regexp)
22018 (goto-char (1- (match-beginning 1)))
22019 (setq column (current-column)))
22020 ;; Else, nothing noticeable found: get indentation and go on.
22021 (t (setq column (org-get-indentation))))))
22022 ;; Now apply indentation and move cursor accordingly
22023 (goto-char pos)
22024 (if (<= (current-column) (current-indentation))
22025 (org-indent-line-to column)
22026 (save-excursion (org-indent-line-to column)))
22027 ;; Special polishing for properties, see `org-property-format'
22028 (setq column (current-column))
22029 (beginning-of-line 1)
22030 (if (looking-at org-property-re)
22031 (replace-match (concat (match-string 4)
22032 (format org-property-format
22033 (match-string 1) (match-string 3)))
22034 t t))
22035 (org-move-to-column column))))
22037 (defun org-indent-drawer ()
22038 "Indent the drawer at point."
22039 (interactive)
22040 (let ((p (point))
22041 (e (and (save-excursion (re-search-forward ":END:" nil t))
22042 (match-end 0)))
22043 (folded
22044 (save-excursion
22045 (end-of-line)
22046 (when (overlays-at (point))
22047 (member 'invisible (overlay-properties
22048 (car (overlays-at (point)))))))))
22049 (when folded (org-cycle))
22050 (indent-for-tab-command)
22051 (while (and (move-beginning-of-line 2) (< (point) e))
22052 (indent-for-tab-command))
22053 (goto-char p)
22054 (when folded (org-cycle)))
22055 (message "Drawer at point indented"))
22057 (defun org-indent-block ()
22058 "Indent the block at point."
22059 (interactive)
22060 (let ((p (point))
22061 (case-fold-search t)
22063 (match-end 0)))
22064 (folded
22065 (save-excursion
22066 (end-of-line)
22067 (when (overlays-at (point))
22068 (member 'invisible (overlay-properties
22069 (car (overlays-at (point)))))))))
22070 (when folded (org-cycle))
22071 (indent-for-tab-command)
22072 (while (and (move-beginning-of-line 2) (< (point) e))
22073 (indent-for-tab-command))
22074 (goto-char p)
22075 (when folded (org-cycle)))
22076 (message "Block at point indented"))
22078 (defun org-indent-region (start end)
22079 "Indent region."
22080 (interactive "r")
22081 (save-excursion
22082 (let ((line-end (org-current-line end)))
22083 (goto-char start)
22084 (while (< (org-current-line) line-end)
22085 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
22086 (t (call-interactively 'org-indent-line)))
22087 (move-beginning-of-line 2)))))
22090 ;;; Filling
22092 ;; We use our own fill-paragraph and auto-fill functions.
22094 ;; `org-fill-paragraph' relies on adaptive filling and context
22095 ;; checking. Appropriate `fill-prefix' is computed with
22096 ;; `org-adaptive-fill-function'.
22098 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22099 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22100 ;; `org-adaptive-fill-function' value. Internally,
22101 ;; `org-comment-line-break-function' breaks the line.
22103 ;; `org-setup-filling' installs filling and auto-filling related
22104 ;; variables during `org-mode' initialization.
22106 (defvar org-element-paragraph-separate) ; org-element.el
22107 (defun org-setup-filling ()
22108 (require 'org-element)
22109 ;; Prevent auto-fill from inserting unwanted new items.
22110 (when (boundp 'fill-nobreak-predicate)
22111 (org-set-local
22112 'fill-nobreak-predicate
22113 (org-uniquify
22114 (append fill-nobreak-predicate
22115 '(org-fill-line-break-nobreak-p
22116 org-fill-paragraph-with-timestamp-nobreak-p)))))
22117 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22118 (org-set-local 'paragraph-start paragraph-ending)
22119 (org-set-local 'paragraph-separate paragraph-ending))
22120 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22121 (org-set-local 'auto-fill-inhibit-regexp nil)
22122 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22123 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22124 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22126 (defun org-fill-line-break-nobreak-p ()
22127 "Non-nil when a new line at point would create an Org line break."
22128 (save-excursion
22133 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22134 "Non-nil when a new line at point would split a timestamp."
22135 (and (org-at-timestamp-p t)
22136 (not (looking-at org-ts-regexp-both))))
22138 (declare-function message-in-body-p "message" ())
22139 (defvar orgtbl-line-start-regexp) ; From org-table.el
22140 (defun org-adaptive-fill-function ()
22141 "Compute a fill prefix for the current line.
22142 Return fill prefix, as a string, or nil if current line isn't
22143 meant to be filled."
22144 (let (prefix)
22145 (catch 'exit
22146 (when (derived-mode-p 'message-mode)
22147 (save-excursion
22148 (beginning-of-line)
22149 (cond ((or (not (message-in-body-p))
22150 (looking-at orgtbl-line-start-regexp))
22151 (throw 'exit nil))
22152 ((looking-at message-cite-prefix-regexp)
22153 (throw 'exit (match-string-no-properties 0)))
22154 ((looking-at org-outline-regexp)
22155 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22156 (org-with-wide-buffer
22157 (let* ((p (line-beginning-position))
22158 (element (save-excursion
22159 (beginning-of-line)
22160 (or (ignore-errors (org-element-at-point))
22161 (user-error "An element cannot be parsed line %d"
22162 (line-number-at-pos (point))))))
22163 (type (org-element-type element))
22164 (post-affiliated (org-element-property :post-affiliated element)))
22165 (unless (and post-affiliated (< p post-affiliated))
22166 (case type
22168 (footnote-definition "")
22169 ((item plain-list)
22170 (make-string (org-list-item-body-column
22171 (or post-affiliated
22172 (org-element-property :begin element)))
22173 ? ))
22174 (paragraph
22175 ;; Fill prefix is usually the same as the current line,
22176 ;; except if the paragraph is at the beginning of an item.
22177 (let ((parent (org-element-property :parent element)))
22178 (cond ((eq (org-element-type parent) 'item)
22179 (make-string (org-list-item-body-column
22180 (org-element-property :begin parent))
22181 ? ))
22183 (match-string 0))
22184 (t ""))))
22185 (comment-block
22186 ;; Only fill contents if P is within block boundaries.
22187 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22188 (forward-line)
22189 (point)))
22190 (cend (save-excursion
22191 (goto-char (org-element-property :end element))
22193 (line-beginning-position))))
22194 (when (and (>= p cbeg) (< p cend))
22196 (match-string 0)
22197 "")))))))))))
22199 (declare-function message-goto-body "message" ())
22200 (defvar message-cite-prefix-regexp) ; From message.el
22201 (defun org-fill-paragraph (&optional justify)
22202 "Fill element at point, when applicable.
22204 This function only applies to comment blocks, comments, example
22205 blocks and paragraphs. Also, as a special case, re-align table
22206 when point is at one.
22208 If JUSTIFY is non-nil (interactively, with prefix argument),
22209 justify as well. If `sentence-end-double-space' is non-nil, then
22210 period followed by one space does not end a sentence, so don't
22211 break a line there. The variable `fill-column' controls the
22212 width for filling.
22214 For convenience, when point is at a plain list, an item or
22215 a footnote definition, try to fill the first paragraph within."
22216 (interactive)
22217 (if (and (derived-mode-p 'message-mode)
22218 (or (not (message-in-body-p))
22219 (save-excursion (move-beginning-of-line 1)
22220 (looking-at message-cite-prefix-regexp))))
22221 ;; First ensure filling is correct in message-mode.
22222 (let ((fill-paragraph-function
22223 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22224 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22225 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22226 (paragraph-separate
22227 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22228 (fill-paragraph nil))
22229 (with-syntax-table org-mode-transpose-word-syntax-table
22230 ;; Move to end of line in order to get the first paragraph
22231 ;; within a plain list or a footnote definition.
22232 (let ((element (save-excursion
22233 (end-of-line)
22234 (or (ignore-errors (org-element-at-point))
22235 (user-error "An element cannot be parsed line %d"
22236 (line-number-at-pos (point)))))))
22237 ;; First check if point is in a blank line at the beginning of
22238 ;; the buffer. In that case, ignore filling.
22239 (case (org-element-type element)
22240 ;; Use major mode filling function is src blocks.
22241 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22242 ;; Align Org tables, leave table.el tables as-is.
22243 (table-row (org-table-align) t)
22244 (table
22245 (when (eq (org-element-property :type element) 'org)
22246 (save-excursion
22247 (goto-char (org-element-property :post-affiliated element))
22248 (org-table-align)))
22249 t)
22250 (paragraph
22251 ;; Paragraphs may contain `line-break' type objects.
22252 (let ((beg (max (point-min)
22253 (org-element-property :contents-begin element)))
22254 (end (min (point-max)
22255 (org-element-property :contents-end element))))
22256 ;; Do nothing if point is at an affiliated keyword.
22257 (if (< (line-end-position) beg) t
22258 (when (derived-mode-p 'message-mode)
22259 ;; In `message-mode', do not fill following citation
22260 ;; in current paragraph nor text before message body.
22261 (let ((body-start (save-excursion (message-goto-body))))
22262 (when body-start (setq beg (max body-start beg))))
22263 (when (save-excursion
22264 (re-search-forward
22265 (concat "^" message-cite-prefix-regexp) end t))
22266 (setq end (match-beginning 0))))
22267 ;; Fill paragraph, taking line breaks into account.
22268 ;; For that, slice the paragraph using line breaks as
22269 ;; separators, and fill the parts in reverse order to
22270 ;; avoid messing with markers.
22271 (save-excursion
22272 (goto-char end)
22273 (mapc
22274 (lambda (pos)
22275 (fill-region-as-paragraph pos (point) justify)
22276 (goto-char pos))
22277 ;; Find the list of ending positions for line breaks
22278 ;; in the current paragraph. Add paragraph
22279 ;; beginning to include first slice.
22280 (nreverse
22281 (cons beg
22282 (org-element-map
22283 (org-element--parse-objects
22284 beg end nil (org-element-restriction 'paragraph))
22285 'line-break
22286 (lambda (lb) (org-element-property :end lb)))))))
22287 t)))
22288 ;; Contents of `comment-block' type elements should be
22289 ;; filled as plain text, but only if point is within block
22290 ;; markers.
22291 (comment-block
22292 (let* ((case-fold-search t)
22293 (beg (save-excursion
22294 (goto-char (org-element-property :begin element))
22296 (forward-line)
22297 (point)))
22298 (end (save-excursion
22299 (goto-char (org-element-property :end element))
22301 (line-beginning-position))))
22302 (when (and (>= (point) beg) (< (point) end))
22303 (fill-region-as-paragraph
22304 (save-excursion
22305 (end-of-line)
22307 (line-beginning-position))
22308 (save-excursion
22309 (beginning-of-line)
22311 (line-beginning-position))
22312 justify)))
22313 t)
22314 ;; Fill comments.
22315 (comment (fill-comment-paragraph justify))
22316 ;; Ignore every other element.
22317 (otherwise t))))))
22319 (defun org-auto-fill-function ()
22320 "Auto-fill function."
22321 ;; Check if auto-filling is meaningful.
22322 (let ((fc (current-fill-column)))
22323 (when (and fc (> (current-column) fc))
22324 (let* ((fill-prefix (org-adaptive-fill-function))
22325 ;; Enforce empty fill prefix, if required. Otherwise, it
22326 ;; will be computed again.
22327 (adaptive-fill-mode (not (equal fill-prefix ""))))
22328 (when fill-prefix (do-auto-fill))))))
22330 (defun org-comment-line-break-function (&optional soft)
22331 "Break line at point and indent, continuing comment if within one.
22332 The inserted newline is marked hard if variable
22333 `use-hard-newlines' is true, unless optional argument SOFT is
22334 non-nil."
22336 (save-excursion (forward-char -1) (delete-horizontal-space))
22337 (delete-horizontal-space)
22338 (indent-to-left-margin)
22339 (insert-before-markers-and-inherit fill-prefix))
22342 ;;; Comments
22344 ;; Org comments syntax is quite complex. It requires the entire line
22345 ;; to be just a comment. Also, even with the right syntax at the
22346 ;; beginning of line, some some elements (i.e. verse-block or
22347 ;; example-block) don't accept comments. Usual Emacs comment commands
22348 ;; cannot cope with those requirements. Therefore, Org replaces them.
22350 ;; Org still relies on `comment-dwim', but cannot trust
22351 ;; `comment-only-p'. So, `comment-region-function' and
22352 ;; `uncomment-region-function' both point
22353 ;; to`org-comment-or-uncomment-region'. Eventually,
22354 ;; `org-insert-comment' takes care of insertion of comments at the
22355 ;; beginning of line.
22357 ;; `org-setup-comments-handling' install comments related variables
22358 ;; during `org-mode' initialization.
22360 (defun org-setup-comments-handling ()
22361 (interactive)
22362 (org-set-local 'comment-use-syntax nil)
22363 (org-set-local 'comment-start "# ")
22365 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22366 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22367 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22369 (defun org-insert-comment ()
22370 "Insert an empty comment above current line.
22371 If the line is empty, insert comment at its beginning."
22372 (beginning-of-line)
22374 (org-indent-line)
22375 (insert "# "))
22377 (defvar comment-empty-lines) ; From newcomment.el.
22378 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22379 "Comment or uncomment each non-blank line in the region.
22380 Uncomment each non-blank line between BEG and END if it only
22381 contains commented lines. Otherwise, comment them."
22382 (save-restriction
22383 ;; Restrict region
22384 (narrow-to-region (save-excursion (goto-char beg)
22386 (line-beginning-position))
22387 (save-excursion (goto-char end)
22389 (line-end-position)))
22390 (let ((uncommentp
22391 ;; UNCOMMENTP is non-nil when every non blank line between
22392 ;; BEG and END is a comment.
22393 (save-excursion
22394 (goto-char (point-min))
22395 (while (and (not (eobp))
22396 (let ((element (org-element-at-point)))
22397 (and (eq (org-element-type element) 'comment)
22398 (goto-char (min (point-max)
22399 (org-element-property
22400 :end element)))))))
22401 (eobp))))
22402 (if uncommentp
22403 ;; Only blank lines and comments in region: uncomment it.
22404 (save-excursion
22405 (goto-char (point-min))
22406 (while (not (eobp))
22408 (replace-match "" nil nil nil 1))
22409 (forward-line)))
22410 ;; Comment each line in region.
22411 (let ((min-indent (point-max)))
22412 ;; First find the minimum indentation across all lines.
22413 (save-excursion
22414 (goto-char (point-min))
22415 (while (and (not (eobp)) (not (zerop min-indent)))
22417 (setq min-indent (min min-indent (current-indentation))))
22418 (forward-line)))
22419 ;; Then loop over all lines.
22420 (save-excursion
22421 (goto-char (point-min))
22422 (while (not (eobp))
22424 ;; Don't get fooled by invisible text (e.g. link path)
22425 ;; when moving to column MIN-INDENT.
22426 (let ((buffer-invisibility-spec nil))
22427 (org-move-to-column min-indent t))
22428 (insert comment-start))
22429 (forward-line))))))))
22432 ;;; Planning
22434 ;; This section contains tools to operate on timestamp objects, as
22435 ;; returned by, e.g. `org-element-context'.
22437 (defun org-timestamp-has-time-p (timestamp)
22438 "Non-nil when TIMESTAMP has a time specified."
22439 (org-element-property :hour-start timestamp))
22441 (defun org-timestamp-format (timestamp format &optional end utc)
22442 "Format a TIMESTAMP element into a string.
22444 FORMAT is a format specifier to be passed to
22445 `format-time-string'.
22447 When optional argument END is non-nil, use end of date-range or
22448 time-range, if possible.
22450 When optional argument UTC is non-nil, time will be expressed as
22451 Universal Time."
22452 (format-time-string
22453 format
22454 (apply 'encode-time
22455 (cons 0
22456 (mapcar
22457 (lambda (prop) (or (org-element-property prop timestamp) 0))
22458 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22459 '(:minute-start :hour-start :day-start :month-start
22460 :year-start)))))
22461 utc))
22463 (defun org-timestamp-split-range (timestamp &optional end)
22464 "Extract a timestamp object from a date or time range.
22466 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22467 the end of the range. Otherwise, extract its start.
22469 Return a new timestamp object sharing the same parent as
22470 TIMESTAMP."
22471 (let ((type (org-element-property :type timestamp)))
22472 (if (memq type '(active inactive diary)) timestamp
22473 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22474 ;; Set new type.
22475 (org-element-put-property
22476 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22477 ;; Copy start properties over end properties if END is
22478 ;; non-nil. Otherwise, copy end properties over `start' ones.
22479 (let ((p-alist '((:minute-start . :minute-end)
22480 (:hour-start . :hour-end)
22481 (:day-start . :day-end)
22482 (:month-start . :month-end)
22483 (:year-start . :year-end))))
22484 (dolist (p-cell p-alist)
22485 (org-element-put-property
22486 split-ts
22487 (funcall (if end 'car 'cdr) p-cell)
22488 (org-element-property
22489 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22490 ;; Eventually refresh `:raw-value'.
22491 (org-element-put-property split-ts :raw-value nil)
22492 (org-element-put-property
22493 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22495 (defun org-timestamp-translate (timestamp &optional boundary)
22496 "Apply `org-translate-time' on a TIMESTAMP object.
22497 When optional argument BOUNDARY is non-nil, it is either the
22498 symbol `start' or `end'. In this case, only translate the
22499 starting or ending part of TIMESTAMP if it is a date or time
22500 range. Otherwise, translate both parts."
22501 (if (and (not boundary)
22502 (memq (org-element-property :type timestamp)
22503 '(active-range inactive-range)))
22504 (concat
22505 (org-translate-time
22506 (org-element-property :raw-value
22507 (org-timestamp-split-range timestamp)))
22508 "--"
22509 (org-translate-time
22510 (org-element-property :raw-value
22511 (org-timestamp-split-range timestamp t))))
22512 (org-translate-time
22513 (org-element-property
22514 :raw-value
22515 (if (not boundary) timestamp
22516 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22520 ;;; Other stuff.
22522 (defun org-toggle-fixed-width-section (arg)
22523 "Toggle the fixed-width export.
22524 If there is no active region, the QUOTE keyword at the current headline is
22525 inserted or removed. When present, it causes the text between this headline
22526 and the next to be exported as fixed-width text, and unmodified.
22527 If there is an active region, this command adds or removes a colon as the
22528 first character of this line. If the first character of a line is a colon,
22529 this line is also exported in fixed-width font."
22530 (interactive "P")
22531 (let* ((cc 0)
22532 (regionp (org-region-active-p))
22533 (beg (if regionp (region-beginning) (point)))
22534 (end (if regionp (region-end)))
22535 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22536 (case-fold-search nil)
22538 off)
22539 (if regionp
22540 (save-excursion
22541 (goto-char beg)
22542 (setq cc (current-column))
22543 (beginning-of-line 1)
22544 (setq off (looking-at re))
22545 (while (> nlines 0)
22546 (setq nlines (1- nlines))
22547 (beginning-of-line 1)
22548 (cond
22549 (arg
22550 (org-move-to-column cc t)
22552 (forward-line -1))
22553 ((and off (looking-at re))
22554 (replace-match "" t t nil 1))
22555 ((not off) (org-move-to-column cc t) (insert ": ")))
22556 (forward-line 1)))
22557 (save-excursion
22558 (org-back-to-heading)
22559 (cond
22560 ((looking-at (format org-heading-keyword-regexp-format
22561 org-quote-string))
22562 (goto-char (match-end 1))
22563 (looking-at (concat " +" org-quote-string))
22564 (replace-match "" t t)
22565 (when (eolp) (insert " ")))
22566 ((looking-at org-outline-regexp)
22567 (goto-char (match-end 0))
22568 (insert org-quote-string " ")))))))
22570 (defun org-reftex-citation ()
22571 "Use reftex-citation to insert a citation into the buffer.
22572 This looks for a line like
22574 #+BIBLIOGRAPHY: foo plain option:-d
22576 and derives from it that foo.bib is the bibliography file relevant
22577 for this document. It then installs the necessary environment for RefTeX
22578 to work in this buffer and calls `reftex-citation' to insert a citation
22579 into the buffer.
22581 Export of such citations to both LaTeX and HTML is handled by the contributed
22582 package ox-bibtex by Taru Karttunen."
22583 (interactive)
22584 (let ((reftex-docstruct-symbol 'rds)
22586 rds bib)
22587 (save-excursion
22588 (save-restriction
22589 (widen)
22590 (let ((case-fold-search t)
22592 (if (not (save-excursion
22593 (or (re-search-forward re nil t)
22594 (re-search-backward re nil t))))
22595 (error "No bibliography defined in file")
22596 (setq bib (concat (match-string 1) ".bib")
22597 rds (list (list 'bib bib)))))))
22598 (call-interactively 'reftex-citation)))
22600 ;;;; Functions extending outline functionality
22602 (defun org-beginning-of-line (&optional arg)
22603 "Go to the beginning of the current line. If that is invisible, continue
22604 to a visible line beginning. This makes the function of C-a more intuitive.
22605 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22606 first attempt, and only move to after the tags when the cursor is already
22607 beyond the end of the headline."
22608 (interactive "P")
22609 (let ((pos (point))
22610 (special (if (consp org-special-ctrl-a/e)
22611 (car org-special-ctrl-a/e)
22612 org-special-ctrl-a/e))
22613 refpos)
22614 (if (org-bound-and-true-p visual-line-mode)
22615 (beginning-of-visual-line 1)
22616 (beginning-of-line 1))
22617 (if (and arg (fboundp 'move-beginning-of-line))
22618 (call-interactively 'move-beginning-of-line)
22619 (if (bobp)
22620 nil
22621 (backward-char 1)
22622 (if (org-truely-invisible-p)
22623 (while (and (not (bobp)) (org-truely-invisible-p))
22624 (backward-char 1)
22625 (beginning-of-line 1))
22626 (forward-char 1))))
22627 (when special
22628 (cond
22629 ((and (looking-at org-complex-heading-regexp)
22630 (= (char-after (match-end 1)) ?\ ))
22631 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22632 (point-at-eol)))
22633 (goto-char
22634 (if (eq special t)
22635 (cond ((> pos refpos) refpos)
22636 ((= pos (point)) refpos)
22637 (t (point)))
22638 (cond ((> pos (point)) (point))
22639 ((not (eq last-command this-command)) (point))
22640 (t refpos)))))
22641 ((org-at-item-p)
22642 ;; Being at an item and not looking at an the item means point
22643 ;; was previously moved to beginning of a visual line, which
22644 ;; doesn't contain the item. Therefore, do nothing special,
22645 ;; just stay here.
22646 (when (looking-at org-list-full-item-re)
22647 ;; Set special position at first white space character after
22648 ;; bullet, and check-box, if any.
22649 (let ((after-bullet
22650 (let ((box (match-end 3)))
22651 (if (not box) (match-end 1)
22652 (let ((after (char-after box)))
22653 (if (and after (= after ? )) (1+ box) box))))))
22654 ;; Special case: Move point to special position when
22655 ;; currently after it or at beginning of line.
22656 (if (eq special t)
22657 (when (or (> pos after-bullet) (= (point) pos))
22658 (goto-char after-bullet))
22659 ;; Reversed case: Move point to special position when
22660 ;; point was already at beginning of line and command is
22661 ;; repeated.
22662 (when (and (= (point) pos) (eq last-command this-command))
22663 (goto-char after-bullet))))))))
22664 (org-no-warnings
22665 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22666 (setq disable-point-adjustment
22667 (or (not (invisible-p (point)))
22668 (not (invisible-p (max (point-min) (1- (point))))))))
22670 (defun org-end-of-line (&optional arg)
22671 "Go to the end of the line.
22672 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22673 tags on the first attempt, and only move to after the tags when
22674 the cursor is already beyond the end of the headline."
22675 (interactive "P")
22676 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22677 org-special-ctrl-a/e))
22678 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22679 'end-of-visual-line)
22680 ((fboundp 'move-end-of-line) 'move-end-of-line)
22681 (t 'end-of-line))))
22682 (if (or (not special) arg) (call-interactively move-fun)
22683 (let* ((element (save-excursion (beginning-of-line)
22684 (org-element-at-point)))
22685 (type (org-element-type element)))
22686 (cond
22687 ((memq type '(headline inlinetask))
22688 (let ((pos (point)))
22689 (beginning-of-line 1)
22691 (if (eq special t)
22692 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22693 (goto-char (match-beginning 1))
22694 (goto-char (match-end 0)))
22695 (if (or (< pos (match-end 0))
22696 (not (eq this-command last-command)))
22697 (goto-char (match-end 0))
22698 (goto-char (match-beginning 1))))
22699 (call-interactively move-fun))))
22700 ((org-element-property :hiddenp element)
22701 ;; If element is hidden, `move-end-of-line' would put point
22702 ;; after it. Use `end-of-line' to stay on current line.
22703 (call-interactively 'end-of-line))
22704 (t (call-interactively move-fun)))))
22705 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22706 (setq disable-point-adjustment
22707 (or (not (invisible-p (point)))
22708 (not (invisible-p (max (point-min) (1- (point))))))))
22710 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22711 (define-key org-mode-map "\C-e" 'org-end-of-line)
22713 (defun org-backward-sentence (&optional arg)
22714 "Go to beginning of sentence, or beginning of table field.
22715 This will call `backward-sentence' or `org-table-beginning-of-field',
22716 depending on context."
22717 (interactive "P")
22718 (cond
22719 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22720 (t (call-interactively 'backward-sentence))))
22722 (defun org-forward-sentence (&optional arg)
22723 "Go to end of sentence, or end of table field.
22724 This will call `forward-sentence' or `org-table-end-of-field',
22725 depending on context."
22726 (interactive "P")
22727 (cond
22728 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22729 (t (call-interactively 'forward-sentence))))
22731 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22732 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22734 (defun org-kill-line (&optional arg)
22735 "Kill line, to tags or end of line."
22736 (interactive "P")
22737 (cond
22738 ((or (not org-special-ctrl-k)
22739 (bolp)
22740 (not (org-at-heading-p)))
22741 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22742 org-ctrl-k-protect-subtree)
22743 (if (or (eq org-ctrl-k-protect-subtree 'error)
22744 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22745 (user-error "C-k aborted as it would kill a hidden subtree")))
22746 (call-interactively
22747 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22749 (kill-region (point) (match-beginning 1))
22750 (org-set-tags nil t))
22751 (t (kill-region (point) (point-at-eol)))))
22753 (define-key org-mode-map "\C-k" 'org-kill-line)
22755 (defun org-yank (&optional arg)
22756 "Yank. If the kill is a subtree, treat it specially.
22757 This command will look at the current kill and check if is a single
22758 subtree, or a series of subtrees[1]. If it passes the test, and if the
22759 cursor is at the beginning of a line or after the stars of a currently
22760 empty headline, then the yank is handled specially. How exactly depends
22761 on the value of the following variables, both set by default.
22763 org-yank-folded-subtrees
22764 When set, the subtree(s) will be folded after insertion, but only
22765 if doing so would now swallow text after the yanked text.
22767 org-yank-adjusted-subtrees
22768 When set, the subtree will be promoted or demoted in order to
22769 fit into the local outline tree structure, which means that the level
22770 will be adjusted so that it becomes the smaller one of the two
22771 *visible* surrounding headings.
22773 Any prefix to this command will cause `yank' to be called directly with
22775 will just
22776 plainly yank the text as it is.
22778 \[1] The test checks if the first non-white line is a heading
22779 and if there are no other headings with fewer stars."
22780 (interactive "P")
22781 (org-yank-generic 'yank arg))
22783 (defun org-yank-generic (command arg)
22784 "Perform some yank-like command.
22786 This function implements the behavior described in the `org-yank'
22787 documentation. However, it has been generalized to work for any
22788 interactive command with similar behavior."
22790 ;; pretend to be command COMMAND
22791 (setq this-command command)
22793 (if arg
22794 (call-interactively command)
22796 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22797 (and (org-kill-is-subtree-p)
22798 (or (bolp)
22800 (string-match
22802 (buffer-substring (point-at-bol) (point)))))))
22803 swallowp)
22804 (cond
22805 ((and subtreep org-yank-folded-subtrees)
22806 (let ((beg (point))
22807 end)
22808 (if (and subtreep org-yank-adjusted-subtrees)
22809 (org-paste-subtree nil nil 'for-yank)
22810 (call-interactively command))
22812 (setq end (point))
22813 (goto-char beg)
22814 (when (and (bolp) subtreep
22815 (not (setq swallowp
22816 (org-yank-folding-would-swallow-text beg end))))
22817 (org-with-limited-levels
22818 (or (looking-at org-outline-regexp)
22819 (re-search-forward org-outline-regexp-bol end t))
22820 (while (and (< (point) end) (looking-at org-outline-regexp))
22821 (hide-subtree)
22822 (org-cycle-show-empty-lines 'folded)
22823 (condition-case nil
22824 (outline-forward-same-level 1)
22825 (error (goto-char end))))))
22826 (when swallowp
22827 (message
22828 "Inserted text not folded because that would swallow text"))
22830 (goto-char end)
22832 (beginning-of-line 1)
22833 (push-mark beg 'nomsg)))
22834 ((and subtreep org-yank-adjusted-subtrees)
22835 (let ((beg (point-at-bol)))
22836 (org-paste-subtree nil nil 'for-yank)
22837 (push-mark beg 'nomsg)))
22838 (t
22839 (call-interactively command))))))
22841 (defun org-yank-folding-would-swallow-text (beg end)
22842 "Would hide-subtree at BEG swallow any text after END?"
22843 (let (level)
22844 (org-with-limited-levels
22845 (save-excursion
22846 (goto-char beg)
22847 (when (or (looking-at org-outline-regexp)
22848 (re-search-forward org-outline-regexp-bol end t))
22849 (setq level (org-outline-level)))
22850 (goto-char end)
22852 (if (or (eobp)
22853 (and (bolp) (looking-at org-outline-regexp)
22854 (<= (org-outline-level) level)))
22855 nil ; Nothing would be swallowed
22856 t))))) ; something would swallow
22858 (define-key org-mode-map "\C-y" 'org-yank)
22860 (defun org-truely-invisible-p ()
22861 "Check if point is at a character currently not visible.
22862 This version does not only check the character property, but also
22863 `visible-mode'."
22864 ;; Early versions of noutline don't have `outline-invisible-p'.
22865 (if (org-bound-and-true-p visible-mode)
22866 nil
22867 (outline-invisible-p)))
22869 (defun org-invisible-p2 ()
22870 "Check if point is at a character currently not visible."
22871 (save-excursion
22872 (if (and (eolp) (not (bobp))) (backward-char 1))
22873 ;; Early versions of noutline don't have `outline-invisible-p'.
22874 (outline-invisible-p)))
22876 (defun org-back-to-heading (&optional invisible-ok)
22877 "Call `outline-back-to-heading', but provide a better error message."
22878 (condition-case nil
22879 (outline-back-to-heading invisible-ok)
22880 (error (error "Before first headline at position %d in buffer %s"
22881 (point) (current-buffer)))))
22883 (defun org-before-first-heading-p ()
22884 "Before first heading?"
22885 (save-excursion
22886 (end-of-line)
22887 (null (re-search-backward org-outline-regexp-bol nil t))))
22889 (defun org-at-heading-p (&optional ignored)
22890 (outline-on-heading-p t))
22891 ;; Compatibility alias with Org versions < 7.8.03
22892 (defalias 'org-on-heading-p 'org-at-heading-p)
22894 (defun org-at-comment-p nil
22895 "Is cursor in a line starting with a # character?"
22896 (save-excursion
22897 (beginning-of-line)
22898 (looking-at "^#")))
22900 (defun org-at-drawer-p nil
22901 "Is cursor at a drawer keyword?"
22902 (save-excursion
22903 (move-beginning-of-line 1)
22904 (looking-at org-drawer-regexp)))
22906 (defun org-at-block-p nil
22907 "Is cursor at a block keyword?"
22908 (save-excursion
22909 (move-beginning-of-line 1)
22910 (looking-at org-block-regexp)))
22912 (defun org-point-at-end-of-empty-headline ()
22913 "If point is at the end of an empty headline, return t, else nil.
22914 If the heading only contains a TODO keyword, it is still still considered
22915 empty."
22917 (when org-todo-line-regexp
22918 (save-excursion
22919 (beginning-of-line 1)
22920 (let ((case-fold-search nil))
22921 (looking-at org-todo-line-regexp)
22922 (string= (match-string 3) ""))))))
22924 (defun org-at-heading-or-item-p ()
22925 (or (org-at-heading-p) (org-at-item-p)))
22927 (defun org-at-target-p ()
22928 (or (org-in-regexp org-radio-target-regexp)
22929 (org-in-regexp org-target-regexp)))
22930 ;; Compatibility alias with Org versions < 7.8.03
22931 (defalias 'org-on-target-p 'org-at-target-p)
22933 (defun org-up-heading-all (arg)
22934 "Move to the heading line of which the present line is a subheading.
22935 This function considers both visible and invisible heading lines.
22936 With argument, move up ARG levels."
22937 (if (fboundp 'outline-up-heading-all)
22938 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22939 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22941 (defun org-up-heading-safe ()
22942 "Move to the heading line of which the present line is a subheading.
22943 This version will not throw an error. It will return the level of the
22944 headline found, or nil if no higher level is found.
22946 Also, this function will be a lot faster than `outline-up-heading',
22947 because it relies on stars being the outline starters. This can really
22948 make a significant difference in outlines with very many siblings."
22949 (let (start-level re)
22950 (org-back-to-heading t)
22951 (setq start-level (funcall outline-level))
22952 (if (equal start-level 1)
22953 nil
22955 (if (re-search-backward re nil t)
22956 (funcall outline-level)))))
22958 (defun org-first-sibling-p ()
22959 "Is this heading the first child of its parents?"
22960 (interactive)
22961 (let ((re org-outline-regexp-bol)
22962 level l)
22963 (unless (org-at-heading-p t)
22964 (user-error "Not at a heading"))
22965 (setq level (funcall outline-level))
22966 (save-excursion
22967 (if (not (re-search-backward re nil t))
22968 t
22969 (setq l (funcall outline-level))
22970 (< l level)))))
22972 (defun org-goto-sibling (&optional previous)
22973 "Goto the next sibling, even if it is invisible.
22974 When PREVIOUS is set, go to the previous sibling instead. Returns t
22975 when a sibling was found. When none is found, return nil and don't
22976 move point."
22977 (let ((fun (if previous 're-search-backward 're-search-forward))
22978 (pos (point))
22979 (re org-outline-regexp-bol)
22980 level l)
22981 (when (condition-case nil (org-back-to-heading t) (error nil))
22982 (setq level (funcall outline-level))
22983 (catch 'exit
22984 (or previous (forward-char 1))
22985 (while (funcall fun re nil t)
22986 (setq l (funcall outline-level))
22987 (when (< l level) (goto-char pos) (throw 'exit nil))
22988 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22989 (goto-char pos)
22990 nil))))
22992 (defun org-show-siblings ()
22993 "Show all siblings of the current headline."
22994 (save-excursion
22995 (while (org-goto-sibling) (org-flag-heading nil)))
22996 (save-excursion
22997 (while (org-goto-sibling 'previous)
22998 (org-flag-heading nil))))
23000 (defun org-goto-first-child ()
23001 "Goto the first child, even if it is invisible.
23002 Return t when a child was found. Otherwise don't move point and
23003 return nil."
23004 (let (level (pos (point)) (re org-outline-regexp-bol))
23005 (when (condition-case nil (org-back-to-heading t) (error nil))
23006 (setq level (outline-level))
23007 (forward-char 1)
23008 (if (and (re-search-forward re nil t) (> (outline-level) level))
23009 (progn (goto-char (match-beginning 0)) t)
23010 (goto-char pos) nil))))
23012 (defun org-show-hidden-entry ()
23013 "Show an entry where even the heading is hidden."
23014 (save-excursion
23015 (org-show-entry)))
23017 (defun org-flag-heading (flag &optional entry)
23018 "Flag the current heading. FLAG non-nil means make invisible.
23019 When ENTRY is non-nil, show the entire entry."
23020 (save-excursion
23021 (org-back-to-heading t)
23022 ;; Check if we should show the entire entry
23023 (if entry
23024 (progn
23025 (org-show-entry)
23026 (save-excursion
23027 (and (outline-next-heading)
23028 (org-flag-heading nil))))
23029 (outline-flag-region (max (point-min) (1- (point)))
23030 (save-excursion (outline-end-of-heading) (point))
23031 flag))))
23033 (defun org-get-next-sibling ()
23034 "Move to next heading of the same level, and return point.
23035 If there is no such heading, return nil.
23036 This is like outline-next-sibling, but invisible headings are ok."
23037 (let ((level (funcall outline-level)))
23038 (outline-next-heading)
23039 (while (and (not (eobp)) (> (funcall outline-level) level))
23040 (outline-next-heading))
23041 (if (or (eobp) (< (funcall outline-level) level))
23042 nil
23043 (point))))
23045 (defun org-get-last-sibling ()
23046 "Move to previous heading of the same level, and return point.
23047 If there is no such heading, return nil."
23048 (let ((opoint (point))
23049 (level (funcall outline-level)))
23050 (outline-previous-heading)
23051 (when (and (/= (point) opoint) (outline-on-heading-p t))
23052 (while (and (> (funcall outline-level) level)
23053 (not (bobp)))
23054 (outline-previous-heading))
23055 (if (< (funcall outline-level) level)
23056 nil
23057 (point)))))
23059 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23060 "Goto to the end of a subtree."
23061 ;; This contains an exact copy of the original function, but it uses
23062 ;; `org-back-to-heading', to make it work also in invisible
23063 ;; trees. And is uses an invisible-ok argument.
23064 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23065 ;; Furthermore, when used inside Org, finding the end of a large subtree
23066 ;; with many children and grandchildren etc, this can be much faster
23067 ;; than the outline version.
23068 (org-back-to-heading invisible-ok)
23069 (let ((first t)
23070 (level (funcall outline-level)))
23071 (if (and (derived-mode-p 'org-mode) (< level 1000))
23072 ;; A true heading (not a plain list item), in Org-mode
23073 ;; This means we can easily find the end by looking
23074 ;; only for the right number of stars. Using a regexp to do
23075 ;; this is so much faster than using a Lisp loop.
23077 (forward-char 1)
23078 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23079 ;; something else, do it the slow way
23080 (while (and (not (eobp))
23081 (or first (> (funcall outline-level) level)))
23082 (setq first nil)
23083 (outline-next-heading)))
23084 (unless to-heading
23086 (progn
23087 ;; Go to end of line before heading
23088 (forward-char -1)
23090 ;; leave blank line before heading
23091 (forward-char -1))))))
23092 (point))
23094 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23095 "Use Org version in org-mode, for dramatic speed-up."
23096 (if (derived-mode-p 'org-mode)
23097 (progn
23098 (org-end-of-subtree nil t)
23099 (unless (eobp) (backward-char 1)))
23100 ad-do-it))
23102 (defun org-end-of-meta-data-and-drawers ()
23103 "Jump to the first text after meta data and drawers in the current entry.
23104 This will move over empty lines, lines with planning time stamps,
23105 clocking lines, and drawers."
23106 (org-back-to-heading t)
23107 (let ((end (save-excursion (outline-next-heading) (point)))
23110 (forward-line 1)
23111 (while (re-search-forward re end t)
23112 (if (not (match-end 1))
23113 ;; empty or planning line
23114 (forward-line 1)
23115 ;; a drawer, find the end
23117 (forward-line 1)))
23119 (point)))
23121 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23122 "Move forward to the ARG'th subheading at same level as this one.
23123 Stop at the first and last subheadings of a superior heading.
23124 Normally this only looks at visible headings, but when INVISIBLE-OK is
23125 non-nil it will also look at invisible ones."
23126 (interactive "p")
23127 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23128 (if (and arg (< arg 0))
23129 (goto-char (point-min))
23130 (outline-next-heading))
23131 (org-at-heading-p)
23132 (let ((level (- (match-end 0) (match-beginning 0) 1))
23133 (f (if (and arg (< arg 0))
23134 're-search-backward
23135 're-search-forward))
23136 (count (if arg (abs arg) 1))
23137 (result (point)))
23138 (while (and (prog1 (> count 0)
23139 (forward-char (if (and arg (< arg 0)) -1 1)))
23140 (funcall f org-outline-regexp-bol nil 'move))
23141 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23142 (cond ((< l level) (setq count 0))
23143 ((and (= l level)
23144 (or invisible-ok
23145 (progn
23146 (goto-char (line-beginning-position))
23147 (not (outline-invisible-p)))))
23148 (setq count (1- count))
23149 (when (eq l level)
23150 (setq result (point)))))))
23151 (goto-char result))
23152 (beginning-of-line 1)))
23154 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23155 "Move backward to the ARG'th subheading at same level as this one.
23156 Stop at the first and last subheadings of a superior heading."
23157 (interactive "p")
23158 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23160 (defun org-next-block (arg &optional backward block-regexp)
23161 "Jump to the next block.
23162 With a prefix argument ARG, jump forward ARG many source blocks.
23163 When BACKWARD is non-nil, jump to the previous block.
23164 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23165 (interactive "p")
23166 (let ((re (or block-regexp org-block-regexp))
23167 (re-search-fn (or (and backward 're-search-backward)
23168 're-search-forward)))
23169 (if (looking-at re) (forward-char 1))
23170 (condition-case nil
23171 (funcall re-search-fn re nil nil arg)
23172 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23173 (goto-char (match-beginning 0)) (org-show-context)))
23175 (defun org-previous-block (arg &optional block-regexp)
23176 "Jump to the previous block.
23177 With a prefix argument ARG, jump backward ARG many source blocks.
23178 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23179 (interactive "p")
23180 (org-next-block arg t block-regexp))
23182 (defun org-forward-element ()
23183 "Move forward by one element.
23184 Move to the next element at the same level, when possible."
23185 (interactive)
23186 (cond ((eobp) (user-error "Cannot move further down"))
23187 ((org-with-limited-levels (org-at-heading-p))
23188 (let ((origin (point)))
23189 (goto-char (org-end-of-subtree nil t))
23190 (unless (org-with-limited-levels (org-at-heading-p))
23191 (goto-char origin)
23192 (user-error "Cannot move further down"))))
23193 (t
23194 (let* ((elem (org-element-at-point))
23195 (end (org-element-property :end elem))
23196 (parent (org-element-property :parent elem)))
23197 (if (and parent (= (org-element-property :contents-end parent) end))
23198 (goto-char (org-element-property :end parent))
23199 (goto-char end))))))
23201 (defun org-backward-element ()
23202 "Move backward by one element.
23203 Move to the previous element at the same level, when possible."
23204 (interactive)
23205 (cond ((bobp) (user-error "Cannot move further up"))
23206 ((org-with-limited-levels (org-at-heading-p))
23207 ;; At a headline, move to the previous one, if any, or stay
23208 ;; here.
23209 (let ((origin (point)))
23210 (org-with-limited-levels (org-backward-heading-same-level 1))
23211 ;; When current headline has no sibling above, move to its
23212 ;; parent.
23213 (when (= (point) origin)
23214 (or (org-with-limited-levels (org-up-heading-safe))
23215 (progn (goto-char origin)
23216 (user-error "Cannot move further up"))))))
23217 (t
23218 (let* ((trail (org-element-at-point 'keep-trail))
23219 (elem (car trail))
23220 (prev-elem (nth 1 trail))
23221 (beg (org-element-property :begin elem)))
23222 (cond
23223 ;; Move to beginning of current element if point isn't
23224 ;; there already.
23225 ((/= (point) beg) (goto-char beg))
23226 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23227 ((org-before-first-heading-p) (goto-char (point-min)))
23228 (t (org-back-to-heading)))))))
23230 (defun org-up-element ()
23231 "Move to upper element."
23232 (interactive)
23233 (if (org-with-limited-levels (org-at-heading-p))
23234 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23235 (let* ((elem (org-element-at-point))
23236 (parent (org-element-property :parent elem)))
23237 (if parent (goto-char (org-element-property :begin parent))
23238 (if (org-with-limited-levels (org-before-first-heading-p))
23239 (user-error "No surrounding element")
23240 (org-with-limited-levels (org-back-to-heading)))))))
23242 (defvar org-element-greater-elements)
23243 (defun org-down-element ()
23244 "Move to inner element."
23245 (interactive)
23246 (let ((element (org-element-at-point)))
23247 (cond
23248 ((memq (org-element-type element) '(plain-list table))
23249 (goto-char (org-element-property :contents-begin element))
23250 (forward-char))
23251 ((memq (org-element-type element) org-element-greater-elements)
23252 ;; If contents are hidden, first disclose them.
23253 (when (org-element-property :hiddenp element) (org-cycle))
23254 (goto-char (or (org-element-property :contents-begin element)
23255 (user-error "No content for this element"))))
23256 (t (user-error "No inner element")))))
23258 (defun org-drag-element-backward ()
23259 "Move backward element at point."
23260 (interactive)
23261 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23262 (let* ((trail (org-element-at-point 'keep-trail))
23263 (elem (car trail))
23264 (prev-elem (nth 1 trail)))
23265 ;; Error out if no previous element or previous element is
23266 ;; a parent of the current one.
23267 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23268 (user-error "Cannot drag element backward")
23269 (let ((pos (point)))
23270 (org-element-swap-A-B prev-elem elem)
23271 (goto-char (+ (org-element-property :begin prev-elem)
23272 (- pos (org-element-property :begin elem)))))))))
23274 (defun org-drag-element-forward ()
23275 "Move forward element at point."
23276 (interactive)
23277 (let* ((pos (point))
23278 (elem (org-element-at-point)))
23279 (when (= (point-max) (org-element-property :end elem))
23280 (user-error "Cannot drag element forward"))
23281 (goto-char (org-element-property :end elem))
23282 (let ((next-elem (org-element-at-point)))
23283 (when (or (org-element-nested-p elem next-elem)
23284 (and (eq (org-element-type next-elem) 'headline)
23285 (not (eq (org-element-type elem) 'headline))))
23286 (goto-char pos)
23287 (user-error "Cannot drag element forward"))
23288 ;; Compute new position of point: it's shifted by NEXT-ELEM
23289 ;; body's length (without final blanks) and by the length of
23290 ;; blanks between ELEM and NEXT-ELEM.
23291 (let ((size-next (- (save-excursion
23292 (goto-char (org-element-property :end next-elem))
23294 (forward-line)
23295 ;; Small correction if buffer doesn't end
23296 ;; with a newline character.
23297 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23298 (org-element-property :begin next-elem)))
23299 (size-blank (- (org-element-property :end elem)
23300 (save-excursion
23301 (goto-char (org-element-property :end elem))
23303 (forward-line)
23304 (point)))))
23305 (org-element-swap-A-B elem next-elem)
23306 (goto-char (+ pos size-next size-blank))))))
23308 (defun org-drag-line-forward (arg)
23309 "Drag the line at point ARG lines forward."
23310 (interactive "p")
23311 (dotimes (n (abs arg))
23312 (let ((c (current-column)))
23313 (if (< 0 arg)
23314 (progn
23315 (beginning-of-line 2)
23316 (transpose-lines 1)
23317 (beginning-of-line 0))
23318 (transpose-lines 1)
23319 (beginning-of-line -1))
23320 (org-move-to-column c))))
23322 (defun org-drag-line-backward (arg)
23323 "Drag the line at point ARG lines backward."
23324 (interactive "p")
23325 (org-drag-line-forward (- arg)))
23327 (defun org-mark-element ()
23328 "Put point at beginning of this element, mark at end.
23330 Interactively, if this command is repeated or (in Transient Mark
23331 mode) if the mark is active, it marks the next element after the
23332 ones already marked."
23333 (interactive)
23334 (let (deactivate-mark)
23335 (if (and (org-called-interactively-p 'any)
23336 (or (and (eq last-command this-command) (mark t))
23337 (and transient-mark-mode mark-active)))
23338 (set-mark
23339 (save-excursion
23340 (goto-char (mark))
23341 (goto-char (org-element-property :end (org-element-at-point)))))
23342 (let ((element (org-element-at-point)))
23343 (end-of-line)
23344 (push-mark (org-element-property :end element) t t)
23345 (goto-char (org-element-property :begin element))))))
23347 (defun org-narrow-to-element ()
23348 "Narrow buffer to current element."
23349 (interactive)
23350 (let ((elem (org-element-at-point)))
23351 (cond
23352 ((eq (car elem) 'headline)
23353 (narrow-to-region
23354 (org-element-property :begin elem)
23355 (org-element-property :end elem)))
23356 ((memq (car elem) org-element-greater-elements)
23357 (narrow-to-region
23358 (org-element-property :contents-begin elem)
23359 (org-element-property :contents-end elem)))
23360 (t
23361 (narrow-to-region
23362 (org-element-property :begin elem)
23363 (org-element-property :end elem))))))
23365 (defun org-transpose-element ()
23366 "Transpose current and previous elements, keeping blank lines between.
23367 Point is moved after both elements."
23368 (interactive)
23369 (org-skip-whitespace)
23370 (let ((end (org-element-property :end (org-element-at-point))))
23371 (org-drag-element-backward)
23372 (goto-char end)))
23374 (defun org-unindent-buffer ()
23375 "Un-indent the visible part of the buffer.
23376 Relative indentation (between items, inside blocks, etc.) isn't
23377 modified."
23378 (interactive)
23379 (unless (eq major-mode 'org-mode)
23380 (user-error "Cannot un-indent a buffer not in Org mode"))
23381 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23382 unindent-tree ; For byte-compiler.
23383 (unindent-tree
23384 (function
23385 (lambda (contents)
23386 (mapc
23387 (lambda (element)
23388 (if (memq (org-element-type element) '(headline section))
23389 (funcall unindent-tree (org-element-contents element))
23390 (save-excursion
23391 (save-restriction
23392 (narrow-to-region
23393 (org-element-property :begin element)
23394 (org-element-property :end element))
23395 (org-do-remove-indentation)))))
23396 (reverse contents))))))
23397 (funcall unindent-tree (org-element-contents parse-tree))))
23399 (defun org-show-subtree ()
23400 "Show everything after this heading at deeper levels."
23401 (interactive)
23402 (outline-flag-region
23403 (point)
23404 (save-excursion
23405 (org-end-of-subtree t t))
23406 nil))
23408 (defun org-show-entry ()
23409 "Show the body directly following this heading.
23410 Show the heading too, if it is currently invisible."
23411 (interactive)
23412 (save-excursion
23413 (condition-case nil
23414 (progn
23415 (org-back-to-heading t)
23416 (outline-flag-region
23417 (max (point-min) (1- (point)))
23418 (save-excursion
23419 (if (re-search-forward
23421 (match-beginning 1)
23422 (point-max)))
23423 nil)
23424 (org-cycle-hide-drawers 'children))
23425 (error nil))))
23427 (defun org-make-options-regexp (kwds &optional extra)
23428 "Make a regular expression for keyword lines."
23429 (concat
23435 ;; Make isearch reveal the necessary context
23436 (defun org-isearch-end ()
23437 "Reveal context after isearch exits."
23438 (when isearch-success ; only if search was successful
23439 (if (featurep 'xemacs)
23440 ;; Under XEmacs, the hook is run in the correct place,
23441 ;; we directly show the context.
23442 (org-show-context 'isearch)
23443 ;; In Emacs the hook runs *before* restoring the overlays.
23444 ;; So we have to use a one-time post-command-hook to do this.
23445 ;; (Emacs 22 has a special variable, see function `org-mode')
23446 (unless (and (boundp 'isearch-mode-end-hook-quit)
23447 isearch-mode-end-hook-quit)
23448 ;; Only when the isearch was not quitted.
23449 (org-add-hook 'post-command-hook 'org-isearch-post-command
23450 'append 'local)))
23451 (org-fix-ellipsis-at-bol)))
23453 (defun org-isearch-post-command ()
23454 "Remove self from hook, and show context."
23455 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23456 (org-show-context 'isearch))
23459 ;;;; Integration with and fixes for other packages
23461 ;;; Imenu support
23463 (defvar org-imenu-markers nil
23464 "All markers currently used by Imenu.")
23465 (make-variable-buffer-local 'org-imenu-markers)
23467 (defun org-imenu-new-marker (&optional pos)
23468 "Return a new marker for use by Imenu, and remember the marker."
23469 (let ((m (make-marker)))
23470 (move-marker m (or pos (point)))
23471 (push m org-imenu-markers)
23472 m))
23474 (defun org-imenu-get-tree ()
23475 "Produce the index for Imenu."
23476 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23477 (setq org-imenu-markers nil)
23478 (let* ((n org-imenu-depth)
23479 (re (concat "^" (org-get-limited-outline-regexp)))
23480 (subs (make-vector (1+ n) nil))
23481 (last-level 0)
23482 m level head0 head)
23483 (save-excursion
23484 (save-restriction
23485 (widen)
23486 (goto-char (point-max))
23487 (while (re-search-backward re nil t)
23488 (setq level (org-reduced-level (funcall outline-level)))
23489 (when (and (<= level n)
23490 (looking-at org-complex-heading-regexp)
23491 (setq head0 (org-match-string-no-properties 4)))
23492 (setq head (org-link-display-format head0)
23493 m (org-imenu-new-marker))
23494 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23495 (if (>= level last-level)
23496 (push (cons head m) (aref subs level))
23497 (push (cons head (aref subs (1+ level))) (aref subs level))
23498 (loop for i from (1+ level) to n do (aset subs i nil)))
23499 (setq last-level level)))))
23500 (aref subs 1)))
23502 (eval-after-load "imenu"
23503 '(progn
23504 (add-hook 'imenu-after-jump-hook
23505 (lambda ()
23506 (if (derived-mode-p 'org-mode)
23507 (org-show-context 'org-goto))))))
23509 (defun org-link-display-format (link)
23510 "Replace a link with its the description.
23511 If there is no description, use the link target."
23512 (save-match-data
23513 (if (string-match org-bracket-link-analytic-regexp link)
23514 (replace-match (if (match-end 5)
23515 (match-string 5 link)
23516 (concat (match-string 1 link)
23517 (match-string 3 link)))
23518 nil t link)
23519 link)))
23521 (defun org-toggle-link-display ()
23522 "Toggle the literal or descriptive display of links."
23523 (interactive)
23524 (if org-descriptive-links
23525 (progn (org-remove-from-invisibility-spec '(org-link))
23526 (org-restart-font-lock)
23527 (setq org-descriptive-links nil))
23528 (progn (add-to-invisibility-spec '(org-link))
23529 (org-restart-font-lock)
23530 (setq org-descriptive-links t))))
23532 ;; Speedbar support
23534 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23535 "Overlay marking the agenda restriction line in speedbar.")
23536 (overlay-put org-speedbar-restriction-lock-overlay
23537 'face 'org-agenda-restriction-lock)
23538 (overlay-put org-speedbar-restriction-lock-overlay
23539 'help-echo "Agendas are currently limited to this item.")
23540 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23542 (defun org-speedbar-set-agenda-restriction ()
23543 "Restrict future agenda commands to the location at point in speedbar.
23545 (interactive)
23546 (require 'org-agenda)
23547 (let (p m tp np dir txt)
23548 (cond
23549 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23550 'org-imenu t))
23551 (setq m (get-text-property p 'org-imenu-marker))
23552 (with-current-buffer (marker-buffer m)
23553 (goto-char m)
23554 (org-agenda-set-restriction-lock 'subtree)))
23555 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23556 'speedbar-function 'speedbar-find-file))
23557 (setq tp (previous-single-property-change
23558 (1+ p) 'speedbar-function)
23559 np (next-single-property-change
23560 tp 'speedbar-function)
23561 dir (speedbar-line-directory)
23562 txt (buffer-substring-no-properties (or tp (point-min))
23563 (or np (point-max))))
23564 (with-current-buffer (find-file-noselect
23565 (let ((default-directory dir))
23566 (expand-file-name txt)))
23567 (unless (derived-mode-p 'org-mode)
23568 (user-error "Cannot restrict to non-Org-mode file"))
23569 (org-agenda-set-restriction-lock 'file)))
23570 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23571 (move-overlay org-speedbar-restriction-lock-overlay
23572 (point-at-bol) (point-at-eol))
23573 (setq current-prefix-arg nil)
23574 (org-agenda-maybe-redo)))
23576 (eval-after-load "speedbar"
23577 '(progn
23578 (speedbar-add-supported-extension ".org")
23579 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23580 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23581 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23582 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23583 (add-hook 'speedbar-visiting-tag-hook
23584 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23586 ;;; Fixes and Hacks for problems with other packages
23588 ;; Make flyspell not check words in links, to not mess up our keymap
23589 (defvar org-element-affiliated-keywords) ; From org-element.el
23590 (defvar org-element-block-name-alist) ; From org-element.el
23591 (defun org-mode-flyspell-verify ()
23592 "Don't let flyspell put overlays at active buttons, or on
23593 {todo,all-time,additional-option-like}-keywords."
23594 (require 'org-element) ; For `org-element-affiliated-keywords'
23595 (let ((pos (max (1- (point)) (point-min)))
23596 (word (thing-at-point 'word)))
23597 (and (not (get-text-property pos 'keymap))
23598 (not (get-text-property pos 'org-no-flyspell))
23599 (not (member word org-todo-keywords-1))
23600 (not (member word org-all-time-keywords))
23601 (not (member word org-options-keywords))
23602 (not (member word (mapcar 'car org-startup-options)))
23603 (not (member-ignore-case word org-element-affiliated-keywords))
23604 (not (member-ignore-case word (org-get-export-keywords)))
23605 (not (member-ignore-case
23606 word (mapcar 'car org-element-block-name-alist)))
23607 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23608 (not (org-in-src-block-p)))))
23610 (defun org-remove-flyspell-overlays-in (beg end)
23611 "Remove flyspell overlays in region."
23612 (and (org-bound-and-true-p flyspell-mode)
23613 (fboundp 'flyspell-delete-region-overlays)
23614 (flyspell-delete-region-overlays beg end))
23615 (add-text-properties beg end '(org-no-flyspell t)))
23617 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23618 (eval-after-load "bookmark"
23619 '(if (boundp 'bookmark-after-jump-hook)
23620 ;; We can use the hook
23621 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23622 ;; Hook not available, use advice
23623 (defadvice bookmark-jump (after org-make-visible activate)
23624 "Make the position visible."
23625 (org-bookmark-jump-unhide))))
23627 ;; Make sure saveplace shows the location if it was hidden
23628 (eval-after-load "saveplace"
23629 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23630 "Make the position visible."
23631 (org-bookmark-jump-unhide)))
23633 ;; Make sure ecb shows the location if it was hidden
23634 (eval-after-load "ecb"
23635 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23636 "Make hierarchy visible when jumping into location from ECB tree buffer."
23637 (if (derived-mode-p 'org-mode)
23638 (org-show-context))))
23640 (defun org-bookmark-jump-unhide ()
23641 "Unhide the current position, to show the bookmark location."
23642 (and (derived-mode-p 'org-mode)
23643 (or (outline-invisible-p)
23644 (save-excursion (goto-char (max (point-min) (1- (point))))
23645 (outline-invisible-p)))
23646 (org-show-context 'bookmark-jump)))
23648 ;; Make session.el ignore our circular variable
23649 (eval-after-load "session"
23650 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23652 ;;;; Finish up
23654 (provide 'org)
23656 (run-hooks 'org-load-hook)
23658 ;;; org.el ends here