| blob | 77a5172939cd53ac52e7d2ee86a548f22781e9e1 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
86 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
87 ;; some places -- e.g. see the macro org-with-limited-levels.
88 ;;
89 ;; In Org buffers, the value of `outline-regexp' is that of
90 ;; `org-outline-regexp'. The only function still directly relying on
91 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
92 ;; job when `orgstruct-mode' is active.
97 "Regexp to match Org headlines.
98 This is similar to `org-outline-regexp' but additionally makes
102 "Matches a headline, putting stars and text into groups.
105 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
119 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
161 ;; load languages based on value of `org-babel-load-languages'
164 ;;;###autoload
166 "Load the languages defined in `org-babel-load-languages'."
178 org-babel-load-languages))
181 "Languages which can be evaluated in Org-mode buffers.
182 This list can be used to load support for any of the languages
183 below, note that each language will depend on a different set of
184 system executables and/or Emacs modes. When a language is
186 with `org-babel-execute-src-block' bound by default to C-c
187 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
188 be set to remove code block evaluation from the C-c C-c
189 keybinding. By default only Emacs Lisp (which has no
190 requirements) is loaded."
195 :key-type
239 ;;;; Customization variables
241 "Remove ID property of clones of a subtree.
242 When non-nil, clones of a subtree don't inherit the ID property.
243 Otherwise they inherit the ID property with a new unique
244 identifier."
249 ;;; Version
252 ;;;###autoload
254 "Show the org-mode version in the echo area.
255 With prefix argument HERE, insert it at point.
256 When FULL is non-nil, use a verbose version string.
257 When MESSAGE is non-nil, display a message with the version."
270 org-version
271 git-version
274 org-install-dir
283 _version)))
287 ;;; Compatibility constants
289 ;;; The custom variables
292 "Outline-based notes management and organizer."
298 "Mode hook for Org-mode, run after the mode was turned on."
303 "Hook that is run after org.el has been loaded."
308 "Hook that is run after an Org log buffer is created."
318 "Load all extensions listed in `org-modules'."
323 org-modules)
327 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
332 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
333 "Modules that should always be loaded together with org.el.
335 If a description starts with <C>, the file is not part of Emacs
336 and loading it will require that you have downloaded and properly
337 installed the Org mode distribution.
339 You can also use this system to load external packages (i.e. neither Org
340 core modules, nor modules from the CONTRIB directory). Just add symbols
341 to the end of the list. If the package is called org-xyz.el, then you need
342 to add the symbol `xyz', and the package must have a call to:
344 \(provide 'org-xyz)
346 For export specific modules, see also `org-export-backends'."
349 :type
377 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
386 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
395 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
413 "List of export back-ends that should be always available.
415 If a description starts with <C>, the file is not part of Emacs
416 and loading it will require that you have downloaded and properly
417 installed the Org mode distribution.
419 Unlike to `org-modules', libraries in this list will not be
420 loaded along with Org, but only once the export framework is
421 needed.
423 This variable needs to be set before org.el is loaded. If you
424 need to make a change while Emacs is running, use the customize
425 interface or run the following code, where VALUE stands for the
426 new value of the variable, after updating it:
428 \(progn
429 \(setq org-export-registered-backends
430 \(org-remove-if-not
431 \(lambda (backend)
432 \(or (memq backend val)
433 \(catch 'parentp
434 \(mapc
435 \(lambda (b)
436 \(and (org-export-derived-backend-p b (car backend))
437 \(throw 'parentp t)))
438 val)
439 nil)))
440 org-export-registered-backends))
441 \(let ((new-list (mapcar 'car org-export-registered-backends)))
442 \(dolist (backend val)
443 \(cond
446 backend))
447 \((not (memq backend new-list)) (push backend new-list))))
448 \(set-default var new-list)))
450 Adding a back-end to this list will also pull the back-end it
451 depends on, if any."
456 ;; Any back-end not required anymore (not present in VAL and not
457 ;; a parent of any back-end in the new value) is removed from the
458 ;; list of registered back-ends.
468 val)
469 nil)))
470 org-export-registered-backends))
471 ;; Now build NEW-LIST of both new back-ends and required
472 ;; parents.
478 backend))
480 ;; Set VAR to that list with fixed dependencies.
503 backend))))
504 org-export-backends))
507 "Non-nil means make shift-cursor commands select text when possible.
509 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
510 start selecting a region, or enlarge regions started in this way.
511 In Org-mode, in special contexts, these same keys are used for
512 other purposes, important enough to compete with shift selection.
513 Org tries to balance these needs by supporting `shift-select-mode'
514 outside these special contexts, under control of this variable.
516 The default of this variable is nil, to avoid confusing behavior. Shifted
517 cursor keys will then execute Org commands in the following contexts:
518 - on a headline, changing TODO state (left/right) and priority (up/down)
519 - on a time stamp, changing the time
520 - in a plain list item, changing the bullet type
521 - in a property definition line, switching between allowed values
522 - in the BEGIN line of a clock table (changing the time block).
523 Outside these contexts, the commands will throw an error.
525 When this variable is t and the cursor is not in a special
526 context, Org-mode will support shift-selection for making and
527 enlarging regions. To make this more effective, the bullet
528 cycling will no longer happen anywhere in an item line, but only
529 if the cursor is exactly on the bullet.
531 If you set this variable to the symbol `always', then the keys
532 will not be special in headlines, property lines, and item lines,
533 to make shift selection work there as well. If this is what you
534 want, you can use the following alternative commands: `C-c C-t'
535 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
536 can be used to switch TODO sets, `C-c -' to cycle item bullet
537 types, and properties can be edited by hand or in column view.
539 However, when the cursor is on a timestamp, shift-cursor commands
540 will still edit the time stamp - this is just too good to give up.
542 XEmacs user should have this variable set to nil, because
543 `shift-select-mode' is in Emacs 23 or later only."
551 "Shall some commands act upon headlines in the active region?
553 When set to `t', some commands will be performed in all headlines
554 within the active region.
556 When set to `start-level', some commands will be performed in all
557 headlines within the active region, provided that these headlines
558 are of the same level than the first one.
560 When set to a string, those commands will be performed on the
561 matching headlines within the active region. Such string must be
562 a tags/property/todo match as it is used in the agenda tags view.
564 The list of commands is: `org-schedule', `org-deadline',
565 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
566 `org-archive-to-archive-sibling'. The archiving commands skip
567 already archived entries."
577 "Options concerning startup of Org-mode."
582 "Non-nil means entering Org-mode will switch to OVERVIEW.
583 This can also be configured on a per-file basis by adding one of
584 the following lines anywhere in the buffer:
586 #+STARTUP: fold (or `overview', this is equivalent)
587 #+STARTUP: nofold (or `showall', this is equivalent)
588 #+STARTUP: content
589 #+STARTUP: showeverything
591 By default, this option is ignored when Org opens agenda files
592 for the first time. If you want the agenda to honor the startup
593 option, set `org-agenda-inhibit-startup' to nil."
602 "Non-nil means entering Org-mode will set `truncate-lines'.
603 This is useful since some lines containing links can be very long and
604 uninteresting. Also tables look terrible when wrapped."
609 "Non-nil means turn on `org-indent-mode' on startup.
610 This can also be configured on a per-file basis by adding one of
611 the following lines anywhere in the buffer:
613 #+STARTUP: indent
614 #+STARTUP: noindent"
622 When this option is turned on, you can use TeX-like syntax for sub- and
624 considered as a single item - so grouping with {} is normally not
625 needed. For example, the following things will be parsed as single
626 sub- or superscripts.
628 10^24 or 10^tau several digits will be considered 1 item.
629 10^-12 or 10^-tau a leading sign with digits or a word
630 x^2-y^3 will be read as x^2 - y^3, because items are
631 terminated by almost any nonword/nondigit char.
632 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
634 Still, ambiguity is possible - so when in doubt use {} to enclose
635 the sub/superscript. If you set this variable to the symbol
636 `{}', the braces are *required* in order to trigger
637 interpretations as sub/superscript. This can be helpful in
647 "Non-nil means turn on `org-beamer-mode' on startup.
648 This can also be configured on a per-file basis by adding one of
649 the following lines anywhere in the buffer:
651 #+STARTUP: beamer"
657 "Non-nil means align all tables when visiting a file.
658 This is useful when the column width in tables is forced with <N> cookies
659 in table fields. Such tables will look correct only after the first re-align.
660 This can also be configured on a per-file basis by adding one of
661 the following lines anywhere in the buffer:
662 #+STARTUP: align
663 #+STARTUP: noalign"
668 "Non-nil means show inline images when loading a new Org file.
669 This can also be configured on a per-file basis by adding one of
670 the following lines anywhere in the buffer:
671 #+STARTUP: inlineimages
672 #+STARTUP: noinlineimages"
678 "Non-nil means preview LaTeX fragments when loading a new Org file.
680 This can also be configured on a per-file basis by adding one of
681 the followinglines anywhere in the buffer:
682 #+STARTUP: latexpreview
683 #+STARTUP: nolatexpreview"
690 "Non-nil means insert the first line setting Org-mode in empty files.
691 When the function `org-mode' is called interactively in an empty file, this
692 normally means that the file name does not automatically trigger Org-mode.
693 To ensure that the file will always be in Org-mode in the future, a
694 line enforcing Org-mode will be inserted into the buffer, if this option
695 has been set."
700 "Non-nil means use alternative key bindings for some keys.
701 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
702 These keys are also used by other packages like shift-selection-mode'
703 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
704 If you want to use Org-mode together with one of these other modes,
705 or more generally if you would like to move some Org-mode commands to
706 other keys, set this variable and configure the keys with the variable
707 `org-disputed-keys'.
709 This option is only relevant at load-time of Org-mode, and must be set
710 *before* org.el is loaded. Changing it requires a restart of Emacs to
711 become effective."
716 "Non-nil means use extra key sequence definitions for certain commands.
717 This happens automatically if you run XEmacs or if `window-system'
718 is nil. This variable lets you do the same manually. You must
719 set it before loading org.
721 Example: on Carbon Emacs 22 running graphically, with an external
722 keyboard on a Powerbook, the default way of setting M-left might
723 not work for either Alt or ESC. Setting this variable will make
724 it work for ESC."
738 "Keys for which Org-mode and other modes compete.
739 This is an alist, cars are the default keys, second element specifies
740 the alternative to use when `org-replace-disputed-keys' is t.
742 Keys can be specified in any syntax supported by `define-key'.
743 The value of this option takes effect only at Org-mode's startup,
744 therefore you'll have to restart Emacs to apply it after changing."
749 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
750 Or return the original if not disputed.
751 Also apply the translations defined in `org-xemacs-key-equivalents'."
756 org-disputed-keys)))
760 key)
770 "Define a key, possibly translated, as returned by `org-key'."
774 "The ellipsis to use in the Org-mode outline.
775 When nil, just use the standard three dots. When a string, use that instead,
776 When a face, use the standard 3 dots, but with the specified face.
777 The change affects only Org-mode (which will then use its own display table).
778 Changing this requires executing `M-x org-mode' in a buffer to become
779 effective."
789 "Keywords in Org-mode."
794 "String to mark deadline entries.
795 A deadline is this string, followed by a time stamp. Should be a word,
796 terminated by a colon. You can insert a schedule keyword and
798 Changes become only effective after restarting Emacs."
803 "String to mark scheduled TODO entries.
804 A schedule is this string, followed by a time stamp. Should be a word,
805 terminated by a colon. You can insert a schedule keyword and
807 Changes become only effective after restarting Emacs."
812 "String used as the prefix for timestamps logging closing a TODO entry."
817 "String used as prefix for timestamps clocking work hours on an item."
829 "Entries starting with this keyword will never be exported.
830 An entry can be toggled between COMMENT and normal with
832 Changes become only effective after restarting Emacs."
837 "Entries starting with this keyword will be exported in fixed-width font.
838 Quoting applies only to the text in the entry following the headline, and does
839 not extend beyond the next headline, even if that is lower level.
840 An entry can be toggled between QUOTE and normal with
847 "Regular expression for specifying repeated events.
851 "Options concerning the general structure of Org-mode files."
856 "Options about how to make context of a location visible."
880 "Non-nil means show full hierarchy when revealing a location.
881 Org-mode often shows locations in an org-mode file which might have
882 been invisible before. When this is set, the hierarchy of headings
883 above the exposed location is shown.
884 Turning this off for example for sparse trees makes them very compact.
885 Instead of t, this can also be an alist specifying this option for different
886 contexts. Valid contexts are
887 agenda when exposing an entry from the agenda
888 org-goto when using the command `org-goto' on key C-c C-j
889 occur-tree when using the command `org-occur' on key C-c /
890 tags-tree when constructing a sparse tree based on tags matches
891 link-search when exposing search matches associated with a link
892 mark-goto when exposing the jump goal of a mark
893 bookmark-jump when exposing a bookmark location
894 isearch when exiting from an incremental search
895 default default for all contexts not set explicitly"
900 "Non-nil means show following heading when revealing a location.
901 Org-mode often shows locations in an org-mode file which might have
902 been invisible before. When this is set, the heading following the
903 match is shown.
904 Turning this off for example for sparse trees makes them very compact,
905 but makes it harder to edit the location of the match. In such a case,
907 Instead of t, this can also be an alist specifying this option for different
908 contexts. See `org-show-hierarchy-above' for valid contexts."
913 "Non-nil means show all sibling heading when revealing a location.
914 Org-mode often shows locations in an org-mode file which might have
915 been invisible before. When this is set, the sibling of the current entry
916 heading are all made visible. If `org-show-hierarchy-above' is t,
917 the same happens on each level of the hierarchy above the current entry.
919 By default this is on for the isearch context, off for all other contexts.
920 Turning this off for example for sparse trees makes them very compact,
921 but makes it harder to edit the location of the match. In such a case,
923 Instead of t, this can also be an alist specifying this option for different
924 contexts. See `org-show-hierarchy-above' for valid contexts."
929 "Non-nil means show the entry below a headline when revealing a location.
930 Org-mode often shows locations in an org-mode file which might have
931 been invisible before. When this is set, the text below the headline that is
932 exposed is also shown.
934 By default this is off for all contexts.
935 Instead of t, this can also be an alist specifying this option for different
936 contexts. See `org-show-hierarchy-above' for valid contexts."
941 "How should indirect tree buffers be displayed?
942 This applies to indirect buffers created with the commands
944 Valid values are:
945 current-window Display in the current window
946 other-window Just display in another window.
947 dedicated-frame Create one new frame, and re-use it each time.
948 new-frame Make a new frame each time. Note that in this case
949 previously-made indirect buffers are kept, and you need to
950 kill these buffers yourself."
960 "Non-nil means activate single letter commands at beginning of a headline.
961 This may also be a function to test for appropriate locations where speed
962 commands should be active."
970 "Alist of additional speed commands.
971 This list will be checked before `org-speed-commands-default'
972 when the variable `org-use-speed-commands' is non-nil
973 and when the cursor is at the beginning of a headline.
974 The car if each entry is a string with a single letter, which must
975 be assigned to `self-insert-command' in the global map.
976 The cdr is either a command to be called interactively, a function
977 to be called, or a form to be evaluated.
978 An entry that is just a list with a single string will be interpreted
979 as a descriptive headline that will be added when listing the speed
980 commands in the Help buffer using the `?' speed command."
992 "Options concerning visibility cycling in Org-mode."
997 "Non-nil means skip CHILDREN state in entries that don't have any."
1002 "Maximum level which should still be subject to visibility cycling.
1003 Levels higher than this will, for cycling, be treated as text, not a headline.
1004 When `org-odd-levels-only' is set, a value of N in this variable actually
1005 means 2N-1 stars as the limiting headline.
1006 When nil, cycle all levels.
1007 Note that the limiting level of cycling is also influenced by
1008 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1009 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1010 than its value."
1017 "Names of drawers. Drawers are not opened by cycling on the headline above.
1018 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1019 this:
1020 :DRAWERNAME:
1021 .....
1022 :END:
1024 the property API.
1026 Drawers can be defined on the per-file basis with a line like:
1028 #+DRAWERS: HIDDEN STATE PROPERTIES"
1034 "Non-nil means entering Org-mode will fold all blocks.
1035 This can also be set in on a per-file basis with
1037 #+STARTUP: hideblocks
1038 #+STARTUP: showblocks"
1044 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1045 This makes it possible to do global cycling without having to use S-TAB or
1047 of the buffer must not be a headline -- it may be empty or some other text.
1048 When used in this way, `org-cycle-hook' is disabled temporarily to make
1049 sure the cursor stays at the beginning of the buffer. When this option is
1050 nil, don't do anything special at the beginning of the buffer."
1055 "Non-nil means cycle entry level or item indentation in new empty entries.
1057 When the cursor is at the end of an empty headline, i.e., with only stars
1058 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1059 and then all possible ancestor states, before returning to the original state.
1060 This makes data entry extremely fast: M-RET to create a new headline,
1061 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1063 When the cursor is at the end of an empty plain list item, one TAB will
1064 make it a subitem, two or more tabs will back up to make this an item
1065 higher up in the item hierarchy."
1070 "Where should `org-cycle' emulate TAB.
1071 nil Never
1072 white Only in completely white lines
1073 whitestart Only at the beginning of lines, before the first non-white char
1074 t Everywhere except in headlines
1075 exc-hl-bol Everywhere except at the start of a headline
1076 If TAB is used in a place where it does not emulate TAB, the current subtree
1077 visibility is cycled."
1084 ))
1087 "Number of empty lines needed to keep an empty line between collapsed trees.
1088 If you leave an empty line between the end of a subtree and the following
1089 headline, this empty line is hidden when the subtree is folded.
1090 Org-mode will leave (exactly) one empty line visible if the number of
1091 empty lines is equal or larger to the number given in this variable.
1092 So the default 2 means at least 2 empty lines after the end of a subtree
1093 are needed to produce free space between a collapsed subtree and the
1094 following headline.
1096 If the number is negative, and the number of empty lines is at least -N,
1097 all empty lines are shown.
1099 Special case: when 0, never leave empty lines in collapsed view."
1105 "Hook that is run before visibility cycling is happening.
1106 The function(s) in this hook must accept a single argument which indicates
1107 the new state that will be set right after running this hook. The
1108 argument is a symbol. Before a global state change, it can have the values
1109 `overview', `content', or `all'. Before a local state change, it can have
1110 the values `folded', `children', or `subtree'."
1115 org-cycle-hide-drawers
1116 org-cycle-hide-inline-tasks
1117 org-cycle-show-empty-lines
1118 org-optimize-window-after-visibility-change)
1119 "Hook that is run after `org-cycle' has changed the buffer visibility.
1120 The function(s) in this hook must accept a single argument which indicates
1121 the new state that was set by the most recent `org-cycle' command. The
1122 argument is a symbol. After a global state change, it can have the values
1123 `overview', `contents', or `all'. After a local state change, it can have
1124 the values `folded', `children', or `subtree'."
1129 "Options concerning structure editing in Org-mode."
1134 "Non-nil means skip even levels and only use odd levels for the outline.
1135 This has the effect that two stars are being added/taken away in
1136 promotion/demotion commands. It also influences how levels are
1137 handled by the exporters.
1138 Changing it requires restart of `font-lock-mode' to become effective
1139 for fontification also in regions already fontified.
1140 You may also set this on a per-file basis by adding one of the following
1141 lines to the buffer:
1143 #+STARTUP: odd
1144 #+STARTUP: oddeven"
1150 "Non-nil means adapt indentation to outline node level.
1152 When this variable is set, Org assumes that you write outlines by
1153 indenting text in each node to align with the headline (after the stars).
1154 The following issues are influenced by this variable:
1156 - When this is set and the *entire* text in an entry is indented, the
1157 indentation is increased by one space in a demotion command, and
1158 decreased by one in a promotion command. If any line in the entry
1159 body starts with text at column 0, indentation is not changed at all.
1161 - Property drawers and planning information is inserted indented when
1162 this variable s set. When nil, they will not be indented.
1164 - TAB indents a line relative to context. The lines below a headline
1165 will be indented when this variable is set.
1167 Note that this is all about true indentation, by adding and removing
1168 space characters. See also `org-indent.el' which does level-dependent
1169 indentation in a virtual way, i.e. at display time in Emacs."
1174 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1176 When t, `C-a' will bring back the cursor to the beginning of the
1177 headline text, i.e. after the stars and after a possible TODO
1178 keyword. In an item, this will be the position after bullet and
1179 check-box, if any. When the cursor is already at that position,
1180 another `C-a' will bring it to the beginning of the line.
1182 `C-e' will jump to the end of the headline, ignoring the presence
1183 of tags in the headline. A second `C-e' will then jump to the
1184 true end of the line, after any tags. This also means that, when
1185 this variable is non-nil, `C-e' also will never jump beyond the
1186 end of the heading of a folded section, i.e. not after the
1187 ellipses.
1189 When set to the symbol `reversed', the first `C-a' or `C-e' works
1190 normally, going to the true line boundary first. Only a directly
1191 following, identical keypress will bring the cursor to the
1192 special positions.
1194 This may also be a cons cell where the behavior for `C-a' and
1195 `C-e' is set separately."
1214 "Non-nil means `C-k' will behave specially in headlines.
1215 When nil, `C-k' will call the default `kill-line' command.
1216 When t, the following will happen while the cursor is in the headline:
1218 - When the cursor is at the beginning of a headline, kill the entire
1219 line and possible the folded subtree below the line.
1220 - When in the middle of the headline text, kill the headline up to the tags.
1221 - When after the headline text, kill the tags."
1226 "Non-nil means, do not delete a hidden subtree with C-k.
1227 When set to the symbol `error', simply throw an error when C-k is
1228 used to kill (part-of) a headline that has hidden text behind it.
1229 Any other non-nil value will result in a query to the user, if it is
1230 OK to kill that hidden subtree. When nil, kill without remorse."
1239 "Check if in invisible region before inserting or deleting a character.
1240 Valid values are:
1242 nil Do not check, so just do invisible edits.
1243 error Throw an error and do nothing.
1244 show Make point visible, and do the requested edit.
1245 show-and-error Make point visible, then throw an error and abort the edit.
1246 smart Make point visible, and do insertion/deletion if it is
1247 adjacent to visible text and the change feels predictable.
1248 Never delete a previously invisible character or add in the
1249 middle or right after an invisible region. Basically, this
1250 allows insertion and backward-delete right before ellipses.
1251 FIXME: maybe in this case we should not even show?"
1262 "Non-nil means when yanking subtrees, fold them.
1263 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1264 it starts with a heading and all other headings in it are either children
1265 or siblings, then fold all the subtrees. However, do this only if no
1266 text after the yank would be swallowed into a folded tree by this action."
1271 "Non-nil means when yanking subtrees, adjust the level.
1272 With this setting, `org-paste-subtree' is used to insert the subtree, see
1273 this function for details."
1278 "Non-nil means M-RET will split the line at the cursor position.
1279 When nil, it will go to the end of the line before making a
1280 new line.
1281 You may also set this option in a different way for different
1282 contexts. Valid contexts are:
1284 headline when creating a new headline
1285 item when creating a new item
1286 table in a table field
1287 default the value to be used for all contexts not explicitly
1288 customized"
1305 "Non-nil means insert new headings after the current subtree.
1306 When nil, the new heading is created directly after the current line.
1309 for the duration of the command."
1315 "Should `org-insert-heading' leave a blank line before new heading/item?
1316 The value is an alist, with `heading' and `plain-list-item' as CAR,
1317 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1318 which case Org will look at the surrounding headings/items and try to
1319 make an intelligent decision whether to insert a blank line or not.
1321 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1322 set, the setting here is ignored and no empty line is inserted, to avoid
1323 breaking the list structure."
1336 "Hook being run after inserting a new heading."
1342 This currently only means they are never auto-wrapped.
1343 When nil, such lines will be treated like ordinary lines.
1344 See also the QUOTE keyword."
1349 "Non-nil means typing characters in `org-goto' starts incremental search.
1350 When nil, you can use these keybindings to navigate the buffer:
1352 q Quit the org-goto interface
1353 n Go to the next visible heading
1354 p Go to the previous visible heading
1355 f Go one heading forward on same level
1356 b Go one heading backward on same level
1357 u Go one heading up"
1362 "Options concerning sparse trees in Org-mode."
1367 "Non-nil means highlight all matches that define a sparse tree.
1368 The highlights will automatically disappear the next time the buffer is
1369 changed by an edit command."
1374 "Non-nil means any change to the buffer will remove temporary highlights.
1375 Such highlights are created by `org-occur' and `org-clock-display'.
1376 When nil, `C-c C-c needs to be used to get rid of the highlights.
1377 The highlights created by `org-preview-latex-fragment' always need
1378 `C-c C-c' to be removed."
1385 "Hook that is run after `org-occur' has constructed a sparse tree.
1386 This can be used to recenter the window to show as much of the structure
1387 as possible."
1392 "Options concerning imenu and speedbar in Org-mode."
1397 "The maximum level for Imenu access to Org-mode headlines.
1398 This also applied for speedbar access."
1403 "Options concerning tables in Org-mode."
1409 When nil, such lines will be treated like ordinary lines.
1411 When equal to the symbol `optimized', the table editor will be optimized to
1412 do the following:
1413 - Automatic overwrite mode in front of whitespace in table fields.
1414 This makes the structure of the table stay in tact as long as the edited
1415 field does not exceed the column width.
1416 - Minimize the number of realigns. Normally, the table is aligned each time
1417 TAB or RET are pressed to move to another field. With optimization this
1418 happens only if changes to a field might have changed the column width.
1419 Optimization requires replacing the functions `self-insert-command',
1420 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1421 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1422 very good at guessing when a re-align will be necessary, but you can always
1425 If you would like to use the optimized version in Org-mode, but the
1426 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1428 This variable can be used to turn on and off the table editor during a session,
1429 but in order to toggle optimization, a restart is required.
1431 See also the variable `org-table-auto-blank-field'."
1440 "Non-nil means cluster self-insert commands for undo when possible.
1441 If this is set, then, like in the Emacs command loop, 20 consecutive
1442 characters will be undone together.
1443 This is configurable, because there is some impact on typing performance."
1448 "Non-nil means TAB will automatically notice a table.el table.
1449 When it sees such a table, it moves point into it and - if necessary -
1450 calls `table-recognize-table'."
1455 "Options concerning links in Org-mode."
1460 "Buffer-local version of `org-link-abbrev-alist', which see.
1465 "Alist of link abbreviations.
1466 The car of each element is a string, to be replaced at the start of a link.
1468 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1470 [[linkkey:tag][description]]
1472 The 'linkkey' must be a word word, starting with a letter, followed
1473 by letters, numbers, '-' or '_'.
1475 If REPLACE is a string, the tag will simply be appended to create the link.
1478 at that point (see the function `url-hexify-string'). If the string contains
1480 be invoked: this function takes the tag as its only argument and must return
1481 a string.
1483 REPLACE may also be a function that will be called with the tag as the
1484 only argument to create the link, which should be returned as a string.
1486 See the manual for examples."
1496 "Non-nil means Org will display descriptive links.
1497 E.g. [[http://orgmode.org][Org website]] will be displayed as
1499 description. When set to `nil', Org will display the full links
1500 literally.
1502 You can interactively set the value of this variable by calling
1503 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1508 "How the path name in file links should be stored.
1509 Valid values are:
1511 relative Relative to the current directory, i.e. the directory of the file
1512 into which the link is being inserted.
1513 absolute Absolute path, if possible with ~ for home directory.
1514 noabbrev Absolute path, no abbreviation of home directory.
1515 adaptive Use relative path for files in the current directory and sub-
1516 directories of it. For other files, use an absolute path."
1525 "Types of links that should be activated in Org-mode files.
1526 This is a list of symbols, each leading to the activation of a certain link
1527 type. In principle, it does not hurt to turn on most link types - there may
1528 be a small gain when turning off unused link types. The types are:
1530 bracket The recommended [[link][description]] or [[link]] links with hiding.
1531 angle Links in angular brackets that may contain whitespace like
1532 <bbdb:Carsten Dominik>.
1533 plain Plain links in normal text, no whitespace, like http://google.com.
1534 radio Text that is matched by a radio target, see manual for details.
1535 tag Tag settings in a headline (link to tag search).
1536 date Time stamps (link to calendar).
1537 footnote Footnote labels.
1539 Changing this variable requires a restart of Emacs to become effective."
1551 "Function to use for generating link descriptions from links.
1552 When nil, the link location will be used. This function must take
1553 two parameters: the first one is the link, the second one is the
1554 description generated by `org-insert-link'. The function should
1555 return the description to use."
1560 "Options concerning storing links in Org-mode."
1565 "When non-nil, hexify URL when creating a link."
1571 "Format of the description part of a link to an email or usenet message.
1572 The following %-escapes will be replaced by corresponding information:
1580 %s subject
1581 %d date
1582 %m message-id.
1584 You may use normal field width specification between the % and the letter.
1585 This is for example useful to limit the length of the subject.
1599 It should match if the message is from the user him/herself."
1604 "Non-nil means file links from `org-store-link' contain context.
1605 A search string will be added to the file name with :: as separator and
1606 used to find the context when the link is activated by the command
1607 `org-open-at-point'. When this option is t, the entire active region
1608 will be placed in the search string of the file link. If set to a
1609 positive integer, only the first n lines of context will be stored.
1612 negates this setting for the duration of the command."
1617 "Non-nil means keep link in list for entire session.
1619 The command `org-store-link' adds a link pointing to the current
1620 location to an internal list. These links accumulate during a session.
1621 The command `org-insert-link' can be used to insert links into any
1622 Org-mode file (offering completion for all stored links). When this
1624 will be removed from the list, to make completing the unused links
1625 more efficient."
1630 "Options concerning following links in Org-mode."
1635 "Function to translate links with different syntax to Org syntax.
1636 This can be used to translate links created for example by the Planner
1637 or emacs-wiki packages to Org syntax.
1638 The function must accept two parameters, a TYPE containing the link
1640 which is everything after the link protocol. It should return a cons
1641 with possibly modified values of type and path.
1642 Org contains a function for this, so if you set this variable to
1643 `org-translate-link-from-planner', you should be able follow many
1644 links created by planner."
1649 "Hook that is run after a link has been followed."
1654 "Non-nil means on links TAB will follow the link.
1655 Needs to be set before org.el is loaded.
1656 This really should not be used, it does not make sense, and the
1657 implementation is bad."
1662 "Non-nil means on links RET will follow the link.
1663 In tables, the special behavior of RET has precedence."
1669 "Non-nil means mouse-1 on a link will follow the link.
1670 A longer mouse click will still set point. Does not work on XEmacs.
1671 Needs to be set before org.el is loaded."
1676 "Number of different positions to be recorded in the ring.
1677 Changing this requires a restart of Emacs to work correctly."
1682 "Non-nil means internal links in Org files must exactly match a headline.
1683 When nil, the link search tries to match a phrase with all words
1684 in the search text."
1691 query-to-create)))
1699 "Setup the frame configuration for following links.
1700 When following a link with Emacs, it may often be useful to display
1701 this link in another window or frame. This variable can be used to
1702 set this up for the different types of links.
1703 For VM, use any of
1704 `vm-visit-folder'
1705 `vm-visit-folder-other-window'
1706 `vm-visit-folder-other-frame'
1707 For Gnus, use any of
1708 `gnus'
1709 `gnus-other-frame'
1710 `org-gnus-no-new-news'
1711 For FILE, use any of
1712 `find-file'
1713 `find-file-other-window'
1714 `find-file-other-frame'
1715 For Wanderlust use any of
1716 `wl'
1717 `wl-other-frame'
1718 For the calendar, use the variable `calendar-setup'.
1719 For BBDB, it is currently only possible to display the matches in
1720 another window."
1744 "Non-nil means use indirect buffer to display infile links.
1745 Activating internal links (from one location in a file to another location
1746 in the same file) normally just jumps to the location. When the link is
1748 is displayed in
1749 another window. When this option is set, the other window actually displays
1750 an indirect buffer clone of the current buffer, to avoid any visibility
1751 changes to the current buffer."
1756 "Non-nil means `org-open-file' will open non-existing files.
1757 When nil, an error will be generated.
1758 This variable applies only to external applications because they
1759 might choke on non-existing files. If the link is to a file that
1760 will be opened in Emacs, the variable is ignored."
1765 "Non-nil means a link to a directory really means to index.org.
1766 When nil, following a directory link will run dired or open a finder/explorer
1767 window on that directory."
1772 "Function and arguments to call for following mailto links.
1773 This is a list with the first element being a Lisp function, and the
1774 remaining elements being arguments to the function. In string arguments,
1775 %a will be replaced by the address, and %s will be replaced by the subject
1776 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1785 "Non-nil means ask for confirmation before executing shell links.
1786 Shell links can be dangerous: just think about a link
1788 [[shell:rm -rf ~/*][Google Search]]
1791 but really it would remove your entire home directory.
1792 Therefore we advise against setting this variable to nil.
1793 Just change it to `y-or-n-p' if you want to confirm with a
1801 'safe-local-variable
1805 "A regexp to skip confirmation for shell links."
1811 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1812 Elisp links can be dangerous: just think about a link
1817 but really it would remove your entire home directory.
1818 Therefore we advise against setting this variable to nil.
1819 Just change it to `y-or-n-p' if you want to confirm with a
1827 'safe-local-variable
1831 "A regexp to skip confirmation for Elisp links."
1840 "Default file applications on a UNIX or GNU/Linux system.
1851 "Default file applications on a MacOS X system.
1853 for some files for which the OS does not have a good default.
1861 'mswindows-shell-execute
1866 'mswindows-shell-execute
1869 "Default file applications on a Windows NT system.
1874 '(
1879 )
1880 "External applications for opening `file:path' items in a document.
1881 Org-mode uses system defaults for different file types, but
1882 you can use this variable to set the application for a given file
1883 extension. The entries in this list are cons cells where the car identifies
1884 files and the cdr the corresponding command. Possible values for the
1885 file identifier are
1887 ways, depending on its contents:
1889 - Alphanumeric characters only:
1890 Match links with this file extension.
1892 to open PDFs with evince.
1894 - Regular expression: Match links where the
1895 filename matches the regexp. If you want to
1896 use groups here, use shy groups.
1900 to open *.html and *.xhtml with firefox.
1902 - Regular expression which contains (non-shy) groups:
1904 anything after that, matches the regexp.
1905 In a custom command string, %1, %2, etc. are replaced with
1906 the parts of the link that were matched by the groups.
1907 For backwards compatibility, if a command string is given
1908 that does not use any of the group matches, this case is
1909 handled identically to the second one (i.e. match against
1910 file name only).
1911 In a custom lisp form, you can access the group matches with
1912 (match-string n link).
1915 to open [[file:document.pdf::5]] with evince at page 5.
1917 `directory' Matches a directory
1918 `remote' Matches a remote file, accessible through tramp or efs.
1919 Remote files most likely should be visited through Emacs
1920 because external applications cannot handle such paths.
1921 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1922 so all files Emacs knows how to handle. Using this with
1923 command `emacs' will open most files in Emacs. Beware that this
1924 will also open html files inside Emacs, unless you add
1926 t Default for files not matched by any of the other options.
1927 `system' The system command to open files, like `open' on Windows
1928 and Mac OS X, and mailcap under GNU/Linux. This is the command
1929 that will be selected if you call `C-c C-o' with a double
1932 Possible values for the command are:
1933 `emacs' The file will be visited by the current Emacs process.
1934 `default' Use the default application for this file type, which is the
1935 association for t in the list, most likely in the system-specific
1936 part.
1937 This can be used to overrule an unwanted setting in the
1938 system-specific variable.
1940 This command is specified by the entry whose car is `system'.
1941 Most likely, the system-specific version of this variable
1942 does define this command, but you can overrule/replace it
1943 here.
1944 string A command to be executed by a shell; %s will be replaced
1945 by the path to the file.
1946 sexp A Lisp form which will be evaluated. The file path will
1947 be available in the Lisp variable `file'.
1948 For more examples, see the system specific constants
1949 `org-file-apps-defaults-macosx'
1950 `org-file-apps-defaults-windowsnt'
1951 `org-file-apps-defaults-gnu'."
1961 auto-mode))
1970 "The URL of the DOI server."
1976 "Options concerning refiling entries in Org-mode."
1981 "Directory with org files.
1982 This is just a default location to look for Org files. There is no need
1983 at all to put your files into this directory. It is only used in the
1984 following situations:
1986 1. When a capture template specifies a target file that is not an
1987 absolute path. The path will then be interpreted relative to
1988 `org-directory'
1989 2. When a capture note is filed away in an interactive way (when exiting the
1990 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1991 with `org-directory' as the default path."
1998 "Default target for storing notes.
1999 Used as a fall back file for org-remember.el and org-capture.el, for
2000 templates that do not specify a target file."
2006 file))
2009 "The default interface to be used for `org-goto'.
2010 Allowed values are:
2011 outline The interface shows an outline of the relevant file
2012 and the correct heading is found by moving through
2013 the outline or by searching with incremental search.
2014 outline-path-completion Headlines in the current buffer are offered via
2015 completion. This is the interface also used by
2016 the refile command."
2023 "Maximum target level when running `org-goto' with refile interface."
2028 "Non-nil means store new notes at the beginning of a file or entry.
2029 When nil, new notes will be filed to the end of a file or entry.
2030 This can also be a list with cons cells of regular expressions that
2031 are matched against file names, and values."
2042 "Information to record when a task is refiled.
2044 Possible values are:
2046 nil Don't add anything
2047 time Add a time stamp to the task
2048 note Prompt for a note and add it with template `org-log-note-headings'
2050 This option can also be set with on a per-file-basis with
2052 #+STARTUP: nologrefile
2053 #+STARTUP: logrefile
2054 #+STARTUP: lognoterefile
2056 You can have local logging settings for a subtree by setting the LOGGING
2057 property to one or more of these keywords.
2059 When bulk-refiling from the agenda, the value `note' is forbidden and
2060 will temporarily be changed to `time'."
2071 This is a list of cons cells. Each cell contains:
2072 - a specification of the files to be considered, either a list of files,
2073 or a symbol whose function or variable value will be used to retrieve
2074 a file name or a list of file names. If you use `org-agenda-files' for
2075 that, all agenda files will be scanned for targets. Nil means consider
2076 headings in the current buffer.
2077 - A specification of how to find candidate refile targets. This may be
2078 any of:
2080 This tag has to be present in all target headlines, inheritance will
2081 not be considered.
2083 todo keyword.
2085 headlines that are refiling targets.
2086 - a cons cell (:level . N). Any headline of level N is considered a target.
2087 Note that, when `org-odd-levels-only' is set, level corresponds to
2088 order in hierarchy, not to the number of stars.
2089 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2090 Note that, when `org-odd-levels-only' is set, level corresponds to
2091 order in hierarchy, not to the number of stars.
2093 Each element of this list generates a set of possible targets.
2094 The union of these sets is presented (with completion) to
2095 the user by `org-refile'.
2097 You can set the variable `org-refile-target-verify-function' to a function
2098 to verify each headline found by the simple criteria above.
2100 When this variable is nil, all top-level headlines in the current buffer
2101 are used, equivalent to the value `((nil . (:level . 1))'."
2117 "Function to verify if the headline at point should be a refile target.
2118 The function will be called without arguments, with point at the
2119 beginning of the headline. It should return t and leave point
2120 where it is if the headline is a valid target for refiling.
2122 If the target should not be selected, the function must return nil.
2123 In addition to this, it may move point to a place from where the search
2124 should be continued. For example, the function may decide that the entire
2125 subtree of the current entry should be excluded and move point to the end
2126 of the subtree."
2131 "Non-nil means cache refile targets to speed up the process.
2132 The cache for a particular file will be updated automatically when
2133 the buffer has been killed, or when any of the marker used for flagging
2134 refile targets no longer points at a live buffer.
2135 If you have added new entries to a buffer that might themselves be targets,
2136 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2137 find that easier, `C-u C-u C-u C-c C-w'."
2143 "Non-nil means provide refile targets as paths.
2144 So a level 3 headline will be available as level1/level2/level3.
2146 When the value is `file', also include the file name (without directory)
2147 into the path. In this case, you can also stop the completion after
2148 the file name, to get entries inserted as top level in the file.
2150 When `full-file-path', include the full file path."
2159 "Non-nil means complete the outline path in hierarchical steps.
2160 When Org-mode uses the refile interface to select an outline path
2161 \(see variable `org-refile-use-outline-path'), the completion of
2162 the path can be done is a single go, or if can be done in steps down
2163 the headline hierarchy. Going in steps is probably the best if you
2164 do not use a special completion package like `ido' or `icicles'.
2165 However, when using these packages, going in one step can be very
2166 fast, while still showing the whole path to the entry."
2171 "Non-nil means allow to create new nodes as refile targets.
2173 of an existing node. When the value of this variable is `confirm',
2174 new node creation must be confirmed by the user (recommended)
2175 When nil, the completion must match an existing entry.
2177 Note that, if the new heading is not seen by the criteria
2178 listed in `org-refile-targets', multiple instances of the same
2179 heading would be created by trying again to file under the new
2180 heading."
2188 "Non-nil means also refile active region within a subtree.
2190 By default `org-refile' doesn't allow refiling regions if they
2191 don't contain a set of subtrees, but it might be convenient to
2192 do so sometimes: in that case, the first line of the region is
2193 converted to a headline before refiling."
2199 "Options concerning TODO items in Org-mode."
2204 "Options concerning Progress logging in Org-mode."
2211 "The available interpretation symbols for customizing `org-todo-keywords'.
2215 "List of TODO entry keyword sequences and their interpretation.
2218 Each sequence starts with a symbol, either `sequence' or `type',
2219 indicating if the keywords should be interpreted as a sequence of
2220 action steps, or as different types of TODO items. The first
2221 keywords are states requiring action - these states will select a headline
2222 for inclusion into the global TODO list Org-mode produces. If one of
2225 the last keyword is treated as the only DONE state of the sequence.
2228 additional state where no keyword is present. For details about this
2229 cycling, see the manual.
2231 TODO keywords and interpretation can also be set on a per-file basis with
2232 the special #+SEQ_TODO and #+TYP_TODO lines.
2234 Each keyword can optionally specify a character for fast state selection
2235 \(in combination with the variable `org-use-fast-todo-selection')
2236 and specifiers for state change logging, using the same syntax that
2239 indicates to record a time stamp each time this state is selected.
2241 Each keyword may also specify if a timestamp or a note should be
2242 recorded when entering or leaving the state, by adding additional
2243 characters in the parenthesis after the keyword. This looks like this:
2245 record only the time of the state change. With X and Y being either
2247 Y when leaving the state if and only if the *target* state does not
2248 define X. You may omit any of the fast-selection key or X or /Y,
2249 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2251 For backward compatibility, this variable may also be just a list
2252 of keywords. In this case the interpretation (sequence or type) will be
2253 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2263 ;;Quick and dirty way to see
2264 ;;`org-todo-interpretations'. This takes the
2265 ;;place of item arguments
2266 :convert-widget
2273 org-todo-interpretation-widgets))
2274 widget))
2305 "Controls how TODO keywords are interpreted.
2306 This variable is in principle obsolete and is only used for
2307 backward compatibility, if the interpretation of todo keywords is
2308 not given already in `org-todo-keywords'. See that variable for
2309 more information."
2316 "Non-nil means use the fast todo selection scheme with C-c C-t.
2317 This variable describes if and under what circumstances the cycling
2318 mechanism for TODO keywords will be replaced by a single-key, direct
2319 selection scheme.
2321 When nil, fast selection is never used.
2323 When the symbol `prefix', it will be used when `org-todo' is called
2324 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2325 `C-u t' in an agenda buffer.
2327 When t, fast selection is used by default. In this case, the prefix
2328 argument forces cycling instead.
2330 In all cases, the special interface is only used if access keys have
2331 actually been assigned by the user, i.e. if keywords in the configuration
2332 are followed by a letter in parenthesis, like TODO(t)."
2340 "Non-nil means update todo statistics after insert and toggle.
2341 ALL-HEADLINES means update todo statistics by including headlines
2342 with no TODO keyword as well, counting them as not done.
2343 A list of TODO keywords means the same, but skip keywords that are
2344 not in this list.
2346 When this is set, todo statistics is updated in the parent of the
2347 current entry each time a todo state is changed."
2357 "Non-nil means TODO statistics covers just direct children.
2358 When nil, all entries in the subtree are considered.
2359 This has only an effect if `org-provide-todo-statistics' is set.
2360 To set this to nil for only a single subtree, use a COOKIE_DATA
2366 "Hook which is run after the state of a TODO item was changed.
2367 The new state (a string with a TODO keyword, or nil) is available in the
2368 Lisp variable `org-state'."
2373 "Hook for functions that are allowed to block a state change.
2375 Functions in this hook should not modify the buffer.
2376 Each function gets as its single argument a property list,
2377 see `org-trigger-hook' for more information about this list.
2379 If any of the functions in this hook returns nil, the state change
2383 "Hook for functions that are triggered by a state change.
2385 Each function gets as its single argument a property list with at
2386 least the following elements:
2388 (:type type-of-change :position pos-at-entry-start
2389 :from old-state :to new-state)
2391 Depending on the type, more properties may be present.
2393 This mechanism is currently implemented for:
2395 TODO state changes
2396 ------------------
2397 :type todo-state-change
2398 :from previous state (keyword as a string), or nil, or a symbol
2399 'todo' or 'done', to indicate the general type of state.
2403 "Non-nil means undone TODO entries will block switching the parent to DONE.
2404 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2405 be blocked if any prior sibling is not yet done.
2406 Finally, if the parent is blocked because of ordered siblings of its own,
2407 the child will also be blocked."
2419 "Non-nil means unchecked boxes will block switching the parent to DONE.
2420 When this is nil, checkboxes have no influence on switching TODO states.
2421 When non-nil, you first need to check off all check boxes before the TODO
2422 entry can be switched to DONE.
2423 This variable needs to be set before org.el is loaded, and you need to
2424 restart Emacs after a change to make the change effective. The only way
2425 to change is while Emacs is running is through the customize interface."
2437 "Non-nil means inserting a TODO heading is treated as state change.
2439 logging will apply if appropriate. When nil, the new TODO item will
2440 be inserted directly, and no logging will take place."
2445 "Non-nil means switching TODO states with S-cursor counts as state change.
2446 This is the default behavior. However, setting this to nil allows a
2447 convenient way to select a TODO state and bypass any logging associated
2448 with that."
2453 "Tag changes that should be triggered by TODO state changes.
2454 This is a list. Each entry is
2456 (state-change (tag . flag) .......)
2458 State-change can be a string with a state, and empty string to indicate the
2459 state that has no TODO keyword, or it can be one of the symbols `todo'
2460 or `done', meaning any not-done or done state, respectively."
2474 "Information to record when a task moves to the DONE state.
2476 Possible values are:
2478 nil Don't add anything, just change the keyword
2479 time Add a time stamp to the task
2480 note Prompt for a note and add it with template `org-log-note-headings'
2482 This option can also be set with on a per-file-basis with
2484 #+STARTUP: nologdone
2485 #+STARTUP: logdone
2486 #+STARTUP: lognotedone
2488 You can have local logging settings for a subtree by setting the LOGGING
2489 property to one or more of these keywords."
2497 ;; Normalize old uses of org-log-done.
2504 "Information to record when the scheduling date of a tasks is modified.
2506 Possible values are:
2508 nil Don't add anything, just change the date
2509 time Add a time stamp to the task
2510 note Prompt for a note and add it with template `org-log-note-headings'
2512 This option can also be set with on a per-file-basis with
2514 #+STARTUP: nologreschedule
2515 #+STARTUP: logreschedule
2516 #+STARTUP: lognotereschedule"
2525 "Information to record when the deadline date of a tasks is modified.
2527 Possible values are:
2529 nil Don't add anything, just change the date
2530 time Add a time stamp to the task
2531 note Prompt for a note and add it with template `org-log-note-headings'
2533 This option can also be set with on a per-file-basis with
2535 #+STARTUP: nologredeadline
2536 #+STARTUP: logredeadline
2537 #+STARTUP: lognoteredeadline
2539 You can have local logging settings for a subtree by setting the LOGGING
2540 property to one or more of these keywords."
2549 "Non-nil means record a note when clocking out of an item.
2550 This can also be configured on a per-file basis by adding one of
2551 the following lines anywhere in the buffer:
2553 #+STARTUP: lognoteclock-out
2554 #+STARTUP: nolognoteclock-out"
2560 "Non-nil means the CLOSED time stamp will contain date and time.
2561 When nil, only the date will be recorded."
2575 "Headings for notes added to entries.
2576 The value is an alist, with the car being a symbol indicating the note
2577 context, and the cdr is the heading to be used. The heading may also be the
2578 empty string.
2579 %t in the heading will be replaced by a time stamp.
2580 %T will be an active time stamp instead the default inactive one
2581 %d will be replaced by a short-format time stamp.
2582 %D will be replaced by an active short-format time stamp.
2583 %s will be replaced by the new TODO state, in double quotes.
2584 %S will be replaced by the old TODO state, in double quotes.
2585 %u will be replaced by the user name.
2586 %U will be replaced by the full user name.
2588 In fact, it is not a good idea to change the `state' entry, because
2589 agenda log mode depends on the format of these entries."
2595 "Heading when changing todo state (todo sequence only)"
2609 "Non-nil means insert state change notes and time stamps into a drawer.
2610 When nil, state changes notes will be inserted after the headline and
2611 any scheduling and clock lines, but not inside a drawer.
2613 The value of this variable should be the name of the drawer to use.
2614 LOGBOOK is proposed as the default drawer for this purpose, you can
2615 also set this to a string to define the drawer of your choice.
2619 A value of t or nil can also be set with on a per-file-basis with
2621 #+STARTUP: logdrawer
2622 #+STARTUP: nologdrawer
2624 If this variable is set, `org-log-state-notes-insert-after-drawers'
2625 will be ignored.
2627 You can set the property LOG_INTO_DRAWER to overrule this setting for
2628 a subtree."
2640 "Return the value of `org-log-into-drawer', but let properties overrule.
2641 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2642 used instead of the default value."
2651 "Non-nil means insert state change notes after any drawers in entry.
2652 Only the drawers that *immediately* follow the headline and the
2653 deadline/scheduled line are skipped.
2654 When nil, insert notes right after the heading and perhaps the line
2655 with deadline/scheduling if present.
2657 This variable will have no effect if `org-log-into-drawer' is
2658 set."
2664 "Non-nil means the latest state note will be directly after heading.
2665 When nil, the state change notes will be ordered according to time.
2667 This option can also be set with on a per-file-basis with
2669 #+STARTUP: logstatesreversed
2670 #+STARTUP: nologstatesreversed"
2676 "The TODO state to which a repeater should return the repeating task.
2677 By default this is the first task in a TODO sequence, or the previous state
2678 in a TODO_TYP set. But you can specify another task here.
2679 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2686 "Non-nil means record moving through the DONE state when triggering repeat.
2687 An auto-repeating task is immediately switched back to TODO when
2690 record a closing note, there will be no record of the task moving
2691 through DONE. This variable forces taking a note anyway.
2693 nil Don't force a record
2694 time Record a time stamp
2695 note Prompt for a note and add it with template `org-log-note-headings'
2697 This option can also be set with on a per-file-basis with
2699 #+STARTUP: nologrepeat
2700 #+STARTUP: logrepeat
2701 #+STARTUP: lognoterepeat
2703 You can have local logging settings for a subtree by setting the LOGGING
2704 property to one or more of these keywords."
2714 "Priorities in Org-mode."
2719 "Non-nil means priority commands are active.
2720 When nil, these commands will be disabled, so that you never accidentally
2721 set a priority."
2726 "The highest priority of TODO items. A character like ?A, ?B etc.
2727 Must have a smaller ASCII number than `org-lowest-priority'."
2732 "The lowest priority of TODO items. A character like ?A, ?B etc.
2733 Must have a larger ASCII number than `org-highest-priority'."
2738 "The default priority of TODO items.
2739 This is the priority an item gets if no explicit priority is given.
2740 When starting to cycle on an empty priority the first step in the cycle
2741 depends on `org-priority-start-cycle-with-default'. The resulting first
2742 step priority must not exceed the range from `org-highest-priority' to
2743 `org-lowest-priority' which means that `org-default-priority' has to be
2744 in this range exclusive or inclusive the range boundaries. Else the
2745 first step refuses to set the default and the second will fall back
2746 to (depending on the command used) the highest or lowest priority."
2751 "Non-nil means start with default priority when starting to cycle.
2752 When this is nil, the first step in the cycle will be (depending on the
2753 command used) one higher or lower than the default priority.
2754 See also `org-default-priority'."
2759 "Function to extract the priority from a string.
2760 The string is normally the headline. If this is nil Org computes the
2761 priority from the priority cookie like [#A] in the headline. It returns
2762 an integer, increasing by 1000 for each priority level.
2763 The user can set a different function here, which should take a string
2764 as an argument and return the numeric priority."
2770 "Options concerning time stamps and deadlines in Org-mode."
2775 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2776 When nil, these labeled time stamps are forces into the second line of an
2777 entry, just after the headline. When scheduling from the global TODO list,
2778 the time stamp will always be forced into the second line."
2783 "Formats for `format-time-string' which are used for time stamps.
2787 "Number of minutes to round time stamps to.
2788 These are two values, the first applies when first creating a time stamp.
2789 The second applies when changing it with the commands `S-up' and `S-down'.
2790 When changing the time stamp, this means that it will change in steps
2791 of N minutes, as given by the second value.
2793 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2794 numbers should be factors of 60, so for example 5, 10, 15.
2796 When this is larger than 1, you can still force an exact time stamp by using
2797 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2798 and by using a prefix arg to `S-up/down' to specify the exact number
2799 of minutes to shift."
2809 ;; Normalize old customizations of this variable.
2813 org-time-stamp-rounding-minutes)))
2816 "Non-nil means overlay custom formats over all time stamps.
2817 The formats are defined through the variable `org-time-stamp-custom-formats'.
2818 To turn this on on a per-file basis, insert anywhere in the file:
2819 #+STARTUP: customtime"
2827 "Custom formats for time stamps. See `format-time-string' for the syntax.
2828 These are overlaid over the default ISO format if the variable
2829 `org-display-custom-times' is set. Time like %H:%M should be at the
2830 end of the second format. The custom formats are also honored by export
2831 commands, if custom time display is turned on at the time of export."
2836 "Get the right format for a time string."
2841 f)))
2845 "The format string used when creating CLOCKSUM lines.
2846 This is also used when Org mode generates a time duration.
2848 The value can be a single format string containing two
2849 %-sequences, which will be filled with the number of hours and
2850 minutes in that order.
2852 Alternatively, the value can be a plist associating any of the
2853 keys :years, :months, :weeks, :days, :hours or :minutes with
2854 format strings. The time duration is formatted using only the
2855 time components that are needed and concatenating the results.
2856 If a time unit in absent, it falls back to the next smallest
2857 unit.
2859 The keys :require-years, :require-months, :require-days,
2860 :require-weeks, :require-hours, :require-minutes are also
2861 meaningful. A non-nil value for these keys indicates that the
2862 corresponding time component should always be included, even if
2863 its value is 0.
2866 For example,
2869 :require-minutes t)
2871 means durations longer than a day will be expressed in days,
2872 hours and minutes, and durations less than a day will always be
2873 expressed in hours and minutes (even for durations less than an
2874 hour).
2876 The value
2880 means durations longer than a day will be expressed in days and
2881 minutes, and durations less than a day will be expressed entirely
2882 in minutes (even for durations longer than an hour)."
2922 See `org-time-clocksum-format' for more on time clock formats."
2930 E.g. by default, one day is considered to be a 8 hours effort,
2931 so a task that has been clocked for 16 hours will be displayed
2932 as during 2 days in the clock display or in the clocktable.
2934 See `org-effort-durations' on how to set effort durations
2935 and `org-time-clocksum-format' for more on time clock formats."
2943 "The format string used when creating CLOCKSUM lines,
2944 or when Org mode generates a time duration, if
2945 `org-time-clocksum-use-fractional' is enabled.
2947 The value can be a single format string containing one
2948 %-sequence, which will be filled with the number of hours as
2949 a float.
2951 Alternatively, the value can be a plist associating any of the
2952 keys :years, :months, :weeks, :days, :hours or :minutes with
2953 a format string. The time duration is formatted using the
2954 largest time unit which gives a non-zero integer part. If all
2955 specified formats have zero integer part, the smallest time unit
2956 is used."
2973 "Number of days before expiration during which a deadline becomes active.
2974 This variable governs the display in sparse trees and in the agenda.
2975 When 0 or negative, it means use this number (the absolute value of it)
2976 even if a deadline has a different individual lead time specified.
2978 Custom commands can set this variable in the options section."
2984 "Number of days before a scheduled item becomes active.
2985 This variable governs the display in sparse trees and in the agenda.
2986 The default value (i.e. 0) means: don't delay scheduled item.
2987 When negative, it means use this number (the absolute value of it)
2988 even if a scheduled item has a different individual delay time
2989 specified.
2991 Custom commands can set this variable in the options section."
2999 "Non-nil means assume future for incomplete date input from user.
3000 This affects the following situations:
3001 1. The user gives a month but not a year.
3004 2. The user gives a day, but no month.
3007 it will be considered as *this* month.
3009 If you set this variable to the symbol `time', then also the following
3010 will work:
3012 3. If the user gives a time.
3013 If the time is before now, it will be interpreted as tomorrow.
3015 Currently none of this works for ISO week specifications.
3017 When this option is nil, the current day, month and year will always be
3018 used as defaults.
3020 See also `org-agenda-jump-prefer-future'."
3028 "Should the agenda jump command prefer the future for incomplete dates?
3029 The default is to do the same as configured in `org-read-date-prefer-future'.
3030 But you can also set a deviating value here.
3031 This may t or nil, or the symbol `org-read-date-prefer-future'."
3037 org-read-date-prefer-future)
3042 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3044 Depending on the system Emacs is running on, certain dates cannot
3045 be represented with the type used internally to represent time.
3046 Dates between 1970-1-1 and 2038-1-1 can always be represented
3047 correctly. Some systems allow for earlier dates, some for later,
3048 some for both. One way to find out it to insert any date into an
3049 Org buffer, putting the cursor on the year and hitting S-up and
3050 S-down to test the range.
3052 When this variable is set to t, the date/time prompt will not let
3053 you specify dates outside the 1970-2037 range, so it is certain that
3054 these dates will work in whatever version of Emacs you are
3055 running, and also that you can move a file from one Emacs implementation
3056 to another. WHenever Org is forcing the year for you, it will display
3057 a message and beep.
3059 When this variable is nil, Org will check if the date is
3060 representable in the specific Emacs implementation you are using.
3061 If not, it will force a year, usually the current year, and beep
3062 to remind you. Currently this setting is not recommended because
3063 the likelihood that you will open your Org files in an Emacs that
3064 has limited date range is not negligible.
3066 A workaround for this problem is to use diary sexp dates for time
3067 stamps outside of this range."
3073 "Non-nil means display current interpretation of date prompt live.
3074 This display will be in an overlay, in the minibuffer."
3079 "Non-nil means pop up a calendar when prompting for a date.
3080 In the calendar, the date can be selected with mouse-1. However, the
3081 minibuffer will also be active, and you can simply enter the date as well.
3082 When nil, only the minibuffer will be available."
3090 'org-read-date-minibuffer-setup-hook
3093 "Hook to be used to set up keys for the date/time interface.
3094 Add key definitions to `minibuffer-local-map', which will be a
3095 temporary copy.
3097 WARNING: This option is obsolete, you should use
3098 `org-read-date-minibuffer-local-map' to set up keys."
3103 "The hour when your day really ends. Must be an integer.
3104 This has influence for the following applications:
3106 the time given here, the day recognized as TODAY is actually yesterday.
3107 - When a date is read from the user and it is still before the time given
3108 here, the current date and time will be assumed to be yesterday, 23:59.
3109 Also, timestamps inserted in capture templates follow this rule.
3111 IMPORTANT: This is a feature whose implementation is and likely will
3112 remain incomplete. Really, it is only here because past midnight seems to
3113 be the favorite working time of John Wiegley :-)"
3118 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3119 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3121 23:59 of the previous day."
3127 "When non-nil, use the last clock out time for `org-todo'.
3128 Note that this option has precedence over the combined use of
3129 `org-use-effective-time' and `org-extend-today-until'."
3136 "Non-nil means S-down will increase the time in a time stamp.
3137 When nil, S-up will increase."
3142 "Non-nil means make the calendar window follow timestamp changes.
3143 When a timestamp is modified and the calendar window is visible, it will be
3144 moved to the new date."
3149 "Options concerning tags in Org-mode."
3154 "List of tags allowed in Org-mode files.
3155 When this list is nil, Org-mode will base TAG input on what is already in the
3156 buffer.
3157 The value of this variable is an alist, the car of each entry must be a
3158 keyword as a string, the cdr may be a character that is used to select
3159 that tag through the fast-tag-selection interface.
3160 See the manual for details."
3175 "List of tags that will always appear in all Org-mode files.
3176 This is in addition to any in buffer settings or customizations
3177 of `org-tag-alist'.
3178 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3179 The value of this variable is an alist, the car of each entry must be a
3180 keyword as a string, the cdr may be a character that is used to select
3181 that tag through the fast-tag-selection interface.
3182 See the manual for details.
3183 To disable these tags on a per-file basis, insert anywhere in the file:
3184 #+STARTUP: noptag"
3195 "If non-nil, always offer completion for all tags of all agenda files.
3196 Instead of customizing this variable directly, you might want to
3197 set it locally for capture buffers, because there no list of
3198 tags in that file can be created dynamically (there are none).
3200 (add-hook 'org-capture-mode-hook
3201 (lambda ()
3202 (set (make-local-variable
3203 'org-complete-tags-always-offer-all-agenda-tags)
3204 t)))"
3210 "List of tags that can be inherited by all entries in the file.
3211 The tags will be inherited if the variable `org-use-tag-inheritance'
3212 says they should be.
3216 "Non-nil means use fast tag selection scheme.
3217 This is a special interface to select and deselect tags with single keys.
3218 When nil, fast selection is never used.
3219 When the symbol `auto', fast selection is used if and only if selection
3220 characters for tags have been configured, either through the variable
3221 `org-tag-alist' or through a #+TAGS line in the buffer.
3222 When t, fast selection is always used and selection keys are assigned
3223 automatically if necessary."
3231 "Non-nil means fast tag selection exits after first change.
3232 When nil, you have to press RET to exit it.
3233 During fast tag selection, you can toggle this flag with `C-c'.
3234 This variable can also have the value `expert'. In this case, the window
3235 displaying the tags menu is not even shown, until you press C-c again."
3243 "Non-nil means fast tags selection interface will also offer TODO states.
3247 "The column to which tags should be indented in a headline.
3248 If this number is positive, it specifies the column. If it is negative,
3249 it means that the tags should be flushright to that column. For example,
3250 -80 works well for a normal 80 character screen.
3251 When 0, place tags directly after headline text, with only one space in
3252 between."
3257 "Non-nil keeps tags aligned when modifying headlines.
3258 Some operations (i.e. demoting) change the length of a headline and
3259 therefore shift the tags around. With this option turned on, after
3260 each such operation the tags are again aligned to `org-tags-column'."
3265 "Non-nil means tags in levels apply also for sublevels.
3266 When nil, only the tags directly given in a specific line apply there.
3267 This may also be a list of tags that should be inherited, or a regexp that
3268 matches tags that should be inherited. Additional control is possible
3269 with the variable `org-tags-exclude-from-inheritance' which gives an
3270 explicit list of tags to be excluded from inheritance, even if the value of
3271 `org-use-tag-inheritance' would select it for inheritance.
3273 If this option is t, a match early-on in a tree can lead to a large
3274 number of matches in the subtree when constructing the agenda or creating
3275 a sparse tree. If you only want to see the first match in a tree during
3276 a search, check out the variable `org-tags-match-list-sublevels'."
3285 "List of tags that should never be inherited.
3286 This is a way to exclude a few tags from inheritance. For way to do
3287 the opposite, to actively allow inheritance for selected tags,
3288 see the variable `org-use-tag-inheritance'."
3293 "Check if TAG is one that should be inherited."
3305 "Non-nil means list also sublevels of headlines matching a search.
3306 This variable applies to tags/property searches, and also to stuck
3307 projects because this search is based on a tags match as well.
3309 When set to the symbol `indented', sublevels are indented with
3310 leading dots.
3312 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3313 the sublevels of a headline matching a tag search often also match
3314 the same search. Listing all of them can create very long lists.
3315 Setting this variable to nil causes subtrees of a match to be skipped.
3317 This variable is semi-obsolete and probably should always be true. It
3318 is better to limit inheritance to certain tags using the variables
3319 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3327 "When set, tags are sorted using this function as a comparator."
3343 "Options concerning properties in Org-mode."
3348 "How property key/value pairs should be formatted by `indent-line'.
3349 When `indent-line' hits a property definition, it will format the line
3350 according to this format, mainly to make sure that the values are
3351 lined-up with respect to each other."
3356 "Alist of properties and functions to adjust inserted values.
3357 Elements of this alist must be of the form
3359 ([string] [function])
3361 where [string] must be a property name and [function] must be a
3362 lambda expression: this lambda expression must take one argument,
3363 the value to adjust, and return the new value as a string.
3367 and the clock summary:
3370 (let ((clocksum (org-clock-sum-current-item))
3371 (effort (org-duration-string-to-minutes
3373 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3380 "Non-nil means properties apply also for sublevels.
3382 This setting is chiefly used during property searches. Turning it on can
3383 cause significant overhead when doing a search, which is why it is not
3384 on by default.
3386 When nil, only the properties directly given in the current entry count.
3387 When t, every property is inherited. The value may also be a list of
3388 properties that should have inheritance, or a regular expression matching
3389 properties that should be inherited.
3391 However, note that some special properties use inheritance under special
3392 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3394 for valid values of a property.
3396 Note for programmers:
3397 When querying an entry with `org-entry-get', you can control if inheritance
3398 should be used. By default, `org-entry-get' looks only at the local
3399 properties. You can request inheritance by setting the inherit argument
3400 to t (to force inheritance) or to `selective' (to respect the setting
3401 in this variable)."
3410 "Check if PROPERTY is one that should be inherited."
3421 "The default column format, if no other format has been defined.
3422 This variable can be set on the per-file basis by inserting a line
3424 #+COLUMNS: %25ITEM ....."
3429 "The ellipses to be used when a field in column view is truncated.
3430 When this is the empty string, as many characters as possible are shown,
3431 but then there will be no visual indication that the field has been truncated.
3432 When this is a string of length N, the last N characters of a truncated
3433 field are replaced by this string. If the column is narrower than the
3434 ellipses string, only part of the ellipses string will be shown."
3439 "Function that modifies values for display in column view.
3440 For example, it can be used to cut out a certain part from a time stamp.
3441 The function must take 2 arguments:
3443 column-title The title of the column (*not* the property name)
3444 value The value that should be modified.
3446 The function should return the value that should be displayed,
3447 or nil if the normal value should be used."
3452 "The property that is being used to keep track of effort estimates.
3453 Effort estimates given in this property need to have the format H:MM."
3461 "List of property/value pairs that can be inherited by any entry.
3463 These are fixed values, for the preset properties. The user variable
3464 that can be used to add to this list is `org-global-properties'.
3466 The entries in this list are cons cells where the car is a property
3467 name and cdr is a string with the value. If the value represents
3472 "List of property/value pairs that can be inherited by any entry.
3474 This list will be combined with the constant `org-global-properties-fixed'.
3476 The entries in this list are cons cells where the car is a property
3477 name and cdr is a string with the value.
3479 You can set buffer-local values for the same purpose in the variable
3480 `org-file-properties' this by adding lines like
3482 #+PROPERTY: NAME VALUE"
3489 "List of property/value pairs that can be inherited by any entry.
3490 Valid for the current buffer.
3495 "Options concerning agenda views in Org-mode."
3500 "Variable used by org files to set a category for agenda display.
3501 Such files should use a file variable to set it, for example
3505 or contain a special line
3507 #+CATEGORY: ELisp
3509 If the file does not specify a category, then file's base name
3515 "The files to be used for agenda display.
3519 If an entry is a directory, all files in that directory that are matched by
3520 `org-agenda-file-regexp' will be part of the file list.
3522 If the value of the variable is not a list but a single file name, then
3523 the list of agenda files is actually stored and maintained in that file, one
3524 agenda file per line. In this file paths can be given relative to
3525 `org-directory'. Tilde expansion and environment variable substitution
3526 are also made."
3533 "Regular expression to match files for `org-agenda-files'.
3534 If any element in the list in that variable contains a directory instead
3535 of a normal file, all files in that directory that are matched by this
3536 regular expression will be included."
3541 "List of extra files to be searched by text search commands.
3542 These files will be search in addition to the agenda files by the
3543 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3544 Note that these files will only be searched for text search commands,
3545 not for the other agenda views like todo lists, tag searches or the weekly
3546 agenda. This variable is intended to list notes and possibly archive files
3547 that should also be searched by these two commands.
3548 In fact, if the first element in the list is the symbol `agenda-archives',
3549 than all archive files of all agenda files will be added to the search
3550 scope."
3561 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3562 A nil value means to remove them, after a query, from the list."
3567 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3568 The command `org-calendar-goto-agenda' will be bound to this key. The
3569 default is the character `c' because then `c' can be used to switch back and
3570 forth between agenda and calendar."
3575 "The key to be installed in `calendar-mode-map' for adding diary entries.
3576 This option is irrelevant until `org-agenda-diary-file' has been configured
3577 to point to an Org-mode file. When that is the case, the command
3578 `org-agenda-diary-entry' will be bound to the key given here, by default
3579 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3580 if you want to continue doing this, you need to change this to a different
3581 key."
3586 "File to which to add new entries with the `i' key in agenda and calendar.
3587 When this is the symbol `diary-file', the functionality in the Emacs
3588 calendar will be used to add entries to the `diary-file'. But when this
3589 points to a file, `org-agenda-diary-entry' will be used instead."
3603 org-calendar-insert-diary-entry-key
3607 "Options for embedding LaTeX code into Org-mode."
3615 "Options for creating images from LaTeX fragments.
3616 This is a property list with the following properties:
3618 `default' means use the foreground of the default face.
3619 `auto' means use the foreground from the text face.
3621 `default' means use the background of the default face.
3622 `auto' means use the background from the text face.
3623 :scale a scaling factor for the size of the images, to get more pixels
3624 :html-foreground, :html-background, :html-scale
3625 the same numbers for HTML export.
3626 :matchers a list indicating which matchers should be used to
3627 find LaTeX fragments. Valid members of this list are:
3638 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3639 When nil, just push out a message."
3646 Use this to specify additional executable file say a jar file.
3648 When using MathToWeb as the converter, specify the full-path to
3649 your mathtoweb.jar file."
3657 "Command to convert LaTeX fragments to MathML.
3658 Replace format-specifiers in the command as noted below and use
3659 `shell-command' to convert LaTeX to MathML.
3660 %j: Executable file in fully expanded form as specified by
3661 `org-latex-to-mathml-jar-file'.
3662 %I: Input LaTeX file in fully expanded form
3663 %o: Output MathML file
3664 This command is used by `org-create-math-formula'.
3666 When using MathToWeb as the converter, set this to
3675 "Program to convert LaTeX fragments with.
3677 dvipng Process the LaTeX fragments to dvi file, then convert
3678 dvi files to png files using dvipng.
3679 This will also include processing of non-math environments.
3680 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3681 to convert pdf files to png files"
3689 "Path to store latex preview images.
3690 A relative path here creates many directories relative to the
3691 processed org files paths. An absolute path puts all preview
3692 images at the same place."
3698 "Return t if `org-latex-to-mathml-convert-command' is usable."
3701 org-latex-to-mathml-convert-command)
3703 org-latex-to-mathml-convert-command))))
3708 t))))))
3715 \[PACKAGES]
3716 \[DEFAULT-PACKAGES]
3717 % The settings below are copied from fullpage.sty
3730 "The document header used for processing LaTeX fragments.
3731 It is imperative that this header make sure that no page number
3732 appears on the page. The package defined in the variables
3733 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3735 header, or they will be appended."
3740 "Set the packages alist and make sure it has 3 elements per entry."
3744 x))
3745 val)))
3748 "Get the packages alist and make sure it has 3 elements per entry."
3752 x))
3771 "Alist of default packages to be inserted in the header.
3773 Change this only if one of the packages here causes an
3774 incompatibility with another package you are using.
3776 The packages in this list are needed by one part or another of
3777 Org mode to function properly:
3779 - inputenc, fontenc: for basic font and character selection
3780 - textcomp, marvosymb, wasysym, latexsym, amssym: for various
3781 symbols used for interpreting the entities in `org-entities'.
3782 You can skip some of these packages if you don't use any of the
3783 symbols in it.
3784 - graphicx: for including images
3785 - float, wrapfig: for figure placement
3786 - longtable: for long tables
3787 - hyperref: for cross references
3789 Therefore you should not modify this variable unless you know
3790 what you are doing. The one reason to change it anyway is that
3791 you might be loading some other package that conflicts with one
3792 of the default packages. Each cell is of the format
3794 the package also needs to be included when compiling LaTeX
3795 snippets into images for inclusion into non-LaTeX output."
3810 "Alist of packages to be inserted in every LaTeX header.
3812 These will be inserted after `org-latex-default-packages-alist'.
3813 Each cell is of the format:
3817 SNIPPET-FLAG, when t, indicates that this package is also needed
3818 when turning LaTeX snippets into images for inclusion into
3819 non-LaTeX output.
3821 Make sure that you only list packages here which:
3823 - you want in every file
3824 - do not conflict with the setup in `org-format-latex-header'.
3825 - do not conflict with the default packages in
3826 `org-latex-default-packages-alist'."
3840 "Settings for Org-mode appearance."
3845 "Non-nil means fontify only the stars in each headline.
3846 When nil, the entire headline is fontified.
3847 Changing it requires restart of `font-lock-mode' to become effective
3848 also in regions already fontified."
3853 "Non-nil means hide the first N-1 stars in a headline.
3854 This works by using the face `org-hide' for these stars. This
3855 face is white for a light background, and black for a dark
3856 background. You may have to customize the face `org-hide' to
3857 make this work.
3858 Changing it requires restart of `font-lock-mode' to become effective
3859 also in regions already fontified.
3860 You may also set this on a per-file basis by adding one of the following
3861 lines to the buffer:
3863 #+STARTUP: hidestars
3864 #+STARTUP: showstars"
3869 "List of symbols corresponding to keywords to be hidden the org buffer.
3870 For example, a value '(title) for this list will make the document's title
3871 appear in the buffer without the initial #+TITLE: keyword."
3880 "List of properties (as strings) with a special meaning.
3881 The default use of these custom properties is to let the user
3882 hide them with `org-toggle-custom-properties-visibility'."
3889 "Non-nil means change the face of a headline if it is marked DONE.
3890 Normally, only the TODO/DONE keyword indicates the state of a headline.
3891 When this is non-nil, the headline after the keyword is set to the
3892 `org-headline-done' as an additional indication."
3897 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3898 Changing this variable requires a restart of Emacs to take effect."
3903 "Non-nil means fontify the whole line for headings.
3904 This is useful when setting a background color for the
3905 org-level-* faces."
3910 "Non-nil means highlight LaTeX related syntax in the buffer.
3911 When non nil, the value should be a list containing any of the
3912 following symbols:
3913 `latex' Highlight LaTeX snippets and environments.
3914 `script' Highlight subscript and superscript.
3915 `entities' Highlight entities."
3925 "Non-nil mean font-lock should hide the emphasis marker characters."
3930 "Non-nil means show entities as UTF8 characters.
3937 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3943 "Regular expression for matching emphasis.
3944 After a match, the match groups contain these elements:
3945 0 The match of the full regular expression, including the characters
3946 before and after the proper match
3947 1 The character before the proper match, or empty at beginning of line
3948 2 The proper match, including the leading and trailing markers
3949 3 The leading marker like * or /, indicating the type of highlighting
3950 4 The text between the emphasis markers, not including the markers
3957 "Set variable and compute the emphasis regular expression."
3961 org-emphasis-alist org-emphasis-regexp-components)
3973 ;; make sure special characters appear at the right position in the class
3985 ;; Make the regexp
3993 body1
4005 body1
4013 "Components used to build the regular expression for emphasis.
4014 This is a list with five entries. Terminology: In an emphasis string
4018 specify what is allowed/forbidden in each part:
4020 pre Chars allowed as prematch. Beginning of line will be allowed too.
4021 post Chars allowed as postmatch. End of line will be allowed too.
4022 border The chars *forbidden* as border characters.
4024 non-shy groups here, and don't allow newline here.
4025 newline The maximum number of newlines allowed in an emphasis exp.
4027 Use customize to modify this, or restart Emacs after changing it."
4046 )
4047 "Special syntax for emphasized text.
4048 Text starting and ending with a special character will be emphasized, for
4049 example *bold*, _underlined_ and /italic/. This variable sets the marker
4050 characters, the face to be used by font-lock for highlighting in Org-mode
4051 Emacs buffers, and the HTML tags to be used for this.
4052 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
4053 Use customize to modify this, or restart Emacs after changing it."
4068 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4071 ;;; Miscellaneous options
4074 "Completion in Org-mode."
4079 "Non-nil means use ido completion wherever possible.
4080 Note that `ido-mode' must be active for this variable to be relevant.
4081 If you decide to turn this variable on, you might well want to turn off
4082 `org-outline-path-complete-in-steps'.
4083 See also `org-completion-use-iswitchb'."
4088 "Non-nil means use iswitchb completion wherever possible.
4089 Note that `iswitchb-mode' must be active for this variable to be relevant.
4090 If you decide to turn this variable on, you might well want to turn off
4091 `org-outline-path-complete-in-steps'.
4092 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4098 Normal means, no org-mode-specific context."
4102 ;;; Functions and variables from their packages
4103 ;; Declared here to avoid compiler warnings
4105 ;; XEmacs only
4111 ;; Emacs only
4114 ;; Various packages
4133 org-agenda-format-item "org-agenda"
4160 ;;; Autoload and prepare some org modules
4162 ;; Some table stuff that needs to be defined here, because it is used
4163 ;; by the functions setting up org-mode or checking for table context.
4176 "Detect the first line outside a table when searching from within it.
4179 ;; Autoload the functions in org-table.el that are needed by functions here.
4185 ;;;###autoload
4187 "Unconditionally turn on `orgtbl-mode'."
4192 "Return t if the cursor is inside an org-type table.
4193 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4198 org-table-line-regexp)))
4199 nil))
4203 "Return t if and only if we are at a table.el table."
4210 "If there is a table.el table nearby, recognize it and move into it."
4216 nil
4226 t
4231 t)
4232 nil)
4233 nil))
4236 "Return t if the cursor is inside a hline in a table."
4241 nil))
4245 "Apply FUNCTION to the start of all tables in the buffer."
4255 ;; Exclude tables in src/example/verbatim/clocktable blocks
4263 ;; Declare and autoload functions from ox.el and al.
4269 ;; Declare and autoload functions from org-agenda.el
4287 "Return non-nil if clock is currently running.
4288 The return value is actually the clock marker."
4293 org-clock-update-time-maybe
4294 org-clocktable-shift)))
4297 "Check if the current buffer contains the running clock.
4298 If yes, offer to stop it and to save the buffer with the changes."
4307 "Check if this line starts a clock table, if yes, shift the time block."
4311 ;;;###autoload
4313 "Set up hooks for clock persistence."
4318 ;; Define the variable already here, to make sure we have it.
4320 "Non-nil if Org-Indent mode is enabled.
4323 ;; Autoload archiving code
4324 ;; The stuff that is needed for cycling and tags has to be defined here.
4327 "Options concerning archiving in Org-mode."
4332 "The location where subtrees should be archived.
4334 The value of this variable is a string, consisting of two parts,
4335 separated by a double-colon. The first part is a filename and
4336 the second part is a headline.
4338 When the filename is omitted, archiving happens in the same file.
4339 %s in the filename will be replaced by the current file
4340 name (without the directory part). Archiving to a different file
4341 is useful to keep archived entries from contributing to the
4342 Org-mode Agenda.
4344 The archived entries will be filed as subtrees of the specified
4345 headline. When the headline is omitted, the subtrees are simply
4346 filed away at the end of the file, as top-level entries. Also in
4347 the heading you can use %s to represent the file name, this can be
4348 useful when using the same archive for a number of different files.
4350 Here are a few examples:
4352 If the current file is Projects.org, archive in file
4353 Projects.org_archive, as top-level trees. This is the default.
4356 Archive in the current file, under the top-level headline
4360 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4363 Archive in file ~/org/archive.org (absolute path), under headlines
4368 items to the datetree. Items are placed in either the CLOSED
4369 date of the item, or the current date if there is no CLOSED date.
4370 The heading will be a subentry to the current date. There doesn't
4371 need to be a heading, but there always needs to be a slash after
4372 datetree. For example, to store archived items directly in the
4376 Archive in file ./basement (relative path), as level 3 trees
4379 You may set this option on a per-file basis by adding to the buffer a
4380 line like
4382 #+ARCHIVE: basement::** Finished Tasks
4384 You may also define it locally for a subtree by setting an ARCHIVE property
4385 in the entry. If such a property is found in an entry, or anywhere up
4386 the hierarchy, it will be used."
4391 "The tag that marks a subtree as archived.
4392 An archived subtree does not open during visibility cycling, and does
4393 not contribute to the agenda listings.
4394 After changing this, font-lock must be restarted in the relevant buffers to
4395 get the proper fontification."
4401 "Non-nil means the agenda will skip any items located in archived trees.
4402 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4403 variable is no longer recommended, you should leave it at the value t.
4404 Instead, use the key `v' to cycle the archives-mode in the agenda."
4410 "Non-nil means ignore archived trees when creating column view."
4416 "Non-nil means `org-cycle' will open archived trees.
4417 An archived tree is a tree marked with the tag ARCHIVE.
4418 When nil, archived trees will stay folded. You can still open them with
4419 normal outline commands like `show-all', but not with the cycling commands."
4425 "Non-nil means sparse tree construction shows matches in archived trees.
4426 When nil, matches in these trees are highlighted, but the trees are kept in
4427 collapsed state."
4433 "The default date type when building a sparse tree.
4434 When this is nil, a date is a scheduled or a deadline timestamp.
4435 Otherwise, these types are allowed:
4437 all: all timestamps
4438 active: only active timestamps (<...>)
4439 inactive: only inactive timestamps (<...)
4440 scheduled: only scheduled timestamps
4441 deadline: only deadline timestamps"
4452 "Re-hide all archived subtrees after a visibility state change."
4463 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4466 "Cycle subtree even if it is archived."
4473 "Re-hide all archived subtrees after a visibility state change."
4490 flag)))
4498 ;; Autoload Column View Code
4506 org-columns-get-format-and-top-level
4507 org-columns-compute
4508 org-columns-remove-overlays))
4510 ;; Autoload ID code
4518 org-id-copy
4519 org-id-get-with-outline-path-completion
4520 org-id-get-with-outline-drilling))
4522 ;;; Variables for pre-computed regular expressions, all buffer local
4540 "Matches a headline and puts everything into groups:
4541 group 1: the stars
4542 group 2: The todo keyword, maybe
4543 group 3: Priority cookie
4544 group 4: True headline
4548 "Printf format to make regexp to match an exact headline.
4549 This regexp will match the headline of any node which has the
4550 exact headline text that is put into the format, but may have any
4554 "Matches a headline and puts TODO state into group 2 if present.
4600 "Regular expression to match a plain time or time range.
4601 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4602 groups carry important information:
4603 0 the full match
4604 1 the first time, range or not
4612 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4613 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4614 groups carry important information:
4615 0 the full match
4616 7 hours of duration
4625 "Regular expression to match a timestamp time or time range.
4626 After a match, the following groups carry important information:
4627 0 the full match
4628 1 date plus weekday, for back referencing to make sure both times are on the same day
4629 2 the first time, range or not
4690 "Variable associated with STARTUP options for org-mode.
4691 Each element is a list of three items: the startup options (as written
4692 in the #+STARTUP line), the corresponding variable, and the value to set
4693 this variable to if the option is found. An optional forth element PUSH
4697 "Update PROPS with KEY and VAL."
4711 "Printf format for a regexp matching a headline with some keyword.
4712 This regexp will match the headline of any node which has the
4713 exact keyword that is put into the format. The keyword isn't in
4717 "Printf format for a regexp matching a headline, possibly with some keyword.
4718 This regexp can match any headline with the specified keyword, or
4719 without a keyword. The keyword isn't in any group by default,
4723 "Precompute regular expressions for current buffer."
4742 kwds kws0 kwsa key log value cat arch tags const links hw dws
4743 tail sep kws1 prio props ftags drawers ext-setup-or-nil setup-contents
4765 ;; general TODO-like setup
4777 links)))
4784 props))))
4789 ftags
4799 l var val)
4827 ;; search for property blocks
4836 props)))))))
4853 ;; Process the TODO keywords
4855 ;; Use the global values as if they had been given locally.
4867 kws)))
4870 kwsa nil
4873 ;; 1 2
4881 kw)
4883 kws0)
4900 ;; Process the constants
4908 ;; Process the tags.
4919 tgs))
4927 ;; Compute the regular expressions and other local variables.
4928 ;; Using `org-outline-regexp-bol' would complicate them much,
4929 ;; because of the fixed white space at the end of that string.
4937 org-drawer-regexp
4941 org-not-done-keywords
4943 org-todo-regexp
4947 org-not-done-regexp
4951 org-not-done-heading-regexp
4953 org-todo-line-regexp
4955 org-complex-heading-regexp
4962 org-complex-heading-regexp-format
4967 ;; Stats cookies can be stuck to body.
4974 org-todo-line-tags-regexp
4981 org-deadline-time-regexp
4983 org-deadline-line-regexp
4985 org-scheduled-regexp
4987 org-scheduled-time-regexp
4989 org-closed-time-regexp
4991 org-keyword-time-regexp
4997 org-keyword-time-not-clock-regexp
5003 org-maybe-keyword-time-regexp
5009 org-all-time-keywords
5012 org-clock-string org-closed-string)))
5017 "Return the contents of FILE, as a string."
5031 "Extract the log state setting from a TODO keyword string.
5045 "Remove a pair of parenthesis at the end of each string in LIST."
5049 x))
5050 list))
5053 "Assign fast keys to a keyword-key alist.
5054 Respect keys that are already there."
5072 ;;; Some variables used in various places
5079 "Function to be called when `C-c C-c' is used.
5083 ;; FIXME: Occasionally check by commenting these, to make sure
5084 ;; no other functions uses these, forgetting to let-bind them.
5089 ;; Defined somewhere in this file, but used before definition.
5095 ;;;; Define the Org-mode
5097 ;; We use a before-change function to check if a table might need
5098 ;; an update.
5100 "Indicates that a table might need an update.
5101 This variable is set by `org-before-change-function'.
5104 "Every change indicates that a table might need an update."
5119 (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"))
5122 ;; Other stuff we need.
5128 ;; (require 'org-macs) moved higher up in the file before it is first used
5130 ;; (require 'org-compat) moved higher up in the file before it is first used
5138 ;; babel
5141 ;;;###autoload
5143 "Outline-based notes management and organizer, alias
5146 Org-mode develops organizational tasks around a NOTES file which
5147 contains information about projects as plain text. Org-mode is
5148 implemented on top of outline-mode, which is ideal to keep the content
5149 of large files well structured. It supports ToDo items, deadlines and
5150 time stamps, which magically appear in the diary listing of the Emacs
5151 calendar. Tables are easily created with a built-in table editor.
5152 Plain text URL-like links connect to websites, emails (VM), Usenet
5153 messages (Gnus), BBDB entries, and any files related to the project.
5154 For printing and sharing of notes, an Org-mode file (or a part of it)
5155 can be exported as a structured ASCII or HTML file.
5157 The following commands are available:
5161 ;; Get rid of Outline menus, they are not needed
5162 ;; Need to do this here because define-derived-mode sets up
5163 ;; the keymap so late. Still, it is a waste to call this each time
5164 ;; we switch another buffer into org-mode.
5167 ;; Assume this is Greg's port, it uses easymenu
5193 org-display-table 4
5196 org-ellipsis)))
5201 ;; tag faces set outside customize.... force initialization.
5203 ;; Calc embedded
5205 ;; Modify a few syntax entries
5216 ;; Activate before-change-function
5220 ;; Check for running clock before killing a buffer
5222 ;; Initialize macros templates.
5224 ;; Initialize radio targets.
5226 ;; Indentation.
5229 ;; Filling and auto-filling.
5231 ;; Comments.
5233 ;; Beginning/end of defun
5236 ;; Next error for sparse trees
5238 ;; Make sure dependence stuff works reliably, even for users who set it
5239 ;; too late :-(
5251 ;; Align options lines
5253 'align-mode-rules-list
5258 ;; Imenu
5262 ;; Make isearch reveal context
5265 ;; Emacs 21 and XEmacs make use of the hook
5267 ;; Emacs 22 deals with this through a special variable
5272 ;; Setup the pcomplete hooks
5285 ;; If empty file that did not turn on org-mode automatically, make it to.
5301 ;; Try to set org-hide correctly
5308 org-emphasis-alist)
5309 st))
5322 "unspecified-bg"
5335 "Current time, possibly rounded to ROUNDING-MINUTES.
5336 When ROUNDING-MINUTES is not an integer, fall back on the car of
5337 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5338 the rounding returns a past time."
5350 res))))
5353 "Return today date, considering `org-extend-today-until'."
5358 ;;;; Font-Lock stuff, including the activators
5389 "Regular expression used to analyze links.
5390 Here is what the match groups contain after a match:
5391 1: http:
5392 2: http
5393 3: path
5394 4: [desc]
5405 "Create a regular expression which will match a balanced sexp.
5406 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5407 as single character strings.
5408 The regexp returned will match the entire expression including the
5409 delimiters. It will also define a single group which contains the
5410 match except for the outermost delimiters. The maximum depth of
5411 stacked delimiters is N. Escaping delimiters is not possible."
5440 "Update the link regular expressions.
5441 This should be called after the variable `org-link-types' has changed."
5445 org-link-re-with-space
5451 org-link-re-with-space2
5457 org-link-re-with-space3
5462 org-angle-link-re
5468 org-plain-link-re
5472 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5473 org-bracket-link-regexp
5475 org-bracket-link-analytic-regexp
5483 org-bracket-link-analytic-regexp++
5491 org-any-link-re
5500 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5503 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5504 "Regular expression matching time strings for analysis.
5505 This one does not require the space after the date, so it can be used
5507 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5524 "Regular expression matching a time stamp or time stamp range.
5530 "Run through the buffer and add overlays to emphasized strings."
5539 'face
5552 rtn))
5555 "Insert or change an emphasis, i.e. a font like bold or italic.
5556 If there is an active region, change that region to a new emphasis.
5557 If there is no region, just insert the marker characters and position
5558 the cursor between them.
5559 CHAR should be either the marker character, or the first character of the
5560 HTML tag associated with that emphasis. If CHAR is a space, the means
5561 to remove the emphasis of the selected region.
5562 If char is not given (for example in an interactive call) it
5563 will be prompted for."
5614 "Run through the buffer and add overlays to links."
5623 nil
5630 t)))
5638 t)))
5641 "When non-nil, fontify code in code blocks."
5648 "When non-nil, allow promoting a top level subtree.
5649 The leading star of the top level headline will be replaced
5650 by a #."
5661 "Fontify #+ lines and blocks, in the correct ways."
5664 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5665 limit t)
5673 end end1 quoting block-type ovl)
5676 ;; a single line of backend-specific content
5684 ; for backend-specific code
5685 t)
5687 ;; Truly a block
5700 beg end
5708 ;; remove old background overlays
5713 ;; add a background overlay
5728 t))
5748 t)
5754 ;; just any other in-buffer setting, but not indented
5758 t)
5762 "Run through the buffer and add overlays to links."
5771 t)))
5774 "Run through the buffer and add overlays to footnotes."
5781 'keymap org-mouse-map
5782 'help-echo
5784 "Footnote definition"
5786 'font-lock-fontified t
5787 'font-lock-multiline t
5791 "Run through the buffer and add overlays to bracketed links."
5796 ;; FIXME: Above we should remove the escapes. But that
5797 ;; requires another match, protecting match data, a lot
5798 ;; of overhead for font-lock.
5807 ;; We need to remove the invisible property here. Table narrowing
5808 ;; may have made some of this invisible.
5826 t)))
5829 "Run through the buffer and add overlays to dates."
5842 t)))
5851 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5855 "Run through the buffer and add overlays to target matches."
5863 'keymap org-mouse-map
5867 t)))))
5870 "Find all radio targets in this file and update the regular expression."
5885 t)))
5893 "Compute regular expression for LaTeX, entities and sub/superscript.
5894 Result depends on variable `org-highlight-latex-and-related'."
5896 'org-latex-and-related-regexp
5908 org-latex-regexps)))))
5915 "Highlight LaTeX snippets and environments, entities and sub/superscript.
5916 LIMIT bounds the search for syntax to highlight. Stop at first
5917 highlighted object, if any. Return t if some highlighting was
5918 done, nil otherwise."
5927 1
5935 nil)))
5938 "Restart `font-lock-mode', to force refontification."
5944 "Return a list of all targets in this file.
5945 When optional argument RADIO is non-nil, only find radio
5946 targets."
5951 ;; Make sure point is really within the object.
5956 rtn)))
5959 "Make regular expression matching all strings in TARGETS.
5960 The regular expression finds the targets also if there is a line break
5961 between words."
5970 x)
5971 targets
5983 t)))
5986 "Compute the outline level of the heading at point.
5987 If this is called at a normal headline, the level is the number of stars.
5988 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5993 0
5999 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
6006 "Functions that can manipulate `org-font-lock-extra-keywords'.
6007 This is called after `org-font-lock-extra-keywords' is defined, but before
6008 it is installed to be used by font lock. This can be useful if something
6012 "Run `org-font-lock-hook' within LIMIT."
6016 "Set font lock defaults for the current buffer."
6021 ;; Call the hook
6023 ;; Headlines
6030 ;; Table lines
6033 ;; Table internals
6038 ;; Drawers
6041 ;; Properties
6045 ;; Links
6055 ;; TODO keyword
6057 org-todo-regexp)
6059 ;; DONE
6067 nil)
6068 ;; Priorities
6070 ;; Tags
6072 ;; Special keywords
6077 ;; Emphasis
6082 ;; Checkboxes
6083 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6088 ;; Description list items
6091 ;; ARCHIVEd headings
6093 org-outline-regexp-bol
6096 ;; Specials
6100 ;; Code
6102 ;; COMMENT
6108 ;; Blocks and meta lines
6110 )))
6113 ;; Now set the full font-lock-keywords
6120 "Toggle the composition display of entities as UTF8 characters."
6136 "Display or hide properties in `org-custom-properties'."
6153 org-custom-properties)))))))
6156 "Find an entity to fontify."
6162 limit t)
6177 nil))))
6180 "Fontify string S like in Org-mode."
6192 "Get the right face for match N in font-lock matching of headlines."
6205 "Get the right face for a TODO keyword KWD.
6206 If KWD is a number, get the corresponding match group."
6214 "Create a face list that inherits INHERIT, but sets the foreground color.
6215 When FACE-OR-COLOR is not a string, just return it."
6219 face-or-color)
6220 face-or-color))
6223 "Add the special tag faces."
6232 "Add the special priority faces."
6240 org-priority-faces)))
6245 "Get the right face for a TODO keyword KWD.
6246 If KWD is a number, get the corresponding match group."
6253 "Remove fontification and activation overlays from links."
6258 deactivate-mark buffer-file-name buffer-file-truename)
6262 invisible t intangible t
6263 org-no-flyspell t org-emphasis t))
6273 "Remove specific display properties that have been added by font lock.
6274 The will remove the raise properties that are used to show superscripts
6275 and subscripts."
6285 "Add raise properties to sub/superscripts."
6289 org-match-substring-regexp
6290 org-match-substring-with-braces-regexp)
6291 limit t)
6301 ;; FIXME: Should we go back one character here, for a_b^c
6302 ;; (goto-char (1- pos)) ;????????????????????
6304 t
6306 'display
6322 t)))))
6324 ;;;; Visibility cycling, including org-goto and indirect buffer
6326 ;;; Cycling
6337 ;;;###autoload
6339 "TAB-action and visibility cycling for Org-mode.
6341 This is the command invoked in Org-mode by the TAB key. Its main purpose
6342 is outline visibility cycling, but it also invokes other actions
6343 in special contexts.
6345 - When this function is called with a prefix argument, rotate the entire
6346 buffer through 3 states (global cycling)
6347 1. OVERVIEW: Show only top-level headlines.
6348 2. CONTENTS: Show all headlines of all levels, but no body text.
6349 3. SHOW ALL: Show everything.
6350 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6351 determined by the variable `org-startup-folded', and by any VISIBILITY
6352 properties in the buffer.
6353 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6354 including any drawers.
6356 - When inside a table, re-align the table and move to the next field.
6358 - When point is at the beginning of a headline, rotate the subtree started
6359 by this line through 3 different states (local cycling)
6360 1. FOLDED: Only the main headline is shown.
6361 2. CHILDREN: The main headline and the direct children are shown.
6362 From this state, you can move to one of the children
6363 and zoom in further.
6364 3. SUBTREE: Show the entire subtree, including body text.
6365 If there is no subtree, switch directly from CHILDREN to FOLDED.
6367 - When point is at the beginning of an empty headline and the variable
6368 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6369 of the headline by demoting and promoting it to likely levels. This
6370 speeds up creation document structure by pressing TAB once or several
6371 times right after creating a new headline.
6373 - When there is a numeric prefix, go up to a heading with level ARG, do
6374 a `show-subtree' and return to the previous cursor position. If ARG
6375 is negative, go up that many levels.
6377 - When point is not at the beginning of a headline, execute the global
6378 binding for TAB, which is re-indenting the line. See the option
6379 `org-cycle-emulate-tab' for details.
6381 - Special case: if point is at the beginning of the buffer and there is
6382 no headline in line 1, this function will act as if called with prefix arg
6383 (C-u TAB, same as S-TAB) also when called without prefix arg.
6384 But only if also the variable `org-cycle-global-at-bob' is t."
6395 org-inlinetask-min-level
6400 limit-level)))
6403 outline-regexp
6411 org-cycle-hook))
6415 ;; special case: use global cycling
6429 ;; Table: enter it or move to the next field.
6440 ;; Global cycling: delegate to `org-cycle-internal-global'.
6443 ;; Drawers: delegate to `org-flag-drawer'.
6451 ;; Show-subtree, ARG levels up from here.
6459 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6467 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6474 ;; From there: TAB emulation and template completion.
6496 t
6505 "Do the global cycling action."
6506 ;; Hack to avoid display of messages for .org attachments in Gnus
6512 ;; We just created the overview - now do table of contents
6513 ;; This can be slow in very large buffers, so indicate action
6523 ;; We just showed the table of contents - now show everything
6531 ;; Default action: go to overview
6539 "Do the local cycling action."
6542 ;; First, determine end of headline (EOH), end of subtree or item
6543 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6563 ;; Determine end invisible part of buffer (EOL)
6565 ;; XEmacs doesn't have `next-single-char-property-change'
6575 ;; Find out what to do next and set `this-command'
6578 ;; Nothing is hidden behind this heading
6591 org-cycle-skip-children-state-if-no-children))))
6592 ;; Entire subtree is hidden in one line: children view
6599 ;; FIXME: This slows down the func way too much.
6600 ;; How keep drawers hidden in subtree anyway?
6601 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6602 ;; (org-cycle-hide-drawers 'subtree))
6604 ;; Fold every list in subtree to top-level items.
6627 ;; We just showed the children, or no children are there,
6628 ;; now show everything.
6637 ;; Default action: hide the subtree.
6645 ;;;###autoload
6647 "Cycle the global visibility. For details see `org-cycle'.
6649 With a numeric prefix, show all headlines up to that level."
6665 "Set the visibility required by startup options and properties."
6680 "Switch subtree visibilities according to :VISIBILITY: property."
6687 nil t)
6711 ;; This function uses outline-regexp instead of the more fundamental
6712 ;; org-outline-regexp so that org-cycle-global works outside of Org
6713 ;; buffers, where outline-regexp is needed.
6715 "Switch to overview mode, showing only top-level headlines.
6716 Really, this shows all headlines with level equal or greater than the level
6717 of the first headline in the buffer. This is important, because if the
6718 first headline is not level one, then (hide-sublevels 1) gives confusing
6719 results."
6733 "Show all headlines in the buffer, like a table of contents.
6734 With numerical argument N, show content up to level N."
6737 ;; Visit all headings and show their offspring
6744 t)
6753 "Adjust the window after a change in outline visibility.
6754 This function is the default value of the hook `org-cycle-hook'."
6764 "Remove outline overlays that do not contain non-white stuff."
6774 "Fix visibility issues after moving a subtree."
6775 ;; First, find a reasonable region to look at:
6776 ;; Start two siblings above, end three below
6794 ;; Properly fold already folded siblings
6805 "Show empty lines above all visible headlines.
6806 The region to be covered depends on STATE when called through
6807 `org-cycle-hook'. Lisp program can use t for STATE to get the
6808 entire buffer covered. Note that an empty line is only shown if there
6809 are at least `org-cycle-separator-lines' empty lines before the headline."
6819 beg end b e)
6843 ;; Never hide empty lines at the end of the file.
6853 "Move to the parent and re-show empty lines before visible headlines."
6859 "Return `org-agenda-files' list, plus all open org-mode files.
6860 This is useful for operations that need to scan all of a user's
6861 open and agenda-wise Org files."
6869 files))
6872 "Return the beginning position of the current entry."
6876 "Return the end position of the current entry."
6880 "Re-hide all drawers after a visibility state change."
6895 "Re-hide inline task when switching to 'contents visibility state."
6898 org-inlinetask-min-level)
6902 "When FLAG is non-nil, hide the drawer we are within.
6903 Otherwise make it visible."
6915 "Is the end of the current subtree visible?"
6920 "Move cursor to the first headline and recenter the headline.
6921 Optional argument N means put the headline into the Nth line of the window."
6927 ;;; Saving and restoring visibility
6930 "Return a list of the locations of all outline overlays.
6931 These are overlays with the `invisible' property value `outline'.
6932 The return value is a list of cons cells, with start and stop
6933 positions for each overlay.
6934 If USE-MARKERS is set, return the positions as markers."
6952 "Create visibility overlays for all positions in DATA.
6953 DATA should have been made by `org-outline-overlay-data'."
6961 data)))))
6963 ;;; Folding of blocks
6970 "Call FUNCTION at the head of all source blocks in the current buffer.
6971 Optional arguments START and END can be used to limit the range."
6983 "Toggle the visibility of all blocks in the current buffer."
6987 "Fold all blocks in the current buffer."
6993 "Unfold all blocks in the current buffer."
6999 "Toggle visibility of block at point."
7010 "Toggle the visibility of the current block."
7017 ov)
7033 ;; make the block accessible to isearch
7035 ov 'isearch-open-invisible
7046 ;; org-tab-after-check-for-cycling-hook
7048 ;; Remove overlays when changing major mode
7053 ;;; Org-goto
7059 "Set the keymap `org-goto'."
7063 mouse-drag-region universal-argument org-occur))
7064 cmd)
7080 nil)
7081 (org-defkey map "q" 'org-goto-quit)
7082 (org-defkey map "n" 'outline-next-visible-heading)
7083 (org-defkey map "p" 'outline-previous-visible-heading)
7084 (org-defkey map "f" 'outline-forward-same-level)
7085 (org-defkey map "b" 'outline-backward-same-level)
7086 (org-defkey map "u" 'outline-up-heading))
7087 (org-defkey map "/" 'org-occur)
7088 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7089 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7090 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7091 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7092 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7093 map)))
7095 (defconst org-goto-help
7096 "Browse buffer copy, to find location or copy text.%s
7097 RET=jump to location C-g=quit and return to previous location
7098 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7100 (defvar org-goto-start-pos) ; dynamically scoped parameter
7102 ;; FIXME: Docstring does not mention both interfaces
7103 (defun org-goto (&optional alternative-interface)
7104 "Look up a different location in the current file, keeping current visibility.
7106 When you want look-up or go to a different location in a
7107 document, the fastest way is often to fold the entire buffer and
7108 then dive into the tree. This method has the disadvantage, that
7109 the previous location will be folded, which may not be what you
7110 want.
7112 This command works around this by showing a copy of the current
7113 buffer in an indirect buffer, in overview mode. You can dive
7114 into the tree in that copy, use org-occur and incremental search
7115 to find a location. When pressing RET or `Q', the command
7116 returns to the original buffer in which the visibility is still
7117 unchanged. After RET it will also jump to the location selected
7118 in the indirect buffer and expose the headline hierarchy above.
7120 With a prefix argument, use the alternative interface: e.g. if
7121 `org-goto-interface' is 'outline use 'outline-path-completion."
7122 (interactive "P")
7123 (org-goto-map)
7124 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7125 (org-refile-use-outline-path t)
7126 (org-refile-target-verify-function nil)
7127 (interface
7128 (if (not alternative-interface)
7129 org-goto-interface
7130 (if (eq org-goto-interface 'outline)
7131 'outline-path-completion
7132 'outline)))
7133 (org-goto-start-pos (point))
7134 (selected-point
7135 (if (eq interface 'outline)
7136 (car (org-get-location (current-buffer) org-goto-help))
7137 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7138 (org-refile-check-position pa)
7139 (nth 3 pa)))))
7140 (if selected-point
7141 (progn
7142 (org-mark-ring-push org-goto-start-pos)
7143 (goto-char selected-point)
7144 (if (or (outline-invisible-p) (org-invisible-p2))
7145 (org-show-context 'org-goto)))
7146 (message "Quit"))))
7148 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7149 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7150 (defvar org-goto-local-auto-isearch-map) ; defined below
7152 (defun org-get-location (buf help)
7153 "Let the user select a location in the Org-mode buffer BUF.
7154 This function uses a recursive edit. It returns the selected position
7155 or nil."
7156 (org-no-popups
7157 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7158 (isearch-hide-immediately nil)
7159 (isearch-search-fun-function
7160 (lambda () 'org-goto-local-search-headings))
7161 (org-goto-selected-point org-goto-exit-command))
7162 (save-excursion
7163 (save-window-excursion
7164 (delete-other-windows)
7165 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7166 (org-pop-to-buffer-same-window
7167 (condition-case nil
7168 (make-indirect-buffer (current-buffer) "*org-goto*")
7169 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7170 (with-output-to-temp-buffer "*Org Help*"
7171 (princ (format help (if org-goto-auto-isearch
7172 " Just type for auto-isearch."
7173 " n/p/f/b/u to navigate, q to quit."))))
7174 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7175 (setq buffer-read-only nil)
7176 (let ((org-startup-truncated t)
7177 (org-startup-folded nil)
7178 (org-startup-align-all-tables nil))
7179 (org-mode)
7180 (org-overview))
7181 (setq buffer-read-only t)
7182 (if (and (boundp 'org-goto-start-pos)
7183 (integer-or-marker-p org-goto-start-pos))
7184 (let ((org-show-hierarchy-above t)
7185 (org-show-siblings t)
7186 (org-show-following-heading t))
7187 (goto-char org-goto-start-pos)
7188 (and (outline-invisible-p) (org-show-context)))
7189 (goto-char (point-min)))
7190 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7191 (message "Select location and press RET")
7192 (use-local-map org-goto-map)
7193 (recursive-edit)))
7194 (kill-buffer "*org-goto*")
7195 (cons org-goto-selected-point org-goto-exit-command))))
7197 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7198 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7199 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7200 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7202 (defun org-goto-local-search-headings (string bound noerror)
7203 "Search and make sure that any matches are in headlines."
7204 (catch 'return
7205 (while (if isearch-forward
7206 (search-forward string bound noerror)
7207 (search-backward string bound noerror))
7208 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7209 (and (member :headline context)
7210 (not (member :tags context))))
7211 (throw 'return (point))))))
7213 (defun org-goto-local-auto-isearch ()
7214 "Start isearch."
7215 (interactive)
7216 (goto-char (point-min))
7217 (let ((keys (this-command-keys)))
7218 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7219 (isearch-mode t)
7220 (isearch-process-search-char (string-to-char keys)))))
7222 (defun org-goto-ret (&optional arg)
7223 "Finish `org-goto' by going to the new location."
7224 (interactive "P")
7225 (setq org-goto-selected-point (point)
7226 org-goto-exit-command 'return)
7227 (throw 'exit nil))
7229 (defun org-goto-left ()
7230 "Finish `org-goto' by going to the new location."
7231 (interactive)
7232 (if (org-at-heading-p)
7233 (progn
7234 (beginning-of-line 1)
7235 (setq org-goto-selected-point (point)
7236 org-goto-exit-command 'left)
7237 (throw 'exit nil))
7238 (error "Not on a heading")))
7240 (defun org-goto-right ()
7241 "Finish `org-goto' by going to the new location."
7242 (interactive)
7243 (if (org-at-heading-p)
7244 (progn
7245 (setq org-goto-selected-point (point)
7246 org-goto-exit-command 'right)
7247 (throw 'exit nil))
7248 (error "Not on a heading")))
7250 (defun org-goto-quit ()
7251 "Finish `org-goto' without cursor motion."
7252 (interactive)
7253 (setq org-goto-selected-point nil)
7254 (setq org-goto-exit-command 'quit)
7255 (throw 'exit nil))
7257 ;;; Indirect buffer display of subtrees
7259 (defvar org-indirect-dedicated-frame nil
7260 "This is the frame being used for indirect tree display.")
7261 (defvar org-last-indirect-buffer nil)
7263 (defun org-tree-to-indirect-buffer (&optional arg)
7264 "Create indirect buffer and narrow it to current subtree.
7265 With a numerical prefix ARG, go up to this level and then take that tree.
7266 If ARG is negative, go up that many levels.
7268 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7269 indirect buffer previously made with this command, to avoid proliferation of
7270 indirect buffers. However, when you call the command with a \
7272 when `org-indirect-buffer-display' is `new-frame', the last buffer
7273 is kept so that you can work with several indirect buffers at the same time.
7274 If `org-indirect-buffer-display' is `dedicated-frame', the \
7276 requests that a new frame be made for the new buffer, so that the dedicated
7277 frame is not changed."
7278 (interactive "P")
7279 (let ((cbuf (current-buffer))
7280 (cwin (selected-window))
7281 (pos (point))
7282 beg end level heading ibuf)
7283 (save-excursion
7284 (org-back-to-heading t)
7285 (when (numberp arg)
7286 (setq level (org-outline-level))
7287 (if (< arg 0) (setq arg (+ level arg)))
7288 (while (> (setq level (org-outline-level)) arg)
7289 (org-up-heading-safe)))
7290 (setq beg (point)
7291 heading (org-get-heading))
7292 (org-end-of-subtree t t)
7293 (if (org-at-heading-p) (backward-char 1))
7294 (setq end (point)))
7295 (if (and (buffer-live-p org-last-indirect-buffer)
7296 (not (eq org-indirect-buffer-display 'new-frame))
7297 (not arg))
7298 (kill-buffer org-last-indirect-buffer))
7299 (setq ibuf (org-get-indirect-buffer cbuf)
7300 org-last-indirect-buffer ibuf)
7301 (cond
7302 ((or (eq org-indirect-buffer-display 'new-frame)
7303 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7304 (select-frame (make-frame))
7305 (delete-other-windows)
7306 (org-pop-to-buffer-same-window ibuf)
7307 (org-set-frame-title heading))
7308 ((eq org-indirect-buffer-display 'dedicated-frame)
7309 (raise-frame
7310 (select-frame (or (and org-indirect-dedicated-frame
7311 (frame-live-p org-indirect-dedicated-frame)
7312 org-indirect-dedicated-frame)
7313 (setq org-indirect-dedicated-frame (make-frame)))))
7314 (delete-other-windows)
7315 (org-pop-to-buffer-same-window ibuf)
7316 (org-set-frame-title (concat "Indirect: " heading)))
7317 ((eq org-indirect-buffer-display 'current-window)
7318 (org-pop-to-buffer-same-window ibuf))
7319 ((eq org-indirect-buffer-display 'other-window)
7320 (pop-to-buffer ibuf))
7321 (t (error "Invalid value")))
7322 (if (featurep 'xemacs)
7323 (save-excursion (org-mode) (turn-on-font-lock)))
7324 (narrow-to-region beg end)
7325 (show-all)
7326 (goto-char pos)
7327 (run-hook-with-args 'org-cycle-hook 'all)
7328 (and (window-live-p cwin) (select-window cwin))))
7330 (defun org-get-indirect-buffer (&optional buffer)
7331 (setq buffer (or buffer (current-buffer)))
7332 (let ((n 1) (base (buffer-name buffer)) bname)
7333 (while (buffer-live-p
7334 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7335 (setq n (1+ n)))
7336 (condition-case nil
7337 (make-indirect-buffer buffer bname 'clone)
7338 (error (make-indirect-buffer buffer bname)))))
7340 (defun org-set-frame-title (title)
7341 "Set the title of the current frame to the string TITLE."
7342 ;; FIXME: how to name a single frame in XEmacs???
7343 (unless (featurep 'xemacs)
7344 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7346 ;;;; Structure editing
7348 ;;; Inserting headlines
7350 (defun org-previous-line-empty-p ()
7351 (save-excursion
7352 (and (not (bobp))
7353 (or (beginning-of-line 0) t)
7354 (save-match-data
7357 (defun org-insert-heading (&optional force-heading invisible-ok)
7358 "Insert a new heading or item with same depth at point.
7359 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7360 If point is at the beginning of a headline, insert a sibling before the
7361 current headline. If point is not at the beginning, split the line,
7362 create the new headline with the text in the current line after point
7363 \(but see also the variable `org-M-RET-may-split-line').
7365 With a double prefix arg, force the heading to be inserted at the
7366 end of the parent subtree.
7368 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7369 This is important for non-interactive uses of the command."
7370 (interactive "P")
7371 (if (or (= (buffer-size) 0)
7372 (and (not (save-excursion
7373 (and (ignore-errors (org-back-to-heading invisible-ok))
7374 (org-at-heading-p))))
7375 (or force-heading (not (org-in-item-p)))))
7376 (progn
7378 (run-hooks 'org-insert-heading-hook))
7379 (when (or force-heading (not (org-insert-item)))
7380 (let* ((empty-line-p nil)
7381 (level nil)
7382 (on-heading (org-at-heading-p))
7383 (head (save-excursion
7384 (condition-case nil
7385 (progn
7386 (org-back-to-heading invisible-ok)
7387 (when (and (not on-heading)
7388 (featurep 'org-inlinetask)
7389 (integerp org-inlinetask-min-level)
7390 (>= (length (match-string 0))
7391 org-inlinetask-min-level))
7392 ;; Find a heading level before the inline task
7393 (while (and (setq level (org-up-heading-safe))
7394 (>= level org-inlinetask-min-level)))
7395 (if (org-at-heading-p)
7396 (org-back-to-heading invisible-ok)
7397 (error "This should not happen")))
7398 (setq empty-line-p (org-previous-line-empty-p))
7399 (match-string 0))
7400 (error "*"))))
7401 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7402 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7403 pos hide-previous previous-pos)
7404 (cond
7405 ((and (org-at-heading-p) (bolp)
7406 (or (bobp)
7407 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7408 ;; insert before the current line
7409 (open-line (if blank 2 1)))
7410 ((and (bolp)
7411 (not org-insert-heading-respect-content)
7412 (or (bobp)
7413 (save-excursion
7414 (backward-char 1) (not (outline-invisible-p)))))
7415 ;; insert right here
7416 nil)
7417 (t
7418 ;; somewhere in the line
7419 (save-excursion
7420 (setq previous-pos (point-at-bol))
7421 (end-of-line)
7422 (setq hide-previous (outline-invisible-p)))
7423 (and org-insert-heading-respect-content (org-show-subtree))
7424 (let ((split
7425 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7426 (save-excursion
7427 (let ((p (point)))
7428 (goto-char (point-at-bol))
7429 (and (looking-at org-complex-heading-regexp)
7430 (match-beginning 4)
7431 (> p (match-beginning 4)))))))
7432 tags pos)
7433 (cond
7434 (org-insert-heading-respect-content
7435 (if (not (equal force-heading '(16)))
7436 (progn
7437 (org-end-of-subtree nil t)
7439 (while (and (not (bobp))
7441 (backward-delete-char 1)))
7442 (org-up-heading-safe)
7443 (org-end-of-subtree nil t))
7444 (when (featurep 'org-inlinetask)
7445 (while (and (not (eobp))
7447 (>= (length (match-string 1))
7448 org-inlinetask-min-level))
7449 (org-end-of-subtree nil t)))
7450 (or (bolp) (newline))
7451 (or (org-previous-line-empty-p)
7452 (and blank (newline)))
7453 (open-line 1))
7454 ((org-at-heading-p)
7455 (when hide-previous
7456 (show-children)
7457 (org-show-entry))
7459 (setq tags (and (match-end 2) (match-string 2)))
7460 (and (match-end 1)
7461 (delete-region (match-beginning 1) (match-end 1)))
7462 (setq pos (point-at-bol))
7463 (or split (end-of-line 1))
7464 (delete-horizontal-space)
7466 (buffer-substring (point-at-bol) (point)))
7467 (insert " "))
7468 (newline (if blank 2 1))
7469 (when tags
7470 (save-excursion
7471 (goto-char pos)
7472 (end-of-line 1)
7473 (insert " " tags)
7474 (org-set-tags nil 'align))))
7475 (t
7476 (or split (end-of-line 1))
7477 (newline (if blank 2 1)))))))
7478 (insert head) (just-one-space)
7479 (setq pos (point))
7480 (end-of-line 1)
7481 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7482 (when (and org-insert-heading-respect-content hide-previous)
7483 (save-excursion
7484 (goto-char previous-pos)
7485 (hide-subtree)))
7486 (run-hooks 'org-insert-heading-hook)))))
7488 (defun org-get-heading (&optional no-tags no-todo)
7489 "Return the heading of the current entry, without the stars.
7490 When NO-TAGS is non-nil, don't include tags.
7491 When NO-TODO is non-nil, don't include TODO keywords."
7492 (save-excursion
7493 (org-back-to-heading t)
7494 (cond
7495 ((and no-tags no-todo)
7496 (looking-at org-complex-heading-regexp)
7497 (match-string 4))
7498 (no-tags
7499 (looking-at (concat org-outline-regexp
7502 (match-string 1))
7503 (no-todo
7504 (looking-at org-todo-line-regexp)
7505 (match-string 3))
7506 (t (looking-at org-heading-regexp)
7507 (match-string 2)))))
7509 (defvar orgstruct-mode) ; defined below
7511 (defun org-heading-components ()
7512 "Return the components of the current heading.
7513 This is a list with the following elements:
7514 - the level as an integer
7515 - the reduced level, different if `org-odd-levels-only' is set.
7516 - the TODO keyword, or nil
7517 - the priority character, like ?A, or nil if no priority is given
7518 - the headline text itself, or the tags string if no headline text
7519 - the tags string, or nil."
7520 (save-excursion
7521 (org-back-to-heading t)
7522 (if (let (case-fold-search)
7523 (looking-at
7524 (if orgstruct-mode
7525 org-heading-regexp
7526 org-complex-heading-regexp)))
7527 (if orgstruct-mode
7528 (list (length (match-string 1))
7529 (org-reduced-level (length (match-string 1)))
7530 nil
7531 nil
7532 (match-string 2)
7533 nil)
7534 (list (length (match-string 1))
7535 (org-reduced-level (length (match-string 1)))
7536 (org-match-string-no-properties 2)
7537 (and (match-end 3) (aref (match-string 3) 2))
7538 (org-match-string-no-properties 4)
7539 (org-match-string-no-properties 5))))))
7541 (defun org-get-entry ()
7542 "Get the entry text, after heading, entire subtree."
7543 (save-excursion
7544 (org-back-to-heading t)
7545 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7547 (defun org-insert-heading-after-current ()
7548 "Insert a new heading with same level as current, after current subtree."
7549 (interactive)
7550 (org-back-to-heading)
7551 (org-insert-heading)
7552 (org-move-subtree-down)
7553 (end-of-line 1))
7555 (defun org-insert-heading-respect-content (invisible-ok)
7556 "Insert heading with `org-insert-heading-respect-content' set to t."
7557 (interactive "P")
7558 (let ((org-insert-heading-respect-content t))
7559 (org-insert-heading t invisible-ok)))
7561 (defun org-insert-todo-heading-respect-content (&optional force-state)
7562 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7563 (interactive "P")
7564 (let ((org-insert-heading-respect-content t))
7565 (org-insert-todo-heading force-state t)))
7567 (defun org-insert-todo-heading (arg &optional force-heading)
7568 "Insert a new heading with the same level and TODO state as current heading.
7569 If the heading has no TODO state, or if the state is DONE, use the first
7570 state (TODO by default). Also one prefix arg, force first state. With two
7571 prefix args, force inserting at the end of the parent subtree."
7572 (interactive "P")
7573 (when (or force-heading (not (org-insert-item 'checkbox)))
7574 (org-insert-heading (or (and (equal arg '(16)) '(16))
7575 force-heading))
7576 (save-excursion
7577 (org-back-to-heading)
7578 (outline-previous-heading)
7579 (looking-at org-todo-line-regexp))
7580 (let*
7581 ((new-mark-x
7582 (if (or arg
7583 (not (match-beginning 2))
7584 (member (match-string 2) org-done-keywords))
7585 (car org-todo-keywords-1)
7586 (match-string 2)))
7587 (new-mark
7588 (or
7589 (run-hook-with-args-until-success
7590 'org-todo-get-default-hook new-mark-x nil)
7591 new-mark-x)))
7592 (beginning-of-line 1)
7593 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7594 (if org-treat-insert-todo-heading-as-state-change
7595 (org-todo new-mark)
7596 (insert new-mark " "))))
7597 (when org-provide-todo-statistics
7598 (org-update-parent-todo-statistics))))
7600 (defun org-insert-subheading (arg)
7601 "Insert a new subheading and demote it.
7602 Works for outline headings and for plain lists alike."
7603 (interactive "P")
7604 (org-insert-heading arg)
7605 (cond
7606 ((org-at-heading-p) (org-do-demote))
7607 ((org-at-item-p) (org-indent-item))))
7609 (defun org-insert-todo-subheading (arg)
7610 "Insert a new subheading with TODO keyword or checkbox and demote it.
7611 Works for outline headings and for plain lists alike."
7612 (interactive "P")
7613 (org-insert-todo-heading arg)
7614 (cond
7615 ((org-at-heading-p) (org-do-demote))
7616 ((org-at-item-p) (org-indent-item))))
7618 ;;; Promotion and Demotion
7620 (defvar org-after-demote-entry-hook nil
7621 "Hook run after an entry has been demoted.
7622 The cursor will be at the beginning of the entry.
7623 When a subtree is being demoted, the hook will be called for each node.")
7625 (defvar org-after-promote-entry-hook nil
7626 "Hook run after an entry has been promoted.
7627 The cursor will be at the beginning of the entry.
7628 When a subtree is being promoted, the hook will be called for each node.")
7630 (defun org-promote-subtree ()
7631 "Promote the entire subtree.
7632 See also `org-promote'."
7633 (interactive)
7634 (save-excursion
7635 (org-with-limited-levels (org-map-tree 'org-promote)))
7636 (org-fix-position-after-promote))
7638 (defun org-demote-subtree ()
7639 "Demote the entire subtree. See `org-demote'.
7640 See also `org-promote'."
7641 (interactive)
7642 (save-excursion
7643 (org-with-limited-levels (org-map-tree 'org-demote)))
7644 (org-fix-position-after-promote))
7647 (defun org-do-promote ()
7648 "Promote the current heading higher up the tree.
7649 If the region is active in `transient-mark-mode', promote all headings
7650 in the region."
7651 (interactive)
7652 (save-excursion
7653 (if (org-region-active-p)
7654 (org-map-region 'org-promote (region-beginning) (region-end))
7655 (org-promote)))
7656 (org-fix-position-after-promote))
7658 (defun org-do-demote ()
7659 "Demote the current heading lower down the tree.
7660 If the region is active in `transient-mark-mode', demote all headings
7661 in the region."
7662 (interactive)
7663 (save-excursion
7664 (if (org-region-active-p)
7665 (org-map-region 'org-demote (region-beginning) (region-end))
7666 (org-demote)))
7667 (org-fix-position-after-promote))
7669 (defun org-fix-position-after-promote ()
7670 "Make sure that after pro/demotion cursor position is right."
7671 (let ((pos (point)))
7672 (when (save-excursion
7673 (beginning-of-line 1)
7674 (looking-at org-todo-line-regexp)
7675 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7676 (cond ((eobp) (insert " "))
7677 ((eolp) (insert " "))
7678 ((equal (char-after) ?\ ) (forward-char 1))))))
7680 (defun org-current-level ()
7681 "Return the level of the current entry, or nil if before the first headline.
7682 The level is the number of stars at the beginning of the headline."
7683 (save-excursion
7684 (org-with-limited-levels
7685 (if (ignore-errors (org-back-to-heading t))
7686 (funcall outline-level)))))
7688 (defun org-get-previous-line-level ()
7689 "Return the outline depth of the last headline before the current line.
7690 Returns 0 for the first headline in the buffer, and nil if before the
7691 first headline."
7692 (let ((current-level (org-current-level))
7693 (prev-level (when (> (line-number-at-pos) 1)
7694 (save-excursion
7695 (beginning-of-line 0)
7696 (org-current-level)))))
7697 (cond ((null current-level) nil) ; Before first headline
7698 ((null prev-level) 0) ; At first headline
7699 (prev-level))))
7701 (defun org-reduced-level (l)
7702 "Compute the effective level of a heading.
7703 This takes into account the setting of `org-odd-levels-only'."
7704 (cond
7705 ((zerop l) 0)
7706 (org-odd-levels-only (1+ (floor (/ l 2))))
7707 (t l)))
7709 (defun org-level-increment ()
7710 "Return the number of stars that will be added or removed at a
7711 time to headlines when structure editing, based on the value of
7712 `org-odd-levels-only'."
7713 (if org-odd-levels-only 2 1))
7715 (defun org-get-valid-level (level &optional change)
7716 "Rectify a level change under the influence of `org-odd-levels-only'
7717 LEVEL is a current level, CHANGE is by how much the level should be
7718 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7719 even level numbers will become the next higher odd number."
7720 (if org-odd-levels-only
7721 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7722 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7723 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7724 (max 1 (+ level (or change 0)))))
7726 (if (boundp 'define-obsolete-function-alias)
7727 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7728 (define-obsolete-function-alias 'org-get-legal-level
7729 'org-get-valid-level)
7730 (define-obsolete-function-alias 'org-get-legal-level
7731 'org-get-valid-level "23.1")))
7733 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7734 ;; ̀org-with-limited-levels'
7735 (defun org-promote ()
7736 "Promote the current heading higher up the tree.
7737 If the region is active in `transient-mark-mode', promote all headings
7738 in the region."
7739 (org-back-to-heading t)
7740 (let* ((level (save-match-data (funcall outline-level)))
7741 (after-change-functions (remove 'flyspell-after-change-function
7742 after-change-functions))
7743 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7744 (diff (abs (- level (length up-head) -1))))
7745 (cond ((and (= level 1) org-called-with-limited-levels
7746 org-allow-promoting-top-level-subtree)
7747 (replace-match "# " nil t))
7748 ((= level 1)
7749 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7750 (t (replace-match up-head nil t)))
7751 ;; Fixup tag positioning
7752 (unless (= level 1)
7753 (and org-auto-align-tags (org-set-tags nil t))
7754 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7755 (run-hooks 'org-after-promote-entry-hook)))
7757 (defun org-demote ()
7758 "Demote the current heading lower down the tree.
7759 If the region is active in `transient-mark-mode', demote all headings
7760 in the region."
7761 (org-back-to-heading t)
7762 (let* ((level (save-match-data (funcall outline-level)))
7763 (after-change-functions (remove 'flyspell-after-change-function
7764 after-change-functions))
7765 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7766 (diff (abs (- level (length down-head) -1))))
7767 (replace-match down-head nil t)
7768 ;; Fixup tag positioning
7769 (and org-auto-align-tags (org-set-tags nil t))
7770 (if org-adapt-indentation (org-fixup-indentation diff))
7771 (run-hooks 'org-after-demote-entry-hook)))
7773 (defun org-cycle-level ()
7774 "Cycle the level of an empty headline through possible states.
7775 This goes first to child, then to parent, level, then up the hierarchy.
7776 After top level, it switches back to sibling level."
7777 (interactive)
7778 (let ((org-adapt-indentation nil))
7779 (when (org-point-at-end-of-empty-headline)
7780 (setq this-command 'org-cycle-level) ; Only needed for caching
7781 (let ((cur-level (org-current-level))
7782 (prev-level (org-get-previous-line-level)))
7783 (cond
7784 ;; If first headline in file, promote to top-level.
7785 ((= prev-level 0)
7786 (loop repeat (/ (- cur-level 1) (org-level-increment))
7787 do (org-do-promote)))
7788 ;; If same level as prev, demote one.
7789 ((= prev-level cur-level)
7790 (org-do-demote))
7791 ;; If parent is top-level, promote to top level if not already.
7792 ((= prev-level 1)
7793 (loop repeat (/ (- cur-level 1) (org-level-increment))
7794 do (org-do-promote)))
7795 ;; If top-level, return to prev-level.
7796 ((= cur-level 1)
7797 (loop repeat (/ (- prev-level 1) (org-level-increment))
7798 do (org-do-demote)))
7799 ;; If less than prev-level, promote one.
7800 ((< cur-level prev-level)
7801 (org-do-promote))
7802 ;; If deeper than prev-level, promote until higher than
7803 ;; prev-level.
7804 ((> cur-level prev-level)
7805 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7806 do (org-do-promote))))
7807 t))))
7809 (defun org-map-tree (fun)
7810 "Call FUN for every heading underneath the current one."
7811 (org-back-to-heading)
7812 (let ((level (funcall outline-level)))
7813 (save-excursion
7814 (funcall fun)
7815 (while (and (progn
7816 (outline-next-heading)
7817 (> (funcall outline-level) level))
7818 (not (eobp)))
7819 (funcall fun)))))
7821 (defun org-map-region (fun beg end)
7822 "Call FUN for every heading between BEG and END."
7823 (let ((org-ignore-region t))
7824 (save-excursion
7825 (setq end (copy-marker end))
7826 (goto-char beg)
7827 (if (and (re-search-forward org-outline-regexp-bol nil t)
7828 (< (point) end))
7829 (funcall fun))
7830 (while (and (progn
7831 (outline-next-heading)
7832 (< (point) end))
7833 (not (eobp)))
7834 (funcall fun)))))
7836 (defvar org-property-end-re) ; silence byte-compiler
7837 (defun org-fixup-indentation (diff)
7838 "Change the indentation in the current entry by DIFF.
7839 However, if any line in the current entry has no indentation, or if it
7840 would end up with no indentation after the change, nothing at all is done."
7841 (save-excursion
7842 (let ((end (save-excursion (outline-next-heading)
7843 (point-marker)))
7844 (prohibit (if (> diff 0)
7847 col)
7848 (unless (save-excursion (end-of-line 1)
7849 (re-search-forward prohibit end t))
7850 (while (and (< (point) end)
7852 (goto-char (match-end 0))
7853 (setq col (current-column))
7854 (if (< diff 0) (replace-match ""))
7855 (org-indent-to-column (+ diff col))))
7856 (move-marker end nil))))
7858 (defun org-convert-to-odd-levels ()
7859 "Convert an org-mode file with all levels allowed to one with odd levels.
7860 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7861 level 5 etc."
7862 (interactive)
7863 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7864 (let ((outline-level 'org-outline-level)
7865 (org-odd-levels-only nil) n)
7866 (save-excursion
7867 (goto-char (point-min))
7869 (setq n (- (length (match-string 0)) 2))
7870 (while (>= (setq n (1- n)) 0)
7871 (org-demote))
7872 (end-of-line 1))))))
7874 (defun org-convert-to-oddeven-levels ()
7875 "Convert an org-mode file with only odd levels to one with odd/even levels.
7876 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7877 file contains a section with an even level, conversion would
7878 destroy the structure of the file. An error is signaled in this
7879 case."
7880 (interactive)
7881 (goto-char (point-min))
7882 ;; First check if there are no even levels
7884 (org-show-context t)
7885 (error "Not all levels are odd in this file. Conversion not possible"))
7886 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7887 (let ((outline-regexp org-outline-regexp)
7888 (outline-level 'org-outline-level)
7889 (org-odd-levels-only nil) n)
7890 (save-excursion
7891 (goto-char (point-min))
7893 (setq n (/ (1- (length (match-string 0))) 2))
7894 (while (>= (setq n (1- n)) 0)
7895 (org-promote))
7896 (end-of-line 1))))))
7898 (defun org-tr-level (n)
7899 "Make N odd if required."
7900 (if org-odd-levels-only (1+ (/ n 2)) n))
7902 ;;; Vertical tree motion, cutting and pasting of subtrees
7904 (defun org-move-subtree-up (&optional arg)
7905 "Move the current subtree up past ARG headlines of the same level."
7906 (interactive "p")
7907 (org-move-subtree-down (- (prefix-numeric-value arg))))
7909 (defun org-move-subtree-down (&optional arg)
7910 "Move the current subtree down past ARG headlines of the same level."
7911 (interactive "p")
7912 (setq arg (prefix-numeric-value arg))
7913 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7914 'org-get-last-sibling))
7915 (ins-point (make-marker))
7916 (cnt (abs arg))
7917 (col (current-column))
7918 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7919 ;; Select the tree
7920 (org-back-to-heading)
7921 (setq beg0 (point))
7922 (save-excursion
7923 (setq ne-beg (org-back-over-empty-lines))
7924 (setq beg (point)))
7925 (save-match-data
7926 (save-excursion (outline-end-of-heading)
7927 (setq folded (outline-invisible-p)))
7928 (outline-end-of-subtree))
7929 (outline-next-heading)
7930 (setq ne-end (org-back-over-empty-lines))
7931 (setq end (point))
7932 (goto-char beg0)
7933 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7934 ;; include less whitespace
7935 (save-excursion
7936 (goto-char beg)
7937 (forward-line (- ne-beg ne-end))
7938 (setq beg (point))))
7939 ;; Find insertion point, with error handling
7940 (while (> cnt 0)
7941 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7942 (progn (goto-char beg0)
7943 (user-error "Cannot move past superior level or buffer limit")))
7944 (setq cnt (1- cnt)))
7945 (if (> arg 0)
7946 ;; Moving forward - still need to move over subtree
7947 (progn (org-end-of-subtree t t)
7948 (save-excursion
7949 (org-back-over-empty-lines)
7950 (or (bolp) (newline)))))
7951 (setq ne-ins (org-back-over-empty-lines))
7952 (move-marker ins-point (point))
7953 (setq txt (buffer-substring beg end))
7954 (org-save-markers-in-region beg end)
7955 (delete-region beg end)
7956 (org-remove-empty-overlays-at beg)
7957 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7958 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7960 (let ((bbb (point)))
7961 (insert-before-markers txt)
7962 (org-reinstall-markers-in-region bbb)
7963 (move-marker ins-point bbb))
7965 (setq ins-end (point))
7966 (goto-char ins-point)
7967 (org-skip-whitespace)
7968 (when (and (< arg 0)
7969 (org-first-sibling-p)
7970 (> ne-ins ne-beg))
7971 ;; Move whitespace back to beginning
7972 (save-excursion
7973 (goto-char ins-end)
7974 (let ((kill-whole-line t))
7975 (kill-line (- ne-ins ne-beg)) (point)))
7977 (move-marker ins-point nil)
7978 (if folded
7979 (hide-subtree)
7980 (org-show-entry)
7981 (show-children)
7982 (org-cycle-hide-drawers 'children))
7983 (org-clean-visibility-after-subtree-move)
7984 ;; move back to the initial column we were at
7985 (move-to-column col)))
7987 (defvar org-subtree-clip ""
7988 "Clipboard for cut and paste of subtrees.
7989 This is actually only a copy of the kill, because we use the normal kill
7990 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7992 (defvar org-subtree-clip-folded nil
7993 "Was the last copied subtree folded?
7994 This is used to fold the tree back after pasting.")
7996 (defun org-cut-subtree (&optional n)
7997 "Cut the current subtree into the clipboard.
7998 With prefix arg N, cut this many sequential subtrees.
7999 This is a short-hand for marking the subtree and then cutting it."
8000 (interactive "p")
8001 (org-copy-subtree n 'cut))
8003 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8004 "Cut the current subtree into the clipboard.
8005 With prefix arg N, cut this many sequential subtrees.
8006 This is a short-hand for marking the subtree and then copying it.
8007 If CUT is non-nil, actually cut the subtree.
8008 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8009 of some markers in the region, even if CUT is non-nil. This is
8010 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8011 (interactive "p")
8012 (let (beg end folded (beg0 (point)))
8013 (if (org-called-interactively-p 'any)
8014 (org-back-to-heading nil) ; take what looks like a subtree
8015 (org-back-to-heading t)) ; take what is really there
8016 (setq beg (point))
8018 (save-match-data
8019 (if nosubtrees
8020 (outline-next-heading)
8021 (save-excursion (outline-end-of-heading)
8022 (setq folded (outline-invisible-p)))
8023 (condition-case nil
8024 (org-forward-heading-same-level (1- n) t)
8025 (error nil))
8026 (org-end-of-subtree t t)))
8027 (setq end (point))
8028 (goto-char beg0)
8029 (when (> end beg)
8030 (setq org-subtree-clip-folded folded)
8031 (when (or cut force-store-markers)
8032 (org-save-markers-in-region beg end))
8033 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8034 (setq org-subtree-clip (current-kill 0))
8035 (message "%s: Subtree(s) with %d characters"
8036 (if cut "Cut" "Copied")
8037 (length org-subtree-clip)))))
8039 (defun org-paste-subtree (&optional level tree for-yank)
8040 "Paste the clipboard as a subtree, with modification of headline level.
8041 The entire subtree is promoted or demoted in order to match a new headline
8042 level.
8044 If the cursor is at the beginning of a headline, the same level as
8045 that headline is used to paste the tree.
8047 If not, the new level is derived from the *visible* headings
8048 before and after the insertion point, and taken to be the inferior headline
8049 level of the two. So if the previous visible heading is level 3 and the
8050 next is level 4 (or vice versa), level 4 will be used for insertion.
8051 This makes sure that the subtree remains an independent subtree and does
8052 not swallow low level entries.
8054 You can also force a different level, either by using a numeric prefix
8055 argument, or by inserting the heading marker by hand. For example, if the
8058 If optional TREE is given, use this text instead of the kill ring.
8060 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8061 move back over whitespace before inserting, and move point to the end of
8062 the inserted text when done."
8063 (interactive "P")
8064 (setq tree (or tree (and kill-ring (current-kill 0))))
8065 (unless (org-kill-is-subtree-p tree)
8066 (error "%s"
8067 (substitute-command-keys
8069 (org-with-limited-levels
8070 (let* ((visp (not (outline-invisible-p)))
8071 (txt tree)
8073 (old-level (if (string-match org-outline-regexp-bol txt)
8074 (- (match-end 0) (match-beginning 0) 1)
8075 -1))
8076 (force-level (cond (level (prefix-numeric-value level))
8078 (string-match
8080 (point-at-bol) (point))))
8081 (- (match-end 1) (match-beginning 1)))
8082 ((and (bolp)
8083 (looking-at org-outline-regexp))
8084 (- (match-end 0) (point) 1))))
8085 (previous-level (save-excursion
8086 (condition-case nil
8087 (progn
8088 (outline-previous-visible-heading 1)
8089 (if (looking-at ^re_)
8090 (- (match-end 0) (match-beginning 0) 1)
8091 1))
8092 (error 1))))
8093 (next-level (save-excursion
8094 (condition-case nil
8095 (progn
8096 (or (looking-at org-outline-regexp)
8097 (outline-next-visible-heading 1))
8098 (if (looking-at ^re_)
8099 (- (match-end 0) (match-beginning 0) 1)
8100 1))
8101 (error 1))))
8102 (new-level (or force-level (max previous-level next-level)))
8103 (shift (if (or (= old-level -1)
8104 (= new-level -1)
8105 (= old-level new-level))
8106 0
8107 (- new-level old-level)))
8108 (delta (if (> shift 0) -1 1))
8109 (func (if (> shift 0) 'org-demote 'org-promote))
8110 (org-odd-levels-only nil)
8111 beg end newend)
8112 ;; Remove the forced level indicator
8113 (if force-level
8114 (delete-region (point-at-bol) (point)))
8115 ;; Paste
8116 (beginning-of-line (if (bolp) 1 2))
8117 (setq beg (point))
8118 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8119 (insert-before-markers txt)
8121 (setq newend (point))
8122 (org-reinstall-markers-in-region beg)
8123 (setq end (point))
8124 (goto-char beg)
8126 (setq beg (point))
8127 (if (and (outline-invisible-p) visp)
8128 (save-excursion (outline-show-heading)))
8129 ;; Shift if necessary
8130 (unless (= shift 0)
8131 (save-restriction
8132 (narrow-to-region beg end)
8133 (while (not (= shift 0))
8134 (org-map-region func (point-min) (point-max))
8135 (setq shift (+ delta shift)))
8136 (goto-char (point-min))
8137 (setq newend (point-max))))
8138 (when (or (org-called-interactively-p 'interactive) for-yank)
8139 (message "Clipboard pasted as level %d subtree" new-level))
8140 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8141 kill-ring
8142 (eq org-subtree-clip (current-kill 0))
8143 org-subtree-clip-folded)
8144 ;; The tree was folded before it was killed/copied
8145 (hide-subtree))
8146 (and for-yank (goto-char newend)))))
8148 (defun org-kill-is-subtree-p (&optional txt)
8149 "Check if the current kill is an outline subtree, or a set of trees.
8150 Returns nil if kill does not start with a headline, or if the first
8151 headline level is not the largest headline level in the tree.
8152 So this will actually accept several entries of equal levels as well,
8153 which is OK for `org-paste-subtree'.
8154 If optional TXT is given, check this string instead of the current kill."
8155 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8156 (re (org-get-limited-outline-regexp))
8157 (^re (concat "^" re))
8158 (start-level (and kill
8159 (string-match
8161 kill)
8162 (- (match-end 2) (match-beginning 2) 1)))
8163 (start (1+ (or (match-beginning 2) -1))))
8164 (if (not start-level)
8165 (progn
8166 nil) ;; does not even start with a heading
8167 (catch 'exit
8168 (while (setq start (string-match ^re kill (1+ start)))
8169 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8170 (throw 'exit nil)))
8171 t))))
8173 (defvar org-markers-to-move nil
8174 "Markers that should be moved with a cut-and-paste operation.
8175 Those markers are stored together with their positions relative to
8176 the start of the region.")
8178 (defun org-save-markers-in-region (beg end)
8179 "Check markers in region.
8180 If these markers are between BEG and END, record their position relative
8181 to BEG, so that after moving the block of text, we can put the markers back
8182 into place.
8183 This function gets called just before an entry or tree gets cut from the
8184 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8185 called immediately, to move the markers with the entries."
8186 (setq org-markers-to-move nil)
8187 (when (featurep 'org-clock)
8188 (org-clock-save-markers-for-cut-and-paste beg end))
8189 (when (featurep 'org-agenda)
8190 (org-agenda-save-markers-for-cut-and-paste beg end)))
8192 (defun org-check-and-save-marker (marker beg end)
8193 "Check if MARKER is between BEG and END.
8194 If yes, remember the marker and the distance to BEG."
8195 (when (and (marker-buffer marker)
8196 (equal (marker-buffer marker) (current-buffer)))
8197 (if (and (>= marker beg) (< marker end))
8198 (push (cons marker (- marker beg)) org-markers-to-move))))
8200 (defun org-reinstall-markers-in-region (beg)
8201 "Move all remembered markers to their position relative to BEG."
8202 (mapc (lambda (x)
8203 (move-marker (car x) (+ beg (cdr x))))
8204 org-markers-to-move)
8205 (setq org-markers-to-move nil))
8207 (defun org-narrow-to-subtree ()
8208 "Narrow buffer to the current subtree."
8209 (interactive)
8210 (save-excursion
8211 (save-match-data
8212 (org-with-limited-levels
8213 (narrow-to-region
8214 (progn (org-back-to-heading t) (point))
8215 (progn (org-end-of-subtree t t)
8216 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8217 (point)))))))
8219 (defun org-narrow-to-block ()
8220 "Narrow buffer to the current block."
8221 (interactive)
8222 (let* ((case-fold-search t)
8225 (if blockp
8226 (narrow-to-region (car blockp) (cdr blockp))
8227 (error "Not in a block"))))
8229 (eval-when-compile
8230 (defvar org-property-drawer-re))
8232 (defvar org-property-start-re) ;; defined below
8233 (defun org-clone-subtree-with-time-shift (n &optional shift)
8234 "Clone the task (subtree) at point N times.
8235 The clones will be inserted as siblings.
8237 In interactive use, the user will be prompted for the number of
8238 clones to be produced, and for a time SHIFT, which may be a
8239 repeater as used in time stamps, for example `+3d'.
8241 When a valid repeater is given and the entry contains any time
8242 stamps, the clones will become a sequence in time, with time
8243 stamps in the subtree shifted for each clone produced. If SHIFT
8244 is nil or the empty string, time stamps will be left alone. The
8245 ID property of the original subtree is removed.
8247 If the original subtree did contain time stamps with a repeater,
8248 the following will happen:
8249 - the repeater will be removed in each clone
8250 - an additional clone will be produced, with the current, unshifted
8251 date(s) in the entry.
8252 - the original entry will be placed *after* all the clones, with
8253 repeater intact.
8254 - the start days in the repeater in the original entry will be shifted
8255 to past the last clone.
8256 In this way you can spell out a number of instances of a repeating task,
8257 and still retain the repeater to cover future instances of the task."
8258 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
8259 (let (beg end template task idprop
8260 shift-n shift-what doshift nmin nmax (n-no-remove -1)
8261 (drawer-re org-drawer-regexp))
8262 (if (not (and (integerp n) (> n 0)))
8263 (error "Invalid number of replications %s" n))
8266 shift)))
8267 (error "Invalid shift specification %s" shift))
8268 (when doshift
8269 (setq shift-n (string-to-number (match-string 1 shift))
8270 shift-what (cdr (assoc (match-string 2 shift)
8271 '(("d" . day) ("w" . week)
8272 ("m" . month) ("y" . year))))))
8273 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8274 (setq nmin 1 nmax n)
8275 (org-back-to-heading t)
8276 (setq beg (point))
8277 (setq idprop (org-entry-get nil "ID"))
8278 (org-end-of-subtree t t)
8280 (setq end (point))
8281 (setq template (buffer-substring beg end))
8282 (when (and doshift
8284 (delete-region beg end)
8285 (setq end beg)
8286 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8287 (goto-char end)
8288 (loop for n from nmin to nmax do
8289 ;; prepare clone
8290 (with-temp-buffer
8291 (insert template)
8292 (org-mode)
8293 (goto-char (point-min))
8294 (org-show-subtree)
8295 (and idprop (if org-clone-delete-id
8296 (org-entry-delete nil "ID")
8297 (org-id-get-create t)))
8298 (unless (= n 0)
8300 (kill-whole-line))
8301 (goto-char (point-min))
8302 (while (re-search-forward drawer-re nil t)
8303 (mapc (lambda (d)
8304 (org-remove-empty-drawer-at d (point))) org-drawers)))
8305 (goto-char (point-min))
8306 (when doshift
8307 (while (re-search-forward org-ts-regexp-both nil t)
8308 (org-timestamp-change (* n shift-n) shift-what))
8309 (unless (= n n-no-remove)
8310 (goto-char (point-min))
8311 (while (re-search-forward org-ts-regexp nil t)
8312 (save-excursion
8313 (goto-char (match-beginning 0))
8315 (delete-region (match-beginning 1) (match-end 1)))))))
8316 (setq task (buffer-string)))
8317 (insert task))
8318 (goto-char beg)))
8320 ;;; Outline Sorting
8322 (defun org-sort (with-case)
8323 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8324 Optional argument WITH-CASE means sort case-sensitively."
8325 (interactive "P")
8326 (cond
8327 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8328 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8329 (t
8330 (org-call-with-arg 'org-sort-entries with-case))))
8332 (defun org-sort-remove-invisible (s)
8333 "Remove invisible links from string S."
8334 (remove-text-properties 0 (length s) org-rm-props s)
8335 (while (string-match org-bracket-link-regexp s)
8336 (setq s (replace-match (if (match-end 2)
8337 (match-string 3 s)
8338 (match-string 1 s)) t t s)))
8339 (let ((st (format " %s " s)))
8340 (while (string-match org-emph-re st)
8341 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8342 (setq s (substring st 1 -1)))
8343 s)
8345 (defvar org-priority-regexp) ; defined later in the file
8347 (defvar org-after-sorting-entries-or-items-hook nil
8348 "Hook that is run after a bunch of entries or items have been sorted.
8349 When children are sorted, the cursor is in the parent line when this
8350 hook gets called. When a region or a plain list is sorted, the cursor
8351 will be in the first entry of the sorted region/list.")
8353 (defun org-sort-entries
8354 (&optional with-case sorting-type getkey-func compare-func property)
8355 "Sort entries on a certain level of an outline tree.
8356 If there is an active region, the entries in the region are sorted.
8357 Else, if the cursor is before the first entry, sort the top-level items.
8358 Else, the children of the entry at point are sorted.
8360 Sorting can be alphabetically, numerically, by date/time as given by
8361 a time stamp, by a property, by priority order, or by a custom function.
8363 The command prompts for the sorting type unless it has been given to the
8364 function through the SORTING-TYPE argument, which needs to be a character,
8365 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8366 precise meaning of each character:
8368 n Numerically, by converting the beginning of the entry/item to a number.
8369 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8370 o By order of TODO keywords.
8371 t By date/time, either the first active time stamp in the entry, or, if
8372 none exist, by the first inactive one.
8373 s By the scheduled date/time.
8374 d By deadline date/time.
8375 c By creation time, which is assumed to be the first inactive time stamp
8376 at the beginning of a line.
8377 p By priority according to the cookie.
8378 r By the value of a property.
8380 Capital letters will reverse the sort order.
8382 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8383 called with point at the beginning of the record. It must return either
8384 a string or a number that should serve as the sorting key for that record.
8386 Comparing entries ignores case by default. However, with an optional argument
8387 WITH-CASE, the sorting considers case as well.
8389 Sorting is done against the visible part of the headlines, it ignores hidden
8390 links."
8391 (interactive "P")
8392 (let ((case-func (if with-case 'identity 'downcase))
8393 (cmstr
8394 ;; The clock marker is lost when using `sort-subr', let's
8395 ;; store the clocking string.
8396 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8397 (save-excursion
8398 (goto-char org-clock-marker)
8399 (looking-back "^.*") (match-string-no-properties 0))))
8400 start beg end stars re re2
8401 txt what tmp)
8402 ;; Find beginning and end of region to sort
8403 (cond
8404 ((org-region-active-p)
8405 ;; we will sort the region
8406 (setq end (region-end)
8407 what "region")
8408 (goto-char (region-beginning))
8409 (if (not (org-at-heading-p)) (outline-next-heading))
8410 (setq start (point)))
8411 ((or (org-at-heading-p)
8412 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8413 ;; we will sort the children of the current headline
8414 (org-back-to-heading)
8415 (setq start (point)
8416 end (progn (org-end-of-subtree t t)
8418 (org-back-over-empty-lines)
8419 (point))
8420 what "children")
8421 (goto-char start)
8422 (show-subtree)
8423 (outline-next-heading))
8424 (t
8425 ;; we will sort the top-level entries in this file
8426 (goto-char (point-min))
8427 (or (org-at-heading-p) (outline-next-heading))
8428 (setq start (point))
8429 (goto-char (point-max))
8430 (beginning-of-line 1)
8432 ;; File ends in a non-white line
8433 (end-of-line 1)
8435 (setq end (point-max))
8436 (setq what "top-level")
8437 (goto-char start)
8438 (show-all)))
8440 (setq beg (point))
8441 (if (>= beg end) (error "Nothing to sort"))
8444 (setq stars (match-string 1)
8445 re (concat "^" (regexp-quote stars) " +")
8447 txt (buffer-substring beg end))
8449 (if (and (not (equal stars "*")) (string-match re2 txt))
8450 (error "Region to sort contains a level above the first entry"))
8452 (unless sorting-type
8453 (message
8454 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8456 A/N/P/R/O/F/T/S/D/C means reversed:"
8457 what)
8458 (setq sorting-type (read-char-exclusive))
8460 (unless getkey-func
8461 (and (= (downcase sorting-type) ?f)
8462 (setq getkey-func
8463 (org-icompleting-read "Sort using function: "
8464 obarray 'fboundp t nil nil))
8465 (setq getkey-func (intern getkey-func))))
8467 (and (= (downcase sorting-type) ?r)
8468 (not property)
8469 (setq property
8470 (org-icompleting-read "Property: "
8471 (mapcar 'list (org-buffer-property-keys t))
8472 nil t))))
8474 (message "Sorting entries...")
8476 (save-restriction
8477 (narrow-to-region start end)
8478 (let ((dcst (downcase sorting-type))
8479 (case-fold-search nil)
8480 (now (current-time)))
8481 (sort-subr
8482 (/= dcst sorting-type)
8483 ;; This function moves to the beginning character of the "record" to
8484 ;; be sorted.
8485 (lambda nil
8486 (if (re-search-forward re nil t)
8487 (goto-char (match-beginning 0))
8488 (goto-char (point-max))))
8489 ;; This function moves to the last character of the "record" being
8490 ;; sorted.
8491 (lambda nil
8492 (save-match-data
8493 (condition-case nil
8494 (outline-forward-same-level 1)
8495 (error
8496 (goto-char (point-max))))))
8497 ;; This function returns the value that gets sorted against.
8498 (lambda nil
8499 (cond
8500 ((= dcst ?n)
8501 (if (looking-at org-complex-heading-regexp)
8502 (string-to-number (org-sort-remove-invisible (match-string 4)))
8503 nil))
8504 ((= dcst ?a)
8505 (if (looking-at org-complex-heading-regexp)
8506 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8507 nil))
8508 ((= dcst ?t)
8509 (let ((end (save-excursion (outline-next-heading) (point))))
8510 (if (or (re-search-forward org-ts-regexp end t)
8511 (re-search-forward org-ts-regexp-both end t))
8512 (org-time-string-to-seconds (match-string 0))
8513 (org-float-time now))))
8514 ((= dcst ?c)
8515 (let ((end (save-excursion (outline-next-heading) (point))))
8516 (if (re-search-forward
8518 end t)
8519 (org-time-string-to-seconds (match-string 0))
8520 (org-float-time now))))
8521 ((= dcst ?s)
8522 (let ((end (save-excursion (outline-next-heading) (point))))
8523 (if (re-search-forward org-scheduled-time-regexp end t)
8524 (org-time-string-to-seconds (match-string 1))
8525 (org-float-time now))))
8526 ((= dcst ?d)
8527 (let ((end (save-excursion (outline-next-heading) (point))))
8528 (if (re-search-forward org-deadline-time-regexp end t)
8529 (org-time-string-to-seconds (match-string 1))
8530 (org-float-time now))))
8531 ((= dcst ?p)
8532 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8533 (string-to-char (match-string 2))
8534 org-default-priority))
8535 ((= dcst ?r)
8536 (or (org-entry-get nil property) ""))
8537 ((= dcst ?o)
8538 (if (looking-at org-complex-heading-regexp)
8539 (- 9999 (length (member (match-string 2)
8540 org-todo-keywords-1)))))
8541 ((= dcst ?f)
8542 (if getkey-func
8543 (progn
8544 (setq tmp (funcall getkey-func))
8545 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8546 tmp)
8547 (error "Invalid key function `%s'" getkey-func)))
8548 (t (error "Invalid sorting type `%c'" sorting-type))))
8549 nil
8550 (cond
8551 ((= dcst ?a) 'string<)
8552 ((= dcst ?f) compare-func)
8553 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8554 (run-hooks 'org-after-sorting-entries-or-items-hook)
8555 ;; Reset the clock marker if needed
8556 (when cmstr
8557 (save-excursion
8558 (goto-char start)
8559 (search-forward cmstr nil t)
8560 (move-marker org-clock-marker (point))))
8561 (message "Sorting entries...done")))
8563 (defun org-do-sort (table what &optional with-case sorting-type)
8564 "Sort TABLE of WHAT according to SORTING-TYPE.
8565 The user will be prompted for the SORTING-TYPE if the call to this
8566 function does not specify it. WHAT is only for the prompt, to indicate
8567 what is being sorted. The sorting key will be extracted from
8568 the car of the elements of the table.
8569 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8570 (unless sorting-type
8571 (message
8572 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8573 what)
8574 (setq sorting-type (read-char-exclusive)))
8575 (let ((dcst (downcase sorting-type))
8576 extractfun comparefun)
8577 ;; Define the appropriate functions
8578 (cond
8579 ((= dcst ?n)
8580 (setq extractfun 'string-to-number
8581 comparefun (if (= dcst sorting-type) '< '>)))
8582 ((= dcst ?a)
8583 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8584 (lambda(x) (downcase (org-sort-remove-invisible x))))
8585 comparefun (if (= dcst sorting-type)
8586 'string<
8587 (lambda (a b) (and (not (string< a b))
8588 (not (string= a b)))))))
8589 ((= dcst ?t)
8590 (setq extractfun
8591 (lambda (x)
8592 (if (or (string-match org-ts-regexp x)
8593 (string-match org-ts-regexp-both x))
8594 (org-float-time
8595 (org-time-string-to-time (match-string 0 x)))
8596 0))
8597 comparefun (if (= dcst sorting-type) '< '>)))
8598 (t (error "Invalid sorting type `%c'" sorting-type)))
8600 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8601 table)
8602 (lambda (a b) (funcall comparefun (car a) (car b))))))
8605 ;;; The orgstruct minor mode
8607 ;; Define a minor mode which can be used in other modes in order to
8608 ;; integrate the org-mode structure editing commands.
8610 ;; This is really a hack, because the org-mode structure commands use
8611 ;; keys which normally belong to the major mode. Here is how it
8612 ;; works: The minor mode defines all the keys necessary to operate the
8613 ;; structure commands, but wraps the commands into a function which
8614 ;; tests if the cursor is currently at a headline or a plain list
8615 ;; item. If that is the case, the structure command is used,
8616 ;; temporarily setting many Org-mode variables like regular
8617 ;; expressions for filling etc. However, when any of those keys is
8618 ;; used at a different location, function uses `key-binding' to look
8619 ;; up if the key has an associated command in another currently active
8620 ;; keymap (minor modes, major mode, global), and executes that
8621 ;; command. There might be problems if any of the keys is otherwise
8622 ;; used as a prefix key.
8624 (defcustom orgstruct-heading-prefix-regexp ""
8625 "Regexp that matches the custom prefix of Org headlines in
8626 orgstruct(++)-mode."
8627 :group 'org
8628 :version "24.4"
8629 :package-version '(Org . "8.0")
8630 :type 'string)
8631 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8633 (defcustom orgstruct-setup-hook nil
8634 "Hook run after orgstruct-mode-map is filled."
8635 :group 'org
8636 :type 'hook)
8638 (defvar orgstruct-initialized nil)
8640 (defvar org-local-vars nil
8641 "List of local variables, for use by `orgstruct-mode'.")
8643 ;;;###autoload
8644 (define-minor-mode orgstruct-mode
8645 "Toggle the minor mode `orgstruct-mode'.
8646 This mode is for using Org-mode structure commands in other
8647 modes. The following keys behave as if Org-mode were active, if
8648 the cursor is on a headline, or on a plain list item (both as
8649 defined by Org-mode)."
8650 nil " OrgStruct" (make-sparse-keymap)
8651 (when orgstruct-mode
8652 (org-load-modules-maybe)
8653 (unless orgstruct-initialized
8654 (orgstruct-setup)
8655 (setq orgstruct-initialized t))))
8657 ;;;###autoload
8658 (defun turn-on-orgstruct ()
8659 "Unconditionally turn on `orgstruct-mode'."
8660 (orgstruct-mode 1))
8662 (defvar org-fb-vars nil)
8663 (make-variable-buffer-local 'org-fb-vars)
8664 (defun orgstruct++-mode (&optional arg)
8665 "Toggle `orgstruct-mode', the enhanced version of it.
8666 In addition to setting orgstruct-mode, this also exports all
8667 indentation and autofilling variables from org-mode into the
8668 buffer. It will also recognize item context in multiline items."
8669 (interactive "P")
8670 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8671 (if (< arg 1)
8672 (progn (orgstruct-mode -1)
8673 (mapc (lambda(v)
8674 (org-set-local (car v)
8675 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8676 org-fb-vars))
8677 (orgstruct-mode 1)
8678 (setq org-fb-vars nil)
8679 (let (var val)
8680 (mapc
8681 (lambda (x)
8682 (when (string-match
8684 (symbol-name (car x)))
8685 (setq var (car x) val (nth 1 x))
8686 (push (list var `(quote ,(eval var))) org-fb-vars)
8687 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8688 org-local-vars)
8689 (org-set-local 'orgstruct-is-++ t))))
8691 (defvar orgstruct-is-++ nil
8692 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8693 (make-variable-buffer-local 'orgstruct-is-++)
8695 ;;;###autoload
8696 (defun turn-on-orgstruct++ ()
8697 "Unconditionally turn on `orgstruct++-mode'."
8698 (orgstruct++-mode 1))
8700 (defun orgstruct-error ()
8701 "Error when there is no default binding for a structure key."
8702 (interactive)
8703 (error "This key has no function outside structure elements"))
8705 (defun orgstruct-setup ()
8706 "Setup orgstruct keymap."
8707 (dolist (f
8708 '("org-meta"
8709 "org-shift"
8710 "org-shiftmeta"
8711 org-shifttab
8712 org-backward-element
8713 org-backward-heading-same-level
8714 org-ctrl-c-ret
8715 org-cycle
8716 org-forward-heading-same-level
8717 org-insert-heading
8718 org-insert-heading-respect-content
8719 org-kill-note-or-show-branches
8720 org-mark-subtree
8721 org-narrow-to-subtree
8722 org-promote-subtree
8723 org-reveal
8724 org-show-subtree
8725 org-sort
8726 org-up-element
8727 outline-demote
8728 outline-next-visible-heading
8729 outline-previous-visible-heading
8730 outline-promote
8731 outline-up-heading
8732 show-children))
8733 (dolist (f (if (stringp f)
8734 (let ((flist))
8735 (dolist (postfix
8736 '("-return" "tab" "left" "right" "up" "down")
8737 flist)
8738 (let ((f (intern (concat f postfix))))
8739 (when (fboundp f)
8740 (push f flist)))))
8741 (list f)))
8742 (dolist (binding (nconc (where-is-internal f org-mode-map)
8743 (where-is-internal f outline-mode-map)))
8744 ;; TODO use local-function-key-map
8745 (dolist (rep '(("<tab>" . "TAB")
8746 ("<return>" . "RET")
8747 ("<escape>" . "ESC")
8748 ("<delete>" . "DEL")))
8749 (setq binding (read-kbd-macro (replace-regexp-in-string
8750 (regexp-quote (car rep))
8751 (cdr rep)
8752 (key-description binding)))))
8753 (let ((key (lookup-key orgstruct-mode-map binding)))
8754 (when (or (not key) (numberp key))
8755 (condition-case nil
8756 (org-defkey orgstruct-mode-map
8757 binding
8758 (orgstruct-make-binding f binding))
8759 (error nil)))))))
8760 (run-hooks 'orgstruct-setup-hook))
8762 (defun orgstruct-make-binding (fun key)
8763 "Create a function for binding in the structure minor mode.
8764 FUN is the command to call inside a table. KEY is the key that
8765 should be checked in for a command to execute outside of tables."
8766 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
8767 (let ((nname name)
8768 (i 0))
8769 (while (fboundp (intern nname))
8770 (setq nname (format "%s-%d" name (setq i (1+ i)))))
8771 (setq name (intern nname)))
8772 (eval
8773 (let ((bindings '((org-heading-regexp
8774 (concat "^"
8775 orgstruct-heading-prefix-regexp
8777 (org-outline-regexp
8779 (org-outline-regexp-bol
8780 (concat "^" org-outline-regexp))
8781 (outline-regexp org-outline-regexp)
8783 (outline-level 'outline-level)
8784 (outline-heading-alist))))
8785 `(defun ,name (arg)
8787 "Outside of structure, run the binding of `"
8788 (key-description key) "'.")
8789 (interactive "p")
8790 (unless
8791 (let* ,bindings
8792 (when (org-context-p 'headline 'item
8793 ,(when (memq fun '(org-insert-heading))
8794 '(when orgstruct-is-++
8795 'item-body)))
8796 (org-run-like-in-org-mode
8797 (lambda ()
8798 (interactive)
8799 (let* ,bindings
8800 (call-interactively ',fun))))
8801 t))
8802 (let* ((orgstruct-mode)
8803 (binding (key-binding ,key)))
8804 (if (keymapp binding)
8805 (set-temporary-overlay-map binding)
8806 (call-interactively
8807 (or binding 'orgstruct-error))))))))
8808 name))
8810 (defun org-contextualize-keys (alist contexts)
8811 "Return valid elements in ALIST depending on CONTEXTS.
8813 `org-agenda-custom-commands' or `org-capture-templates' are the
8814 values used for ALIST, and `org-agenda-custom-commands-contexts'
8815 or `org-capture-templates-contexts' are the associated contexts
8816 definitions."
8817 (let ((contexts
8818 ;; normalize contexts
8819 (mapcar
8820 (lambda(c) (cond ((listp (cadr c))
8821 (list (car c) (car c) (cadr c)))
8822 ((string= "" (cadr c))
8823 (list (car c) (car c) (caddr c)))
8824 (t c))) contexts))
8825 (a alist) c r s)
8826 ;; loop over all commands or templates
8827 (while (setq c (pop a))
8828 (let (vrules repl)
8829 (cond
8830 ((not (assoc (car c) contexts))
8831 (push c r))
8832 ((and (assoc (car c) contexts)
8833 (setq vrules (org-contextualize-validate-key
8834 (car c) contexts)))
8835 (mapc (lambda (vr)
8836 (when (not (equal (car vr) (cadr vr)))
8837 (setq repl vr))) vrules)
8838 (if (not repl) (push c r)
8839 (push (cadr repl) s)
8840 (push
8841 (cons (car c)
8842 (cdr (or (assoc (cadr repl) alist)
8843 (error "Undefined key `%s' as contextual replacement for `%s'"
8844 (cadr repl) (car c)))))
8845 r))))))
8846 ;; Return limited ALIST, possibly with keys modified, and deduplicated
8847 (delq
8848 nil
8849 (delete-dups
8850 (mapcar (lambda (x)
8851 (let ((tpl (car x)))
8852 (when (not (delq
8853 nil
8854 (mapcar (lambda(y)
8855 (equal y tpl)) s))) x)))
8856 (reverse r))))))
8858 (defun org-contextualize-validate-key (key contexts)
8859 "Check CONTEXTS for agenda or capture KEY."
8860 (let (r rr res)
8861 (while (setq r (pop contexts))
8862 (mapc
8863 (lambda (rr)
8864 (when
8865 (and (equal key (car r))
8866 (if (functionp rr) (funcall rr)
8867 (or (and (eq (car rr) 'in-file)
8868 (buffer-file-name)
8869 (string-match (cdr rr) (buffer-file-name)))
8870 (and (eq (car rr) 'in-mode)
8871 (string-match (cdr rr) (symbol-name major-mode)))
8872 (and (eq (car rr) 'in-buffer)
8873 (string-match (cdr rr) (buffer-name)))
8874 (when (and (eq (car rr) 'not-in-file)
8875 (buffer-file-name))
8876 (not (string-match (cdr rr) (buffer-file-name))))
8877 (when (eq (car rr) 'not-in-mode)
8878 (not (string-match (cdr rr) (symbol-name major-mode))))
8879 (when (eq (car rr) 'not-in-buffer)
8880 (not (string-match (cdr rr) (buffer-name)))))))
8881 (push r res)))
8882 (car (last r))))
8883 (delete-dups (delq nil res))))
8885 (defun org-context-p (&rest contexts)
8886 "Check if local context is any of CONTEXTS.
8887 Possible values in the list of contexts are `table', `headline', and `item'."
8888 (let ((pos (point)))
8889 (goto-char (point-at-bol))
8890 (prog1 (or (and (memq 'table contexts)
8892 (and (memq 'headline contexts)
8893 (looking-at org-outline-regexp))
8894 (and (memq 'item contexts)
8896 (and (memq 'item-body contexts)
8897 (org-in-item-p)))
8898 (goto-char pos))))
8900 (defun org-get-local-variables ()
8901 "Return a list of all local variables in an Org mode buffer."
8902 (let (varlist)
8903 (with-current-buffer (get-buffer-create "*Org tmp*")
8904 (erase-buffer)
8905 (org-mode)
8906 (setq varlist (buffer-local-variables)))
8907 (kill-buffer "*Org tmp*")
8908 (delq nil
8909 (mapcar
8910 (lambda (x)
8911 (setq x
8912 (if (symbolp x)
8913 (list x)
8914 (list (car x) (cdr x))))
8915 (if (and (not (get (car x) 'org-state))
8916 (string-match
8917 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
8918 (symbol-name (car x))))
8919 x nil))
8920 varlist))))
8922 (defun org-clone-local-variables (from-buffer &optional regexp)
8923 "Clone local variables from FROM-BUFFER.
8924 Optional argument REGEXP selects variables to clone."
8925 (mapc
8926 (lambda (pair)
8927 (and (symbolp (car pair))
8928 (or (null regexp)
8929 (string-match regexp (symbol-name (car pair))))
8930 (set (make-local-variable (car pair))
8931 (cdr pair))))
8932 (buffer-local-variables from-buffer)))
8934 ;;;###autoload
8935 (defun org-run-like-in-org-mode (cmd)
8936 "Run a command, pretending that the current buffer is in Org-mode.
8937 This will temporarily bind local variables that are typically bound in
8938 Org-mode to the values they have in Org-mode, and then interactively
8939 call CMD."
8940 (org-load-modules-maybe)
8941 (unless org-local-vars
8942 (setq org-local-vars (org-get-local-variables)))
8943 (let (binds)
8944 (dolist (var org-local-vars)
8945 (when (or (not (boundp (car var)))
8946 (eq (symbol-value (car var))
8947 (default-value (car var))))
8948 (push (list (car var) `(quote ,(cadr var))) binds)))
8949 (eval `(let ,binds
8950 (call-interactively (quote ,cmd))))))
8952 ;;;; Archiving
8954 (defun org-get-category (&optional pos force-refresh)
8955 "Get the category applying to position POS."
8956 (save-match-data
8957 (if force-refresh (org-refresh-category-properties))
8958 (let ((pos (or pos (point))))
8959 (or (get-text-property pos 'org-category)
8960 (progn (org-refresh-category-properties)
8961 (get-text-property pos 'org-category))))))
8963 (defun org-refresh-category-properties ()
8964 "Refresh category text properties in the buffer."
8965 (let ((case-fold-search t)
8966 (inhibit-read-only t)
8967 (def-cat (cond
8968 ((null org-category)
8969 (if buffer-file-name
8970 (file-name-sans-extension
8971 (file-name-nondirectory buffer-file-name))
8972 "???"))
8973 ((symbolp org-category) (symbol-name org-category))
8974 (t org-category)))
8975 beg end cat pos optionp)
8976 (org-with-silent-modifications
8977 (save-excursion
8978 (save-restriction
8979 (widen)
8980 (goto-char (point-min))
8981 (put-text-property (point) (point-max) 'org-category def-cat)
8982 (while (re-search-forward
8984 (setq pos (match-end 0)
8985 optionp (equal (char-after (match-beginning 0)) ?#)
8986 cat (org-trim (match-string 2)))
8987 (if optionp
8988 (setq beg (point-at-bol) end (point-max))
8989 (org-back-to-heading t)
8990 (setq beg (point) end (org-end-of-subtree t t)))
8991 (put-text-property beg end 'org-category cat)
8992 (put-text-property beg end 'org-category-position beg)
8993 (goto-char pos)))))))
8995 (defun org-refresh-properties (dprop tprop)
8996 "Refresh buffer text properties.
8997 DPROP is the drawer property and TPROP is the corresponding text
8998 property to set."
8999 (let ((case-fold-search t)
9000 (inhibit-read-only t) p)
9001 (org-with-silent-modifications
9002 (save-excursion
9003 (save-restriction
9004 (widen)
9005 (goto-char (point-min))
9007 (setq p (org-match-string-no-properties 1))
9008 (save-excursion
9009 (org-back-to-heading t)
9010 (put-text-property
9011 (point-at-bol) (point-at-eol) tprop p))))))))
9014 ;;;; Link Stuff
9016 ;;; Link abbreviations
9018 (defun org-link-expand-abbrev (link)
9019 "Apply replacements as defined in `org-link-abbrev-alist'."
9021 (let* ((key (match-string 1 link))
9022 (as (or (assoc key org-link-abbrev-alist-local)
9023 (assoc key org-link-abbrev-alist)))
9024 (tag (and (match-end 2) (match-string 3 link)))
9025 rpl)
9026 (if (not as)
9027 link
9028 (setq rpl (cdr as))
9029 (cond
9030 ((symbolp rpl) (funcall rpl tag))
9032 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
9033 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9034 ((string-match "%h" rpl)
9035 (replace-match (url-hexify-string (or tag "")) t t rpl))
9036 (t (concat rpl tag)))))
9037 link))
9039 ;;; Storing and inserting links
9041 (defvar org-insert-link-history nil
9042 "Minibuffer history for links inserted with `org-insert-link'.")
9044 (defvar org-stored-links nil
9045 "Contains the links stored with `org-store-link'.")
9047 (defvar org-store-link-plist nil
9048 "Plist with info about the most recently link created with `org-store-link'.")
9050 (defvar org-link-protocols nil
9051 "Link protocols added to Org-mode using `org-add-link-type'.")
9053 (defvar org-store-link-functions nil
9054 "List of functions that are called to create and store a link.
9055 Each function will be called in turn until one returns a non-nil
9056 value. Each function should check if it is responsible for creating
9057 this link (for example by looking at the major mode).
9058 If not, it must exit and return nil.
9059 If yes, it should return a non-nil value after a calling
9060 `org-store-link-props' with a list of properties and values.
9061 Special properties are:
9065 This is obligatory as well.
9066 :description Optional default description for the second pair
9067 of brackets in an Org-mode link. The user can still change
9068 this when inserting this link into an Org-mode buffer.
9070 In addition to these, any additional properties can be specified
9071 and then used in capture templates.")
9073 (defun org-add-link-type (type &optional follow export)
9074 "Add TYPE to the list of `org-link-types'.
9075 Re-compute all regular expressions depending on `org-link-types'
9077 FOLLOW and EXPORT are two functions.
9079 FOLLOW should take the link path as the single argument and do whatever
9080 is necessary to follow the link, for example find a file or display
9081 a mail message.
9083 EXPORT should format the link path for export to one of the export formats.
9084 It should be a function accepting three arguments:
9087 desc the description of the link, if any, or a description added by
9088 org-export-normalize-links if there is none
9089 format the export format, a symbol like `html' or `latex' or `ascii'..
9091 The function may use the FORMAT information to return different values
9092 depending on the format. The return value will be put literally into
9093 the exported file. If the return value is nil, this means Org should
9094 do what it normally does with links which do not have EXPORT defined.
9096 Org-mode has a built-in default for exporting links. If you are happy with
9097 this default, there is no need to define an export function for the link
9098 type. For a simple example of an export function, see `org-bbdb.el'."
9099 (add-to-list 'org-link-types type t)
9100 (org-make-link-regexps)
9101 (if (assoc type org-link-protocols)
9102 (setcdr (assoc type org-link-protocols) (list follow export))
9103 (push (list type follow export) org-link-protocols)))
9105 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9106 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9108 ;;;###autoload
9109 (defun org-store-link (arg)
9111 This link is added to `org-stored-links' and can later be inserted
9114 For some link types, a prefix arg is interpreted.
9115 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9116 For file links, arg negates `org-context-in-file-links'.
9118 A double prefix arg force skipping storing functions that are not
9119 part of Org's core."
9120 (interactive "P")
9121 (org-load-modules-maybe)
9122 (setq org-store-link-plist nil) ; reset
9123 (org-with-limited-levels
9124 (let (link cpltxt desc description search txt custom-id agenda-link sfuns sfunsn)
9125 (cond
9126 ((and (not (equal arg '(16)))
9127 (setq sfuns
9128 (delq
9129 nil (mapcar (lambda (f) (let (fs) (if (funcall f) (push f fs))))
9130 org-store-link-functions))
9131 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9132 (or (and (cdr sfuns)
9133 (funcall (intern
9134 (completing-read "Which function for creating the link? "
9135 sfunsn t (car sfunsn)))))
9136 (funcall (caar sfuns)))
9137 (setq link (plist-get org-store-link-plist :link)
9138 desc (or (plist-get org-store-link-plist :description) link))))
9139 ((org-src-edit-buffer-p)
9140 (let (label gc)
9141 (while (or (not label)
9142 (save-excursion
9143 (save-restriction
9144 (widen)
9145 (goto-char (point-min))
9146 (re-search-forward
9147 (regexp-quote (format org-coderef-label-format label))
9148 nil t))))
9149 (when label (message "Label exists already") (sit-for 2))
9150 (setq label (read-string "Code line label: " label)))
9151 (end-of-line 1)
9152 (setq link (format org-coderef-label-format label))
9153 (setq gc (- 79 (length link)))
9154 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9155 (insert link)
9156 (setq link (concat "(" label ")") desc nil)))
9158 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9159 ;; We are in the agenda, link to referenced location
9160 (let ((m (or (get-text-property (point) 'org-hd-marker)
9161 (get-text-property (point) 'org-marker))))
9162 (when m
9163 (org-with-point-at m
9164 (setq agenda-link
9165 (if (org-called-interactively-p 'any)
9166 (call-interactively 'org-store-link)
9167 (org-store-link nil)))))))
9169 ((eq major-mode 'calendar-mode)
9170 (let ((cd (calendar-cursor-to-date)))
9171 (setq link
9172 (format-time-string
9173 (car org-time-stamp-formats)
9174 (apply 'encode-time
9175 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9176 nil nil nil))))
9177 (org-store-link-props :type "calendar" :date cd)))
9179 ((eq major-mode 'help-mode)
9180 (setq link (concat "help:" (save-excursion
9181 (goto-char (point-min))
9182 (looking-at "^[^ ]+")
9183 (match-string 0))))
9184 (org-store-link-props :type "help"))
9186 ((eq major-mode 'w3-mode)
9187 (setq cpltxt (if (and (buffer-name)
9188 (not (string-match "Untitled" (buffer-name))))
9189 (buffer-name)
9190 (url-view-url t))
9191 link (url-view-url t))
9192 (org-store-link-props :type "w3" :url (url-view-url t)))
9194 ((setq search (run-hook-with-args-until-success
9195 'org-create-file-search-functions))
9196 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9197 "::" search))
9198 (setq cpltxt (or description link)))
9200 ((eq major-mode 'image-mode)
9201 (setq cpltxt (concat "file:"
9202 (abbreviate-file-name buffer-file-name))
9203 link cpltxt)
9204 (org-store-link-props :type "image" :file buffer-file-name))
9206 ((eq major-mode 'dired-mode)
9207 ;; link to the file in the current line
9208 (let ((file (dired-get-filename nil t)))
9209 (setq file (if file
9210 (abbreviate-file-name
9211 (expand-file-name (dired-get-filename nil t)))
9212 ;; otherwise, no file so use current directory.
9213 default-directory))
9214 (setq cpltxt (concat "file:" file)
9215 link cpltxt)))
9217 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9218 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9219 (cond
9221 (setq cpltxt
9222 (concat "file:"
9223 (abbreviate-file-name
9224 (buffer-file-name (buffer-base-buffer)))
9225 "::" (match-string 1))
9226 link cpltxt))
9227 ((and (featurep 'org-id)
9228 (or (eq org-id-link-to-org-use-id t)
9229 (and (org-called-interactively-p 'any)
9230 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9231 (and (eq org-id-link-to-org-use-id
9232 'create-if-interactive-and-no-custom-id)
9233 (not custom-id))))
9234 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9235 ;; We can make a link using the ID.
9236 (setq link (condition-case nil
9237 (prog1 (org-id-store-link)
9238 (setq desc (plist-get org-store-link-plist :description)))
9239 (error
9240 ;; probably before first headline, link to file only
9241 (concat "file:"
9242 (abbreviate-file-name
9243 (buffer-file-name (buffer-base-buffer))))))))
9244 (t
9245 ;; Just link to current headline
9246 (setq cpltxt (concat "file:"
9247 (abbreviate-file-name
9248 (buffer-file-name (buffer-base-buffer)))))
9249 ;; Add a context search string
9250 (when (org-xor org-context-in-file-links arg)
9251 (let* ((ee (org-element-at-point))
9252 (et (org-element-type ee))
9253 (ev (plist-get (cadr ee) :value)))
9254 (setq txt (cond
9255 ((org-at-heading-p) nil)
9256 ((eq et 'keyword) ev)
9257 ((org-region-active-p)
9258 (buffer-substring (region-beginning) (region-end)))))
9260 (setq cpltxt
9261 (concat cpltxt "::"
9262 (condition-case nil
9263 (org-make-org-heading-search-string txt)
9264 (error "")))
9265 desc (or (and (eq et 'keyword) ev)
9266 (nth 4 (ignore-errors (org-heading-components)))
9267 "NONE")))))
9269 (setq cpltxt (substring cpltxt 0 -2)))
9270 (setq link cpltxt))))
9272 ((buffer-file-name (buffer-base-buffer))
9273 ;; Just link to this file here.
9274 (setq cpltxt (concat "file:"
9275 (abbreviate-file-name
9276 (buffer-file-name (buffer-base-buffer)))))
9277 ;; Add a context string
9278 (when (org-xor org-context-in-file-links arg)
9279 (setq txt (if (org-region-active-p)
9280 (buffer-substring (region-beginning) (region-end))
9281 (buffer-substring (point-at-bol) (point-at-eol))))
9282 ;; Only use search option if there is some text.
9284 (setq cpltxt
9285 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9286 desc "NONE")))
9287 (setq link cpltxt))
9289 ((org-called-interactively-p 'interactive)
9290 (user-error "No method for storing a link from this buffer"))
9292 (t (setq link nil)))
9294 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9295 (setq link (or link cpltxt)
9296 desc (or desc cpltxt))
9297 (cond ((equal desc "NONE") (setq desc nil))
9298 ((string-match org-bracket-link-regexp desc)
9299 (setq desc (replace-regexp-in-string
9300 org-bracket-link-regexp
9302 (length desc)) "*" "")) desc))))
9304 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
9305 (progn
9306 (setq org-stored-links
9307 (cons (list link desc) org-stored-links))
9308 (message "Stored: %s" (or desc link))
9309 (when custom-id
9310 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
9311 "::#" custom-id))
9312 (setq org-stored-links
9313 (cons (list link desc) org-stored-links))))
9314 (or agenda-link (and link (org-make-link-string link desc)))))))
9316 (defun org-store-link-props (&rest plist)
9317 "Store link properties, extract names and addresses."
9318 (let (x adr)
9319 (when (setq x (plist-get plist :from))
9320 (setq adr (mail-extract-address-components x))
9321 (setq plist (plist-put plist :fromname (car adr)))
9322 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9323 (when (setq x (plist-get plist :to))
9324 (setq adr (mail-extract-address-components x))
9325 (setq plist (plist-put plist :toname (car adr)))
9326 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9327 (let ((from (plist-get plist :from))
9328 (to (plist-get plist :to)))
9329 (when (and from to org-from-is-user-regexp)
9330 (setq plist
9331 (plist-put plist :fromto
9332 (if (string-match org-from-is-user-regexp from)
9333 (concat "to %t")
9334 (concat "from %f"))))))
9335 (setq org-store-link-plist plist))
9337 (defun org-add-link-props (&rest plist)
9338 "Add these properties to the link property list."
9339 (let (key value)
9340 (while plist
9341 (setq key (pop plist) value (pop plist))
9342 (setq org-store-link-plist
9343 (plist-put org-store-link-plist key value)))))
9345 (defun org-email-link-description (&optional fmt)
9346 "Return the description part of an email link.
9347 This takes information from `org-store-link-plist' and formats it
9348 according to FMT (default from `org-email-link-description-format')."
9349 (setq fmt (or fmt org-email-link-description-format))
9350 (let* ((p org-store-link-plist)
9351 (to (plist-get p :toaddress))
9352 (from (plist-get p :fromaddress))
9353 (table
9354 (list
9355 (cons "%c" (plist-get p :fromto))
9356 (cons "%F" (plist-get p :from))
9357 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9358 (cons "%T" (plist-get p :to))
9359 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9360 (cons "%s" (plist-get p :subject))
9361 (cons "%d" (plist-get p :date))
9362 (cons "%m" (plist-get p :message-id)))))
9363 (when (string-match "%c" fmt)
9364 ;; Check if the user wrote this message
9365 (if (and org-from-is-user-regexp from to
9366 (save-match-data (string-match org-from-is-user-regexp from)))
9367 (setq fmt (replace-match "to %t" t t fmt))
9368 (setq fmt (replace-match "from %f" t t fmt))))
9369 (org-replace-escapes fmt table)))
9371 (defun org-make-org-heading-search-string (&optional string)
9372 "Make search string for the current headline or STRING."
9373 (let ((s (or string
9374 (and (derived-mode-p 'org-mode)
9375 (save-excursion
9376 (org-back-to-heading t)
9377 (org-element-property :raw-value (org-element-at-point))))))
9378 (lines org-context-in-file-links))
9379 (or string (setq s (concat "*" s))) ; Add * for headlines
9381 (when (and string (integerp lines) (> lines 0))
9383 (when (< lines (length slines))
9384 (setq s (mapconcat
9385 'identity
9386 (reverse (nthcdr (- (length slines) lines)
9390 (defun org-make-link-string (link &optional description)
9391 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9393 (error "Empty link"))
9394 (when (and description
9395 (stringp description)
9397 (setq description nil))
9398 (when (stringp description)
9399 ;; Remove brackets from the description, they are fatal.
9401 (setq description (replace-match "{" t t description)))
9403 (setq description (replace-match "}" t t description))))
9404 (when (equal link description)
9405 ;; No description needed, it is identical
9406 (setq description nil))
9407 (when (and (not description)
9408 (not (string-match (org-image-file-name-regexp) link))
9409 (not (equal link (org-link-escape link))))
9410 (setq description (org-extract-attributes link)))
9411 (setq link
9412 (cond ((string-match (org-image-file-name-regexp) link) link)
9413 ((string-match org-link-types-re link)
9414 (concat (match-string 1 link)
9415 (org-link-escape (substring link (match-end 1)))))
9416 (t (org-link-escape link))))
9417 (concat "[[" link "]"
9418 (if description (concat "[" description "]") "")
9419 "]"))
9421 (defconst org-link-escape-chars
9422 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9423 "List of characters that should be escaped in link.
9424 This is the list that is used for internal purposes.")
9426 (defconst org-link-escape-chars-browser
9427 '(?\ )
9428 "List of escapes for characters that are problematic in links.
9429 This is the list that is used before handing over to the browser.")
9431 (defun org-link-escape (text &optional table merge)
9432 "Return percent escaped representation of TEXT.
9433 TEXT is a string with the text to escape.
9434 Optional argument TABLE is a list with characters that should be
9435 escaped. When nil, `org-link-escape-chars' is used.
9436 If optional argument MERGE is set, merge TABLE into
9437 `org-link-escape-chars'."
9438 (cond
9439 ((and table merge)
9440 (mapc (lambda (defchr)
9441 (unless (member defchr table)
9442 (setq table (cons defchr table)))) org-link-escape-chars))
9443 ((null table)
9444 (setq table org-link-escape-chars)))
9445 (mapconcat
9446 (lambda (char)
9447 (if (or (member char table)
9448 (and (or (< char 32) (= char 37) (> char 126))
9449 org-url-hexify-p))
9450 (mapconcat (lambda (sequence-element)
9451 (format "%%%.2X" sequence-element))
9452 (or (encode-coding-char char 'utf-8)
9453 (error "Unable to percent escape character: %s"
9454 (char-to-string char))) "")
9455 (char-to-string char))) text ""))
9457 (defun org-link-unescape (str)
9458 "Unhex hexified Unicode strings as returned from the JavaScript function
9459 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9460 (unless (and (null str) (string= "" str))
9461 (let ((pos 0) (case-fold-search t) unhexed)
9463 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9464 (setq str (replace-match unhexed t t str))
9465 (setq pos (+ pos (length unhexed))))))
9466 str)
9468 (defun org-link-unescape-compound (hex)
9469 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9470 Note: this function also decodes single byte encodings like
9471 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9472 (save-match-data
9473 (let* ((bytes (cdr (split-string hex "%")))
9474 (ret "")
9475 (eat 0)
9476 (sum 0))
9477 (while bytes
9478 (let* ((val (string-to-number (pop bytes) 16))
9479 (shift-xor
9480 (if (= 0 eat)
9481 (cond
9482 ((>= val 252) (cons 6 252))
9483 ((>= val 248) (cons 5 248))
9484 ((>= val 240) (cons 4 240))
9485 ((>= val 224) (cons 3 224))
9486 ((>= val 192) (cons 2 192))
9487 (t (cons 0 0)))
9488 (cons 6 128))))
9489 (if (>= val 192) (setq eat (car shift-xor)))
9490 (setq val (logxor val (cdr shift-xor)))
9491 (setq sum (+ (lsh sum (car shift-xor)) val))
9492 (if (> eat 0) (setq eat (- eat 1)))
9493 (cond
9494 ((= 0 eat) ;multi byte
9495 (setq ret (concat ret (org-char-to-string sum)))
9496 (setq sum 0))
9497 ((not bytes) ; single byte(s)
9498 (setq ret (org-link-unescape-single-byte-sequence hex))))
9499 )) ;; end (while bytes
9500 ret )))
9502 (defun org-link-unescape-single-byte-sequence (hex)
9503 "Unhexify hex-encoded single byte character sequences."
9504 (mapconcat (lambda (byte)
9505 (char-to-string (string-to-number byte 16)))
9506 (cdr (split-string hex "%")) ""))
9508 (defun org-xor (a b)
9509 "Exclusive or."
9510 (if a (not b) b))
9512 (defun org-fixup-message-id-for-http (s)
9513 "Replace special characters in a message id, so it can be used in an http query."
9514 (when (string-match "%" s)
9515 (setq s (mapconcat (lambda (c)
9516 (if (eq c ?%)
9517 "%25"
9518 (char-to-string c)))
9519 s "")))
9520 (while (string-match "<" s)
9521 (setq s (replace-match "%3C" t t s)))
9522 (while (string-match ">" s)
9523 (setq s (replace-match "%3E" t t s)))
9524 (while (string-match "@" s)
9525 (setq s (replace-match "%40" t t s)))
9526 s)
9528 (defun org-link-prettify (link)
9529 "Return a human-readable representation of LINK.
9530 The car of LINK must be a raw link the cdr of LINK must be either
9531 a link description or nil."
9532 (let ((desc (or (cadr link) "<no description>")))
9533 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9534 "<" (car link) ">")))
9536 ;;;###autoload
9537 (defun org-insert-link-global ()
9538 "Insert a link like Org-mode does.
9539 This command can be called in any mode to insert a link in Org-mode syntax."
9540 (interactive)
9541 (org-load-modules-maybe)
9542 (org-run-like-in-org-mode 'org-insert-link))
9544 (defun org-insert-all-links (&optional keep)
9545 "Insert all links in `org-stored-links'."
9546 (interactive "P")
9547 (let ((links (copy-sequence org-stored-links)) l)
9548 (while (setq l (if keep (pop links) (pop org-stored-links)))
9549 (insert "- ")
9550 (org-insert-link nil (car l) (cadr l))
9553 (defun org-link-fontify-links-to-this-file ()
9554 "Fontify links to the current file in `org-stored-links'."
9555 (let ((f (buffer-file-name)) a b)
9556 (setq a (mapcar (lambda(l)
9557 (let ((ll (car l)))
9559 (equal f (expand-file-name (match-string 1 ll))))
9560 ll)))
9561 org-stored-links))
9562 (when (featurep 'org-id)
9563 (setq b (mapcar (lambda(l)
9564 (let ((ll (car l)))
9566 (equal f (expand-file-name
9567 (or (org-id-find-id-file
9568 (match-string 1 ll)) ""))))
9569 ll)))
9570 org-stored-links)))
9571 (mapcar (lambda(l)
9572 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9573 (delq nil (append a b)))))
9575 (defvar org-link-links-in-this-file nil)
9576 (defun org-insert-link (&optional complete-file link-location default-description)
9577 "Insert a link. At the prompt, enter the link.
9579 Completion can be used to insert any of the link protocol prefixes like
9580 http or ftp in use.
9582 The history can be used to select a link previously stored with
9583 `org-store-link'. When the empty string is entered (i.e. if you just
9584 press RET at the prompt), the link defaults to the most recently
9585 stored link. As SPC triggers completion in the minibuffer, you need to
9586 use M-SPC or C-q SPC to force the insertion of a space character.
9588 You will also be prompted for a description, and if one is given, it will
9589 be displayed in the buffer instead of the link.
9591 If there is already a link at point, this command will allow you to edit link
9592 and description parts.
9595 be selected using completion. The path to the file will be relative to the
9596 current directory if the file is in the current directory or a subdirectory.
9597 Otherwise, the link will be the absolute path as completed in the minibuffer
9598 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9599 option `org-link-file-path-type'.
9602 the current directory or below.
9605 `org-keep-stored-link-after-insertion'.
9607 If `org-make-link-description-function' is non-nil, this function will be
9608 called with the link target, and the result will be the default
9609 link description.
9611 If the LINK-LOCATION parameter is non-nil, this value will be
9612 used as the link location instead of reading one interactively.
9614 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9615 be used as the default description."
9616 (interactive "P")
9617 (let* ((wcf (current-window-configuration))
9618 (origbuf (current-buffer))
9619 (region (if (org-region-active-p)
9620 (buffer-substring (region-beginning) (region-end))))
9621 (remove (and region (list (region-beginning) (region-end))))
9622 (desc region)
9623 tmphist ; byte-compile incorrectly complains about this
9624 (link link-location)
9625 (abbrevs org-link-abbrev-alist-local)
9626 entry file all-prefixes auto-desc)
9627 (cond
9628 (link-location) ; specified by arg, just use it.
9629 ((org-in-regexp org-bracket-link-regexp 1)
9630 ;; We do have a link at point, and we are going to edit it.
9631 (setq remove (list (match-beginning 0) (match-end 0)))
9632 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9633 (setq link (read-string "Link: "
9634 (org-link-unescape
9635 (org-match-string-no-properties 1)))))
9636 ((or (org-in-regexp org-angle-link-re)
9637 (org-in-regexp org-plain-link-re))
9638 ;; Convert to bracket link
9639 (setq remove (list (match-beginning 0) (match-end 0))
9640 link (read-string "Link: "
9641 (org-remove-angle-brackets (match-string 0)))))
9642 ((member complete-file '((4) (16)))
9643 ;; Completing read for file names.
9644 (setq link (org-file-complete-link complete-file)))
9645 (t
9646 ;; Read link, with completion for stored links.
9647 (org-link-fontify-links-to-this-file)
9648 (org-switch-to-buffer-other-window "*Org Links*")
9649 (with-current-buffer "*Org Links*"
9650 (erase-buffer)
9651 (insert "Insert a link.
9653 (when org-stored-links
9655 (insert (mapconcat 'org-link-prettify
9657 (goto-char (point-min)))
9658 (let ((cw (selected-window)))
9659 (select-window (get-buffer-window "*Org Links*" 'visible))
9660 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9661 (unless (pos-visible-in-window-p (point-max))
9662 (org-fit-window-to-buffer))
9663 (and (window-live-p cw) (select-window cw)))
9664 ;; Fake a link history, containing the stored links.
9665 (setq tmphist (append (mapcar 'car org-stored-links)
9666 org-insert-link-history))
9667 (setq all-prefixes (append (mapcar 'car abbrevs)
9668 (mapcar 'car org-link-abbrev-alist)
9669 org-link-types))
9670 (unwind-protect
9671 (progn
9672 (setq link
9673 (org-completing-read
9674 "Link: "
9675 (append
9676 (mapcar (lambda (x) (concat x ":"))
9677 all-prefixes)
9678 (mapcar 'car org-stored-links))
9679 nil nil nil
9680 'tmphist
9681 (caar org-stored-links)))
9683 (error "No link selected"))
9684 (mapc (lambda(l)
9685 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9686 org-stored-links)
9687 (if (or (member link all-prefixes)
9688 (and (equal ":" (substring link -1))
9689 (member (substring link 0 -1) all-prefixes)
9690 (setq link (substring link 0 -1))))
9691 (setq link (with-current-buffer origbuf
9692 (org-link-try-special-completion link)))))
9693 (set-window-configuration wcf)
9694 (kill-buffer "*Org Links*"))
9695 (setq entry (assoc link org-stored-links))
9696 (or entry (push link org-insert-link-history))
9697 (setq desc (or desc (nth 1 entry)))))
9699 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9700 (not org-keep-stored-link-after-insertion))
9701 (setq org-stored-links (delq (assoc link org-stored-links)
9702 org-stored-links)))
9704 (if (string-match org-plain-link-re link)
9705 ;; URL-like link, normalize the use of angular brackets.
9706 (setq link (org-remove-angle-brackets link)))
9708 ;; Check if we are linking to the current file with a search
9709 ;; option If yes, simplify the link by using only the search
9710 ;; option.
9711 (when (and buffer-file-name
9713 (let* ((path (match-string 1 link))
9714 (case-fold-search nil)
9715 (search (match-string 2 link)))
9716 (save-match-data
9717 (if (equal (file-truename buffer-file-name) (file-truename path))
9718 ;; We are linking to this same file, with a search option
9719 (setq link search)))))
9721 ;; Check if we can/should use a relative path. If yes, simplify the link
9723 (let* ((type (match-string 1 link))
9724 (path (match-string 2 link))
9725 (origpath path)
9726 (case-fold-search nil))
9727 (cond
9728 ((or (eq org-link-file-path-type 'absolute)
9729 (equal complete-file '(16)))
9730 (setq path (abbreviate-file-name (expand-file-name path))))
9731 ((eq org-link-file-path-type 'noabbrev)
9732 (setq path (expand-file-name path)))
9733 ((eq org-link-file-path-type 'relative)
9734 (setq path (file-relative-name path)))
9735 (t
9736 (save-match-data
9737 (if (string-match (concat "^" (regexp-quote
9738 (expand-file-name
9739 (file-name-as-directory
9740 default-directory))))
9741 (expand-file-name path))
9742 ;; We are linking a file with relative path name.
9743 (setq path (substring (expand-file-name path)
9744 (match-end 0)))
9745 (setq path (abbreviate-file-name (expand-file-name path)))))))
9746 (setq link (concat type path))
9747 (if (equal desc origpath)
9748 (setq desc path))))
9750 (if org-make-link-description-function
9751 (setq desc
9752 (or (condition-case nil
9753 (funcall org-make-link-description-function link desc)
9754 (error (progn (message "Can't get link description from `%s'"
9755 (symbol-name org-make-link-description-function))
9756 (sit-for 2) nil)))
9757 (read-string "Description: " default-description)))
9758 (if default-description (setq desc default-description)
9759 (setq desc (or (and auto-desc desc)
9760 (read-string "Description: " desc)))))
9763 (if remove (apply 'delete-region remove))
9764 (insert (org-make-link-string link desc))))
9766 (defun org-link-try-special-completion (type)
9767 "If there is completion support for link type TYPE, offer it."
9768 (let ((fun (intern (concat "org-" type "-complete-link"))))
9769 (if (functionp fun)
9770 (funcall fun)
9771 (read-string "Link (no completion support): " (concat type ":")))))
9773 (defun org-file-complete-link (&optional arg)
9774 "Create a file link using completion."
9775 (let (file link)
9776 (setq file (org-iread-file-name "File: "))
9777 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9778 (pwd1 (file-name-as-directory (abbreviate-file-name
9779 (expand-file-name ".")))))
9780 (cond
9781 ((equal arg '(16))
9782 (setq link (concat
9783 "file:"
9784 (abbreviate-file-name (expand-file-name file)))))
9786 (setq link (concat "file:" (match-string 1 file))))
9788 (expand-file-name file))
9789 (setq link (concat
9790 "file:" (match-string 1 (expand-file-name file)))))
9791 (t (setq link (concat "file:" file)))))
9792 link))
9794 (defun org-iread-file-name (&rest args)
9795 "Read-file-name using `ido-mode' speedup if available.
9796 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
9797 See `read-file-name' for a description of parameters."
9798 (org-without-partial-completion
9799 (if (and org-completion-use-ido
9800 (fboundp 'ido-read-file-name)
9801 (boundp 'ido-mode) ido-mode
9802 (listp (second args)))
9803 (let ((ido-enter-matching-directory nil))
9804 (apply 'ido-read-file-name args))
9805 (apply 'read-file-name args))))
9807 (defun org-completing-read (&rest args)
9808 "Completing-read with SPACE being a normal character."
9809 (let ((enable-recursive-minibuffers t)
9810 (minibuffer-local-completion-map
9811 (copy-keymap minibuffer-local-completion-map)))
9812 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9813 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9814 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9815 (apply 'org-icompleting-read args)))
9817 (defun org-completing-read-no-i (&rest args)
9818 (let (org-completion-use-ido org-completion-use-iswitchb)
9819 (apply 'org-completing-read args)))
9821 (defun org-iswitchb-completing-read (prompt choices &rest args)
9822 "Use iswitch as a completing-read replacement to choose from choices.
9823 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9824 from."
9825 (let* ((iswitchb-use-virtual-buffers nil)
9826 (iswitchb-make-buflist-hook
9827 (lambda ()
9828 (setq iswitchb-temp-buflist choices))))
9829 (iswitchb-read-buffer prompt)))
9831 (defun org-icompleting-read (&rest args)
9832 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9833 (org-without-partial-completion
9834 (if (and org-completion-use-ido
9835 (fboundp 'ido-completing-read)
9836 (boundp 'ido-mode) ido-mode
9837 (listp (second args)))
9838 (let ((ido-enter-matching-directory nil))
9839 (apply 'ido-completing-read (concat (car args))
9840 (if (consp (car (nth 1 args)))
9841 (mapcar 'car (nth 1 args))
9842 (nth 1 args))
9843 (cddr args)))
9844 (if (and org-completion-use-iswitchb
9845 (boundp 'iswitchb-mode) iswitchb-mode
9846 (listp (second args)))
9847 (apply 'org-iswitchb-completing-read (concat (car args))
9848 (if (consp (car (nth 1 args)))
9849 (mapcar 'car (nth 1 args))
9850 (nth 1 args))
9851 (cddr args))
9852 (apply 'completing-read args)))))
9854 (defun org-extract-attributes (s)
9855 "Extract the attributes cookie from a string and set as text property."
9856 (let (a attr (start 0) key value)
9857 (save-match-data
9859 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9861 (setq key (match-string 1 a) value (match-string 2 a)
9862 start (match-end 0)
9863 attr (plist-put attr (intern key) value))))
9864 (org-add-props s nil 'org-attr attr))
9865 s))
9867 (defun org-extract-attributes-from-string (tag)
9868 (let (key value attr)
9870 (setq key (match-string 1 tag) value (match-string 2 tag)
9871 tag (replace-match "" t t tag)
9872 attr (plist-put attr (intern key) value)))
9873 (cons tag attr)))
9875 (defun org-attributes-to-string (plist)
9876 "Format a property list into an HTML attribute list."
9877 (let ((s "") key value)
9878 (while plist
9879 (setq key (pop plist) value (pop plist))
9880 (and value
9882 s))
9884 ;;; Opening/following a link
9886 (defvar org-link-search-failed nil)
9888 (defvar org-open-link-functions nil
9889 "Hook for functions finding a plain text link.
9890 These functions must take a single argument, the link content.
9891 They will be called for links that look like [[link text][description]]
9895 These functions will be called *before* Org attempts to resolve the
9896 link by doing text searches in the current buffer - so if you want a
9898 handle this as a special case.
9900 When the function does handle the link, it must return a non-nil value.
9901 If it decides that it is not responsible for this link, it must return
9902 nil to indicate that that Org-mode can continue with other options
9903 like exact and fuzzy text search.")
9905 (defun org-next-link (&optional search-backward)
9906 "Move forward to the next link.
9907 If the link is in hidden text, expose it."
9908 (interactive "P")
9909 (when (and org-link-search-failed (eq this-command last-command))
9910 (goto-char (point-min))
9911 (message "Link search wrapped back to beginning of buffer"))
9912 (setq org-link-search-failed nil)
9913 (let* ((pos (point))
9914 (ct (org-context))
9915 (a (assoc :link ct))
9916 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
9917 (cond (a (goto-char (nth (if search-backward 1 2) a)))
9918 ((looking-at org-any-link-re)
9919 ;; Don't stay stuck at link without an org-link face
9920 (forward-char (if search-backward -1 1))))
9921 (if (funcall srch-fun org-any-link-re nil t)
9922 (progn
9923 (goto-char (match-beginning 0))
9924 (if (outline-invisible-p) (org-show-context)))
9925 (goto-char pos)
9926 (setq org-link-search-failed t)
9927 (message "No further link found"))))
9929 (defun org-previous-link ()
9930 "Move backward to the previous link.
9931 If the link is in hidden text, expose it."
9932 (interactive)
9933 (funcall 'org-next-link t))
9935 (defun org-translate-link (s)
9936 "Translate a link string if a translation function has been defined."
9937 (if (and org-link-translation-function
9938 (fboundp org-link-translation-function)
9940 (progn
9941 (setq s (funcall org-link-translation-function
9942 (match-string 1 s) (match-string 2 s)))
9943 (concat (car s) ":" (cdr s)))
9944 s))
9946 (defun org-translate-link-from-planner (type path)
9947 "Translate a link from Emacs Planner syntax so that Org can follow it.
9948 This is still an experimental function, your mileage may vary."
9949 (cond
9950 ((member type '("http" "https" "news" "ftp"))
9951 ;; standard Internet links are the same.
9952 nil)
9953 ((and (equal type "irc") (string-match "^//" path))
9954 ;; Planner has two / at the beginning of an irc link, we have 1.
9955 ;; We should have zero, actually....
9956 (setq path (substring path 1)))
9957 ((and (equal type "lisp") (string-match "^/" path))
9958 ;; Planner has a slash, we do not.
9959 (setq type "elisp" path (substring path 1)))
9961 ;; A typical message link. Planner has the id after the final slash,
9962 ;; we separate it with a hash mark
9963 (setq path (concat (match-string 1 path) "#"
9964 (org-remove-angle-brackets (match-string 2 path)))))
9965 )
9966 (cons type path))
9968 (defun org-find-file-at-mouse (ev)
9969 "Open file link or URL at mouse."
9970 (interactive "e")
9971 (mouse-set-point ev)
9972 (org-open-at-point 'in-emacs))
9974 (defun org-open-at-mouse (ev)
9975 "Open file link or URL at mouse.
9976 See the docstring of `org-open-file' for details."
9977 (interactive "e")
9978 (mouse-set-point ev)
9979 (if (eq major-mode 'org-agenda-mode)
9980 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9981 (org-open-at-point))
9983 (defvar org-window-config-before-follow-link nil
9984 "The window configuration before following a link.
9985 This is saved in case the need arises to restore it.")
9987 (defvar org-open-link-marker (make-marker)
9988 "Marker pointing to the location where `org-open-at-point; was called.")
9990 ;;;###autoload
9991 (defun org-open-at-point-global ()
9992 "Follow a link like Org-mode does.
9993 This command can be called in any mode to follow a link that has
9994 Org-mode syntax."
9995 (interactive)
9996 (org-run-like-in-org-mode 'org-open-at-point))
9998 ;;;###autoload
9999 (defun org-open-link-from-string (s &optional arg reference-buffer)
10000 "Open a link in the string S, as if it was in Org-mode."
10002 (let ((reference-buffer (or reference-buffer (current-buffer))))
10003 (with-temp-buffer
10004 (let ((org-inhibit-startup (not reference-buffer)))
10005 (org-mode)
10006 (insert s)
10007 (goto-char (point-min))
10008 (when reference-buffer
10009 (setq org-link-abbrev-alist-local
10010 (with-current-buffer reference-buffer
10011 org-link-abbrev-alist-local)))
10012 (org-open-at-point arg reference-buffer)))))
10014 (defvar org-open-at-point-functions nil
10015 "Hook that is run when following a link at point.
10017 Functions in this hook must return t if they identify and follow
10018 a link at point. If they don't find anything interesting at point,
10019 they must return nil.")
10021 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10022 (defun org-open-at-point (&optional arg reference-buffer)
10023 "Open link at or after point.
10024 If there is no link at point, this function will search forward up to
10025 the end of the current line.
10026 Normally, files will be opened by an appropriate application. If the
10027 optional prefix argument ARG is non-nil, Emacs will visit the file.
10028 With a double prefix argument, try to open outside of Emacs, in the
10029 application the system uses for this file type."
10030 (interactive "P")
10031 ;; if in a code block, then open the block's results
10032 (unless (call-interactively #'org-babel-open-src-block-result)
10033 (org-load-modules-maybe)
10034 (move-marker org-open-link-marker (point))
10035 (setq org-window-config-before-follow-link (current-window-configuration))
10036 (org-remove-occur-highlights nil nil t)
10037 (cond
10038 ((and (org-at-heading-p)
10039 (not (org-at-timestamp-p t))
10040 (not (org-in-regexp
10045 (not (get-text-property (point) 'org-linked-text)))
10046 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10047 (lk0 (car lkall))
10048 (lk (if (stringp lk0) (list lk0) lk0))
10049 (lkend (cdr lkall)))
10050 (mapcar (lambda(l)
10051 (search-forward l nil lkend)
10052 (goto-char (match-beginning 0))
10053 (org-open-at-point))
10054 lk))
10055 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10056 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10057 ((and (org-at-timestamp-p t)
10058 (not (org-in-regexp org-bracket-link-regexp)))
10059 (org-follow-timestamp-link))
10060 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10061 (not (org-in-regexp org-any-link-re)))
10062 (org-footnote-action))
10063 (t
10064 (let (type path link line search (pos (point)))
10065 (catch 'match
10066 (save-excursion
10068 (when (org-in-regexp org-bracket-link-regexp 1)
10069 (setq link (org-extract-attributes
10070 (org-link-unescape (org-match-string-no-properties 1))))
10072 (setq link (replace-match " " t t link)))
10073 (setq link (org-link-expand-abbrev link))
10074 (cond
10075 ((or (file-name-absolute-p link)
10077 (setq type "file" path link))
10078 ((string-match org-link-re-with-space3 link)
10079 (setq type (match-string 1 link) path (match-string 2 link)))
10081 (setq type "help" path (match-string 1 link)))
10082 (t (setq type "thisfile" path link)))
10083 (throw 'match t)))
10085 (when (get-text-property (point) 'org-linked-text)
10086 (setq type "thisfile"
10087 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10088 (1+ (point)) (point))
10089 path (buffer-substring
10090 (or (previous-single-property-change pos 'org-linked-text)
10091 (point-min))
10092 (or (next-single-property-change pos 'org-linked-text)
10093 (point-max))))
10094 (throw 'match t))
10096 (save-excursion
10097 (when (or (org-in-regexp org-angle-link-re)
10098 (let ((match (org-in-regexp org-plain-link-re)))
10099 ;; Check a plain link is not within a bracket link
10100 (and match
10101 (save-excursion
10102 (progn
10103 (goto-char (car match))
10104 (not (org-in-regexp org-bracket-link-regexp))))))
10105 (let ((line_ending (save-excursion (end-of-line) (point))))
10106 ;; We are in a line before a plain or bracket link
10107 (or (re-search-forward org-plain-link-re line_ending t)
10108 (re-search-forward org-bracket-link-regexp line_ending t))))
10109 (setq type (match-string 1)
10110 path (org-link-unescape (match-string 2)))
10111 (throw 'match t)))
10112 (save-excursion
10114 (setq type "tags"
10115 path (match-string 1))
10116 (while (string-match ":" path)
10117 (setq path (replace-match "+" t t path)))
10118 (throw 'match t)))
10120 (setq type "tree-match"
10121 path (match-string 1))
10122 (throw 'match t)))
10123 (unless path
10124 (user-error "No link found"))
10126 ;; switch back to reference buffer
10127 ;; needed when if called in a temporary buffer through
10128 ;; org-open-link-from-string
10129 (with-current-buffer (or reference-buffer (current-buffer))
10131 ;; Remove any trailing spaces in path
10133 (setq path (replace-match "" t t path)))
10134 (if (and org-link-translation-function
10135 (fboundp org-link-translation-function))
10136 ;; Check if we need to translate the link
10137 (let ((tmp (funcall org-link-translation-function type path)))
10138 (setq type (car tmp) path (cdr tmp))))
10140 (cond
10142 ((assoc type org-link-protocols)
10143 (funcall (nth 1 (assoc type org-link-protocols)) path))
10145 ((equal type "help")
10146 (let ((f-or-v (intern path)))
10147 (cond ((fboundp f-or-v)
10148 (describe-function f-or-v))
10149 ((boundp f-or-v)
10150 (describe-variable f-or-v))
10151 (t (error "Not a known function or variable")))))
10153 ((equal type "mailto")
10154 (let ((cmd (car org-link-mailto-program))
10155 (args (cdr org-link-mailto-program)) args1
10156 (address path) (subject "") a)
10158 (setq address (match-string 1 path)
10159 subject (org-link-escape (match-string 2 path))))
10160 (while args
10161 (cond
10162 ((not (stringp (car args))) (push (pop args) args1))
10163 (t (setq a (pop args))
10164 (if (string-match "%a" a)
10165 (setq a (replace-match address t t a)))
10166 (if (string-match "%s" a)
10167 (setq a (replace-match subject t t a)))
10168 (push a args1))))
10169 (apply cmd (nreverse args1))))
10171 ((member type '("http" "https" "ftp" "news"))
10172 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
10173 (org-link-escape
10174 path org-link-escape-chars-browser)
10175 path))))
10177 ((string= type "doi")
10178 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
10179 (org-link-escape
10180 path org-link-escape-chars-browser)
10181 path))))
10183 ((member type '("message"))
10184 (browse-url (concat type ":" path)))
10186 ((string= type "tags")
10187 (org-tags-view arg path))
10189 ((string= type "tree-match")
10192 ((string= type "file")
10194 (setq line (string-to-number (match-string 1 path))
10195 path (substring path 0 (match-beginning 0)))
10197 (setq search (match-string 1 path)
10198 path (substring path 0 (match-beginning 0)))))
10199 (if (string-match "[*?{]" (file-name-nondirectory path))
10200 (dired path)
10201 (org-open-file path arg line search)))
10203 ((string= type "shell")
10204 (let ((buf (generate-new-buffer "*Org Shell Output"))
10205 (cmd path))
10206 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10207 (string-match org-confirm-shell-link-not-regexp cmd))
10208 (not org-confirm-shell-link-function)
10209 (funcall org-confirm-shell-link-function
10211 (org-add-props cmd nil
10212 'face 'org-warning))))
10213 (progn
10214 (message "Executing %s" cmd)
10215 (shell-command cmd buf)
10216 (if (featurep 'midnight)
10217 (setq clean-buffer-list-kill-buffer-names
10218 (cons buf clean-buffer-list-kill-buffer-names))))
10219 (error "Abort"))))
10221 ((string= type "elisp")
10222 (let ((cmd path))
10223 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10224 (string-match org-confirm-elisp-link-not-regexp cmd))
10225 (not org-confirm-elisp-link-function)
10226 (funcall org-confirm-elisp-link-function
10228 (org-add-props cmd nil
10229 'face 'org-warning))))
10230 (message "%s => %s" cmd
10231 (if (equal (string-to-char cmd) ?\()
10232 (eval (read cmd))
10233 (call-interactively (read cmd))))
10234 (error "Abort"))))
10236 ((and (string= type "thisfile")
10237 (run-hook-with-args-until-success
10238 'org-open-link-functions path)))
10240 ((string= type "thisfile")
10241 (if arg
10242 (switch-to-buffer-other-window
10243 (org-get-buffer-for-internal-link (current-buffer)))
10244 (org-mark-ring-push))
10245 (let ((cmd `(org-link-search
10246 ,path
10247 ,(cond ((equal arg '(4)) ''occur)
10248 ((equal arg '(16)) ''org-occur))
10249 ,pos)))
10250 (condition-case nil (let ((org-link-search-inhibit-query t))
10251 (eval cmd))
10252 (error (progn (widen) (eval cmd))))))
10254 (t (browse-url-at-point)))))))
10255 (move-marker org-open-link-marker nil)
10256 (run-hook-with-args 'org-follow-link-hook)))
10258 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10259 "Offer links in the current entry and return the selected link.
10260 If there is only one link, return it.
10261 If NTH is an integer, return the NTH link found.
10262 If ZERO is a string, check also this string for a link, and if
10263 there is one, return it."
10264 (with-current-buffer buffer
10265 (save-excursion
10266 (save-restriction
10267 (widen)
10268 (goto-char marker)
10272 (cnt ?0)
10273 (in-emacs (if (integerp nth) nil nth))
10274 have-zero end links link c)
10275 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10276 (push (match-string 0 zero) links)
10277 (setq cnt (1- cnt) have-zero t))
10278 (save-excursion
10279 (org-back-to-heading t)
10280 (setq end (save-excursion (outline-next-heading) (point)))
10281 (while (re-search-forward re end t)
10282 (push (match-string 0) links))
10283 (setq links (org-uniquify (reverse links))))
10284 (cond
10285 ((null links)
10286 (message "No links"))
10287 ((equal (length links) 1)
10288 (setq link (car links)))
10289 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10290 (setq link (nth (if have-zero nth (1- nth)) links)))
10291 (t ; we have to select a link
10292 (save-excursion
10293 (save-window-excursion
10294 (delete-other-windows)
10295 (with-output-to-temp-buffer "*Select Link*"
10296 (mapc (lambda (l)
10297 (if (not (string-match org-bracket-link-regexp l))
10299 (org-remove-angle-brackets l)))
10300 (if (match-end 3)
10302 (match-string 3 l) (match-string 1 l)))
10304 (match-string 1 l))))))
10305 links))
10306 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10307 (message "Select link to open, RET to open all:")
10308 (setq c (read-char-exclusive))
10309 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10310 (when (equal c ?q) (error "Abort"))
10311 (if (equal c ?\C-m)
10312 (setq link links)
10313 (setq nth (- c ?0))
10314 (if have-zero (setq nth (1+ nth)))
10315 (unless (and (integerp nth) (>= (length links) nth))
10316 (error "Invalid link selection"))
10317 (setq link (nth (1- nth) links)))))
10318 (cons link end))))))
10320 ;; Add special file links that specify the way of opening
10322 (org-add-link-type "file+sys" 'org-open-file-with-system)
10323 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10324 (defun org-open-file-with-system (path)
10325 "Open file at PATH using the system way of opening it."
10326 (org-open-file path 'system))
10327 (defun org-open-file-with-emacs (path)
10328 "Open file at PATH in Emacs."
10329 (org-open-file path 'emacs))
10332 ;;; File search
10334 (defvar org-create-file-search-functions nil
10335 "List of functions to construct the right search string for a file link.
10336 These functions are called in turn with point at the location to
10337 which the link should point.
10339 A function in the hook should first test if it would like to
10340 handle this file type, for example by checking the `major-mode'
10341 or the file extension. If it decides not to handle this file, it
10342 should just return nil to give other functions a chance. If it
10343 does handle the file, it must return the search string to be used
10344 when following the link. The search string will be part of the
10345 file link, given after a double colon, and `org-open-at-point'
10346 will automatically search for it. If special measures must be
10347 taken to make the search successful, another function should be
10348 added to the companion hook `org-execute-file-search-functions',
10349 which see.
10351 A function in this hook may also use `setq' to set the variable
10352 `description' to provide a suggestion for the descriptive text to
10353 be used for this link when it gets inserted into an Org-mode
10356 (defvar org-execute-file-search-functions nil
10357 "List of functions to execute a file search triggered by a link.
10359 Functions added to this hook must accept a single argument, the
10360 search string that was part of the file link, the part after the
10361 double colon. The function must first check if it would like to
10362 handle this search, for example by checking the `major-mode' or
10363 the file extension. If it decides not to handle this search, it
10364 should just return nil to give other functions a chance. If it
10365 does handle the search, it must return a non-nil value to keep
10366 other functions from trying.
10368 Each function can access the current prefix argument through the
10369 variable `current-prefix-argument'. Note that a single prefix is
10370 used to force opening a link in Emacs, so it may be good to only
10371 use a numeric or double prefix to guide the search function.
10373 In case this is needed, a function in this hook can also restore
10374 the window configuration before `org-open-at-point' was called using:
10376 (set-window-configuration org-window-config-before-follow-link)")
10378 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10379 (defun org-link-search (s &optional type avoid-pos stealth)
10380 "Search for a link search option.
10381 If S is surrounded by forward slashes, it is interpreted as a
10382 regular expression. In org-mode files, this will create an `org-occur'
10383 sparse tree. In ordinary files, `occur' will be used to list matches.
10384 If the current buffer is in `dired-mode', grep will be used to search
10385 in all files. If AVOID-POS is given, ignore matches near that position.
10387 When optional argument STEALTH is non-nil, do not modify
10388 visibility around point, thus ignoring
10389 `org-show-hierarchy-above', `org-show-following-heading' and
10390 `org-show-siblings' variables."
10391 (let ((case-fold-search t)
10395 org-emphasis-alist)
10397 (pos (point))
10398 (pre nil) (post nil)
10399 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10400 (cond
10401 ;; First check if there are any special search functions
10402 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10403 ;; Now try the builtin stuff
10404 ((and (equal (string-to-char s0) ?#)
10405 (> (length s0) 1)
10406 (save-excursion
10407 (goto-char (point-min))
10408 (and
10409 (re-search-forward
10411 (setq type 'dedicated
10412 pos (match-beginning 0))))
10413 ;; There is an exact target for this
10414 (goto-char pos)
10415 (org-back-to-heading t)))
10416 ((save-excursion
10417 (goto-char (point-min))
10418 (and
10419 (re-search-forward
10420 (concat "<<" (regexp-quote s0) ">>") nil t)
10421 (setq type 'dedicated
10422 pos (match-beginning 0))))
10423 ;; There is an exact target for this
10424 (goto-char pos))
10425 ((save-excursion
10426 (goto-char (point-min))
10427 (and
10428 (re-search-forward
10430 (setq type 'dedicated pos (match-beginning 0))))
10431 ;; Found an invisible target.
10432 (goto-char pos))
10433 ((save-excursion
10434 (goto-char (point-min))
10435 (and
10436 (re-search-forward
10438 (setq type 'dedicated pos (match-beginning 0))))
10439 ;; Found an element with a matching #+name affiliated keyword.
10440 (goto-char pos))
10442 (save-excursion
10443 (goto-char (point-min))
10444 (and
10445 (re-search-forward
10446 (concat "[^[]" (regexp-quote
10447 (format org-coderef-label-format
10448 (match-string 1 s0))))
10449 nil t)
10450 (setq type 'dedicated
10451 pos (1+ (match-beginning 0))))))
10452 ;; There is a coderef target for this
10453 (goto-char pos))
10455 ;; A regular expression
10456 (cond
10457 ((derived-mode-p 'org-mode)
10458 (org-occur (match-string 1 s)))
10459 (t (org-do-occur (match-string 1 s)))))
10460 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10461 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10462 (goto-char (point-min))
10463 (cond
10464 ((let (case-fold-search)
10465 (re-search-forward (format org-complex-heading-regexp-format
10466 (regexp-quote s))
10467 nil t))
10468 ;; OK, found a match
10469 (setq type 'dedicated)
10470 (goto-char (match-beginning 0)))
10471 ((and (not org-link-search-inhibit-query)
10472 (eq org-link-search-must-match-exact-headline 'query-to-create)
10473 (y-or-n-p "No match - create this as a new heading? "))
10474 (goto-char (point-max))
10475 (or (bolp) (newline))
10477 (beginning-of-line 0))
10478 (t
10479 (goto-char pos)
10480 (error "No match"))))
10481 (t
10482 ;; A normal search string
10483 (when (equal (string-to-char s) ?*)
10484 ;; Anchor on headlines, post may include tags.
10487 s (substring s 1)))
10488 (remove-text-properties
10489 0 (length s)
10490 '(face nil mouse-face nil keymap nil fontified nil) s)
10491 ;; Make a series of regular expressions to find a match
10500 re4 (concat "[^a-zA-Z_]" re4_)
10502 re1 (concat pre re2 post)
10503 re3 (concat pre (if pre re4_ re4) post)
10504 re5 (concat pre ".*" re4)
10505 re2 (concat pre re2)
10506 re2a (concat pre (if pre re2a_ re2a))
10507 re4 (concat pre (if pre re4_ re4))
10511 ))
10512 (cond
10513 ((eq type 'org-occur) (org-occur reall))
10514 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10515 (t (goto-char (point-min))
10516 (setq type 'fuzzy)
10517 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10518 (org-search-not-self 1 re1 nil t)
10519 (org-search-not-self 1 re2 nil t)
10520 (org-search-not-self 1 re2a nil t)
10521 (org-search-not-self 1 re3 nil t)
10522 (org-search-not-self 1 re4 nil t)
10523 (org-search-not-self 1 re5 nil t)
10524 )
10525 (goto-char (match-beginning 1))
10526 (goto-char pos)
10527 (error "No match"))))))
10528 (and (derived-mode-p 'org-mode)
10529 (not stealth)
10530 (org-show-context 'link-search))
10531 type))
10533 (defun org-search-not-self (group &rest args)
10534 "Execute `re-search-forward', but only accept matches that do not
10535 enclose the position of `org-open-link-marker'."
10536 (let ((m org-open-link-marker))
10537 (catch 'exit
10538 (while (apply 're-search-forward args)
10539 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10540 (goto-char (match-end group))
10541 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10542 (> (match-beginning 0) (marker-position m))
10543 (< (match-end 0) (marker-position m)))
10544 (save-match-data
10545 (or (not (org-in-regexp
10546 org-bracket-link-analytic-regexp 1))
10547 (not (match-end 4)) ; no description
10548 (and (<= (match-beginning 4) (point))
10549 (>= (match-end 4) (point))))))
10550 (throw 'exit (point))))))))
10552 (defun org-get-buffer-for-internal-link (buffer)
10553 "Return a buffer to be used for displaying the link target of internal links."
10554 (cond
10555 ((not org-display-internal-link-with-indirect-buffer)
10556 buffer)
10557 ((string-match "(Clone)$" (buffer-name buffer))
10558 (message "Buffer is already a clone, not making another one")
10559 ;; we also do not modify visibility in this case
10560 buffer)
10561 (t ; make a new indirect buffer for displaying the link
10562 (let* ((bn (buffer-name buffer))
10563 (ibn (concat bn "(Clone)"))
10564 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10565 (with-current-buffer ib (org-overview))
10566 ib))))
10568 (defun org-do-occur (regexp &optional cleanup)
10569 "Call the Emacs command `occur'.
10570 If CLEANUP is non-nil, remove the printout of the regular expression
10571 in the *Occur* buffer. This is useful if the regex is long and not useful
10572 to read."
10573 (occur regexp)
10574 (when cleanup
10575 (let ((cwin (selected-window)) win beg end)
10576 (when (setq win (get-buffer-window "*Occur*"))
10577 (select-window win))
10578 (goto-char (point-min))
10579 (when (re-search-forward "match[a-z]+" nil t)
10580 (setq beg (match-end 0))
10582 (setq end (1- (match-beginning 0)))))
10583 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10584 (goto-char (point-min))
10585 (select-window cwin))))
10587 ;;; The mark ring for links jumps
10589 (defvar org-mark-ring nil
10590 "Mark ring for positions before jumps in Org-mode.")
10591 (defvar org-mark-ring-last-goto nil
10592 "Last position in the mark ring used to go back.")
10593 ;; Fill and close the ring
10594 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10595 (loop for i from 1 to org-mark-ring-length do
10596 (push (make-marker) org-mark-ring))
10597 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10598 org-mark-ring)
10600 (defun org-mark-ring-push (&optional pos buffer)
10601 "Put the current position or POS into the mark ring and rotate it."
10602 (interactive)
10603 (setq pos (or pos (point)))
10604 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10605 (move-marker (car org-mark-ring)
10606 (or pos (point))
10607 (or buffer (current-buffer)))
10608 (message "%s"
10609 (substitute-command-keys
10612 (defun org-mark-ring-goto (&optional n)
10613 "Jump to the previous position in the mark ring.
10614 With prefix arg N, jump back that many stored positions. When
10615 called several times in succession, walk through the entire ring.
10616 Org-mode commands jumping to a different position in the current file,
10617 or to another Org-mode file, automatically push the old position
10618 onto the ring."
10619 (interactive "p")
10620 (let (p m)
10621 (if (eq last-command this-command)
10622 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10623 (setq p org-mark-ring))
10624 (setq org-mark-ring-last-goto p)
10625 (setq m (car p))
10626 (org-pop-to-buffer-same-window (marker-buffer m))
10627 (goto-char m)
10628 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10630 (defun org-remove-angle-brackets (s)
10631 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10632 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10633 s)
10634 (defun org-add-angle-brackets (s)
10635 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10636 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10637 s)
10638 (defun org-remove-double-quotes (s)
10641 s)
10643 ;;; Following specific links
10645 (defun org-follow-timestamp-link ()
10646 "Open an agenda view for the time-stamp date/range at point."
10647 (cond
10648 ((org-at-date-range-p t)
10649 (let ((org-agenda-start-on-weekday)
10650 (t1 (match-string 1))
10651 (t2 (match-string 2)) tt1 tt2)
10652 (setq tt1 (time-to-days (org-time-string-to-time t1))
10653 tt2 (time-to-days (org-time-string-to-time t2)))
10654 (let ((org-agenda-buffer-tmp-name
10655 (format "*Org Agenda(a:%s)"
10656 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10657 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10658 ((org-at-timestamp-p t)
10659 (let ((org-agenda-buffer-tmp-name
10660 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10661 (org-agenda-list nil (time-to-days (org-time-string-to-time
10662 (substring (match-string 1) 0 10)))
10663 1)))
10664 (t (error "This should not happen"))))
10667 ;;; Following file links
10668 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10669 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10670 (declare-function mailcap-mime-info
10671 "mailcap" (string &optional request no-decode))
10672 (defvar org-wait nil)
10673 (defun org-open-file (path &optional in-emacs line search)
10674 "Open the file at PATH.
10675 First, this expands any special file name abbreviations. Then the
10676 configuration variable `org-file-apps' is checked if it contains an
10677 entry for this file type, and if yes, the corresponding command is launched.
10679 If no application is found, Emacs simply visits the file.
10681 With optional prefix argument IN-EMACS, Emacs will visit the file.
10683 prefix arg, Org tries to avoid opening in Emacs
10684 and to use an external application to visit the file.
10686 Optional LINE specifies a line to go to, optional SEARCH a string
10687 to search for. If LINE or SEARCH is given, the file will be
10688 opened in Emacs, unless an entry from org-file-apps that makes
10689 use of groups in a regexp matches.
10691 If you want to change the way frames are used when following a
10692 link, please customize `org-link-frame-setup'.
10694 If the file does not exist, an error is thrown."
10695 (let* ((file (if (equal path "")
10696 buffer-file-name
10697 (substitute-in-file-name (expand-file-name path))))
10698 (file-apps (append org-file-apps (org-default-apps)))
10699 (apps (org-remove-if
10700 'org-file-apps-entry-match-against-dlink-p file-apps))
10701 (apps-dlink (org-remove-if-not
10702 'org-file-apps-entry-match-against-dlink-p file-apps))
10703 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10704 (dirp (if remp nil (file-directory-p file)))
10705 (file (if (and dirp org-open-directory-means-index-dot-org)
10706 (concat (file-name-as-directory file) "index.org")
10707 file))
10708 (a-m-a-p (assq 'auto-mode apps))
10709 (dfile (downcase file))
10710 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10711 (link (cond ((and (eq line nil)
10712 (eq search nil))
10713 file)
10714 (line
10715 (concat file "::" (number-to-string line)))
10716 (search
10717 (concat file "::" search))))
10718 (dlink (downcase link))
10719 (old-buffer (current-buffer))
10720 (old-pos (point))
10721 (old-mode major-mode)
10722 ext cmd link-match-data)
10724 (setq ext (match-string 1 dfile))
10726 (setq ext (match-string 1 dfile))))
10727 (cond
10728 ((member in-emacs '((16) system))
10729 (setq cmd (cdr (assoc 'system apps))))
10730 (in-emacs (setq cmd 'emacs))
10731 (t
10732 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10733 (and dirp (cdr (assoc 'directory apps)))
10734 ; first, try matching against apps-dlink
10735 ; if we get a match here, store the match data for later
10736 (let ((match (assoc-default dlink apps-dlink
10737 'string-match)))
10738 (if match
10739 (progn (setq link-match-data (match-data))
10740 match)
10741 (progn (setq in-emacs (or in-emacs line search))
10742 nil))) ; if we have no match in apps-dlink,
10743 ; always open the file in emacs if line or search
10744 ; is given (for backwards compatibility)
10745 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10746 'string-match)
10747 (cdr (assoc ext apps))
10748 (cdr (assoc t apps))))))
10749 (when (eq cmd 'system)
10750 (setq cmd (cdr (assoc 'system apps))))
10751 (when (eq cmd 'default)
10752 (setq cmd (cdr (assoc t apps))))
10753 (when (eq cmd 'mailcap)
10754 (require 'mailcap)
10755 (mailcap-parse-mailcaps)
10756 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10757 (command (mailcap-mime-info mime-type)))
10758 (if (stringp command)
10759 (setq cmd command)
10760 (setq cmd 'emacs))))
10761 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10762 (not (file-exists-p file))
10763 (not org-open-non-existing-files))
10764 (error "No such file: %s" file))
10765 (cond
10767 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10769 (setq cmd (replace-match "%s" t t cmd)))
10770 (while (string-match "%s" cmd)
10771 (setq cmd (replace-match
10772 (save-match-data
10773 (shell-quote-argument
10774 (convert-standard-filename file)))
10775 t t cmd)))
10777 ;; Replace "%1", "%2" etc. in command with group matches from regex
10778 (save-match-data
10779 (let ((match-index 1)
10780 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10781 (set-match-data link-match-data)
10782 (while (<= match-index number-of-groups)
10783 (let ((regex (concat "%" (number-to-string match-index)))
10784 (replace-with (match-string match-index dlink)))
10785 (while (string-match regex cmd)
10786 (setq cmd (replace-match replace-with t t cmd))))
10787 (setq match-index (+ match-index 1)))))
10789 (save-window-excursion
10790 (message "Running %s...done" cmd)
10791 (start-process-shell-command cmd nil cmd)
10792 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
10793 ((or (stringp cmd)
10794 (eq cmd 'emacs))
10795 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10796 (widen)
10797 (if line (org-goto-line line)
10798 (if search (org-link-search search))))
10799 ((consp cmd)
10800 (let ((file (convert-standard-filename file)))
10801 (save-match-data
10802 (set-match-data link-match-data)
10803 (eval cmd))))
10804 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10805 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
10806 (or (not (equal old-buffer (current-buffer)))
10807 (not (equal old-pos (point))))
10808 (org-mark-ring-push old-pos old-buffer))))
10810 (defun org-file-apps-entry-match-against-dlink-p (entry)
10811 "This function returns non-nil if `entry' uses a regular
10812 expression which should be matched against the whole link by
10813 org-open-file.
10815 It assumes that is the case when the entry uses a regular
10816 expression which has at least one grouping construct and the
10817 action is either a lisp form or a command string containing
10818 '%1', i.e. using at least one subexpression match as a
10819 parameter."
10820 (let ((selector (car entry))
10821 (action (cdr entry)))
10822 (if (stringp selector)
10823 (and (> (regexp-opt-depth selector) 0)
10824 (or (and (stringp action)
10825 (string-match "%[0-9]" action))
10826 (consp action)))
10827 nil)))
10829 (defun org-default-apps ()
10830 "Return the default applications for this operating system."
10831 (cond
10832 ((eq system-type 'darwin)
10833 org-file-apps-defaults-macosx)
10834 ((eq system-type 'windows-nt)
10835 org-file-apps-defaults-windowsnt)
10836 (t org-file-apps-defaults-gnu)))
10838 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10839 "Convert extensions to regular expressions in the cars of LIST.
10840 Also, weed out any non-string entries, because the return value is used
10841 only for regexp matching.
10842 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10843 point to the symbol `emacs', indicating that the file should
10844 be opened in Emacs."
10845 (append
10846 (delq nil
10847 (mapcar (lambda (x)
10848 (if (not (stringp (car x)))
10849 nil
10851 x
10853 list))
10854 (if add-auto-mode
10855 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10857 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10858 (defun org-file-remote-p (file)
10859 "Test whether FILE specifies a location on a remote system.
10860 Return non-nil if the location is indeed remote.
10864 (cond ((fboundp 'file-remote-p)
10865 (file-remote-p file))
10866 ((fboundp 'tramp-handle-file-remote-p)
10867 (tramp-handle-file-remote-p file))
10868 ((and (boundp 'ange-ftp-name-format)
10869 (string-match (car ange-ftp-name-format) file))
10870 t)))
10873 ;;;; Refiling
10875 (defun org-get-org-file ()
10876 "Read a filename, with default directory `org-directory'."
10877 (let ((default (or org-default-notes-file remember-data-file)))
10878 (read-file-name (format "File name [%s]: " default)
10879 (file-name-as-directory org-directory)
10880 default)))
10882 (defun org-notes-order-reversed-p ()
10883 "Check if the current file should receive notes in reversed order."
10884 (cond
10885 ((not org-reverse-note-order) nil)
10886 ((eq t org-reverse-note-order) t)
10887 ((not (listp org-reverse-note-order)) nil)
10888 (t (catch 'exit
10889 (let ((all org-reverse-note-order)
10890 entry)
10891 (while (setq entry (pop all))
10892 (if (string-match (car entry) buffer-file-name)
10893 (throw 'exit (cdr entry))))
10894 nil)))))
10896 (defvar org-refile-target-table nil
10897 "The list of refile targets, created by `org-refile'.")
10899 (defvar org-agenda-new-buffers nil
10900 "Buffers created to visit agenda files.")
10902 (defvar org-refile-cache nil
10903 "Cache for refile targets.")
10905 (defvar org-refile-markers nil
10906 "All the markers used for caching refile locations.")
10908 (defun org-refile-marker (pos)
10909 "Get a new refile marker, but only if caching is in use."
10910 (if (not org-refile-use-cache)
10911 pos
10912 (let ((m (make-marker)))
10913 (move-marker m pos)
10914 (push m org-refile-markers)
10915 m)))
10917 (defun org-refile-cache-clear ()
10918 "Clear the refile cache and disable all the markers."
10919 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10920 (setq org-refile-markers nil)
10921 (setq org-refile-cache nil)
10922 (message "Refile cache has been cleared"))
10924 (defun org-refile-cache-check-set (set)
10925 "Check if all the markers in the cache still have live buffers."
10926 (let (marker)
10927 (catch 'exit
10928 (while (and set (setq marker (nth 3 (pop set))))
10929 ;; if org-refile-use-outline-path is 'file, marker may be nil
10930 (when (and marker (null (marker-buffer marker)))
10931 (message "not found") (sit-for 3)
10932 (throw 'exit nil)))
10933 t)))
10935 (defun org-refile-cache-put (set &rest identifiers)
10936 "Push the refile targets SET into the cache, under IDENTIFIERS."
10937 (let* ((key (sha1 (prin1-to-string identifiers)))
10938 (entry (assoc key org-refile-cache)))
10939 (if entry
10940 (setcdr entry set)
10941 (push (cons key set) org-refile-cache))))
10943 (defun org-refile-cache-get (&rest identifiers)
10944 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10945 (cond
10946 ((not org-refile-cache) nil)
10947 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10948 (t
10949 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10950 org-refile-cache))))
10951 (and set (org-refile-cache-check-set set) set)))))
10953 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10954 "Produce a table with refile targets."
10955 (let ((case-fold-search nil)
10956 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10957 (entries (or org-refile-targets '((nil . (:level . 1)))))
10958 targets tgs txt re files f desc descre fast-path-p level pos0)
10959 (message "Getting targets...")
10960 (with-current-buffer (or default-buffer (current-buffer))
10961 (while (setq entry (pop entries))
10962 (setq files (car entry) desc (cdr entry))
10963 (setq fast-path-p nil)
10964 (cond
10965 ((null files) (setq files (list (current-buffer))))
10966 ((eq files 'org-agenda-files)
10967 (setq files (org-agenda-files 'unrestricted)))
10968 ((and (symbolp files) (fboundp files))
10969 (setq files (funcall files)))
10970 ((and (symbolp files) (boundp files))
10971 (setq files (symbol-value files))))
10972 (if (stringp files) (setq files (list files)))
10973 (cond
10974 ((eq (car desc) :tag)
10976 ((eq (car desc) :todo)
10978 ((eq (car desc) :regexp)
10979 (setq descre (cdr desc)))
10980 ((eq (car desc) :level)
10982 (if org-odd-levels-only
10983 (1- (* 2 (cdr desc)))
10984 (cdr desc)))
10986 ((eq (car desc) :maxlevel)
10987 (setq fast-path-p t)
10989 (if org-odd-levels-only
10990 (1- (* 2 (cdr desc)))
10991 (cdr desc)))
10993 (t (error "Bad refiling target description %s" desc)))
10994 (while (setq f (pop files))
10995 (with-current-buffer
10996 (if (bufferp f) f (org-get-agenda-file-buffer f))
10997 (or
10998 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10999 (progn
11000 (if (bufferp f) (setq f (buffer-file-name
11001 (buffer-base-buffer f))))
11002 (setq f (and f (expand-file-name f)))
11003 (if (eq org-refile-use-outline-path 'file)
11004 (push (list (file-name-nondirectory f) f nil nil) tgs))
11005 (save-excursion
11006 (save-restriction
11007 (widen)
11008 (goto-char (point-min))
11009 (while (re-search-forward descre nil t)
11010 (goto-char (setq pos0 (point-at-bol)))
11011 (catch 'next
11012 (when org-refile-target-verify-function
11013 (save-match-data
11014 (or (funcall org-refile-target-verify-function)
11015 (throw 'next t))))
11016 (when (and (looking-at org-complex-heading-regexp)
11017 (not (member (match-string 4) excluded-entries))
11018 (match-string 4))
11019 (setq level (org-reduced-level
11020 (- (match-end 1) (match-beginning 1)))
11021 txt (org-link-display-format (match-string 4))
11023 re (format org-complex-heading-regexp-format
11024 (regexp-quote (match-string 4))))
11025 (when org-refile-use-outline-path
11026 (setq txt (mapconcat
11027 'org-protect-slash
11028 (append
11029 (if (eq org-refile-use-outline-path
11030 'file)
11031 (list (file-name-nondirectory
11032 (buffer-file-name
11033 (buffer-base-buffer))))
11034 (if (eq org-refile-use-outline-path
11035 'full-file-path)
11036 (list (buffer-file-name
11037 (buffer-base-buffer)))))
11038 (org-get-outline-path fast-path-p
11039 level txt)
11040 (list txt))
11041 "/")))
11042 (push (list txt f re (org-refile-marker (point)))
11043 tgs)))
11044 (when (= (point) pos0)
11045 ;; verification function has not moved point
11046 (goto-char (point-at-eol))))))))
11047 (when org-refile-use-cache
11048 (org-refile-cache-put tgs (buffer-file-name) descre))
11049 (setq targets (append tgs targets))
11050 ))))
11051 (message "Getting targets...done")
11052 (nreverse targets)))
11054 (defun org-protect-slash (s)
11055 (while (string-match "/" s)
11057 s)
11059 (defvar org-olpa (make-vector 20 nil))
11061 (defun org-get-outline-path (&optional fastp level heading)
11062 "Return the outline path to the current entry, as a list.
11064 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11065 routine which makes outline path derivations for an entire file,
11066 avoiding backtracing. Refile target collection makes use of that."
11067 (if fastp
11068 (progn
11069 (if (> level 19)
11070 (error "Outline path failure, more than 19 levels"))
11071 (loop for i from level upto 19 do
11072 (aset org-olpa i nil))
11073 (prog1
11074 (delq nil (append org-olpa nil))
11075 (aset org-olpa level heading)))
11076 (let (rtn case-fold-search)
11077 (save-excursion
11078 (save-restriction
11079 (widen)
11080 (while (org-up-heading-safe)
11081 (when (looking-at org-complex-heading-regexp)
11082 (push (org-match-string-no-properties 4) rtn)))
11083 rtn)))))
11085 (defun org-format-outline-path (path &optional width prefix separator)
11086 "Format the outline path PATH for display.
11087 WIDTH is the maximum number of characters that is available.
11088 PREFIX is a prefix to be included in the returned string,
11089 such as the file name.
11090 SEPARATOR is inserted between the different parts of the path,
11092 (setq width (or width 79))
11093 (if prefix (setq width (- width (length prefix))))
11094 (if (not path)
11095 (or prefix "")
11096 (let* ((nsteps (length path))
11097 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11098 (maxwidth (if (<= total-width width)
11099 10000 ;; everything fits
11100 ;; we need to shorten the level headings
11101 (/ (- width nsteps) nsteps)))
11102 (org-odd-levels-only nil)
11103 (n 0)
11104 (total (1+ (length prefix))))
11105 (setq maxwidth (max maxwidth 10))
11106 (concat prefix
11107 (if prefix (or separator "/"))
11108 (mapconcat
11109 (lambda (h)
11110 (setq n (1+ n))
11111 (if (and (= n nsteps) (< maxwidth 10000))
11112 (setq maxwidth (- total-width total)))
11113 (if (< (length h) maxwidth)
11114 (progn (setq total (+ total (length h) 1)) h)
11115 (setq h (substring h 0 (- maxwidth 2))
11116 total (+ total maxwidth 1))
11118 (setq h (substring h 0 (match-beginning 0))))
11119 (setq h (concat h "..")))
11120 (org-add-props h nil 'face
11121 (nth (% (1- n) org-n-level-faces)
11122 org-level-faces))
11123 h)
11124 path (or separator "/"))))))
11126 (defun org-display-outline-path (&optional file current separator just-return-string)
11127 "Display the current outline path in the echo area.
11129 If FILE is non-nil, prepend the output with the file name.
11130 If CURRENT is non-nil, append the current heading to the output.
11131 SEPARATOR is passed through to `org-format-outline-path'. It separates
11133 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11134 (interactive "P")
11135 (let* (case-fold-search
11136 message-log-max ; Don't populate the *Messages* buffer
11137 (bfn (buffer-file-name (buffer-base-buffer)))
11138 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11139 res)
11140 (if current (setq path (append path
11141 (save-excursion
11142 (org-back-to-heading t)
11143 (if (looking-at org-complex-heading-regexp)
11144 (list (match-string 4)))))))
11145 (setq res
11146 (org-format-outline-path
11147 path
11148 (1- (frame-width))
11149 (and file bfn (concat (file-name-nondirectory bfn) separator))
11150 separator))
11151 (if just-return-string
11152 (org-no-properties res)
11153 (message "%s" res))))
11155 (defvar org-refile-history nil
11156 "History for refiling operations.")
11158 (defvar org-after-refile-insert-hook nil
11159 "Hook run after `org-refile' has inserted its stuff at the new location.
11160 Note that this is still *before* the stuff will be removed from
11161 the *old* location.")
11163 (defvar org-capture-last-stored-marker)
11164 (defvar org-refile-keep nil
11165 "Non-nil means `org-refile' will copy instead of refile.")
11167 (defun org-copy ()
11168 "Like `org-refile', but copy."
11169 (interactive)
11170 (let ((org-refile-keep t))
11171 (funcall 'org-refile nil nil nil "Copy")))
11173 (defun org-refile (&optional goto default-buffer rfloc msg)
11174 "Move the entry or entries at point to another heading.
11175 The list of target headings is compiled using the information in
11176 `org-refile-targets', which see.
11178 At the target location, the entry is filed as a subitem of the target
11179 heading. Depending on `org-reverse-note-order', the new subitem will
11180 either be the first or the last subitem.
11182 If there is an active region, all entries in that region will be moved.
11183 However, the region must fulfill the requirement that the first heading
11184 is the first one sets the top-level of the moved text - at most siblings
11185 below it are allowed.
11187 With prefix arg GOTO, the command will only visit the target location
11188 and not actually move anything.
11191 go to the location where the last refiling operation has put the subtree.
11192 With a prefix argument of `2', refile to the running clock.
11194 RFLOC can be a refile location obtained in a different way.
11199 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11201 If you are using target caching (see `org-refile-use-cache'),
11202 you have to clear the target cache in order to find new targets.
11203 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11204 prefix argument (`C-u C-u C-u C-c C-w')."
11206 (interactive "P")
11207 (if (member goto '(0 (64)))
11208 (org-refile-cache-clear)
11209 (let* ((actionmsg (or msg "Refile"))
11210 (cbuf (current-buffer))
11211 (regionp (org-region-active-p))
11212 (region-start (and regionp (region-beginning)))
11213 (region-end (and regionp (region-end)))
11214 (region-length (and regionp (- region-end region-start)))
11215 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11216 pos it nbuf file re level reversed)
11217 (setq last-command nil)
11218 (when regionp
11219 (goto-char region-start)
11220 (or (bolp) (goto-char (point-at-bol)))
11221 (setq region-start (point))
11222 (unless (or (org-kill-is-subtree-p
11223 (buffer-substring region-start region-end))
11224 (prog1 org-refile-active-region-within-subtree
11225 (org-toggle-heading)))
11226 (error "The region is not a (sequence of) subtree(s)")))
11227 (if (equal goto '(16))
11228 (org-refile-goto-last-stored)
11229 (when (or
11230 (and (equal goto 2)
11231 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11232 (prog1
11233 (setq it (list (or org-clock-heading "running clock")
11234 (buffer-file-name
11235 (marker-buffer org-clock-hd-marker))
11236 ""
11237 (marker-position org-clock-hd-marker)))
11238 (setq goto nil)))
11239 (setq it (or rfloc
11240 (let (heading-text)
11241 (save-excursion
11242 (unless goto
11243 (org-back-to-heading t)
11244 (setq heading-text
11245 (nth 4 (org-heading-components))))
11247 (org-refile-get-location
11248 (cond (goto "Goto")
11249 (regionp (concat actionmsg " region to"))
11252 default-buffer
11253 (and (not (equal '(4) goto))
11254 org-refile-allow-creating-parent-nodes)
11255 goto))))))
11256 (setq file (nth 1 it)
11257 re (nth 2 it)
11258 pos (nth 3 it))
11259 (if (and (not goto)
11260 pos
11261 (equal (buffer-file-name) file)
11262 (if regionp
11263 (and (>= pos region-start)
11264 (<= pos region-end))
11265 (and (>= pos (point))
11266 (< pos (save-excursion
11267 (org-end-of-subtree t t))))))
11268 (error "Cannot refile to position inside the tree or region"))
11270 (setq nbuf (or (find-buffer-visiting file)
11271 (find-file-noselect file)))
11272 (if goto
11273 (progn
11274 (org-pop-to-buffer-same-window nbuf)
11275 (goto-char pos)
11276 (org-show-context 'org-goto))
11277 (if regionp
11278 (progn
11279 (org-kill-new (buffer-substring region-start region-end))
11280 (org-save-markers-in-region region-start region-end))
11281 (org-copy-subtree 1 nil t))
11282 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11283 (find-file-noselect file)))
11284 (setq reversed (org-notes-order-reversed-p))
11285 (save-excursion
11286 (save-restriction
11287 (widen)
11288 (if pos
11289 (progn
11290 (goto-char pos)
11291 (looking-at org-outline-regexp)
11292 (setq level (org-get-valid-level (funcall outline-level) 1))
11293 (goto-char
11294 (if reversed
11295 (or (outline-next-heading) (point-max))
11296 (or (save-excursion (org-get-next-sibling))
11297 (org-end-of-subtree t t)
11298 (point-max)))))
11299 (setq level 1)
11300 (if (not reversed)
11301 (goto-char (point-max))
11302 (goto-char (point-min))
11303 (or (outline-next-heading) (goto-char (point-max)))))
11304 (if (not (bolp)) (newline))
11305 (org-paste-subtree level)
11306 (when org-log-refile
11307 (org-add-log-setup 'refile nil nil 'findpos
11308 org-log-refile)
11309 (unless (eq org-log-refile 'note)
11310 (save-excursion (org-add-log-note))))
11311 (and org-auto-align-tags
11312 (let ((org-loop-over-headlines-in-active-region nil))
11313 (org-set-tags nil t)))
11314 (with-demoted-errors
11315 (bookmark-set "org-refile-last-stored"))
11316 ;; If we are refiling for capture, make sure that the
11317 ;; last-capture pointers point here
11318 (when (org-bound-and-true-p org-refile-for-capture)
11319 (with-demoted-errors
11320 (bookmark-set "org-capture-last-stored-marker"))
11321 (move-marker org-capture-last-stored-marker (point)))
11322 (if (fboundp 'deactivate-mark) (deactivate-mark))
11323 (run-hooks 'org-after-refile-insert-hook))))
11324 (unless org-refile-keep
11325 (if regionp
11326 (delete-region (point) (+ (point) region-length))
11327 (org-cut-subtree)))
11328 (when (featurep 'org-inlinetask)
11329 (org-inlinetask-remove-END-maybe))
11330 (setq org-markers-to-move nil)
11333 (defun org-refile-goto-last-stored ()
11334 "Go to the location where the last refile was stored."
11335 (interactive)
11336 (bookmark-jump "org-refile-last-stored")
11337 (message "This is the location of the last refile"))
11339 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11340 no-exclude)
11341 "Prompt the user for a refile location, using PROMPT.
11342 PROMPT should not be suffixed with a colon and a space, because
11343 this function appends the default value from
11344 `org-refile-history' automatically, if that is not empty.
11345 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11346 this is used for the GOTO interface."
11347 (let ((org-refile-targets org-refile-targets)
11348 (org-refile-use-outline-path org-refile-use-outline-path)
11349 excluded-entries)
11350 (when (and (derived-mode-p 'org-mode)
11351 (not org-refile-use-cache)
11352 (not no-exclude))
11353 (org-map-tree
11354 (lambda()
11355 (setq excluded-entries
11356 (append excluded-entries (list (org-get-heading t t)))))))
11357 (setq org-refile-target-table
11358 (org-refile-get-targets default-buffer excluded-entries)))
11359 (unless org-refile-target-table
11360 (error "No refile targets"))
11361 (let* ((cbuf (current-buffer))
11362 (partial-completion-mode nil)
11363 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11364 (cfunc (if (and org-refile-use-outline-path
11365 org-outline-path-complete-in-steps)
11366 'org-olpath-completing-read
11367 'org-icompleting-read))
11368 (extra (if org-refile-use-outline-path "/" ""))
11369 (cbnex (concat (buffer-name) extra))
11370 (filename (and cfn (expand-file-name cfn)))
11371 (tbl (mapcar
11372 (lambda (x)
11373 (if (and (not (member org-refile-use-outline-path
11374 '(file full-file-path)))
11375 (not (equal filename (nth 1 x))))
11376 (cons (concat (car x) extra " ("
11377 (file-name-nondirectory (nth 1 x)) ")")
11378 (cdr x))
11379 (cons (concat (car x) extra) (cdr x))))
11380 org-refile-target-table))
11381 (completion-ignore-case t)
11382 cdef
11383 (prompt (concat prompt
11384 (or (and (car org-refile-history)
11385 (concat " (default " (car org-refile-history) ")"))
11386 (and (assoc cbnex tbl) (setq cdef cbnex)
11387 (concat " (default " cbnex ")"))) ": "))
11388 pa answ parent-target child parent old-hist)
11389 (setq old-hist org-refile-history)
11390 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11391 nil 'org-refile-history (or cdef (car org-refile-history))))
11392 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11393 (org-refile-check-position pa)
11394 (if pa
11395 (progn
11396 (when (or (not org-refile-history)
11397 (not (eq old-hist org-refile-history))
11398 (not (equal (car pa) (car org-refile-history))))
11399 (setq org-refile-history
11400 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11401 org-refile-history
11402 (cdr org-refile-history))))
11403 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11404 (pop org-refile-history)))
11405 pa)
11407 (progn
11408 (setq parent (match-string 1 answ)
11409 child (match-string 2 answ))
11410 (setq parent-target (or (assoc parent tbl)
11411 (assoc (concat parent "/") tbl)))
11412 (when (and parent-target
11413 (or (eq new-nodes t)
11414 (and (eq new-nodes 'confirm)
11416 child)))))
11417 (org-refile-new-child parent-target child)))
11418 (error "Invalid target location")))))
11420 (declare-function org-string-nw-p "org-macs" (s))
11421 (defun org-refile-check-position (refile-pointer)
11422 "Check if the refile pointer matches the headline to which it points."
11423 (let* ((file (nth 1 refile-pointer))
11424 (re (nth 2 refile-pointer))
11425 (pos (nth 3 refile-pointer))
11426 buffer)
11427 (if (and (not (markerp pos)) (not file))
11428 (error "Please save the buffer to a file before refiling")
11429 (when (org-string-nw-p re)
11430 (setq buffer (if (markerp pos)
11431 (marker-buffer pos)
11432 (or (find-buffer-visiting file)
11433 (find-file-noselect file))))
11434 (with-current-buffer buffer
11435 (save-excursion
11436 (save-restriction
11437 (widen)
11438 (goto-char pos)
11439 (beginning-of-line 1)
11440 (unless (org-looking-at-p re)
11441 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11443 (defun org-refile-new-child (parent-target child)
11444 "Use refile target PARENT-TARGET to add new CHILD below it."
11445 (unless parent-target
11446 (error "Cannot find parent for new node"))
11447 (let ((file (nth 1 parent-target))
11448 (pos (nth 3 parent-target))
11449 level)
11450 (with-current-buffer (or (find-buffer-visiting file)
11451 (find-file-noselect file))
11452 (save-excursion
11453 (save-restriction
11454 (widen)
11455 (if pos
11456 (goto-char pos)
11457 (goto-char (point-max))
11458 (if (not (bolp)) (newline)))
11459 (when (looking-at org-outline-regexp)
11460 (setq level (funcall outline-level))
11461 (org-end-of-subtree t t))
11462 (org-back-over-empty-lines)
11464 (if pos (org-get-valid-level level 1) 1) ?*)
11466 (beginning-of-line 0)
11467 (list (concat (car parent-target) "/" child) file "" (point)))))))
11469 (defun org-olpath-completing-read (prompt collection &rest args)
11470 "Read an outline path like a file name."
11471 (let ((thetable collection)
11472 (org-completion-use-ido nil) ; does not work with ido.
11473 (org-completion-use-iswitchb nil)) ; or iswitchb
11474 (apply
11475 'org-icompleting-read prompt
11476 (lambda (string predicate &optional flag)
11477 (let (rtn r f (l (length string)))
11478 (cond
11479 ((eq flag nil)
11480 ;; try completion
11481 (try-completion string thetable))
11482 ((eq flag t)
11483 ;; all-completions
11484 (setq rtn (all-completions string thetable predicate))
11485 (mapcar
11486 (lambda (x)
11487 (setq r (substring x l))
11488 (if (string-match " ([^)]*)$" x)
11489 (setq f (match-string 0 x))
11490 (setq f ""))
11491 (if (string-match "/" r)
11492 (concat string (substring r 0 (match-end 0)) f)
11493 x))
11494 rtn))
11495 ((eq flag 'lambda)
11496 ;; exact match?
11497 (assoc string thetable)))))
11498 args)))
11500 ;;;; Dynamic blocks
11502 (defun org-find-dblock (name)
11503 "Find the first dynamic block with name NAME in the buffer.
11504 If not found, stay at current position and return nil."
11505 (let ((case-fold-search t) pos)
11506 (save-excursion
11507 (goto-char (point-min))
11508 (setq pos (and (re-search-forward
11510 (match-beginning 0))))
11511 (if pos (goto-char pos))
11512 pos))
11514 (defconst org-dblock-start-re
11516 "Matches the start line of a dynamic block, with parameters.")
11519 "Matches the end of a dynamic block.")
11521 (defun org-create-dblock (plist)
11522 "Create a dynamic block section, with parameters taken from PLIST.
11523 PLIST must contain a :name entry which is used as name of the block."
11525 (end-of-line 1)
11526 (newline))
11527 (let ((col (current-column))
11528 (name (plist-get plist :name)))
11529 (insert "#+BEGIN: " name)
11530 (while plist
11531 (if (eq (car plist) :name)
11532 (setq plist (cddr plist))
11533 (insert " " (prin1-to-string (pop plist)))))
11535 (beginning-of-line -2)))
11537 (defun org-prepare-dblock ()
11538 "Prepare dynamic block for refresh.
11539 This empties the block, puts the cursor at the insert position and returns
11540 the property list including an extra property :name with the block name."
11541 (unless (looking-at org-dblock-start-re)
11542 (error "Not at a dynamic block"))
11543 (let* ((begdel (1+ (match-end 0)))
11544 (name (org-no-properties (match-string 1)))
11545 (params (append (list :name name)
11546 (read (concat "(" (match-string 3) ")")))))
11547 (save-excursion
11548 (beginning-of-line 1)
11550 (setq params (plist-put params :indentation-column (current-column))))
11551 (unless (re-search-forward org-dblock-end-re nil t)
11552 (error "Dynamic block not terminated"))
11553 (setq params
11554 (append params
11555 (list :content (buffer-substring
11556 begdel (match-beginning 0)))))
11557 (delete-region begdel (match-beginning 0))
11558 (goto-char begdel)
11559 (open-line 1)
11560 params))
11562 (defun org-map-dblocks (&optional command)
11563 "Apply COMMAND to all dynamic blocks in the current buffer.
11564 If COMMAND is not given, use `org-update-dblock'."
11565 (let ((cmd (or command 'org-update-dblock)))
11566 (save-excursion
11567 (goto-char (point-min))
11568 (while (re-search-forward org-dblock-start-re nil t)
11569 (goto-char (match-beginning 0))
11570 (save-excursion
11571 (condition-case nil
11572 (funcall cmd)
11573 (error (message "Error during update of dynamic block"))))
11574 (unless (re-search-forward org-dblock-end-re nil t)
11575 (error "Dynamic block not terminated"))))))
11577 (defun org-dblock-update (&optional arg)
11578 "User command for updating dynamic blocks.
11579 Update the dynamic block at point. With prefix ARG, update all dynamic
11580 blocks in the buffer."
11581 (interactive "P")
11582 (if arg
11583 (org-update-all-dblocks)
11584 (or (looking-at org-dblock-start-re)
11585 (org-beginning-of-dblock))
11586 (org-update-dblock)))
11588 (defun org-update-dblock ()
11589 "Update the dynamic block at point.
11590 This means to empty the block, parse for parameters and then call
11591 the correct writing function."
11592 (interactive)
11593 (save-window-excursion
11594 (let* ((pos (point))
11595 (line (org-current-line))
11596 (params (org-prepare-dblock))
11597 (name (plist-get params :name))
11598 (indent (plist-get params :indentation-column))
11599 (cmd (intern (concat "org-dblock-write:" name))))
11600 (message "Updating dynamic block `%s' at line %d..." name line)
11601 (funcall cmd params)
11602 (message "Updating dynamic block `%s' at line %d...done" name line)
11603 (goto-char pos)
11604 (when (and indent (> indent 0))
11605 (setq indent (make-string indent ?\ ))
11606 (save-excursion
11607 (org-beginning-of-dblock)
11608 (forward-line 1)
11609 (while (not (looking-at org-dblock-end-re))
11610 (insert indent)
11611 (beginning-of-line 2))
11612 (when (looking-at org-dblock-end-re)
11614 (replace-match ""))
11615 (insert indent)))))))
11617 (defun org-beginning-of-dblock ()
11618 "Find the beginning of the dynamic block at point.
11619 Error if there is no such block at point."
11620 (let ((pos (point))
11621 beg)
11622 (end-of-line 1)
11623 (if (and (re-search-backward org-dblock-start-re nil t)
11624 (setq beg (match-beginning 0))
11625 (re-search-forward org-dblock-end-re nil t)
11626 (> (match-end 0) pos))
11627 (goto-char beg)
11628 (goto-char pos)
11629 (error "Not in a dynamic block"))))
11631 (defun org-update-all-dblocks ()
11632 "Update all dynamic blocks in the buffer.
11633 This function can be used in a hook."
11634 (interactive)
11635 (when (derived-mode-p 'org-mode)
11636 (org-map-dblocks 'org-update-dblock)))
11639 ;;;; Completion
11641 (defun org-get-export-keywords ()
11642 "Return a list of all currently understood export keywords.
11643 Export keywords include options, block names, attributes and
11644 keywords relative to each registered export back-end."
11645 (delq nil
11646 (let (keywords)
11647 (mapc
11648 (lambda (back-end)
11649 (let ((props (cdr back-end)))
11650 ;; Back-end name (for keywords, like #+LATEX:)
11651 (push (upcase (symbol-name (car back-end))) keywords)
11652 ;; Back-end options.
11653 (mapc (lambda (option) (push (cadr option) keywords))
11654 (plist-get (cdr back-end) :options-alist))))
11655 (org-bound-and-true-p org-export-registered-backends))
11656 keywords)))
11658 (defconst org-options-keywords
11659 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11660 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11661 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11662 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11663 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:" "INFOJS_OPT:"))
11665 (defcustom org-structure-template-alist
11680 ("L" "#+LaTeX: "
11684 ("H" "#+HTML: "
11687 ("A" "#+ASCII: ")
11688 ("i" "#+INDEX: ?"
11689 "#+INDEX: ?")
11690 ("I" "#+INCLUDE: %file ?"
11692 "Structure completion elements.
11693 This is a list of abbreviation keys and values. The value gets inserted
11694 if you type `<' followed by the key and then press the completion key,
11695 usually `M-TAB'. %file will be replaced by a file name after prompting
11696 for the file using completion. The cursor will be placed at the position
11697 of the `?` in the template.
11698 There are two templates for each key, the first uses the original Org syntax,
11699 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11700 the default when the /org-mtags.el/ module has been loaded. See also the
11701 variable `org-mtags-prefer-muse-templates'."
11702 :group 'org-completion
11703 :type '(repeat
11704 (string :tag "Key")
11705 (string :tag "Template")
11706 (string :tag "Muse Template")))
11708 (defun org-try-structure-completion ()
11709 "Try to complete a structure template before point.
11711 expands them."
11712 (let ((l (buffer-substring (point-at-bol) (point)))
11713 a)
11716 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11717 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11718 (match-beginning 1)) a)
11719 t)))
11721 (defun org-complete-expand-structure-template (start cell)
11722 "Expand a structure template."
11723 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11724 (rpl (nth (if musep 2 1) cell))
11725 (ind ""))
11726 (delete-region start (point))
11728 (cond
11729 ((bolp))
11731 (setq ind (buffer-substring (point-at-bol) (point))))
11732 (t (newline))))
11733 (setq start (point))
11734 (if (string-match "%file" rpl)
11735 (setq rpl (replace-match
11736 (concat
11738 (save-match-data
11739 (abbreviate-file-name (read-file-name "Include file: ")))
11741 t t rpl)))
11744 (insert rpl)
11747 ;;;; TODO, DEADLINE, Comments
11749 (defun org-toggle-comment ()
11750 "Change the COMMENT state of an entry."
11751 (interactive)
11752 (save-excursion
11753 (org-back-to-heading)
11754 (let (case-fold-search)
11755 (cond
11756 ((looking-at (format org-heading-keyword-regexp-format
11757 org-comment-string))
11758 (goto-char (match-end 1))
11759 (looking-at (concat " +" org-comment-string))
11760 (replace-match "" t t)
11761 (when (eolp) (insert " ")))
11762 ((looking-at org-outline-regexp)
11763 (goto-char (match-end 0))
11764 (insert org-comment-string " "))))))
11766 (defvar org-last-todo-state-is-todo nil
11767 "This is non-nil when the last TODO state change led to a TODO state.
11768 If the last change removed the TODO tag or switched to DONE, then
11769 this is nil.")
11771 (defvar org-setting-tags nil) ; dynamically skipped
11773 (defvar org-todo-setup-filter-hook nil
11774 "Hook for functions that pre-filter todo specs.
11775 Each function takes a todo spec and returns either nil or the spec
11776 transformed into canonical form." )
11778 (defvar org-todo-get-default-hook nil
11779 "Hook for functions that get a default item for todo.
11780 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11781 nil or a string to be used for the todo mark." )
11783 (defvar org-agenda-headline-snapshot-before-repeat)
11785 (defun org-current-effective-time ()
11786 "Return current time adjusted for `org-extend-today-until' variable."
11787 (let* ((ct (org-current-time))
11788 (dct (decode-time ct))
11789 (ct1
11790 (cond
11791 (org-use-last-clock-out-time-as-effective-time
11792 (or (org-clock-get-last-clock-out-time) ct))
11793 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
11794 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
11795 (t ct))))
11796 ct1))
11798 (defun org-todo-yesterday (&optional arg)
11799 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11800 (interactive "P")
11801 (if (eq major-mode 'org-agenda-mode)
11802 (apply 'org-agenda-todo-yesterday arg)
11803 (let* ((hour (third (decode-time
11804 (org-current-time))))
11805 (org-extend-today-until (1+ hour)))
11806 (org-todo arg))))
11808 (defvar org-block-entry-blocking ""
11809 "First entry preventing the TODO state change.")
11811 (defun org-todo (&optional arg)
11812 "Change the TODO state of an item.
11813 The state of an item is given by a keyword at the start of the heading,
11814 like
11815 *** TODO Write paper
11816 *** DONE Call mom
11818 The different keywords are specified in the variable `org-todo-keywords'.
11820 So for this example: when the item starts with TODO, it is changed to DONE.
11821 When it starts with DONE, the DONE is removed. And when neither TODO nor
11822 DONE are present, add TODO at the beginning of the heading.
11825 state.
11826 With numeric prefix arg, switch to that state.
11828 keywords (nextset).
11830 With a numeric prefix arg of 0, inhibit note taking for the change.
11832 For calling through lisp, arg is also interpreted in the following way:
11833 'none -> empty state
11835 'done -> switch to DONE
11836 'nextset -> switch to the next set of keywords
11837 'previousset -> switch to the previous set of keywords
11839 really is a member of `org-todo-keywords'."
11840 (interactive "P")
11841 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11842 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11843 'region-start-level 'region))
11844 org-loop-over-headlines-in-active-region)
11845 (org-map-entries
11846 `(org-todo ,arg)
11847 org-loop-over-headlines-in-active-region
11848 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11849 (if (equal arg '(16)) (setq arg 'nextset))
11850 (let ((org-blocker-hook org-blocker-hook)
11851 commentp
11852 case-fold-search)
11853 (when (equal arg '(64))
11854 (setq arg nil org-blocker-hook nil))
11855 (when (and org-blocker-hook
11856 (or org-inhibit-blocking
11857 (org-entry-get nil "NOBLOCKING")))
11858 (setq org-blocker-hook nil))
11859 (save-excursion
11860 (catch 'exit
11861 (org-back-to-heading t)
11863 (org-toggle-comment)
11864 (setq commentp t))
11865 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11868 (let* ((match-data (match-data))
11869 (startpos (point-at-bol))
11870 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11871 (org-log-done org-log-done)
11872 (org-log-repeat org-log-repeat)
11873 (org-todo-log-states org-todo-log-states)
11874 (org-inhibit-logging
11875 (if (equal arg 0)
11876 (progn (setq arg nil) 'note) org-inhibit-logging))
11877 (this (match-string 1))
11878 (hl-pos (match-beginning 0))
11879 (head (org-get-todo-sequence-head this))
11880 (ass (assoc head org-todo-kwd-alist))
11881 (interpret (nth 1 ass))
11882 (done-word (nth 3 ass))
11883 (final-done-word (nth 4 ass))
11884 (org-last-state (or this ""))
11885 (completion-ignore-case t)
11886 (member (member this org-todo-keywords-1))
11887 (tail (cdr member))
11888 (org-state (cond
11889 ((and org-todo-key-trigger
11890 (or (and (equal arg '(4))
11891 (eq org-use-fast-todo-selection 'prefix))
11892 (and (not arg) org-use-fast-todo-selection
11893 (not (eq org-use-fast-todo-selection
11894 'prefix)))))
11895 ;; Use fast selection
11896 (org-fast-todo-selection))
11897 ((and (equal arg '(4))
11898 (or (not org-use-fast-todo-selection)
11899 (not org-todo-key-trigger)))
11900 ;; Read a state with completion
11901 (org-icompleting-read
11902 "State: " (mapcar (lambda(x) (list x))
11903 org-todo-keywords-1)
11904 nil t))
11905 ((eq arg 'right)
11906 (if this
11907 (if tail (car tail) nil)
11908 (car org-todo-keywords-1)))
11909 ((eq arg 'left)
11910 (if (equal member org-todo-keywords-1)
11911 nil
11912 (if this
11913 (nth (- (length org-todo-keywords-1)
11914 (length tail) 2)
11915 org-todo-keywords-1)
11916 (org-last org-todo-keywords-1))))
11917 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11918 (setq arg nil))) ; hack to fall back to cycling
11919 (arg
11920 ;; user or caller requests a specific state
11921 (cond
11922 ((equal arg "") nil)
11923 ((eq arg 'none) nil)
11924 ((eq arg 'done) (or done-word (car org-done-keywords)))
11925 ((eq arg 'nextset)
11926 (or (car (cdr (member head org-todo-heads)))
11927 (car org-todo-heads)))
11928 ((eq arg 'previousset)
11929 (let ((org-todo-heads (reverse org-todo-heads)))
11930 (or (car (cdr (member head org-todo-heads)))
11931 (car org-todo-heads))))
11932 ((car (member arg org-todo-keywords-1)))
11933 ((stringp arg)
11934 (error "State `%s' not valid in this file" arg))
11935 ((nth (1- (prefix-numeric-value arg))
11936 org-todo-keywords-1))))
11937 ((null member) (or head (car org-todo-keywords-1)))
11938 ((equal this final-done-word) nil) ;; -> make empty
11939 ((null tail) nil) ;; -> first entry
11940 ((memq interpret '(type priority))
11941 (if (eq this-command last-command)
11942 (car tail)
11943 (if (> (length tail) 0)
11944 (or done-word (car org-done-keywords))
11945 nil)))
11946 (t
11947 (car tail))))
11948 (org-state (or
11949 (run-hook-with-args-until-success
11950 'org-todo-get-default-hook org-state org-last-state)
11951 org-state))
11952 (next (if org-state (concat " " org-state " ") " "))
11953 (change-plist (list :type 'todo-state-change :from this :to org-state
11954 :position startpos))
11955 dolog now-done-p)
11956 (when org-blocker-hook
11957 (setq org-last-todo-state-is-todo
11958 (not (member this org-done-keywords)))
11959 (unless (save-excursion
11960 (save-match-data
11961 (org-with-wide-buffer
11962 (run-hook-with-args-until-failure
11963 'org-blocker-hook change-plist))))
11964 (if (org-called-interactively-p 'interactive)
11966 this org-state org-block-entry-blocking)
11967 ;; fail silently
11969 this org-state org-block-entry-blocking)
11970 (throw 'exit nil))))
11971 (store-match-data match-data)
11972 (replace-match next t t)
11973 (unless (pos-visible-in-window-p hl-pos)
11974 (message "TODO state changed to %s" (org-trim next)))
11975 (unless head
11976 (setq head (org-get-todo-sequence-head org-state)
11977 ass (assoc head org-todo-kwd-alist)
11978 interpret (nth 1 ass)
11979 done-word (nth 3 ass)
11980 final-done-word (nth 4 ass)))
11981 (when (memq arg '(nextset previousset))
11982 (message "Keyword-Set %d/%d: %s"
11983 (- (length org-todo-sets) -1
11984 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11985 (length org-todo-sets)
11986 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11987 (setq org-last-todo-state-is-todo
11988 (not (member org-state org-done-keywords)))
11989 (setq now-done-p (and (member org-state org-done-keywords)
11990 (not (member this org-done-keywords))))
11991 (and logging (org-local-logging logging))
11992 (when (and (or org-todo-log-states org-log-done)
11993 (not (eq org-inhibit-logging t))
11994 (not (memq arg '(nextset previousset))))
11995 ;; we need to look at recording a time and note
11996 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11997 (nth 2 (assoc this org-todo-log-states))))
11998 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11999 (setq dolog 'time))
12000 (when (and org-state
12001 (member org-state org-not-done-keywords)
12002 (not (member this org-not-done-keywords)))
12003 ;; This is now a todo state and was not one before
12004 ;; If there was a CLOSED time stamp, get rid of it.
12005 (org-add-planning-info nil nil 'closed))
12006 (when (and now-done-p org-log-done)
12007 ;; It is now done, and it was not done before
12008 (org-add-planning-info 'closed (org-current-effective-time))
12009 (if (and (not dolog) (eq 'note org-log-done))
12010 (org-add-log-setup 'done org-state this 'findpos 'note)))
12011 (when (and org-state dolog)
12012 ;; This is a non-nil state, and we need to log it
12013 (org-add-log-setup 'state org-state this 'findpos dolog)))
12014 ;; Fixup tag positioning
12015 (org-todo-trigger-tag-changes org-state)
12016 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12017 (when org-provide-todo-statistics
12018 (org-update-parent-todo-statistics))
12019 (run-hooks 'org-after-todo-state-change-hook)
12020 (if (and arg (not (member org-state org-done-keywords)))
12021 (setq head (org-get-todo-sequence-head org-state)))
12022 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12023 ;; Do we need to trigger a repeat?
12024 (when now-done-p
12025 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12026 ;; This is for the agenda, take a snapshot of the headline.
12027 (save-match-data
12028 (setq org-agenda-headline-snapshot-before-repeat
12029 (org-get-heading))))
12030 (org-auto-repeat-maybe org-state))
12031 ;; Fixup cursor location if close to the keyword
12032 (if (and (outline-on-heading-p)
12033 (not (bolp))
12034 (save-excursion (beginning-of-line 1)
12035 (looking-at org-todo-line-regexp))
12036 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12037 (progn
12038 (goto-char (or (match-end 2) (match-end 1)))
12039 (and (looking-at " ") (just-one-space))))
12040 (when org-trigger-hook
12041 (save-excursion
12042 (run-hook-with-args 'org-trigger-hook change-plist)))
12043 (when commentp (org-toggle-comment))))))))
12045 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12046 "Block turning an entry into a TODO, using the hierarchy.
12047 This checks whether the current task should be blocked from state
12048 changes. Such blocking occurs when:
12050 1. The task has children which are not all in a completed state.
12052 2. A task has a parent with the property :ORDERED:, and there
12053 are siblings prior to the current task with incomplete
12054 status.
12056 3. The parent of the task is blocked because it has siblings that should
12057 be done first, or is child of a block grandparent TODO entry."
12059 (if (not org-enforce-todo-dependencies)
12060 t ; if locally turned off don't block
12061 (catch 'dont-block
12062 ;; If this is not a todo state change, or if this entry is already DONE,
12063 ;; do not block
12064 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12065 (member (plist-get change-plist :from)
12066 (cons 'done org-done-keywords))
12067 (member (plist-get change-plist :to)
12068 (cons 'todo org-not-done-keywords))
12069 (not (plist-get change-plist :to)))
12070 (throw 'dont-block t))
12071 ;; If this task has children, and any are undone, it's blocked
12072 (save-excursion
12073 (org-back-to-heading t)
12074 (let ((this-level (funcall outline-level)))
12075 (outline-next-heading)
12076 (let ((child-level (funcall outline-level)))
12077 (while (and (not (eobp))
12078 (> child-level this-level))
12079 ;; this todo has children, check whether they are all
12080 ;; completed
12081 (if (and (not (org-entry-is-done-p))
12082 (org-entry-is-todo-p))
12083 (progn (setq org-block-entry-blocking (org-get-heading))
12084 (throw 'dont-block nil)))
12085 (outline-next-heading)
12086 (setq child-level (funcall outline-level))))))
12087 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12088 ;; any previous siblings are undone, it's blocked
12089 (save-excursion
12090 (org-back-to-heading t)
12091 (let* ((pos (point))
12092 (parent-pos (and (org-up-heading-safe) (point))))
12093 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12094 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12095 (forward-line 1)
12096 (re-search-forward org-not-done-heading-regexp pos t))
12097 (setq org-block-entry-blocking (match-string 0))
12098 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12099 ;; Search further up the hierarchy, to see if an ancestor is blocked
12100 (while t
12101 (goto-char parent-pos)
12102 (if (not (looking-at org-not-done-heading-regexp))
12103 (throw 'dont-block t)) ; do not block, parent is not a TODO
12104 (setq pos (point))
12105 (setq parent-pos (and (org-up-heading-safe) (point)))
12106 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12107 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12108 (forward-line 1)
12109 (re-search-forward org-not-done-heading-regexp pos t)
12110 (setq org-block-entry-blocking (org-get-heading)))
12111 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12113 (defcustom org-track-ordered-property-with-tag nil
12114 "Should the ORDERED property also be shown as a tag?
12115 The ORDERED property decides if an entry should require subtasks to be
12116 completed in sequence. Since a property is not very visible, setting
12117 this option means that toggling the ORDERED property with the command
12118 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12119 not relevant for the behavior, but it makes things more visible.
12121 Note that toggling the tag with tags commands will not change the property
12122 and therefore not influence behavior!
12124 This can be t, meaning the tag ORDERED should be used, It can also be a
12125 string to select a different tag for this task."
12126 :group 'org-todo
12127 :type '(choice
12128 (const :tag "No tracking" nil)
12129 (const :tag "Track with ORDERED tag" t)
12130 (string :tag "Use other tag")))
12132 (defun org-toggle-ordered-property ()
12133 "Toggle the ORDERED property of the current entry.
12134 For better visibility, you can track the value of this property with a tag.
12135 See variable `org-track-ordered-property-with-tag'."
12136 (interactive)
12137 (let* ((t1 org-track-ordered-property-with-tag)
12138 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12139 (save-excursion
12140 (org-back-to-heading)
12141 (if (org-entry-get nil "ORDERED")
12142 (progn
12143 (org-delete-property "ORDERED" "PROPERTIES")
12144 (and tag (org-toggle-tag tag 'off))
12145 (message "Subtasks can be completed in arbitrary order"))
12146 (org-entry-put nil "ORDERED" "t")
12147 (and tag (org-toggle-tag tag 'on))
12148 (message "Subtasks must be completed in sequence")))))
12150 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12151 (defun org-block-todo-from-checkboxes (change-plist)
12152 "Block turning an entry into a TODO, using checkboxes.
12153 This checks whether the current task should be blocked from state
12154 changes because there are unchecked boxes in this entry."
12155 (if (not org-enforce-todo-checkbox-dependencies)
12156 t ; if locally turned off don't block
12157 (catch 'dont-block
12158 ;; If this is not a todo state change, or if this entry is already DONE,
12159 ;; do not block
12160 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12161 (member (plist-get change-plist :from)
12162 (cons 'done org-done-keywords))
12163 (member (plist-get change-plist :to)
12164 (cons 'todo org-not-done-keywords))
12165 (not (plist-get change-plist :to)))
12166 (throw 'dont-block t))
12167 ;; If this task has checkboxes that are not checked, it's blocked
12168 (save-excursion
12169 (org-back-to-heading t)
12170 (let ((beg (point)) end)
12171 (outline-next-heading)
12172 (setq end (point))
12173 (goto-char beg)
12174 (if (org-list-search-forward
12175 (concat (org-item-beginning-re)
12178 end t)
12179 (progn
12180 (if (boundp 'org-blocked-by-checkboxes)
12181 (setq org-blocked-by-checkboxes t))
12182 (throw 'dont-block nil)))))
12183 t))) ; do not block
12185 (defun org-entry-blocked-p ()
12186 "Is the current entry blocked?"
12187 (org-with-silent-modifications
12188 (if (org-entry-get nil "NOBLOCKING")
12189 nil ;; Never block this entry
12190 (not (run-hook-with-args-until-failure
12191 'org-blocker-hook
12192 (list :type 'todo-state-change
12193 :position (point)
12194 :from 'todo
12195 :to 'done))))))
12197 (defun org-update-statistics-cookies (all)
12198 "Update the statistics cookie, either from TODO or from checkboxes.
12199 This should be called with the cursor in a line with a statistics cookie."
12200 (interactive "P")
12201 (if all
12202 (progn
12203 (org-update-checkbox-count 'all)
12204 (org-map-entries 'org-update-parent-todo-statistics))
12205 (if (not (org-at-heading-p))
12206 (org-update-checkbox-count)
12207 (let ((pos (point-marker))
12208 end l1 l2)
12209 (ignore-errors (org-back-to-heading t))
12210 (if (not (org-at-heading-p))
12211 (org-update-checkbox-count)
12212 (setq l1 (org-outline-level))
12213 (setq end (save-excursion
12214 (outline-next-heading)
12215 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12216 (point)))
12217 (if (and (save-excursion
12218 (re-search-forward
12220 (not (save-excursion (re-search-forward
12222 (org-update-checkbox-count)
12223 (if (and l2 (> l2 l1))
12224 (progn
12225 (goto-char end)
12226 (org-update-parent-todo-statistics))
12227 (goto-char pos)
12228 (beginning-of-line 1)
12229 (while (re-search-forward
12231 (point-at-eol) t)
12232 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12233 (goto-char pos)
12234 (move-marker pos nil)))))
12236 (defvar org-entry-property-inherited-from) ;; defined below
12237 (defun org-update-parent-todo-statistics ()
12238 "Update any statistics cookie in the parent of the current headline.
12239 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12240 the entire subtree and this will travel up the hierarchy and update
12241 statistics everywhere."
12242 (let* ((prop (save-excursion (org-up-heading-safe)
12243 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12244 (recursive (or (not org-hierarchical-todo-statistics)
12246 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12247 0))
12248 (first t)
12250 level ltoggle l1 new ndel
12251 (cnt-all 0) (cnt-done 0) is-percent kwd
12252 checkbox-beg ov ovs ove cookie-present)
12253 (catch 'exit
12254 (save-excursion
12255 (beginning-of-line 1)
12256 (setq ltoggle (funcall outline-level))
12257 ;; Three situations are to consider:
12259 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12260 ;; to the top-level ancestor on the headline;
12262 ;; 2. If parent has "recursive" property, repeat up to the
12263 ;; headline setting that property, taking inheritance into
12264 ;; account;
12266 ;; 3. Else, move up to direct parent and proceed only once.
12267 (while (and (setq level (org-up-heading-safe))
12268 (or recursive first)
12269 (>= (point) lim))
12270 (setq first nil cookie-present nil)
12271 (unless (and level
12272 (not (string-match
12274 (downcase (or (org-entry-get nil "COOKIE_DATA")
12275 "")))))
12276 (throw 'exit nil))
12277 (while (re-search-forward box-re (point-at-eol) t)
12278 (setq cnt-all 0 cnt-done 0 cookie-present t)
12279 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12280 (save-match-data
12281 (unless (outline-next-heading) (throw 'exit nil))
12282 (while (and (looking-at org-complex-heading-regexp)
12283 (> (setq l1 (length (match-string 1))) level))
12284 (setq kwd (and (or recursive (= l1 ltoggle))
12285 (match-string 2)))
12286 (if (or (eq org-provide-todo-statistics 'all-headlines)
12287 (and (listp org-provide-todo-statistics)
12288 (or (member kwd org-provide-todo-statistics)
12289 (member kwd org-done-keywords))))
12290 (setq cnt-all (1+ cnt-all))
12291 (if (eq org-provide-todo-statistics t)
12292 (and kwd (setq cnt-all (1+ cnt-all)))))
12293 (and (member kwd org-done-keywords)
12294 (setq cnt-done (1+ cnt-done)))
12295 (outline-next-heading)))
12296 (setq new
12297 (if is-percent
12298 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12299 (format "[%d/%d]" cnt-done cnt-all))
12300 ndel (- (match-end 0) checkbox-beg))
12301 ;; handle overlays when updating cookie from column view
12302 (when (setq ov (car (overlays-at checkbox-beg)))
12303 (setq ovs (overlay-start ov) ove (overlay-end ov))
12304 (delete-overlay ov))
12305 (goto-char checkbox-beg)
12306 (insert new)
12307 (delete-region (point) (+ (point) ndel))
12308 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12309 (when ov (move-overlay ov ovs ove)))
12310 (when cookie-present
12311 (run-hook-with-args 'org-after-todo-statistics-hook
12312 cnt-done (- cnt-all cnt-done))))))
12313 (run-hooks 'org-todo-statistics-hook)))
12315 (defvar org-after-todo-statistics-hook nil
12316 "Hook that is called after a TODO statistics cookie has been updated.
12317 Each function is called with two arguments: the number of not-done entries
12318 and the number of done entries.
12320 For example, the following function, when added to this hook, will switch
12321 an entry to DONE when all children are done, and back to TODO when new
12322 entries are set to a TODO status. Note that this hook is only called
12323 when there is a statistics cookie in the headline!
12325 (defun org-summary-todo (n-done n-not-done)
12327 (let (org-log-done org-log-states) ; turn off logging
12329 ")
12331 (defvar org-todo-statistics-hook nil
12332 "Hook that is run whenever Org thinks TODO statistics should be updated.
12333 This hook runs even if there is no statistics cookie present, in which case
12334 `org-after-todo-statistics-hook' would not run.")
12336 (defun org-todo-trigger-tag-changes (state)
12337 "Apply the changes defined in `org-todo-state-tags-triggers'."
12338 (let ((l org-todo-state-tags-triggers)
12339 changes)
12340 (when (or (not state) (equal state ""))
12341 (setq changes (append changes (cdr (assoc "" l)))))
12342 (when (and (stringp state) (> (length state) 0))
12343 (setq changes (append changes (cdr (assoc state l)))))
12344 (when (member state org-not-done-keywords)
12345 (setq changes (append changes (cdr (assoc 'todo l)))))
12346 (when (member state org-done-keywords)
12347 (setq changes (append changes (cdr (assoc 'done l)))))
12348 (dolist (c changes)
12349 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12351 (defun org-local-logging (value)
12352 "Get logging settings from a property VALUE."
12353 (let* (words w a)
12354 ;; directly set the variables, they are already local.
12355 (setq org-log-done nil
12356 org-log-repeat nil
12357 org-todo-log-states nil)
12358 (setq words (org-split-string value))
12359 (while (setq w (pop words))
12360 (cond
12361 ((setq a (assoc w org-startup-options))
12362 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12363 (set (nth 1 a) (nth 2 a))))
12364 ((setq a (org-extract-log-state-settings w))
12365 (and (member (car a) org-todo-keywords-1)
12366 (push a org-todo-log-states)))))))
12368 (defun org-get-todo-sequence-head (kwd)
12369 "Return the head of the TODO sequence to which KWD belongs.
12370 If KWD is not set, check if there is a text property remembering the
12371 right sequence."
12372 (let (p)
12373 (cond
12374 ((not kwd)
12375 (or (get-text-property (point-at-bol) 'org-todo-head)
12376 (progn
12377 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12378 nil (point-at-eol)))
12379 (get-text-property p 'org-todo-head))))
12380 ((not (member kwd org-todo-keywords-1))
12381 (car org-todo-keywords-1))
12382 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12384 (defun org-fast-todo-selection ()
12385 "Fast TODO keyword selection with single keys.
12386 Returns the new TODO keyword, or nil if no state change should occur."
12387 (let* ((fulltable org-todo-key-alist)
12388 (done-keywords org-done-keywords) ;; needed for the faces.
12389 (maxlen (apply 'max (mapcar
12390 (lambda (x)
12391 (if (stringp (car x)) (string-width (car x)) 0))
12392 fulltable)))
12393 (expert nil)
12394 (fwidth (+ maxlen 3 1 3))
12395 (ncol (/ (- (window-width) 4) fwidth))
12396 tg cnt e c tbl
12397 groups ingroup)
12398 (save-excursion
12399 (save-window-excursion
12400 (if expert
12401 (set-buffer (get-buffer-create " *Org todo*"))
12402 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12403 (erase-buffer)
12404 (org-set-local 'org-done-keywords done-keywords)
12405 (setq tbl fulltable cnt 0)
12406 (while (setq e (pop tbl))
12407 (cond
12408 ((equal e '(:startgroup))
12409 (push '() groups) (setq ingroup t)
12410 (when (not (= cnt 0))
12411 (setq cnt 0)
12413 (insert "{ "))
12414 ((equal e '(:endgroup))
12415 (setq ingroup nil cnt 0)
12417 ((equal e '(:newline))
12418 (when (not (= cnt 0))
12419 (setq cnt 0)
12421 (setq e (car tbl))
12422 (while (equal (car tbl) '(:newline))
12424 (setq tbl (cdr tbl)))))
12425 (t
12426 (setq tg (car e) c (cdr e))
12427 (if ingroup (push tg (car groups)))
12428 (setq tg (org-add-props tg nil 'face
12429 (org-get-todo-face tg)))
12430 (if (and (= cnt 0) (not ingroup)) (insert " "))
12431 (insert "[" c "] " tg (make-string
12432 (- fwidth 4 (length tg)) ?\ ))
12433 (when (= (setq cnt (1+ cnt)) ncol)
12435 (if ingroup (insert " "))
12436 (setq cnt 0)))))
12438 (goto-char (point-min))
12439 (if (not expert) (org-fit-window-to-buffer))
12440 (message "[a-z..]:Set [SPC]:clear")
12441 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12442 (cond
12443 ((or (= c ?\C-g)
12444 (and (= c ?q) (not (rassoc c fulltable))))
12445 (setq quit-flag t))
12446 ((= c ?\ ) nil)
12447 ((setq e (rassoc c fulltable) tg (car e))
12448 tg)
12449 (t (setq quit-flag t)))))))
12451 (defun org-entry-is-todo-p ()
12452 (member (org-get-todo-state) org-not-done-keywords))
12454 (defun org-entry-is-done-p ()
12455 (member (org-get-todo-state) org-done-keywords))
12457 (defun org-get-todo-state ()
12458 (save-excursion
12459 (org-back-to-heading t)
12460 (and (looking-at org-todo-line-regexp)
12461 (match-end 2)
12462 (match-string 2))))
12464 (defun org-at-date-range-p (&optional inactive-ok)
12465 "Is the cursor inside a date range?"
12466 (interactive)
12467 (save-excursion
12468 (catch 'exit
12469 (let ((pos (point)))
12471 (skip-chars-backward "<[")
12472 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12473 (>= (match-end 0) pos)
12474 (throw 'exit t))
12476 (skip-chars-backward "<[")
12477 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12478 (>= (match-end 0) pos)
12479 (throw 'exit t)))
12480 nil)))
12482 (defun org-get-repeat (&optional tagline)
12483 "Check if there is a deadline/schedule with repeater in this entry."
12484 (save-match-data
12485 (save-excursion
12486 (org-back-to-heading t)
12487 (and (re-search-forward (if tagline
12489 org-repeat-re)
12490 (org-entry-end-position) t)
12491 (match-string-no-properties 1)))))
12493 (defvar org-last-changed-timestamp)
12494 (defvar org-last-inserted-timestamp)
12495 (defvar org-log-post-message)
12496 (defvar org-log-note-purpose)
12497 (defvar org-log-note-how)
12498 (defvar org-log-note-extra)
12499 (defun org-auto-repeat-maybe (done-word)
12500 "Check if the current headline contains a repeated deadline/schedule.
12501 If yes, set TODO state back to what it was and change the base date
12502 of repeating deadline/scheduled time stamps to new date.
12503 This function is run automatically after each state change to a DONE state."
12504 ;; last-state is dynamically scoped into this function
12505 (let* ((repeat (org-get-repeat))
12506 (aa (assoc org-last-state org-todo-kwd-alist))
12507 (interpret (nth 1 aa))
12508 (head (nth 2 aa))
12509 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12510 (msg "Entry repeats: ")
12511 (org-log-done nil)
12512 (org-todo-log-states nil)
12513 re type n what ts time to-state)
12514 (when repeat
12515 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12516 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12517 org-todo-repeat-to-state))
12518 (unless (and to-state (member to-state org-todo-keywords-1))
12519 (setq to-state (if (eq interpret 'type) org-last-state head)))
12520 (org-todo to-state)
12521 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12522 (org-entry-put nil "LAST_REPEAT" (format-time-string
12523 (org-time-stamp-format t t))))
12524 (when org-log-repeat
12525 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12526 (memq 'org-add-log-note post-command-hook))
12527 ;; OK, we are already setup for some record
12528 (if (eq org-log-repeat 'note)
12529 ;; make sure we take a note, not only a time stamp
12530 (setq org-log-note-how 'note))
12531 ;; Set up for taking a record
12532 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12533 org-last-state
12534 'findpos org-log-repeat)))
12535 (org-back-to-heading t)
12536 (org-add-planning-info nil nil 'closed)
12540 (while (re-search-forward
12541 re (save-excursion (outline-next-heading) (point)) t)
12542 (setq type (if (match-end 1) org-scheduled-string
12543 (if (match-end 3) org-deadline-string "Plain:"))
12544 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12546 (setq n (string-to-number (match-string 2 ts))
12547 what (match-string 3 ts))
12548 (if (equal what "w") (setq n (* n 7) what "d"))
12550 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12551 ;; Preparation, see if we need to modify the start date for the change
12552 (when (match-end 1)
12553 (setq time (save-match-data (org-time-string-to-time ts)))
12554 (cond
12555 ((equal (match-string 1 ts) ".")
12556 ;; Shift starting date to today
12557 (org-timestamp-change
12558 (- (org-today) (time-to-days time))
12559 'day))
12560 ((equal (match-string 1 ts) "+")
12561 (let ((nshiftmax 10) (nshift 0))
12562 (while (or (= nshift 0)
12563 (<= (time-to-days time)
12564 (time-to-days (current-time))))
12565 (when (= (incf nshift) nshiftmax)
12566 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12567 (error "Abort")))
12568 (org-timestamp-change n (cdr (assoc what whata)))
12569 (org-at-timestamp-p t)
12570 (setq ts (match-string 1))
12571 (setq time (save-match-data (org-time-string-to-time ts)))))
12572 (org-timestamp-change (- n) (cdr (assoc what whata)))
12573 ;; rematch, so that we have everything in place for the real shift
12574 (org-at-timestamp-p t)
12575 (setq ts (match-string 1))
12577 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12578 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12579 (setq org-log-post-message msg)
12580 (message "%s" msg))))
12582 (defun org-show-todo-tree (arg)
12583 "Make a compact tree which shows all headlines marked with TODO.
12584 The tree will show the lines where the regexp matches, and all higher
12585 headlines above the match.
12587 With a numeric prefix N, construct a sparse tree for the Nth element
12588 of `org-todo-keywords-1'."
12589 (interactive "P")
12590 (let ((case-fold-search nil)
12591 (kwd-re
12592 (cond ((null arg) org-not-done-regexp)
12593 ((equal arg '(4))
12594 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12595 (mapcar 'list org-todo-keywords-1))))
12599 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12600 (regexp-quote (nth (1- (prefix-numeric-value arg))
12601 org-todo-keywords-1)))
12602 (t (error "Invalid prefix argument: %s" arg)))))
12603 (message "%d TODO entries found"
12604 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12606 (defun org-deadline (&optional arg time)
12608 With one universal prefix argument, remove any deadline from the item.
12609 With two universal prefix arguments, prompt for a warning delay.
12610 With argument TIME, set the deadline at the corresponding date. TIME
12612 (interactive "P")
12613 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12614 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12615 'region-start-level 'region))
12616 org-loop-over-headlines-in-active-region)
12617 (org-map-entries
12618 `(org-deadline ',arg ,time)
12619 org-loop-over-headlines-in-active-region
12620 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12621 (let* ((old-date (org-entry-get nil "DEADLINE"))
12622 (repeater (and old-date
12623 (string-match
12625 old-date)
12626 (match-string 1 old-date))))
12627 (cond
12628 ((equal arg '(4))
12629 (when (and old-date org-log-redeadline)
12630 (org-add-log-setup 'deldeadline nil old-date 'findpos
12631 org-log-redeadline))
12632 (org-remove-timestamp-with-keyword org-deadline-string)
12633 (message "Item no longer has a deadline."))
12634 ((equal arg '(16))
12635 (save-excursion
12636 (if (re-search-forward
12637 org-deadline-time-regexp
12638 (save-excursion (outline-next-heading) (point)) t)
12639 (let* ((rpl0 (match-string 1))
12640 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12641 (replace-match
12642 (concat org-deadline-string
12643 " <" rpl
12644 (format " -%dd" (abs
12645 (- (time-to-days
12646 (save-match-data
12647 (org-read-date nil t nil "Warn starting from")))
12648 (time-to-days nil))))
12649 ">") t t))
12650 (user-error "No deadline information to update"))))
12651 (t
12652 (org-add-planning-info 'deadline time 'closed)
12653 (when (and old-date org-log-redeadline
12654 (not (equal old-date
12655 (substring org-last-inserted-timestamp 1 -1))))
12656 (org-add-log-setup 'redeadline nil old-date 'findpos
12657 org-log-redeadline))
12658 (when repeater
12659 (save-excursion
12660 (org-back-to-heading t)
12661 (when (re-search-forward (concat org-deadline-string " "
12662 org-last-inserted-timestamp)
12663 (save-excursion
12664 (outline-next-heading) (point)) t)
12665 (goto-char (1- (match-end 0)))
12666 (insert " " repeater)
12667 (setq org-last-inserted-timestamp
12668 (concat (substring org-last-inserted-timestamp 0 -1)
12669 " " repeater
12670 (substring org-last-inserted-timestamp -1))))))
12671 (message "Deadline on %s" org-last-inserted-timestamp))))))
12673 (defun org-schedule (&optional arg time)
12674 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12675 With one universal prefix argument, remove any scheduling date from the item.
12676 With two universal prefix arguments, prompt for a delay cookie.
12677 With argument TIME, scheduled at the corresponding date. TIME can
12679 (interactive "P")
12680 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12681 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12682 'region-start-level 'region))
12683 org-loop-over-headlines-in-active-region)
12684 (org-map-entries
12685 `(org-schedule ',arg ,time)
12686 org-loop-over-headlines-in-active-region
12687 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12688 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12689 (repeater (and old-date
12690 (string-match
12692 old-date)
12693 (match-string 1 old-date))))
12694 (cond
12695 ((equal arg '(4))
12696 (progn
12697 (when (and old-date org-log-reschedule)
12698 (org-add-log-setup 'delschedule nil old-date 'findpos
12699 org-log-reschedule))
12700 (org-remove-timestamp-with-keyword org-scheduled-string)
12701 (message "Item is no longer scheduled.")))
12702 ((equal arg '(16))
12703 (save-excursion
12704 (if (re-search-forward
12705 org-scheduled-time-regexp
12706 (save-excursion (outline-next-heading) (point)) t)
12707 (let* ((rpl0 (match-string 1))
12708 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12709 (replace-match
12710 (concat org-scheduled-string
12711 " <" rpl
12712 (format " -%dd" (abs
12713 (- (time-to-days
12714 (save-match-data
12715 (org-read-date nil t nil "Delay until")))
12716 (time-to-days nil))))
12717 ">") t t))
12718 (user-error "No scheduled information to update"))))
12719 (t
12720 (org-add-planning-info 'scheduled time 'closed)
12721 (when (and old-date org-log-reschedule
12722 (not (equal old-date
12723 (substring org-last-inserted-timestamp 1 -1))))
12724 (org-add-log-setup 'reschedule nil old-date 'findpos
12725 org-log-reschedule))
12726 (when repeater
12727 (save-excursion
12728 (org-back-to-heading t)
12729 (when (re-search-forward (concat org-scheduled-string " "
12730 org-last-inserted-timestamp)
12731 (save-excursion
12732 (outline-next-heading) (point)) t)
12733 (goto-char (1- (match-end 0)))
12734 (insert " " repeater)
12735 (setq org-last-inserted-timestamp
12736 (concat (substring org-last-inserted-timestamp 0 -1)
12737 " " repeater
12738 (substring org-last-inserted-timestamp -1))))))
12739 (message "Scheduled to %s" org-last-inserted-timestamp))))))
12741 (defun org-get-scheduled-time (pom &optional inherit)
12742 "Get the scheduled time as a time tuple, of a format suitable
12743 for calling org-schedule with, or if there is no scheduling,
12744 returns nil."
12745 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12746 (when time
12747 (apply 'encode-time (org-parse-time-string time)))))
12749 (defun org-get-deadline-time (pom &optional inherit)
12750 "Get the deadline as a time tuple, of a format suitable for
12751 calling org-deadline with, or if there is no scheduling, returns
12752 nil."
12753 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12754 (when time
12755 (apply 'encode-time (org-parse-time-string time)))))
12757 (defun org-remove-timestamp-with-keyword (keyword)
12758 "Remove all time stamps with KEYWORD in the current entry."
12760 beg)
12761 (save-excursion
12762 (org-back-to-heading t)
12763 (setq beg (point))
12764 (outline-next-heading)
12765 (while (re-search-backward re beg t)
12766 (replace-match "")
12768 (equal (char-before) ?\ ))
12769 (backward-delete-char 1)
12771 (point-at-bol) (point-at-eol)))
12772 (delete-region (point-at-bol)
12773 (min (point-max) (1+ (point-at-eol))))))))))
12775 (defun org-add-planning-info (what &optional time &rest remove)
12776 "Insert new timestamp with keyword in the line directly after the headline.
12777 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12778 If non is given, the user is prompted for a date.
12779 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12780 be removed."
12781 (interactive)
12782 (let (org-time-was-given org-end-time-was-given ts
12783 end default-time default-input)
12785 (catch 'exit
12786 (when (and (memq what '(scheduled deadline))
12787 (or (not time)
12788 (and (stringp time)
12789 (string-match "^[-+]+[0-9]" time))))
12790 ;; Try to get a default date/time from existing timestamp
12791 (save-excursion
12792 (org-back-to-heading t)
12793 (setq end (save-excursion (outline-next-heading) (point)))
12794 (when (re-search-forward (if (eq what 'scheduled)
12795 org-scheduled-time-regexp
12796 org-deadline-time-regexp)
12797 end t)
12798 (setq ts (match-string 1)
12799 default-time
12800 (apply 'encode-time (org-parse-time-string ts))
12801 default-input (and ts (org-get-compact-tod ts))))))
12802 (when what
12803 (setq time
12804 (if (stringp time)
12805 ;; This is a string (relative or absolute), set proper date
12806 (apply 'encode-time
12807 (org-read-date-analyze
12808 time default-time (decode-time default-time)))
12809 ;; If necessary, get the time from the user
12810 (or time (org-read-date nil 'to-time nil nil
12811 default-time default-input)))))
12813 (when (and org-insert-labeled-timestamps-at-point
12814 (member what '(scheduled deadline)))
12815 (insert
12816 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12817 (org-insert-time-stamp time org-time-was-given
12818 nil nil nil (list org-end-time-was-given))
12819 (setq what nil))
12820 (save-excursion
12821 (save-restriction
12822 (let (col list elt ts buffer-invisibility-spec)
12823 (org-back-to-heading t)
12825 (goto-char (match-end 1))
12826 (setq col (current-column))
12827 (goto-char (match-end 0))
12829 (when (and (not what)
12830 (not (looking-at
12832 org-keyword-time-not-clock-regexp))))
12833 ;; Nothing to add, nothing to remove...... :-)
12834 (throw 'exit nil))
12835 (if (and (not (looking-at org-outline-regexp))
12838 (not (equal (match-string 1) org-clock-string)))
12839 (narrow-to-region (match-beginning 0) (match-end 0))
12841 (backward-char 1)
12842 (narrow-to-region (point) (point))
12843 (and org-adapt-indentation (org-indent-to-column col)))
12844 ;; Check if we have to remove something.
12845 (setq list (cons what remove))
12846 (while list
12847 (setq elt (pop list))
12848 (when (or (and (eq elt 'scheduled)
12849 (re-search-forward org-scheduled-time-regexp nil t))
12850 (and (eq elt 'deadline)
12851 (re-search-forward org-deadline-time-regexp nil t))
12852 (and (eq elt 'closed)
12853 (re-search-forward org-closed-time-regexp nil t)))
12854 (replace-match "")
12855 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12857 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12858 (when what
12859 (insert
12860 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12861 (cond ((eq what 'scheduled) org-scheduled-string)
12862 ((eq what 'deadline) org-deadline-string)
12863 ((eq what 'closed) org-closed-string))
12864 " ")
12865 (setq ts (org-insert-time-stamp
12866 time
12867 (or org-time-was-given
12868 (and (eq what 'closed) org-log-done-with-time))
12869 (eq what 'closed)
12870 nil nil (list org-end-time-was-given)))
12871 (insert
12872 (if (not (or (bolp) (eq (char-before) ?\ )
12873 (memq (char-after) '(32 10))
12874 (eobp))) " " ""))
12875 (end-of-line 1))
12876 (goto-char (point-min))
12877 (widen)
12880 (delete-region (1- (point)) (point-at-eol)))
12881 ts))))))
12883 (defvar org-log-note-marker (make-marker))
12884 (defvar org-log-note-purpose nil)
12885 (defvar org-log-note-state nil)
12886 (defvar org-log-note-previous-state nil)
12887 (defvar org-log-note-how nil)
12888 (defvar org-log-note-extra nil)
12889 (defvar org-log-note-window-configuration nil)
12890 (defvar org-log-note-return-to (make-marker))
12891 (defvar org-log-note-effective-time nil
12892 "Remembered current time so that dynamically scoped
12893 `org-extend-today-until' affects tha timestamps in state change
12894 log")
12896 (defvar org-log-post-message nil
12897 "Message to be displayed after a log note has been stored.
12898 The auto-repeater uses this.")
12900 (defun org-add-note ()
12901 "Add a note to the current entry.
12902 This is done in the same way as adding a state change note."
12903 (interactive)
12904 (org-add-log-setup 'note nil nil 'findpos nil))
12906 (defvar org-property-end-re)
12907 (defun org-add-log-setup (&optional purpose state prev-state
12908 findpos how extra)
12909 "Set up the post command hook to take a note.
12910 If this is about to TODO state change, the new state is expected in STATE.
12911 When FINDPOS is non-nil, find the correct position for the note in
12912 the current entry. If not, assume that it can be inserted at point.
12913 HOW is an indicator what kind of note should be created.
12914 EXTRA is additional text that will be inserted into the notes buffer."
12915 (let* ((org-log-into-drawer (org-log-into-drawer))
12916 (drawer (cond ((stringp org-log-into-drawer)
12917 org-log-into-drawer)
12918 (org-log-into-drawer "LOGBOOK"))))
12919 (save-restriction
12920 (save-excursion
12921 (when findpos
12922 (org-back-to-heading t)
12923 (narrow-to-region (point) (save-excursion
12924 (outline-next-heading) (point)))
12928 (goto-char (match-end 0))
12929 (cond
12930 (drawer
12932 nil t)
12933 (progn
12934 (goto-char (match-end 0))
12935 (or org-log-states-order-reversed
12936 (and (re-search-forward org-property-end-re nil t)
12937 (goto-char (1- (match-beginning 0))))))
12939 (beginning-of-line 0)
12940 (org-indent-line)
12941 (beginning-of-line 2)
12942 (org-indent-line)
12943 (end-of-line 0)))
12944 ((and org-log-state-notes-insert-after-drawers
12945 (save-excursion
12946 (forward-line) (looking-at org-drawer-regexp)))
12947 (forward-line)
12948 (while (looking-at org-drawer-regexp)
12949 (goto-char (match-end 0))
12950 (re-search-forward org-property-end-re (point-max) t)
12951 (forward-line))
12952 (forward-line -1)))
12953 (unless org-log-states-order-reversed
12955 (org-skip-over-state-notes)
12957 (move-marker org-log-note-marker (point))
12958 (setq org-log-note-purpose purpose
12959 org-log-note-state state
12960 org-log-note-previous-state prev-state
12961 org-log-note-how how
12962 org-log-note-extra extra
12963 org-log-note-effective-time (org-current-effective-time))
12964 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12966 (defun org-skip-over-state-notes ()
12967 "Skip past the list of State notes in an entry."
12969 (when (ignore-errors (goto-char (org-in-item-p)))
12970 (let* ((struct (org-list-struct))
12971 (prevs (org-list-prevs-alist struct)))
12973 (goto-char (or (org-list-get-next-item (point) struct prevs)
12974 (org-list-get-item-end (point) struct)))))))
12976 (defun org-add-log-note (&optional purpose)
12977 "Pop up a window for taking a note, and add this note later at point."
12978 (remove-hook 'post-command-hook 'org-add-log-note)
12979 (setq org-log-note-window-configuration (current-window-configuration))
12980 (delete-other-windows)
12981 (move-marker org-log-note-return-to (point))
12982 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12983 (goto-char org-log-note-marker)
12984 (org-switch-to-buffer-other-window "*Org Note*")
12985 (erase-buffer)
12986 (if (memq org-log-note-how '(time state))
12987 (let (current-prefix-arg) (org-store-log-note))
12988 (let ((org-inhibit-startup t)) (org-mode))
12989 (insert (format "# Insert note for %s.
12991 (cond
12992 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12993 ((eq org-log-note-purpose 'done) "closed todo item")
12994 ((eq org-log-note-purpose 'state)
12996 (or org-log-note-previous-state "")
12997 (or org-log-note-state "")))
12998 ((eq org-log-note-purpose 'reschedule)
12999 "rescheduling")
13000 ((eq org-log-note-purpose 'delschedule)
13001 "no longer scheduled")
13002 ((eq org-log-note-purpose 'redeadline)
13003 "changing deadline")
13004 ((eq org-log-note-purpose 'deldeadline)
13005 "removing deadline")
13006 ((eq org-log-note-purpose 'refile)
13007 "refiling")
13008 ((eq org-log-note-purpose 'note)
13009 "this entry")
13010 (t (error "This should not happen")))))
13011 (if org-log-note-extra (insert org-log-note-extra))
13012 (org-set-local 'org-finish-function 'org-store-log-note)
13013 (run-hooks 'org-log-buffer-setup-hook)))
13015 (defvar org-note-abort nil) ; dynamically scoped
13016 (defun org-store-log-note ()
13017 "Finish taking a log note, and insert it to where it belongs."
13018 (let ((txt (buffer-string)))
13019 (kill-buffer (current-buffer))
13020 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13021 lines ind bul)
13023 (setq txt (replace-match "" t t txt)))
13025 (setq txt (replace-match "" t t txt)))
13028 (setq note
13029 (org-replace-escapes
13030 note
13031 (list (cons "%u" (user-login-name))
13032 (cons "%U" user-full-name)
13033 (cons "%t" (format-time-string
13034 (org-time-stamp-format 'long 'inactive)
13035 org-log-note-effective-time))
13036 (cons "%T" (format-time-string
13037 (org-time-stamp-format 'long nil)
13038 org-log-note-effective-time))
13039 (cons "%d" (format-time-string
13040 (org-time-stamp-format nil 'inactive)
13041 org-log-note-effective-time))
13042 (cons "%D" (format-time-string
13043 (org-time-stamp-format nil nil)
13044 org-log-note-effective-time))
13045 (cons "%s" (if org-log-note-state
13047 ""))
13048 (cons "%S" (if org-log-note-previous-state
13052 (push note lines))
13053 (when (or current-prefix-arg org-note-abort)
13054 (when org-log-into-drawer
13055 (org-remove-empty-drawer-at
13056 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13057 org-log-note-marker))
13058 (setq lines nil))
13059 (when lines
13060 (with-current-buffer (marker-buffer org-log-note-marker)
13061 (save-excursion
13062 (goto-char org-log-note-marker)
13063 (move-marker org-log-note-marker nil)
13064 (end-of-line 1)
13066 (setq ind (save-excursion
13067 (if (ignore-errors (goto-char (org-in-item-p)))
13068 (let ((struct (org-list-struct)))
13069 (org-list-get-ind
13070 (org-list-get-top-point struct) struct))
13072 (cond
13073 ((and (org-at-heading-p)
13074 org-adapt-indentation)
13075 (1+ (org-current-level)))
13076 ((org-at-heading-p) 0)
13077 (t (org-get-indentation))))))
13078 (setq bul (org-list-bullet-string "-"))
13079 (org-indent-line-to ind)
13080 (insert bul (pop lines))
13081 (let ((ind-body (+ (length bul) ind)))
13082 (while lines
13084 (org-indent-line-to ind-body)
13085 (insert (pop lines))))
13086 (message "Note stored")
13087 (org-back-to-heading t)
13088 (org-cycle-hide-drawers 'children))))))
13089 (set-window-configuration org-log-note-window-configuration)
13090 (with-current-buffer (marker-buffer org-log-note-return-to)
13091 (goto-char org-log-note-return-to))
13092 (move-marker org-log-note-return-to nil)
13093 (and org-log-post-message (message "%s" org-log-post-message)))
13095 (defun org-remove-empty-drawer-at (drawer pos)
13096 "Remove an empty drawer DRAWER at position POS.
13097 POS may also be a marker."
13098 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13099 (save-excursion
13100 (save-restriction
13101 (widen)
13102 (goto-char pos)
13103 (if (org-in-regexp
13105 (replace-match ""))))))
13107 (defvar org-ts-type nil)
13108 (defun org-sparse-tree (&optional arg type)
13109 "Create a sparse tree, prompt for the details.
13110 This command can create sparse trees. You first need to select the type
13111 of match used to create the tree:
13113 t Show all TODO entries.
13114 T Show entries with a specific TODO keyword.
13115 m Show entries selected by a tags/property match.
13116 p Enter a property name and its value (both with completion on existing
13117 names/values) and show entries with that property.
13118 r Show entries matching a regular expression (`/' can be used as well).
13119 b Show deadlines and scheduled items before a date.
13120 a Show deadlines and scheduled items after a date.
13121 d Show deadlines due within `org-deadline-warning-days'.
13122 D Show deadlines and scheduled items between a date range."
13123 (interactive "P")
13124 (let (ans kwd value ts-type)
13125 (setq type (or type org-sparse-tree-default-date-type))
13126 (setq org-ts-type type)
13127 (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"
13128 (cond ((eq type 'all) "all timestamps")
13129 ((eq type 'scheduled) "only scheduled")
13130 ((eq type 'deadline) "only deadline")
13131 ((eq type 'active) "only active timestamps")
13132 ((eq type 'inactive) "only inactive timestamps")
13133 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13134 (t "scheduled/deadline")))
13135 (setq ans (read-char-exclusive))
13136 (cond
13137 ((equal ans ?c)
13138 (org-sparse-tree arg (cadr (member type '(scheduled-or-deadline all scheduled deadline active inactive)))))
13139 ((equal ans ?d)
13140 (call-interactively 'org-check-deadlines))
13141 ((equal ans ?b)
13142 (call-interactively 'org-check-before-date))
13143 ((equal ans ?a)
13144 (call-interactively 'org-check-after-date))
13145 ((equal ans ?D)
13146 (call-interactively 'org-check-dates-range))
13147 ((equal ans ?t)
13148 (call-interactively 'org-show-todo-tree))
13149 ((equal ans ?T)
13150 (org-show-todo-tree '(4)))
13151 ((member ans '(?T ?m))
13152 (call-interactively 'org-match-sparse-tree))
13153 ((member ans '(?p ?P))
13154 (setq kwd (org-icompleting-read "Property: "
13155 (mapcar 'list (org-buffer-property-keys))))
13156 (setq value (org-icompleting-read "Value: "
13157 (mapcar 'list (org-property-values kwd))))
13160 (org-match-sparse-tree arg (concat kwd "=" value)))
13161 ((member ans '(?r ?R ?/))
13162 (call-interactively 'org-occur))
13165 (defvar org-occur-highlights nil
13166 "List of overlays used for occur matches.")
13167 (make-variable-buffer-local 'org-occur-highlights)
13168 (defvar org-occur-parameters nil
13169 "Parameters of the active org-occur calls.
13170 This is a list, each call to org-occur pushes as cons cell,
13171 containing the regular expression and the callback, onto the list.
13172 The list can contain several entries if `org-occur' has been called
13173 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13174 will only contain one set of parameters. When the highlights are
13175 removed (for example with `C-c C-c', or with the next edit (depending
13176 on `org-remove-highlights-with-change'), this variable is emptied
13177 as well.")
13178 (make-variable-buffer-local 'org-occur-parameters)
13180 (defun org-occur (regexp &optional keep-previous callback)
13181 "Make a compact tree which shows all matches of REGEXP.
13182 The tree will show the lines where the regexp matches, and all higher
13183 headlines above the match. It will also show the heading after the match,
13184 to make sure editing the matching entry is easy.
13185 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13186 call to `org-occur' will be kept, to allow stacking of calls to this
13187 command.
13188 If CALLBACK is non-nil, it is a function which is called to confirm
13189 that the match should indeed be shown."
13191 (when (equal regexp "")
13192 (error "Regexp cannot be empty"))
13193 (unless keep-previous
13194 (org-remove-occur-highlights nil nil t))
13195 (push (cons regexp callback) org-occur-parameters)
13196 (let ((cnt 0))
13197 (save-excursion
13198 (goto-char (point-min))
13199 (if (or (not keep-previous) ; do not want to keep
13200 (not org-occur-highlights)) ; no previous matches
13201 ;; hide everything
13202 (org-overview))
13203 (while (re-search-forward regexp nil t)
13204 (when (or (not callback)
13205 (save-match-data (funcall callback)))
13206 (setq cnt (1+ cnt))
13207 (when org-highlight-sparse-tree-matches
13208 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13209 (org-show-context 'occur-tree))))
13210 (when org-remove-highlights-with-change
13211 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13212 nil 'local))
13213 (unless org-sparse-tree-open-archived-trees
13214 (org-hide-archived-subtrees (point-min) (point-max)))
13215 (run-hooks 'org-occur-hook)
13216 (if (org-called-interactively-p 'interactive)
13217 (message "%d match(es) for regexp %s" cnt regexp))
13218 cnt))
13220 (defun org-occur-next-match (&optional n reset)
13221 "Function for `next-error-function' to find sparse tree matches.
13222 N is the number of matches to move, when negative move backwards.
13223 RESET is entirely ignored - this function always goes back to the
13224 starting point when no match is found."
13225 (let* ((limit (if (< n 0) (point-min) (point-max)))
13226 (search-func (if (< n 0)
13227 'previous-single-char-property-change
13228 'next-single-char-property-change))
13229 (n (abs n))
13230 (pos (point))
13231 p1)
13232 (catch 'exit
13233 (while (setq p1 (funcall search-func (point) 'org-type))
13234 (when (equal p1 limit)
13235 (goto-char pos)
13236 (error "No more matches"))
13237 (when (equal (get-char-property p1 'org-type) 'org-occur)
13238 (setq n (1- n))
13239 (when (= n 0)
13240 (goto-char p1)
13241 (throw 'exit (point))))
13242 (goto-char p1))
13243 (goto-char p1)
13244 (error "No more matches"))))
13246 (defun org-show-context (&optional key)
13247 "Make sure point and context are visible.
13248 How much context is shown depends upon the variables
13249 `org-show-hierarchy-above', `org-show-following-heading',
13250 `org-show-entry-below' and `org-show-siblings'."
13251 (let ((heading-p (org-at-heading-p t))
13252 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13253 (following-p (org-get-alist-option org-show-following-heading key))
13254 (entry-p (org-get-alist-option org-show-entry-below key))
13255 (siblings-p (org-get-alist-option org-show-siblings key)))
13256 ;; Show heading or entry text
13257 (if (and heading-p (not entry-p))
13258 (org-flag-heading nil) ; only show the heading
13259 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13260 (org-show-hidden-entry))) ; show entire entry
13261 (when following-p
13262 ;; Show next sibling, or heading below text
13263 (save-excursion
13264 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13265 (org-flag-heading nil))))
13266 (when siblings-p (org-show-siblings))
13267 (when hierarchy-p
13268 ;; show all higher headings, possibly with siblings
13269 (save-excursion
13270 (while (and (condition-case nil
13271 (progn (org-up-heading-all 1) t)
13272 (error nil))
13273 (not (bobp)))
13274 (org-flag-heading nil)
13275 (when siblings-p (org-show-siblings)))))
13276 (org-fix-ellipsis-at-bol)))
13278 (defvar org-reveal-start-hook nil
13279 "Hook run before revealing a location.")
13281 (defun org-reveal (&optional siblings)
13282 "Show current entry, hierarchy above it, and the following headline.
13283 This can be used to show a consistent set of context around locations
13284 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13285 not t for the search context.
13287 With optional argument SIBLINGS, on each level of the hierarchy all
13288 siblings are shown. This repairs the tree structure to what it would
13289 look like when opened with hierarchical calls to `org-cycle'.
13291 go to the parent and show the
13292 entire tree."
13293 (interactive "P")
13294 (run-hooks 'org-reveal-start-hook)
13295 (let ((org-show-hierarchy-above t)
13296 (org-show-following-heading t)
13297 (org-show-siblings (if siblings t org-show-siblings)))
13298 (org-show-context nil))
13299 (when (equal siblings '(16))
13300 (save-excursion
13301 (when (org-up-heading-safe)
13302 (org-show-subtree)
13303 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13305 (defun org-highlight-new-match (beg end)
13306 "Highlight from BEG to END and mark the highlight is an occur headline."
13307 (let ((ov (make-overlay beg end)))
13308 (overlay-put ov 'face 'secondary-selection)
13309 (overlay-put ov 'org-type 'org-occur)
13310 (push ov org-occur-highlights)))
13312 (defun org-remove-occur-highlights (&optional beg end noremove)
13313 "Remove the occur highlights from the buffer.
13314 BEG and END are ignored. If NOREMOVE is nil, remove this function
13315 from the `before-change-functions' in the current buffer."
13316 (interactive)
13317 (unless org-inhibit-highlight-removal
13318 (mapc 'delete-overlay org-occur-highlights)
13319 (setq org-occur-highlights nil)
13320 (setq org-occur-parameters nil)
13321 (unless noremove
13322 (remove-hook 'before-change-functions
13323 'org-remove-occur-highlights 'local))))
13325 ;;;; Priorities
13328 "Regular expression matching the priority indicator.")
13330 (defvar org-remove-priority-next-time nil)
13332 (defun org-priority-up ()
13333 "Increase the priority of the current item."
13334 (interactive)
13335 (org-priority 'up))
13337 (defun org-priority-down ()
13338 "Decrease the priority of the current item."
13339 (interactive)
13340 (org-priority 'down))
13342 (defun org-priority (&optional action show)
13343 "Change the priority of an item.
13344 ACTION can be `set', `up', `down', or a character."
13345 (interactive "P")
13346 (if (equal action '(4))
13347 (org-show-priority)
13348 (unless org-enable-priority-commands
13349 (error "Priority commands are disabled"))
13350 (setq action (or action 'set))
13351 (let (current new news have remove)
13352 (save-excursion
13353 (org-back-to-heading t)
13354 (if (looking-at org-priority-regexp)
13355 (setq current (string-to-char (match-string 2))
13356 have t))
13357 (cond
13358 ((eq action 'remove)
13359 (setq remove t new ?\ ))
13360 ((or (eq action 'set)
13361 (if (featurep 'xemacs) (characterp action) (integerp action)))
13362 (if (not (eq action 'set))
13363 (setq new action)
13364 (message "Priority %c-%c, SPC to remove: "
13365 org-highest-priority org-lowest-priority)
13366 (save-match-data
13367 (setq new (read-char-exclusive))))
13368 (if (and (= (upcase org-highest-priority) org-highest-priority)
13369 (= (upcase org-lowest-priority) org-lowest-priority))
13370 (setq new (upcase new)))
13371 (cond ((equal new ?\ ) (setq remove t))
13372 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13373 (error "Priority must be between `%c' and `%c'"
13374 org-highest-priority org-lowest-priority))))
13375 ((eq action 'up)
13376 (setq new (if have
13377 (1- current) ; normal cycling
13378 ;; last priority was empty
13379 (if (eq last-command this-command)
13380 org-lowest-priority ; wrap around empty to lowest
13381 ;; default
13382 (if org-priority-start-cycle-with-default
13383 org-default-priority
13384 (1- org-default-priority))))))
13385 ((eq action 'down)
13386 (setq new (if have
13387 (1+ current) ; normal cycling
13388 ;; last priority was empty
13389 (if (eq last-command this-command)
13390 org-highest-priority ; wrap around empty to highest
13391 ;; default
13392 (if org-priority-start-cycle-with-default
13393 org-default-priority
13394 (1+ org-default-priority))))))
13395 (t (error "Invalid action")))
13396 (if (or (< (upcase new) org-highest-priority)
13397 (> (upcase new) org-lowest-priority))
13398 (if (and (memq action '(up down))
13399 (not have) (not (eq last-command this-command)))
13400 ;; `new' is from default priority
13401 (error
13402 "The default can not be set, see `org-default-priority' why")
13403 ;; normal cycling: `new' is beyond highest/lowest priority
13404 ;; and is wrapped around to the empty priority
13405 (setq remove t)))
13406 (setq news (format "%c" new))
13407 (if have
13408 (if remove
13409 (replace-match "" t t nil 1)
13410 (replace-match news t t nil 2))
13411 (if remove
13412 (error "No priority cookie found in line")
13413 (let ((case-fold-search nil))
13414 (looking-at org-todo-line-regexp))
13415 (if (match-end 2)
13416 (progn
13417 (goto-char (match-end 2))
13418 (insert " [#" news "]"))
13419 (goto-char (match-beginning 3))
13420 (insert "[#" news "] "))))
13421 (org-preserve-lc (org-set-tags nil 'align)))
13422 (if remove
13423 (message "Priority removed")
13424 (message "Priority of current item set to %s" news)))))
13426 (defun org-show-priority ()
13427 "Show the priority of the current item.
13428 This priority is composed of the main priority given with the [#A] cookies,
13429 and by additional input from the age of a schedules or deadline entry."
13430 (interactive)
13431 (let ((pri (if (eq major-mode 'org-agenda-mode)
13432 (org-get-at-bol 'priority)
13433 (save-excursion
13434 (save-match-data
13435 (beginning-of-line)
13436 (and (looking-at org-heading-regexp)
13437 (org-get-priority (match-string 0))))))))
13438 (message "Priority is %d" (if pri pri -1000))))
13440 (defun org-get-priority (s)
13441 "Find priority cookie and return priority."
13442 (save-match-data
13443 (if (functionp org-get-priority-function)
13444 (funcall org-get-priority-function)
13445 (if (not (string-match org-priority-regexp s))
13446 (* 1000 (- org-lowest-priority org-default-priority))
13447 (* 1000 (- org-lowest-priority
13448 (string-to-char (match-string 2 s))))))))
13450 ;;;; Tags
13452 (defvar org-agenda-archives-mode)
13453 (defvar org-map-continue-from nil
13454 "Position from where mapping should continue.
13455 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13457 (defvar org-scanner-tags nil
13458 "The current tag list while the tags scanner is running.")
13459 (defvar org-trust-scanner-tags nil
13460 "Should `org-get-tags-at' use the tags for the scanner.
13461 This is for internal dynamical scoping only.
13462 When this is non-nil, the function `org-get-tags-at' will return the value
13463 of `org-scanner-tags' instead of building the list by itself. This
13464 can lead to large speed-ups when the tags scanner is used in a file with
13465 many entries, and when the list of tags is retrieved, for example to
13466 obtain a list of properties. Building the tags list for each entry in such
13467 a file becomes an N^2 operation - but with this variable set, it scales
13468 as N.")
13470 (defun org-scan-tags (action matcher todo-only &optional start-level)
13471 "Sca headline tags with inheritance and produce output ACTION.
13473 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13474 or `agenda' to produce an entry list for an agenda view. It can also be
13475 a Lisp form or a function that should be called at each matched headline, in
13476 this case the return value is a list of all return values from these calls.
13478 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13479 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13480 only lines with a not-done TODO keyword are included in the output.
13481 This should be the same variable that was scoped into
13482 and set by `org-make-tags-matcher' when it constructed MATCHER.
13484 START-LEVEL can be a string with asterisks, reducing the scope to
13485 headlines matching this string."
13486 (require 'org-agenda)
13487 (let* ((re (concat "^"
13488 (if start-level
13489 ;; Get the correct level to match
13491 org-outline-regexp)
13495 (props (list 'face 'default
13496 'done-face 'org-agenda-done
13497 'undone-face 'default
13498 'mouse-face 'highlight
13499 'org-not-done-regexp org-not-done-regexp
13500 'org-todo-regexp org-todo-regexp
13501 'org-complex-heading-regexp org-complex-heading-regexp
13502 'help-echo
13503 (format "mouse-2 or RET jump to org file %s"
13504 (abbreviate-file-name
13505 (or (buffer-file-name (buffer-base-buffer))
13506 (buffer-name (buffer-base-buffer)))))))
13507 (case-fold-search nil)
13508 (org-map-continue-from nil)
13509 lspos tags tags-list
13510 (tags-alist (list (cons 0 org-file-tags)))
13511 (llast 0) rtn rtn1 level category i txt
13512 todo marker entry priority)
13513 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13514 (setq action (list 'lambda nil action)))
13515 (save-excursion
13516 (goto-char (point-min))
13517 (when (eq action 'sparse-tree)
13518 (org-overview)
13519 (org-remove-occur-highlights))
13520 (while (re-search-forward re nil t)
13521 (setq org-map-continue-from nil)
13522 (catch :skip
13523 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13524 tags (if (match-end 4) (org-match-string-no-properties 4)))
13525 (goto-char (setq lspos (match-beginning 0)))
13526 (setq level (org-reduced-level (org-outline-level))
13527 category (org-get-category))
13528 (setq i llast llast level)
13529 ;; remove tag lists from same and sublevels
13530 (while (>= i level)
13531 (when (setq entry (assoc i tags-alist))
13532 (setq tags-alist (delete entry tags-alist)))
13533 (setq i (1- i)))
13534 ;; add the next tags
13535 (when tags
13536 (setq tags (org-split-string tags ":")
13537 tags-alist
13538 (cons (cons level tags) tags-alist)))
13539 ;; compile tags for current headline
13540 (setq tags-list
13541 (if org-use-tag-inheritance
13542 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13543 tags)
13544 org-scanner-tags tags-list)
13545 (when org-use-tag-inheritance
13546 (setcdr (car tags-alist)
13547 (mapcar (lambda (x)
13548 (setq x (copy-sequence x))
13549 (org-add-prop-inherited x))
13550 (cdar tags-alist))))
13551 (when (and tags org-use-tag-inheritance
13552 (or (not (eq t org-use-tag-inheritance))
13553 org-tags-exclude-from-inheritance))
13554 ;; selective inheritance, remove uninherited ones
13555 (setcdr (car tags-alist)
13556 (org-remove-uninherited-tags (cdar tags-alist))))
13557 (when (and
13559 ;; eval matcher only when the todo condition is OK
13560 (and (or (not todo-only) (member todo org-not-done-keywords))
13561 (let ((case-fold-search t) (org-trust-scanner-tags t))
13562 (eval matcher)))
13564 ;; Call the skipper, but return t if it does not skip,
13565 ;; so that the `and' form continues evaluating
13566 (progn
13567 (unless (eq action 'sparse-tree) (org-agenda-skip))
13568 t)
13570 ;; Check if timestamps are deselecting this entry
13571 (or (not todo-only)
13572 (and (member todo org-not-done-keywords)
13573 (or (not org-agenda-tags-todo-honor-ignore-options)
13574 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13576 ;; select this headline
13577 (cond
13578 ((eq action 'sparse-tree)
13579 (and org-highlight-sparse-tree-matches
13580 (org-get-heading) (match-end 0)
13581 (org-highlight-new-match
13582 (match-beginning 1) (match-end 1)))
13583 (org-show-context 'tags-tree))
13584 ((eq action 'agenda)
13585 (setq txt (org-agenda-format-item
13586 ""
13587 (concat
13588 (if (eq org-tags-match-list-sublevels 'indented)
13589 (make-string (1- level) ?.) "")
13590 (org-get-heading))
13591 level category
13592 tags-list)
13593 priority (org-get-priority txt))
13594 (goto-char lspos)
13595 (setq marker (org-agenda-new-marker))
13596 (org-add-props txt props
13597 'org-marker marker 'org-hd-marker marker 'org-category category
13598 'todo-state todo
13599 'priority priority 'type "tagsmatch")
13600 (push txt rtn))
13601 ((functionp action)
13602 (setq org-map-continue-from nil)
13603 (save-excursion
13604 (setq rtn1 (funcall action))
13605 (push rtn1 rtn)))
13606 (t (error "Invalid action")))
13608 ;; if we are to skip sublevels, jump to end of subtree
13609 (unless org-tags-match-list-sublevels
13610 (org-end-of-subtree t)
13611 (backward-char 1))))
13612 ;; Get the correct position from where to continue
13613 (if org-map-continue-from
13614 (goto-char org-map-continue-from)
13615 (and (= (point) lspos) (end-of-line 1)))))
13616 (when (and (eq action 'sparse-tree)
13617 (not org-sparse-tree-open-archived-trees))
13618 (org-hide-archived-subtrees (point-min) (point-max)))
13619 (nreverse rtn)))
13621 (defun org-remove-uninherited-tags (tags)
13622 "Remove all tags that are not inherited from the list TAGS."
13623 (cond
13624 ((eq org-use-tag-inheritance t)
13625 (if org-tags-exclude-from-inheritance
13626 (org-delete-all org-tags-exclude-from-inheritance tags)
13627 tags))
13628 ((not org-use-tag-inheritance) nil)
13629 ((stringp org-use-tag-inheritance)
13630 (delq nil (mapcar
13631 (lambda (x)
13632 (if (and (string-match org-use-tag-inheritance x)
13633 (not (member x org-tags-exclude-from-inheritance)))
13634 x nil))
13635 tags)))
13636 ((listp org-use-tag-inheritance)
13637 (delq nil (mapcar
13638 (lambda (x)
13639 (if (member x org-use-tag-inheritance) x nil))
13640 tags)))))
13642 (defun org-match-sparse-tree (&optional todo-only match)
13643 "Create a sparse tree according to tags string MATCH.
13644 MATCH can contain positive and negative selection of tags, like
13646 If optional argument TODO-ONLY is non-nil, only select lines that are
13647 also TODO lines."
13648 (interactive "P")
13649 (org-agenda-prepare-buffers (list (current-buffer)))
13650 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13652 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13654 (defvar org-cached-props nil)
13655 (defun org-cached-entry-get (pom property)
13656 (if (or (eq t org-use-property-inheritance)
13657 (and (stringp org-use-property-inheritance)
13658 (string-match org-use-property-inheritance property))
13659 (and (listp org-use-property-inheritance)
13660 (member property org-use-property-inheritance)))
13661 ;; Caching is not possible, check it directly
13662 (org-entry-get pom property 'inherit)
13663 ;; Get all properties, so that we can do complicated checks easily
13664 (cdr (assoc property (or org-cached-props
13665 (setq org-cached-props
13666 (org-entry-properties pom)))))))
13668 (defun org-global-tags-completion-table (&optional files)
13669 "Return the list of all tags in all agenda buffer/files.
13670 Optional FILES argument is a list of files which can be used
13671 instead of the agenda files."
13672 (save-excursion
13673 (org-uniquify
13674 (delq nil
13675 (apply 'append
13676 (mapcar
13677 (lambda (file)
13678 (set-buffer (find-file-noselect file))
13679 (append (org-get-buffer-tags)
13680 (mapcar (lambda (x) (if (stringp (car-safe x))
13681 (list (car-safe x)) nil))
13682 org-tag-alist)))
13683 (if (and files (car files))
13684 files
13685 (org-agenda-files))))))))
13687 (defun org-make-tags-matcher (match)
13688 "Create the TAGS/TODO matcher form for the selection string MATCH.
13690 The variable `todo-only' is scoped dynamically into this function.
13691 It will be set to t if the matcher restricts matching to TODO entries,
13692 otherwise will not be touched.
13694 Returns a cons of the selection string MATCH and the constructed
13695 lisp form implementing the matcher. The matcher is to be evaluated
13696 at an Org entry, with point on the headline, and returns t if the
13697 entry matches the selection string MATCH. The returned lisp form
13698 references two variables with information about the entry, which
13699 must be bound around the form's evaluation: todo, the TODO keyword
13700 at the entry (or nil of none); and tags-list, the list of all tags
13701 at the entry including inherited ones. Additionally, the category
13702 of the entry (if any) must be specified as the text property
13703 'org-category on the headline.
13705 See also `org-scan-tags'.
13706 "
13707 (declare (special todo-only))
13708 (unless (boundp 'todo-only)
13709 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13710 (unless match
13711 ;; Get a new match request, with completion
13712 (let ((org-last-tags-completion-table
13713 (org-global-tags-completion-table)))
13714 (setq match (org-completing-read-no-i
13715 "Match: " 'org-tags-completion-function nil nil nil
13716 'org-tags-history))))
13718 ;; Parse the string and create a lisp form
13719 (let ((match0 match)
13720 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13721 minus tag mm
13722 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13723 orterms term orlist re-p str-p level-p level-op time-p
13724 prop-p pn pv po gv rest)
13725 (if (string-match "/+" match)
13726 ;; match contains also a todo-matching request
13727 (progn
13728 (setq tagsmatch (substring match 0 (match-beginning 0))
13729 todomatch (substring match (match-end 0)))
13730 (if (string-match "^!" todomatch)
13731 (setq todo-only t todomatch (substring todomatch 1)))
13733 (setq todomatch nil)))
13734 ;; only matching tags
13735 (setq tagsmatch match todomatch nil))
13737 ;; Make the tags matcher
13739 (setq tagsmatcher t)
13740 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13741 (while (setq term (pop orterms))
13743 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13744 (while (string-match re term)
13745 (setq rest (substring term (match-end 0))
13746 minus (and (match-end 1)
13747 (equal (match-string 1 term) "-"))
13748 tag (save-match-data (replace-regexp-in-string
13750 (match-string 2 term)))
13751 re-p (equal (string-to-char tag) ?{)
13752 level-p (match-end 4)
13753 prop-p (match-end 5)
13754 mm (cond
13755 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13756 (level-p
13757 (setq level-op (org-op-to-function (match-string 3 term)))
13758 `(,level-op level ,(string-to-number
13759 (match-string 4 term))))
13760 (prop-p
13761 (setq pn (match-string 5 term)
13762 po (match-string 6 term)
13763 pv (match-string 7 term)
13764 re-p (equal (string-to-char pv) ?{)
13766 time-p (save-match-data
13768 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13769 (if time-p (setq pv (org-matcher-time pv)))
13770 (setq po (org-op-to-function po (if time-p 'time str-p)))
13771 (cond
13772 ((equal pn "CATEGORY")
13773 (setq gv '(get-text-property (point) 'org-category)))
13774 ((equal pn "TODO")
13775 (setq gv 'todo))
13776 (t
13777 (setq gv `(org-cached-entry-get nil ,pn))))
13778 (if re-p
13779 (if (eq po 'org<>)
13780 `(not (string-match ,pv (or ,gv "")))
13781 `(string-match ,pv (or ,gv "")))
13782 (if str-p
13783 `(,po (or ,gv "") ,pv)
13784 `(,po (string-to-number (or ,gv ""))
13785 ,(string-to-number pv) ))))
13786 (t `(member ,tag tags-list)))
13787 mm (if minus (list 'not mm) mm)
13788 term rest)
13789 (push mm tagsmatcher))
13790 (push (if (> (length tagsmatcher) 1)
13791 (cons 'and tagsmatcher)
13792 (car tagsmatcher))
13793 orlist)
13794 (setq tagsmatcher nil))
13795 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13796 (setq tagsmatcher
13797 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13798 ;; Make the todo matcher
13800 (setq todomatcher t)
13801 (setq orterms (org-split-string todomatch "|") orlist nil)
13802 (while (setq term (pop orterms))
13803 (while (string-match re term)
13804 (setq minus (and (match-end 1)
13805 (equal (match-string 1 term) "-"))
13806 kwd (match-string 2 term)
13807 re-p (equal (string-to-char kwd) ?{)
13808 term (substring term (match-end 0))
13809 mm (if re-p
13810 `(string-match ,(substring kwd 1 -1) todo)
13811 (list 'equal 'todo kwd))
13812 mm (if minus (list 'not mm) mm))
13813 (push mm todomatcher))
13814 (push (if (> (length todomatcher) 1)
13815 (cons 'and todomatcher)
13816 (car todomatcher))
13817 orlist)
13818 (setq todomatcher nil))
13819 (setq todomatcher (if (> (length orlist) 1)
13820 (cons 'or orlist) (car orlist))))
13822 ;; Return the string and lisp forms of the matcher
13823 (setq matcher (if todomatcher
13824 (list 'and tagsmatcher todomatcher)
13825 tagsmatcher))
13826 (when todo-only
13827 (setq matcher (list 'and '(member todo org-not-done-keywords)
13828 matcher)))
13829 (cons match0 matcher)))
13831 (defun org-op-to-function (op &optional stringp)
13832 "Turn an operator into the appropriate function."
13833 (setq op
13834 (cond
13835 ((equal op "<" ) '(< string< org-time<))
13836 ((equal op ">" ) '(> org-string> org-time>))
13837 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13838 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13839 ((member op '("=" "==")) '(= string= org-time=))
13840 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13841 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13843 (defun org<> (a b) (not (= a b)))
13844 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13845 (defun org-string>= (a b) (not (string< a b)))
13846 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13847 (defun org-string<> (a b) (not (string= a b)))
13848 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13849 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13850 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13851 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13852 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13853 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13854 (defun org-2ft (s)
13855 "Convert S to a floating point time.
13856 If S is already a number, just return it. If it is a string, parse
13857 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13858 (cond
13859 ((numberp s) s)
13860 ((stringp s)
13861 (condition-case nil
13862 (float-time (apply 'encode-time (org-parse-time-string s)))
13863 (error 0.)))
13864 (t 0.)))
13866 (defun org-time-today ()
13867 "Time in seconds today at 0:00.
13868 Returns the float number of seconds since the beginning of the
13869 epoch to the beginning of today (00:00)."
13870 (float-time (apply 'encode-time
13871 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13873 (defun org-matcher-time (s)
13874 "Interpret a time comparison value."
13875 (save-match-data
13876 (cond
13877 ((string= s "<now>") (float-time))
13878 ((string= s "<today>") (org-time-today))
13879 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13880 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13882 (+ (org-time-today)
13883 (* (string-to-number (match-string 1 s))
13884 (cdr (assoc (match-string 2 s)
13885 '(("d" . 86400.0) ("w" . 604800.0)
13886 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13887 (t (org-2ft s)))))
13889 (defun org-match-any-p (re list)
13890 "Does re match any element of list?"
13891 (setq list (mapcar (lambda (x) (string-match re x)) list))
13892 (delq nil list))
13894 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13895 (defvar org-tags-overlay (make-overlay 1 1))
13896 (org-detach-overlay org-tags-overlay)
13898 (defun org-get-local-tags-at (&optional pos)
13899 "Get a list of tags defined in the current headline."
13900 (org-get-tags-at pos 'local))
13902 (defun org-get-local-tags ()
13903 "Get a list of tags defined in the current headline."
13904 (org-get-tags-at nil 'local))
13906 (defun org-get-tags-at (&optional pos local)
13907 "Get a list of all headline tags applicable at POS.
13908 POS defaults to point. If tags are inherited, the list contains
13909 the targets in the same sequence as the headlines appear, i.e.
13910 the tags of the current headline come last.
13911 When LOCAL is non-nil, only return tags from the current headline,
13912 ignore inherited ones."
13913 (interactive)
13914 (if (and org-trust-scanner-tags
13915 (or (not pos) (equal pos (point)))
13916 (not local))
13917 org-scanner-tags
13918 (let (tags ltags lastpos parent)
13919 (save-excursion
13920 (save-restriction
13921 (widen)
13922 (goto-char (or pos (point)))
13923 (save-match-data
13924 (catch 'done
13925 (condition-case nil
13926 (progn
13927 (org-back-to-heading t)
13928 (while (not (equal lastpos (point)))
13929 (setq lastpos (point))
13930 (when (looking-at
13932 (setq ltags (org-split-string
13933 (org-match-string-no-properties 1) ":"))
13934 (when parent
13935 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13936 (setq tags (append
13937 (if parent
13938 (org-remove-uninherited-tags ltags)
13939 ltags)
13940 tags)))
13941 (or org-use-tag-inheritance (throw 'done t))
13942 (if local (throw 'done t))
13943 (or (org-up-heading-safe) (error nil))
13944 (setq parent t)))
13945 (error nil)))))
13946 (if local
13947 tags
13948 (reverse (delete-dups
13949 (reverse (append
13950 (org-remove-uninherited-tags
13951 org-file-tags) tags)))))))))
13953 (defun org-add-prop-inherited (s)
13954 (add-text-properties 0 (length s) '(inherited t) s)
13955 s)
13957 (defun org-toggle-tag (tag &optional onoff)
13958 "Toggle the tag TAG for the current line.
13959 If ONOFF is `on' or `off', don't toggle but set to this state."
13960 (let (res current)
13961 (save-excursion
13962 (org-back-to-heading t)
13964 (point-at-eol) t)
13965 (progn
13966 (setq current (match-string 1))
13967 (replace-match ""))
13968 (setq current ""))
13969 (setq current (nreverse (org-split-string current ":")))
13970 (cond
13971 ((eq onoff 'on)
13972 (setq res t)
13973 (or (member tag current) (push tag current)))
13974 ((eq onoff 'off)
13975 (or (not (member tag current)) (setq current (delete tag current))))
13976 (t (if (member tag current)
13977 (setq current (delete tag current))
13978 (setq res t)
13979 (push tag current))))
13980 (end-of-line 1)
13981 (if current
13982 (progn
13983 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13984 (org-set-tags nil t))
13985 (delete-horizontal-space))
13986 (run-hooks 'org-after-tags-change-hook))
13987 res))
13989 (defun org-align-tags-here (to-col)
13990 ;; Assumes that this is a headline
13991 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13992 (beginning-of-line 1)
13994 (< pos (match-beginning 2)))
13995 (progn
13996 (setq tags-l (- (match-end 2) (match-beginning 2)))
13997 (goto-char (match-beginning 1))
13998 (insert " ")
13999 (delete-region (point) (1+ (match-beginning 2)))
14000 (setq ncol (max (current-column)
14001 (1+ col)
14002 (if (> to-col 0)
14003 to-col
14004 (- (abs to-col) tags-l))))
14005 (setq p (point))
14006 (insert (make-string (- ncol (current-column)) ?\ ))
14007 (setq ncol (current-column))
14008 (when indent-tabs-mode (tabify p (point-at-eol)))
14009 (org-move-to-column (min ncol col) t))
14010 (goto-char pos))))
14012 (defun org-set-tags-command (&optional arg just-align)
14013 "Call the set-tags command for the current entry."
14014 (interactive "P")
14015 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14016 (org-set-tags arg just-align)
14017 (save-excursion
14018 (unless (and (org-region-active-p)
14019 org-loop-over-headlines-in-active-region)
14020 (org-back-to-heading t))
14021 (org-set-tags arg just-align))))
14023 (defun org-set-tags-to (data)
14024 "Set the tags of the current entry to DATA, replacing the current tags.
14025 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14026 If DATA is nil or the empty string, any tags will be removed."
14027 (interactive "sTags: ")
14028 (setq data
14029 (cond
14030 ((eq data nil) "")
14031 ((equal data "") "")
14032 ((stringp data)
14033 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14034 ":"))
14035 ((listp data)
14036 (concat ":" (mapconcat 'identity data ":") ":"))))
14037 (when data
14038 (save-excursion
14039 (org-back-to-heading t)
14040 (when (looking-at org-complex-heading-regexp)
14041 (if (match-end 5)
14042 (progn
14043 (goto-char (match-beginning 5))
14044 (insert data)
14045 (delete-region (point) (point-at-eol))
14046 (org-set-tags nil 'align))
14047 (goto-char (point-at-eol))
14048 (insert " " data)
14049 (org-set-tags nil 'align)))
14050 (beginning-of-line 1)
14052 (delete-region (match-beginning 1) (match-end 1))))))
14054 (defun org-align-all-tags ()
14055 "Align the tags i all headings."
14056 (interactive)
14057 (save-excursion
14058 (or (ignore-errors (org-back-to-heading t))
14059 (outline-next-heading))
14060 (if (org-at-heading-p)
14061 (org-set-tags t)
14062 (message "No headings"))))
14064 (defvar org-indent-indentation-per-level)
14065 (defun org-set-tags (&optional arg just-align)
14066 "Set the tags for the current headline.
14067 With prefix ARG, realign all tags in headings in the current buffer."
14068 (interactive "P")
14069 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14070 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14071 'region-start-level 'region))
14072 org-loop-over-headlines-in-active-region)
14073 (org-map-entries
14074 ;; We don't use ARG and JUST-ALIGN here these args are not
14075 ;; useful when looping over headlines
14076 `(org-set-tags)
14077 org-loop-over-headlines-in-active-region
14078 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14079 (let* ((re org-outline-regexp-bol)
14080 (current (unless arg (org-get-tags-string)))
14081 (col (current-column))
14082 (org-setting-tags t)
14083 table current-tags inherited-tags ; computed below when needed
14084 tags p0 c0 c1 rpl di tc level)
14085 (if arg
14086 (save-excursion
14087 (goto-char (point-min))
14088 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14089 (while (re-search-forward re nil t)
14090 (org-set-tags nil t)
14091 (end-of-line 1)))
14092 (message "All tags realigned to column %d" org-tags-column))
14093 (if just-align
14094 (setq tags current)
14095 ;; Get a new set of tags from the user
14096 (save-excursion
14097 (setq table (append org-tag-persistent-alist
14098 (or org-tag-alist (org-get-buffer-tags))
14099 (and
14100 org-complete-tags-always-offer-all-agenda-tags
14101 (org-global-tags-completion-table
14102 (org-agenda-files))))
14103 org-last-tags-completion-table table
14104 current-tags (org-split-string current ":")
14105 inherited-tags (nreverse
14106 (nthcdr (length current-tags)
14107 (nreverse (org-get-tags-at))))
14108 tags
14109 (if (or (eq t org-use-fast-tag-selection)
14110 (and org-use-fast-tag-selection
14111 (delq nil (mapcar 'cdr table))))
14112 (org-fast-tag-selection
14113 current-tags inherited-tags table
14114 (if org-fast-tag-selection-include-todo
14115 org-todo-key-alist))
14116 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14117 (org-trim
14118 (org-icompleting-read "Tags: "
14119 'org-tags-completion-function
14120 nil nil current 'org-tags-history))))))
14121 (while (string-match "[-+&]+" tags)
14122 ;; No boolean logic, just a list
14123 (setq tags (replace-match ":" t t tags))))
14125 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14127 (if org-tags-sort-function
14128 (setq tags (mapconcat 'identity
14129 (sort (org-split-string
14130 tags (org-re "[^[:alnum:]_@#%]+"))
14131 org-tags-sort-function) ":")))
14134 (setq tags "")
14135 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14136 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14138 ;; Insert new tags at the correct column
14139 (beginning-of-line 1)
14140 (setq level (or (and (looking-at org-outline-regexp)
14141 (- (match-end 0) (point) 1))
14142 1))
14143 (cond
14144 ((and (equal current "") (equal tags "")))
14145 ((re-search-forward
14147 (point-at-eol) t)
14148 (if (equal tags "")
14149 (setq rpl "")
14150 (goto-char (match-beginning 0))
14151 (setq c0 (current-column)
14152 ;; compute offset for the case of org-indent-mode active
14153 di (if org-indent-mode
14154 (* (1- org-indent-indentation-per-level) (1- level))
14155 0)
14156 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14157 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14158 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14159 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14160 (replace-match rpl t t)
14161 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14162 tags)
14163 (t (error "Tags alignment failed")))
14164 (org-move-to-column col)
14165 (unless just-align
14166 (run-hooks 'org-after-tags-change-hook))))))
14168 (defun org-change-tag-in-region (beg end tag off)
14169 "Add or remove TAG for each entry in the region.
14170 This works in the agenda, and also in an org-mode buffer."
14171 (interactive
14172 (list (region-beginning) (region-end)
14173 (let ((org-last-tags-completion-table
14174 (if (derived-mode-p 'org-mode)
14175 (org-get-buffer-tags)
14176 (org-global-tags-completion-table))))
14177 (org-icompleting-read
14178 "Tag: " 'org-tags-completion-function nil nil nil
14179 'org-tags-history))
14180 (progn
14182 (equal (read-char-exclusive) ?r))))
14183 (if (fboundp 'deactivate-mark) (deactivate-mark))
14184 (let ((agendap (equal major-mode 'org-agenda-mode))
14185 l1 l2 m buf pos newhead (cnt 0))
14186 (goto-char end)
14187 (setq l2 (1- (org-current-line)))
14188 (goto-char beg)
14189 (setq l1 (org-current-line))
14190 (loop for l from l1 to l2 do
14191 (org-goto-line l)
14192 (setq m (get-text-property (point) 'org-hd-marker))
14193 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14194 (and agendap m))
14195 (setq buf (if agendap (marker-buffer m) (current-buffer))
14196 pos (if agendap m (point)))
14197 (with-current-buffer buf
14198 (save-excursion
14199 (save-restriction
14200 (goto-char pos)
14201 (setq cnt (1+ cnt))
14202 (org-toggle-tag tag (if off 'off 'on))
14203 (setq newhead (org-get-heading)))))
14204 (and agendap (org-agenda-change-all-lines newhead m))))
14205 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14207 (defun org-tags-completion-function (string predicate &optional flag)
14208 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14209 (confirm (lambda (x) (stringp (car x)))))
14211 (setq s1 (match-string 1 string)
14212 s2 (match-string 2 string))
14213 (setq s1 "" s2 string))
14214 (cond
14215 ((eq flag nil)
14216 ;; try completion
14217 (setq rtn (try-completion s2 ctable confirm))
14218 (if (stringp rtn)
14219 (setq rtn
14220 (concat s1 s2 (substring rtn (length s2))
14221 (if (and org-add-colon-after-tag-completion
14222 (assoc rtn ctable))
14223 ":" ""))))
14224 rtn)
14225 ((eq flag t)
14226 ;; all-completions
14227 (all-completions s2 ctable confirm)
14228 )
14229 ((eq flag 'lambda)
14230 ;; exact match?
14231 (assoc s2 ctable)))
14232 ))
14234 (defun org-fast-tag-insert (kwd tags face &optional end)
14235 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
14236 (insert (format "%-12s" (concat kwd ":"))
14237 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14238 (or end "")))
14240 (defun org-fast-tag-show-exit (flag)
14241 (save-excursion
14242 (org-goto-line 3)
14244 (replace-match ""))
14245 (when flag
14246 (end-of-line 1)
14247 (org-move-to-column (- (window-width) 19) t)
14248 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14250 (defun org-set-current-tags-overlay (current prefix)
14251 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14252 (if (featurep 'xemacs)
14253 (org-overlay-display org-tags-overlay (concat prefix s)
14254 'secondary-selection)
14255 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14256 (org-overlay-display org-tags-overlay (concat prefix s)))))
14258 (defvar org-last-tag-selection-key nil)
14259 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14260 "Fast tag selection with single keys.
14261 CURRENT is the current list of tags in the headline, INHERITED is the
14262 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14263 possibly with grouping information. TODO-TABLE is a similar table with
14264 TODO keywords, should these have keys assigned to them.
14265 If the keys are nil, a-z are automatically assigned.
14266 Returns the new tags string, or nil to not change the current settings."
14267 (let* ((fulltable (append table todo-table))
14268 (maxlen (apply 'max (mapcar
14269 (lambda (x)
14270 (if (stringp (car x)) (string-width (car x)) 0))
14271 fulltable)))
14272 (buf (current-buffer))
14273 (expert (eq org-fast-tag-selection-single-key 'expert))
14274 (buffer-tags nil)
14275 (fwidth (+ maxlen 3 1 3))
14276 (ncol (/ (- (window-width) 4) fwidth))
14277 (i-face 'org-done)
14278 (c-face 'org-todo)
14279 tg cnt e c char c1 c2 ntable tbl rtn
14280 ov-start ov-end ov-prefix
14281 (exit-after-next org-fast-tag-selection-single-key)
14282 (done-keywords org-done-keywords)
14283 groups ingroup)
14284 (save-excursion
14285 (beginning-of-line 1)
14286 (if (looking-at
14288 (setq ov-start (match-beginning 1)
14289 ov-end (match-end 1)
14290 ov-prefix "")
14291 (setq ov-start (1- (point-at-eol))
14292 ov-end (1+ ov-start))
14294 (setq ov-prefix
14295 (concat
14296 (buffer-substring (1- (point)) (point))
14297 (if (> (current-column) org-tags-column)
14298 " "
14299 (make-string (- org-tags-column (current-column)) ?\ ))))))
14300 (move-overlay org-tags-overlay ov-start ov-end)
14301 (save-window-excursion
14302 (if expert
14303 (set-buffer (get-buffer-create " *Org tags*"))
14304 (delete-other-windows)
14305 (split-window-vertically)
14306 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14307 (erase-buffer)
14308 (org-set-local 'org-done-keywords done-keywords)
14311 (org-fast-tag-show-exit exit-after-next)
14312 (org-set-current-tags-overlay current ov-prefix)
14313 (setq tbl fulltable char ?a cnt 0)
14314 (while (setq e (pop tbl))
14315 (cond
14316 ((equal (car e) :startgroup)
14317 (push '() groups) (setq ingroup t)
14318 (when (not (= cnt 0))
14319 (setq cnt 0)
14321 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14322 ((equal (car e) :endgroup)
14323 (setq ingroup nil cnt 0)
14325 ((equal e '(:newline))
14326 (when (not (= cnt 0))
14327 (setq cnt 0)
14329 (setq e (car tbl))
14330 (while (equal (car tbl) '(:newline))
14332 (setq tbl (cdr tbl)))))
14333 (t
14334 (setq tg (copy-sequence (car e)) c2 nil)
14335 (if (cdr e)
14336 (setq c (cdr e))
14337 ;; automatically assign a character.
14338 (setq c1 (string-to-char
14339 (downcase (substring
14340 tg (if (= (string-to-char tg) ?@) 1 0)))))
14341 (if (or (rassoc c1 ntable) (rassoc c1 table))
14342 (while (or (rassoc char ntable) (rassoc char table))
14343 (setq char (1+ char)))
14344 (setq c2 c1))
14345 (setq c (or c2 char)))
14346 (if ingroup (push tg (car groups)))
14347 (setq tg (org-add-props tg nil 'face
14348 (cond
14349 ((not (assoc tg table))
14350 (org-get-todo-face tg))
14351 ((member tg current) c-face)
14352 ((member tg inherited) i-face))))
14353 (if (and (= cnt 0) (not ingroup)) (insert " "))
14354 (insert "[" c "] " tg (make-string
14355 (- fwidth 4 (length tg)) ?\ ))
14356 (push (cons tg c) ntable)
14357 (when (= (setq cnt (1+ cnt)) ncol)
14359 (if ingroup (insert " "))
14360 (setq cnt 0)))))
14361 (setq ntable (nreverse ntable))
14363 (goto-char (point-min))
14364 (if (not expert) (org-fit-window-to-buffer))
14365 (setq rtn
14366 (catch 'exit
14367 (while t
14368 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14369 (if (not groups) "no " "")
14370 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14371 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14372 (setq org-last-tag-selection-key c)
14373 (cond
14375 ((= c ?!)
14376 (setq groups (not groups))
14377 (goto-char (point-min))
14378 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14379 ((= c ?\C-c)
14380 (if (not expert)
14381 (org-fast-tag-show-exit
14382 (setq exit-after-next (not exit-after-next)))
14383 (setq expert nil)
14384 (delete-other-windows)
14385 (set-window-buffer (split-window-vertically) " *Org tags*")
14386 (org-switch-to-buffer-other-window " *Org tags*")
14387 (org-fit-window-to-buffer)))
14388 ((or (= c ?\C-g)
14389 (and (= c ?q) (not (rassoc c ntable))))
14390 (org-detach-overlay org-tags-overlay)
14391 (setq quit-flag t))
14392 ((= c ?\ )
14393 (setq current nil)
14394 (if exit-after-next (setq exit-after-next 'now)))
14396 (condition-case nil
14397 (setq tg (org-icompleting-read
14398 "Tag: "
14399 (or buffer-tags
14400 (with-current-buffer buf
14401 (org-get-buffer-tags)))))
14402 (quit (setq tg "")))
14404 (add-to-list 'buffer-tags (list tg))
14405 (if (member tg current)
14406 (setq current (delete tg current))
14407 (push tg current)))
14408 (if exit-after-next (setq exit-after-next 'now)))
14409 ((setq e (rassoc c todo-table) tg (car e))
14410 (with-current-buffer buf
14411 (save-excursion (org-todo tg)))
14412 (if exit-after-next (setq exit-after-next 'now)))
14413 ((setq e (rassoc c ntable) tg (car e))
14414 (if (member tg current)
14415 (setq current (delete tg current))
14416 (loop for g in groups do
14417 (if (member tg g)
14418 (mapc (lambda (x)
14419 (setq current (delete x current)))
14420 g)))
14421 (push tg current))
14422 (if exit-after-next (setq exit-after-next 'now))))
14424 ;; Create a sorted list
14425 (setq current
14426 (sort current
14427 (lambda (a b)
14428 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14429 (if (eq exit-after-next 'now) (throw 'exit t))
14430 (goto-char (point-min))
14431 (beginning-of-line 2)
14432 (delete-region (point) (point-at-eol))
14433 (org-fast-tag-insert "Current" current c-face)
14434 (org-set-current-tags-overlay current ov-prefix)
14435 (while (re-search-forward
14437 (setq tg (match-string 1))
14438 (add-text-properties
14439 (match-beginning 1) (match-end 1)
14440 (list 'face
14441 (cond
14442 ((member tg current) c-face)
14443 ((member tg inherited) i-face)
14444 (t (get-text-property (match-beginning 1) 'face))))))
14445 (goto-char (point-min)))))
14446 (org-detach-overlay org-tags-overlay)
14447 (if rtn
14448 (mapconcat 'identity current ":")
14449 nil))))
14451 (defun org-get-tags-string ()
14452 "Get the TAGS string in the current headline."
14453 (unless (org-at-heading-p t)
14454 (error "Not on a heading"))
14455 (save-excursion
14456 (beginning-of-line 1)
14458 (org-match-string-no-properties 1)
14459 "")))
14461 (defun org-get-tags ()
14462 "Get the list of tags specified in the current headline."
14463 (org-split-string (org-get-tags-string) ":"))
14465 (defun org-get-buffer-tags ()
14466 "Get a table of all tags used in the buffer, for completion."
14467 (let (tags)
14468 (save-excursion
14469 (goto-char (point-min))
14470 (while (re-search-forward
14472 (when (equal (char-after (point-at-bol 0)) ?*)
14473 (mapc (lambda (x) (add-to-list 'tags x))
14474 (org-split-string (org-match-string-no-properties 1) ":")))))
14475 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14476 (mapcar 'list tags)))
14478 ;;;; The mapping API
14480 (defun org-map-entries (func &optional match scope &rest skip)
14481 "Call FUNC at each headline selected by MATCH in SCOPE.
14483 FUNC is a function or a lisp form. The function will be called without
14484 arguments, with the cursor positioned at the beginning of the headline.
14485 The return values of all calls to the function will be collected and
14486 returned as a list.
14488 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14489 does not need to preserve point. After evaluation, the cursor will be
14490 moved to the end of the line (presumably of the headline of the
14491 processed entry) and search continues from there. Under some
14492 circumstances, this may not produce the wanted results. For example,
14493 if you have removed (e.g. archived) the current (sub)tree it could
14494 mean that the next entry will be skipped entirely. In such cases, you
14495 can specify the position from where search should continue by making
14496 FUNC set the variable `org-map-continue-from' to the desired buffer
14497 position.
14499 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14500 Only headlines that are matched by this query will be considered during
14501 the iteration. When MATCH is nil or t, all headlines will be
14502 visited by the iteration.
14504 SCOPE determines the scope of this command. It can be any of:
14506 nil The current buffer, respecting the restriction if any
14507 tree The subtree started with the entry at point
14508 region The entries within the active region, if any
14509 region-start-level
14510 The entries within the active region, but only those at
14511 the same level than the first one.
14512 file The current buffer, without restriction
14513 file-with-archives
14514 The current buffer, and any archives associated with it
14515 agenda All agenda files
14516 agenda-with-archives
14517 All agenda files with any archive files associated with them
14518 \(file1 file2 ...)
14519 If this is a list, all files in the list will be scanned
14521 The remaining args are treated as settings for the skipping facilities of
14522 the scanner. The following items can be given here:
14524 archive skip trees with the archive tag
14525 comment skip trees with the COMMENT keyword
14526 function or Emacs Lisp form:
14527 will be used as value for `org-agenda-skip-function', so
14528 whenever the function returns a position, FUNC will not be
14529 called for that entry and search will continue from the
14530 position returned
14532 If your function needs to retrieve the tags including inherited tags
14533 at the *current* entry, you can use the value of the variable
14534 `org-scanner-tags' which will be much faster than getting the value
14535 with `org-get-tags-at'. If your function gets properties with
14536 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14537 to t around the call to `org-entry-properties' to get the same speedup.
14538 Note that if your function moves around to retrieve tags and properties at
14539 a *different* entry, you cannot use these techniques."
14540 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14541 (not (org-region-active-p)))
14542 (let* ((org-agenda-archives-mode nil) ; just to make sure
14543 (org-agenda-skip-archived-trees (memq 'archive skip))
14544 (org-agenda-skip-comment-trees (memq 'comment skip))
14545 (org-agenda-skip-function
14546 (car (org-delete-all '(comment archive) skip)))
14547 (org-tags-match-list-sublevels t)
14548 (start-level (eq scope 'region-start-level))
14549 matcher file res
14550 org-todo-keywords-for-agenda
14551 org-done-keywords-for-agenda
14552 org-todo-keyword-alist-for-agenda
14553 org-drawers-for-agenda
14554 org-tag-alist-for-agenda
14555 todo-only)
14557 (cond
14558 ((eq match t) (setq matcher t))
14559 ((eq match nil) (setq matcher t))
14560 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14562 (save-excursion
14563 (save-restriction
14564 (cond ((eq scope 'tree)
14565 (org-back-to-heading t)
14566 (org-narrow-to-subtree)
14567 (setq scope nil))
14568 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14569 (org-region-active-p))
14570 ;; If needed, set start-level to a string like "2"
14571 (when start-level
14572 (save-excursion
14573 (goto-char (region-beginning))
14574 (unless (org-at-heading-p) (outline-next-heading))
14575 (setq start-level (org-current-level))))
14576 (narrow-to-region (region-beginning)
14577 (save-excursion
14578 (goto-char (region-end))
14579 (unless (and (bolp) (org-at-heading-p))
14580 (outline-next-heading))
14581 (point)))
14582 (setq scope nil)))
14584 (if (not scope)
14585 (progn
14586 (org-agenda-prepare-buffers
14587 (list (buffer-file-name (current-buffer))))
14588 (setq res (org-scan-tags func matcher todo-only start-level)))
14589 ;; Get the right scope
14590 (cond
14591 ((and scope (listp scope) (symbolp (car scope)))
14592 (setq scope (eval scope)))
14593 ((eq scope 'agenda)
14594 (setq scope (org-agenda-files t)))
14595 ((eq scope 'agenda-with-archives)
14596 (setq scope (org-agenda-files t))
14597 (setq scope (org-add-archive-files scope)))
14598 ((eq scope 'file)
14599 (setq scope (list (buffer-file-name))))
14600 ((eq scope 'file-with-archives)
14601 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14602 (org-agenda-prepare-buffers scope)
14603 (while (setq file (pop scope))
14604 (with-current-buffer (org-find-base-buffer-visiting file)
14605 (save-excursion
14606 (save-restriction
14607 (widen)
14608 (goto-char (point-min))
14609 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14610 res)))
14612 ;;;; Properties
14614 ;;; Setting and retrieving properties
14616 (defconst org-special-properties
14617 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14618 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14619 "The special properties valid in Org-mode.
14621 These are properties that are not defined in the property drawer,
14622 but in some other way.")
14624 (defconst org-default-properties
14625 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14626 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14627 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14628 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14629 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14630 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14631 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14632 "Some properties that are used by Org-mode for various purposes.
14633 Being in this list makes sure that they are offered for completion.")
14636 "Regular expression matching the first line of a property drawer.")
14639 "Regular expression matching the last line of a property drawer.")
14642 "Regular expression matching the first line of a property drawer.")
14645 "Regular expression matching the first line of a property drawer.")
14647 (defconst org-property-drawer-re
14650 "Matches an entire property drawer.")
14652 (defconst org-clock-drawer-re
14655 "Matches an entire clock drawer.")
14657 (defsubst org-re-property (property)
14658 "Return a regexp matching a PROPERTY line.
14659 Match group 1 will be set to the value."
14662 (defsubst org-re-property-keyword (property)
14663 "Return a regexp matching a PROPERTY line, possibly with no
14664 value for the property."
14667 (defun org-property-action ()
14668 "Do an action on properties."
14669 (interactive)
14670 (let (c)
14671 (org-at-property-p)
14672 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14673 (setq c (read-char-exclusive))
14674 (cond
14675 ((equal c ?s)
14676 (call-interactively 'org-set-property))
14677 ((equal c ?d)
14678 (call-interactively 'org-delete-property))
14679 ((equal c ?D)
14680 (call-interactively 'org-delete-property-globally))
14681 ((equal c ?c)
14682 (call-interactively 'org-compute-property-at-point))
14683 (t (error "No such property action %c" c)))))
14685 (defun org-inc-effort ()
14686 "Increment the value of the effort property in the current entry."
14687 (interactive)
14688 (org-set-effort nil t))
14690 (defvar org-clock-effort) ;; Defined in org-clock.el
14691 (defvar org-clock-current-task) ;; Defined in org-clock.el
14692 (defun org-set-effort (&optional value increment)
14693 "Set the effort property of the current entry.
14694 With numerical prefix arg, use the nth allowed value, 0 stands for the
14695 10th allowed value.
14697 When INCREMENT is non-nil, set the property to the next allowed value."
14698 (interactive "P")
14699 (if (equal value 0) (setq value 10))
14700 (let* ((completion-ignore-case t)
14701 (prop org-effort-property)
14702 (cur (org-entry-get nil prop))
14703 (allowed (org-property-get-allowed-values nil prop 'table))
14704 (existing (mapcar 'list (org-property-values prop)))
14705 (heading (nth 4 (org-heading-components)))
14706 rpl
14707 (val (cond
14708 ((stringp value) value)
14709 ((and allowed (integerp value))
14710 (or (car (nth (1- value) allowed))
14711 (car (org-last allowed))))
14712 ((and allowed increment)
14713 (or (caadr (member (list cur) allowed))
14714 (error "Allowed effort values are not set")))
14715 (allowed
14716 (message "Select 1-9,0, [RET%s]: %s"
14717 (if cur (concat "=" cur) "")
14718 (mapconcat 'car allowed " "))
14719 (setq rpl (read-char-exclusive))
14721 cur
14722 (setq rpl (- rpl ?0))
14723 (if (equal rpl 0) (setq rpl 10))
14724 (if (and (> rpl 0) (<= rpl (length allowed)))
14725 (car (nth (1- rpl) allowed))
14726 (org-completing-read "Effort: " allowed nil))))
14727 (t
14728 (let (org-completion-use-ido org-completion-use-iswitchb)
14729 (org-completing-read
14731 (concat "[" cur "]") "")
14732 ": ")
14733 existing nil nil "" nil cur))))))
14734 (unless (equal (org-entry-get nil prop) val)
14735 (org-entry-put nil prop val))
14736 (save-excursion
14737 (org-back-to-heading t)
14738 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
14739 (when (string= heading org-clock-current-task)
14740 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
14741 (org-clock-update-mode-line))
14742 (message "%s is now %s" prop val)))
14744 (defun org-at-property-p ()
14745 "Is cursor inside a property drawer?"
14746 (save-excursion
14747 (beginning-of-line 1)
14749 (save-match-data ;; Used by calling procedures
14750 (let ((p (point))
14751 (range (unless (org-before-first-heading-p)
14752 (org-get-property-block))))
14753 (and range (<= (car range) p) (< p (cdr range))))))))
14755 (defun org-get-property-block (&optional beg end force)
14756 "Return the (beg . end) range of the body of the property drawer.
14757 BEG and END are the beginning and end of the current subtree, or of
14758 the part before the first headline. If they are not given, they will
14759 be found. If the drawer does not exist and FORCE is non-nil, create
14760 the drawer."
14761 (catch 'exit
14762 (save-excursion
14763 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
14764 (progn (org-back-to-heading t) (point))))
14765 (end (or end (and (not (outline-next-heading)) (point-max))
14766 (point))))
14767 (goto-char beg)
14768 (if (re-search-forward org-property-start-re end t)
14769 (setq beg (1+ (match-end 0)))
14770 (if force
14771 (save-excursion
14772 (org-insert-property-drawer)
14773 (setq end (progn (outline-next-heading) (point))))
14774 (throw 'exit nil))
14775 (goto-char beg)
14776 (if (re-search-forward org-property-start-re end t)
14777 (setq beg (1+ (match-end 0)))))
14778 (if (re-search-forward org-property-end-re end t)
14779 (setq end (match-beginning 0))
14780 (or force (throw 'exit nil))
14781 (goto-char beg)
14782 (setq end beg)
14783 (org-indent-line)
14785 (cons beg end)))))
14787 (defun org-entry-properties (&optional pom which specific)
14788 "Get all properties of the entry at point-or-marker POM.
14789 This includes the TODO keyword, the tags, time strings for deadline,
14790 scheduled, and clocking, and any additional properties defined in the
14791 entry. The return value is an alist, keys may occur multiple times
14792 if the property key was used several times.
14793 POM may also be nil, in which case the current entry is used.
14794 If WHICH is nil or `all', get all properties. If WHICH is
14795 `special' or `standard', only get that subclass. If WHICH
14796 is a string only get exactly this property. SPECIFIC can be a string, the
14797 specific property we are interested in. Specifying it can speed
14798 things up because then unnecessary parsing is avoided."
14799 (setq which (or which 'all))
14800 (org-with-point-at pom
14801 (let ((clockstr (substring org-clock-string 0 -1))
14802 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14803 (case-fold-search nil)
14804 beg end range props sum-props key key1 value string clocksum clocksumt)
14805 (save-excursion
14806 (when (condition-case nil
14807 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
14808 (error nil))
14809 (setq beg (point))
14810 (setq sum-props (get-text-property (point) 'org-summaries))
14811 (setq clocksum (get-text-property (point) :org-clock-minutes)
14812 clocksumt (get-text-property (point) :org-clock-minutes-today))
14813 (outline-next-heading)
14814 (setq end (point))
14815 (when (memq which '(all special))
14816 ;; Get the special properties, like TODO and tags
14817 (goto-char beg)
14818 (when (and (or (not specific) (string= specific "TODO"))
14819 (looking-at org-todo-line-regexp) (match-end 2))
14820 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14821 (when (and (or (not specific) (string= specific "PRIORITY"))
14822 (looking-at org-priority-regexp))
14823 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14824 (when (or (not specific) (string= specific "FILE"))
14825 (push (cons "FILE" buffer-file-name) props))
14826 (when (and (or (not specific) (string= specific "TAGS"))
14827 (setq value (org-get-tags-string))
14829 (push (cons "TAGS" value) props))
14830 (when (and (or (not specific) (string= specific "ALLTAGS"))
14831 (setq value (org-get-tags-at)))
14832 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14833 ":"))
14834 props))
14835 (when (or (not specific) (string= specific "BLOCKED"))
14836 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14837 (when (or (not specific)
14838 (member specific
14839 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14840 "TIMESTAMP" "TIMESTAMP_IA")))
14841 (catch 'match
14842 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14843 (setq key (if (match-end 1)
14844 (substring (org-match-string-no-properties 1)
14845 0 -1))
14846 string (if (equal key clockstr)
14847 (org-trim
14848 (buffer-substring-no-properties
14849 (match-beginning 3) (goto-char
14850 (point-at-eol))))
14851 (substring (org-match-string-no-properties 3)
14852 1 -1)))
14853 ;; Get the correct property name from the key. This is
14854 ;; necessary if the user has configured time keywords.
14855 (setq key1 (concat key ":"))
14856 (cond
14857 ((not key)
14858 (setq key
14859 (if (= (char-after (match-beginning 3)) ?\[)
14860 "TIMESTAMP_IA" "TIMESTAMP")))
14861 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14862 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14863 ((equal key1 org-closed-string) (setq key "CLOSED"))
14864 ((equal key1 org-clock-string) (setq key "CLOCK")))
14865 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14866 (progn
14867 (push (cons key string) props)
14868 ;; no need to search further if match is found
14869 (throw 'match t))
14870 (when (or (equal key "CLOCK") (not (assoc key props)))
14871 (push (cons key string) props)))))))
14873 (when (memq which '(all standard))
14874 ;; Get the standard properties, like :PROP: ...
14875 (setq range (org-get-property-block beg end))
14876 (when range
14877 (goto-char (car range))
14878 (while (re-search-forward
14880 (cdr range) t)
14881 (setq key (org-match-string-no-properties 1)
14882 value (org-trim (or (org-match-string-no-properties 2) "")))
14883 (unless (member key excluded)
14884 (push (cons key (or value "")) props)))))
14885 (if clocksum
14886 (push (cons "CLOCKSUM"
14887 (org-columns-number-to-string (/ (float clocksum) 60.)
14888 'add_times))
14889 props))
14890 (if clocksumt
14891 (push (cons "CLOCKSUM_T"
14892 (org-columns-number-to-string (/ (float clocksumt) 60.)
14893 'add_times))
14894 props))
14895 (unless (assoc "CATEGORY" props)
14896 (push (cons "CATEGORY" (org-get-category)) props))
14897 (append sum-props (nreverse props)))))))
14899 (defun org-entry-get (pom property &optional inherit literal-nil)
14900 "Get value of PROPERTY for entry or content at point-or-marker POM.
14901 If INHERIT is non-nil and the entry does not have the property,
14902 then also check higher levels of the hierarchy.
14903 If INHERIT is the symbol `selective', use inheritance only if the setting
14904 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14905 If the property is present but empty, the return value is the empty string.
14906 If the property is not present at all, nil is returned.
14909 do not interpret it as the list atom nil. This is used for inheritance
14911 (org-with-point-at pom
14912 (if (and inherit (if (eq inherit 'selective)
14913 (org-property-inherit-p property)
14914 t))
14915 (org-entry-get-with-inheritance property literal-nil)
14916 (if (member property org-special-properties)
14917 ;; We need a special property. Use `org-entry-properties' to
14918 ;; retrieve it, but specify the wanted property
14919 (cdr (assoc property (org-entry-properties nil 'special property)))
14920 (let ((range (org-get-property-block)))
14921 (when (and range (not (eq (car range) (cdr range))))
14922 (let* ((props (list (or (assoc property org-file-properties)
14923 (assoc property org-global-properties)
14924 (assoc property org-global-properties-fixed))))
14925 (ap (lambda (key)
14926 (when (re-search-forward
14927 (org-re-property key) (cdr range) t)
14928 (setq props
14929 (org-update-property-plist
14930 key
14931 (if (match-end 1)
14932 (org-match-string-no-properties 1) "")
14933 props)))))
14934 val)
14935 (goto-char (car range))
14936 (funcall ap property)
14937 (goto-char (car range))
14938 (while (funcall ap (concat property "+")))
14939 (setq val (cdr (assoc property props)))
14940 (when val (if literal-nil val (org-not-nil val))))))))))
14942 (defun org-property-or-variable-value (var &optional inherit)
14943 "Check if there is a property fixing the value of VAR.
14944 If yes, return this value. If not, return the current value of the variable."
14945 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14947 (read prop)
14948 (symbol-value var))))
14950 (defun org-entry-delete (pom property &optional delete-empty-drawer)
14951 "Delete the property PROPERTY from entry at point-or-marker POM.
14952 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
14953 an empty drawer to delete."
14954 (org-with-point-at pom
14955 (if (member property org-special-properties)
14956 nil ; cannot delete these properties.
14957 (let ((range (org-get-property-block)))
14958 (if (and range
14959 (goto-char (car range))
14960 (re-search-forward
14961 (org-re-property property)
14962 (cdr range) t))
14963 (progn
14964 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14965 (and delete-empty-drawer
14966 (org-remove-empty-drawer-at
14967 delete-empty-drawer (car range)))
14968 t)
14969 nil)))))
14971 ;; Multi-values properties are properties that contain multiple values
14972 ;; These values are assumed to be single words, separated by whitespace.
14973 (defun org-entry-add-to-multivalued-property (pom property value)
14974 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14975 (let* ((old (org-entry-get pom property))
14977 (setq value (org-entry-protect-space value))
14978 (unless (member value values)
14979 (setq values (cons value values))
14980 (org-entry-put pom property
14981 (mapconcat 'identity values " ")))))
14983 (defun org-entry-remove-from-multivalued-property (pom property value)
14984 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14985 (let* ((old (org-entry-get pom property))
14987 (setq value (org-entry-protect-space value))
14988 (when (member value values)
14989 (setq values (delete value values))
14990 (org-entry-put pom property
14991 (mapconcat 'identity values " ")))))
14993 (defun org-entry-member-in-multivalued-property (pom property value)
14994 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14995 (let* ((old (org-entry-get pom property))
14997 (setq value (org-entry-protect-space value))
14998 (member value values)))
15000 (defun org-entry-get-multivalued-property (pom property)
15001 "Return a list of values in a multivalued property."
15002 (let* ((value (org-entry-get pom property))
15004 (mapcar 'org-entry-restore-space values)))
15006 (defun org-entry-put-multivalued-property (pom property &rest values)
15007 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15008 VALUES should be a list of strings. Spaces will be protected."
15009 (org-entry-put pom property
15010 (mapconcat 'org-entry-protect-space values " "))
15011 (let* ((value (org-entry-get pom property))
15013 (mapcar 'org-entry-restore-space values)))
15015 (defun org-entry-protect-space (s)
15016 "Protect spaces and newline in string S."
15017 (while (string-match " " s)
15018 (setq s (replace-match "%20" t t s)))
15020 (setq s (replace-match "%0A" t t s)))
15021 s)
15023 (defun org-entry-restore-space (s)
15024 "Restore spaces and newline in string S."
15025 (while (string-match "%20" s)
15026 (setq s (replace-match " " t t s)))
15027 (while (string-match "%0A" s)
15029 s)
15031 (defvar org-entry-property-inherited-from (make-marker)
15032 "Marker pointing to the entry from where a property was inherited.
15033 Each call to `org-entry-get-with-inheritance' will set this marker to the
15034 location of the entry where the inheritance search matched. If there was
15035 no match, the marker will point nowhere.
15036 Note that also `org-entry-get' calls this function, if the INHERIT flag
15037 is set.")
15039 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15040 "Get PROPERTY of entry or content at point, search higher levels if needed.
15041 The search will stop at the first ancestor which has the property defined.
15043 should be considered as undefined (this is the meaning of nil here).
15045 (move-marker org-entry-property-inherited-from nil)
15046 (let (tmp)
15047 (save-excursion
15048 (save-restriction
15049 (widen)
15050 (catch 'ex
15051 (while t
15052 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15053 (or (ignore-errors (org-back-to-heading t))
15054 (goto-char (point-min)))
15055 (move-marker org-entry-property-inherited-from (point))
15056 (throw 'ex tmp))
15057 (or (ignore-errors (org-up-heading-safe))
15058 (throw 'ex nil))))))
15059 (setq tmp (or tmp
15060 (cdr (assoc property org-file-properties))
15061 (cdr (assoc property org-global-properties))
15062 (cdr (assoc property org-global-properties-fixed))))
15063 (if literal-nil tmp (org-not-nil tmp))))
15065 (defvar org-property-changed-functions nil
15066 "Hook called when the value of a property has changed.
15067 Each hook function should accept two arguments, the name of the property
15068 and the new value.")
15070 (defun org-entry-put (pom property value)
15071 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15072 (org-with-point-at pom
15073 (org-back-to-heading t)
15074 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15075 range)
15076 (cond
15077 ((equal property "TODO")
15079 (not (member value org-todo-keywords-1)))
15081 (if (or (not value)
15083 (setq value 'none))
15084 (org-todo value)
15085 (org-set-tags nil 'align))
15086 ((equal property "PRIORITY")
15088 (string-to-char value) ?\ ))
15089 (org-set-tags nil 'align))
15090 ((equal property "CLOCKSUM")
15091 (if (not (re-search-forward
15093 (error "Cannot find a clock log")
15094 (goto-char (- (match-end 1) 2))
15095 (cond
15096 ((eq value 'earlier) (org-timestamp-down))
15097 ((eq value 'later) (org-timestamp-up)))
15098 (org-clock-sum-current-item)))
15099 ((equal property "SCHEDULED")
15100 (if (re-search-forward org-scheduled-time-regexp end t)
15101 (cond
15102 ((eq value 'earlier) (org-timestamp-change -1 'day))
15103 ((eq value 'later) (org-timestamp-change 1 'day))
15104 (t (call-interactively 'org-schedule)))
15105 (call-interactively 'org-schedule)))
15106 ((equal property "DEADLINE")
15107 (if (re-search-forward org-deadline-time-regexp end t)
15108 (cond
15109 ((eq value 'earlier) (org-timestamp-change -1 'day))
15110 ((eq value 'later) (org-timestamp-change 1 'day))
15111 (t (call-interactively 'org-deadline)))
15112 (call-interactively 'org-deadline)))
15113 ((member property org-special-properties)
15114 (error "The %s property can not yet be set with `org-entry-put'"
15115 property))
15116 (t ; a non-special property
15117 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15118 (setq range (org-get-property-block beg end 'force))
15119 (goto-char (car range))
15120 (if (re-search-forward
15121 (org-re-property-keyword property) (cdr range) t)
15122 (progn
15123 (delete-region (match-beginning 0) (match-end 0))
15124 (goto-char (match-beginning 0)))
15125 (goto-char (cdr range))
15127 (backward-char 1)
15128 (org-indent-line))
15129 (insert ":" property ":")
15130 (and value (insert " " value))
15131 (org-indent-line)))))
15132 (run-hook-with-args 'org-property-changed-functions property value)))
15134 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15135 "Get all property keys in the current buffer.
15136 With INCLUDE-SPECIALS, also list the special properties that reflect things
15137 like tags and TODO state.
15138 With INCLUDE-DEFAULTS, also include properties that has special meaning
15139 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15140 and others.
15141 With INCLUDE-COLUMNS, also include property names given in COLUMN
15142 formats in the current buffer."
15143 (let (rtn range cfmt s p)
15144 (save-excursion
15145 (save-restriction
15146 (widen)
15147 (goto-char (point-min))
15148 (while (re-search-forward org-property-start-re nil t)
15149 (setq range (org-get-property-block))
15150 (goto-char (car range))
15151 (while (re-search-forward
15153 (cdr range) t)
15154 (add-to-list 'rtn (org-match-string-no-properties 1)))
15155 (outline-next-heading))))
15157 (when include-specials
15158 (setq rtn (append org-special-properties rtn)))
15160 (when include-defaults
15161 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15162 (add-to-list 'rtn org-effort-property))
15164 (when include-columns
15165 (save-excursion
15166 (save-restriction
15167 (widen)
15168 (goto-char (point-min))
15169 (while (re-search-forward
15171 nil t)
15172 (setq cfmt (match-string 2) s 0)
15174 cfmt s)
15175 (setq s (match-end 0)
15176 p (match-string 1 cfmt))
15177 (unless (or (equal p "ITEM")
15178 (member p org-special-properties))
15179 (add-to-list 'rtn (match-string 1 cfmt))))))))
15181 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15183 (defun org-property-values (key)
15184 "Return a list of all values of property KEY in the current buffer."
15185 (save-excursion
15186 (save-restriction
15187 (widen)
15188 (goto-char (point-min))
15189 (let ((re (org-re-property key))
15190 values)
15191 (while (re-search-forward re nil t)
15192 (add-to-list 'values (org-trim (match-string 1))))
15193 (delete "" values)))))
15195 (defun org-insert-property-drawer ()
15196 "Insert a property drawer into the current entry."
15197 (org-back-to-heading t)
15198 (looking-at org-outline-regexp)
15199 (let ((indent (if org-adapt-indentation
15200 (- (match-end 0) (match-beginning 0))
15201 0))
15202 (beg (point))
15204 end hiddenp)
15205 (outline-next-heading)
15206 (setq end (point))
15207 (goto-char beg)
15208 (while (re-search-forward re end t))
15209 (setq hiddenp (outline-invisible-p))
15210 (end-of-line 1)
15213 (if (member (match-string 1) '("CLOCK:" ":END:"))
15214 ;; just skip this line
15215 (beginning-of-line 2)
15216 ;; Drawer start, find the end
15218 (beginning-of-line 1)))
15219 (org-skip-over-state-notes)
15221 (if (eq (char-before) ?*) (forward-char 1))
15223 (beginning-of-line 0)
15224 (org-indent-to-column indent)
15225 (beginning-of-line 2)
15226 (org-indent-to-column indent)
15227 (beginning-of-line 0)
15228 (if hiddenp
15229 (save-excursion
15230 (org-back-to-heading t)
15231 (hide-entry))
15232 (org-flag-drawer t))))
15234 (defun org-insert-drawer (&optional arg drawer)
15235 "Insert a drawer at point.
15237 Optional argument DRAWER, when non-nil, is a string representing
15238 drawer's name. Otherwise, the user is prompted for a name.
15240 If a region is active, insert the drawer around that region
15241 instead.
15243 Point is left between drawer's boundaries."
15244 (interactive "P")
15245 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15246 "LOGBOOK"))
15247 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15248 ;; internally by Org. They are meant to be inserted
15249 ;; automatically.
15250 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15251 ;; Remove system drawers from list. Note: For some reason,
15252 ;; `org-completing-read' ignores the predicate while
15253 ;; `completing-read' handles it fine.
15254 (drawer (if arg "PROPERTIES"
15255 (or drawer
15256 (completing-read
15257 "Drawer: " org-drawers
15258 (lambda (d) (not (member d system-drawers))))))))
15259 (cond
15260 ;; With C-u, fall back on `org-insert-property-drawer'
15261 (arg (org-insert-property-drawer))
15262 ;; With an active region, insert a drawer at point.
15263 ((not (org-region-active-p))
15264 (progn
15267 (forward-line -2)))
15268 ;; Otherwise, insert the drawer at point
15269 (t
15270 (let ((rbeg (region-beginning))
15271 (rend (copy-marker (region-end))))
15272 (unwind-protect
15273 (progn
15274 (goto-char rbeg)
15275 (beginning-of-line)
15276 (when (save-excursion
15277 (re-search-forward org-outline-regexp-bol rend t))
15278 (error "Drawers cannot contain headlines"))
15279 ;; Position point at the beginning of the first
15280 ;; non-blank line in region. Insert drawer's opening
15281 ;; there, then indent it.
15282 (org-skip-whitespace)
15283 (beginning-of-line)
15285 (forward-line -1)
15286 (indent-for-tab-command)
15287 ;; Move point to the beginning of the first blank line
15288 ;; after the last non-blank line in region. Insert
15289 ;; drawer's closing, then indent it.
15290 (goto-char rend)
15293 (deactivate-mark t)
15294 (indent-for-tab-command)
15296 ;; Clear marker, whatever the outcome of insertion is.
15297 (set-marker rend nil)))))))
15299 (defvar org-property-set-functions-alist nil
15300 "Property set function alist.
15301 Each entry should have the following format:
15303 (PROPERTY . READ-FUNCTION)
15305 The read function will be called with the same argument as
15306 `org-completing-read'.")
15308 (defun org-set-property-function (property)
15309 "Get the function that should be used to set PROPERTY.
15310 This is computed according to `org-property-set-functions-alist'."
15311 (or (cdr (assoc property org-property-set-functions-alist))
15312 'org-completing-read))
15314 (defun org-read-property-value (property)
15315 "Read PROPERTY value from user."
15316 (let* ((completion-ignore-case t)
15317 (allowed (org-property-get-allowed-values nil property 'table))
15318 (cur (org-entry-get nil property))
15319 (prompt (concat property " value"
15321 (concat " [" cur "]") "") ": "))
15322 (set-function (org-set-property-function property))
15323 (val (if allowed
15324 (funcall set-function prompt allowed nil
15325 (not (get-text-property 0 'org-unrestricted
15326 (caar allowed))))
15327 (let (org-completion-use-ido org-completion-use-iswitchb)
15328 (funcall set-function prompt
15329 (mapcar 'list (org-property-values property))
15330 nil nil "" nil cur)))))
15331 (if (equal val "")
15332 cur
15333 val)))
15335 (defvar org-last-set-property nil)
15336 (defvar org-last-set-property-value nil)
15337 (defun org-read-property-name ()
15338 "Read a property name."
15339 (let* ((completion-ignore-case t)
15340 (keys (org-buffer-property-keys nil t t))
15341 (default-prop (or (save-excursion
15342 (save-match-data
15343 (beginning-of-line)
15345 (null (string= (match-string 1) "END"))
15346 (match-string 1))))
15347 org-last-set-property))
15348 (property (org-icompleting-read
15349 (concat "Property"
15350 (if default-prop (concat " [" default-prop "]") "")
15351 ": ")
15352 (mapcar 'list keys)
15353 nil nil nil nil
15354 default-prop)))
15355 (if (member property keys)
15356 property
15357 (or (cdr (assoc (downcase property)
15358 (mapcar (lambda (x) (cons (downcase x) x))
15359 keys)))
15360 property))))
15362 (defun org-set-property-and-value (use-last)
15363 "Allow to set [PROPERTY]: [value] direction from prompt.
15364 When use-default, don't even ask, just use the last
15366 (interactive "P")
15367 (let* ((completion-ignore-case t)
15368 (pv (or (and use-last org-last-set-property-value)
15369 (org-completing-read
15371 nil nil nil nil nil
15372 org-last-set-property-value)))
15373 prop val)
15375 (setq prop (match-string 1 pv)
15376 val (match-string 2 pv))
15377 (org-set-property prop val))))
15379 (defun org-set-property (property value)
15380 "In the current entry, set PROPERTY to VALUE.
15381 When called interactively, this will prompt for a property name, offering
15382 completion on existing and default properties. And then it will prompt
15383 for a value, offering completion either on allowed values (via an inherited
15384 xxx_ALL property) or on existing values in other instances of this property
15385 in the current file."
15386 (interactive (list nil nil))
15387 (let* ((property (or property (org-read-property-name)))
15388 (value (or value (org-read-property-value property)))
15389 (fn (cdr (assoc property org-properties-postprocess-alist))))
15390 (setq org-last-set-property property)
15391 (setq org-last-set-property-value (concat property ": " value))
15392 ;; Possibly postprocess the inserted value:
15393 (when fn (setq value (funcall fn value)))
15394 (unless (equal (org-entry-get nil property) value)
15395 (org-entry-put nil property value))))
15397 (defun org-delete-property (property &optional delete-empty-drawer)
15398 "In the current entry, delete PROPERTY.
15399 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15400 an empty drawer to delete."
15401 (interactive
15402 (let* ((completion-ignore-case t)
15403 (prop (org-icompleting-read "Property: "
15404 (org-entry-properties nil 'standard))))
15405 (list prop)))
15406 (message "Property %s %s" property
15407 (if (org-entry-delete nil property delete-empty-drawer)
15408 "deleted"
15409 "was not present in the entry")))
15411 (defun org-delete-property-globally (property)
15412 "Remove PROPERTY globally, from all entries."
15413 (interactive
15414 (let* ((completion-ignore-case t)
15415 (prop (org-icompleting-read
15416 "Globally remove property: "
15417 (mapcar 'list (org-buffer-property-keys)))))
15418 (list prop)))
15419 (save-excursion
15420 (save-restriction
15421 (widen)
15422 (goto-char (point-min))
15423 (let ((cnt 0))
15424 (while (re-search-forward
15425 (org-re-property property)
15426 nil t)
15427 (setq cnt (1+ cnt))
15428 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15431 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15433 (defun org-compute-property-at-point ()
15434 "Compute the property at point.
15435 This looks for an enclosing column format, extracts the operator and
15436 then applies it to the property in the column format's scope."
15437 (interactive)
15438 (unless (org-at-property-p)
15439 (error "Not at a property"))
15440 (let ((prop (org-match-string-no-properties 2)))
15441 (org-columns-get-format-and-top-level)
15442 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15443 (error "No operator defined for property %s" prop))
15444 (org-columns-compute prop)))
15446 (defvar org-property-allowed-value-functions nil
15447 "Hook for functions supplying allowed values for a specific property.
15448 The functions must take a single argument, the name of the property, and
15450 the values, this means that these values are intended as defaults for
15451 completion, but that other values should be allowed too.
15452 The functions must return nil if they are not responsible for this
15453 property.")
15455 (defun org-property-get-allowed-values (pom property &optional table)
15456 "Get allowed values for the property PROPERTY.
15457 When TABLE is non-nil, return an alist that can directly be used for
15458 completion."
15459 (let (vals)
15460 (cond
15461 ((equal property "TODO")
15462 (setq vals (org-with-point-at pom
15463 (append org-todo-keywords-1 '("")))))
15464 ((equal property "PRIORITY")
15465 (let ((n org-lowest-priority))
15466 (while (>= n org-highest-priority)
15467 (push (char-to-string n) vals)
15468 (setq n (1- n)))))
15469 ((member property org-special-properties))
15470 ((setq vals (run-hook-with-args-until-success
15471 'org-property-allowed-value-functions property)))
15472 (t
15473 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15475 (setq vals (car (read-from-string (concat "(" vals ")"))))
15476 (setq vals (mapcar (lambda (x)
15477 (cond ((stringp x) x)
15478 ((numberp x) (number-to-string x))
15479 ((symbolp x) (symbol-name x))
15480 (t "???")))
15481 vals)))))
15482 (when (member ":ETC" vals)
15483 (setq vals (remove ":ETC" vals))
15484 (org-add-props (car vals) '(org-unrestricted t)))
15485 (if table (mapcar 'list vals) vals)))
15487 (defun org-property-previous-allowed-value (&optional previous)
15488 "Switch to the next allowed value for this property."
15489 (interactive)
15490 (org-property-next-allowed-value t))
15492 (defun org-property-next-allowed-value (&optional previous)
15493 "Switch to the next allowed value for this property."
15494 (interactive)
15495 (unless (org-at-property-p)
15496 (error "Not at a property"))
15497 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15498 (key (match-string 2))
15499 (value (match-string 3))
15500 (allowed (or (org-property-get-allowed-values (point) key)
15501 (and (member value '("[ ]" "[-]" "[X]"))
15502 '("[ ]" "[X]"))))
15503 (heading (save-match-data (nth 4 (org-heading-components))))
15504 nval)
15505 (unless allowed
15506 (error "Allowed values for this property have not been defined"))
15507 (if previous (setq allowed (reverse allowed)))
15508 (if (member value allowed)
15509 (setq nval (car (cdr (member value allowed)))))
15510 (setq nval (or nval (car allowed)))
15511 (if (equal nval value)
15512 (error "Only one allowed value for this property"))
15513 (org-at-property-p)
15514 (replace-match (concat " :" key ": " nval) t t)
15515 (org-indent-line)
15516 (beginning-of-line 1)
15518 (when (equal prop org-effort-property)
15519 (save-excursion
15520 (org-back-to-heading t)
15521 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15522 (when (string= org-clock-current-task heading)
15523 (setq org-clock-effort nval)
15524 (org-clock-update-mode-line)))
15525 (run-hook-with-args 'org-property-changed-functions key nval)))
15527 (defun org-find-olp (path &optional this-buffer)
15528 "Return a marker pointing to the entry at outline path OLP.
15529 If anything goes wrong, throw an error.
15530 You can wrap this call to catch the error like this:
15532 (condition-case msg
15533 (org-mobile-locate-entry (match-string 4))
15534 (error (nth 1 msg)))
15536 The return value will then be either a string with the error message,
15537 or a marker if everything is OK.
15539 If THIS-BUFFER is set, the outline path does not contain a file,
15540 only headings."
15541 (let* ((file (if this-buffer buffer-file-name (pop path)))
15542 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15543 (level 1)
15544 (lmin 1)
15545 (lmax 1)
15546 limit re end found pos heading cnt flevel)
15547 (unless buffer (error "File not found :%s" file))
15548 (with-current-buffer buffer
15549 (save-excursion
15550 (save-restriction
15551 (widen)
15552 (setq limit (point-max))
15553 (goto-char (point-min))
15554 (while (setq heading (pop path))
15555 (setq re (format org-complex-heading-regexp-format
15556 (regexp-quote heading)))
15557 (setq cnt 0 pos (point))
15558 (while (re-search-forward re end t)
15559 (setq level (- (match-end 1) (match-beginning 1)))
15560 (if (and (>= level lmin) (<= level lmax))
15561 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15562 (when (= cnt 0) (error "Heading not found on level %d: %s"
15563 lmax heading))
15564 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15565 lmax heading))
15566 (goto-char found)
15567 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15568 (setq end (save-excursion (org-end-of-subtree t t))))
15569 (when (org-at-heading-p)
15570 (point-marker)))))))
15572 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15573 "Find node HEADING in BUFFER.
15574 Return a marker to the heading if it was found, or nil if not.
15575 If POS-ONLY is set, return just the position instead of a marker.
15577 The heading text must match exact, but it may have a TODO keyword,
15578 a priority cookie and tags in the standard locations."
15579 (with-current-buffer (or buffer (current-buffer))
15580 (save-excursion
15581 (save-restriction
15582 (widen)
15583 (goto-char (point-min))
15584 (let (case-fold-search)
15585 (if (re-search-forward
15586 (format org-complex-heading-regexp-format
15587 (regexp-quote heading)) nil t)
15588 (if pos-only
15589 (match-beginning 0)
15590 (move-marker (make-marker) (match-beginning 0)))))))))
15592 (defun org-find-exact-heading-in-directory (heading &optional dir)
15593 "Find Org node headline HEADING in all .org files in directory DIR.
15594 When the target headline is found, return a marker to this location."
15595 (let ((files (directory-files (or dir default-directory)
15597 file visiting m buffer)
15598 (catch 'found
15599 (while (setq file (pop files))
15600 (message "trying %s" file)
15601 (setq visiting (org-find-base-buffer-visiting file))
15602 (setq buffer (or visiting (find-file-noselect file)))
15603 (setq m (org-find-exact-headline-in-buffer
15604 heading buffer))
15605 (when (and (not m) (not visiting)) (kill-buffer buffer))
15606 (and m (throw 'found m))))))
15608 (defun org-find-entry-with-id (ident)
15609 "Locate the entry that contains the ID property with exact value IDENT.
15610 IDENT can be a string, a symbol or a number, this function will search for
15611 the string representation of it.
15612 Return the position where this entry starts, or nil if there is no such entry."
15613 (interactive "sID: ")
15614 (let ((id (cond
15615 ((stringp ident) ident)
15616 ((symbol-name ident) (symbol-name ident))
15617 ((numberp ident) (number-to-string ident))
15618 (t (error "IDENT %s must be a string, symbol or number" ident))))
15619 (case-fold-search nil))
15620 (save-excursion
15621 (save-restriction
15622 (widen)
15623 (goto-char (point-min))
15624 (when (re-search-forward
15626 nil t)
15627 (org-back-to-heading t)
15628 (point))))))
15630 ;;;; Timestamps
15632 (defvar org-last-changed-timestamp nil)
15633 (defvar org-last-inserted-timestamp nil
15634 "The last time stamp inserted with `org-insert-time-stamp'.")
15635 (defvar org-time-was-given) ; dynamically scoped parameter
15636 (defvar org-end-time-was-given) ; dynamically scoped parameter
15637 (defvar org-ts-what) ; dynamically scoped parameter
15639 (defun org-time-stamp (arg &optional inactive)
15640 "Prompt for a date/time and insert a time stamp.
15641 If the user specifies a time like HH:MM or if this command is
15642 called with at least one prefix argument, the time stamp contains
15643 the date and the time. Otherwise, only the date is be included.
15645 All parts of a date not specified by the user is filled in from
15646 the current date/time. So if you just press return without
15647 typing anything, the time stamp will represent the current
15648 date/time.
15650 If there is already a timestamp at the cursor, it will be
15651 modified.
15653 With two universal prefix arguments, insert an active timestamp
15654 with the current time without prompting the user."
15655 (interactive "P")
15656 (let* ((ts nil)
15657 (default-time
15658 ;; Default time is either today, or, when entering a range,
15659 ;; the range start.
15660 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15661 (save-excursion
15662 (re-search-backward
15664 (- (point) 20) t)))
15665 (apply 'encode-time (org-parse-time-string (match-string 1)))
15666 (current-time)))
15667 (default-input (and ts (org-get-compact-tod ts)))
15668 (repeater (save-excursion
15669 (save-match-data
15670 (beginning-of-line)
15671 (when (re-search-forward
15673 (save-excursion (progn (end-of-line) (point))) t)
15674 (match-string 0)))))
15675 org-time-was-given org-end-time-was-given time)
15676 (cond
15677 ((and (org-at-timestamp-p t)
15678 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15679 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15680 (insert "--")
15681 (setq time (let ((this-command this-command))
15682 (org-read-date arg 'totime nil nil
15683 default-time default-input inactive)))
15684 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15685 ((org-at-timestamp-p t)
15686 (setq time (let ((this-command this-command))
15687 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15688 (when (org-at-timestamp-p t) ; just to get the match data
15689 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15690 (replace-match "")
15691 (setq org-last-changed-timestamp
15692 (org-insert-time-stamp
15693 time (or org-time-was-given arg)
15694 inactive nil nil (list org-end-time-was-given)))
15695 (when repeater (goto-char (1- (point))) (insert " " repeater)
15696 (setq org-last-changed-timestamp
15697 (concat (substring org-last-inserted-timestamp 0 -1)
15698 " " repeater ">"))))
15699 (message "Timestamp updated"))
15700 ((equal arg '(16))
15701 (org-insert-time-stamp (current-time) t))
15702 (t
15703 (setq time (let ((this-command this-command))
15704 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15705 (org-insert-time-stamp time (or org-time-was-given arg) inactive
15706 nil nil (list org-end-time-was-given))))))
15708 ;; FIXME: can we use this for something else, like computing time differences?
15709 (defun org-get-compact-tod (s)
15710 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
15711 (let* ((t1 (match-string 1 s))
15712 (h1 (string-to-number (match-string 2 s)))
15713 (m1 (string-to-number (match-string 3 s)))
15714 (t2 (and (match-end 4) (match-string 5 s)))
15715 (h2 (and t2 (string-to-number (match-string 6 s))))
15716 (m2 (and t2 (string-to-number (match-string 7 s))))
15717 dh dm)
15718 (if (not t2)
15719 t1
15720 (setq dh (- h2 h1) dm (- m2 m1))
15721 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
15722 (concat t1 "+" (number-to-string dh)
15723 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15725 (defun org-time-stamp-inactive (&optional arg)
15726 "Insert an inactive time stamp.
15727 An inactive time stamp is enclosed in square brackets instead of angle
15728 brackets. It is inactive in the sense that it does not trigger agenda entries,
15729 does not link to the calendar and cannot be changed with the S-cursor keys.
15730 So these are more for recording a certain time/date."
15731 (interactive "P")
15732 (org-time-stamp arg 'inactive))
15734 (defvar org-date-ovl (make-overlay 1 1))
15735 (overlay-put org-date-ovl 'face 'org-date-selected)
15736 (org-detach-overlay org-date-ovl)
15738 (defvar org-ans1) ; dynamically scoped parameter
15739 (defvar org-ans2) ; dynamically scoped parameter
15741 (defvar org-plain-time-of-day-regexp) ; defined below
15743 (defvar org-overriding-default-time nil) ; dynamically scoped
15744 (defvar org-read-date-overlay nil)
15745 (defvar org-dcst nil) ; dynamically scoped
15746 (defvar org-read-date-history nil)
15747 (defvar org-read-date-final-answer nil)
15748 (defvar org-read-date-analyze-futurep nil)
15749 (defvar org-read-date-analyze-forced-year nil)
15750 (defvar org-read-date-inactive)
15752 (defvar org-read-date-minibuffer-local-map
15753 (let ((map (make-sparse-keymap)))
15754 (set-keymap-parent map minibuffer-local-map)
15755 (org-defkey map (kbd ".")
15756 (lambda () (interactive)
15757 (org-eval-in-calendar '(calendar-goto-today))))
15758 (org-defkey map [(meta shift left)]
15759 (lambda () (interactive)
15760 (org-eval-in-calendar '(calendar-backward-month 1))))
15761 (org-defkey map [(meta shift right)]
15762 (lambda () (interactive)
15763 (org-eval-in-calendar '(calendar-forward-month 1))))
15764 (org-defkey map [(meta shift up)]
15765 (lambda () (interactive)
15766 (org-eval-in-calendar '(calendar-backward-year 1))))
15767 (org-defkey map [(meta shift down)]
15768 (lambda () (interactive)
15769 (org-eval-in-calendar '(calendar-forward-year 1))))
15770 (org-defkey map [?\e (shift left)]
15771 (lambda () (interactive)
15772 (org-eval-in-calendar '(calendar-backward-month 1))))
15773 (org-defkey map [?\e (shift right)]
15774 (lambda () (interactive)
15775 (org-eval-in-calendar '(calendar-forward-month 1))))
15776 (org-defkey map [?\e (shift up)]
15777 (lambda () (interactive)
15778 (org-eval-in-calendar '(calendar-backward-year 1))))
15779 (org-defkey map [?\e (shift down)]
15780 (lambda () (interactive)
15781 (org-eval-in-calendar '(calendar-forward-year 1))))
15782 (org-defkey map [(shift up)]
15783 (lambda () (interactive)
15784 (org-eval-in-calendar '(calendar-backward-week 1))))
15785 (org-defkey map [(shift down)]
15786 (lambda () (interactive)
15787 (org-eval-in-calendar '(calendar-forward-week 1))))
15788 (org-defkey map [(shift left)]
15789 (lambda () (interactive)
15790 (org-eval-in-calendar '(calendar-backward-day 1))))
15791 (org-defkey map [(shift right)]
15792 (lambda () (interactive)
15793 (org-eval-in-calendar '(calendar-forward-day 1))))
15794 (org-defkey map "!"
15795 (lambda () (interactive)
15796 (org-eval-in-calendar '(diary-view-entries))
15797 (message "")))
15798 (org-defkey map ">"
15799 (lambda () (interactive)
15800 (org-eval-in-calendar '(scroll-calendar-left 1))))
15801 (org-defkey map "<"
15802 (lambda () (interactive)
15803 (org-eval-in-calendar '(scroll-calendar-right 1))))
15804 (org-defkey map "\C-v"
15805 (lambda () (interactive)
15806 (org-eval-in-calendar
15807 '(calendar-scroll-left-three-months 1))))
15808 (org-defkey map "\M-v"
15809 (lambda () (interactive)
15810 (org-eval-in-calendar
15811 '(calendar-scroll-right-three-months 1))))
15812 map)
15813 "Keymap for minibuffer commands when using `org-read-date'.")
15815 (defun org-read-date (&optional org-with-time to-time from-string prompt
15816 default-time default-input inactive)
15817 "Read a date, possibly a time, and make things smooth for the user.
15818 The prompt will suggest to enter an ISO date, but you can also enter anything
15819 which will at least partially be understood by `parse-time-string'.
15820 Unrecognized parts of the date will default to the current day, month, year,
15821 hour and minute. If this command is called to replace a timestamp at point,
15822 or to enter the second timestamp of a range, the default time is taken
15823 from the existing stamp. Furthermore, the command prefers the future,
15824 so if you are giving a date where the year is not given, and the day-month
15825 combination is already past in the current year, it will assume you
15826 mean next year. For details, see the manual. A few examples:
15828 3-2-5 --> 2003-02-05
15829 feb 15 --> currentyear-02-15
15830 2/15 --> currentyear-02-15
15831 sep 12 9 --> 2009-09-12
15832 12:45 --> today 12:45
15833 22 sept 0:34 --> currentyear-09-22 0:34
15834 12 --> currentyear-currentmonth-12
15835 Fri --> nearest Friday (today or later)
15836 etc.
15838 Furthermore you can specify a relative date by giving, as the *first* thing
15839 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
15840 change in days weeks, months, years.
15841 With a single plus or minus, the date is relative to today. With a double
15842 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15843 +4d --> four days from today
15844 +4 --> same as above
15845 +2w --> two weeks from today
15846 ++5 --> five days from default date
15848 The function understands only English month and weekday abbreviations.
15850 While prompting, a calendar is popped up - you can also select the
15851 date with the mouse (button 1). The calendar shows a period of three
15852 months. To scroll it to other months, use the keys `>' and `<'.
15853 If you don't like the calendar, turn it off with
15854 \(setq org-read-date-popup-calendar nil)
15856 With optional argument TO-TIME, the date will immediately be converted
15857 to an internal time.
15858 With an optional argument ORG-WITH-TIME, the prompt will suggest to
15859 also insert a time. Note that when ORG-WITH-TIME is not set, you can
15860 still enter a time, and this function will inform the calling routine
15861 about this change. The calling routine may then choose to change the
15862 format used to insert the time stamp into the buffer to include the time.
15863 With optional argument FROM-STRING, read from this string instead from
15864 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15865 the time/date that is used for everything that is not specified by the
15866 user."
15867 (require 'parse-time)
15868 (let* ((org-time-stamp-rounding-minutes
15869 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15870 (org-dcst org-display-custom-times)
15871 (ct (org-current-time))
15872 (org-def (or org-overriding-default-time default-time ct))
15873 (org-defdecode (decode-time org-def))
15874 (dummy (progn
15875 (when (< (nth 2 org-defdecode) org-extend-today-until)
15876 (setcar (nthcdr 2 org-defdecode) -1)
15877 (setcar (nthcdr 1 org-defdecode) 59)
15878 (setq org-def (apply 'encode-time org-defdecode)
15879 org-defdecode (decode-time org-def)))))
15880 (mouse-autoselect-window nil) ; Don't let the mouse jump
15881 (calendar-frame-setup nil)
15882 (calendar-setup nil)
15883 (calendar-move-hook nil)
15884 (calendar-view-diary-initially-flag nil)
15885 (calendar-view-holidays-initially-flag nil)
15886 (timestr (format-time-string
15887 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15888 (prompt (concat (if prompt (concat prompt " ") "")
15889 (format "Date+time [%s]: " timestr)))
15890 ans (org-ans0 "") org-ans1 org-ans2 final)
15892 (cond
15893 (from-string (setq ans from-string))
15894 (org-read-date-popup-calendar
15895 (save-excursion
15896 (save-window-excursion
15897 (calendar)
15898 (org-eval-in-calendar '(setq cursor-type nil) t)
15899 (unwind-protect
15900 (progn
15901 (calendar-forward-day (- (time-to-days org-def)
15902 (calendar-absolute-from-gregorian
15903 (calendar-current-date))))
15904 (org-eval-in-calendar nil t)
15905 (let* ((old-map (current-local-map))
15906 (map (copy-keymap calendar-mode-map))
15907 (minibuffer-local-map
15908 (copy-keymap org-read-date-minibuffer-local-map)))
15909 (org-defkey map (kbd "RET") 'org-calendar-select)
15910 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15911 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15912 (unwind-protect
15913 (progn
15914 (use-local-map map)
15915 (setq org-read-date-inactive inactive)
15916 (add-hook 'post-command-hook 'org-read-date-display)
15917 (setq org-ans0 (read-string prompt default-input
15918 'org-read-date-history nil))
15919 ;; org-ans0: from prompt
15920 ;; org-ans1: from mouse click
15921 ;; org-ans2: from calendar motion
15922 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15923 (remove-hook 'post-command-hook 'org-read-date-display)
15924 (use-local-map old-map)
15925 (when org-read-date-overlay
15926 (delete-overlay org-read-date-overlay)
15927 (setq org-read-date-overlay nil)))))
15928 (bury-buffer "*Calendar*")))))
15930 (t ; Naked prompt only
15931 (unwind-protect
15932 (setq ans (read-string prompt default-input
15933 'org-read-date-history timestr))
15934 (when org-read-date-overlay
15935 (delete-overlay org-read-date-overlay)
15936 (setq org-read-date-overlay nil)))))
15938 (setq final (org-read-date-analyze ans org-def org-defdecode))
15940 (when org-read-date-analyze-forced-year
15941 (message "Year was forced into %s"
15942 (if org-read-date-force-compatible-dates
15943 "compatible range (1970-2037)"
15944 "range representable on this machine"))
15945 (ding))
15947 ;; One round trip to get rid of 34th of August and stuff like that....
15948 (setq final (decode-time (apply 'encode-time final)))
15950 (setq org-read-date-final-answer ans)
15952 (if to-time
15953 (apply 'encode-time final)
15954 (if (and (boundp 'org-time-was-given) org-time-was-given)
15955 (format "%04d-%02d-%02d %02d:%02d"
15956 (nth 5 final) (nth 4 final) (nth 3 final)
15957 (nth 2 final) (nth 1 final))
15958 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15960 (defvar org-def)
15961 (defvar org-defdecode)
15962 (defvar org-with-time)
15963 (defun org-read-date-display ()
15964 "Display the current date prompt interpretation in the minibuffer."
15965 (when org-read-date-display-live
15966 (when org-read-date-overlay
15967 (delete-overlay org-read-date-overlay))
15968 (when (minibufferp (current-buffer))
15969 (save-excursion
15970 (end-of-line 1)
15971 (while (not (equal (buffer-substring
15972 (max (point-min) (- (point) 4)) (point))
15973 " "))
15974 (insert " ")))
15975 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15976 " " (or org-ans1 org-ans2)))
15977 (org-end-time-was-given nil)
15978 (f (org-read-date-analyze ans org-def org-defdecode))
15979 (fmts (if org-dcst
15980 org-time-stamp-custom-formats
15981 org-time-stamp-formats))
15982 (fmt (if (or org-with-time
15983 (and (boundp 'org-time-was-given) org-time-was-given))
15984 (cdr fmts)
15985 (car fmts)))
15986 (txt (format-time-string fmt (apply 'encode-time f)))
15987 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15988 (txt (concat "=> " txt)))
15989 (when (and org-end-time-was-given
15990 (string-match org-plain-time-of-day-regexp txt))
15991 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15992 org-end-time-was-given
15993 (substring txt (match-end 0)))))
15994 (when org-read-date-analyze-futurep
15995 (setq txt (concat txt " (=>F)")))
15996 (setq org-read-date-overlay
15997 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15998 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16000 (defun org-read-date-analyze (ans org-def org-defdecode)
16001 "Analyze the combined answer of the date prompt."
16002 ;; FIXME: cleanup and comment
16003 (let ((nowdecode (decode-time (current-time)))
16004 delta deltan deltaw deltadef year month day
16005 hour minute second wday pm h2 m2 tl wday1
16006 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16007 (setq org-read-date-analyze-futurep nil
16008 org-read-date-analyze-forced-year nil)
16010 (setq ans "+0"))
16012 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16013 (setq ans (replace-match "" t t ans)
16014 deltan (car delta)
16015 deltaw (nth 1 delta)
16016 deltadef (nth 2 delta)))
16018 ;; Check if there is an iso week date in there. If yes, store the
16019 ;; info and postpone interpreting it until the rest of the parsing
16020 ;; is done.
16021 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16022 (setq iso-year (if (match-end 1)
16023 (org-small-year-to-year
16024 (string-to-number (match-string 1 ans))))
16025 iso-weekday (if (match-end 3)
16026 (string-to-number (match-string 3 ans)))
16027 iso-week (string-to-number (match-string 2 ans)))
16028 (setq ans (replace-match "" t t ans)))
16030 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16031 (when (string-match
16033 (setq year (if (match-end 2)
16034 (string-to-number (match-string 2 ans))
16035 (progn (setq kill-year t)
16036 (string-to-number (format-time-string "%Y"))))
16037 month (string-to-number (match-string 3 ans))
16038 day (string-to-number (match-string 4 ans)))
16039 (if (< year 100) (setq year (+ 2000 year)))
16041 t nil ans)))
16043 ;; Help matching dotted european dates
16044 (when (string-match
16045 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16046 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16047 (setq kill-year t)
16048 (string-to-number (format-time-string "%Y")))
16049 day (string-to-number (match-string 1 ans))
16050 month (string-to-number (match-string 2 ans))
16051 ans (replace-match (format "%04d-%02d-%02d" year month day)
16052 t nil ans)))
16054 ;; Help matching american dates, like 5/30 or 5/30/7
16055 (when (string-match
16056 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16057 (setq year (if (match-end 4)
16058 (string-to-number (match-string 4 ans))
16059 (progn (setq kill-year t)
16060 (string-to-number (format-time-string "%Y"))))
16061 month (string-to-number (match-string 1 ans))
16062 day (string-to-number (match-string 2 ans)))
16063 (if (< year 100) (setq year (+ 2000 year)))
16065 t nil ans)))
16066 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16067 ;; If there is a time with am/pm, and *no* time without it, we convert
16068 ;; so that matching will be successful.
16069 (loop for i from 1 to 2 do ; twice, for end time as well
16072 (setq hour (string-to-number (match-string 1 ans))
16073 minute (if (match-end 3)
16074 (string-to-number (match-string 3 ans))
16075 0)
16076 pm (equal ?p
16077 (string-to-char (downcase (match-string 4 ans)))))
16078 (if (and (= hour 12) (not pm))
16079 (setq hour 0)
16080 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16081 (setq ans (replace-match (format "%02d:%02d" hour minute)
16082 t t ans))))
16084 ;; Check if a time range is given as a duration
16085 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16086 (setq hour (string-to-number (match-string 1 ans))
16087 h2 (+ hour (string-to-number (match-string 3 ans)))
16088 minute (string-to-number (match-string 2 ans))
16089 m2 (+ minute (if (match-end 5) (string-to-number
16090 (match-string 5 ans))0)))
16091 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16092 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16093 t t ans)))
16095 ;; Check if there is a time range
16096 (when (boundp 'org-end-time-was-given)
16097 (setq org-time-was-given nil)
16098 (when (and (string-match org-plain-time-of-day-regexp ans)
16099 (match-end 8))
16100 (setq org-end-time-was-given (match-string 8 ans))
16101 (setq ans (concat (substring ans 0 (match-beginning 7))
16102 (substring ans (match-end 7))))))
16104 (setq tl (parse-time-string ans)
16105 day (or (nth 3 tl) (nth 3 org-defdecode))
16106 month (or (nth 4 tl)
16107 (if (and org-read-date-prefer-future
16108 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16109 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16110 (nth 4 org-defdecode)))
16111 year (or (and (not kill-year) (nth 5 tl))
16112 (if (and org-read-date-prefer-future
16113 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16114 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16115 (nth 5 org-defdecode)))
16116 hour (or (nth 2 tl) (nth 2 org-defdecode))
16117 minute (or (nth 1 tl) (nth 1 org-defdecode))
16118 second (or (nth 0 tl) 0)
16119 wday (nth 6 tl))
16121 (when (and (eq org-read-date-prefer-future 'time)
16122 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16123 (equal day (nth 3 nowdecode))
16124 (equal month (nth 4 nowdecode))
16125 (equal year (nth 5 nowdecode))
16126 (nth 2 tl)
16127 (or (< (nth 2 tl) (nth 2 nowdecode))
16128 (and (= (nth 2 tl) (nth 2 nowdecode))
16129 (nth 1 tl)
16130 (< (nth 1 tl) (nth 1 nowdecode)))))
16131 (setq day (1+ day)
16132 futurep t))
16134 ;; Special date definitions below
16135 (cond
16136 (iso-week
16137 ;; There was an iso week
16138 (require 'cal-iso)
16139 (setq futurep nil)
16140 (setq year (or iso-year year)
16141 day (or iso-weekday wday 1)
16142 wday nil ; to make sure that the trigger below does not match
16143 iso-date (calendar-gregorian-from-absolute
16144 (calendar-absolute-from-iso
16145 (list iso-week day year))))
16146 ; FIXME: Should we also push ISO weeks into the future?
16147 ; (when (and org-read-date-prefer-future
16148 ; (not iso-year)
16149 ; (< (calendar-absolute-from-gregorian iso-date)
16150 ; (time-to-days (current-time))))
16151 ; (setq year (1+ year)
16152 ; iso-date (calendar-gregorian-from-absolute
16153 ; (calendar-absolute-from-iso
16154 ; (list iso-week day year)))))
16155 (setq month (car iso-date)
16156 year (nth 2 iso-date)
16157 day (nth 1 iso-date)))
16158 (deltan
16159 (setq futurep nil)
16160 (unless deltadef
16161 (let ((now (decode-time (current-time))))
16162 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16163 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16164 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16165 ((equal deltaw "m") (setq month (+ month deltan)))
16166 ((equal deltaw "y") (setq year (+ year deltan)))))
16167 ((and wday (not (nth 3 tl)))
16168 ;; Weekday was given, but no day, so pick that day in the week
16169 ;; on or after the derived date.
16170 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16171 (unless (equal wday wday1)
16172 (setq day (+ day (% (- wday wday1 -7) 7))))))
16173 (if (and (boundp 'org-time-was-given)
16174 (nth 2 tl))
16175 (setq org-time-was-given t))
16176 (if (< year 100) (setq year (+ 2000 year)))
16177 ;; Check of the date is representable
16178 (if org-read-date-force-compatible-dates
16179 (progn
16180 (if (< year 1970)
16181 (setq year 1970 org-read-date-analyze-forced-year t))
16182 (if (> year 2037)
16183 (setq year 2037 org-read-date-analyze-forced-year t)))
16184 (condition-case nil
16185 (ignore (encode-time second minute hour day month year))
16186 (error
16187 (setq year (nth 5 org-defdecode))
16188 (setq org-read-date-analyze-forced-year t))))
16189 (setq org-read-date-analyze-futurep futurep)
16190 (list second minute hour day month year)))
16192 (defvar parse-time-weekdays)
16193 (defun org-read-date-get-relative (s today default)
16194 "Check string S for special relative date string.
16195 TODAY and DEFAULT are internal times, for today and for a default.
16196 Return shift list (N what def-flag)
16198 N is the number of WHATs to shift.
16199 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16200 the DEFAULT date rather than TODAY."
16201 (require 'parse-time)
16202 (when (and
16203 (string-match
16204 (concat
16209 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16210 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16211 (string-to-char (substring (match-string 1 s) -1))
16212 ?+))
16213 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16214 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16215 (what (if (match-end 3) (match-string 3 s) "d"))
16216 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16217 (date (if rel default today))
16218 (wday (nth 6 (decode-time date)))
16219 delta)
16220 (if wday1
16221 (progn
16222 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16223 (if (= dir ?-) (setq delta (- delta 7)))
16224 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16225 (list delta "d" rel))
16226 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16228 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16229 "Turn a user-specified date into the internal representation.
16230 The internal representation needed by the calendar is (month day year).
16231 This is a wrapper to handle the brain-dead convention in calendar that
16232 user function argument order change dependent on argument order."
16233 (if (boundp 'calendar-date-style)
16234 (cond
16235 ((eq calendar-date-style 'american)
16236 (list arg1 arg2 arg3))
16237 ((eq calendar-date-style 'european)
16238 (list arg2 arg1 arg3))
16239 ((eq calendar-date-style 'iso)
16240 (list arg2 arg3 arg1)))
16241 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16242 (if (org-bound-and-true-p european-calendar-style)
16243 (list arg2 arg1 arg3)
16244 (list arg1 arg2 arg3)))))
16246 (defun org-eval-in-calendar (form &optional keepdate)
16247 "Eval FORM in the calendar window and return to current window.
16248 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16249 otherwise stick to the current value of `org-ans2'."
16250 (let ((sf (selected-frame))
16251 (sw (selected-window)))
16252 (select-window (get-buffer-window "*Calendar*" t))
16253 (eval form)
16254 (when (and (not keepdate) (calendar-cursor-to-date))
16255 (let* ((date (calendar-cursor-to-date))
16256 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16257 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16258 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16259 (select-window sw)
16260 (org-select-frame-set-input-focus sf)))
16262 (defun org-calendar-select ()
16263 "Return to `org-read-date' with the date currently selected.
16264 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16265 (interactive)
16266 (when (calendar-cursor-to-date)
16267 (let* ((date (calendar-cursor-to-date))
16268 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16269 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16270 (if (active-minibuffer-window) (exit-minibuffer))))
16272 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16273 "Insert a date stamp for the date given by the internal TIME.
16274 WITH-HM means use the stamp format that includes the time of the day.
16275 INACTIVE means use square brackets instead of angular ones, so that the
16276 stamp will not contribute to the agenda.
16277 PRE and POST are optional strings to be inserted before and after the
16278 stamp.
16279 The command returns the inserted time stamp."
16280 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16281 stamp)
16282 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16283 (insert-before-markers (or pre ""))
16284 (when (listp extra)
16285 (setq extra (car extra))
16286 (if (and (stringp extra)
16288 (setq extra (format "-%02d:%02d"
16289 (string-to-number (match-string 1 extra))
16290 (string-to-number (match-string 2 extra))))
16291 (setq extra nil)))
16292 (when extra
16293 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16294 (insert-before-markers (setq stamp (format-time-string fmt time)))
16295 (insert-before-markers (or post ""))
16296 (setq org-last-inserted-timestamp stamp)))
16298 (defun org-toggle-time-stamp-overlays ()
16299 "Toggle the use of custom time stamp formats."
16300 (interactive)
16301 (setq org-display-custom-times (not org-display-custom-times))
16302 (unless org-display-custom-times
16303 (let ((p (point-min)) (bmp (buffer-modified-p)))
16304 (while (setq p (next-single-property-change p 'display))
16305 (if (and (get-text-property p 'display)
16306 (eq (get-text-property p 'face) 'org-date))
16307 (remove-text-properties
16308 p (setq p (next-single-property-change p 'display))
16309 '(display t))))
16310 (set-buffer-modified-p bmp)))
16311 (if (featurep 'xemacs)
16312 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16313 (org-restart-font-lock)
16314 (setq org-table-may-need-update t)
16315 (if org-display-custom-times
16316 (message "Time stamps are overlaid with custom format")
16317 (message "Time stamp overlays removed")))
16319 (defun org-display-custom-time (beg end)
16320 "Overlay modified time stamp format over timestamp between BEG and END."
16321 (let* ((ts (buffer-substring beg end))
16322 t1 w1 with-hm tf time str w2 (off 0))
16323 (save-match-data
16324 (setq t1 (org-parse-time-string ts t))
16325 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16326 (setq off (- (match-end 0) (match-beginning 0)))))
16327 (setq end (- end off))
16328 (setq w1 (- end beg)
16329 with-hm (and (nth 1 t1) (nth 2 t1))
16330 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16331 time (org-fix-decoded-time t1)
16332 str (org-add-props
16333 (format-time-string
16334 (substring tf 1 -1) (apply 'encode-time time))
16335 nil 'mouse-face 'highlight)
16336 w2 (length str))
16337 (if (not (= w2 w1))
16338 (add-text-properties (1+ beg) (+ 2 beg)
16339 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16340 (if (featurep 'xemacs)
16341 (progn
16342 (put-text-property beg end 'invisible t)
16343 (put-text-property beg end 'end-glyph (make-glyph str)))
16344 (put-text-property beg end 'display str))))
16346 (defun org-translate-time (string)
16347 "Translate all timestamps in STRING to custom format.
16348 But do this only if the variable `org-display-custom-times' is set."
16349 (when org-display-custom-times
16350 (save-match-data
16351 (let* ((start 0)
16352 (re org-ts-regexp-both)
16353 t1 with-hm inactive tf time str beg end)
16354 (while (setq start (string-match re string start))
16355 (setq beg (match-beginning 0)
16356 end (match-end 0)
16357 t1 (save-match-data
16358 (org-parse-time-string (substring string beg end) t))
16359 with-hm (and (nth 1 t1) (nth 2 t1))
16360 inactive (equal (substring string beg (1+ beg)) "[")
16361 tf (funcall (if with-hm 'cdr 'car)
16362 org-time-stamp-custom-formats)
16363 time (org-fix-decoded-time t1)
16364 str (format-time-string
16365 (concat
16366 (if inactive "[" "<") (substring tf 1 -1)
16367 (if inactive "]" ">"))
16368 (apply 'encode-time time))
16369 string (replace-match str t t string)
16370 start (+ start (length str)))))))
16371 string)
16373 (defun org-fix-decoded-time (time)
16374 "Set 0 instead of nil for the first 6 elements of time.
16375 Don't touch the rest."
16376 (let ((n 0))
16377 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16379 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16381 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16382 "Difference between TIMESTAMP-STRING and now in days.
16383 If SECONDS is non-nil, return the difference in seconds."
16384 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16385 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16386 (funcall fdiff (current-time)))))
16388 (defun org-deadline-close (timestamp-string &optional ndays)
16389 "Is the time in TIMESTAMP-STRING close to the current date?"
16390 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16391 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16392 (not (org-entry-is-done-p))))
16394 (defun org-get-wdays (ts &optional delay zero-delay)
16395 "Get the deadline lead time appropriate for timestring TS.
16396 When DELAY is non-nil, get the delay time for scheduled items
16397 instead of the deadline lead time. When ZERO-DELAY is non-nil
16398 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16399 don't try to find the delay cookie in the scheduled timestamp."
16400 (let ((tv (if delay org-scheduled-delay-days
16401 org-deadline-warning-days)))
16402 (cond
16403 ((or (and delay (< tv 0))
16404 (and delay zero-delay (<= tv 0))
16405 (and (not delay) (<= tv 0)))
16406 ;; Enforce this value no matter what
16407 (- tv))
16409 ;; lead time is specified.
16410 (floor (* (string-to-number (match-string 1 ts))
16411 (cdr (assoc (match-string 2 ts)
16412 '(("d" . 1) ("w" . 7)
16413 ("m" . 30.4) ("y" . 365.25)
16414 ("h" . 0.041667)))))))
16415 ;; go for the default.
16416 (t tv))))
16418 (defun org-calendar-select-mouse (ev)
16419 "Return to `org-read-date' with the date currently selected.
16420 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16421 (interactive "e")
16422 (mouse-set-point ev)
16423 (when (calendar-cursor-to-date)
16424 (let* ((date (calendar-cursor-to-date))
16425 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16426 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16427 (if (active-minibuffer-window) (exit-minibuffer))))
16429 (defun org-check-deadlines (ndays)
16430 "Check if there are any deadlines due or past due.
16431 A deadline is considered due if it happens within `org-deadline-warning-days'
16432 days from today's date. If the deadline appears in an entry marked DONE,
16433 it is not shown. The prefix arg NDAYS can be used to test that many
16435 (interactive "P")
16436 (let* ((org-warn-days
16437 (cond
16438 ((equal ndays '(4)) 100000)
16439 (ndays (prefix-numeric-value ndays))
16440 (t (abs org-deadline-warning-days))))
16441 (case-fold-search nil)
16443 (callback
16444 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16446 (message "%d deadlines past-due or due within %d days"
16447 (org-occur regexp nil callback)
16448 org-warn-days)))
16450 (defsubst org-re-timestamp (type)
16451 "Return a regexp for timestamp TYPE.
16452 Allowed values for TYPE are:
16454 all: all timestamps
16455 active: only active timestamps (<...>)
16456 inactive: only inactive timestamps ([...])
16457 scheduled: only scheduled timestamps
16458 deadline: only deadline timestamps
16460 When TYPE is nil, fall back on returning a regexp that matches
16461 both scheduled and deadline timestamps."
16462 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16463 ((eq type 'active) org-ts-regexp)
16467 ((eq type 'scheduled-or-deadline)
16470 (defun org-check-before-date (date)
16471 "Check if there are deadlines or scheduled entries before DATE."
16472 (interactive (list (org-read-date)))
16473 (let ((case-fold-search nil)
16474 (regexp (org-re-timestamp org-ts-type))
16475 (callback
16476 (lambda () (time-less-p
16477 (org-time-string-to-time (match-string 1))
16478 (org-time-string-to-time date)))))
16479 (message "%d entries before %s"
16480 (org-occur regexp nil callback) date)))
16482 (defun org-check-after-date (date)
16483 "Check if there are deadlines or scheduled entries after DATE."
16484 (interactive (list (org-read-date)))
16485 (let ((case-fold-search nil)
16486 (regexp (org-re-timestamp org-ts-type))
16487 (callback
16488 (lambda () (not
16489 (time-less-p
16490 (org-time-string-to-time (match-string 1))
16491 (org-time-string-to-time date))))))
16492 (message "%d entries after %s"
16493 (org-occur regexp nil callback) date)))
16495 (defun org-check-dates-range (start-date end-date)
16496 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16497 (interactive (list (org-read-date nil nil nil "Range starts")
16498 (org-read-date nil nil nil "Range end")))
16499 (let ((case-fold-search nil)
16500 (regexp (org-re-timestamp org-ts-type))
16501 (callback
16502 (lambda ()
16503 (let ((match (match-string 1)))
16504 (and
16505 (not (time-less-p
16506 (org-time-string-to-time match)
16507 (org-time-string-to-time start-date)))
16508 (time-less-p
16509 (org-time-string-to-time match)
16510 (org-time-string-to-time end-date)))))))
16511 (message "%d entries between %s and %s"
16512 (org-occur regexp nil callback) start-date end-date)))
16514 (defun org-evaluate-time-range (&optional to-buffer)
16515 "Evaluate a time range by computing the difference between start and end.
16516 Normally the result is just printed in the echo area, but with prefix arg
16517 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16518 If the time range is actually in a table, the result is inserted into the
16519 next column.
16520 For time difference computation, a year is assumed to be exactly 365
16521 days in order to avoid rounding problems."
16522 (interactive "P")
16523 (or
16524 (org-clock-update-time-maybe)
16525 (save-excursion
16526 (unless (org-at-date-range-p t)
16527 (goto-char (point-at-bol))
16528 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16529 (if (not (org-at-date-range-p t))
16530 (error "Not at a time-stamp range, and none found in current line")))
16531 (let* ((ts1 (match-string 1))
16532 (ts2 (match-string 2))
16533 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16534 (match-end (match-end 0))
16535 (time1 (org-time-string-to-time ts1))
16536 (time2 (org-time-string-to-time ts2))
16537 (t1 (org-float-time time1))
16538 (t2 (org-float-time time2))
16539 (diff (abs (- t2 t1)))
16540 (negative (< (- t2 t1) 0))
16541 ;; (ys (floor (* 365 24 60 60)))
16542 (ds (* 24 60 60))
16543 (hs (* 60 60))
16544 (fy "%dy %dd %02d:%02d")
16545 (fy1 "%dy %dd")
16546 (fd "%dd %02d:%02d")
16547 (fd1 "%dd")
16548 (fh "%02d:%02d")
16549 y d h m align)
16550 (if havetime
16551 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16552 y 0
16553 d (floor (/ diff ds)) diff (mod diff ds)
16554 h (floor (/ diff hs)) diff (mod diff hs)
16555 m (floor (/ diff 60)))
16556 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16557 y 0
16558 d (floor (+ (/ diff ds) 0.5))
16559 h 0 m 0))
16560 (if (not to-buffer)
16561 (message "%s" (org-make-tdiff-string y d h m))
16562 (if (org-at-table-p)
16563 (progn
16564 (goto-char match-end)
16565 (setq align t)
16566 (and (looking-at " *|") (goto-char (match-end 0))))
16567 (goto-char match-end))
16568 (if (looking-at
16570 (replace-match ""))
16571 (if negative (insert " -"))
16572 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16573 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16574 (insert " " (format fh h m))))
16575 (if align (org-table-align))
16576 (message "Time difference inserted")))))
16578 (defun org-make-tdiff-string (y d h m)
16579 (let ((fmt "")
16580 (l nil))
16581 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16582 l (push y l)))
16583 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16584 l (push d l)))
16585 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16586 l (push h l)))
16587 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16588 l (push m l)))
16589 (apply 'format fmt (nreverse l))))
16591 (defun org-time-string-to-time (s &optional buffer pos)
16592 "Convert a timestamp string into internal time."
16593 (condition-case errdata
16594 (apply 'encode-time (org-parse-time-string s))
16596 s (if (not (and buffer pos))
16597 ""
16598 (format " at %d in buffer `%s'" pos buffer))
16599 (cdr errdata)))))
16601 (defun org-time-string-to-seconds (s)
16602 "Convert a timestamp string to a number of seconds."
16603 (org-float-time (org-time-string-to-time s)))
16605 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16606 "Convert a time stamp to an absolute day number.
16607 If there is a specifier for a cyclic time stamp, get the closest
16608 date to DAYNR.
16609 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16610 The variable date is bound by the calendar when this is called."
16611 (cond
16613 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16614 daynr
16615 (+ daynr 1000)))
16617 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16618 (time-to-days (current-time))) (match-string 0 s)
16619 prefer show-all))
16620 (t (time-to-days
16621 (condition-case errdata
16622 (apply 'encode-time (org-parse-time-string s))
16624 s (if (not (and buffer pos))
16625 ""
16626 (format " at %d in buffer `%s'" pos buffer))
16627 (cdr errdata))))))))
16629 (defun org-days-to-iso-week (days)
16630 "Return the iso week number."
16631 (require 'cal-iso)
16632 (car (calendar-iso-from-absolute days)))
16634 (defun org-small-year-to-year (year)
16635 "Convert 2-digit years into 4-digit years.
16636 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16637 The year 2000 cannot be abbreviated. Any year larger than 99
16638 is returned unchanged."
16639 (if (< year 38)
16640 (setq year (+ 2000 year))
16641 (if (< year 100)
16642 (setq year (+ 1900 year))))
16643 year)
16645 (defun org-time-from-absolute (d)
16646 "Return the time corresponding to date D.
16647 D may be an absolute day number, or a calendar-type list (month day year)."
16648 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16649 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16651 (defun org-calendar-holiday ()
16652 "List of holidays, for Diary display in Org-mode."
16653 (require 'holidays)
16654 (let ((hl (funcall
16655 (if (fboundp 'calendar-check-holidays)
16656 'calendar-check-holidays 'check-calendar-holidays) date)))
16657 (if hl (mapconcat 'identity hl "; "))))
16659 (defun org-diary-sexp-entry (sexp entry date)
16660 "Process a SEXP diary ENTRY for DATE."
16661 (require 'diary-lib)
16662 (let ((result (if calendar-debug-sexp
16663 (let ((stack-trace-on-error t))
16664 (eval (car (read-from-string sexp))))
16665 (condition-case nil
16666 (eval (car (read-from-string sexp)))
16667 (error
16668 (beep)
16669 (message "Bad sexp at line %d in %s: %s"
16670 (org-current-line)
16671 (buffer-file-name) sexp)
16672 (sleep-for 2))))))
16673 (cond ((stringp result) (split-string result "; "))
16674 ((and (consp result)
16675 (not (consp (cdr result)))
16676 (stringp (cdr result))) (cdr result))
16677 ((and (consp result)
16678 (stringp (car result))) result)
16679 (result entry))))
16681 (defun org-diary-to-ical-string (frombuf)
16682 "Get iCalendar entries from diary entries in buffer FROMBUF.
16683 This uses the icalendar.el library."
16684 (let* ((tmpdir (if (featurep 'xemacs)
16685 (temp-directory)
16686 temporary-file-directory))
16687 (tmpfile (make-temp-name
16688 (expand-file-name "orgics" tmpdir)))
16689 buf rtn b e)
16690 (with-current-buffer frombuf
16691 (icalendar-export-region (point-min) (point-max) tmpfile)
16692 (setq buf (find-buffer-visiting tmpfile))
16693 (set-buffer buf)
16694 (goto-char (point-min))
16695 (if (re-search-forward "^BEGIN:VEVENT" nil t)
16696 (setq b (match-beginning 0)))
16697 (goto-char (point-max))
16698 (if (re-search-backward "^END:VEVENT" nil t)
16699 (setq e (match-end 0)))
16701 (kill-buffer buf)
16702 (delete-file tmpfile)
16703 rtn))
16705 (defun org-closest-date (start current change prefer show-all)
16706 "Find the date closest to CURRENT that is consistent with START and CHANGE.
16707 When PREFER is `past', return a date that is either CURRENT or past.
16708 When PREFER is `future', return a date that is either CURRENT or future.
16709 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
16710 ;; Make the proper lists from the dates
16711 (catch 'exit
16712 (let ((a1 '(("h" . hour)
16713 ("d" . day)
16714 ("w" . week)
16715 ("m" . month)
16716 ("y" . year)))
16717 (shour (nth 2 (org-parse-time-string start)))
16718 dn dw sday cday n1 n2 n0
16719 d m y y1 y2 date1 date2 nmonths nm ny m2)
16721 (setq start (org-date-to-gregorian start)
16722 current (org-date-to-gregorian
16723 (if show-all
16724 current
16725 (time-to-days (current-time))))
16726 sday (calendar-absolute-from-gregorian start)
16727 cday (calendar-absolute-from-gregorian current))
16729 (if (<= cday sday) (throw 'exit sday))
16732 (setq dn (string-to-number (match-string 1 change))
16733 dw (cdr (assoc (match-string 2 change) a1)))
16734 (error "Invalid change specifier: %s" change))
16735 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
16736 (cond
16737 ((eq dw 'hour)
16738 (let ((missing-hours
16739 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
16740 dn)))
16741 (setq n1 (if (zerop missing-hours) cday
16742 (- cday (1+ (floor (/ missing-hours 24)))))
16743 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
16744 ((eq dw 'day)
16745 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
16746 n2 (+ n1 dn)))
16747 ((eq dw 'year)
16748 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
16749 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
16750 (setq date1 (list m d y1)
16751 n1 (calendar-absolute-from-gregorian date1)
16752 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
16753 n2 (calendar-absolute-from-gregorian date2)))
16754 ((eq dw 'month)
16755 ;; approx number of month between the two dates
16756 (setq nmonths (floor (/ (- cday sday) 30.436875)))
16757 ;; How often does dn fit in there?
16758 (setq d (nth 1 start) m (car start) y (nth 2 start)
16759 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
16760 m (+ m nm)
16761 ny (floor (/ m 12))
16762 y (+ y ny)
16763 m (- m (* ny 12)))
16764 (while (> m 12) (setq m (- m 12) y (1+ y)))
16765 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
16766 (setq m2 (+ m dn) y2 y)
16767 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16768 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
16769 (while (<= n2 cday)
16770 (setq n1 n2 m m2 y y2)
16771 (setq m2 (+ m dn) y2 y)
16772 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
16773 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
16774 ;; Make sure n1 is the earlier date
16775 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
16776 (if show-all
16777 (cond
16778 ((eq prefer 'past) (if (= cday n2) n2 n1))
16779 ((eq prefer 'future) (if (= cday n1) n1 n2))
16780 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16781 (cond
16782 ((eq prefer 'past) (if (= cday n2) n2 n1))
16783 ((eq prefer 'future) (if (= cday n1) n1 n2))
16784 (t (if (= cday n1) n1 n2)))))))
16786 (defun org-date-to-gregorian (date)
16787 "Turn any specification of DATE into a Gregorian date for the calendar."
16788 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16789 ((and (listp date) (= (length date) 3)) date)
16790 ((stringp date)
16791 (setq date (org-parse-time-string date))
16792 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16793 ((listp date)
16794 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16796 (defun org-parse-time-string (s &optional nodefault)
16797 "Parse the standard Org-mode time string.
16798 This should be a lot faster than the normal `parse-time-string'.
16799 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16800 hour and minute fields will be nil if not given."
16801 (cond ((string-match org-ts-regexp0 s)
16802 (list 0
16803 (if (or (match-beginning 8) (not nodefault))
16804 (string-to-number (or (match-string 8 s) "0")))
16805 (if (or (match-beginning 7) (not nodefault))
16806 (string-to-number (or (match-string 7 s) "0")))
16807 (string-to-number (match-string 4 s))
16808 (string-to-number (match-string 3 s))
16809 (string-to-number (match-string 2 s))
16810 nil nil nil))
16811 ((string-match "^<[^>]+>$" s)
16812 (decode-time (seconds-to-time (org-matcher-time s))))
16813 (t (error "Not a standard Org-mode time string: %s" s))))
16815 (defun org-timestamp-up (&optional arg)
16816 "Increase the date item at the cursor by one.
16817 If the cursor is on the year, change the year. If it is on the month,
16818 the day or the time, change that.
16819 With prefix ARG, change by that many units."
16820 (interactive "p")
16821 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16823 (defun org-timestamp-down (&optional arg)
16824 "Decrease the date item at the cursor by one.
16825 If the cursor is on the year, change the year. If it is on the month,
16826 the day or the time, change that.
16827 With prefix ARG, change by that many units."
16828 (interactive "p")
16829 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16831 (defun org-timestamp-up-day (&optional arg)
16832 "Increase the date in the time stamp by one day.
16833 With prefix ARG, change that many days."
16834 (interactive "p")
16835 (if (and (not (org-at-timestamp-p t))
16836 (org-at-heading-p))
16837 (org-todo 'up)
16838 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16840 (defun org-timestamp-down-day (&optional arg)
16841 "Decrease the date in the time stamp by one day.
16842 With prefix ARG, change that many days."
16843 (interactive "p")
16844 (if (and (not (org-at-timestamp-p t))
16845 (org-at-heading-p))
16846 (org-todo 'down)
16847 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16849 (defun org-at-timestamp-p (&optional inactive-ok)
16850 "Determine if the cursor is in or at a timestamp."
16851 (interactive)
16852 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16853 (pos (point))
16854 (ans (or (looking-at tsr)
16855 (save-excursion
16857 (if (> (point) (point-min)) (backward-char 1))
16858 (and (looking-at tsr)
16859 (> (- (match-end 0) pos) -1))))))
16860 (and ans
16861 (boundp 'org-ts-what)
16862 (setq org-ts-what
16863 (cond
16864 ((= pos (match-beginning 0)) 'bracket)
16865 ;; Point is considered to be "on the bracket" whether
16866 ;; it's really on it or right after it.
16867 ((= pos (1- (match-end 0))) 'bracket)
16868 ((= pos (match-end 0)) 'after)
16869 ((org-pos-in-match-range pos 2) 'year)
16870 ((org-pos-in-match-range pos 3) 'month)
16871 ((org-pos-in-match-range pos 7) 'hour)
16872 ((org-pos-in-match-range pos 8) 'minute)
16873 ((or (org-pos-in-match-range pos 4)
16874 (org-pos-in-match-range pos 5)) 'day)
16875 ((and (> pos (or (match-end 8) (match-end 5)))
16876 (< pos (match-end 0)))
16877 (- pos (or (match-end 8) (match-end 5))))
16878 (t 'day))))
16879 ans))
16881 (defun org-toggle-timestamp-type ()
16882 "Toggle the type (<active> or [inactive]) of a time stamp."
16883 (interactive)
16884 (when (org-at-timestamp-p t)
16885 (let ((beg (match-beginning 0)) (end (match-end 0))
16886 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16887 (save-excursion
16888 (goto-char beg)
16889 (while (re-search-forward "[][<>]" end t)
16890 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16891 t t)))
16892 (message "Timestamp is now %sactive"
16893 (if (equal (char-after beg) ?<) "" "in")))))
16895 (defun org-at-clock-log-p nil
16896 "Is the cursor on the clock log line?"
16897 (save-excursion
16898 (move-beginning-of-line 1)
16901 (defvar org-clock-history) ; defined in org-clock.el
16902 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
16903 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
16904 "Change the date in the time stamp at point.
16905 The date will be changed by N times WHAT. WHAT can be `day', `month',
16906 `year', `minute', `second'. If WHAT is not given, the cursor position
16907 in the timestamp determines what will be changed.
16909 (let ((origin (point)) origin-cat
16910 with-hm inactive
16911 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16912 org-ts-what
16913 extra rem
16914 ts time time0 fixnext clrgx)
16915 (if (not (org-at-timestamp-p t))
16916 (error "Not at a timestamp"))
16917 (if (and (not what) (eq org-ts-what 'bracket))
16918 (org-toggle-timestamp-type)
16919 ;; Point isn't on brackets. Remember the part of the time-stamp
16920 ;; the point was in. Indeed, size of time-stamps may change,
16921 ;; but point must be kept in the same category nonetheless.
16922 (setq origin-cat org-ts-what)
16923 (if (and (not what) (not (eq org-ts-what 'day))
16924 org-display-custom-times
16925 (get-text-property (point) 'display)
16926 (not (get-text-property (1- (point)) 'display)))
16927 (setq org-ts-what 'day))
16928 (setq org-ts-what (or what org-ts-what)
16929 inactive (= (char-after (match-beginning 0)) ?\[)
16930 ts (match-string 0))
16931 (replace-match "")
16932 (when (string-match
16933 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
16934 ts)
16935 (setq extra (match-string 1 ts))
16936 (if suppress-tmp-delay
16937 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
16939 (setq with-hm t))
16940 (setq time0 (org-parse-time-string ts))
16941 (when (and updown
16942 (eq org-ts-what 'minute)
16943 (not current-prefix-arg))
16944 ;; This looks like s-up and s-down. Change by one rounding step.
16945 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16946 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16947 (setcar (cdr time0) (+ (nth 1 time0)
16948 (if (> n 0) (- rem) (- dm rem))))))
16949 (setq time
16950 (encode-time (or (car time0) 0)
16951 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16952 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16953 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16954 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16955 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16956 (nthcdr 6 time0)))
16957 (when (and (member org-ts-what '(hour minute))
16958 extra
16960 (setq extra (org-modify-ts-extra
16961 extra
16962 (if (eq org-ts-what 'hour) 2 5)
16963 n dm)))
16964 (when (integerp org-ts-what)
16965 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16966 (if (eq what 'calendar)
16967 (let ((cal-date (org-get-date-from-calendar)))
16968 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16969 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16970 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16971 (setcar time0 (or (car time0) 0))
16972 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16973 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16974 (setq time (apply 'encode-time time0))))
16975 ;; Insert the new time-stamp, and ensure point stays in the same
16976 ;; category as before (i.e. not after the last position in that
16977 ;; category).
16978 (let ((pos (point)))
16979 ;; Stay before inserted string. `save-excursion' is of no use.
16980 (setq org-last-changed-timestamp
16981 (org-insert-time-stamp time with-hm inactive nil nil extra))
16982 (goto-char pos))
16983 (save-match-data
16984 (looking-at org-ts-regexp3)
16985 (goto-char (cond
16986 ;; `day' category ends before `hour' if any, or at
16987 ;; the end of the day name.
16988 ((eq origin-cat 'day)
16989 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16990 ((eq origin-cat 'hour) (min (match-end 7) origin))
16991 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16992 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16993 ;; `year' and `month' have both fixed size: point
16994 ;; couldn't have moved into another part.
16995 (t origin))))
16996 ;; Update clock if on a CLOCK line.
16997 (org-clock-update-time-maybe)
16998 ;; Maybe adjust the closest clock in `org-clock-history'
16999 (when org-clock-adjust-closest
17000 (if (not (and (org-at-clock-log-p)
17001 (< 1 (length (delq nil (mapcar (lambda(m) (marker-position m))
17002 org-clock-history))))))
17003 (message "No clock to adjust")
17004 (cond ((save-excursion ; fix previous clock?
17005 (re-search-backward org-ts-regexp0 nil t)
17008 ((save-excursion ; fix next clock?
17009 (re-search-backward org-ts-regexp0 nil t)
17012 (save-window-excursion
17013 ;; Find closest clock to point, adjust the previous/next one in history
17014 (let* ((p (save-excursion (org-back-to-heading t)))
17015 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17016 (clfixnth
17017 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17018 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17019 (if (not clfixpos)
17020 (message "No clock to adjust")
17021 (save-excursion
17022 (org-goto-marker-or-bmk clfixpos)
17023 (org-show-subtree)
17024 (when (re-search-forward clrgx nil t)
17025 (goto-char (match-beginning 1))
17026 (let (org-clock-adjust-closest)
17027 (org-timestamp-change n org-ts-what updown))
17028 (message "Clock adjusted in %s for heading: %s"
17029 (file-name-nondirectory (buffer-file-name))
17030 (org-get-heading t t)))))))))
17031 ;; Try to recenter the calendar window, if any.
17032 (if (and org-calendar-follow-timestamp-change
17033 (get-buffer-window "*Calendar*" t)
17034 (memq org-ts-what '(day month year)))
17035 (org-recenter-calendar (time-to-days time))))))
17037 (defun org-modify-ts-extra (s pos n dm)
17038 "Change the different parts of the lead-time and repeat fields in timestamp."
17039 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17040 ng h m new rem)
17041 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17042 (cond
17043 ((or (org-pos-in-match-range pos 2)
17044 (org-pos-in-match-range pos 3))
17045 (setq m (string-to-number (match-string 3 s))
17046 h (string-to-number (match-string 2 s)))
17047 (if (org-pos-in-match-range pos 2)
17048 (setq h (+ h n))
17049 (setq n (* dm (org-no-warnings (signum n))))
17050 (when (not (= 0 (setq rem (% m dm))))
17051 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17052 (setq m (+ m n)))
17053 (if (< m 0) (setq m (+ m 60) h (1- h)))
17054 (if (> m 59) (setq m (- m 60) h (1+ h)))
17055 (setq h (min 24 (max 0 h)))
17056 (setq ng 1 new (format "-%02d:%02d" h m)))
17057 ((org-pos-in-match-range pos 6)
17058 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17059 ((org-pos-in-match-range pos 5)
17060 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17062 ((org-pos-in-match-range pos 9)
17063 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17064 ((org-pos-in-match-range pos 8)
17065 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17067 (when ng
17068 (setq s (concat
17069 (substring s 0 (match-beginning ng))
17070 new
17071 (substring s (match-end ng))))))
17072 s))
17074 (defun org-recenter-calendar (date)
17075 "If the calendar is visible, recenter it to DATE."
17076 (let ((cwin (get-buffer-window "*Calendar*" t)))
17077 (when cwin
17078 (let ((calendar-move-hook nil))
17079 (with-selected-window cwin
17080 (calendar-goto-date (if (listp date) date
17081 (calendar-gregorian-from-absolute date))))))))
17083 (defun org-goto-calendar (&optional arg)
17084 "Go to the Emacs calendar at the current date.
17085 If there is a time stamp in the current line, go to that date.
17086 A prefix ARG can be used to force the current date."
17087 (interactive "P")
17088 (let ((tsr org-ts-regexp) diff
17089 (calendar-move-hook nil)
17090 (calendar-view-holidays-initially-flag nil)
17091 (calendar-view-diary-initially-flag nil))
17092 (if (or (org-at-timestamp-p)
17093 (save-excursion
17094 (beginning-of-line 1)
17095 (looking-at (concat ".*" tsr))))
17096 (let ((d1 (time-to-days (current-time)))
17097 (d2 (time-to-days
17098 (org-time-string-to-time (match-string 1)))))
17099 (setq diff (- d2 d1))))
17100 (calendar)
17101 (calendar-goto-today)
17102 (if (and diff (not arg)) (calendar-forward-day diff))))
17104 (defun org-get-date-from-calendar ()
17105 "Return a list (month day year) of date at point in calendar."
17106 (with-current-buffer "*Calendar*"
17107 (save-match-data
17108 (calendar-cursor-to-date))))
17110 (defun org-date-from-calendar ()
17111 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17112 If there is already a time stamp at the cursor position, update it."
17113 (interactive)
17114 (if (org-at-timestamp-p t)
17115 (org-timestamp-change 0 'calendar)
17116 (let ((cal-date (org-get-date-from-calendar)))
17117 (org-insert-time-stamp
17118 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17120 (defcustom org-effort-durations
17121 `(("h" . 60)
17122 ("d" . ,(* 60 8))
17123 ("w" . ,(* 60 8 5))
17124 ("m" . ,(* 60 8 5 4))
17125 ("y" . ,(* 60 8 5 40)))
17126 "Conversion factor to minutes for an effort modifier.
17128 Each entry has the form (MODIFIER . MINUTES).
17130 In an effort string, a number followed by MODIFIER is multiplied
17131 by the specified number of MINUTES to obtain an effort in
17132 minutes.
17136 :group 'org-agenda
17137 :version "24.1"
17138 :type '(alist :key-type (string :tag "Modifier")
17139 :value-type (number :tag "Minutes")))
17141 (defun org-minutes-to-clocksum-string (m)
17142 "Format number of minutes as a clocksum string.
17143 The format is determined by `org-time-clocksum-format',
17144 `org-time-clocksum-use-fractional' and
17145 `org-time-clocksum-fractional-format' and
17146 `org-time-clocksum-use-effort-durations'."
17147 (let ((clocksum "") h d w mo y fmt n)
17148 (setq h (if org-time-clocksum-use-effort-durations
17149 (cdr (assoc "h" org-effort-durations)) 60)
17150 d (if org-time-clocksum-use-effort-durations
17151 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17152 w (if org-time-clocksum-use-effort-durations
17153 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17154 mo (if org-time-clocksum-use-effort-durations
17155 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17156 y (if org-time-clocksum-use-effort-durations
17157 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17158 ;; fractional format
17159 (if org-time-clocksum-use-fractional
17160 (cond
17161 ;; single format string
17162 ((stringp org-time-clocksum-fractional-format)
17163 (format org-time-clocksum-fractional-format (/ m (float h))))
17164 ;; choice of fractional formats for different time units
17165 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17166 (> (/ (truncate m) (* y d h)) 0))
17167 (format fmt (/ m (* y d (float h)))))
17168 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17169 (> (/ (truncate m) (* mo d h)) 0))
17170 (format fmt (/ m (* mo d (float h)))))
17171 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17172 (> (/ (truncate m) (* w d h)) 0))
17173 (format fmt (/ m (* w d (float h)))))
17174 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17175 (> (/ (truncate m) (* d h)) 0))
17176 (format fmt (/ m (* d (float h)))))
17177 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17178 (> (/ (truncate m) h) 0))
17179 (format fmt (/ m (float h))))
17180 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17181 (format fmt m))
17182 ;; fall back to smallest time unit with a format
17183 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17184 (format fmt (/ m (float h))))
17185 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17186 (format fmt (/ m (* d (float h)))))
17187 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17188 (format fmt (/ m (* w d (float h)))))
17189 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17190 (format fmt (/ m (* mo d (float h)))))
17191 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17192 (format fmt (/ m (* y d (float h))))))
17193 ;; standard (non-fractional) format, with single format string
17194 (if (stringp org-time-clocksum-format)
17195 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17196 ;; separate formats components
17197 (and (setq fmt (plist-get org-time-clocksum-format :years))
17198 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17199 (plist-get org-time-clocksum-format :require-years))
17200 (setq clocksum (concat clocksum (format fmt n))
17201 m (- m (* n y d h))))
17202 (and (setq fmt (plist-get org-time-clocksum-format :months))
17203 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17204 (plist-get org-time-clocksum-format :require-months))
17205 (setq clocksum (concat clocksum (format fmt n))
17206 m (- m (* n mo d h))))
17207 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17208 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17209 (plist-get org-time-clocksum-format :require-weeks))
17210 (setq clocksum (concat clocksum (format fmt n))
17211 m (- m (* n w d h))))
17212 (and (setq fmt (plist-get org-time-clocksum-format :days))
17213 (or (> (setq n (/ (truncate m) (* d h))) 0)
17214 (plist-get org-time-clocksum-format :require-days))
17215 (setq clocksum (concat clocksum (format fmt n))
17216 m (- m (* n d h))))
17217 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17218 (or (> (setq n (/ (truncate m) h)) 0)
17219 (plist-get org-time-clocksum-format :require-hours))
17220 (setq clocksum (concat clocksum (format fmt n))
17221 m (- m (* n h))))
17222 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17223 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17224 (setq clocksum (concat clocksum (format fmt m))))
17225 ;; return formatted time duration
17226 clocksum))))
17228 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17229 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17230 "Org mode version 8.0")
17232 (defun org-hours-to-clocksum-string (n)
17233 (org-minutes-to-clocksum-string (* n 60)))
17235 (defun org-hh:mm-string-to-minutes (s)
17236 "Convert a string H:MM to a number of minutes.
17237 If the string is just a number, interpret it as minutes.
17238 In fact, the first hh:mm or number in the string will be taken,
17239 there can be extra stuff in the string.
17240 If no number is found, the return value is 0."
17241 (cond
17242 ((integerp s) s)
17244 (+ (* (string-to-number (match-string 1 s)) 60)
17245 (string-to-number (match-string 2 s))))
17247 (string-to-number (match-string 1 s)))
17248 (t 0)))
17250 (defcustom org-image-actual-width t
17251 "Should we use the actual width of images when inlining them?
17253 When set to `t', always use the image width.
17255 When set to a number, use imagemagick (when available) to set
17256 the image's width to this value.
17258 When set to a number in a list, try to get the width from the
17259 #+ATTR.* keyword if it matches a width specification like
17262 When set to nil, try to get the width from an #+ATTR.* keyword
17263 and fall back on the original width if none is found.
17265 This requires Emacs >= 24.1, build with imagemagick support."
17266 :group 'org-appearance
17267 :version "24.4"
17268 :package-version '(Org . "8.0")
17269 :type '(choice
17270 (const :tag "Use the image width" t)
17271 (integer :tag "Use a number of pixels")
17272 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17273 (const :tag "Use #+ATTR* or don't resize" nil)))
17275 (defcustom org-agenda-inhibit-startup t
17276 "Inhibit startup when preparing agenda buffers.
17277 When this variable is `t' (the default), the initialization of
17278 the Org agenda buffers is inhibited: e.g. the visibility state
17279 is not set, the tables are not re-aligned, etc."
17280 :type 'boolean
17281 :version "24.3"
17282 :group 'org-agenda)
17284 (defun org-duration-string-to-minutes (s &optional output-to-string)
17285 "Convert a duration string S to minutes.
17287 A bare number is interpreted as minutes, modifiers can be set by
17288 customizing `org-effort-durations' (which see).
17290 Entries containing a colon are interpreted as H:MM by
17291 `org-hh:mm-string-to-minutes'."
17292 (let ((result 0)
17294 (regexp-opt (mapcar 'car org-effort-durations))
17296 (while (string-match re s)
17297 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17298 (string-to-number (match-string 1 s))))
17299 (setq s (replace-match "" nil t s)))
17300 (setq result (floor result))
17301 (incf result (org-hh:mm-string-to-minutes s))
17302 (if output-to-string (number-to-string result) result)))
17304 ;;;; Files
17306 (defun org-save-all-org-buffers ()
17307 "Save all Org-mode buffers without user confirmation."
17308 (interactive)
17309 (message "Saving all Org-mode buffers...")
17310 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17311 (when (featurep 'org-id) (org-id-locations-save))
17312 (message "Saving all Org-mode buffers... done"))
17314 (defun org-revert-all-org-buffers ()
17315 "Revert all Org-mode buffers.
17316 Prompt for confirmation when there are unsaved changes.
17317 Be sure you know what you are doing before letting this function
17318 overwrite your changes.
17320 This function is useful in a setup where one tracks org files
17321 with a version control system, to revert on one machine after pulling
17322 changes from another. I believe the procedure must be like this:
17324 1. M-x org-save-all-org-buffers
17325 2. Pull changes from the other machine, resolve conflicts
17326 3. M-x org-revert-all-org-buffers"
17327 (interactive)
17328 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17329 (error "Abort"))
17330 (save-excursion
17331 (save-window-excursion
17332 (mapc
17333 (lambda (b)
17334 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17335 (with-current-buffer b buffer-file-name))
17336 (org-pop-to-buffer-same-window b)
17337 (revert-buffer t 'no-confirm)))
17338 (buffer-list))
17339 (when (and (featurep 'org-id) org-id-track-globally)
17340 (org-id-locations-load)))))
17342 ;;;; Agenda files
17344 ;;;###autoload
17345 (defun org-switchb (&optional arg)
17346 "Switch between Org buffers.
17347 With one prefix argument, restrict available buffers to files.
17348 With two prefix arguments, restrict available buffers to agenda files.
17350 Defaults to `iswitchb' for buffer name completion.
17351 Set `org-completion-use-ido' to make it use ido instead."
17352 (interactive "P")
17353 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17354 ((equal arg '(16)) (org-buffer-list 'agenda))
17355 (t (org-buffer-list))))
17356 (org-completion-use-iswitchb org-completion-use-iswitchb)
17357 (org-completion-use-ido org-completion-use-ido))
17358 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17359 (setq org-completion-use-iswitchb t))
17360 (org-pop-to-buffer-same-window
17361 (org-icompleting-read "Org buffer: "
17362 (mapcar 'list (mapcar 'buffer-name blist))
17363 nil t))))
17365 ;;; Define some older names previously used for this functionality
17366 ;;;###autoload
17367 (defalias 'org-ido-switchb 'org-switchb)
17368 ;;;###autoload
17369 (defalias 'org-iswitchb 'org-switchb)
17371 (defun org-buffer-list (&optional predicate exclude-tmp)
17372 "Return a list of Org buffers.
17373 PREDICATE can be `export', `files' or `agenda'.
17375 export restrict the list to Export buffers.
17376 files restrict the list to buffers visiting Org files.
17377 agenda restrict the list to buffers visiting agenda files.
17379 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17380 (let* ((bfn nil)
17381 (agenda-files (and (eq predicate 'agenda)
17382 (mapcar 'file-truename (org-agenda-files t))))
17383 (filter
17384 (cond
17385 ((eq predicate 'files)
17386 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17387 ((eq predicate 'export)
17388 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17389 ((eq predicate 'agenda)
17390 (lambda (b)
17391 (with-current-buffer b
17392 (and (derived-mode-p 'org-mode)
17393 (setq bfn (buffer-file-name b))
17394 (member (file-truename bfn) agenda-files)))))
17395 (t (lambda (b) (with-current-buffer b
17396 (or (derived-mode-p 'org-mode)
17397 (string-match "\*Org .*Export"
17398 (buffer-name b)))))))))
17399 (delq nil
17400 (mapcar
17401 (lambda(b)
17402 (if (and (funcall filter b)
17403 (or (not exclude-tmp)
17404 (not (string-match "tmp" (buffer-name b)))))
17405 b
17406 nil))
17407 (buffer-list)))))
17409 (defun org-agenda-files (&optional unrestricted archives)
17410 "Get the list of agenda files.
17411 Optional UNRESTRICTED means return the full list even if a restriction
17412 is currently in place.
17413 When ARCHIVES is t, include all archive files that are really being
17414 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17415 `org-agenda-archives-mode' is t."
17416 (let ((files
17417 (cond
17418 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17419 ((stringp org-agenda-files) (org-read-agenda-file-list))
17420 ((listp org-agenda-files) org-agenda-files)
17421 (t (error "Invalid value of `org-agenda-files'")))))
17422 (setq files (apply 'append
17423 (mapcar (lambda (f)
17424 (if (file-directory-p f)
17425 (directory-files
17426 f t org-agenda-file-regexp)
17427 (list f)))
17428 files)))
17429 (when org-agenda-skip-unavailable-files
17430 (setq files (delq nil
17431 (mapcar (function
17432 (lambda (file)
17433 (and (file-readable-p file) file)))
17434 files))))
17435 (when (or (eq archives t)
17436 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17437 (setq files (org-add-archive-files files)))
17438 files))
17440 (defun org-agenda-file-p (&optional file)
17441 "Return non-nil, if FILE is an agenda file.
17442 If FILE is omitted, use the file associated with the current
17443 buffer."
17444 (member (or file (buffer-file-name))
17445 (org-agenda-files t)))
17447 (defun org-edit-agenda-file-list ()
17448 "Edit the list of agenda files.
17449 Depending on setup, this either uses customize to edit the variable
17450 `org-agenda-files', or it visits the file that is holding the list. In the
17451 latter case, the buffer is set up in a way that saving it automatically kills
17452 the buffer and restores the previous window configuration."
17453 (interactive)
17454 (if (stringp org-agenda-files)
17455 (let ((cw (current-window-configuration)))
17456 (find-file org-agenda-files)
17457 (org-set-local 'org-window-configuration cw)
17458 (org-add-hook 'after-save-hook
17459 (lambda ()
17460 (set-window-configuration
17461 (prog1 org-window-configuration
17462 (kill-buffer (current-buffer))))
17463 (org-install-agenda-files-menu)
17464 (message "New agenda file list installed"))
17465 nil 'local)
17466 (message "%s" (substitute-command-keys
17468 (customize-variable 'org-agenda-files)))
17470 (defun org-store-new-agenda-file-list (list)
17471 "Set new value for the agenda file list and save it correctly."
17472 (if (stringp org-agenda-files)
17473 (let ((fe (org-read-agenda-file-list t)) b u)
17474 (while (setq b (find-buffer-visiting org-agenda-files))
17475 (kill-buffer b))
17476 (with-temp-file org-agenda-files
17477 (insert
17478 (mapconcat
17479 (lambda (f) ;; Keep un-expanded entries.
17480 (if (setq u (assoc f fe))
17481 (cdr u)
17482 f))
17485 (let ((org-mode-hook nil) (org-inhibit-startup t)
17486 (org-insert-mode-line-in-empty-file nil))
17487 (setq org-agenda-files list)
17488 (customize-save-variable 'org-agenda-files org-agenda-files))))
17490 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17491 "Read the list of agenda files from a file.
17492 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17493 filenames, used by `org-store-new-agenda-file-list' to write back
17494 un-expanded file names."
17495 (when (file-directory-p org-agenda-files)
17496 (error "`org-agenda-files' cannot be a single directory"))
17497 (when (stringp org-agenda-files)
17498 (with-temp-buffer
17499 (insert-file-contents org-agenda-files)
17500 (mapcar
17501 (lambda (f)
17502 (let ((e (expand-file-name (substitute-in-file-name f)
17503 org-directory)))
17504 (if pair-with-expansion
17505 (cons e f)
17506 e)))
17509 ;;;###autoload
17510 (defun org-cycle-agenda-files ()
17511 "Cycle through the files in `org-agenda-files'.
17512 If the current buffer visits an agenda file, find the next one in the list.
17513 If the current buffer does not, find the first agenda file."
17514 (interactive)
17515 (let* ((fs (org-agenda-files t))
17516 (files (append fs (list (car fs))))
17517 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17518 file)
17519 (unless files (error "No agenda files"))
17520 (catch 'exit
17521 (while (setq file (pop files))
17522 (if (equal (file-truename file) tcf)
17523 (when (car files)
17524 (find-file (car files))
17525 (throw 'exit t))))
17526 (find-file (car fs)))
17527 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17529 (defun org-agenda-file-to-front (&optional to-end)
17530 "Move/add the current file to the top of the agenda file list.
17531 If the file is not present in the list, it is added to the front. If it is
17532 present, it is moved there. With optional argument TO-END, add/move to the
17533 end of the list."
17534 (interactive "P")
17535 (let ((org-agenda-skip-unavailable-files nil)
17536 (file-alist (mapcar (lambda (x)
17537 (cons (file-truename x) x))
17538 (org-agenda-files t)))
17539 (ctf (file-truename
17540 (or buffer-file-name
17541 (error "Please save the current buffer to a file"))))
17542 x had)
17543 (setq x (assoc ctf file-alist) had x)
17545 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17546 (if to-end
17547 (setq file-alist (append (delq x file-alist) (list x)))
17548 (setq file-alist (cons x (delq x file-alist))))
17549 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17550 (org-install-agenda-files-menu)
17551 (message "File %s to %s of agenda file list"
17552 (if had "moved" "added") (if to-end "end" "front"))))
17554 (defun org-remove-file (&optional file)
17555 "Remove current file from the list of files in variable `org-agenda-files'.
17556 These are the files which are being checked for agenda entries.
17557 Optional argument FILE means use this file instead of the current."
17558 (interactive)
17559 (let* ((org-agenda-skip-unavailable-files nil)
17560 (file (or file buffer-file-name
17561 (error "Current buffer does not visit a file")))
17562 (true-file (file-truename file))
17563 (afile (abbreviate-file-name file))
17564 (files (delq nil (mapcar
17565 (lambda (x)
17566 (if (equal true-file
17567 (file-truename x))
17568 nil x))
17569 (org-agenda-files t)))))
17570 (if (not (= (length files) (length (org-agenda-files t))))
17571 (progn
17572 (org-store-new-agenda-file-list files)
17573 (org-install-agenda-files-menu)
17574 (message "Removed file: %s" afile))
17575 (message "File was not in list: %s (not removed)" afile))))
17577 (defun org-file-menu-entry (file)
17578 (vector file (list 'find-file file) t))
17580 (defun org-check-agenda-file (file)
17581 "Make sure FILE exists. If not, ask user what to do."
17582 (when (not (file-exists-p file))
17583 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17584 (abbreviate-file-name file))
17585 (let ((r (downcase (read-char-exclusive))))
17586 (cond
17587 ((equal r ?r)
17588 (org-remove-file file)
17589 (throw 'nextfile t))
17590 (t (error "Abort"))))))
17592 (defun org-get-agenda-file-buffer (file)
17593 "Get a buffer visiting FILE. If the buffer needs to be created, add
17594 it to the list of buffers which might be released later."
17595 (let ((buf (org-find-base-buffer-visiting file)))
17596 (if buf
17597 buf ; just return it
17598 ;; Make a new buffer and remember it
17599 (setq buf (find-file-noselect file))
17600 (if buf (push buf org-agenda-new-buffers))
17601 buf)))
17603 (defun org-release-buffers (blist)
17604 "Release all buffers in list, asking the user for confirmation when needed.
17605 When a buffer is unmodified, it is just killed. When modified, it is saved
17606 \(if the user agrees) and then killed."
17607 (let (buf file)
17608 (while (setq buf (pop blist))
17609 (setq file (buffer-file-name buf))
17610 (when (and (buffer-modified-p buf)
17611 file
17612 (y-or-n-p (format "Save file %s? " file)))
17613 (with-current-buffer buf (save-buffer)))
17614 (kill-buffer buf))))
17616 (defun org-agenda-prepare-buffers (files)
17617 "Create buffers for all agenda files, protect archived trees and comments."
17618 (interactive)
17619 (let ((pa '(:org-archived t))
17620 (pc '(:org-comment t))
17621 (pall '(:org-archived t :org-comment t))
17622 (inhibit-read-only t)
17623 (org-inhibit-startup org-agenda-inhibit-startup)
17624 (rea (concat ":" org-archive-tag ":"))
17625 file re)
17626 (save-excursion
17627 (save-restriction
17628 (while (setq file (pop files))
17629 (catch 'nextfile
17630 (if (bufferp file)
17631 (set-buffer file)
17632 (org-check-agenda-file file)
17633 (set-buffer (org-get-agenda-file-buffer file)))
17634 (widen)
17635 (org-refresh-category-properties)
17636 (org-refresh-properties org-effort-property 'org-effort)
17637 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
17638 (setq org-todo-keywords-for-agenda
17639 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17640 (setq org-done-keywords-for-agenda
17641 (append org-done-keywords-for-agenda org-done-keywords))
17642 (setq org-todo-keyword-alist-for-agenda
17643 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17644 (setq org-drawers-for-agenda
17645 (append org-drawers-for-agenda org-drawers))
17646 (setq org-tag-alist-for-agenda
17647 (append org-tag-alist-for-agenda org-tag-alist))
17648 (org-with-silent-modifications
17649 (save-excursion
17650 (remove-text-properties (point-min) (point-max) pall)
17651 (when org-agenda-skip-archived-trees
17652 (goto-char (point-min))
17653 (while (re-search-forward rea nil t)
17654 (if (org-at-heading-p t)
17655 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17656 (goto-char (point-min))
17657 (setq re (format org-heading-keyword-regexp-format
17658 org-comment-string))
17659 (while (re-search-forward re nil t)
17660 (add-text-properties
17661 (match-beginning 0) (org-end-of-subtree t) pc))))))))
17662 (setq org-todo-keywords-for-agenda
17663 (org-uniquify org-todo-keywords-for-agenda))
17664 (setq org-todo-keyword-alist-for-agenda
17665 (org-uniquify org-todo-keyword-alist-for-agenda)
17666 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
17668 \f
17669 ;;;; CDLaTeX minor mode
17671 (defvar org-cdlatex-mode-map (make-sparse-keymap)
17672 "Keymap for the minor `org-cdlatex-mode'.")
17674 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
17675 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
17676 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
17677 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
17678 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
17680 (defvar org-cdlatex-texmathp-advice-is-done nil
17681 "Flag remembering if we have applied the advice to texmathp already.")
17683 (define-minor-mode org-cdlatex-mode
17684 "Toggle the minor `org-cdlatex-mode'.
17685 This mode supports entering LaTeX environment and math in LaTeX fragments
17686 in Org-mode.
17688 nil " OCDL" nil
17689 (when org-cdlatex-mode
17690 (require 'cdlatex)
17691 (run-hooks 'cdlatex-mode-hook)
17692 (cdlatex-compute-tables))
17693 (unless org-cdlatex-texmathp-advice-is-done
17694 (setq org-cdlatex-texmathp-advice-is-done t)
17695 (defadvice texmathp (around org-math-always-on activate)
17696 "Always return t in org-mode buffers.
17697 This is because we want to insert math symbols without dollars even outside
17698 the LaTeX math segments. If Orgmode thinks that point is actually inside
17699 an embedded LaTeX fragment, let texmathp do its job.
17701 (interactive)
17702 (let (p)
17703 (cond
17704 ((not (derived-mode-p 'org-mode)) ad-do-it)
17705 ((eq this-command 'cdlatex-math-symbol)
17706 (setq ad-return-value t
17707 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
17708 (t
17709 (let ((p (org-inside-LaTeX-fragment-p)))
17710 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
17711 (setq ad-return-value t
17712 texmathp-why '("Org-mode embedded math" . 0))
17713 (if p ad-do-it)))))))))
17715 (defun turn-on-org-cdlatex ()
17716 "Unconditionally turn on `org-cdlatex-mode'."
17717 (org-cdlatex-mode 1))
17719 (defun org-try-cdlatex-tab ()
17720 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17721 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17722 - inside a LaTeX fragment, or
17723 - after the first word in a line, where an abbreviation expansion could
17724 insert a LaTeX environment."
17725 (when org-cdlatex-mode
17726 (cond
17727 ;; Before any word on the line: No expansion possible.
17729 ;; Just after first word on the line: Expand it. Make sure it
17730 ;; cannot happen on headlines, though.
17731 ((save-excursion
17732 (skip-chars-backward "a-zA-Z0-9*")
17734 (and (bolp) (not (org-at-heading-p))))
17735 (cdlatex-tab) t)
17736 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
17738 (defun org-cdlatex-underscore-caret (&optional arg)
17739 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17740 Revert to the normal definition outside of these fragments."
17741 (interactive "P")
17742 (if (org-inside-LaTeX-fragment-p)
17743 (call-interactively 'cdlatex-sub-superscript)
17744 (let (org-cdlatex-mode)
17745 (call-interactively (key-binding (vector last-input-event))))))
17747 (defun org-cdlatex-math-modify (&optional arg)
17748 "Execute `cdlatex-math-modify' in LaTeX fragments.
17749 Revert to the normal definition outside of these fragments."
17750 (interactive "P")
17751 (if (org-inside-LaTeX-fragment-p)
17752 (call-interactively 'cdlatex-math-modify)
17753 (let (org-cdlatex-mode)
17754 (call-interactively (key-binding (vector last-input-event))))))
17757 \f
17758 ;;;; LaTeX fragments
17760 (defvar org-latex-regexps
17762 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17765 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
17769 "Regular expressions for matching embedded LaTeX.")
17771 (defun org-inside-LaTeX-fragment-p ()
17772 "Test if point is inside a LaTeX fragment.
17774 sequence appearing also before point.
17775 Even though the matchers for math are configurable, this function assumes
17777 delimiters are skipped when they have been removed by customization.
17778 The return value is nil, or a cons cell with the delimiter and the
17779 position of this delimiter.
17781 This function does a reasonably good job, but can locally be fooled by
17782 for example currency specifications. For example it will assume being in
17784 fragments that are properly closed, but during editing, we have to live
17785 with the uncertainty caused by missing closing delimiters. This function
17786 looks only before point, not after."
17787 (catch 'exit
17788 (let ((pos (point))
17789 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
17790 (lim (progn
17792 (point)))
17793 dd-on str (start 0) m re)
17794 (goto-char pos)
17795 (when dodollar
17797 re (nth 1 (assoc "$" org-latex-regexps)))
17798 (while (string-match re str start)
17799 (cond
17800 ((= (match-end 0) (length str))
17801 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
17802 ((= (match-end 0) (- (length str) 5))
17803 (throw 'exit nil))
17804 (t (setq start (match-end 0))))))
17805 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17806 (goto-char pos)
17807 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
17808 (and (match-beginning 2) (throw 'exit nil))
17809 ;; count $$
17811 (setq dd-on (not dd-on)))
17812 (goto-char pos)
17813 (if dd-on (cons "$$" m))))))
17815 (defun org-inside-latex-macro-p ()
17816 "Is point inside a LaTeX macro or its arguments?"
17817 (save-match-data
17818 (org-in-regexp
17821 (defvar org-latex-fragment-image-overlays nil
17822 "List of overlays carrying the images of latex fragments.")
17823 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
17825 (defun org-remove-latex-fragment-image-overlays ()
17826 "Remove all overlays with LaTeX fragment images in current buffer."
17827 (mapc 'delete-overlay org-latex-fragment-image-overlays)
17828 (setq org-latex-fragment-image-overlays nil))
17830 (defun org-preview-latex-fragment (&optional subtree)
17831 "Preview the LaTeX fragment at point, or all locally or globally.
17832 If the cursor is in a LaTeX fragment, create the image and overlay
17833 it over the source code. If there is no fragment at point, display
17834 all fragments in the current text, from one headline to the next. With
17835 prefix SUBTREE, display all fragments in the current subtree. With a
17837 the cursor is before the first headline,
17838 display all fragments in the buffer.
17840 (interactive "P")
17841 (unless buffer-file-name
17842 (error "Can't preview LaTeX fragment in a non-file buffer"))
17843 (org-remove-latex-fragment-image-overlays)
17844 (save-excursion
17845 (save-restriction
17846 (let (beg end at msg)
17847 (cond
17848 ((or (equal subtree '(16))
17849 (not (save-excursion
17850 (re-search-backward org-outline-regexp-bol nil t))))
17851 (setq beg (point-min) end (point-max)
17852 msg "Creating images for buffer...%s"))
17853 ((equal subtree '(4))
17854 (org-back-to-heading)
17855 (setq beg (point) end (org-end-of-subtree t)
17856 msg "Creating images for subtree...%s"))
17857 (t
17858 (if (setq at (org-inside-LaTeX-fragment-p))
17859 (goto-char (max (point-min) (- (cdr at) 2)))
17860 (org-back-to-heading))
17861 (setq beg (point) end (progn (outline-next-heading) (point))
17862 msg (if at "Creating image...%s"
17863 "Creating images for entry...%s"))))
17864 (message msg "")
17865 (narrow-to-region beg end)
17866 (goto-char beg)
17867 (org-format-latex
17868 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
17869 (file-name-nondirectory
17870 buffer-file-name)))
17871 default-directory 'overlays msg at 'forbuffer
17872 org-latex-create-formula-image-program)
17873 (message msg "done. Use `C-c C-c' to remove images.")))))
17875 (defun org-format-latex (prefix &optional dir overlays msg at
17876 forbuffer processing-type)
17877 "Replace LaTeX fragments with links to an image, and produce images.
17878 Some of the options can be changed using the variable
17879 `org-format-latex-options'."
17880 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
17881 (let* ((prefixnodir (file-name-nondirectory prefix))
17882 (absprefix (expand-file-name prefix dir))
17883 (todir (file-name-directory absprefix))
17884 (opt org-format-latex-options)
17885 (optnew org-format-latex-options)
17886 (matchers (plist-get opt :matchers))
17887 (re-list org-latex-regexps)
17888 (cnt 0) txt hash link beg end re e checkdir
17889 string
17890 m n block-type block linkfile movefile ov)
17891 ;; Check the different regular expressions
17892 (while (setq e (pop re-list))
17893 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
17895 (when (member m matchers)
17896 (goto-char (point-min))
17897 (while (re-search-forward re nil t)
17898 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
17899 (or (not overlays)
17900 (not (eq (get-char-property (match-beginning n)
17901 'org-overlay-type)
17902 'org-latex-overlay))))
17903 (cond
17904 ((eq processing-type 'verbatim))
17905 ((eq processing-type 'mathjax)
17906 ;; Prepare for MathJax processing.
17907 (setq string (match-string n))
17908 (when (member m '("$" "$1"))
17909 (save-excursion
17910 (delete-region (match-beginning n) (match-end n))
17911 (goto-char (match-beginning n))
17913 ((or (eq processing-type 'dvipng)
17914 (eq processing-type 'imagemagick))
17915 ;; Process to an image.
17916 (setq txt (match-string n)
17917 beg (match-beginning n) end (match-end n)
17918 cnt (1+ cnt))
17919 (let ((face (face-at-point))
17920 (fg (plist-get opt :foreground))
17921 (bg (plist-get opt :background))
17922 ;; Ensure full list is printed.
17923 print-length print-level)
17924 (when forbuffer
17925 ;; Get the colors from the face at point.
17926 (goto-char beg)
17927 (when (eq fg 'auto)
17928 (setq fg (face-attribute face :foreground nil 'default)))
17929 (when (eq bg 'auto)
17930 (setq bg (face-attribute face :background nil 'default)))
17931 (setq optnew (copy-sequence opt))
17932 (plist-put optnew :foreground fg)
17933 (plist-put optnew :background bg))
17934 (setq hash (sha1 (prin1-to-string
17935 (list org-format-latex-header
17936 org-latex-default-packages-alist
17937 org-latex-packages-alist
17938 org-format-latex-options
17939 forbuffer txt fg bg)))
17940 linkfile (format "%s_%s.png" prefix hash)
17941 movefile (format "%s_%s.png" absprefix hash)))
17942 (setq link (concat block "[[file:" linkfile "]]" block))
17943 (if msg (message msg cnt))
17944 (goto-char beg)
17945 (unless checkdir ; Ensure the directory exists.
17946 (setq checkdir t)
17947 (or (file-directory-p todir) (make-directory todir t)))
17948 (unless (file-exists-p movefile)
17949 (org-create-formula-image
17950 txt movefile optnew forbuffer processing-type))
17951 (if overlays
17952 (progn
17953 (mapc (lambda (o)
17954 (if (eq (overlay-get o 'org-overlay-type)
17955 'org-latex-overlay)
17956 (delete-overlay o)))
17957 (overlays-in beg end))
17958 (setq ov (make-overlay beg end))
17959 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17960 (if (featurep 'xemacs)
17961 (progn
17962 (overlay-put ov 'invisible t)
17963 (overlay-put
17964 ov 'end-glyph
17965 (make-glyph (vector 'png :file movefile))))
17966 (overlay-put
17967 ov 'display
17968 (list 'image :type 'png :file movefile :ascent 'center)))
17969 (push ov org-latex-fragment-image-overlays)
17970 (goto-char end))
17971 (delete-region beg end)
17972 (insert (org-add-props link
17973 (list 'org-latex-src
17974 (replace-regexp-in-string
17976 'org-latex-src-embed-type
17977 (if block-type 'paragraph 'character))))))
17978 ((eq processing-type 'mathml)
17979 ;; Process to MathML
17980 (unless (save-match-data (org-format-latex-mathml-available-p))
17981 (error "LaTeX to MathML converter not configured"))
17982 (setq txt (match-string n)
17983 beg (match-beginning n) end (match-end n)
17984 cnt (1+ cnt))
17985 (if msg (message msg cnt))
17986 (goto-char beg)
17987 (delete-region beg end)
17988 (insert (org-format-latex-as-mathml
17989 txt block-type prefix dir)))
17990 (t
17991 (error "Unknown conversion type %s for latex fragments"
17992 processing-type)))))))))
17994 (defun org-create-math-formula (latex-frag &optional mathml-file)
17995 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17996 Use `org-latex-to-mathml-convert-command'. If the conversion is
17998 elements otherwise return nil. When MATHML-FILE is specified,
17999 write the results in to that file. When invoked as an
18000 interactive command, prompt for LATEX-FRAG, with initial value
18001 set to the current active region and echo the results for user
18002 inspection."
18003 (interactive (list (let ((frag (when (org-region-active-p)
18004 (buffer-substring-no-properties
18005 (region-beginning) (region-end)))))
18006 (read-string "LaTeX Fragment: " frag nil frag))))
18007 (unless latex-frag (error "Invalid latex-frag"))
18008 (let* ((tmp-in-file (file-relative-name
18009 (make-temp-name (expand-file-name "ltxmathml-in"))))
18010 (ignore (write-region latex-frag nil tmp-in-file))
18011 (tmp-out-file (file-relative-name
18012 (make-temp-name (expand-file-name "ltxmathml-out"))))
18013 (cmd (format-spec
18014 org-latex-to-mathml-convert-command
18015 `((?j . ,(shell-quote-argument
18016 (expand-file-name org-latex-to-mathml-jar-file)))
18017 (?I . ,(shell-quote-argument tmp-in-file))
18018 (?o . ,(shell-quote-argument tmp-out-file)))))
18019 mathml shell-command-output)
18020 (when (org-called-interactively-p 'any)
18021 (unless (org-format-latex-mathml-available-p)
18022 (error "LaTeX to MathML converter not configured")))
18023 (message "Running %s" cmd)
18024 (setq shell-command-output (shell-command-to-string cmd))
18025 (setq mathml
18026 (when (file-readable-p tmp-out-file)
18027 (with-current-buffer (find-file-noselect tmp-out-file t)
18028 (goto-char (point-min))
18029 (when (re-search-forward
18030 (concat
18031 (regexp-quote
18034 (regexp-quote "</math>")) nil t)
18035 (prog1 (match-string 0) (kill-buffer))))))
18036 (cond
18037 (mathml
18038 (setq mathml
18040 (when mathml-file
18041 (write-region mathml nil mathml-file))
18042 (when (org-called-interactively-p 'any)
18043 (message mathml)))
18044 ((message "LaTeX to MathML conversion failed")
18045 (message shell-command-output)))
18046 (delete-file tmp-in-file)
18047 (when (file-exists-p tmp-out-file)
18048 (delete-file tmp-out-file))
18049 mathml))
18051 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18052 prefix &optional dir)
18053 "Use `org-create-math-formula' but check local cache first."
18054 (let* ((absprefix (expand-file-name prefix dir))
18055 (print-length nil) (print-level nil)
18056 (formula-id (concat
18057 "formula-"
18058 (sha1
18059 (prin1-to-string
18060 (list latex-frag
18061 org-latex-to-mathml-convert-command)))))
18062 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18063 (formula-cache-dir (file-name-directory formula-cache)))
18065 (unless (file-directory-p formula-cache-dir)
18066 (make-directory formula-cache-dir t))
18068 (unless (file-exists-p formula-cache)
18069 (org-create-math-formula latex-frag formula-cache))
18071 (if (file-exists-p formula-cache)
18072 ;; Successful conversion. Return the link to MathML file.
18073 (org-add-props
18074 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18076 'org-latex-src-embed-type (if latex-frag-type
18077 'paragraph 'character)))
18078 ;; Failed conversion. Return the LaTeX fragment verbatim
18079 latex-frag)))
18081 (defun org-create-formula-image (string tofile options buffer &optional type)
18082 "Create an image from LaTeX source using dvipng or convert.
18083 This function calls either `org-create-formula-image-with-dvipng'
18084 or `org-create-formula-image-with-imagemagick' depending on the
18085 value of `org-latex-create-formula-image-program' or on the value
18086 of the optional TYPE variable.
18088 Note: ultimately these two function should be combined as they
18089 share a good deal of logic."
18090 (org-check-external-command
18091 "latex" "needed to convert LaTeX fragments to images")
18092 (funcall
18093 (case (or type org-latex-create-formula-image-program)
18094 ('dvipng
18095 (org-check-external-command
18096 "dvipng" "needed to convert LaTeX fragments to images")
18097 #'org-create-formula-image-with-dvipng)
18098 ('imagemagick
18099 (org-check-external-command
18100 "convert" "you need to install imagemagick")
18101 #'org-create-formula-image-with-imagemagick)
18102 (t (error
18103 "invalid value of `org-latex-create-formula-image-program'")))
18104 string tofile options buffer))
18106 (declare-function org-export--get-global-options "ox" (&optional backend))
18107 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18108 (defun org-create-formula--latex-header ()
18109 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18110 (org-latex-guess-inputenc
18111 (org-splice-latex-header
18112 org-format-latex-header
18113 org-latex-default-packages-alist
18114 org-latex-packages-alist t
18115 (plist-get
18116 (org-combine-plists
18117 (org-export--get-global-options 'latex)
18118 (org-export--get-inbuffer-options 'latex))
18119 :latex-header-extra))))
18121 ;; This function borrows from Ganesh Swami's latex2png.el
18122 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18123 "This calls dvipng."
18124 (require 'ox-latex)
18125 (let* ((tmpdir (if (featurep 'xemacs)
18126 (temp-directory)
18127 temporary-file-directory))
18128 (texfilebase (make-temp-name
18129 (expand-file-name "orgtex" tmpdir)))
18130 (texfile (concat texfilebase ".tex"))
18131 (dvifile (concat texfilebase ".dvi"))
18132 (pngfile (concat texfilebase ".png"))
18133 (fnh (if (featurep 'xemacs)
18134 (font-height (face-font 'default))
18135 (face-attribute 'default :height nil)))
18136 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18137 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18138 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18139 "Black"))
18140 (bg (or (plist-get options (if buffer :background :html-background))
18141 "Transparent")))
18142 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18143 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18144 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18145 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18146 (let ((latex-header (org-create-formula--latex-header)))
18147 (with-temp-file texfile
18148 (insert latex-header)
18150 (let ((dir default-directory))
18151 (condition-case nil
18152 (progn
18153 (cd tmpdir)
18154 (call-process "latex" nil nil nil texfile))
18155 (error nil))
18156 (cd dir))
18157 (if (not (file-exists-p dvifile))
18158 (progn (message "Failed to create dvi file from %s" texfile) nil)
18159 (condition-case nil
18160 (if (featurep 'xemacs)
18161 (call-process "dvipng" nil nil nil
18162 "-fg" fg "-bg" bg
18163 "-T" "tight"
18164 "-o" pngfile
18165 dvifile)
18166 (call-process "dvipng" nil nil nil
18167 "-fg" fg "-bg" bg
18168 "-D" dpi
18169 ;;"-x" scale "-y" scale
18170 "-T" "tight"
18171 "-o" pngfile
18172 dvifile))
18173 (error nil))
18174 (if (not (file-exists-p pngfile))
18175 (if org-format-latex-signal-error
18176 (error "Failed to create png file from %s" texfile)
18177 (message "Failed to create png file from %s" texfile)
18178 nil)
18179 ;; Use the requested file name and clean up
18180 (copy-file pngfile tofile 'replace)
18181 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18182 (if (file-exists-p (concat texfilebase e))
18183 (delete-file (concat texfilebase e))))
18184 pngfile))))
18186 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18187 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18188 "This calls convert, which is included into imagemagick."
18189 (require 'ox-latex)
18190 (let* ((tmpdir (if (featurep 'xemacs)
18191 (temp-directory)
18192 temporary-file-directory))
18193 (texfilebase (make-temp-name
18194 (expand-file-name "orgtex" tmpdir)))
18195 (texfile (concat texfilebase ".tex"))
18196 (pdffile (concat texfilebase ".pdf"))
18197 (pngfile (concat texfilebase ".png"))
18198 (fnh (if (featurep 'xemacs)
18199 (font-height (face-font 'default))
18200 (face-attribute 'default :height nil)))
18201 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18202 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18203 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18204 "black"))
18205 (bg (or (plist-get options (if buffer :background :html-background))
18206 "white")))
18207 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18208 (setq fg (org-latex-color-format fg)))
18209 (if (eq bg 'default) (setq bg (org-latex-color :background))
18210 (setq bg (org-latex-color-format
18211 (if (string= bg "Transparent") "white" bg))))
18212 (let ((latex-header (org-create-formula--latex-header)))
18213 (with-temp-file texfile
18214 (insert latex-header)
18220 string
18223 (org-latex-compile texfile t)
18224 (if (not (file-exists-p pdffile))
18225 (progn (message "Failed to create pdf file from %s" texfile) nil)
18226 (condition-case nil
18227 (if (featurep 'xemacs)
18228 (call-process "convert" nil nil nil
18229 "-density" "96"
18230 "-trim"
18231 "-antialias"
18232 pdffile
18233 "-quality" "100"
18234 ;; "-sharpen" "0x1.0"
18235 pngfile)
18236 (call-process "convert" nil nil nil
18237 "-density" dpi
18238 "-trim"
18239 "-antialias"
18240 pdffile
18241 "-quality" "100"
18242 ;; "-sharpen" "0x1.0"
18243 pngfile))
18244 (error nil))
18245 (if (not (file-exists-p pngfile))
18246 (if org-format-latex-signal-error
18247 (error "Failed to create png file from %s" texfile)
18248 (message "Failed to create png file from %s" texfile)
18249 nil)
18250 ;; Use the requested file name and clean up
18251 (copy-file pngfile tofile 'replace)
18252 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18253 (if (file-exists-p (concat texfilebase e))
18254 (delete-file (concat texfilebase e))))
18255 pngfile))))
18257 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18258 "Fill a LaTeX header template TPL.
18259 In the template, the following place holders will be recognized:
18262 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18264 [NO-PACKAGES] do not include PKG
18265 [EXTRA] the string EXTRA
18266 [NO-EXTRA] do not include EXTRA
18268 For backward compatibility, if both the positive and the negative place
18270 assumed to be present at the end of the template.
18271 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18272 EXTRA is a string.
18273 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18274 (let (rpl (end ""))
18276 (setq rpl (if (or (match-end 1) (not def-pkg))
18277 "" (org-latex-packages-to-string def-pkg snippets-p t))
18278 tpl (replace-match rpl t t tpl))
18279 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18282 (setq rpl (if (or (match-end 1) (not pkg))
18283 "" (org-latex-packages-to-string pkg snippets-p t))
18284 tpl (replace-match rpl t t tpl))
18285 (if pkg (setq end
18287 (org-latex-packages-to-string pkg snippets-p)))))
18290 (setq rpl (if (or (match-end 1) (not extra))
18292 tpl (replace-match rpl t t tpl))
18298 tpl)))
18300 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18302 (setq pkg (mapconcat (lambda(p)
18303 (cond
18304 ((stringp p) p)
18305 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18306 (format "%% Package %s omitted" (cadr p)))
18307 ((equal "" (car p))
18309 (t
18311 (car p) (cadr p)))))
18312 pkg
18316 (defun org-dvipng-color (attr)
18317 "Return a RGB color specification for dvipng."
18318 (apply 'format "rgb %s %s %s"
18319 (mapcar 'org-normalize-color
18320 (if (featurep 'xemacs)
18321 (color-rgb-components
18322 (face-property 'default
18323 (cond ((eq attr :foreground) 'foreground)
18324 ((eq attr :background) 'background))))
18325 (color-values (face-attribute 'default attr nil))))))
18327 (defun org-dvipng-color-format (color-name)
18328 "Convert COLOR-NAME to a RGB color value for dvipng."
18329 (apply 'format "rgb %s %s %s"
18330 (mapcar 'org-normalize-color
18331 (color-values color-name))))
18333 (defun org-latex-color (attr)
18334 "Return a RGB color for the LaTeX color package."
18335 (apply 'format "%s,%s,%s"
18336 (mapcar 'org-normalize-color
18337 (if (featurep 'xemacs)
18338 (color-rgb-components
18339 (face-property 'default
18340 (cond ((eq attr :foreground) 'foreground)
18341 ((eq attr :background) 'background))))
18342 (color-values (face-attribute 'default attr nil))))))
18344 (defun org-latex-color-format (color-name)
18345 "Convert COLOR-NAME to a RGB color value."
18346 (apply 'format "%s,%s,%s"
18347 (mapcar 'org-normalize-color
18348 (color-values color-name))))
18350 (defun org-normalize-color (value)
18351 "Return string to be used as color value for an RGB component."
18352 (format "%g" (/ value 65535.0)))
18355 \f
18356 ;; Image display
18358 (defvar org-inline-image-overlays nil)
18359 (make-variable-buffer-local 'org-inline-image-overlays)
18361 (defun org-toggle-inline-images (&optional include-linked)
18362 "Toggle the display of inline images.
18363 INCLUDE-LINKED is passed to `org-display-inline-images'."
18364 (interactive "P")
18365 (if org-inline-image-overlays
18366 (progn
18367 (org-remove-inline-images)
18368 (message "Inline image display turned off"))
18369 (org-display-inline-images include-linked)
18370 (if (and (org-called-interactively-p)
18371 org-inline-image-overlays)
18372 (message "%d images displayed inline"
18373 (length org-inline-image-overlays))
18374 (message "No images to display inline"))))
18376 (defun org-redisplay-inline-images ()
18377 "Refresh the display of inline images."
18378 (interactive)
18379 (if (not org-inline-image-overlays)
18380 (org-toggle-inline-images)
18381 (org-toggle-inline-images)
18382 (org-toggle-inline-images)))
18384 (defun org-display-inline-images (&optional include-linked refresh beg end)
18385 "Display inline images.
18386 Normally only links without a description part are inlined, because this
18387 is how it will work for export. When INCLUDE-LINKED is set, also links
18388 with a description part will be inlined. This can be nice for a quick
18389 look at those images, but it does not reflect what exported files will look
18390 like.
18391 When REFRESH is set, refresh existing images between BEG and END.
18392 This will create new image displays only if necessary.
18393 BEG and END default to the buffer boundaries."
18394 (interactive "P")
18395 (unless refresh
18396 (org-remove-inline-images)
18397 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18398 (save-excursion
18399 (save-restriction
18400 (widen)
18401 (setq beg (or beg (point-min)) end (or end (point-max)))
18402 (goto-char beg)
18404 (substring (org-image-file-name-regexp) 0 -2)
18406 old file ov img type attrwidth width)
18407 (while (re-search-forward re end t)
18408 (setq old (get-char-property-and-overlay (match-beginning 1)
18409 'org-image-overlay)
18410 file (expand-file-name
18411 (concat (or (match-string 3) "") (match-string 4))))
18412 (when (image-type-available-p 'imagemagick)
18413 (setq attrwidth (if (or (listp org-image-actual-width)
18414 (null org-image-actual-width))
18415 (save-excursion
18416 (save-match-data
18417 (when (re-search-backward
18419 (save-excursion
18421 (string-to-number (match-string 1))))))
18422 width (cond ((eq org-image-actual-width t) nil)
18423 ((null org-image-actual-width) attrwidth)
18424 ((numberp org-image-actual-width)
18425 org-image-actual-width)
18426 ((listp org-image-actual-width)
18427 (or attrwidth (car org-image-actual-width))))
18428 type (if width 'imagemagick)))
18429 (when (file-exists-p file)
18430 (if (and (car-safe old) refresh)
18431 (image-refresh (overlay-get (cdr old) 'display))
18432 (setq img (save-match-data (create-image file type nil :width width)))
18433 (when img
18434 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18435 (overlay-put ov 'display img)
18436 (overlay-put ov 'face 'default)
18437 (overlay-put ov 'org-image-overlay t)
18438 (overlay-put ov 'modification-hooks
18439 (list 'org-display-inline-remove-overlay))
18440 (push ov org-inline-image-overlays)))))))))
18442 (define-obsolete-function-alias
18443 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18445 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18446 "Remove inline-display overlay if a corresponding region is modified."
18447 (let ((inhibit-modification-hooks t))
18448 (when (and ov after)
18449 (delete ov org-inline-image-overlays)
18450 (delete-overlay ov))))
18452 (defun org-remove-inline-images ()
18453 "Remove inline display of images."
18454 (interactive)
18455 (mapc 'delete-overlay org-inline-image-overlays)
18456 (setq org-inline-image-overlays nil))
18458 ;;;; Key bindings
18460 ;; Outline functions from `outline-mode-prefix-map'
18461 ;; that can be remapped in Org:
18462 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18463 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18464 (define-key org-mode-map [remap outline-forward-same-level]
18465 'org-forward-heading-same-level)
18466 (define-key org-mode-map [remap outline-backward-same-level]
18467 'org-backward-heading-same-level)
18468 (define-key org-mode-map [remap show-branches]
18469 'org-kill-note-or-show-branches)
18470 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18471 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18472 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18474 ;; Outline functions from `outline-mode-prefix-map' that can not
18475 ;; be remapped in Org:
18476 ;;
18477 ;; - the column "key binding" shows whether the Outline function is still
18478 ;; available in Org mode on the same key that it has been bound to in
18479 ;; Outline mode:
18480 ;; - "overridden": key used for a different functionality in Org mode
18481 ;; - else: key still bound to the same Outline function in Org mode
18482 ;;
18483 ;; | Outline function | key binding | Org replacement |
18484 ;; |------------------------------------+-------------+-----------------------|
18485 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18486 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18487 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18488 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18489 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18490 ;; | `show-entry' | overridden | no replacement |
18491 ;; | `show-children' | `C-c C-i' | visibility cycling |
18492 ;; | `show-branches' | `C-c C-k' | still same function |
18493 ;; | `show-subtree' | overridden | visibility cycling |
18494 ;; | `show-all' | overridden | no replacement |
18495 ;; | `hide-subtree' | overridden | visibility cycling |
18496 ;; | `hide-body' | overridden | no replacement |
18497 ;; | `hide-entry' | overridden | visibility cycling |
18498 ;; | `hide-leaves' | overridden | no replacement |
18499 ;; | `hide-sublevels' | overridden | no replacement |
18500 ;; | `hide-other' | overridden | no replacement |
18502 ;; Make `C-c C-x' a prefix key
18503 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18505 ;; TAB key with modifiers
18506 (org-defkey org-mode-map "\C-i" 'org-cycle)
18507 (org-defkey org-mode-map [(tab)] 'org-cycle)
18508 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18510 ;; The following line is necessary under Suse GNU/Linux
18511 (unless (featurep 'xemacs)
18512 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18513 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18514 (define-key org-mode-map [backtab] 'org-shifttab)
18516 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18517 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18518 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18520 ;; Cursor keys with modifiers
18521 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18522 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18523 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18524 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18526 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18527 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18528 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18529 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18531 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18532 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18533 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18534 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18536 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18537 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18538 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18539 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18541 ;; Babel keys
18542 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18543 (mapc (lambda (pair)
18544 (define-key org-babel-map (car pair) (cdr pair)))
18545 org-babel-key-bindings)
18547 ;;; Extra keys for tty access.
18548 ;; We only set them when really needed because otherwise the
18549 ;; menus don't show the simple keys
18551 (when (or org-use-extra-keys
18552 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18553 (not window-system))
18554 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18555 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18556 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18557 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18558 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18559 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18560 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18561 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18562 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18563 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18564 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18565 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18566 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18567 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18568 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18569 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18570 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18571 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18572 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18573 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18574 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18575 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18576 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18577 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18578 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18579 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18580 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18581 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18583 ;; All the other keys
18585 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18586 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18587 (if (boundp 'narrow-map)
18588 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18589 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18590 (if (boundp 'narrow-map)
18591 (org-defkey narrow-map "b" 'org-narrow-to-block)
18592 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18593 (if (boundp 'narrow-map)
18594 (org-defkey narrow-map "e" 'org-narrow-to-element)
18595 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18596 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18597 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18598 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18599 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18600 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18601 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18602 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18603 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
18604 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
18605 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18606 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18607 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18608 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18609 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18610 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18611 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18612 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18613 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18614 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18615 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18616 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18617 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18618 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18619 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18620 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18622 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18623 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18624 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18625 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18626 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18627 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18628 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18629 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18630 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18631 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18632 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18633 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18634 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18635 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18636 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18637 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18638 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18639 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18640 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18641 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18642 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18644 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18645 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18646 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18647 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18648 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18649 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18650 (org-defkey org-mode-map "\C-c^" 'org-sort)
18651 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18652 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18653 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18654 (org-defkey org-mode-map "\C-m" 'org-return)
18655 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18656 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18657 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18658 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18659 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18660 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18661 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18662 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18663 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18664 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18665 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18666 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18667 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
18668 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
18669 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
18670 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
18671 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
18672 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
18673 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
18674 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
18675 (org-defkey org-mode-map "\M-h" 'org-mark-element)
18676 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
18677 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
18679 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
18680 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
18681 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
18683 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
18684 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
18685 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
18686 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
18687 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
18688 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
18689 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
18690 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
18691 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
18692 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
18693 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
18694 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
18695 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
18697 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
18698 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
18699 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
18700 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
18701 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
18702 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
18703 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
18704 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
18705 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
18707 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
18708 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
18709 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
18710 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
18711 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
18713 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
18715 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
18717 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
18718 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
18720 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
18723 (when (featurep 'xemacs)
18724 (org-defkey org-mode-map 'button3 'popup-mode-menu))
18727 (defconst org-speed-commands-default
18728 '(
18729 ("Outline Navigation")
18730 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
18731 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
18732 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
18733 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
18734 ("F" . org-next-block)
18735 ("B" . org-previous-block)
18736 ("u" . (org-speed-move-safe 'outline-up-heading))
18737 ("j" . org-goto)
18738 ("g" . (org-refile t))
18739 ("Outline Visibility")
18740 ("c" . org-cycle)
18741 ("C" . org-shifttab)
18742 (" " . org-display-outline-path)
18743 ("=" . org-columns)
18744 ("Outline Structure Editing")
18745 ("U" . org-shiftmetaup)
18746 ("D" . org-shiftmetadown)
18747 ("r" . org-metaright)
18748 ("l" . org-metaleft)
18749 ("R" . org-shiftmetaright)
18750 ("L" . org-shiftmetaleft)
18751 ("i" . (progn (forward-char 1) (call-interactively
18752 'org-insert-heading-respect-content)))
18753 ("^" . org-sort)
18754 ("w" . org-refile)
18755 ("a" . org-archive-subtree-default-with-confirmation)
18756 ("@" . org-mark-subtree)
18757 ("#" . org-toggle-comment)
18758 ("Clock Commands")
18759 ("I" . org-clock-in)
18760 ("O" . org-clock-out)
18761 ("Meta Data Editing")
18762 ("t" . org-todo)
18763 ("," . (org-priority))
18764 ("0" . (org-priority ?\ ))
18765 ("1" . (org-priority ?A))
18766 ("2" . (org-priority ?B))
18767 ("3" . (org-priority ?C))
18768 (":" . org-set-tags-command)
18769 ("e" . org-set-effort)
18770 ("E" . org-inc-effort)
18771 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
18772 (org-entry-put (point) "APPT_WARNTIME" m)))
18773 ("Agenda Views etc")
18774 ("v" . org-agenda)
18775 ("/" . org-sparse-tree)
18776 ("Misc")
18777 ("o" . org-open-at-point)
18778 ("?" . org-speed-command-help)
18779 ("<" . (org-agenda-set-restriction-lock 'subtree))
18780 (">" . (org-agenda-remove-restriction-lock))
18781 )
18782 "The default speed commands.")
18784 (defun org-print-speed-command (e)
18785 (if (> (length (car e)) 1)
18786 (progn
18788 (princ (car e))
18790 (princ (make-string (length (car e)) ?-))
18792 (princ (car e))
18793 (princ " ")
18794 (if (symbolp (cdr e))
18795 (princ (symbol-name (cdr e)))
18796 (prin1 (cdr e)))
18799 (defun org-speed-command-help ()
18800 "Show the available speed commands."
18801 (interactive)
18802 (if (not org-use-speed-commands)
18803 (error "Speed commands are not activated, customize `org-use-speed-commands'")
18804 (with-output-to-temp-buffer "*Help*"
18806 (mapc 'org-print-speed-command org-speed-commands-user)
18809 (mapc 'org-print-speed-command org-speed-commands-default))
18810 (with-current-buffer "*Help*"
18811 (setq truncate-lines t))))
18813 (defun org-speed-move-safe (cmd)
18814 "Execute CMD, but make sure that the cursor always ends up in a headline.
18815 If not, return to the original position and throw an error."
18816 (interactive)
18817 (let ((pos (point)))
18818 (call-interactively cmd)
18819 (unless (and (bolp) (org-at-heading-p))
18820 (goto-char pos)
18821 (error "Boundary reached while executing %s" cmd))))
18823 (defvar org-self-insert-command-undo-counter 0)
18825 (defvar org-table-auto-blank-field) ; defined in org-table.el
18826 (defvar org-speed-command nil)
18828 (define-obsolete-function-alias
18829 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
18831 (defun org-speed-command-activate (keys)
18832 "Hook for activating single-letter speed commands.
18833 `org-speed-commands-default' specifies a minimal command set.
18834 Use `org-speed-commands-user' for further customization."
18835 (when (or (and (bolp) (looking-at org-outline-regexp)
18836 (not (org-in-block-p '("src"))))
18837 (and (functionp org-use-speed-commands)
18838 (funcall org-use-speed-commands)))
18839 (cdr (assoc keys (append org-speed-commands-user
18840 org-speed-commands-default)))))
18842 (define-obsolete-function-alias
18843 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
18845 (defun org-babel-speed-command-activate (keys)
18846 "Hook for activating single-letter code block commands."
18847 (when (and (bolp) (looking-at org-babel-src-block-regexp))
18848 (cdr (assoc keys org-babel-key-bindings))))
18850 (defcustom org-speed-command-hook
18851 '(org-speed-command-default-hook org-babel-speed-command-hook)
18852 "Hook for activating speed commands at strategic locations.
18853 Hook functions are called in sequence until a valid handler is
18854 found.
18856 Each hook takes a single argument, a user-pressed command key
18857 which is also a `self-insert-command' from the global map.
18859 Within the hook, examine the cursor position and the command key
18860 and return nil or a valid handler as appropriate. Handler could
18861 be one of an interactive command, a function, or a form.
18863 Set `org-use-speed-commands' to non-nil value to enable this
18864 hook. The default setting is `org-speed-command-activate'."
18865 :group 'org-structure
18866 :version "24.1"
18867 :type 'hook)
18869 (defun org-self-insert-command (N)
18870 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18871 If the cursor is in a table looking at whitespace, the whitespace is
18872 overwritten, and the table is not marked as requiring realignment."
18873 (interactive "p")
18874 (org-check-before-invisible-edit 'insert)
18875 (cond
18876 ((and org-use-speed-commands
18877 (setq org-speed-command
18878 (run-hook-with-args-until-success
18879 'org-speed-command-hook (this-command-keys))))
18880 (cond
18881 ((commandp org-speed-command)
18882 (setq this-command org-speed-command)
18883 (call-interactively org-speed-command))
18884 ((functionp org-speed-command)
18885 (funcall org-speed-command))
18886 ((and org-speed-command (listp org-speed-command))
18887 (eval org-speed-command))
18888 (t (let (org-use-speed-commands)
18889 (call-interactively 'org-self-insert-command)))))
18890 ((and
18891 (org-table-p)
18892 (progn
18893 ;; check if we blank the field, and if that triggers align
18894 (and (featurep 'org-table) org-table-auto-blank-field
18895 (member last-command
18896 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
18898 ;; got extra space, this field does not determine column width
18899 (let (org-table-may-need-update) (org-table-blank-field))
18900 ;; no extra space, this field may determine column width
18901 (org-table-blank-field)))
18902 t)
18903 (eq N 1)
18905 (let (org-table-may-need-update)
18906 (goto-char (1- (match-end 0)))
18907 (backward-delete-char 1)
18908 (goto-char (match-beginning 0))
18909 (self-insert-command N)))
18910 (t
18911 (setq org-table-may-need-update t)
18912 (self-insert-command N)
18913 (org-fix-tags-on-the-fly)
18914 (if org-self-insert-cluster-for-undo
18915 (if (not (eq last-command 'org-self-insert-command))
18916 (setq org-self-insert-command-undo-counter 1)
18917 (if (>= org-self-insert-command-undo-counter 20)
18918 (setq org-self-insert-command-undo-counter 1)
18919 (and (> org-self-insert-command-undo-counter 0)
18920 buffer-undo-list (listp buffer-undo-list)
18921 (not (cadr buffer-undo-list)) ; remove nil entry
18922 (setcdr buffer-undo-list (cddr buffer-undo-list)))
18923 (setq org-self-insert-command-undo-counter
18924 (1+ org-self-insert-command-undo-counter))))))))
18926 (defun org-check-before-invisible-edit (kind)
18927 "Check is editing if kind KIND would be dangerous with invisible text around.
18928 The detailed reaction depends on the user option `org-catch-invisible-edits'."
18929 ;; First, try to get out of here as quickly as possible, to reduce overhead
18930 (if (and org-catch-invisible-edits
18931 (or (not (boundp 'visible-mode)) (not visible-mode))
18932 (or (get-char-property (point) 'invisible)
18933 (get-char-property (max (point-min) (1- (point))) 'invisible)))
18934 ;; OK, we need to take a closer look
18935 (let* ((invisible-at-point (get-char-property (point) 'invisible))
18936 (invisible-before-point (if (bobp) nil (get-char-property
18937 (1- (point)) 'invisible)))
18938 (border-and-ok-direction
18939 (or
18940 ;; Check if we are acting predictably before invisible text
18941 (and invisible-at-point (not invisible-before-point)
18942 (memq kind '(insert delete-backward)))
18943 ;; Check if we are acting predictably after invisible text
18944 ;; This works not well, and I have turned it off. It seems
18945 ;; better to always show and stop after invisible text.
18946 ;; (and (not invisible-at-point) invisible-before-point
18947 ;; (memq kind '(insert delete)))
18948 )))
18949 (when (or (memq invisible-at-point '(outline org-hide-block t))
18950 (memq invisible-before-point '(outline org-hide-block t)))
18951 (if (eq org-catch-invisible-edits 'error)
18952 (error "Editing in invisible areas is prohibited - make visible first"))
18953 (if (and org-custom-properties-overlays
18954 (y-or-n-p "Display invisible properties in this buffer? "))
18955 (org-toggle-custom-properties-visibility)
18956 ;; Make the area visible
18957 (save-excursion
18958 (if invisible-before-point
18959 (goto-char (previous-single-char-property-change
18960 (point) 'invisible)))
18961 (org-cycle))
18962 (cond
18963 ((eq org-catch-invisible-edits 'show)
18964 ;; That's it, we do the edit after showing
18965 (message
18966 "Unfolding invisible region around point before editing")
18967 (sit-for 1))
18968 ((and (eq org-catch-invisible-edits 'smart)
18969 border-and-ok-direction)
18970 (message "Unfolding invisible region around point before editing"))
18971 (t
18972 ;; Don't do the edit, make the user repeat it in full visibility
18973 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
18975 (defun org-fix-tags-on-the-fly ()
18976 (when (and (equal (char-after (point-at-bol)) ?*)
18977 (org-at-heading-p))
18978 (org-align-tags-here org-tags-column)))
18980 (defun org-delete-backward-char (N)
18981 "Like `delete-backward-char', insert whitespace at field end in tables.
18982 When deleting backwards, in tables this function will insert whitespace in
18984 still be marked for re-alignment if the field did fill the entire column,
18985 because, in this case the deletion might narrow the column."
18986 (interactive "p")
18987 (save-match-data
18988 (org-check-before-invisible-edit 'delete-backward)
18989 (if (and (org-table-p)
18990 (eq N 1)
18991 (string-match "|" (buffer-substring (point-at-bol) (point)))
18992 (looking-at ".*?|"))
18993 (let ((pos (point))
18995 (c org-table-may-need-update))
18996 (backward-delete-char N)
18997 (if (not overwrite-mode)
18998 (progn
18999 (skip-chars-forward "^|")
19000 (insert " ")
19001 (goto-char (1- pos))))
19002 ;; noalign: if there were two spaces at the end, this field
19003 ;; does not determine the width of the column.
19004 (if noalign (setq org-table-may-need-update c)))
19005 (backward-delete-char N)
19006 (org-fix-tags-on-the-fly))))
19008 (defun org-delete-char (N)
19009 "Like `delete-char', but insert whitespace at field end in tables.
19010 When deleting characters, in tables this function will insert whitespace in
19012 still be marked for re-alignment if the field did fill the entire column,
19013 because, in this case the deletion might narrow the column."
19014 (interactive "p")
19015 (save-match-data
19016 (org-check-before-invisible-edit 'delete)
19017 (if (and (org-table-p)
19018 (not (bolp))
19019 (not (= (char-after) ?|))
19020 (eq N 1))
19021 (if (looking-at ".*?|")
19022 (let ((pos (point))
19024 (c org-table-may-need-update))
19025 (replace-match (concat
19026 (substring (match-string 0) 1 -1)
19027 " |"))
19028 (goto-char pos)
19029 ;; noalign: if there were two spaces at the end, this field
19030 ;; does not determine the width of the column.
19031 (if noalign (setq org-table-may-need-update c)))
19032 (delete-char N))
19033 (delete-char N)
19034 (org-fix-tags-on-the-fly))))
19036 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19037 (put 'org-self-insert-command 'delete-selection t)
19038 (put 'orgtbl-self-insert-command 'delete-selection t)
19039 (put 'org-delete-char 'delete-selection 'supersede)
19040 (put 'org-delete-backward-char 'delete-selection 'supersede)
19041 (put 'org-yank 'delete-selection 'yank)
19043 ;; Make `flyspell-mode' delay after some commands
19044 (put 'org-self-insert-command 'flyspell-delayed t)
19045 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19046 (put 'org-delete-char 'flyspell-delayed t)
19047 (put 'org-delete-backward-char 'flyspell-delayed t)
19049 ;; Make pabbrev-mode expand after org-mode commands
19050 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19051 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19053 ;; How to do this: Measure non-white length of current string
19054 ;; If equal to column width, we should realign.
19056 (defun org-remap (map &rest commands)
19057 "In MAP, remap the functions given in COMMANDS.
19058 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19059 (let (new old)
19060 (while commands
19061 (setq old (pop commands) new (pop commands))
19062 (if (fboundp 'command-remapping)
19063 (org-defkey map (vector 'remap old) new)
19064 (substitute-key-definition old new map global-map)))))
19066 (defun org-transpose-words ()
19067 "Transpose words for Org.
19068 This uses the `org-mode-transpose-word-syntax-table' syntax
19069 table, which interprets characters in `org-emphasis-alist' as
19070 word constituants."
19071 (interactive)
19072 (with-syntax-table org-mode-transpose-word-syntax-table
19073 (call-interactively 'transpose-words)))
19074 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19076 (when (eq org-enable-table-editor 'optimized)
19077 ;; If the user wants maximum table support, we need to hijack
19078 ;; some standard editing functions
19079 (org-remap org-mode-map
19080 'self-insert-command 'org-self-insert-command
19081 'delete-char 'org-delete-char
19082 'delete-backward-char 'org-delete-backward-char)
19083 (org-defkey org-mode-map "|" 'org-force-self-insert))
19085 (defvar org-ctrl-c-ctrl-c-hook nil
19086 "Hook for functions attaching themselves to `C-c C-c'.
19088 This can be used to add additional functionality to the C-c C-c
19089 key which executes context-dependent commands. This hook is run
19090 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19091 run after the last test.
19093 Each function will be called with no arguments. The function
19094 must check if the context is appropriate for it to act. If yes,
19095 it should do its thing and then return a non-nil value. If the
19096 context is wrong, just do nothing and return nil.")
19098 (defvar org-ctrl-c-ctrl-c-final-hook nil
19099 "Hook for functions attaching themselves to `C-c C-c'.
19101 This can be used to add additional functionality to the C-c C-c
19102 key which executes context-dependent commands. This hook is run
19103 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19104 before the first test.
19106 Each function will be called with no arguments. The function
19107 must check if the context is appropriate for it to act. If yes,
19108 it should do its thing and then return a non-nil value. If the
19109 context is wrong, just do nothing and return nil.")
19111 (defvar org-tab-first-hook nil
19112 "Hook for functions to attach themselves to TAB.
19113 See `org-ctrl-c-ctrl-c-hook' for more information.
19114 This hook runs as the first action when TAB is pressed, even before
19115 `org-cycle' messes around with the `outline-regexp' to cater for
19116 inline tasks and plain list item folding.
19117 If any function in this hook returns t, any other actions that
19118 would have been caused by TAB (such as table field motion or visibility
19119 cycling) will not occur.")
19121 (defvar org-tab-after-check-for-table-hook nil
19122 "Hook for functions to attach themselves to TAB.
19123 See `org-ctrl-c-ctrl-c-hook' for more information.
19124 This hook runs after it has been established that the cursor is not in a
19125 table, but before checking if the cursor is in a headline or if global cycling
19126 should be done.
19127 If any function in this hook returns t, not other actions like visibility
19128 cycling will be done.")
19130 (defvar org-tab-after-check-for-cycling-hook nil
19131 "Hook for functions to attach themselves to TAB.
19132 See `org-ctrl-c-ctrl-c-hook' for more information.
19133 This hook runs after it has been established that not table field motion and
19134 not visibility should be done because of current context. This is probably
19135 the place where a package like yasnippets can hook in.")
19137 (defvar org-tab-before-tab-emulation-hook nil
19138 "Hook for functions to attach themselves to TAB.
19139 See `org-ctrl-c-ctrl-c-hook' for more information.
19140 This hook runs after every other options for TAB have been exhausted, but
19143 (defvar org-metaleft-hook nil
19144 "Hook for functions attaching themselves to `M-left'.
19145 See `org-ctrl-c-ctrl-c-hook' for more information.")
19146 (defvar org-metaright-hook nil
19147 "Hook for functions attaching themselves to `M-right'.
19148 See `org-ctrl-c-ctrl-c-hook' for more information.")
19149 (defvar org-metaup-hook nil
19150 "Hook for functions attaching themselves to `M-up'.
19151 See `org-ctrl-c-ctrl-c-hook' for more information.")
19152 (defvar org-metadown-hook nil
19153 "Hook for functions attaching themselves to `M-down'.
19154 See `org-ctrl-c-ctrl-c-hook' for more information.")
19155 (defvar org-shiftmetaleft-hook nil
19156 "Hook for functions attaching themselves to `M-S-left'.
19157 See `org-ctrl-c-ctrl-c-hook' for more information.")
19158 (defvar org-shiftmetaright-hook nil
19159 "Hook for functions attaching themselves to `M-S-right'.
19160 See `org-ctrl-c-ctrl-c-hook' for more information.")
19161 (defvar org-shiftmetaup-hook nil
19162 "Hook for functions attaching themselves to `M-S-up'.
19163 See `org-ctrl-c-ctrl-c-hook' for more information.")
19164 (defvar org-shiftmetadown-hook nil
19165 "Hook for functions attaching themselves to `M-S-down'.
19166 See `org-ctrl-c-ctrl-c-hook' for more information.")
19167 (defvar org-metareturn-hook nil
19168 "Hook for functions attaching themselves to `M-RET'.
19169 See `org-ctrl-c-ctrl-c-hook' for more information.")
19170 (defvar org-shiftup-hook nil
19171 "Hook for functions attaching themselves to `S-up'.
19172 See `org-ctrl-c-ctrl-c-hook' for more information.")
19173 (defvar org-shiftup-final-hook nil
19174 "Hook for functions attaching themselves to `S-up'.
19175 This one runs after all other options except shift-select have been excluded.
19176 See `org-ctrl-c-ctrl-c-hook' for more information.")
19177 (defvar org-shiftdown-hook nil
19178 "Hook for functions attaching themselves to `S-down'.
19179 See `org-ctrl-c-ctrl-c-hook' for more information.")
19180 (defvar org-shiftdown-final-hook nil
19181 "Hook for functions attaching themselves to `S-down'.
19182 This one runs after all other options except shift-select have been excluded.
19183 See `org-ctrl-c-ctrl-c-hook' for more information.")
19184 (defvar org-shiftleft-hook nil
19185 "Hook for functions attaching themselves to `S-left'.
19186 See `org-ctrl-c-ctrl-c-hook' for more information.")
19187 (defvar org-shiftleft-final-hook nil
19188 "Hook for functions attaching themselves to `S-left'.
19189 This one runs after all other options except shift-select have been excluded.
19190 See `org-ctrl-c-ctrl-c-hook' for more information.")
19191 (defvar org-shiftright-hook nil
19192 "Hook for functions attaching themselves to `S-right'.
19193 See `org-ctrl-c-ctrl-c-hook' for more information.")
19194 (defvar org-shiftright-final-hook nil
19195 "Hook for functions attaching themselves to `S-right'.
19196 This one runs after all other options except shift-select have been excluded.
19197 See `org-ctrl-c-ctrl-c-hook' for more information.")
19199 (defun org-modifier-cursor-error ()
19200 "Throw an error, a modified cursor command was applied in wrong context."
19201 (error "This command is active in special context like tables, headlines or items"))
19203 (defun org-shiftselect-error ()
19204 "Throw an error because Shift-Cursor command was applied in wrong context."
19205 (if (and (boundp 'shift-select-mode) shift-select-mode)
19206 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19207 (error "This command works only in special context like headlines or timestamps")))
19209 (defun org-call-for-shift-select (cmd)
19210 (let ((this-command-keys-shift-translated t))
19211 (call-interactively cmd)))
19213 (defun org-shifttab (&optional arg)
19214 "Global visibility cycling or move to previous table field.
19215 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
19216 on context.
19217 See the individual commands for more information."
19218 (interactive "P")
19219 (cond
19220 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19221 ((integerp arg)
19222 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19223 (message "Content view to level: %d" arg)
19224 (org-content (prefix-numeric-value arg2))
19225 (setq org-cycle-global-status 'overview)))
19226 (t (call-interactively 'org-global-cycle))))
19228 (defun org-shiftmetaleft ()
19229 "Promote subtree or delete table column.
19230 Calls `org-promote-subtree', `org-outdent-item-tree', or
19231 `org-table-delete-column', depending on context. See the
19232 individual commands for more information."
19233 (interactive)
19234 (cond
19235 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19236 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19237 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19238 ((if (not (org-region-active-p)) (org-at-item-p)
19239 (save-excursion (goto-char (region-beginning))
19240 (org-at-item-p)))
19241 (call-interactively 'org-outdent-item-tree))
19242 (t (org-modifier-cursor-error))))
19244 (defun org-shiftmetaright ()
19245 "Demote subtree or insert table column.
19246 Calls `org-demote-subtree', `org-indent-item-tree', or
19247 `org-table-insert-column', depending on context. See the
19248 individual commands for more information."
19249 (interactive)
19250 (cond
19251 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19252 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19253 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19254 ((if (not (org-region-active-p)) (org-at-item-p)
19255 (save-excursion (goto-char (region-beginning))
19256 (org-at-item-p)))
19257 (call-interactively 'org-indent-item-tree))
19258 (t (org-modifier-cursor-error))))
19260 (defun org-shiftmetaup (&optional arg)
19261 "Move subtree up or kill table row.
19262 Calls `org-move-subtree-up' or `org-table-kill-row' or
19263 `org-move-item-up' or `org-timestamp-up', depending on context.
19264 See the individual commands for more information."
19265 (interactive "P")
19266 (cond
19267 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19268 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19269 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19270 ((org-at-item-p) (call-interactively 'org-move-item-up))
19271 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19272 (call-interactively 'org-timestamp-up)))
19273 (t (call-interactively 'org-drag-line-backward))))
19275 (defun org-shiftmetadown (&optional arg)
19276 "Move subtree down or insert table row.
19277 Calls `org-move-subtree-down' or `org-table-insert-row' or
19278 `org-move-item-down' or `org-timestamp-up', depending on context.
19279 See the individual commands for more information."
19280 (interactive "P")
19281 (cond
19282 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19283 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19284 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19285 ((org-at-item-p) (call-interactively 'org-move-item-down))
19286 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19287 (call-interactively 'org-timestamp-down)))
19288 (t (call-interactively 'org-drag-line-forward))))
19290 (defsubst org-hidden-tree-error ()
19291 (error
19292 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19294 (defun org-metaleft (&optional arg)
19295 "Promote heading or move table column to left.
19296 Calls `org-do-promote' or `org-table-move-column', depending on context.
19297 With no specific context, calls the Emacs default `backward-word'.
19298 See the individual commands for more information."
19299 (interactive "P")
19300 (cond
19301 ((run-hook-with-args-until-success 'org-metaleft-hook))
19302 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19303 ((org-with-limited-levels
19304 (or (org-at-heading-p)
19305 (and (org-region-active-p)
19306 (save-excursion
19307 (goto-char (region-beginning))
19308 (org-at-heading-p)))))
19309 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19310 (call-interactively 'org-do-promote))
19311 ;; At an inline task.
19312 ((org-at-heading-p)
19313 (call-interactively 'org-inlinetask-promote))
19314 ((or (org-at-item-p)
19315 (and (org-region-active-p)
19316 (save-excursion
19317 (goto-char (region-beginning))
19318 (org-at-item-p))))
19319 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19320 (call-interactively 'org-outdent-item))
19321 (t (call-interactively 'backward-word))))
19323 (defun org-metaright (&optional arg)
19324 "Demote a subtree, a list item or move table column to right.
19325 In front of a drawer or a block keyword, indent it correctly.
19326 With no specific context, calls the Emacs default `forward-word'.
19327 See the individual commands for more information."
19328 (interactive "P")
19329 (cond
19330 ((run-hook-with-args-until-success 'org-metaright-hook))
19331 ((org-at-table-p) (call-interactively 'org-table-move-column))
19332 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19333 ((org-at-block-p) (call-interactively 'org-indent-block))
19334 ((org-with-limited-levels
19335 (or (org-at-heading-p)
19336 (and (org-region-active-p)
19337 (save-excursion
19338 (goto-char (region-beginning))
19339 (org-at-heading-p)))))
19340 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19341 (call-interactively 'org-do-demote))
19342 ;; At an inline task.
19343 ((org-at-heading-p)
19344 (call-interactively 'org-inlinetask-demote))
19345 ((or (org-at-item-p)
19346 (and (org-region-active-p)
19347 (save-excursion
19348 (goto-char (region-beginning))
19349 (org-at-item-p))))
19350 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19351 (call-interactively 'org-indent-item))
19352 (t (call-interactively 'forward-word))))
19354 (defun org-check-for-hidden (what)
19355 "Check if there are hidden headlines/items in the current visual line.
19356 WHAT can be either `headlines' or `items'. If the current line is
19357 an outline or item heading and it has a folded subtree below it,
19358 this function returns t, nil otherwise."
19359 (let ((re (cond
19360 ((eq what 'headlines) org-outline-regexp-bol)
19361 ((eq what 'items) (org-item-beginning-re))
19362 (t (error "This should not happen"))))
19363 beg end)
19364 (save-excursion
19365 (catch 'exit
19366 (unless (org-region-active-p)
19367 (setq beg (point-at-bol))
19368 (beginning-of-line 2)
19369 (while (and (not (eobp)) ;; this is like `next-line'
19370 (get-char-property (1- (point)) 'invisible))
19371 (beginning-of-line 2))
19372 (setq end (point))
19373 (goto-char beg)
19374 (goto-char (point-at-eol))
19375 (setq end (max end (point)))
19376 (while (re-search-forward re end t)
19377 (if (get-char-property (match-beginning 0) 'invisible)
19378 (throw 'exit t))))
19379 nil))))
19381 (defun org-metaup (&optional arg)
19382 "Move subtree up or move table row up.
19383 Calls `org-move-subtree-up' or `org-table-move-row' or
19384 `org-move-item-up', depending on context. See the individual commands
19385 for more information."
19386 (interactive "P")
19387 (cond
19388 ((run-hook-with-args-until-success 'org-metaup-hook))
19389 ((org-region-active-p)
19390 (let* ((a (min (region-beginning) (region-end)))
19391 (b (1- (max (region-beginning) (region-end))))
19392 (c (save-excursion (goto-char a)
19393 (move-beginning-of-line 0)))
19394 (d (save-excursion (goto-char a)
19395 (move-end-of-line 0) (point))))
19396 (transpose-regions a b c d)
19397 (goto-char c)))
19398 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19399 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19400 ((org-at-item-p) (call-interactively 'org-move-item-up))
19401 (t (org-drag-element-backward))))
19403 (defun org-metadown (&optional arg)
19404 "Move subtree down or move table row down.
19405 Calls `org-move-subtree-down' or `org-table-move-row' or
19406 `org-move-item-down', depending on context. See the individual
19407 commands for more information."
19408 (interactive "P")
19409 (cond
19410 ((run-hook-with-args-until-success 'org-metadown-hook))
19411 ((org-region-active-p)
19412 (let* ((a (min (region-beginning) (region-end)))
19413 (b (max (region-beginning) (region-end)))
19414 (c (save-excursion (goto-char b)
19415 (move-beginning-of-line 1)))
19416 (d (save-excursion (goto-char b)
19417 (move-end-of-line 1) (1+ (point)))))
19418 (transpose-regions a b c d)
19419 (goto-char d)))
19420 ((org-at-table-p) (call-interactively 'org-table-move-row))
19421 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19422 ((org-at-item-p) (call-interactively 'org-move-item-down))
19423 (t (org-drag-element-forward))))
19425 (defun org-shiftup (&optional arg)
19426 "Increase item in timestamp or increase priority of current headline.
19427 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19428 depending on context. See the individual commands for more information."
19429 (interactive "P")
19430 (cond
19431 ((run-hook-with-args-until-success 'org-shiftup-hook))
19432 ((and org-support-shift-select (org-region-active-p))
19433 (org-call-for-shift-select 'previous-line))
19434 ((org-at-timestamp-p t)
19435 (call-interactively (if org-edit-timestamp-down-means-later
19436 'org-timestamp-down 'org-timestamp-up)))
19437 ((and (not (eq org-support-shift-select 'always))
19438 org-enable-priority-commands
19439 (org-at-heading-p))
19440 (call-interactively 'org-priority-up))
19441 ((and (not org-support-shift-select) (org-at-item-p))
19442 (call-interactively 'org-previous-item))
19443 ((org-clocktable-try-shift 'up arg))
19444 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19445 (org-support-shift-select
19446 (org-call-for-shift-select 'previous-line))
19447 (t (org-shiftselect-error))))
19449 (defun org-shiftdown (&optional arg)
19450 "Decrease item in timestamp or decrease priority of current headline.
19451 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19452 depending on context. See the individual commands for more information."
19453 (interactive "P")
19454 (cond
19455 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19456 ((and org-support-shift-select (org-region-active-p))
19457 (org-call-for-shift-select 'next-line))
19458 ((org-at-timestamp-p t)
19459 (call-interactively (if org-edit-timestamp-down-means-later
19460 'org-timestamp-up 'org-timestamp-down)))
19461 ((and (not (eq org-support-shift-select 'always))
19462 org-enable-priority-commands
19463 (org-at-heading-p))
19464 (call-interactively 'org-priority-down))
19465 ((and (not org-support-shift-select) (org-at-item-p))
19466 (call-interactively 'org-next-item))
19467 ((org-clocktable-try-shift 'down arg))
19468 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19469 (org-support-shift-select
19470 (org-call-for-shift-select 'next-line))
19471 (t (org-shiftselect-error))))
19473 (defun org-shiftright (&optional arg)
19474 "Cycle the thing at point or in the current line, depending on context.
19475 Depending on context, this does one of the following:
19477 - switch a timestamp at point one day into the future
19478 - on a headline, switch to the next TODO keyword.
19479 - on an item, switch entire list to the next bullet type
19480 - on a property line, switch to the next allowed value
19481 - on a clocktable definition line, move time block into the future"
19482 (interactive "P")
19483 (cond
19484 ((run-hook-with-args-until-success 'org-shiftright-hook))
19485 ((and org-support-shift-select (org-region-active-p))
19486 (org-call-for-shift-select 'forward-char))
19487 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19488 ((and (not (eq org-support-shift-select 'always))
19489 (org-at-heading-p))
19490 (let ((org-inhibit-logging
19491 (not org-treat-S-cursor-todo-selection-as-state-change))
19492 (org-inhibit-blocking
19493 (not org-treat-S-cursor-todo-selection-as-state-change)))
19494 (org-call-with-arg 'org-todo 'right)))
19495 ((or (and org-support-shift-select
19496 (not (eq org-support-shift-select 'always))
19497 (org-at-item-bullet-p))
19498 (and (not org-support-shift-select) (org-at-item-p)))
19499 (org-call-with-arg 'org-cycle-list-bullet nil))
19500 ((and (not (eq org-support-shift-select 'always))
19501 (org-at-property-p))
19502 (call-interactively 'org-property-next-allowed-value))
19503 ((org-clocktable-try-shift 'right arg))
19504 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19505 (org-support-shift-select
19506 (org-call-for-shift-select 'forward-char))
19507 (t (org-shiftselect-error))))
19509 (defun org-shiftleft (&optional arg)
19510 "Cycle the thing at point or in the current line, depending on context.
19511 Depending on context, this does one of the following:
19513 - switch a timestamp at point one day into the past
19514 - on a headline, switch to the previous TODO keyword.
19515 - on an item, switch entire list to the previous bullet type
19516 - on a property line, switch to the previous allowed value
19517 - on a clocktable definition line, move time block into the past"
19518 (interactive "P")
19519 (cond
19520 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19521 ((and org-support-shift-select (org-region-active-p))
19522 (org-call-for-shift-select 'backward-char))
19523 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19524 ((and (not (eq org-support-shift-select 'always))
19525 (org-at-heading-p))
19526 (let ((org-inhibit-logging
19527 (not org-treat-S-cursor-todo-selection-as-state-change))
19528 (org-inhibit-blocking
19529 (not org-treat-S-cursor-todo-selection-as-state-change)))
19530 (org-call-with-arg 'org-todo 'left)))
19531 ((or (and org-support-shift-select
19532 (not (eq org-support-shift-select 'always))
19533 (org-at-item-bullet-p))
19534 (and (not org-support-shift-select) (org-at-item-p)))
19535 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19536 ((and (not (eq org-support-shift-select 'always))
19537 (org-at-property-p))
19538 (call-interactively 'org-property-previous-allowed-value))
19539 ((org-clocktable-try-shift 'left arg))
19540 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19541 (org-support-shift-select
19542 (org-call-for-shift-select 'backward-char))
19543 (t (org-shiftselect-error))))
19545 (defun org-shiftcontrolright ()
19546 "Switch to next TODO set."
19547 (interactive)
19548 (cond
19549 ((and org-support-shift-select (org-region-active-p))
19550 (org-call-for-shift-select 'forward-word))
19551 ((and (not (eq org-support-shift-select 'always))
19552 (org-at-heading-p))
19553 (org-call-with-arg 'org-todo 'nextset))
19554 (org-support-shift-select
19555 (org-call-for-shift-select 'forward-word))
19556 (t (org-shiftselect-error))))
19558 (defun org-shiftcontrolleft ()
19559 "Switch to previous TODO set."
19560 (interactive)
19561 (cond
19562 ((and org-support-shift-select (org-region-active-p))
19563 (org-call-for-shift-select 'backward-word))
19564 ((and (not (eq org-support-shift-select 'always))
19565 (org-at-heading-p))
19566 (org-call-with-arg 'org-todo 'previousset))
19567 (org-support-shift-select
19568 (org-call-for-shift-select 'backward-word))
19569 (t (org-shiftselect-error))))
19571 (defun org-shiftcontrolup (&optional n)
19572 "Change timestamps synchronously up in CLOCK log lines.
19573 Optional argument N tells to change by that many units."
19574 (interactive "P")
19575 (cond ((and (not org-support-shift-select)
19576 (org-at-clock-log-p)
19577 (org-at-timestamp-p t))
19578 (org-clock-timestamps-up n))
19579 (t (org-shiftselect-error))))
19581 (defun org-shiftcontroldown (&optional n)
19582 "Change timestamps synchronously down in CLOCK log lines.
19583 Optional argument N tells to change by that many units."
19584 (interactive "P")
19585 (cond ((and (not org-support-shift-select)
19586 (org-at-clock-log-p)
19587 (org-at-timestamp-p t))
19588 (org-clock-timestamps-down n))
19589 (t (org-shiftselect-error))))
19591 (defun org-ctrl-c-ret ()
19592 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19593 (interactive)
19594 (cond
19595 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19596 (t (call-interactively 'org-insert-heading))))
19598 (defun org-find-visible ()
19599 (let ((s (point)))
19600 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19601 (get-char-property s 'invisible)))
19602 s))
19603 (defun org-find-invisible ()
19604 (let ((s (point)))
19605 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19606 (not (get-char-property s 'invisible))))
19607 s))
19609 (defun org-copy-visible (beg end)
19610 "Copy the visible parts of the region."
19611 (interactive "r")
19612 (let (snippets s)
19613 (save-excursion
19614 (save-restriction
19615 (narrow-to-region beg end)
19616 (setq s (goto-char (point-min)))
19617 (while (not (= (point) (point-max)))
19618 (goto-char (org-find-invisible))
19619 (push (buffer-substring s (point)) snippets)
19620 (setq s (goto-char (org-find-visible))))))
19621 (kill-new (apply 'concat (nreverse snippets)))))
19623 (defun org-copy-special ()
19624 "Copy region in table or copy current subtree.
19625 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19626 See the individual commands for more information."
19627 (interactive)
19628 (call-interactively
19629 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19631 (defun org-cut-special ()
19632 "Cut region in table or cut current subtree.
19633 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19634 See the individual commands for more information."
19635 (interactive)
19636 (call-interactively
19637 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19639 (defun org-paste-special (arg)
19640 "Paste rectangular region into table, or past subtree relative to level.
19641 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19642 See the individual commands for more information."
19643 (interactive "P")
19644 (if (org-at-table-p)
19645 (org-table-paste-rectangle)
19646 (org-paste-subtree arg)))
19648 (defsubst org-in-fixed-width-region-p ()
19649 "Is point in a fixed-width region?"
19650 (save-match-data
19651 (eq 'fixed-width (org-element-type (org-element-at-point)))))
19653 (defun org-edit-special (&optional arg)
19654 "Call a special editor for the element at point.
19655 When at a table, call the formula editor with `org-table-edit-formulas'.
19656 When in a source code block, call `org-edit-src-code'.
19657 When in a fixed-width region, call `org-edit-fixed-width-region'.
19658 When at an #+INCLUDE keyword, visit the included file.
19659 On a link, call `ffap' to visit the link at point.
19660 Otherwise, return a user error."
19661 (interactive)
19662 (let ((element (org-element-at-point)))
19663 (assert (not buffer-read-only) nil
19664 "Buffer is read-only: %s" (buffer-name))
19665 (case (org-element-type element)
19666 (src-block
19667 (if (not arg) (org-edit-src-code)
19668 (let* ((info (org-babel-get-src-block-info))
19669 (lang (nth 0 info))
19670 (params (nth 2 info))
19671 (session (cdr (assq :session params))))
19672 (if (not session) (org-edit-src-code)
19673 ;; At a src-block with a session and function called with
19674 ;; an ARG: switch to the buffer related to the inferior
19675 ;; process.
19676 (funcall (intern (concat "org-babel-prep-session:" lang))
19677 session params)))))
19678 (keyword
19679 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
19680 (find-file
19681 (org-remove-double-quotes
19682 (car (org-split-string (org-element-property :value element)))))
19683 (user-error "No special environment to edit here")))
19684 (table
19685 (if (eq (org-element-property :type element) 'table.el)
19686 (org-edit-src-code)
19687 (call-interactively 'org-table-edit-formulas)))
19688 ;; Only Org tables contain `table-row' type elements.
19689 (table-row (call-interactively 'org-table-edit-formulas))
19690 ((example-block export-block) (org-edit-src-code))
19691 (fixed-width (org-edit-fixed-width-region))
19692 (otherwise
19693 ;; No notable element at point. Though, we may be at a link,
19694 ;; which is an object. Thus, scan deeper.
19695 (if (eq (org-element-type (org-element-context element)) 'link)
19696 (call-interactively 'ffap)
19697 (user-error "No special environment to edit here"))))))
19699 (defvar org-table-coordinate-overlays) ; defined in org-table.el
19700 (defun org-ctrl-c-ctrl-c (&optional arg)
19701 "Set tags in headline, or update according to changed information at point.
19703 This command does many different things, depending on context:
19705 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
19706 this is what we do.
19708 - If the cursor is on a statistics cookie, update it.
19710 - If the cursor is in a headline, prompt for tags and insert them
19711 into the current line, aligned to `org-tags-column'. When called
19712 with prefix arg, realign all tags in the current buffer.
19714 - If the cursor is in one of the special #+KEYWORD lines, this
19715 triggers scanning the buffer for these lines and updating the
19716 information.
19718 - If the cursor is inside a table, realign the table. This command
19719 works even if the automatic table editor has been turned off.
19721 - If the cursor is on a #+TBLFM line, re-apply the formulas to
19722 the entire table.
19724 - If the cursor is at a footnote reference or definition, jump to
19725 the corresponding definition or references, respectively.
19727 - If the cursor is a the beginning of a dynamic block, update it.
19729 - If the current buffer is a capture buffer, close note and file it.
19731 - If the cursor is on a <<<target>>>, update radio targets and
19732 corresponding links in this buffer.
19734 - If the cursor is on a numbered item in a plain list, renumber the
19735 ordered list.
19737 - If the cursor is on a checkbox, toggle it.
19739 - If the cursor is on a code block, evaluate it. The variable
19740 `org-confirm-babel-evaluate' can be used to control prompting
19741 before code block evaluation, by default every code block
19742 evaluation requires confirmation. Code block evaluation can be
19743 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
19744 (interactive "P")
19745 (cond
19746 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
19747 org-occur-highlights
19748 org-latex-fragment-image-overlays)
19749 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
19750 (org-remove-occur-highlights)
19751 (org-remove-latex-fragment-image-overlays)
19752 (message "Temporary highlights/overlays removed from current buffer"))
19753 ((and (local-variable-p 'org-finish-function (current-buffer))
19754 (fboundp org-finish-function))
19755 (funcall org-finish-function))
19756 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
19757 (t
19758 (let* ((context (org-element-context)) (type (org-element-type context)))
19759 ;; Test if point is within a blank line.
19761 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19762 (user-error "C-c C-c can do nothing useful at this location"))
19763 ;; For convenience: at the first line of a paragraph on the
19764 ;; same line as an item, apply function on that item instead.
19765 (when (eq type 'paragraph)
19766 (let ((parent (org-element-property :parent context)))
19767 (when (and (eq (org-element-type parent) 'item)
19768 (= (point-at-bol) (org-element-property :begin parent)))
19769 (setq context parent type 'item))))
19770 ;; Act according to type of element or object at point.
19771 (case type
19772 (clock (org-clock-update-time-maybe))
19773 (dynamic-block
19774 (save-excursion
19775 (goto-char (org-element-property :post-affiliated context))
19776 (org-update-dblock)))
19777 (footnote-definition
19778 (goto-char (org-element-property :post-affiliated context))
19779 (call-interactively 'org-footnote-action))
19780 (footnote-reference (call-interactively 'org-footnote-action))
19781 ((headline inlinetask)
19782 (save-excursion (goto-char (org-element-property :begin context))
19783 (call-interactively 'org-set-tags)))
19784 (item
19785 ;; At an item: a double C-u set checkbox to "[-]"
19786 ;; unconditionally, whereas a single one will toggle its
19787 ;; presence. Without an universal argument, if the item
19788 ;; has a checkbox, toggle it. Otherwise repair the list.
19789 (let* ((box (org-element-property :checkbox context))
19790 (struct (org-element-property :structure context))
19791 (old-struct (copy-tree struct))
19792 (parents (org-list-parents-alist struct))
19793 (prevs (org-list-prevs-alist struct))
19794 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
19795 (org-list-set-checkbox
19796 (org-element-property :begin context) struct
19797 (cond ((equal arg '(16)) "[-]")
19798 ((and (not box) (equal arg '(4))) "[ ]")
19799 ((or (not box) (equal arg '(4))) nil)
19800 ((eq box 'on) "[ ]")
19801 (t "[X]")))
19802 ;; Mimic `org-list-write-struct' but with grabbing
19803 ;; a return value from `org-list-struct-fix-box'.
19804 (org-list-struct-fix-ind struct parents 2)
19805 (org-list-struct-fix-item-end struct)
19806 (org-list-struct-fix-bul struct prevs)
19807 (org-list-struct-fix-ind struct parents)
19808 (let ((block-item
19809 (org-list-struct-fix-box struct parents prevs orderedp)))
19810 (if (and box (equal struct old-struct))
19811 (if (equal arg '(16))
19812 (message "Checkboxes already reset")
19813 (user-error "Cannot toggle this checkbox: %s"
19814 (if (eq box 'on)
19815 "all subitems checked"
19816 "unchecked subitems")))
19817 (org-list-struct-apply-struct struct old-struct)
19818 (org-update-checkbox-count-maybe))
19819 (when block-item
19820 (message "Checkboxes were removed due to empty box at line %d"
19821 (org-current-line block-item))))))
19822 (keyword
19823 (let ((org-inhibit-startup-visibility-stuff t)
19824 (org-startup-align-all-tables nil))
19825 (when (boundp 'org-table-coordinate-overlays)
19826 (mapc 'delete-overlay org-table-coordinate-overlays)
19827 (setq org-table-coordinate-overlays nil))
19828 (org-save-outline-visibility 'use-markers (org-mode-restart)))
19829 (message "Local setup has been refreshed"))
19830 (plain-list
19831 ;; At a plain list, with a double C-u argument, set
19832 ;; checkboxes of each item to "[-]", whereas a single one
19833 ;; will toggle their presence according to the state of the
19834 ;; first item in the list. Without an argument, repair the
19835 ;; list.
19836 (let* ((begin (org-element-property :contents-begin context))
19837 (struct (org-element-property :structure context))
19838 (old-struct (copy-tree struct))
19839 (first-box (save-excursion
19840 (goto-char begin)
19841 (looking-at org-list-full-item-re)
19842 (match-string-no-properties 3)))
19843 (new-box (cond ((equal arg '(16)) "[-]")
19844 ((equal arg '(4)) (unless first-box "[ ]"))
19845 ((equal first-box "[X]") "[ ]")
19846 (t "[X]"))))
19847 (cond
19848 (arg
19849 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
19850 (org-list-get-all-items
19851 begin struct (org-list-prevs-alist struct))))
19852 ((and first-box (eq (point) begin))
19853 ;; For convenience, when point is at bol on the first
19854 ;; item of the list and no argument is provided, simply
19855 ;; toggle checkbox of that item, if any.
19856 (org-list-set-checkbox begin struct new-box)))
19857 (org-list-write-struct
19858 struct (org-list-parents-alist struct) old-struct)
19859 (org-update-checkbox-count-maybe)
19860 (save-excursion (goto-char begin) (org-list-send-list 'maybe))))
19861 ((property-drawer node-property)
19862 (call-interactively 'org-property-action))
19863 ((radio-target target)
19864 (call-interactively 'org-update-radio-target-regexp))
19865 (statistics-cookie
19866 (call-interactively 'org-update-statistics-cookies))
19867 ((table table-cell table-row)
19868 ;; At a table, recalculate every field and align it. Also
19869 ;; send the table if necessary. If the table has
19870 ;; a `table.el' type, just give up. At a table row or
19871 ;; cell, maybe recalculate line but always align table.
19872 (if (eq (org-element-property :type context) 'table.el)
19873 (message "Use C-c ' to edit table.el tables")
19874 (let ((org-enable-table-editor t))
19875 (if (or (eq type 'table)
19876 ;; Check if point is at a TBLFM line.
19877 (and (eq type 'table-row)
19878 (= (point) (org-element-property :end context))))
19879 (save-excursion
19880 (goto-char (org-element-property :contents-begin context))
19881 (org-call-with-arg 'org-table-recalculate (or arg t))
19882 (orgtbl-send-table 'maybe))
19883 (org-table-maybe-eval-formula)
19884 (cond (arg (call-interactively 'org-table-recalculate))
19885 ((org-table-maybe-recalculate-line))
19886 (t (org-table-align)))))))
19887 (timestamp (org-timestamp-change 0 'day))
19888 (otherwise
19889 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
19890 (user-error
19891 "C-c C-c can do nothing useful at this location")))))))))
19893 (defun org-mode-restart ()
19894 "Restart Org-mode, to scan again for special lines.
19895 Also updates the keyword regular expressions."
19896 (interactive)
19897 (org-mode)
19898 (message "Org-mode restarted"))
19900 (defun org-kill-note-or-show-branches ()
19901 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
19902 (interactive)
19903 (if (not org-finish-function)
19904 (progn
19905 (hide-subtree)
19906 (call-interactively 'show-branches))
19907 (let ((org-note-abort t))
19908 (funcall org-finish-function))))
19910 (defun org-return (&optional indent)
19911 "Goto next table row or insert a newline.
19912 Calls `org-table-next-row' or `newline', depending on context.
19913 See the individual commands for more information."
19914 (interactive)
19915 (let (org-ts-what)
19916 (cond
19917 ((or (bobp) (org-in-src-block-p))
19918 (if indent (newline-and-indent) (newline)))
19919 ((org-at-table-p)
19920 (org-table-justify-field-maybe)
19921 (call-interactively 'org-table-next-row))
19922 ;; when `newline-and-indent' is called within a list, make sure
19923 ;; text moved stays inside the item.
19924 ((and (org-in-item-p) indent)
19925 (if (and (org-at-item-p) (>= (point) (match-end 0)))
19926 (progn
19927 (save-match-data (newline))
19928 (org-indent-line-to (length (match-string 0))))
19929 (let ((ind (org-get-indentation)))
19930 (newline)
19931 (if (org-looking-back org-list-end-re)
19932 (org-indent-line)
19933 (org-indent-line-to ind)))))
19934 ((and org-return-follows-link
19935 (org-at-timestamp-p t)
19936 (not (eq org-ts-what 'after)))
19937 (org-follow-timestamp-link))
19938 ((and org-return-follows-link
19939 (let ((tprop (get-text-property (point) 'face)))
19940 (or (eq tprop 'org-link)
19941 (and (listp tprop) (memq 'org-link tprop)))))
19942 (call-interactively 'org-open-at-point))
19943 ((and (org-at-heading-p)
19944 (looking-at
19946 (org-show-entry)
19947 (end-of-line 1)
19948 (newline))
19949 (t (if indent (newline-and-indent) (newline))))))
19951 (defun org-return-indent ()
19952 "Goto next table row or insert a newline and indent.
19953 Calls `org-table-next-row' or `newline-and-indent', depending on
19954 context. See the individual commands for more information."
19955 (interactive)
19956 (org-return t))
19958 (defun org-ctrl-c-star ()
19959 "Compute table, or change heading status of lines.
19960 Calls `org-table-recalculate' or `org-toggle-heading',
19961 depending on context."
19962 (interactive)
19963 (cond
19964 ((org-at-table-p)
19965 (call-interactively 'org-table-recalculate))
19966 (t
19967 ;; Convert all lines in region to list items
19968 (call-interactively 'org-toggle-heading))))
19970 (defun org-ctrl-c-minus ()
19971 "Insert separator line in table or modify bullet status of line.
19972 Also turns a plain line or a region of lines into list items.
19973 Calls `org-table-insert-hline', `org-toggle-item', or
19974 `org-cycle-list-bullet', depending on context."
19975 (interactive)
19976 (cond
19977 ((org-at-table-p)
19978 (call-interactively 'org-table-insert-hline))
19979 ((org-region-active-p)
19980 (call-interactively 'org-toggle-item))
19981 ((org-in-item-p)
19982 (call-interactively 'org-cycle-list-bullet))
19983 (t
19984 (call-interactively 'org-toggle-item))))
19986 (defun org-toggle-item (arg)
19987 "Convert headings or normal lines to items, items to normal lines.
19988 If there is no active region, only the current line is considered.
19990 If the first non blank line in the region is a headline, convert
19991 all headlines to items, shifting text accordingly.
19993 If it is an item, convert all items to normal lines.
19995 If it is normal text, change region into an item. With a prefix
19996 argument ARG, change each line in region into an item."
19997 (interactive "P")
19998 (let ((shift-text
19999 (function
20000 ;; Shift text in current section to IND, from point to END.
20001 ;; The function leaves point to END line.
20002 (lambda (ind end)
20003 (let ((min-i 1000) (end (copy-marker end)))
20004 ;; First determine the minimum indentation (MIN-I) of
20005 ;; the text.
20006 (save-excursion
20007 (catch 'exit
20008 (while (< (point) end)
20009 (let ((i (org-get-indentation)))
20010 (cond
20011 ;; Skip blank lines and inline tasks.
20013 ((looking-at org-outline-regexp-bol))
20014 ;; We can't find less than 0 indentation.
20015 ((zerop i) (throw 'exit (setq min-i 0)))
20016 ((< i min-i) (setq min-i i))))
20017 (forward-line))))
20018 ;; Then indent each line so that a line indented to
20019 ;; MIN-I becomes indented to IND. Ignore blank lines
20020 ;; and inline tasks in the process.
20021 (let ((delta (- ind min-i)))
20022 (while (< (point) end)
20024 (looking-at org-outline-regexp-bol))
20025 (org-indent-line-to (+ (org-get-indentation) delta)))
20026 (forward-line)))))))
20027 (skip-blanks
20028 (function
20029 ;; Return beginning of first non-blank line, starting from
20030 ;; line at POS.
20031 (lambda (pos)
20032 (save-excursion
20033 (goto-char pos)
20035 (point-at-bol)))))
20036 beg end)
20037 ;; Determine boundaries of changes.
20038 (if (org-region-active-p)
20039 (setq beg (funcall skip-blanks (region-beginning))
20040 end (copy-marker (region-end)))
20041 (setq beg (funcall skip-blanks (point-at-bol))
20042 end (copy-marker (point-at-eol))))
20043 ;; Depending on the starting line, choose an action on the text
20044 ;; between BEG and END.
20045 (org-with-limited-levels
20046 (save-excursion
20047 (goto-char beg)
20048 (cond
20049 ;; Case 1. Start at an item: de-itemize. Note that it only
20050 ;; happens when a region is active: `org-ctrl-c-minus'
20051 ;; would call `org-cycle-list-bullet' otherwise.
20052 ((org-at-item-p)
20053 (while (< (point) end)
20054 (when (org-at-item-p)
20056 (delete-region (point) (match-end 0)))
20057 (forward-line)))
20058 ;; Case 2. Start at an heading: convert to items.
20059 ((org-at-heading-p)
20060 (let* ((bul (org-list-bullet-string "-"))
20061 (bul-len (length bul))
20062 ;; Indentation of the first heading. It should be
20063 ;; relative to the indentation of its parent, if any.
20064 (start-ind (save-excursion
20065 (cond
20066 ((not org-adapt-indentation) 0)
20067 ((not (outline-previous-heading)) 0)
20068 (t (length (match-string 0))))))
20069 ;; Level of first heading. Further headings will be
20070 ;; compared to it to determine hierarchy in the list.
20071 (ref-level (org-reduced-level (org-outline-level))))
20072 (while (< (point) end)
20073 (let* ((level (org-reduced-level (org-outline-level)))
20074 (delta (max 0 (- level ref-level))))
20075 ;; If current headline is less indented than the first
20076 ;; one, set it as reference, in order to preserve
20077 ;; subtrees.
20078 (when (< level ref-level) (setq ref-level level))
20079 (replace-match bul t t)
20080 (org-indent-line-to (+ start-ind (* delta bul-len)))
20081 ;; Ensure all text down to END (or SECTION-END) belongs
20082 ;; to the newly created item.
20083 (let ((section-end (save-excursion
20084 (or (outline-next-heading) (point)))))
20085 (forward-line)
20086 (funcall shift-text
20087 (+ start-ind (* (1+ delta) bul-len))
20088 (min end section-end)))))))
20089 ;; Case 3. Normal line with ARG: turn each non-item line into
20090 ;; an item.
20091 (arg
20092 (while (< (point) end)
20093 (unless (or (org-at-heading-p) (org-at-item-p))
20095 (replace-match
20097 (forward-line)))
20098 ;; Case 4. Normal line without ARG: make the first line of
20099 ;; region an item, and shift indentation of others
20100 ;; lines to set them as item's body.
20101 (t (let* ((bul (org-list-bullet-string "-"))
20102 (bul-len (length bul))
20103 (ref-ind (org-get-indentation)))
20105 (insert bul)
20106 (forward-line)
20107 (while (< (point) end)
20108 ;; Ensure that lines less indented than first one
20109 ;; still get included in item body.
20110 (funcall shift-text
20111 (+ ref-ind bul-len)
20112 (min end (save-excursion (or (outline-next-heading)
20113 (point)))))
20114 (forward-line)))))))))
20116 (defun org-toggle-heading (&optional nstars)
20117 "Convert headings to normal text, or items or text to headings.
20118 If there is no active region, only the current line is considered.
20121 point into heading.
20123 In a region:
20125 - If the first non blank line is a headline, remove the stars
20126 from all headlines in the region.
20128 - If it is a normal line turn each and every normal line (i.e. not an
20129 heading or an item) in the region into a heading.
20131 - If it is a plain list item, turn all plain list items into headings.
20133 When converting a line into a heading, the number of stars is chosen
20134 such that the lines become children of the current entry. However,
20135 when a prefix argument is given, its value determines the number of
20136 stars to add."
20137 (interactive "P")
20138 (let ((skip-blanks
20139 (function
20140 ;; Return beginning of first non-blank line, starting from
20141 ;; line at POS.
20142 (lambda (pos)
20143 (save-excursion
20144 (goto-char pos)
20145 (while (org-at-comment-p) (forward-line))
20147 (point-at-bol)))))
20148 beg end toggled)
20149 ;; Determine boundaries of changes. If a universal prefix has
20150 ;; been given, put the list in a region. If region ends at a bol,
20151 ;; do not consider the last line to be in the region.
20153 (when (and current-prefix-arg (org-at-item-p))
20154 (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
20155 (org-mark-element))
20157 (if (org-region-active-p)
20158 (setq beg (funcall skip-blanks (region-beginning))
20159 end (copy-marker (save-excursion
20160 (goto-char (region-end))
20161 (if (bolp) (point) (point-at-eol)))))
20162 (setq beg (funcall skip-blanks (point-at-bol))
20163 end (copy-marker (point-at-eol))))
20164 ;; Ensure inline tasks don't count as headings.
20165 (org-with-limited-levels
20166 (save-excursion
20167 (goto-char beg)
20168 (cond
20169 ;; Case 1. Started at an heading: de-star headings.
20170 ((org-at-heading-p)
20171 (while (< (point) end)
20172 (when (org-at-heading-p t)
20173 (looking-at org-outline-regexp) (replace-match "")
20174 (setq toggled t))
20175 (forward-line)))
20176 ;; Case 2. Started at an item: change items into headlines.
20177 ;; One star will be added by `org-list-to-subtree'.
20178 ((org-at-item-p)
20179 (let* ((stars (make-string
20180 (if nstars
20181 ;; subtract the star that will be added again by
20182 ;; `org-list-to-subtree'
20183 (1- (prefix-numeric-value current-prefix-arg))
20184 (or (org-current-level) 0))
20185 ?*))
20186 (add-stars
20187 (cond (nstars "") ; stars from prefix only
20188 ((equal stars "") "") ; before first heading
20189 (org-odd-levels-only "*") ; inside heading, odd
20190 (t "")))) ; inside heading, oddeven
20191 (while (< (point) end)
20192 (when (org-at-item-p)
20193 ;; Pay attention to cases when region ends before list.
20194 (let* ((struct (org-list-struct))
20195 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20196 (save-restriction
20197 (narrow-to-region (point) list-end)
20198 (insert
20199 (org-list-to-subtree
20200 (org-list-parse-list t)
20201 '(:istart (concat stars add-stars (funcall get-stars depth))
20202 :icount (concat stars add-stars (funcall get-stars depth)))))))
20203 (setq toggled t))
20204 (forward-line))))
20205 ;; Case 3. Started at normal text: make every line an heading,
20206 ;; skipping headlines and items.
20207 (t (let* ((stars (make-string
20208 (if nstars
20209 (prefix-numeric-value current-prefix-arg)
20210 (or (org-current-level) 0))
20211 ?*))
20212 (add-stars
20213 (cond (nstars "") ; stars from prefix only
20214 ((equal stars "") "*") ; before first heading
20215 (org-odd-levels-only "**") ; inside heading, odd
20216 (t "*"))) ; inside heading, oddeven
20217 (rpl (concat stars add-stars " ")))
20218 (while (< (point) end)
20219 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20221 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20222 (forward-line)))))))
20223 (unless toggled (message "Cannot toggle heading from here"))))
20225 (defun org-meta-return (&optional arg)
20226 "Insert a new heading or wrap a region in a table.
20227 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20228 See the individual commands for more information."
20229 (interactive "P")
20230 (cond
20231 ((run-hook-with-args-until-success 'org-metareturn-hook))
20232 ((or (org-at-drawer-p) (org-at-property-p))
20233 (newline-and-indent))
20234 ((org-at-table-p)
20235 (call-interactively 'org-table-wrap-region))
20236 (t (call-interactively 'org-insert-heading))))
20238 ;;; Menu entries
20240 (defsubst org-in-subtree-not-table-p ()
20241 "Are we in a subtree and not in a table?"
20242 (and (not (org-before-first-heading-p))
20243 (not (org-at-table-p))))
20245 ;; Define the Org-mode menus
20246 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20247 '("Tbl"
20248 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20249 ["Next Field" org-cycle (org-at-table-p)]
20250 ["Previous Field" org-shifttab (org-at-table-p)]
20251 ["Next Row" org-return (org-at-table-p)]
20252 "--"
20253 ["Blank Field" org-table-blank-field (org-at-table-p)]
20254 ["Edit Field" org-table-edit-field (org-at-table-p)]
20255 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20256 "--"
20257 ("Column"
20258 ["Move Column Left" org-metaleft (org-at-table-p)]
20259 ["Move Column Right" org-metaright (org-at-table-p)]
20260 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20261 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20262 ("Row"
20263 ["Move Row Up" org-metaup (org-at-table-p)]
20264 ["Move Row Down" org-metadown (org-at-table-p)]
20265 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20266 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20267 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20268 "--"
20269 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20270 ("Rectangle"
20271 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20272 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20273 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20274 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20275 "--"
20276 ("Calculate"
20277 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20278 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20279 ["Edit Formulas" org-edit-special (org-at-table-p)]
20280 "--"
20281 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20282 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20283 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20284 "--"
20285 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20286 "--"
20287 ["Sum Column/Rectangle" org-table-sum
20288 (or (org-at-table-p) (org-region-active-p))]
20289 ["Which Column?" org-table-current-column (org-at-table-p)])
20290 ["Debug Formulas"
20291 org-table-toggle-formula-debugger
20292 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20293 ["Show Col/Row Numbers"
20294 org-table-toggle-coordinate-overlays
20295 :style toggle
20296 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20297 "--"
20298 ["Create" org-table-create (and (not (org-at-table-p))
20299 org-enable-table-editor)]
20300 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20301 ["Import from File" org-table-import (not (org-at-table-p))]
20302 ["Export to File" org-table-export (org-at-table-p)]
20303 "--"
20304 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20306 (easy-menu-define org-org-menu org-mode-map "Org menu"
20307 '("Org"
20308 ("Show/Hide"
20309 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20310 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20311 ["Sparse Tree..." org-sparse-tree t]
20312 ["Reveal Context" org-reveal t]
20313 ["Show All" show-all t]
20314 "--"
20315 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20316 "--"
20317 ["New Heading" org-insert-heading t]
20318 ("Navigate Headings"
20319 ["Up" outline-up-heading t]
20320 ["Next" outline-next-visible-heading t]
20321 ["Previous" outline-previous-visible-heading t]
20322 ["Next Same Level" outline-forward-same-level t]
20323 ["Previous Same Level" outline-backward-same-level t]
20324 "--"
20325 ["Jump" org-goto t])
20326 ("Edit Structure"
20327 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20328 "--"
20329 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20330 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20331 "--"
20332 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20333 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20334 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20335 "--"
20336 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20337 "--"
20338 ["Copy visible text" org-copy-visible t]
20339 "--"
20340 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20341 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20342 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20343 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20344 "--"
20345 ["Sort Region/Children" org-sort t]
20346 "--"
20347 ["Convert to odd levels" org-convert-to-odd-levels t]
20348 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20349 ("Editing"
20350 ["Emphasis..." org-emphasize t]
20351 ["Edit Source Example" org-edit-special t]
20352 "--"
20353 ["Footnote new/jump" org-footnote-action t]
20354 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20355 ("Archive"
20356 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20357 "--"
20358 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20359 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20360 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20361 )
20362 "--"
20363 ("Hyperlinks"
20364 ["Store Link (Global)" org-store-link t]
20365 ["Find existing link to here" org-occur-link-in-agenda-files t]
20366 ["Insert Link" org-insert-link t]
20367 ["Follow Link" org-open-at-point t]
20368 "--"
20369 ["Next link" org-next-link t]
20370 ["Previous link" org-previous-link t]
20371 "--"
20372 ["Descriptive Links"
20373 org-toggle-link-display
20374 :style radio
20375 :selected org-descriptive-links
20376 ]
20377 ["Literal Links"
20378 org-toggle-link-display
20379 :style radio
20380 :selected (not org-descriptive-links)])
20381 "--"
20382 ("TODO Lists"
20383 ["TODO/DONE/-" org-todo t]
20384 ("Select keyword"
20385 ["Next keyword" org-shiftright (org-at-heading-p)]
20386 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20387 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20388 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20389 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20390 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20391 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20392 "--"
20393 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20394 :selected org-enforce-todo-dependencies :style toggle :active t]
20395 "Settings for tree at point"
20396 ["Do Children sequentially" org-toggle-ordered-property :style radio
20397 :selected (org-entry-get nil "ORDERED")
20398 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20399 ["Do Children parallel" org-toggle-ordered-property :style radio
20400 :selected (not (org-entry-get nil "ORDERED"))
20401 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20402 "--"
20403 ["Set Priority" org-priority t]
20404 ["Priority Up" org-shiftup t]
20405 ["Priority Down" org-shiftdown t]
20406 "--"
20407 ["Get news from all feeds" org-feed-update-all t]
20408 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20409 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20410 ("TAGS and Properties"
20411 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20412 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20413 "--"
20414 ["Set property" org-set-property (not (org-before-first-heading-p))]
20415 ["Column view of properties" org-columns t]
20416 ["Insert Column View DBlock" org-insert-columns-dblock t])
20417 ("Dates and Scheduling"
20418 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20419 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20420 ("Change Date"
20421 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20422 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20423 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20424 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20425 ["Compute Time Range" org-evaluate-time-range t]
20426 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20427 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20428 "--"
20429 ["Custom time format" org-toggle-time-stamp-overlays
20430 :style radio :selected org-display-custom-times]
20431 "--"
20432 ["Goto Calendar" org-goto-calendar t]
20433 ["Date from Calendar" org-date-from-calendar t]
20434 "--"
20435 ["Start/Restart Timer" org-timer-start t]
20436 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20437 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20438 ["Insert Timer String" org-timer t]
20439 ["Insert Timer Item" org-timer-item t])
20440 ("Logging work"
20441 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20442 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20443 ["Clock out" org-clock-out t]
20444 ["Clock cancel" org-clock-cancel t]
20445 "--"
20446 ["Mark as default task" org-clock-mark-default-task t]
20447 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20448 ["Goto running clock" org-clock-goto t]
20449 "--"
20450 ["Display times" org-clock-display t]
20451 ["Create clock table" org-clock-report t]
20452 "--"
20453 ["Record DONE time"
20454 (progn (setq org-log-done (not org-log-done))
20455 (message "Switching to %s will %s record a timestamp"
20456 (car org-done-keywords)
20457 (if org-log-done "automatically" "not")))
20458 :style toggle :selected org-log-done])
20459 "--"
20460 ["Agenda Command..." org-agenda t]
20461 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20462 ("File List for Agenda")
20463 ("Special views current file"
20464 ["TODO Tree" org-show-todo-tree t]
20465 ["Check Deadlines" org-check-deadlines t]
20466 ["Timeline" org-timeline t]
20467 ["Tags/Property tree" org-match-sparse-tree t])
20468 "--"
20469 ["Export/Publish..." org-export-dispatch t]
20470 ("LaTeX"
20471 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20472 :selected org-cdlatex-mode]
20473 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20474 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20475 ["Modify math symbol" org-cdlatex-math-modify
20476 (org-inside-LaTeX-fragment-p)]
20477 ["Insert citation" org-reftex-citation t]
20478 "--"
20479 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20480 "--"
20481 ("MobileOrg"
20482 ["Push Files and Views" org-mobile-push t]
20483 ["Get Captured and Flagged" org-mobile-pull t]
20484 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20485 "--"
20486 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20487 "--"
20488 ("Documentation"
20489 ["Show Version" org-version t]
20490 ["Info Documentation" org-info t])
20491 ("Customize"
20492 ["Browse Org Group" org-customize t]
20493 "--"
20494 ["Expand This Menu" org-create-customize-menu
20495 (fboundp 'customize-menu-create)])
20496 ["Send bug report" org-submit-bug-report t]
20497 "--"
20498 ("Refresh/Reload"
20499 ["Refresh setup current buffer" org-mode-restart t]
20500 ["Reload Org (after update)" org-reload t]
20501 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20502 ))
20504 (defun org-info (&optional node)
20505 "Read documentation for Org-mode in the info system.
20506 With optional NODE, go directly to that node."
20507 (interactive)
20508 (info (format "(org)%s" (or node ""))))
20510 ;;;###autoload
20511 (defun org-submit-bug-report ()
20512 "Submit a bug report on Org-mode via mail.
20514 Don't hesitate to report any problems or inaccurate documentation.
20516 If you don't have setup sending mail from (X)Emacs, please copy the
20517 output buffer into your mail program, as it gives us important
20518 information about your Org-mode version and configuration."
20519 (interactive)
20520 (require 'reporter)
20521 (org-load-modules-maybe)
20522 (org-require-autoloaded-modules)
20523 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20524 (reporter-submit-bug-report
20525 "emacs-orgmode@gnu.org"
20526 (org-version nil 'full)
20527 (let (list)
20528 (save-window-excursion
20529 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20530 (delete-other-windows)
20531 (erase-buffer)
20532 (insert "You are about to submit a bug report to the Org-mode mailing list.
20534 We would like to add your full Org-mode and Outline configuration to the
20535 bug report. This greatly simplifies the work of the maintainer and
20536 other experts on the mailing list.
20538 HOWEVER, some variables you have customized may contain private
20539 information. The names of customers, colleagues, or friends, might
20540 appear in the form of file names, tags, todo states, or search strings.
20541 If you answer yes to the prompt, you might want to check and remove
20542 such private information before sending the email.")
20543 (add-text-properties (point-min) (point-max) '(face org-warning))
20544 (when (yes-or-no-p "Include your Org-mode configuration ")
20545 (mapatoms
20546 (lambda (v)
20547 (and (boundp v)
20549 (or (and (symbol-value v)
20551 (and
20552 (get v 'custom-type) (get v 'standard-value)
20553 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20554 (push v list)))))
20555 (kill-buffer (get-buffer "*Warn about privacy*"))
20556 list))
20557 nil nil
20558 "Remember to cover the basics, that is, what you expected to happen and
20559 what in fact did happen. You don't know how to make a good report? See
20561 http://orgmode.org/manual/Feedback.html#Feedback
20563 Your bug report will be posted to the Org-mode mailing list.
20564 ------------------------------------------------------------------------")
20565 (save-excursion
20570 (defun org-install-agenda-files-menu ()
20571 (let ((bl (buffer-list)))
20572 (save-excursion
20573 (while bl
20574 (set-buffer (pop bl))
20575 (if (derived-mode-p 'org-mode) (setq bl nil)))
20576 (when (derived-mode-p 'org-mode)
20577 (easy-menu-change
20578 '("Org") "File List for Agenda"
20579 (append
20580 (list
20581 ["Edit File List" (org-edit-agenda-file-list) t]
20582 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20583 ["Remove Current File from List" org-remove-file t]
20584 ["Cycle through agenda files" org-cycle-agenda-files t]
20585 ["Occur in all agenda files" org-occur-in-agenda-files t]
20586 "--")
20587 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20589 ;;;; Documentation
20591 (defun org-require-autoloaded-modules ()
20592 (interactive)
20593 (mapc 'require
20594 '(org-agenda org-archive org-attach org-clock org-colview org-id
20595 org-remember org-table org-timer)))
20597 ;;;###autoload
20598 (defun org-reload (&optional uncompiled)
20599 "Reload all org lisp files.
20600 With prefix arg UNCOMPILED, load the uncompiled versions."
20601 (interactive "P")
20602 (require 'loadhist)
20603 (let* ((org-dir (org-find-library-dir "org"))
20604 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20606 (remove-re (mapconcat 'identity
20607 (mapcar (lambda (f) (concat "^" f "$"))
20608 (list (if (featurep 'xemacs)
20609 "org-colview"
20610 "org-colview-xemacs")
20611 "org" "org-loaddefs" "org-version"))
20613 (feats (delete-dups
20614 (mapcar 'file-name-sans-extension
20615 (mapcar 'file-name-nondirectory
20616 (delq nil
20617 (mapcar 'feature-file
20618 features))))))
20619 (lfeat (append
20620 (sort
20621 (setq feats
20622 (delq nil (mapcar
20623 (lambda (f)
20624 (if (and (string-match feature-re f)
20625 (not (string-match remove-re f)))
20626 f nil))
20627 feats)))
20628 'string-lessp)
20629 (list "org-version" "org")))
20630 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
20631 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20632 load-uncore load-misses)
20633 (setq load-misses
20634 (delq 't
20635 (mapcar (lambda (f)
20636 (or (org-load-noerror-mustsuffix (concat org-dir f))
20637 (and (string= org-dir contrib-dir)
20638 (org-load-noerror-mustsuffix (concat contrib-dir f)))
20639 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
20640 (add-to-list 'load-uncore f 'append)
20641 't)
20642 f))
20643 lfeat)))
20644 (if load-uncore
20646 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20647 (if load-misses
20649 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20652 ;;;###autoload
20653 (defun org-customize ()
20654 "Call the customize function with org as argument."
20655 (interactive)
20656 (org-load-modules-maybe)
20657 (org-require-autoloaded-modules)
20658 (customize-browse 'org))
20660 (defun org-create-customize-menu ()
20661 "Create a full customization menu for Org-mode, insert it into the menu."
20662 (interactive)
20663 (org-load-modules-maybe)
20664 (org-require-autoloaded-modules)
20665 (if (fboundp 'customize-menu-create)
20666 (progn
20667 (easy-menu-change
20668 '("Org") "Customize"
20669 `(["Browse Org group" org-customize t]
20670 "--"
20671 ,(customize-menu-create 'org)
20672 ["Set" Custom-set t]
20673 ["Save" Custom-save t]
20674 ["Reset to Current" Custom-reset-current t]
20675 ["Reset to Saved" Custom-reset-saved t]
20676 ["Reset to Standard Settings" Custom-reset-standard t]))
20678 (error "Cannot expand menu (outdated version of cus-edit.el)")))
20680 ;;;; Miscellaneous stuff
20682 ;;; Generally useful functions
20684 (defun org-get-at-bol (property)
20685 "Get text property PROPERTY at beginning of line."
20686 (get-text-property (point-at-bol) property))
20688 (defun org-find-text-property-in-string (prop s)
20689 "Return the first non-nil value of property PROP in string S."
20690 (or (get-text-property 0 prop s)
20691 (get-text-property (or (next-single-property-change 0 prop s) 0)
20692 prop s)))
20694 (defun org-display-warning (message) ;; Copied from Emacs-Muse
20695 "Display the given MESSAGE as a warning."
20696 (if (fboundp 'display-warning)
20697 (display-warning 'org message
20698 (if (featurep 'xemacs) 'warning :warning))
20699 (let ((buf (get-buffer-create "*Org warnings*")))
20700 (with-current-buffer buf
20701 (goto-char (point-max))
20702 (insert "Warning (Org): " message)
20703 (unless (bolp)
20704 (newline)))
20705 (display-buffer buf)
20706 (sit-for 0))))
20708 (defun org-eval (form)
20709 "Eval FORM and return result."
20710 (condition-case error
20711 (eval form)
20712 (error (format "%%![Error: %s]" error))))
20714 (defun org-in-clocktable-p ()
20715 "Check if the cursor is in a clocktable."
20716 (let ((pos (point)) start)
20717 (save-excursion
20718 (end-of-line 1)
20720 (setq start (match-beginning 0))
20722 (>= (match-end 0) pos)
20723 start))))
20725 (defun org-in-commented-line ()
20726 "Is point in a line starting with `#'?"
20727 (equal (char-after (point-at-bol)) ?#))
20729 (defun org-in-indented-comment-line ()
20730 "Is point in a line starting with `#' after some white space?"
20731 (save-excursion
20732 (save-match-data
20733 (goto-char (point-at-bol))
20736 (defun org-in-verbatim-emphasis ()
20737 (save-match-data
20738 (and (org-in-regexp org-emph-re 2)
20739 (>= (point) (match-beginning 3))
20740 (<= (point) (match-end 4))
20741 (member (match-string 3) '("=" "~")))))
20743 (defun org-goto-marker-or-bmk (marker &optional bookmark)
20744 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
20745 (if (and marker (marker-buffer marker)
20746 (buffer-live-p (marker-buffer marker)))
20747 (progn
20748 (org-pop-to-buffer-same-window (marker-buffer marker))
20749 (if (or (> marker (point-max)) (< marker (point-min)))
20750 (widen))
20751 (goto-char marker)
20752 (org-show-context 'org-goto))
20753 (if bookmark
20754 (bookmark-jump bookmark)
20755 (error "Cannot find location"))))
20757 (defun org-quote-csv-field (s)
20758 "Quote field for inclusion in CSV material."
20761 s))
20763 (defun org-force-self-insert (N)
20764 "Needed to enforce self-insert under remapping."
20765 (interactive "p")
20766 (self-insert-command N))
20768 (defun org-string-width (s)
20769 "Compute width of string, ignoring invisible characters.
20770 This ignores character with invisibility property `org-link', and also
20771 characters with property `org-cwidth', because these will become invisible
20772 upon the next fontification round."
20773 (let (b l)
20774 (when (or (eq t buffer-invisibility-spec)
20775 (assq 'org-link buffer-invisibility-spec))
20776 (while (setq b (text-property-any 0 (length s)
20777 'invisible 'org-link s))
20778 (setq s (concat (substring s 0 b)
20779 (substring s (or (next-single-property-change
20780 b 'invisible s) (length s)))))))
20781 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
20782 (setq s (concat (substring s 0 b)
20783 (substring s (or (next-single-property-change
20784 b 'org-cwidth s) (length s))))))
20785 (setq l (string-width s) b -1)
20786 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
20787 (setq l (- l (get-text-property b 'org-dwidth-n s))))
20788 l))
20790 (defun org-shorten-string (s maxlength)
20791 "Shorten string S so tht it is no longer than MAXLENGTH characters.
20792 If the string is shorter or has length MAXLENGTH, just return the
20793 original string. If it is longer, the functions finds a space in the
20794 string, breaks this string off at that locations and adds three dots
20795 as ellipsis. Including the ellipsis, the string will not be longer
20796 than MAXLENGTH. If finding a good breaking point in the string does
20797 not work, the string is just chopped off in the middle of a word
20798 if necessary."
20799 (if (<= (length s) maxlength)
20800 s
20801 (let* ((n (max (- maxlength 4) 1))
20803 (if (string-match re s)
20804 (concat (match-string 1 s) "...")
20805 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
20807 (defun org-get-indentation (&optional line)
20808 "Get the indentation of the current line, interpreting tabs.
20809 When LINE is given, assume it represents a line and compute its indentation."
20810 (if line
20811 (if (string-match "^ *" (org-remove-tabs line))
20812 (match-end 0))
20813 (save-excursion
20814 (beginning-of-line 1)
20816 (current-column))))
20818 (defun org-get-string-indentation (s)
20819 "What indentation has S due to SPACE and TAB at the beginning of the string?"
20820 (let ((n -1) (i 0) (w tab-width) c)
20821 (catch 'exit
20822 (while (< (setq n (1+ n)) (length s))
20823 (setq c (aref s n))
20824 (cond ((= c ?\ ) (setq i (1+ i)))
20826 (t (throw 'exit t)))))
20827 i))
20829 (defun org-remove-tabs (s &optional width)
20830 "Replace tabulators in S with spaces.
20831 Assumes that s is a single line, starting in column 0."
20832 (setq width (or width tab-width))
20834 (setq s (replace-match
20835 (make-string
20836 (- (* width (/ (+ (match-beginning 0) width) width))
20837 (match-beginning 0)) ?\ )
20838 t t s)))
20839 s)
20841 (defun org-fix-indentation (line ind)
20842 "Fix indentation in LINE.
20843 IND is a cons cell with target and minimum indentation.
20844 If the current indentation in LINE is smaller than the minimum,
20845 leave it alone. If it is larger than ind, set it to the target."
20846 (let* ((l (org-remove-tabs line))
20847 (i (org-get-indentation l))
20848 (i1 (car ind)) (i2 (cdr ind)))
20849 (if (>= i i2) (setq l (substring line i2)))
20850 (if (> i1 0)
20851 (concat (make-string i1 ?\ ) l)
20852 l)))
20854 (defun org-remove-indentation (code &optional n)
20855 "Remove the maximum common indentation from the lines in CODE.
20856 N may optionally be the number of spaces to remove."
20857 (with-temp-buffer
20858 (insert code)
20859 (org-do-remove-indentation n)
20860 (buffer-string)))
20862 (defun org-do-remove-indentation (&optional n)
20863 "Remove the maximum common indentation from the buffer."
20864 (untabify (point-min) (point-max))
20865 (let ((min 10000) re)
20866 (if n
20867 (setq min n)
20868 (goto-char (point-min))
20870 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
20871 (unless (or (= min 0) (= min 10000))
20873 (goto-char (point-min))
20874 (while (re-search-forward re nil t)
20875 (replace-match "")
20876 (end-of-line 1))
20877 min)))
20879 (defun org-fill-template (template alist)
20880 "Find each %key of ALIST in TEMPLATE and replace it."
20881 (let ((case-fold-search nil)
20882 entry key value)
20883 (setq alist (sort (copy-sequence alist)
20884 (lambda (a b) (< (length (car a)) (length (car b))))))
20885 (while (setq entry (pop alist))
20886 (setq template
20887 (replace-regexp-in-string
20888 (concat "%" (regexp-quote (car entry)))
20889 (or (cdr entry) "") template t t)))
20890 template))
20892 (defun org-base-buffer (buffer)
20893 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
20894 (if (not buffer)
20895 buffer
20896 (or (buffer-base-buffer buffer)
20897 buffer)))
20899 (defun org-trim (s)
20900 "Remove whitespace at beginning and end of string."
20903 s)
20905 (defun org-wrap (string &optional width lines)
20906 "Wrap string to either a number of lines, or a width in characters.
20907 If WIDTH is non-nil, the string is wrapped to that width, however many lines
20908 that costs. If there is a word longer than WIDTH, the text is actually
20909 wrapped to the length of that word.
20910 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
20911 many lines, whatever width that takes.
20912 The return value is a list of lines, without newlines at the end."
20914 (maxword (apply 'max (mapcar 'org-string-width words)))
20915 w ll)
20916 (cond (width
20917 (org-do-wrap words (max maxword width)))
20918 (lines
20919 (setq w maxword)
20920 (setq ll (org-do-wrap words maxword))
20921 (if (<= (length ll) lines)
20922 ll
20923 (setq ll words)
20924 (while (> (length ll) lines)
20925 (setq w (1+ w))
20926 (setq ll (org-do-wrap words w)))
20927 ll))
20928 (t (error "Cannot wrap this")))))
20930 (defun org-do-wrap (words width)
20931 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
20932 (let (lines line)
20933 (while words
20934 (setq line (pop words))
20935 (while (and words (< (+ (length line) (length (car words))) width))
20936 (setq line (concat line " " (pop words))))
20937 (setq lines (push line lines)))
20938 (nreverse lines)))
20940 (defun org-split-string (string &optional separators)
20941 "Splits STRING into substrings at SEPARATORS.
20942 No empty strings are returned if there are matches at the beginning
20943 and end of string."
20945 (start 0)
20946 notfirst
20947 (list nil))
20948 (while (and (string-match rexp string
20949 (if (and notfirst
20950 (= start (match-beginning 0))
20951 (< start (length string)))
20952 (1+ start) start))
20953 (< (match-beginning 0) (length string)))
20954 (setq notfirst t)
20955 (or (eq (match-beginning 0) 0)
20956 (and (eq (match-beginning 0) (match-end 0))
20957 (eq (match-beginning 0) start))
20958 (setq list
20959 (cons (substring string start (match-beginning 0))
20960 list)))
20961 (setq start (match-end 0)))
20962 (or (eq start (length string))
20963 (setq list
20964 (cons (substring string start)
20965 list)))
20966 (nreverse list)))
20968 (defun org-quote-vert (s)
20970 (while (string-match "|" s)
20972 s)
20974 (defun org-uuidgen-p (s)
20975 "Is S an ID created by UUIDGEN?"
20976 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
20978 (defun org-in-src-block-p (&optional inside)
20979 "Whether point is in a code source block.
20980 When INSIDE is non-nil, don't consider we are within a src block
20981 when point is at #+BEGIN_SRC or #+END_SRC."
20982 (let ((case-fold-search t) ov)
20983 (or (and (setq ov (overlays-at (point)))
20984 (memq 'org-block-background
20985 (overlay-properties (car ov))))
20986 (and (not inside)
20987 (save-match-data
20988 (save-excursion
20989 (beginning-of-line)
20992 (defun org-context ()
20993 "Return a list of contexts of the current cursor position.
20994 If several contexts apply, all are returned.
20995 Each context entry is a list with a symbol naming the context, and
20996 two positions indicating start and end of the context. Possible
20997 contexts are:
20999 :headline anywhere in a headline
21000 :headline-stars on the leading stars in a headline
21001 :todo-keyword on a TODO keyword (including DONE) in a headline
21002 :tags on the TAGS in a headline
21003 :priority on the priority cookie in a headline
21004 :item on the first line of a plain list item
21005 :item-bullet on the bullet/number of a plain list item
21006 :checkbox on the checkbox in a plain list item
21007 :table in an org-mode table
21008 :table-special on a special filed in a table
21009 :table-table in a table.el table
21010 :clocktable in a clocktable
21011 :src-block in a source block
21012 :link on a hyperlink
21013 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21014 :target on a <<target>>
21015 :radio-target on a <<<radio-target>>>
21016 :latex-fragment on a LaTeX fragment
21017 :latex-preview on a LaTeX fragment with overlaid preview image
21019 This function expects the position to be visible because it uses font-lock
21020 faces as a help to recognize the following contexts: :table-special, :link,
21021 and :keyword."
21022 (let* ((f (get-text-property (point) 'face))
21023 (faces (if (listp f) f (list f)))
21024 (case-fold-search t)
21025 (p (point)) clist o)
21026 ;; First the large context
21027 (cond
21028 ((org-at-heading-p t)
21029 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21030 (when (progn
21031 (beginning-of-line 1)
21032 (looking-at org-todo-line-tags-regexp))
21033 (push (org-point-in-group p 1 :headline-stars) clist)
21034 (push (org-point-in-group p 2 :todo-keyword) clist)
21035 (push (org-point-in-group p 4 :tags) clist))
21036 (goto-char p)
21039 (push (org-point-in-group p 0 :priority) clist)))
21041 ((org-at-item-p)
21042 (push (org-point-in-group p 2 :item-bullet) clist)
21043 (push (list :item (point-at-bol)
21044 (save-excursion (org-end-of-item) (point)))
21045 clist)
21046 (and (org-at-item-checkbox-p)
21047 (push (org-point-in-group p 0 :checkbox) clist)))
21049 ((org-at-table-p)
21050 (push (list :table (org-table-begin) (org-table-end)) clist)
21051 (if (memq 'org-formula faces)
21052 (push (list :table-special
21053 (previous-single-property-change p 'face)
21054 (next-single-property-change p 'face)) clist)))
21055 ((org-at-table-p 'any)
21056 (push (list :table-table) clist)))
21057 (goto-char p)
21059 (let ((case-fold-search t))
21060 ;; New the "medium" contexts: clocktables, source blocks
21061 (cond ((org-in-clocktable-p)
21062 (push (list :clocktable
21064 (search-backward "#+BEGIN: clocktable" nil t))
21065 (match-beginning 0))
21067 (match-end 0))) clist))
21068 ((org-in-src-block-p)
21069 (push (list :src-block
21071 (search-backward "#+BEGIN_SRC" nil t))
21072 (match-beginning 0))
21073 (and (search-forward "#+END_SRC" nil t)
21074 (match-beginning 0))) clist))))
21075 (goto-char p)
21077 ;; Now the small context
21078 (cond
21079 ((org-at-timestamp-p)
21080 (push (org-point-in-group p 0 :timestamp) clist))
21081 ((memq 'org-link faces)
21082 (push (list :link
21083 (previous-single-property-change p 'face)
21084 (next-single-property-change p 'face)) clist))
21085 ((memq 'org-special-keyword faces)
21086 (push (list :keyword
21087 (previous-single-property-change p 'face)
21088 (next-single-property-change p 'face)) clist))
21089 ((org-at-target-p)
21090 (push (org-point-in-group p 0 :target) clist)
21091 (goto-char (1- (match-beginning 0)))
21092 (if (looking-at org-radio-target-regexp)
21093 (push (org-point-in-group p 0 :radio-target) clist))
21094 (goto-char p))
21095 ((setq o (car (delq nil
21096 (mapcar
21097 (lambda (x)
21098 (if (memq x org-latex-fragment-image-overlays) x))
21099 (overlays-at (point))))))
21100 (push (list :latex-fragment
21101 (overlay-start o) (overlay-end o)) clist)
21102 (push (list :latex-preview
21103 (overlay-start o) (overlay-end o)) clist))
21104 ((org-inside-LaTeX-fragment-p)
21105 ;; FIXME: positions wrong.
21106 (push (list :latex-fragment (point) (point)) clist)))
21108 (setq clist (nreverse (delq nil clist)))
21109 clist))
21111 ;; FIXME: Compare with at-regexp-p Do we need both?
21112 (defun org-in-regexp (re &optional nlines visually)
21113 "Check if point is inside a match of regexp.
21114 Normally only the current line is checked, but you can include NLINES extra
21115 lines both before and after point into the search.
21116 If VISUALLY is set, require that the cursor is not after the match but
21117 really on, so that the block visually is on the match."
21118 (catch 'exit
21119 (let ((pos (point))
21120 (eol (point-at-eol (+ 1 (or nlines 0))))
21121 (inc (if visually 1 0)))
21122 (save-excursion
21123 (beginning-of-line (- 1 (or nlines 0)))
21124 (while (re-search-forward re eol t)
21125 (if (and (<= (match-beginning 0) pos)
21126 (>= (+ inc (match-end 0)) pos))
21127 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21129 (defun org-at-regexp-p (regexp)
21130 "Is point inside a match of REGEXP in the current line?"
21131 (catch 'exit
21132 (save-excursion
21133 (let ((pos (point)) (end (point-at-eol)))
21134 (beginning-of-line 1)
21135 (while (re-search-forward regexp end t)
21136 (if (and (<= (match-beginning 0) pos)
21137 (>= (match-end 0) pos))
21138 (throw 'exit t)))
21139 nil))))
21141 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21142 "Non-nil when point is between matches of START-RE and END-RE.
21144 Also return a non-nil value when point is on one of the matches.
21146 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21147 buffer positions. Default values are the positions of headlines
21148 surrounding the point.
21150 The functions returns a cons cell whose car (resp. cdr) is the
21151 position before START-RE (resp. after END-RE)."
21152 (save-match-data
21153 (let ((pos (point))
21154 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21155 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21156 beg end)
21157 (save-excursion
21158 ;; Point is on a block when on START-RE or if START-RE can be
21159 ;; found before it...
21160 (and (or (org-at-regexp-p start-re)
21161 (re-search-backward start-re limit-up t))
21162 (setq beg (match-beginning 0))
21163 ;; ... and END-RE after it...
21164 (goto-char (match-end 0))
21165 (re-search-forward end-re limit-down t)
21166 (> (setq end (match-end 0)) pos)
21167 ;; ... without another START-RE in-between.
21168 (goto-char (match-beginning 0))
21169 (not (re-search-backward start-re (1+ beg) t))
21170 ;; Return value.
21171 (cons beg end))))))
21173 (defun org-in-block-p (names)
21174 "Non-nil when point belongs to a block whose name belongs to NAMES.
21176 NAMES is a list of strings containing names of blocks.
21178 Return first block name matched, or nil. Beware that in case of
21179 nested blocks, the returned name may not belong to the closest
21180 block from point."
21181 (save-match-data
21182 (catch 'exit
21183 (let ((case-fold-search t)
21184 (lim-up (save-excursion (outline-previous-heading)))
21185 (lim-down (save-excursion (outline-next-heading))))
21186 (mapc (lambda (name)
21187 (let ((n (regexp-quote name)))
21188 (when (org-between-regexps-p
21191 lim-up lim-down)
21192 (throw 'exit n))))
21193 names))
21194 nil)))
21196 (defun org-occur-in-agenda-files (regexp &optional nlines)
21197 "Call `multi-occur' with buffers for all agenda files."
21199 (let* ((files (org-agenda-files))
21200 (tnames (mapcar 'file-truename files))
21201 (extra org-agenda-text-search-extra-files)
21202 f)
21203 (when (eq (car extra) 'agenda-archives)
21204 (setq extra (cdr extra))
21205 (setq files (org-add-archive-files files)))
21206 (while (setq f (pop extra))
21207 (unless (member (file-truename f) tnames)
21208 (add-to-list 'files f 'append)
21209 (add-to-list 'tnames (file-truename f) 'append)))
21210 (multi-occur
21211 (mapcar (lambda (x)
21212 (with-current-buffer
21213 (or (get-file-buffer x) (find-file-noselect x))
21214 (widen)
21215 (current-buffer)))
21216 files)
21217 regexp)))
21219 (if (boundp 'occur-mode-find-occurrence-hook)
21220 ;; Emacs 23
21221 (add-hook 'occur-mode-find-occurrence-hook
21222 (lambda ()
21223 (when (derived-mode-p 'org-mode)
21224 (org-reveal))))
21225 ;; Emacs 22
21226 (defadvice occur-mode-goto-occurrence
21227 (after org-occur-reveal activate)
21228 (and (derived-mode-p 'org-mode) (org-reveal)))
21229 (defadvice occur-mode-goto-occurrence-other-window
21230 (after org-occur-reveal activate)
21231 (and (derived-mode-p 'org-mode) (org-reveal)))
21232 (defadvice occur-mode-display-occurrence
21233 (after org-occur-reveal activate)
21234 (when (derived-mode-p 'org-mode)
21235 (let ((pos (occur-mode-find-occurrence)))
21236 (with-current-buffer (marker-buffer pos)
21237 (save-excursion
21238 (goto-char pos)
21239 (org-reveal)))))))
21241 (defun org-occur-link-in-agenda-files ()
21242 "Create a link and search for it in the agendas.
21243 The link is not stored in `org-stored-links', it is just created
21244 for the search purpose."
21245 (interactive)
21246 (let ((link (condition-case nil
21247 (org-store-link nil)
21248 (error "Unable to create a link to here"))))
21249 (org-occur-in-agenda-files (regexp-quote link))))
21251 (defun org-reverse-string (string)
21252 "Return the reverse of STRING."
21253 (apply 'string (reverse (string-to-list string))))
21255 (defun org-uniquify (list)
21256 "Remove duplicate elements from LIST."
21257 (let (res)
21258 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
21259 res))
21261 (defun org-delete-all (elts list)
21262 "Remove all elements in ELTS from LIST."
21263 (while elts
21264 (setq list (delete (pop elts) list)))
21265 list)
21267 (defun org-count (cl-item cl-seq)
21268 "Count the number of occurrences of ITEM in SEQ.
21269 Taken from `count' in cl-seq.el with all keyword arguments removed."
21270 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21271 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21272 (while (< cl-start cl-end)
21273 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21274 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21275 (setq cl-start (1+ cl-start)))
21276 cl-count))
21278 (defun org-remove-if (predicate seq)
21279 "Remove everything from SEQ that fulfills PREDICATE."
21280 (let (res e)
21281 (while seq
21282 (setq e (pop seq))
21283 (if (not (funcall predicate e)) (push e res)))
21284 (nreverse res)))
21286 (defun org-remove-if-not (predicate seq)
21287 "Remove everything from SEQ that does not fulfill PREDICATE."
21288 (let (res e)
21289 (while seq
21290 (setq e (pop seq))
21291 (if (funcall predicate e) (push e res)))
21292 (nreverse res)))
21294 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21295 "Reduce two-argument FUNCTION across SEQ.
21296 Taken from `reduce' in cl-seq.el with all keyword arguments but
21298 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21299 (cadr (memq :initial-value cl-keys)))
21300 (cl-seq (pop cl-seq))
21301 (t (funcall cl-func)))))
21302 (while cl-seq
21303 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21304 cl-accum))
21306 (defun org-back-over-empty-lines ()
21307 "Move backwards over whitespace, to the beginning of the first empty line.
21308 Returns the number of empty lines passed."
21309 (let ((pos (point)))
21310 (if (cdr (assoc 'heading org-blank-before-new-entry))
21312 (unless (eobp)
21313 (forward-line -1)))
21314 (beginning-of-line 2)
21315 (goto-char (min (point) pos))
21316 (count-lines (point) pos)))
21318 (defun org-skip-whitespace ()
21321 (defun org-point-in-group (point group &optional context)
21322 "Check if POINT is in match-group GROUP.
21323 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21324 match. If the match group does not exist or point is not inside it,
21325 return nil."
21326 (and (match-beginning group)
21327 (>= point (match-beginning group))
21328 (<= point (match-end group))
21329 (if context
21330 (list context (match-beginning group) (match-end group))
21331 t)))
21333 (defun org-switch-to-buffer-other-window (&rest args)
21334 "Switch to buffer in a second window on the current frame.
21335 In particular, do not allow pop-up frames.
21336 Returns the newly created buffer."
21337 (org-no-popups
21338 (apply 'switch-to-buffer-other-window args)))
21340 (defun org-combine-plists (&rest plists)
21341 "Create a single property list from all plists in PLISTS.
21342 The process starts by copying the first list, and then setting properties
21343 from the other lists. Settings in the last list are the most significant
21344 ones and overrule settings in the other lists."
21345 (let ((rtn (copy-sequence (pop plists)))
21346 p v ls)
21347 (while plists
21348 (setq ls (pop plists))
21349 (while ls
21350 (setq p (pop ls) v (pop ls))
21351 (setq rtn (plist-put rtn p v))))
21352 rtn))
21354 (defun org-replace-escapes (string table)
21355 "Replace %-escapes in STRING with values in TABLE.
21357 The sequences in STRING may contain normal field width and padding information,
21359 so values can contain further %-escapes if they are define later in TABLE."
21360 (let ((tbl (copy-alist table))
21361 (case-fold-search nil)
21362 (pchg 0)
21363 e re rpl)
21364 (while (setq e (pop tbl))
21365 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21366 (when (and (cdr e) (string-match re (cdr e)))
21367 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21368 (safe "SREF"))
21369 (add-text-properties 0 3 (list 'sref sref) safe)
21370 (setcdr e (replace-match safe t t (cdr e)))))
21371 (while (string-match re string)
21372 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21373 (cdr e)))
21374 (setq string (replace-match rpl t t string))))
21375 (while (setq pchg (next-property-change pchg string))
21376 (let ((sref (get-text-property pchg 'sref string)))
21377 (when (and sref (string-match "SREF" string pchg))
21378 (setq string (replace-match sref t t string)))))
21379 string))
21381 (defun org-sublist (list start end)
21382 "Return a section of LIST, from START to END.
21383 Counting starts at 1."
21384 (let (rtn (c start))
21385 (setq list (nthcdr (1- start) list))
21386 (while (and list (<= c end))
21387 (push (pop list) rtn)
21388 (setq c (1+ c)))
21389 (nreverse rtn)))
21391 (defun org-find-base-buffer-visiting (file)
21392 "Like `find-buffer-visiting' but always return the base buffer and
21393 not an indirect buffer."
21394 (let ((buf (or (get-file-buffer file)
21395 (find-buffer-visiting file))))
21396 (if buf
21397 (or (buffer-base-buffer buf) buf)
21398 nil)))
21400 (defun org-image-file-name-regexp (&optional extensions)
21401 "Return regexp matching the file names of images.
21402 If EXTENSIONS is given, only match these."
21403 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21404 (image-file-name-regexp)
21405 (let ((image-file-name-extensions
21406 (or extensions
21407 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21408 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21410 (regexp-opt (nconc (mapcar 'upcase
21411 image-file-name-extensions)
21412 image-file-name-extensions)
21413 t)
21416 (defun org-file-image-p (file &optional extensions)
21417 "Return non-nil if FILE is an image."
21418 (save-match-data
21419 (string-match (org-image-file-name-regexp extensions) file)))
21421 (defun org-get-cursor-date (&optional with-time)
21422 "Return the date at cursor in as a time.
21423 This works in the calendar and in the agenda, anywhere else it just
21424 returns the current time.
21425 If WITH-TIME is non-nil, returns the time of the event at point (in
21426 the agenda) or the current time of the day."
21427 (let (date day defd tp tm hod mod)
21428 (when with-time
21429 (setq tp (get-text-property (point) 'time))
21431 (setq hod (string-to-number (match-string 1 tp))
21432 mod (string-to-number (match-string 2 tp))))
21433 (or tp (setq hod (nth 2 (decode-time (current-time)))
21434 mod (nth 1 (decode-time (current-time))))))
21435 (cond
21436 ((eq major-mode 'calendar-mode)
21437 (setq date (calendar-cursor-to-date)
21438 defd (encode-time 0 (or mod 0) (or hod 0)
21439 (nth 1 date) (nth 0 date) (nth 2 date))))
21440 ((eq major-mode 'org-agenda-mode)
21441 (setq day (get-text-property (point) 'day))
21442 (if day
21443 (setq date (calendar-gregorian-from-absolute day)
21444 defd (encode-time 0 (or mod 0) (or hod 0)
21445 (nth 1 date) (nth 0 date) (nth 2 date))))))
21446 (or defd (current-time))))
21448 (defun org-mark-subtree (&optional up)
21449 "Mark the current subtree.
21450 This puts point at the start of the current subtree, and mark at
21451 the end. If a numeric prefix UP is given, move up into the
21452 hierarchy of headlines by UP levels before marking the subtree."
21453 (interactive "P")
21454 (org-with-limited-levels
21455 (cond ((org-at-heading-p) (beginning-of-line))
21456 ((org-before-first-heading-p) (error "Not in a subtree"))
21457 (t (outline-previous-visible-heading 1))))
21458 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21459 (if (org-called-interactively-p 'any)
21460 (call-interactively 'org-mark-element)
21461 (org-mark-element)))
21464 ;;; Indentation
21466 (defun org-indent-line ()
21467 "Indent line depending on context."
21468 (interactive)
21469 (let* ((pos (point))
21470 (itemp (org-at-item-p))
21471 (case-fold-search t)
21473 (inline-task-p (and (featurep 'org-inlinetask)
21474 (org-inlinetask-in-task-p)))
21475 (inline-re (and inline-task-p
21476 (org-inlinetask-outline-regexp)))
21477 column)
21478 (if (and orgstruct-is-++ (eq pos (point)))
21479 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21480 (indent-according-to-mode))
21481 (beginning-of-line 1)
21482 (cond
21483 ;; Headings
21484 ((looking-at org-outline-regexp) (setq column 0))
21485 ;; Footnote definition
21486 ((looking-at org-footnote-definition-re) (setq column 0))
21487 ;; Literal examples
21489 (setq column (org-get-indentation))) ; do nothing
21490 ;; Lists
21491 ((ignore-errors (goto-char (org-in-item-p)))
21492 (setq column (if itemp
21493 (org-get-indentation)
21494 (org-list-item-body-column (point))))
21495 (goto-char pos))
21496 ;; Drawers
21498 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21499 (save-excursion
21500 (goto-char (1- (match-beginning 1)))
21501 (setq column (current-column))))
21502 ;; Special blocks
21504 (save-excursion
21505 (re-search-backward
21507 (setq column (org-get-indentation (match-string 0))))
21510 (save-excursion
21512 (setq column
21513 (cond ((equal (downcase (match-string 1)) "src")
21514 ;; src blocks: let `org-edit-src-exit' handle them
21515 (org-get-indentation))
21516 ((equal (downcase (match-string 1)) "example")
21517 (max (org-get-indentation)
21518 (org-get-indentation (match-string 0))))
21519 (t
21520 (org-get-indentation (match-string 0))))))
21521 ;; This line has nothing special, look at the previous relevant
21522 ;; line to compute indentation
21523 (t
21524 (beginning-of-line 0)
21525 (while (and (not (bobp))
21526 (not (looking-at org-table-line-regexp))
21527 (not (looking-at org-drawer-regexp))
21528 ;; When point started in an inline task, do not move
21529 ;; above task starting line.
21530 (not (and inline-task-p (looking-at inline-re)))
21531 ;; Skip drawers, blocks, empty lines, verbatim,
21532 ;; comments, tables, footnotes definitions, lists,
21533 ;; inline tasks.
21535 (re-search-backward org-drawer-regexp nil t))
21539 (looking-at org-footnote-definition-re)
21540 (and (ignore-errors (goto-char (org-in-item-p)))
21541 (goto-char
21542 (org-list-get-top-point (org-list-struct))))
21543 (and (not inline-task-p)
21544 (featurep 'org-inlinetask)
21545 (org-inlinetask-in-task-p)
21546 (or (org-inlinetask-goto-beginning) t))))
21547 (beginning-of-line 0))
21548 (cond
21549 ;; There was an heading above.
21551 (if (not org-adapt-indentation)
21552 (setq column 0)
21553 (goto-char (match-end 0))
21554 (setq column (current-column))))
21555 ;; A drawer had started and is unfinished
21556 ((looking-at org-drawer-regexp)
21557 (goto-char (1- (match-beginning 1)))
21558 (setq column (current-column)))
21559 ;; Else, nothing noticeable found: get indentation and go on.
21560 (t (setq column (org-get-indentation))))))
21561 ;; Now apply indentation and move cursor accordingly
21562 (goto-char pos)
21563 (if (<= (current-column) (current-indentation))
21564 (org-indent-line-to column)
21565 (save-excursion (org-indent-line-to column)))
21566 ;; Special polishing for properties, see `org-property-format'
21567 (setq column (current-column))
21568 (beginning-of-line 1)
21569 (if (looking-at
21571 (replace-match (concat (match-string 1)
21572 (format org-property-format
21573 (match-string 2) (match-string 3)))
21574 t t))
21575 (org-move-to-column column))))
21577 (defun org-indent-drawer ()
21578 "Indent the drawer at point."
21579 (interactive)
21580 (let ((p (point))
21581 (e (and (save-excursion (re-search-forward ":END:" nil t))
21582 (match-end 0)))
21583 (folded
21584 (save-excursion
21585 (end-of-line)
21586 (when (overlays-at (point))
21587 (member 'invisible (overlay-properties
21588 (car (overlays-at (point)))))))))
21589 (when folded (org-cycle))
21590 (indent-for-tab-command)
21591 (while (and (move-beginning-of-line 2) (< (point) e))
21592 (indent-for-tab-command))
21593 (goto-char p)
21594 (when folded (org-cycle)))
21595 (message "Drawer at point indented"))
21597 (defun org-indent-block ()
21598 "Indent the block at point."
21599 (interactive)
21600 (let ((p (point))
21601 (case-fold-search t)
21603 (match-end 0)))
21604 (folded
21605 (save-excursion
21606 (end-of-line)
21607 (when (overlays-at (point))
21608 (member 'invisible (overlay-properties
21609 (car (overlays-at (point)))))))))
21610 (when folded (org-cycle))
21611 (indent-for-tab-command)
21612 (while (and (move-beginning-of-line 2) (< (point) e))
21613 (indent-for-tab-command))
21614 (goto-char p)
21615 (when folded (org-cycle)))
21616 (message "Block at point indented"))
21618 (defun org-indent-region (start end)
21619 "Indent region."
21620 (interactive "r")
21621 (save-excursion
21622 (let ((line-end (org-current-line end)))
21623 (goto-char start)
21624 (while (< (org-current-line) line-end)
21625 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21626 (t (call-interactively 'org-indent-line)))
21627 (move-beginning-of-line 2)))))
21630 ;;; Filling
21632 ;; We use our own fill-paragraph and auto-fill functions.
21634 ;; `org-fill-paragraph' relies on adaptive filling and context
21635 ;; checking. Appropriate `fill-prefix' is computed with
21636 ;; `org-adaptive-fill-function'.
21638 ;; `org-auto-fill-function' takes care of auto-filling. It calls
21639 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
21640 ;; `org-adaptive-fill-function' value. Internally,
21641 ;; `org-comment-line-break-function' breaks the line.
21643 ;; `org-setup-filling' installs filling and auto-filling related
21644 ;; variables during `org-mode' initialization.
21646 (defun org-setup-filling ()
21647 (interactive)
21648 ;; Prevent auto-fill from inserting unwanted new items.
21649 (when (boundp 'fill-nobreak-predicate)
21650 (org-set-local
21651 'fill-nobreak-predicate
21652 (org-uniquify
21653 (append fill-nobreak-predicate
21654 '(org-fill-paragraph-separate-nobreak-p
21655 org-fill-line-break-nobreak-p
21656 org-fill-paragraph-with-timestamp-nobreak-p)))))
21657 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
21658 (org-set-local 'auto-fill-inhibit-regexp nil)
21659 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
21660 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
21661 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
21663 (defvar org-element-paragraph-separate) ; org-element.el
21664 (defun org-fill-paragraph-separate-nobreak-p ()
21665 "Non-nil when a line break at point would insert a new item."
21666 (looking-at (substring org-element-paragraph-separate 1)))
21668 (defun org-fill-line-break-nobreak-p ()
21669 "Non-nil when a line break at point would create an Org line break."
21670 (save-excursion
21675 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
21676 "Non-nil when a line break at point would insert a new item."
21677 (and (org-at-timestamp-p t)
21678 (not (looking-at org-ts-regexp-both))))
21680 (declare-function message-in-body-p "message" ())
21681 (defvar orgtbl-line-start-regexp) ; From org-table.el
21682 (defun org-adaptive-fill-function ()
21683 "Compute a fill prefix for the current line.
21684 Return fill prefix, as a string, or nil if current line isn't
21685 meant to be filled."
21686 (let (prefix)
21687 (catch 'exit
21688 (when (derived-mode-p 'message-mode)
21689 (save-excursion
21690 (beginning-of-line)
21691 (cond ((or (not (message-in-body-p))
21692 (looking-at orgtbl-line-start-regexp))
21693 (throw 'exit nil))
21694 ((looking-at message-cite-prefix-regexp)
21695 (throw 'exit (match-string-no-properties 0)))
21696 ((looking-at org-outline-regexp)
21697 (throw 'exit (make-string (length (match-string 0)) ? ))))))
21698 (org-with-wide-buffer
21699 (let* ((p (line-beginning-position))
21700 (element (save-excursion (beginning-of-line)
21701 (org-element-at-point)))
21702 (type (org-element-type element))
21703 (post-affiliated (org-element-property :post-affiliated element)))
21704 (unless (and post-affiliated (< p post-affiliated))
21705 (case type
21707 (footnote-definition "")
21708 ((item plain-list)
21709 (make-string (org-list-item-body-column
21710 (or post-affiliated
21711 (org-element-property :begin element)))
21712 ? ))
21713 (paragraph
21714 ;; Fill prefix is usually the same as the current line,
21715 ;; except if the paragraph is at the beginning of an item.
21716 (let ((parent (org-element-property :parent element)))
21717 (cond ((eq (org-element-type parent) 'item)
21718 (make-string (org-list-item-body-column
21719 (org-element-property :begin parent))
21720 ? ))
21722 (match-string 0))
21723 (t ""))))
21724 (comment-block
21725 ;; Only fill contents if P is within block boundaries.
21726 (let* ((cbeg (save-excursion (goto-char post-affiliated)
21727 (forward-line)
21728 (point)))
21729 (cend (save-excursion
21730 (goto-char (org-element-property :end element))
21732 (line-beginning-position))))
21733 (when (and (>= p cbeg) (< p cend))
21735 (match-string 0)
21736 "")))))))))))
21738 (declare-function message-goto-body "message" ())
21739 (defvar message-cite-prefix-regexp) ; From message.el
21740 (defvar org-element-all-successors) ; From org-element.el
21741 (defun org-fill-paragraph (&optional justify)
21742 "Fill element at point, when applicable.
21744 This function only applies to comment blocks, comments, example
21745 blocks and paragraphs. Also, as a special case, re-align table
21746 when point is at one.
21748 If JUSTIFY is non-nil (interactively, with prefix argument),
21749 justify as well. If `sentence-end-double-space' is non-nil, then
21750 period followed by one space does not end a sentence, so don't
21751 break a line there. The variable `fill-column' controls the
21752 width for filling.
21754 For convenience, when point is at a plain list, an item or
21755 a footnote definition, try to fill the first paragraph within."
21756 (interactive)
21757 (if (and (derived-mode-p 'message-mode)
21758 (or (not (message-in-body-p))
21759 (save-excursion (move-beginning-of-line 1)
21760 (looking-at message-cite-prefix-regexp))))
21761 ;; First ensure filling is correct in message-mode.
21762 (let ((fill-paragraph-function
21763 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
21764 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
21765 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
21766 (paragraph-separate
21767 (cadadr (assoc 'paragraph-separate org-fb-vars))))
21768 (fill-paragraph nil))
21769 (with-syntax-table org-mode-transpose-word-syntax-table
21770 ;; Move to end of line in order to get the first paragraph
21771 ;; within a plain list or a footnote definition.
21772 (let ((element (save-excursion (end-of-line) (org-element-at-point))))
21773 ;; First check if point is in a blank line at the beginning of
21774 ;; the buffer. In that case, ignore filling.
21775 (case (org-element-type element)
21776 ;; Use major mode filling function is src blocks.
21777 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
21778 ;; Align Org tables, leave table.el tables as-is.
21779 (table-row (org-table-align) t)
21780 (table
21781 (when (eq (org-element-property :type element) 'org)
21782 (org-table-align))
21783 t)
21784 (paragraph
21785 ;; Paragraphs may contain `line-break' type objects.
21786 (let ((beg (max (point-min)
21787 (org-element-property :contents-begin element)))
21788 (end (min (point-max)
21789 (org-element-property :contents-end element))))
21790 ;; Do nothing if point is at an affiliated keyword.
21791 (if (< (line-end-position) beg) t
21792 (when (derived-mode-p 'message-mode)
21793 ;; In `message-mode', do not fill following citation
21794 ;; in current paragraph nor text before message body.
21795 (let ((body-start (save-excursion (message-goto-body))))
21796 (when body-start (setq beg (max body-start beg))))
21797 (when (save-excursion
21798 (re-search-forward
21799 (concat "^" message-cite-prefix-regexp) end t))
21800 (setq end (match-beginning 0))))
21801 ;; Fill paragraph, taking line breaks into account.
21802 ;; For that, slice the paragraph using line breaks as
21803 ;; separators, and fill the parts in reverse order to
21804 ;; avoid messing with markers.
21805 (save-excursion
21806 (goto-char end)
21807 (mapc
21808 (lambda (pos)
21809 (fill-region-as-paragraph pos (point) justify)
21810 (goto-char pos))
21811 ;; Find the list of ending positions for line breaks
21812 ;; in the current paragraph. Add paragraph
21813 ;; beginning to include first slice.
21814 (nreverse
21815 (cons beg
21816 (org-element-map
21817 (org-element--parse-objects
21818 beg end nil org-element-all-successors)
21819 'line-break
21820 (lambda (lb) (org-element-property :end lb)))))))
21821 t)))
21822 ;; Contents of `comment-block' type elements should be
21823 ;; filled as plain text, but only if point is within block
21824 ;; markers.
21825 (comment-block
21826 (let* ((case-fold-search t)
21827 (beg (save-excursion
21828 (goto-char (org-element-property :begin element))
21830 (forward-line)
21831 (point)))
21832 (end (save-excursion
21833 (goto-char (org-element-property :end element))
21835 (line-beginning-position))))
21836 (when (and (>= (point) beg) (< (point) end))
21837 (fill-region-as-paragraph
21838 (save-excursion
21839 (end-of-line)
21841 (line-beginning-position))
21842 (save-excursion
21843 (beginning-of-line)
21845 (line-beginning-position))
21846 justify)))
21847 t)
21848 ;; Fill comments.
21849 (comment (fill-comment-paragraph justify))
21850 ;; Ignore every other element.
21851 (otherwise t))))))
21853 (defun org-auto-fill-function ()
21854 "Auto-fill function."
21855 ;; Check if auto-filling is meaningful.
21856 (let ((fc (current-fill-column)))
21857 (when (and fc (> (current-column) fc))
21858 (let* ((fill-prefix (org-adaptive-fill-function))
21859 ;; Enforce empty fill prefix, if required. Otherwise, it
21860 ;; will be computed again.
21861 (adaptive-fill-mode (not (equal fill-prefix ""))))
21862 (when fill-prefix (do-auto-fill))))))
21864 (defun org-comment-line-break-function (&optional soft)
21865 "Break line at point and indent, continuing comment if within one.
21866 The inserted newline is marked hard if variable
21867 `use-hard-newlines' is true, unless optional argument SOFT is
21868 non-nil."
21870 (save-excursion (forward-char -1) (delete-horizontal-space))
21871 (delete-horizontal-space)
21872 (indent-to-left-margin)
21873 (insert-before-markers-and-inherit fill-prefix))
21876 ;;; Comments
21878 ;; Org comments syntax is quite complex. It requires the entire line
21879 ;; to be just a comment. Also, even with the right syntax at the
21880 ;; beginning of line, some some elements (i.e. verse-block or
21881 ;; example-block) don't accept comments. Usual Emacs comment commands
21882 ;; cannot cope with those requirements. Therefore, Org replaces them.
21884 ;; Org still relies on `comment-dwim', but cannot trust
21885 ;; `comment-only-p'. So, `comment-region-function' and
21886 ;; `uncomment-region-function' both point
21887 ;; to`org-comment-or-uncomment-region'. Eventually,
21888 ;; `org-insert-comment' takes care of insertion of comments at the
21889 ;; beginning of line.
21891 ;; `org-setup-comments-handling' install comments related variables
21892 ;; during `org-mode' initialization.
21894 (defun org-setup-comments-handling ()
21895 (interactive)
21896 (org-set-local 'comment-use-syntax nil)
21897 (org-set-local 'comment-start "# ")
21899 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
21900 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
21901 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
21903 (defun org-insert-comment ()
21904 "Insert an empty comment above current line.
21905 If the line is empty, insert comment at its beginning."
21906 (beginning-of-line)
21908 (org-indent-line)
21909 (insert "# "))
21911 (defvar comment-empty-lines) ; From newcomment.el.
21912 (defun org-comment-or-uncomment-region (beg end &rest ignore)
21913 "Comment or uncomment each non-blank line in the region.
21914 Uncomment each non-blank line between BEG and END if it only
21915 contains commented lines. Otherwise, comment them."
21916 (save-restriction
21917 ;; Restrict region
21918 (narrow-to-region (save-excursion (goto-char beg)
21920 (line-beginning-position))
21921 (save-excursion (goto-char end)
21923 (line-end-position)))
21924 (let ((uncommentp
21925 ;; UNCOMMENTP is non-nil when every non blank line between
21926 ;; BEG and END is a comment.
21927 (save-excursion
21928 (goto-char (point-min))
21929 (while (and (not (eobp))
21930 (let ((element (org-element-at-point)))
21931 (and (eq (org-element-type element) 'comment)
21932 (goto-char (min (point-max)
21933 (org-element-property
21934 :end element)))))))
21935 (eobp))))
21936 (if uncommentp
21937 ;; Only blank lines and comments in region: uncomment it.
21938 (save-excursion
21939 (goto-char (point-min))
21940 (while (not (eobp))
21942 (replace-match "" nil nil nil 1))
21943 (forward-line)))
21944 ;; Comment each line in region.
21945 (let ((min-indent (point-max)))
21946 ;; First find the minimum indentation across all lines.
21947 (save-excursion
21948 (goto-char (point-min))
21949 (while (and (not (eobp)) (not (zerop min-indent)))
21951 (setq min-indent (min min-indent (current-indentation))))
21952 (forward-line)))
21953 ;; Then loop over all lines.
21954 (save-excursion
21955 (goto-char (point-min))
21956 (while (not (eobp))
21958 (org-move-to-column min-indent t)
21959 (insert comment-start))
21960 (forward-line))))))))
21963 ;;; Planning
21965 ;; This section contains tools to operate on timestamp objects, as
21966 ;; returned by, e.g. `org-element-context'.
21968 (defun org-timestamp-has-time-p (timestamp)
21969 "Non-nil when TIMESTAMP has a time specified."
21970 (org-element-property :hour-start timestamp))
21972 (defun org-timestamp-format (timestamp format &optional end utc)
21973 "Format a TIMESTAMP element into a string.
21975 FORMAT is a format specifier to be passed to
21976 `format-time-string'.
21978 When optional argument END is non-nil, use end of date-range or
21979 time-range, if possible.
21981 When optional argument UTC is non-nil, time will be expressed as
21982 Universal Time."
21983 (format-time-string
21984 format
21985 (apply 'encode-time
21986 (cons 0
21987 (mapcar
21988 (lambda (prop) (or (org-element-property prop timestamp) 0))
21989 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
21990 '(:minute-start :hour-start :day-start :month-start
21991 :year-start)))))
21992 utc))
21994 (defun org-timestamp-split-range (timestamp &optional end)
21995 "Extract a timestamp object from a date or time range.
21997 TIMESTAMP is a timestamp object. END, when non-nil, means extract
21998 the end of the range. Otherwise, extract its start.
22000 Return a new timestamp object sharing the same parent as
22001 TIMESTAMP."
22002 (let ((type (org-element-property :type timestamp)))
22003 (if (memq type '(active inactive diary)) timestamp
22004 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22005 ;; Set new type.
22006 (org-element-put-property
22007 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22008 ;; Copy start properties over end properties if END is
22009 ;; non-nil. Otherwise, copy end properties over `start' ones.
22010 (let ((p-alist '((:minute-start . :minute-end)
22011 (:hour-start . :hour-end)
22012 (:day-start . :day-end)
22013 (:month-start . :month-end)
22014 (:year-start . :year-end))))
22015 (dolist (p-cell p-alist)
22016 (org-element-put-property
22017 split-ts
22018 (funcall (if end 'car 'cdr) p-cell)
22019 (org-element-property
22020 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22021 ;; Eventually refresh `:raw-value'.
22022 (org-element-put-property split-ts :raw-value nil)
22023 (org-element-put-property
22024 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22026 (defun org-timestamp-translate (timestamp &optional boundary)
22027 "Apply `org-translate-time' on a TIMESTAMP object.
22028 When optional argument BOUNDARY is non-nil, it is either the
22029 symbol `start' or `end'. In this case, only translate the
22030 starting or ending part of TIMESTAMP if it is a date or time
22031 range. Otherwise, translate both parts."
22032 (if (and (not boundary)
22033 (memq (org-element-property :type timestamp)
22034 '(active-range inactive-range)))
22035 (concat
22036 (org-translate-time
22037 (org-element-property :raw-value
22038 (org-timestamp-split-range timestamp)))
22039 "--"
22040 (org-translate-time
22041 (org-element-property :raw-value
22042 (org-timestamp-split-range timestamp t))))
22043 (org-translate-time
22044 (org-element-property
22045 :raw-value
22046 (if (not boundary) timestamp
22047 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22051 ;;; Other stuff.
22053 (defun org-toggle-fixed-width-section (arg)
22054 "Toggle the fixed-width export.
22055 If there is no active region, the QUOTE keyword at the current headline is
22056 inserted or removed. When present, it causes the text between this headline
22057 and the next to be exported as fixed-width text, and unmodified.
22058 If there is an active region, this command adds or removes a colon as the
22059 first character of this line. If the first character of a line is a colon,
22060 this line is also exported in fixed-width font."
22061 (interactive "P")
22062 (let* ((cc 0)
22063 (regionp (org-region-active-p))
22064 (beg (if regionp (region-beginning) (point)))
22065 (end (if regionp (region-end)))
22066 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22067 (case-fold-search nil)
22069 off)
22070 (if regionp
22071 (save-excursion
22072 (goto-char beg)
22073 (setq cc (current-column))
22074 (beginning-of-line 1)
22075 (setq off (looking-at re))
22076 (while (> nlines 0)
22077 (setq nlines (1- nlines))
22078 (beginning-of-line 1)
22079 (cond
22080 (arg
22081 (org-move-to-column cc t)
22083 (forward-line -1))
22084 ((and off (looking-at re))
22085 (replace-match "" t t nil 1))
22086 ((not off) (org-move-to-column cc t) (insert ": ")))
22087 (forward-line 1)))
22088 (save-excursion
22089 (org-back-to-heading)
22090 (cond
22091 ((looking-at (format org-heading-keyword-regexp-format
22092 org-quote-string))
22093 (goto-char (match-end 1))
22094 (looking-at (concat " +" org-quote-string))
22095 (replace-match "" t t)
22096 (when (eolp) (insert " ")))
22097 ((looking-at org-outline-regexp)
22098 (goto-char (match-end 0))
22099 (insert org-quote-string " ")))))))
22101 (defun org-reftex-citation ()
22102 "Use reftex-citation to insert a citation into the buffer.
22103 This looks for a line like
22105 #+BIBLIOGRAPHY: foo plain option:-d
22107 and derives from it that foo.bib is the bibliography file relevant
22108 for this document. It then installs the necessary environment for RefTeX
22109 to work in this buffer and calls `reftex-citation' to insert a citation
22110 into the buffer.
22112 Export of such citations to both LaTeX and HTML is handled by the contributed
22113 package org-exp-bibtex by Taru Karttunen."
22114 (interactive)
22115 (let ((reftex-docstruct-symbol 'rds)
22117 rds bib)
22118 (save-excursion
22119 (save-restriction
22120 (widen)
22121 (let ((case-fold-search t)
22123 (if (not (save-excursion
22124 (or (re-search-forward re nil t)
22125 (re-search-backward re nil t))))
22126 (error "No bibliography defined in file")
22127 (setq bib (concat (match-string 1) ".bib")
22128 rds (list (list 'bib bib)))))))
22129 (call-interactively 'reftex-citation)))
22131 ;;;; Functions extending outline functionality
22133 (defun org-beginning-of-line (&optional arg)
22134 "Go to the beginning of the current line. If that is invisible, continue
22135 to a visible line beginning. This makes the function of C-a more intuitive.
22136 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22137 first attempt, and only move to after the tags when the cursor is already
22138 beyond the end of the headline."
22139 (interactive "P")
22140 (let ((pos (point))
22141 (special (if (consp org-special-ctrl-a/e)
22142 (car org-special-ctrl-a/e)
22143 org-special-ctrl-a/e))
22144 refpos)
22145 (if (org-bound-and-true-p visual-line-mode)
22146 (beginning-of-visual-line 1)
22147 (beginning-of-line 1))
22148 (if (and arg (fboundp 'move-beginning-of-line))
22149 (call-interactively 'move-beginning-of-line)
22150 (if (bobp)
22151 nil
22152 (backward-char 1)
22153 (if (org-truely-invisible-p)
22154 (while (and (not (bobp)) (org-truely-invisible-p))
22155 (backward-char 1)
22156 (beginning-of-line 1))
22157 (forward-char 1))))
22158 (when special
22159 (cond
22160 ((and (looking-at org-complex-heading-regexp)
22161 (= (char-after (match-end 1)) ?\ ))
22162 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22163 (point-at-eol)))
22164 (goto-char
22165 (if (eq special t)
22166 (cond ((> pos refpos) refpos)
22167 ((= pos (point)) refpos)
22168 (t (point)))
22169 (cond ((> pos (point)) (point))
22170 ((not (eq last-command this-command)) (point))
22171 (t refpos)))))
22172 ((org-at-item-p)
22173 ;; Being at an item and not looking at an the item means point
22174 ;; was previously moved to beginning of a visual line, which
22175 ;; doesn't contain the item. Therefore, do nothing special,
22176 ;; just stay here.
22177 (when (looking-at org-list-full-item-re)
22178 ;; Set special position at first white space character after
22179 ;; bullet, and check-box, if any.
22180 (let ((after-bullet
22181 (let ((box (match-end 3)))
22182 (if (not box) (match-end 1)
22183 (let ((after (char-after box)))
22184 (if (and after (= after ? )) (1+ box) box))))))
22185 ;; Special case: Move point to special position when
22186 ;; currently after it or at beginning of line.
22187 (if (eq special t)
22188 (when (or (> pos after-bullet) (= (point) pos))
22189 (goto-char after-bullet))
22190 ;; Reversed case: Move point to special position when
22191 ;; point was already at beginning of line and command is
22192 ;; repeated.
22193 (when (and (= (point) pos) (eq last-command this-command))
22194 (goto-char after-bullet))))))))
22195 (org-no-warnings
22196 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22198 (defun org-end-of-line (&optional arg)
22199 "Go to the end of the line.
22200 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22201 tags on the first attempt, and only move to after the tags when
22202 the cursor is already beyond the end of the headline."
22203 (interactive "P")
22204 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22205 org-special-ctrl-a/e))
22206 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22207 'end-of-visual-line)
22208 ((fboundp 'move-end-of-line) 'move-end-of-line)
22209 (t 'end-of-line))))
22210 (if (or (not special) arg) (call-interactively move-fun)
22211 (let* ((element (save-excursion (beginning-of-line)
22212 (org-element-at-point)))
22213 (type (org-element-type element)))
22214 (cond
22215 ((memq type '(headline inlinetask))
22216 (let ((pos (point)))
22217 (beginning-of-line 1)
22219 (if (eq special t)
22220 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22221 (goto-char (match-beginning 1))
22222 (goto-char (match-end 0)))
22223 (if (or (< pos (match-end 0))
22224 (not (eq this-command last-command)))
22225 (goto-char (match-end 0))
22226 (goto-char (match-beginning 1))))
22227 (call-interactively move-fun))))
22228 ((org-element-property :hiddenp element)
22229 ;; If element is hidden, `move-end-of-line' would put point
22230 ;; after it. Use `end-of-line' to stay on current line.
22231 (call-interactively 'end-of-line))
22232 (t (call-interactively move-fun)))))
22233 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22235 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22236 (define-key org-mode-map "\C-e" 'org-end-of-line)
22238 (defun org-backward-sentence (&optional arg)
22239 "Go to beginning of sentence, or beginning of table field.
22240 This will call `backward-sentence' or `org-table-beginning-of-field',
22241 depending on context."
22242 (interactive "P")
22243 (cond
22244 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22245 (t (call-interactively 'backward-sentence))))
22247 (defun org-forward-sentence (&optional arg)
22248 "Go to end of sentence, or end of table field.
22249 This will call `forward-sentence' or `org-table-end-of-field',
22250 depending on context."
22251 (interactive "P")
22252 (cond
22253 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22254 (t (call-interactively 'forward-sentence))))
22256 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22257 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22259 (defun org-kill-line (&optional arg)
22260 "Kill line, to tags or end of line."
22261 (interactive "P")
22262 (cond
22263 ((or (not org-special-ctrl-k)
22264 (bolp)
22265 (not (org-at-heading-p)))
22266 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22267 org-ctrl-k-protect-subtree)
22268 (if (or (eq org-ctrl-k-protect-subtree 'error)
22269 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22270 (error "C-k aborted - would kill hidden subtree")))
22271 (call-interactively
22272 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22274 (kill-region (point) (match-beginning 1))
22275 (org-set-tags nil t))
22276 (t (kill-region (point) (point-at-eol)))))
22278 (define-key org-mode-map "\C-k" 'org-kill-line)
22280 (defun org-yank (&optional arg)
22281 "Yank. If the kill is a subtree, treat it specially.
22282 This command will look at the current kill and check if is a single
22283 subtree, or a series of subtrees[1]. If it passes the test, and if the
22284 cursor is at the beginning of a line or after the stars of a currently
22285 empty headline, then the yank is handled specially. How exactly depends
22286 on the value of the following variables, both set by default.
22288 org-yank-folded-subtrees
22289 When set, the subtree(s) will be folded after insertion, but only
22290 if doing so would now swallow text after the yanked text.
22292 org-yank-adjusted-subtrees
22293 When set, the subtree will be promoted or demoted in order to
22294 fit into the local outline tree structure, which means that the level
22295 will be adjusted so that it becomes the smaller one of the two
22296 *visible* surrounding headings.
22298 Any prefix to this command will cause `yank' to be called directly with
22300 will just
22301 plainly yank the text as it is.
22303 \[1] The test checks if the first non-white line is a heading
22304 and if there are no other headings with fewer stars."
22305 (interactive "P")
22306 (org-yank-generic 'yank arg))
22308 (defun org-yank-generic (command arg)
22309 "Perform some yank-like command.
22311 This function implements the behavior described in the `org-yank'
22312 documentation. However, it has been generalized to work for any
22313 interactive command with similar behavior."
22315 ;; pretend to be command COMMAND
22316 (setq this-command command)
22318 (if arg
22319 (call-interactively command)
22321 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22322 (and (org-kill-is-subtree-p)
22323 (or (bolp)
22325 (string-match
22327 (buffer-substring (point-at-bol) (point)))))))
22328 swallowp)
22329 (cond
22330 ((and subtreep org-yank-folded-subtrees)
22331 (let ((beg (point))
22332 end)
22333 (if (and subtreep org-yank-adjusted-subtrees)
22334 (org-paste-subtree nil nil 'for-yank)
22335 (call-interactively command))
22337 (setq end (point))
22338 (goto-char beg)
22339 (when (and (bolp) subtreep
22340 (not (setq swallowp
22341 (org-yank-folding-would-swallow-text beg end))))
22342 (org-with-limited-levels
22343 (or (looking-at org-outline-regexp)
22344 (re-search-forward org-outline-regexp-bol end t))
22345 (while (and (< (point) end) (looking-at org-outline-regexp))
22346 (hide-subtree)
22347 (org-cycle-show-empty-lines 'folded)
22348 (condition-case nil
22349 (outline-forward-same-level 1)
22350 (error (goto-char end))))))
22351 (when swallowp
22352 (message
22353 "Inserted text not folded because that would swallow text"))
22355 (goto-char end)
22357 (beginning-of-line 1)
22358 (push-mark beg 'nomsg)))
22359 ((and subtreep org-yank-adjusted-subtrees)
22360 (let ((beg (point-at-bol)))
22361 (org-paste-subtree nil nil 'for-yank)
22362 (push-mark beg 'nomsg)))
22363 (t
22364 (call-interactively command))))))
22366 (defun org-yank-folding-would-swallow-text (beg end)
22367 "Would hide-subtree at BEG swallow any text after END?"
22368 (let (level)
22369 (org-with-limited-levels
22370 (save-excursion
22371 (goto-char beg)
22372 (when (or (looking-at org-outline-regexp)
22373 (re-search-forward org-outline-regexp-bol end t))
22374 (setq level (org-outline-level)))
22375 (goto-char end)
22377 (if (or (eobp)
22378 (and (bolp) (looking-at org-outline-regexp)
22379 (<= (org-outline-level) level)))
22380 nil ; Nothing would be swallowed
22381 t))))) ; something would swallow
22383 (define-key org-mode-map "\C-y" 'org-yank)
22385 (defun org-truely-invisible-p ()
22386 "Check if point is at a character currently not visible.
22387 This version does not only check the character property, but also
22388 `visible-mode'."
22389 ;; Early versions of noutline don't have `outline-invisible-p'.
22390 (if (org-bound-and-true-p visible-mode)
22391 nil
22392 (outline-invisible-p)))
22394 (defun org-invisible-p2 ()
22395 "Check if point is at a character currently not visible."
22396 (save-excursion
22397 (if (and (eolp) (not (bobp))) (backward-char 1))
22398 ;; Early versions of noutline don't have `outline-invisible-p'.
22399 (outline-invisible-p)))
22401 (defun org-back-to-heading (&optional invisible-ok)
22402 "Call `outline-back-to-heading', but provide a better error message."
22403 (condition-case nil
22404 (outline-back-to-heading invisible-ok)
22405 (error (error "Before first headline at position %d in buffer %s"
22406 (point) (current-buffer)))))
22408 (defun org-before-first-heading-p ()
22409 "Before first heading?"
22410 (save-excursion
22411 (end-of-line)
22412 (null (re-search-backward org-outline-regexp-bol nil t))))
22414 (defun org-at-heading-p (&optional ignored)
22415 (outline-on-heading-p t))
22416 ;; Compatibility alias with Org versions < 7.8.03
22417 (defalias 'org-on-heading-p 'org-at-heading-p)
22419 (defun org-at-comment-p nil
22420 "Is cursor in a line starting with a # character?"
22421 (save-excursion
22422 (beginning-of-line)
22423 (looking-at "^#")))
22425 (defun org-at-drawer-p nil
22426 "Is cursor at a drawer keyword?"
22427 (save-excursion
22428 (move-beginning-of-line 1)
22429 (looking-at org-drawer-regexp)))
22431 (defun org-at-block-p nil
22432 "Is cursor at a block keyword?"
22433 (save-excursion
22434 (move-beginning-of-line 1)
22435 (looking-at org-block-regexp)))
22437 (defun org-point-at-end-of-empty-headline ()
22438 "If point is at the end of an empty headline, return t, else nil.
22439 If the heading only contains a TODO keyword, it is still still considered
22440 empty."
22442 (when org-todo-line-regexp
22443 (save-excursion
22444 (beginning-of-line 1)
22445 (let ((case-fold-search nil))
22446 (looking-at org-todo-line-regexp)
22447 (string= (match-string 3) ""))))))
22449 (defun org-at-heading-or-item-p ()
22450 (or (org-at-heading-p) (org-at-item-p)))
22452 (defun org-at-target-p ()
22453 (or (org-in-regexp org-radio-target-regexp)
22454 (org-in-regexp org-target-regexp)))
22455 ;; Compatibility alias with Org versions < 7.8.03
22456 (defalias 'org-on-target-p 'org-at-target-p)
22458 (defun org-up-heading-all (arg)
22459 "Move to the heading line of which the present line is a subheading.
22460 This function considers both visible and invisible heading lines.
22461 With argument, move up ARG levels."
22462 (if (fboundp 'outline-up-heading-all)
22463 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22464 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22466 (defun org-up-heading-safe ()
22467 "Move to the heading line of which the present line is a subheading.
22468 This version will not throw an error. It will return the level of the
22469 headline found, or nil if no higher level is found.
22471 Also, this function will be a lot faster than `outline-up-heading',
22472 because it relies on stars being the outline starters. This can really
22473 make a significant difference in outlines with very many siblings."
22474 (let (start-level re)
22475 (org-back-to-heading t)
22476 (setq start-level (funcall outline-level))
22477 (if (equal start-level 1)
22478 nil
22480 (if (re-search-backward re nil t)
22481 (funcall outline-level)))))
22483 (defun org-first-sibling-p ()
22484 "Is this heading the first child of its parents?"
22485 (interactive)
22486 (let ((re org-outline-regexp-bol)
22487 level l)
22488 (unless (org-at-heading-p t)
22489 (error "Not at a heading"))
22490 (setq level (funcall outline-level))
22491 (save-excursion
22492 (if (not (re-search-backward re nil t))
22493 t
22494 (setq l (funcall outline-level))
22495 (< l level)))))
22497 (defun org-goto-sibling (&optional previous)
22498 "Goto the next sibling, even if it is invisible.
22499 When PREVIOUS is set, go to the previous sibling instead. Returns t
22500 when a sibling was found. When none is found, return nil and don't
22501 move point."
22502 (let ((fun (if previous 're-search-backward 're-search-forward))
22503 (pos (point))
22504 (re org-outline-regexp-bol)
22505 level l)
22506 (when (condition-case nil (org-back-to-heading t) (error nil))
22507 (setq level (funcall outline-level))
22508 (catch 'exit
22509 (or previous (forward-char 1))
22510 (while (funcall fun re nil t)
22511 (setq l (funcall outline-level))
22512 (when (< l level) (goto-char pos) (throw 'exit nil))
22513 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22514 (goto-char pos)
22515 nil))))
22517 (defun org-show-siblings ()
22518 "Show all siblings of the current headline."
22519 (save-excursion
22520 (while (org-goto-sibling) (org-flag-heading nil)))
22521 (save-excursion
22522 (while (org-goto-sibling 'previous)
22523 (org-flag-heading nil))))
22525 (defun org-goto-first-child ()
22526 "Goto the first child, even if it is invisible.
22527 Return t when a child was found. Otherwise don't move point and
22528 return nil."
22529 (let (level (pos (point)) (re org-outline-regexp-bol))
22530 (when (condition-case nil (org-back-to-heading t) (error nil))
22531 (setq level (outline-level))
22532 (forward-char 1)
22533 (if (and (re-search-forward re nil t) (> (outline-level) level))
22534 (progn (goto-char (match-beginning 0)) t)
22535 (goto-char pos) nil))))
22537 (defun org-show-hidden-entry ()
22538 "Show an entry where even the heading is hidden."
22539 (save-excursion
22540 (org-show-entry)))
22542 (defun org-flag-heading (flag &optional entry)
22543 "Flag the current heading. FLAG non-nil means make invisible.
22544 When ENTRY is non-nil, show the entire entry."
22545 (save-excursion
22546 (org-back-to-heading t)
22547 ;; Check if we should show the entire entry
22548 (if entry
22549 (progn
22550 (org-show-entry)
22551 (save-excursion
22552 (and (outline-next-heading)
22553 (org-flag-heading nil))))
22554 (outline-flag-region (max (point-min) (1- (point)))
22555 (save-excursion (outline-end-of-heading) (point))
22556 flag))))
22558 (defun org-get-next-sibling ()
22559 "Move to next heading of the same level, and return point.
22560 If there is no such heading, return nil.
22561 This is like outline-next-sibling, but invisible headings are ok."
22562 (let ((level (funcall outline-level)))
22563 (outline-next-heading)
22564 (while (and (not (eobp)) (> (funcall outline-level) level))
22565 (outline-next-heading))
22566 (if (or (eobp) (< (funcall outline-level) level))
22567 nil
22568 (point))))
22570 (defun org-get-last-sibling ()
22571 "Move to previous heading of the same level, and return point.
22572 If there is no such heading, return nil."
22573 (let ((opoint (point))
22574 (level (funcall outline-level)))
22575 (outline-previous-heading)
22576 (when (and (/= (point) opoint) (outline-on-heading-p t))
22577 (while (and (> (funcall outline-level) level)
22578 (not (bobp)))
22579 (outline-previous-heading))
22580 (if (< (funcall outline-level) level)
22581 nil
22582 (point)))))
22584 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22585 "Goto to the end of a subtree."
22586 ;; This contains an exact copy of the original function, but it uses
22587 ;; `org-back-to-heading', to make it work also in invisible
22588 ;; trees. And is uses an invisible-ok argument.
22589 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22590 ;; Furthermore, when used inside Org, finding the end of a large subtree
22591 ;; with many children and grandchildren etc, this can be much faster
22592 ;; than the outline version.
22593 (org-back-to-heading invisible-ok)
22594 (let ((first t)
22595 (level (funcall outline-level)))
22596 (if (and (derived-mode-p 'org-mode) (< level 1000))
22597 ;; A true heading (not a plain list item), in Org-mode
22598 ;; This means we can easily find the end by looking
22599 ;; only for the right number of stars. Using a regexp to do
22600 ;; this is so much faster than using a Lisp loop.
22602 (forward-char 1)
22603 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22604 ;; something else, do it the slow way
22605 (while (and (not (eobp))
22606 (or first (> (funcall outline-level) level)))
22607 (setq first nil)
22608 (outline-next-heading)))
22609 (unless to-heading
22611 (progn
22612 ;; Go to end of line before heading
22613 (forward-char -1)
22615 ;; leave blank line before heading
22616 (forward-char -1))))))
22617 (point))
22619 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22620 "Use Org version in org-mode, for dramatic speed-up."
22621 (if (derived-mode-p 'org-mode)
22622 (progn
22623 (org-end-of-subtree nil t)
22624 (unless (eobp) (backward-char 1)))
22625 ad-do-it))
22627 (defun org-end-of-meta-data-and-drawers ()
22628 "Jump to the first text after meta data and drawers in the current entry.
22629 This will move over empty lines, lines with planning time stamps,
22630 clocking lines, and drawers."
22631 (org-back-to-heading t)
22632 (let ((end (save-excursion (outline-next-heading) (point)))
22635 (forward-line 1)
22636 (while (re-search-forward re end t)
22637 (if (not (match-end 1))
22638 ;; empty or planning line
22639 (forward-line 1)
22640 ;; a drawer, find the end
22642 (forward-line 1)))
22644 (point)))
22646 (defun org-forward-heading-same-level (arg &optional invisible-ok)
22647 "Move forward to the ARG'th subheading at same level as this one.
22648 Stop at the first and last subheadings of a superior heading.
22649 Normally this only looks at visible headings, but when INVISIBLE-OK is
22650 non-nil it will also look at invisible ones."
22651 (interactive "p")
22652 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
22653 (if (and arg (< arg 0))
22654 (goto-char (point-min))
22655 (outline-next-heading))
22656 (org-at-heading-p)
22657 (let ((level (- (match-end 0) (match-beginning 0) 1))
22658 (f (if (and arg (< arg 0))
22659 're-search-backward
22660 're-search-forward))
22661 (count (if arg (abs arg) 1))
22662 (result (point)))
22663 (forward-char (if (and arg (< arg 0)) -1 1))
22664 (while (and (> count 0)
22665 (funcall f org-outline-regexp-bol nil 'move))
22666 (let ((l (- (match-end 0) (match-beginning 0) 1)))
22667 (cond ((< l level) (setq count 0))
22668 ((and (= l level)
22669 (or invisible-ok
22670 (progn
22671 (goto-char (line-beginning-position))
22672 (not (outline-invisible-p)))))
22673 (setq count (1- count))
22674 (when (eq l level)
22675 (setq result (point)))))))
22676 (goto-char result))
22677 (beginning-of-line 1)))
22679 (defun org-backward-heading-same-level (arg &optional invisible-ok)
22680 "Move backward to the ARG'th subheading at same level as this one.
22681 Stop at the first and last subheadings of a superior heading."
22682 (interactive "p")
22683 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
22685 (defun org-next-block (arg &optional backward block-regexp)
22686 "Jump to the next block.
22687 With a prefix argument ARG, jump forward ARG many source blocks.
22688 When BACKWARD is non-nil, jump to the previous block.
22689 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
22690 (interactive "p")
22691 (let ((re (or block-regexp org-block-regexp))
22692 (re-search-fn (or (and backward 're-search-backward)
22693 're-search-forward)))
22694 (if (looking-at re) (forward-char 1))
22695 (condition-case nil
22696 (funcall re-search-fn re nil nil arg)
22697 (error (error "No %s code blocks" (if backward "previous" "further" ))))
22698 (goto-char (match-beginning 0)) (org-show-context)))
22700 (defun org-previous-block (arg &optional block-regexp)
22701 "Jump to the previous block.
22702 With a prefix argument ARG, jump backward ARG many source blocks.
22703 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
22704 (interactive "p")
22705 (org-next-block arg t block-regexp))
22707 (defun org-forward-element ()
22708 "Move forward by one element.
22709 Move to the next element at the same level, when possible."
22710 (interactive)
22711 (cond ((eobp) (user-error "Cannot move further down"))
22712 ((org-with-limited-levels (org-at-heading-p))
22713 (let ((origin (point)))
22714 (goto-char (org-end-of-subtree nil t))
22715 (unless (org-with-limited-levels (org-at-heading-p))
22716 (goto-char origin)
22717 (user-error "Cannot move further down"))))
22718 (t
22719 (let* ((elem (org-element-at-point))
22720 (end (org-element-property :end elem))
22721 (parent (org-element-property :parent elem)))
22722 (if (and parent (= (org-element-property :contents-end parent) end))
22723 (goto-char (org-element-property :end parent))
22724 (goto-char end))))))
22726 (defun org-backward-element ()
22727 "Move backward by one element.
22728 Move to the previous element at the same level, when possible."
22729 (interactive)
22730 (cond ((bobp) (user-error "Cannot move further up"))
22731 ((org-with-limited-levels (org-at-heading-p))
22732 ;; At a headline, move to the previous one, if any, or stay
22733 ;; here.
22734 (let ((origin (point)))
22735 (org-with-limited-levels (org-backward-heading-same-level 1))
22736 ;; When current headline has no sibling above, move to its
22737 ;; parent.
22738 (when (= (point) origin)
22739 (or (org-with-limited-levels (org-up-heading-safe))
22740 (progn (goto-char origin)
22741 (user-error "Cannot move further up"))))))
22742 (t
22743 (let* ((trail (org-element-at-point 'keep-trail))
22744 (elem (car trail))
22745 (prev-elem (nth 1 trail))
22746 (beg (org-element-property :begin elem)))
22747 (cond
22748 ;; Move to beginning of current element if point isn't
22749 ;; there already.
22750 ((/= (point) beg) (goto-char beg))
22751 (prev-elem (goto-char (org-element-property :begin prev-elem)))
22752 ((org-before-first-heading-p) (goto-char (point-min)))
22753 (t (org-back-to-heading)))))))
22755 (defun org-up-element ()
22756 "Move to upper element."
22757 (interactive)
22758 (if (org-with-limited-levels (org-at-heading-p))
22759 (unless (org-up-heading-safe) (error "No surrounding element"))
22760 (let* ((elem (org-element-at-point))
22761 (parent (org-element-property :parent elem)))
22762 (if parent (goto-char (org-element-property :begin parent))
22763 (if (org-with-limited-levels (org-before-first-heading-p))
22764 (error "No surrounding element")
22765 (org-with-limited-levels (org-back-to-heading)))))))
22767 (defvar org-element-greater-elements)
22768 (defun org-down-element ()
22769 "Move to inner element."
22770 (interactive)
22771 (let ((element (org-element-at-point)))
22772 (cond
22773 ((memq (org-element-type element) '(plain-list table))
22774 (goto-char (org-element-property :contents-begin element))
22775 (forward-char))
22776 ((memq (org-element-type element) org-element-greater-elements)
22777 ;; If contents are hidden, first disclose them.
22778 (when (org-element-property :hiddenp element) (org-cycle))
22779 (goto-char (or (org-element-property :contents-begin element)
22780 (error "No content for this element"))))
22781 (t (error "No inner element")))))
22783 (defun org-drag-element-backward ()
22784 "Move backward element at point."
22785 (interactive)
22786 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
22787 (let* ((trail (org-element-at-point 'keep-trail))
22788 (elem (car trail))
22789 (prev-elem (nth 1 trail)))
22790 ;; Error out if no previous element or previous element is
22791 ;; a parent of the current one.
22792 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
22793 (error "Cannot drag element backward")
22794 (let ((pos (point)))
22795 (org-element-swap-A-B prev-elem elem)
22796 (goto-char (+ (org-element-property :begin prev-elem)
22797 (- pos (org-element-property :begin elem)))))))))
22799 (defun org-drag-element-forward ()
22800 "Move forward element at point."
22801 (interactive)
22802 (let* ((pos (point))
22803 (elem (org-element-at-point)))
22804 (when (= (point-max) (org-element-property :end elem))
22805 (error "Cannot drag element forward"))
22806 (goto-char (org-element-property :end elem))
22807 (let ((next-elem (org-element-at-point)))
22808 (when (or (org-element-nested-p elem next-elem)
22809 (and (eq (org-element-type next-elem) 'headline)
22810 (not (eq (org-element-type elem) 'headline))))
22811 (goto-char pos)
22812 (error "Cannot drag element forward"))
22813 ;; Compute new position of point: it's shifted by NEXT-ELEM
22814 ;; body's length (without final blanks) and by the length of
22815 ;; blanks between ELEM and NEXT-ELEM.
22816 (let ((size-next (- (save-excursion
22817 (goto-char (org-element-property :end next-elem))
22819 (forward-line)
22820 ;; Small correction if buffer doesn't end
22821 ;; with a newline character.
22822 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
22823 (org-element-property :begin next-elem)))
22824 (size-blank (- (org-element-property :end elem)
22825 (save-excursion
22826 (goto-char (org-element-property :end elem))
22828 (forward-line)
22829 (point)))))
22830 (org-element-swap-A-B elem next-elem)
22831 (goto-char (+ pos size-next size-blank))))))
22833 (defun org-drag-line-forward (arg)
22834 "Drag the line at point ARG lines forward."
22835 (interactive "p")
22836 (dotimes (n (abs arg))
22837 (let ((c (current-column)))
22838 (if (< 0 arg)
22839 (progn
22840 (beginning-of-line 2)
22841 (transpose-lines 1)
22842 (beginning-of-line 0))
22843 (transpose-lines 1)
22844 (beginning-of-line -1))
22845 (org-move-to-column c))))
22847 (defun org-drag-line-backward (arg)
22848 "Drag the line at point ARG lines backward."
22849 (interactive "p")
22850 (org-drag-line-forward (- arg)))
22852 (defun org-mark-element ()
22853 "Put point at beginning of this element, mark at end.
22855 Interactively, if this command is repeated or (in Transient Mark
22856 mode) if the mark is active, it marks the next element after the
22857 ones already marked."
22858 (interactive)
22859 (let (deactivate-mark)
22860 (if (and (org-called-interactively-p 'any)
22861 (or (and (eq last-command this-command) (mark t))
22862 (and transient-mark-mode mark-active)))
22863 (set-mark
22864 (save-excursion
22865 (goto-char (mark))
22866 (goto-char (org-element-property :end (org-element-at-point)))))
22867 (let ((element (org-element-at-point)))
22868 (end-of-line)
22869 (push-mark (org-element-property :end element) t t)
22870 (goto-char (org-element-property :begin element))))))
22872 (defun org-narrow-to-element ()
22873 "Narrow buffer to current element."
22874 (interactive)
22875 (let ((elem (org-element-at-point)))
22876 (cond
22877 ((eq (car elem) 'headline)
22878 (narrow-to-region
22879 (org-element-property :begin elem)
22880 (org-element-property :end elem)))
22881 ((memq (car elem) org-element-greater-elements)
22882 (narrow-to-region
22883 (org-element-property :contents-begin elem)
22884 (org-element-property :contents-end elem)))
22885 (t
22886 (narrow-to-region
22887 (org-element-property :begin elem)
22888 (org-element-property :end elem))))))
22890 (defun org-transpose-element ()
22891 "Transpose current and previous elements, keeping blank lines between.
22892 Point is moved after both elements."
22893 (interactive)
22894 (org-skip-whitespace)
22895 (let ((end (org-element-property :end (org-element-at-point))))
22896 (org-drag-element-backward)
22897 (goto-char end)))
22899 (defun org-unindent-buffer ()
22900 "Un-indent the visible part of the buffer.
22901 Relative indentation (between items, inside blocks, etc.) isn't
22902 modified."
22903 (interactive)
22904 (unless (eq major-mode 'org-mode)
22905 (error "Cannot un-indent a buffer not in Org mode"))
22906 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
22907 unindent-tree ; For byte-compiler.
22908 (unindent-tree
22909 (function
22910 (lambda (contents)
22911 (mapc
22912 (lambda (element)
22913 (if (memq (org-element-type element) '(headline section))
22914 (funcall unindent-tree (org-element-contents element))
22915 (save-excursion
22916 (save-restriction
22917 (narrow-to-region
22918 (org-element-property :begin element)
22919 (org-element-property :end element))
22920 (org-do-remove-indentation)))))
22921 (reverse contents))))))
22922 (funcall unindent-tree (org-element-contents parse-tree))))
22924 (defun org-show-subtree ()
22925 "Show everything after this heading at deeper levels."
22926 (interactive)
22927 (outline-flag-region
22928 (point)
22929 (save-excursion
22930 (org-end-of-subtree t t))
22931 nil))
22933 (defun org-show-entry ()
22934 "Show the body directly following this heading.
22935 Show the heading too, if it is currently invisible."
22936 (interactive)
22937 (save-excursion
22938 (condition-case nil
22939 (progn
22940 (org-back-to-heading t)
22941 (outline-flag-region
22942 (max (point-min) (1- (point)))
22943 (save-excursion
22944 (if (re-search-forward
22946 (match-beginning 1)
22947 (point-max)))
22948 nil)
22949 (org-cycle-hide-drawers 'children))
22950 (error nil))))
22952 (defun org-make-options-regexp (kwds &optional extra)
22953 "Make a regular expression for keyword lines."
22954 (concat
22960 ;; Make isearch reveal the necessary context
22961 (defun org-isearch-end ()
22962 "Reveal context after isearch exits."
22963 (when isearch-success ; only if search was successful
22964 (if (featurep 'xemacs)
22965 ;; Under XEmacs, the hook is run in the correct place,
22966 ;; we directly show the context.
22967 (org-show-context 'isearch)
22968 ;; In Emacs the hook runs *before* restoring the overlays.
22969 ;; So we have to use a one-time post-command-hook to do this.
22970 ;; (Emacs 22 has a special variable, see function `org-mode')
22971 (unless (and (boundp 'isearch-mode-end-hook-quit)
22972 isearch-mode-end-hook-quit)
22973 ;; Only when the isearch was not quitted.
22974 (org-add-hook 'post-command-hook 'org-isearch-post-command
22975 'append 'local)))
22976 (org-fix-ellipsis-at-bol)))
22978 (defun org-isearch-post-command ()
22979 "Remove self from hook, and show context."
22980 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
22981 (org-show-context 'isearch))
22984 ;;;; Integration with and fixes for other packages
22986 ;;; Imenu support
22988 (defvar org-imenu-markers nil
22989 "All markers currently used by Imenu.")
22990 (make-variable-buffer-local 'org-imenu-markers)
22992 (defun org-imenu-new-marker (&optional pos)
22993 "Return a new marker for use by Imenu, and remember the marker."
22994 (let ((m (make-marker)))
22995 (move-marker m (or pos (point)))
22996 (push m org-imenu-markers)
22997 m))
22999 (defun org-imenu-get-tree ()
23000 "Produce the index for Imenu."
23001 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23002 (setq org-imenu-markers nil)
23003 (let* ((n org-imenu-depth)
23004 (re (concat "^" (org-get-limited-outline-regexp)))
23005 (subs (make-vector (1+ n) nil))
23006 (last-level 0)
23007 m level head0 head)
23008 (save-excursion
23009 (save-restriction
23010 (widen)
23011 (goto-char (point-max))
23012 (while (re-search-backward re nil t)
23013 (setq level (org-reduced-level (funcall outline-level)))
23014 (when (and (<= level n)
23015 (looking-at org-complex-heading-regexp)
23016 (setq head0 (org-match-string-no-properties 4)))
23017 (setq head (org-link-display-format head0)
23018 m (org-imenu-new-marker))
23019 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23020 (if (>= level last-level)
23021 (push (cons head m) (aref subs level))
23022 (push (cons head (aref subs (1+ level))) (aref subs level))
23023 (loop for i from (1+ level) to n do (aset subs i nil)))
23024 (setq last-level level)))))
23025 (aref subs 1)))
23027 (eval-after-load "imenu"
23028 '(progn
23029 (add-hook 'imenu-after-jump-hook
23030 (lambda ()
23031 (if (derived-mode-p 'org-mode)
23032 (org-show-context 'org-goto))))))
23034 (defun org-link-display-format (link)
23035 "Replace a link with either the description, or the link target
23036 if no description is present"
23037 (save-match-data
23038 (if (string-match org-bracket-link-analytic-regexp link)
23039 (replace-match (if (match-end 5)
23040 (match-string 5 link)
23041 (concat (match-string 1 link)
23042 (match-string 3 link)))
23043 nil t link)
23044 link)))
23046 (defun org-toggle-link-display ()
23047 "Toggle the literal or descriptive display of links."
23048 (interactive)
23049 (if org-descriptive-links
23050 (progn (org-remove-from-invisibility-spec '(org-link))
23051 (org-restart-font-lock)
23052 (setq org-descriptive-links nil))
23053 (progn (add-to-invisibility-spec '(org-link))
23054 (org-restart-font-lock)
23055 (setq org-descriptive-links t))))
23057 ;; Speedbar support
23059 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23060 "Overlay marking the agenda restriction line in speedbar.")
23061 (overlay-put org-speedbar-restriction-lock-overlay
23062 'face 'org-agenda-restriction-lock)
23063 (overlay-put org-speedbar-restriction-lock-overlay
23064 'help-echo "Agendas are currently limited to this item.")
23065 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23067 (defun org-speedbar-set-agenda-restriction ()
23068 "Restrict future agenda commands to the location at point in speedbar.
23070 (interactive)
23071 (require 'org-agenda)
23072 (let (p m tp np dir txt)
23073 (cond
23074 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23075 'org-imenu t))
23076 (setq m (get-text-property p 'org-imenu-marker))
23077 (with-current-buffer (marker-buffer m)
23078 (goto-char m)
23079 (org-agenda-set-restriction-lock 'subtree)))
23080 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23081 'speedbar-function 'speedbar-find-file))
23082 (setq tp (previous-single-property-change
23083 (1+ p) 'speedbar-function)
23084 np (next-single-property-change
23085 tp 'speedbar-function)
23086 dir (speedbar-line-directory)
23087 txt (buffer-substring-no-properties (or tp (point-min))
23088 (or np (point-max))))
23089 (with-current-buffer (find-file-noselect
23090 (let ((default-directory dir))
23091 (expand-file-name txt)))
23092 (unless (derived-mode-p 'org-mode)
23093 (error "Cannot restrict to non-Org-mode file"))
23094 (org-agenda-set-restriction-lock 'file)))
23095 (t (error "Don't know how to restrict Org-mode's agenda")))
23096 (move-overlay org-speedbar-restriction-lock-overlay
23097 (point-at-bol) (point-at-eol))
23098 (setq current-prefix-arg nil)
23099 (org-agenda-maybe-redo)))
23101 (eval-after-load "speedbar"
23102 '(progn
23103 (speedbar-add-supported-extension ".org")
23104 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23105 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23106 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23107 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23108 (add-hook 'speedbar-visiting-tag-hook
23109 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23111 ;;; Fixes and Hacks for problems with other packages
23113 ;; Make flyspell not check words in links, to not mess up our keymap
23114 (defvar org-element-affiliated-keywords) ; From org-element.el
23115 (defvar org-element-block-name-alist) ; From org-element.el
23116 (defun org-mode-flyspell-verify ()
23117 "Don't let flyspell put overlays at active buttons, or on
23118 {todo,all-time,additional-option-like}-keywords."
23119 (let ((pos (max (1- (point)) (point-min)))
23120 (word (thing-at-point 'word)))
23121 (and (not (get-text-property pos 'keymap))
23122 (not (get-text-property pos 'org-no-flyspell))
23123 (not (member word org-todo-keywords-1))
23124 (not (member word org-all-time-keywords))
23125 (not (member word org-options-keywords))
23126 (not (member word (mapcar 'car org-startup-options)))
23127 (not (member-ignore-case word org-element-affiliated-keywords))
23128 (not (member-ignore-case word (org-get-export-keywords)))
23129 (not (member-ignore-case
23130 word (mapcar 'car org-element-block-name-alist)))
23131 (not (member-ignore-case word '("BEGIN" "END" "ATTR"))))))
23133 (defun org-remove-flyspell-overlays-in (beg end)
23134 "Remove flyspell overlays in region."
23135 (and (org-bound-and-true-p flyspell-mode)
23136 (fboundp 'flyspell-delete-region-overlays)
23137 (flyspell-delete-region-overlays beg end))
23138 (add-text-properties beg end '(org-no-flyspell t)))
23140 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23141 (eval-after-load "bookmark"
23142 '(if (boundp 'bookmark-after-jump-hook)
23143 ;; We can use the hook
23144 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23145 ;; Hook not available, use advice
23146 (defadvice bookmark-jump (after org-make-visible activate)
23147 "Make the position visible."
23148 (org-bookmark-jump-unhide))))
23150 ;; Make sure saveplace shows the location if it was hidden
23151 (eval-after-load "saveplace"
23152 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23153 "Make the position visible."
23154 (org-bookmark-jump-unhide)))
23156 ;; Make sure ecb shows the location if it was hidden
23157 (eval-after-load "ecb"
23158 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23159 "Make hierarchy visible when jumping into location from ECB tree buffer."
23160 (if (derived-mode-p 'org-mode)
23161 (org-show-context))))
23163 (defun org-bookmark-jump-unhide ()
23164 "Unhide the current position, to show the bookmark location."
23165 (and (derived-mode-p 'org-mode)
23166 (or (outline-invisible-p)
23167 (save-excursion (goto-char (max (point-min) (1- (point))))
23168 (outline-invisible-p)))
23169 (org-show-context 'bookmark-jump)))
23171 ;; Make session.el ignore our circular variable
23172 (eval-after-load "session"
23173 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23175 ;;;; Experimental code
23177 (defun org-closed-in-range ()
23178 "Sparse tree of items closed in a certain time range.
23179 Still experimental, may disappear in the future."
23180 (interactive)
23181 ;; Get the time interval from the user.
23182 (let* ((time1 (org-float-time
23183 (org-read-date nil 'to-time nil "Starting date: ")))
23184 (time2 (org-float-time
23185 (org-read-date nil 'to-time nil "End date:")))
23186 ;; callback function
23187 (callback (lambda ()
23188 (let ((time
23189 (org-float-time
23190 (apply 'encode-time
23191 (org-parse-time-string
23192 (match-string 1))))))
23193 ;; check if time in interval
23194 (and (>= time time1) (<= time time2))))))
23195 ;; make tree, check each match with the callback
23198 ;;;; Finish up
23200 (provide 'org)
23202 (run-hooks 'org-load-hook)
23204 ;;; org.el ends here